Optimize performance for binder, imports and packages (Rebased from s…

…balabanov/master) (#1711)

* Cache go.mod resolution for module name search

* Optimize binder.FindObject() for performance by eliminating repeatitive constructs

* Optimize allocations in packages.Load() function

* Optimize binder.FindObject() by indexing object definitions for each loaded package

* goimports to fix linting

Signed-off-by: Steve Coffman <steve@khanacademy.org>

Co-authored-by: Sergey Balabanov <sergeyb@uber.com>

api/option_test.go

@@ -11,8 +11,7 @@ import (
 	"github.com/stretchr/testify/require"
 )
 
-type testPlugin struct {
-}
+type testPlugin struct{}
 
 // Name returns the plugin name
 func (t *testPlugin) Name() string {
@@ -25,7 +24,6 @@ func (t *testPlugin) MutateConfig(_ *config.Config) error {
 }
 
 func TestReplacePlugin(t *testing.T) {
-
 	t.Run("replace plugin if exists", func(t *testing.T) {
 		pg := []plugin.Plugin{
 			federation.New(),
@@ -54,5 +52,4 @@ func TestReplacePlugin(t *testing.T) {
 		require.EqualValues(t, resolvergen.New(), pg[1])
 		require.EqualValues(t, expectedPlugin, pg[2])
 	})
-
 }

client/websocket.go

@@ -64,7 +64,6 @@ func (p *Client) WebsocketWithPayload(query string, initPayload map[string]inter
 	srv := httptest.NewServer(p.h)
 	host := strings.ReplaceAll(srv.URL, "http://", "ws://")
 	c, _, err := websocket.DefaultDialer.Dial(host+r.URL.Path, r.Header)
-
 	if err != nil {
 		return errorSubscription(fmt.Errorf("dial: %w", err))
 	}

cmd/init.go

@@ -187,10 +187,10 @@ func fileExists(filename string) bool {
 }
 
 func initFile(filename, contents string) error {
-	if err := os.MkdirAll(filepath.Dir(filename), 0755); err != nil {
+	if err := os.MkdirAll(filepath.Dir(filename), 0o755); err != nil {
 		return fmt.Errorf("unable to create directory for file '%s': %w\n", filename, err)
 	}
-	if err := ioutil.WriteFile(filename, []byte(contents), 0644); err != nil {
+	if err := ioutil.WriteFile(filename, []byte(contents), 0o644); err != nil {
 		return fmt.Errorf("unable to write file '%s': %w\n", filename, err)
 	}
 

codegen/config/binder.go

@@ -6,6 +6,8 @@ import (
 	"go/token"
 	"go/types"
 
+	"golang.org/x/tools/go/packages"
+
 	"github.com/99designs/gqlgen/codegen/templates"
 	"github.com/99designs/gqlgen/internal/code"
 	"github.com/vektah/gqlparser/v2/ast"
@@ -15,11 +17,12 @@ var ErrTypeNotFound = errors.New("unable to find type")
 
 // Binder connects graphql types to golang types using static analysis
 type Binder struct {
-	pkgs       *code.Packages
-	schema     *ast.Schema
-	cfg        *Config
-	References []*TypeReference
-	SawInvalid bool
+	pkgs        *code.Packages
+	schema      *ast.Schema
+	cfg         *Config
+	References  []*TypeReference
+	SawInvalid  bool
+	objectCache map[string]map[string]types.Object
 }
 
 func (c *Config) NewBinder() *Binder {
@@ -78,8 +81,10 @@ func (b *Binder) FindType(pkgName string, typeName string) (types.Type, error) {
 	return obj.Type(), nil
 }
 
-var MapType = types.NewMap(types.Typ[types.String], types.NewInterfaceType(nil, nil).Complete())
-var InterfaceType = types.NewInterfaceType(nil, nil)
+var (
+	MapType       = types.NewMap(types.Typ[types.String], types.NewInterfaceType(nil, nil).Complete())
+	InterfaceType = types.NewInterfaceType(nil, nil)
+)
 
 func (b *Binder) DefaultUserObject(name string) (types.Type, error) {
 	models := b.cfg.Models[name].Model
@@ -112,45 +117,61 @@ func (b *Binder) FindObject(pkgName string, typeName string) (types.Object, erro
 	if pkgName == "" {
 		return nil, fmt.Errorf("package cannot be nil")
 	}
-	fullName := typeName
-	if pkgName != "" {
-		fullName = pkgName + "." + typeName
-	}
 
 	pkg := b.pkgs.LoadWithTypes(pkgName)
 	if pkg == nil {
 		err := b.pkgs.Errors()
 		if err != nil {
-			return nil, fmt.Errorf("package could not be loaded: %s: %w", fullName, err)
+			return nil, fmt.Errorf("package could not be loaded: %s.%s: %w", pkgName, typeName, err)
 		}
-		return nil, fmt.Errorf("required package was not loaded: %s", fullName)
+		return nil, fmt.Errorf("required package was not loaded: %s.%s", pkgName, typeName)
+	}
+
+	if b.objectCache == nil {
+		b.objectCache = make(map[string]map[string]types.Object, b.pkgs.Count())
+	}
+
+	defsIndex, ok := b.objectCache[pkgName]
+	if !ok {
+		defsIndex = indexDefs(pkg)
+		b.objectCache[pkgName] = defsIndex
 	}
 
 	// function based marshalers take precedence
-	for astNode, def := range pkg.TypesInfo.Defs {
-		// only look at defs in the top scope
-		if def == nil || def.Parent() == nil || def.Parent() != pkg.Types.Scope() {
-			continue
-		}
+	if val, ok := defsIndex["Marshal"+typeName]; ok {
+		return val, nil
+	}
 
-		if astNode.Name == "Marshal"+typeName {
-			return def, nil
-		}
+	if val, ok := defsIndex[typeName]; ok {
+		return val, nil
 	}
 
-	// then look for types directly
+	return nil, fmt.Errorf("%w: %s.%s", ErrTypeNotFound, pkgName, typeName)
+}
+
+func indexDefs(pkg *packages.Package) map[string]types.Object {
+	res := make(map[string]types.Object)
+
+	scope := pkg.Types.Scope()
 	for astNode, def := range pkg.TypesInfo.Defs {
 		// only look at defs in the top scope
-		if def == nil || def.Parent() == nil || def.Parent() != pkg.Types.Scope() {
+		if def == nil {
+			continue
+		}
+		parent := def.Parent()
+		if parent == nil || parent != scope {
 			continue
 		}
 
-		if astNode.Name == typeName {
-			return def, nil
+		if _, ok := res[astNode.Name]; !ok {
+			// The above check may not be really needed, it is only here to have a consistent behavior with
+			// previous implementation of FindObject() function which only honored the first inclusion of a def.
+			// If this is still needed, we can consider something like sync.Map.LoadOrStore() to avoid two lookups.
+			res[astNode.Name] = def
 		}
 	}
 
-	return nil, fmt.Errorf("%w: %s", ErrTypeNotFound, fullName)
+	return res
 }
 
 func (b *Binder) PointerTo(ref *TypeReference) *TypeReference {
@@ -236,12 +257,12 @@ func (t *TypeReference) IsScalar() bool {
 }
 
 func (t *TypeReference) UniquenessKey() string {
-	var nullability = "O"
+	nullability := "O"
 	if t.GQL.NonNull {
 		nullability = "N"
 	}
 
-	var elemNullability = ""
+	elemNullability := ""
 	if t.GQL.Elem != nil && t.GQL.Elem.NonNull {
 		// Fix for #896
 		elemNullability = "ᚄ"

codegen/config/config_test.go

@@ -128,7 +128,6 @@ func TestReferencedPackages(t *testing.T) {
 
 		assert.Equal(t, []string{"github.com/test", "github.com/otherpkg"}, pkgs)
 	})
-
 }
 
 func TestConfigCheck(t *testing.T) {

codegen/templates/import_test.go

@@ -54,7 +54,6 @@ func TestImports(t *testing.T) {
 				require.Equal(t, fmt.Sprintf("bar%d", i), a.Lookup(cBar))
 			} else {
 				require.Equal(t, "bar", a.Lookup(cBar))
-
 			}
 		}
 	})
@@ -89,5 +88,4 @@ turtles "github.com/99designs/gqlgen/codegen/templates/testdata/pkg_mismatch"`,
 		require.Equal(t, `abar "github.com/99designs/gqlgen/codegen/templates/testdata/a/bar"
 bbar "github.com/99designs/gqlgen/codegen/templates/testdata/b/bar"`, a.String())
 	})
-
 }

codegen/templates/templates.go

@@ -589,7 +589,7 @@ func render(filename string, tpldata interface{}) (*bytes.Buffer, error) {
 }
 
 func write(filename string, b []byte, packages *code.Packages) error {
-	err := os.MkdirAll(filepath.Dir(filename), 0755)
+	err := os.MkdirAll(filepath.Dir(filename), 0o755)
 	if err != nil {
 		return fmt.Errorf("failed to create directory: %w", err)
 	}
@@ -600,7 +600,7 @@ func write(filename string, b []byte, packages *code.Packages) error {
 		formatted = b
 	}
 
-	err = ioutil.WriteFile(filename, formatted, 0644)
+	err = ioutil.WriteFile(filename, formatted, 0o644)
 	if err != nil {
 		return fmt.Errorf("failed to write %s: %w", filename, err)
 	}

codegen/templates/templates_test.go

@@ -70,7 +70,6 @@ func TestToGoPrivate(t *testing.T) {
 }
 
 func Test_wordWalker(t *testing.T) {
-
 	helper := func(str string) []*wordInfo {
 		resultList := []*wordInfo{}
 		wordWalker(str, func(info *wordInfo) {

codegen/testserver/followschema/middleware_test.go

@@ -106,5 +106,4 @@ func TestMiddleware(t *testing.T) {
 
 	require.NoError(t, err)
 	require.True(t, called)
-
 }

codegen/testserver/followschema/models.go

@@ -10,8 +10,7 @@ type ForcedResolver struct {
 	Field Circle
 }
 
-type ModelMethods struct {
-}
+type ModelMethods struct{}
 
 func (m ModelMethods) NoContext() bool {
 	return true
@@ -58,8 +57,7 @@ func (m MarshalPanic) MarshalGQL(w io.Writer) {
 	panic("BOOM")
 }
 
-type Panics struct {
-}
+type Panics struct{}
 
 func (p *Panics) FieldFuncMarshal(ctx context.Context, u []MarshalPanic) []MarshalPanic {
 	return []MarshalPanic{MarshalPanic("aa"), MarshalPanic("bb")}

codegen/testserver/followschema/ptr_to_slice_test.go

@@ -32,6 +32,5 @@ func TestPtrToSlice(t *testing.T) {
 		require.NoError(t, err)
 
 		require.Equal(t, []string{"hello"}, resp.PtrToSliceContainer.PtrToSlice)
-
 	})
 }

codegen/testserver/followschema/scalar_context.go

@@ -12,13 +12,16 @@ type StringFromContextInterface struct {
 	OperationName string
 }
 
-var _ graphql.ContextMarshaler = StringFromContextInterface{}
-var _ graphql.ContextUnmarshaler = (*StringFromContextInterface)(nil)
+var (
+	_ graphql.ContextMarshaler   = StringFromContextInterface{}
+	_ graphql.ContextUnmarshaler = (*StringFromContextInterface)(nil)
+)
 
 func (StringFromContextInterface) MarshalGQLContext(ctx context.Context, w io.Writer) error {
 	io.WriteString(w, strconv.Quote(graphql.GetFieldContext(ctx).Field.Name))
 	return nil
 }
+
 func (i *StringFromContextInterface) UnmarshalGQLContext(ctx context.Context, v interface{}) error {
 	i.OperationName = graphql.GetFieldContext(ctx).Field.Name
 	return nil

codegen/testserver/followschema/scalar_context_test.go

@@ -23,7 +23,6 @@ func TestFloatInfAndNaN(t *testing.T) {
 		err := c.Post(`query { infinity }`, nil)
 		require.Error(t, err)
 	})
-
 }
 
 func TestContextPassedToMarshal(t *testing.T) {

codegen/testserver/followschema/v-ok.go

@@ -1,16 +1,14 @@
 package followschema
 
 // VOkCaseValue model
-type VOkCaseValue struct {
-}
+type VOkCaseValue struct{}
 
 func (v VOkCaseValue) Value() (string, bool) {
 	return "hi", true
 }
 
 // VOkCaseNil model
-type VOkCaseNil struct {
-}
+type VOkCaseNil struct{}
 
 func (v VOkCaseNil) Value() (string, bool) {
 	return "", false

codegen/testserver/followschema/wrapped_type.go

@@ -2,7 +2,9 @@ package followschema
 
 import "github.com/99designs/gqlgen/codegen/testserver/followschema/otherpkg"
 
-type WrappedScalar = otherpkg.Scalar
-type WrappedStruct otherpkg.Struct
-type WrappedMap otherpkg.Map
-type WrappedSlice otherpkg.Slice
+type (
+	WrappedScalar = otherpkg.Scalar
+	WrappedStruct otherpkg.Struct
+	WrappedMap    otherpkg.Map
+	WrappedSlice  otherpkg.Slice
+)

codegen/testserver/singlefile/middleware_test.go

@@ -106,5 +106,4 @@ func TestMiddleware(t *testing.T) {
 
 	require.NoError(t, err)
 	require.True(t, called)
-
 }

codegen/testserver/singlefile/models.go

@@ -10,8 +10,7 @@ type ForcedResolver struct {
 	Field Circle
 }
 
-type ModelMethods struct {
-}
+type ModelMethods struct{}
 
 func (m ModelMethods) NoContext() bool {
 	return true
@@ -58,8 +57,7 @@ func (m MarshalPanic) MarshalGQL(w io.Writer) {
 	panic("BOOM")
 }
 
-type Panics struct {
-}
+type Panics struct{}
 
 func (p *Panics) FieldFuncMarshal(ctx context.Context, u []MarshalPanic) []MarshalPanic {
 	return []MarshalPanic{MarshalPanic("aa"), MarshalPanic("bb")}

codegen/testserver/singlefile/ptr_to_slice_test.go

@@ -32,6 +32,5 @@ func TestPtrToSlice(t *testing.T) {
 		require.NoError(t, err)
 
 		require.Equal(t, []string{"hello"}, resp.PtrToSliceContainer.PtrToSlice)
-
 	})
 }

codegen/testserver/singlefile/scalar_context.go

@@ -12,13 +12,16 @@ type StringFromContextInterface struct {
 	OperationName string
 }
 
-var _ graphql.ContextMarshaler = StringFromContextInterface{}
-var _ graphql.ContextUnmarshaler = (*StringFromContextInterface)(nil)
+var (
+	_ graphql.ContextMarshaler   = StringFromContextInterface{}
+	_ graphql.ContextUnmarshaler = (*StringFromContextInterface)(nil)
+)
 
 func (StringFromContextInterface) MarshalGQLContext(ctx context.Context, w io.Writer) error {
 	io.WriteString(w, strconv.Quote(graphql.GetFieldContext(ctx).Field.Name))
 	return nil
 }
+
 func (i *StringFromContextInterface) UnmarshalGQLContext(ctx context.Context, v interface{}) error {
 	i.OperationName = graphql.GetFieldContext(ctx).Field.Name
 	return nil

codegen/testserver/singlefile/scalar_context_test.go

@@ -23,7 +23,6 @@ func TestFloatInfAndNaN(t *testing.T) {
 		err := c.Post(`query { infinity }`, nil)
 		require.Error(t, err)
 	})
-
 }
 
 func TestContextPassedToMarshal(t *testing.T) {