Merge pull request #1091 from CircleCI-Public/develop

Remove introspection query from `setup` & `diagnostic` commands
CircleCI-Public · Jan 20, 2025 · ebcbd1f · ebcbd1f
2 parents 591d7b2 + cb22920
commit ebcbd1f
Show file tree

Hide file tree

Showing 13 changed files with 209 additions and 542 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -8,7 +8,7 @@ orbs:
 executors:
   go:
     docker:
-      - image: cimg/go:1.21.5
+      - image: cimg/go:1.23.4
     resource_class: large
     environment:
       CGO_ENABLED: 0
@@ -103,8 +103,8 @@ jobs:
     steps:
       - checkout
       - run: |
-          curl -OL https://go.dev/dl/go1.21.5.darwin-arm64.pkg
-          sudo installer -pkg ./go1.21.5.darwin-arm64.pkg -target /
+          curl -OL https://go.dev/dl/go1.23.4.darwin-arm64.pkg
+          sudo installer -pkg ./go1.23.4.darwin-arm64.pkg -target /
           echo 'export PATH="/usr/local/go/bin:$PATH"' >> ~/.bash_profile
       - gomod
       - run: make test
@@ -177,7 +177,7 @@ jobs:
 
   lint:
     docker:
-      - image: golangci/golangci-lint:v1.51.0-alpine
+      - image: golangci/golangci-lint:v1.63.4-alpine
     resource_class: large
     steps:
       - checkout

diff --git a/.golangci.yml b/.golangci.yml
@@ -1,10 +1,9 @@
 ---
 service:
-  golangci-lint-version: 1.46.x
+  golangci-lint-version: 1.63.x
 
 linters:
   enable:
-    - deadcode
     - errcheck
     - goconst
     - gofmt
@@ -18,12 +17,10 @@ linters:
     - nakedret
     # - revive
     - staticcheck
-    - structcheck
     - typecheck
     - unconvert
     # - unparam
     - unused
-    - varcheck
     - vet
     - vetshadow
 

diff --git a/api/api.go b/api/api.go
@@ -63,26 +63,6 @@ type GQLResponseError struct {
 	Type          string
 }
 
-// IntrospectionResponse matches the result from making an introspection query
-type IntrospectionResponse struct {
-	Schema struct {
-		MutationType struct {
-			Name string
-		}
-		QueryType struct {
-			Name string
-		}
-		Types []struct {
-			Description string
-			Fields      []struct {
-				Name string
-			}
-			Kind string
-			Name string
-		}
-	} `json:"__schema"`
-}
-
 // ConfigResponse is a structure that matches the result of the GQL
 // query, so that we can use mapstructure to convert from
 // nested maps to a strongly typed struct.
@@ -1457,7 +1437,7 @@ query ListOrbs ($after: String!, $certifiedOnly: Boolean!) {
 				err := yaml.Unmarshal([]byte(edge.Node.Versions[0].Source), &edge.Node)
 
 				if err != nil {
-					l.Printf(errors.Wrapf(err, "Corrupt Orb %s %s", edge.Node.Name, v.Version).Error())
+					l.Printf("%s", errors.Wrap(err, fmt.Sprintf("Corrupt Orb %s %s", edge.Node.Name, v.Version)).Error())
 					continue Orbs
 				}
 
@@ -1626,7 +1606,7 @@ query namespaceOrbs ($namespace: String, $after: String!, $view: OrbListViewType
 
 				err := yaml.Unmarshal([]byte(edge.Node.Versions[0].Source), &edge.Node)
 				if err != nil {
-					l.Printf(errors.Wrapf(err, "Corrupt Orb %s %s", edge.Node.Name, v.Version).Error())
+					l.Printf("%s", errors.Wrap(err, fmt.Sprintf("Corrupt Orb %s %s", edge.Node.Name, v.Version)).Error())
 					continue NamespaceOrbs
 				}
 			} else {
@@ -1644,38 +1624,6 @@ query namespaceOrbs ($namespace: String, $after: String!, $view: OrbListViewType
 	return &orbs, nil
 }
 
-// IntrospectionQuery makes a query on the API asking for bits of the schema
-// This query isn't intended to get the entire schema, there are better tools for that.
-func IntrospectionQuery(cl *graphql.Client) (*IntrospectionResponse, error) {
-	var response IntrospectionResponse
-
-	query := `query IntrospectionQuery {
-		    __schema {
-		      queryType { name }
-		      mutationType { name }
-		      types {
-		        ...FullType
-		      }
-		    }
-		  }
-
-		  fragment FullType on __Type {
-		    kind
-		    name
-		    description
-		    fields(includeDeprecated: true) {
-		      name
-		    }
-		  }`
-
-	request := graphql.NewRequest(query)
-	request.SetToken(cl.Token)
-
-	err := cl.Run(request, &response)
-
-	return &response, err
-}
-
 // OrbCategoryID fetches an orb returning the ID
 func OrbCategoryID(cl *graphql.Client, name string) (*OrbCategoryIDResponse, error) {
 	var response OrbCategoryIDResponse

diff --git a/api/graphql/client.go b/api/graphql/client.go
@@ -237,7 +237,7 @@ func (cl *Client) Run(request *Request, resp interface{}) error {
 	defer func() {
 		responseBodyCloseErr := res.Body.Close()
 		if responseBodyCloseErr != nil {
-			l.Printf(responseBodyCloseErr.Error())
+			l.Printf("%s", responseBodyCloseErr.Error())
 		}
 	}()
 

diff --git a/api/graphql/client_test.go b/api/graphql/client_test.go
@@ -54,7 +54,7 @@ func TestDoJSON(t *testing.T) {
 
 		b, err := io.ReadAll(r.Body)
 		if err != nil {
-			t.Errorf(err.Error())
+			t.Errorf("%s", err.Error())
 		}
 
 		if string(b) != `{"query":"query {}","variables":null}`+"\n" {
@@ -67,7 +67,7 @@ func TestDoJSON(t *testing.T) {
 			}
 		}`)
 		if err != nil {
-			t.Errorf(err.Error())
+			t.Errorf("%s", err.Error())
 		}
 	}))
 	defer srv.Close()
@@ -79,7 +79,7 @@ func TestDoJSON(t *testing.T) {
 	}
 	err := client.Run(&Request{Query: "query {}"}, &resp)
 	if err != nil {
-		t.Errorf(err.Error())
+		t.Errorf("%s", err.Error())
 	}
 
 	if calls != 1 {
@@ -97,14 +97,14 @@ func TestQueryJSON(t *testing.T) {
 		calls++
 		b, err := io.ReadAll(r.Body)
 		if err != nil {
-			t.Errorf(err.Error())
+			t.Errorf("%s", err.Error())
 		}
 		if string(b) != `{"query":"query {}","variables":{"username":"matryer"}}`+"\n" {
 			t.Errorf("expected %s", b)
 		}
 		_, err = io.WriteString(w, `{"data":{"value":"some data"}}`)
 		if err != nil {
-			t.Errorf(err.Error())
+			t.Errorf("%s", err.Error())
 		}
 	}))
 	defer srv.Close()
@@ -128,7 +128,7 @@ func TestQueryJSON(t *testing.T) {
 	}
 	err := client.Run(req, &resp)
 	if err != nil {
-		t.Errorf(err.Error())
+		t.Errorf("%s", err.Error())
 	}
 
 	if calls != 1 {
@@ -147,7 +147,7 @@ func TestDoJSONErr(t *testing.T) {
 
 		body, err := io.ReadAll(req.Body)
 		if err != nil {
-			t.Errorf(err.Error())
+			t.Errorf("%s", err.Error())
 		}
 
 		if string(body) != `{"query":"query {}","variables":null}`+"\n" {
@@ -166,7 +166,7 @@ func TestDoJSONErr(t *testing.T) {
 				]
 			}`)
 		if err != nil {
-			t.Errorf(err.Error())
+			t.Errorf("%s", err.Error())
 		}
 	}))
 
@@ -178,7 +178,7 @@ func TestDoJSONErr(t *testing.T) {
 
 	err := client.Run(&Request{Query: "query {}"}, &responseData)
 	if err.Error() != "Something went wrong\nSomething else went wrong" {
-		t.Errorf(err.Error())
+		t.Errorf("%s", err.Error())
 	}
 }
 
@@ -192,7 +192,7 @@ func TestHeader(t *testing.T) {
 
 		_, err := io.WriteString(w, `{"data":{"value":"some data"}}`)
 		if err != nil {
-			t.Errorf(err.Error())
+			t.Errorf("%s", err.Error())
 		}
 	}))
 	defer srv.Close()
