Merge pull request 99designs#389 from 99designs/multiple-schemas

Support multiple schemas

cmd/gen.go

@@ -36,12 +36,15 @@ var genCmd = cli.Command{
 			}
 		}
 
-		schemaRaw, err := ioutil.ReadFile(config.SchemaFilename)
-		if err != nil {
-			fmt.Fprintln(os.Stderr, "unable to open schema: "+err.Error())
-			os.Exit(1)
+		for _, filename := range config.SchemaFilename {
+			var schemaRaw []byte
+			schemaRaw, err = ioutil.ReadFile(filename)
+			if err != nil {
+				fmt.Fprintln(os.Stderr, "unable to open schema: "+err.Error())
+				os.Exit(1)
+			}
+			config.SchemaStr[filename] = string(schemaRaw)
 		}
-		config.SchemaStr = string(schemaRaw)
 
 		if err = config.Check(); err != nil {
 			fmt.Fprintln(os.Stderr, "invalid config format: "+err.Error())

cmd/init.go

@@ -69,14 +69,16 @@ var initCmd = cli.Command{
 }
 
 func GenerateGraphServer(config *codegen.Config, serverFilename string) {
-	schemaRaw, err := ioutil.ReadFile(config.SchemaFilename)
-	if err != nil {
-		fmt.Fprintln(os.Stderr, "unable to open schema: "+err.Error())
-		os.Exit(1)
+	for _, filename := range config.SchemaFilename {
+		schemaRaw, err := ioutil.ReadFile(filename)
+		if err != nil {
+			fmt.Fprintln(os.Stderr, "unable to open schema: "+err.Error())
+			os.Exit(1)
+		}
+		config.SchemaStr[filename] = string(schemaRaw)
 	}
-	config.SchemaStr = string(schemaRaw)
 
-	if err = config.Check(); err != nil {
+	if err := config.Check(); err != nil {
 		fmt.Fprintln(os.Stderr, "invalid config format: "+err.Error())
 		os.Exit(1)
 	}

codegen/build.go

@@ -19,8 +19,8 @@ type Build struct {
 	QueryRoot        *Object
 	MutationRoot     *Object
 	SubscriptionRoot *Object
-	SchemaRaw        string
-	SchemaFilename   string
+	SchemaRaw        map[string]string
+	SchemaFilename   SchemaFilenames
 	Directives       []*Directive
 }
 

codegen/codegen.go

@@ -151,8 +151,13 @@ func (cfg *Config) normalize() error {
 		}
 	}
 
+	var sources []*ast.Source
+	for _, filename := range cfg.SchemaFilename {
+		sources = append(sources, &ast.Source{Name: filename, Input:  cfg.SchemaStr[filename]})
+	}
+
 	var err *gqlerror.Error
-	cfg.schema, err = gqlparser.LoadSchema(&ast.Source{Name: cfg.SchemaFilename, Input: cfg.SchemaStr})
+	cfg.schema, err = gqlparser.LoadSchema(sources...)
 	if err != nil {
 		return err
 	}

codegen/codegen_test.go

@@ -21,7 +21,8 @@ func TestGenerateServer(t *testing.T) {
 `
 	serverFilename := "gen/" + name + "/server/server.go"
 	cfg := Config{
-		SchemaStr: schema,
+		SchemaFilename: SchemaFilenames{"schema.graphql"},
+		SchemaStr: map[string]string{"schema.graphql": schema},
 		Exec:      PackageConfig{Filename: "gen/" + name + "/exec.go"},
 		Model:     PackageConfig{Filename: "gen/" + name + "/model.go"},
 		Resolver:  PackageConfig{Filename: "gen/" + name + "/resolver.go", Type: "Resolver"},

codegen/config.go

@@ -19,7 +19,8 @@ var cfgFilenames = []string{".gqlgen.yml", "gqlgen.yml", "gqlgen.yaml"}
 // DefaultConfig creates a copy of the default config
 func DefaultConfig() *Config {
 	return &Config{
-		SchemaFilename: "schema.graphql",
+		SchemaFilename: SchemaFilenames{"schema.graphql"},
+		SchemaStr:      map[string]string{},
 		Model:          PackageConfig{Filename: "models_gen.go"},
 		Exec:           PackageConfig{Filename: "generated.go"},
 	}
@@ -53,19 +54,36 @@ func LoadConfig(filename string) (*Config, error) {
 		return nil, errors.Wrap(err, "unable to parse config")
 	}
 
+	preGlobbing := config.SchemaFilename
+	config.SchemaFilename = SchemaFilenames{}
+	for _, f := range preGlobbing {
+		matches, err := filepath.Glob(f)
+		if err != nil {
+			return nil, errors.Wrapf(err, "failed to glob schema filename %s", f)
+		}
+
+		for _, m := range matches {
+			if config.SchemaFilename.Has(m) {
+				continue
+			}
+			config.SchemaFilename = append(config.SchemaFilename, m)
+		}
+	}
+
 	config.FilePath = filename
+	config.SchemaStr = map[string]string{}
 
 	return config, nil
 }
 
 type Config struct {
-	SchemaFilename string        `yaml:"schema,omitempty"`
-	SchemaStr      string        `yaml:"-"`
-	Exec           PackageConfig `yaml:"exec"`
-	Model          PackageConfig `yaml:"model"`
-	Resolver       PackageConfig `yaml:"resolver,omitempty"`
-	Models         TypeMap       `yaml:"models,omitempty"`
-	StructTag      string        `yaml:"struct_tag,omitempty"`
+	SchemaFilename SchemaFilenames   `yaml:"schema,omitempty"`
+	SchemaStr      map[string]string `yaml:"-"`
+	Exec           PackageConfig     `yaml:"exec"`
+	Model          PackageConfig     `yaml:"model"`
+	Resolver       PackageConfig     `yaml:"resolver,omitempty"`
+	Models         TypeMap           `yaml:"models,omitempty"`
+	StructTag      string            `yaml:"struct_tag,omitempty"`
 
 	FilePath string `yaml:"-"`
 
@@ -84,8 +102,37 @@ type TypeMapEntry struct {
 }
 
 type TypeMapField struct {
-	Resolver   bool   `yaml:"resolver"`
-	FieldName  string `yaml:"fieldName"`
+	Resolver  bool   `yaml:"resolver"`
+	FieldName string `yaml:"fieldName"`
+}
+
+type SchemaFilenames []string
+
+func (a *SchemaFilenames) UnmarshalYAML(unmarshal func(interface{}) error) error {
+	var single string
+	err := unmarshal(&single)
+	if err == nil {
+		*a = []string{single}
+		return nil
+	}
+
+	var multi []string
+	err = unmarshal(&multi)
+	if err != nil {
+		return err
+	}
+
+	*a = multi
+	return nil
+}
+
+func (a SchemaFilenames) Has(file string) bool {
+	for _, existing := range a {
+		if existing == file {
+			return true
+		}
+	}
+	return false
 }
 
 func (c *PackageConfig) normalize() error {

codegen/config_test.go

@@ -36,7 +36,7 @@ func TestLoadDefaultConfig(t *testing.T) {
 
 		cfg, err = LoadConfigFromDefaultLocations()
 		require.NoError(t, err)
-		require.Equal(t, cfg.SchemaFilename, "inner")
+		require.Equal(t, SchemaFilenames{"inner"}, cfg.SchemaFilename)
 	})
 
 	t.Run("will find config in parent dirs", func(t *testing.T) {
@@ -45,7 +45,7 @@ func TestLoadDefaultConfig(t *testing.T) {
 
 		cfg, err = LoadConfigFromDefaultLocations()
 		require.NoError(t, err)
-		require.Equal(t, cfg.SchemaFilename, "outer")
+		require.Equal(t, SchemaFilenames{"outer"},cfg.SchemaFilename)
 	})
 
 	t.Run("will return error if config doesn't exist", func(t *testing.T) {

codegen/input_test.go

@@ -35,7 +35,8 @@ func TestTypeInInput(t *testing.T) {
 
 func generate(name string, schema string, typemap ...TypeMap) error {
 	cfg := Config{
-		SchemaStr: schema,
+		SchemaFilename: SchemaFilenames{"schema.graphql"},
+		SchemaStr: map[string]string{"schema.graphql": schema},
 		Exec:      PackageConfig{Filename: "gen/" + name + "/exec.go"},
 		Model:     PackageConfig{Filename: "gen/" + name + "/model.go"},
 	}

codegen/templates/generated.gotpl

@@ -261,5 +261,7 @@ func (ec *executionContext) introspectType(name string) *introspection.Type {
 }
 
 var parsedSchema = gqlparser.MustLoadSchema(
-	&ast.Source{Name: {{.SchemaFilename|quote}}, Input: {{.SchemaRaw|rawQuote}}},
+	{{- range $filename, $schema := .SchemaRaw }}
+		&ast.Source{Name: {{$filename|quote}}, Input: {{$schema|rawQuote}}},
+	{{- end }}
 )

codegen/util_test.go

@@ -83,7 +83,6 @@ type Embed struct {
 }
 
 func parseScope(t *testing.T, input interface{}, packageName string) (*types.Scope, error) {
-	t.Helper()
 	// test setup to parse the types
 	fset := token.NewFileSet()
 	f, err := parser.ParseFile(fset, "test.go", input, 0)

docs/content/config.md

@@ -10,8 +10,18 @@ gqlgen can be configured using a `gqlgen.yml` file, by default it will be loaded
 
 Example:
 ```yml
+# You can pass a single schema file
 schema: schema.graphql
 
+# Or multiple files
+schema:
+ - schema.graphql
+ - user.graphql
+
+# Or you can use globs
+schema: 
+ - "*.graphql"
+
 # Let gqlgen know where to put the generated server
 exec:
   filename: graph/generated/generated.go

example/config/.gqlgen.yml

@@ -3,7 +3,7 @@
 # Refer to https://gqlgen.com/config/
 # for detailed .gqlgen.yml documentation.
 
-schema: schema.graphql
+schema: "*.graphql"
 exec:
   filename: generated.go
 model:

example/config/schema.graphql

@@ -1,29 +1,7 @@
-# GraphQL schema example
-#
-# https://gqlgen.com/getting-started/
-
-type Todo {
-  id: ID!
-  databaseId: Int!
-  text: String!
-  done: Boolean!
-  user: User!
-}
-
-type User {
-  id: ID!
-  name: String!
-}
-
 type Query {
   todos: [Todo!]!
 }
 
-input NewTodo {
-  text: String!
-  userId: String!
-}
-
 type Mutation {
   createTodo(input: NewTodo!): Todo!
 }

example/config/todo.graphql

@@ -0,0 +1,13 @@
+type Todo {
+  id: ID!
+  databaseId: Int!
+  text: String!
+  done: Boolean!
+  user: User!
+}
+
+input NewTodo {
+  text: String!
+  userId: String!
+}
+

example/config/user.graphql

@@ -0,0 +1,4 @@
+type User {
+  id: ID!
+  name: String!
+}

integration/gqlgen.yml

@@ -1,4 +1,6 @@
-schema: schema.graphql
+schema:
+  - "schema.graphql"
+  - "user.graphql"
 
 exec:
   filename: generated.go

integration/schema.graphql

@@ -25,11 +25,6 @@ input DateFilter {
     op: DATE_FILTER_OP = EQ
 }
 
-type User {
-    name: String!
-    likes: [String!]!
-}
-
 type Viewer {
     user: User
 }

integration/user.graphql

@@ -0,0 +1,4 @@
+type User {
+    name: String!
+    likes: [String!]!
+}