@@ -207,7 +207,7 @@ func TestHeader(t *testing.T) {
 	}
 	err := client.Run(req, &resp)
 	if err != nil {
-		t.Errorf(err.Error())
+		t.Errorf("%s", err.Error())
 	}
 
 	if calls != 1 {
@@ -228,7 +228,7 @@ func TestStatusCode200(t *testing.T) {
 
 		_, err := io.WriteString(w, `{"data":{"value":"some data"}}`)
 		if err != nil {
-			t.Errorf(err.Error())
+			t.Errorf("%s", err.Error())
 		}
 	}))
 	defer srv.Close()
@@ -241,7 +241,7 @@ func TestStatusCode200(t *testing.T) {
 
 	err := client.Run(req, &resp)
 	if err != nil {
-		t.Errorf(err.Error())
+		t.Errorf("%s", err.Error())
 	}
 
 	if calls != 1 {
@@ -258,7 +258,7 @@ func TestStatusCode500(t *testing.T) {
 
 		_, err := io.WriteString(w, "some: data")
 		if err != nil {
-			t.Errorf(err.Error())
+			t.Errorf("%s", err.Error())
 		}
 	}))
 	defer srv.Close()
@@ -292,7 +292,7 @@ func TestStatusCode413(t *testing.T) {
 
 		_, err := io.WriteString(w, "some: data")
 		if err != nil {
-			t.Errorf(err.Error())
+			t.Errorf("%s", err.Error())
 		}
 	}))
 	defer srv.Close()

diff --git a/cmd/diagnostic.go b/cmd/diagnostic.go
@@ -2,7 +2,6 @@ package cmd
 
 import (
 	"fmt"
-	"os"
 
 	"github.com/CircleCI-Public/circleci-cli/api"
 	"github.com/CircleCI-Public/circleci-cli/api/graphql"
@@ -57,25 +56,6 @@ func diagnostic(opts diagnosticOptions) error {
 
 	fmt.Println("OK, got a token.")
 
-	fmt.Println("Trying an introspection query on API... ")
-
-	responseIntro, err := api.IntrospectionQuery(opts.cl)
-	if responseIntro.Schema.QueryType.Name == "" {
-		fmt.Println("Unable to make a query against the GraphQL API, please check your settings")
-		if err != nil {
-			return err
-		}
-	}
-
-	fmt.Println("Ok.")
-
-	if opts.cfg.Debug {
-		_, err = fmt.Fprintf(os.Stderr, "Introspection query result with Schema.QueryType of %s", responseIntro.Schema.QueryType.Name)
-		if err != nil {
-			return err
-		}
-	}
-
 	responseWho, err := api.WhoamiQuery(opts.cl)
 
 	if err != nil {