more miscellaneous fixes while integrating into webapp

example/genqlient.yaml

@@ -2,6 +2,5 @@
 package: example
 schema: schema.graphql
 queries:
-- queries.graphql
+- genqlient.graphql
 generated: generated.go
-use_context: true

generate/config.go

@@ -12,7 +12,7 @@ import (
 
 var defaultConfig = &Config{
 	Schema:      "schema.graphql",
-	Queries:     []string{"queries.graphql"},
+	Operations:  []string{"genqlient.graphql"},
 	Generated:   "generated.go",
 	ContextType: "context.Context",
 }
@@ -24,12 +24,13 @@ type Config struct {
 	// how to convert that to SDL).
 	Schema string `yaml:"schema"`
 
-	// Filenames or globs with the queries; defaults to queries.graphql.
+	// Filenames or globs with the operations for which to generate code;
+	// defaults to genqlient.graphql.
 	//
 	// These may be .graphql files, containing the queries in SDL format, or
 	// Go files, in which case any string-literal starting with (optional
 	// whitespace and) the string "# @genqlient" will be extracted as a query.
-	Queries []string `yaml:"queries"`
+	Operations []string `yaml:"operations"`
 
 	// If set, a file at this path will be generated containing the exact
 	// operations that genqlient will send to the server.
@@ -41,6 +42,7 @@ type Config struct {
 	//	{"operations": [{
 	//		"operationName": "operationname",
 	//		"query": "query operationName { ... }",
+	//		"sourceLocation": "myqueriesfile.graphql",
 	//	}]}
 	// Keys may be added in the future.
 	//
@@ -74,8 +76,8 @@ func (c *Config) ValidateAndFillDefaults(configFilename string) error {
 	// Make paths relative to config dir
 	configDir := filepath.Dir(configFilename)
 	c.Schema = filepath.Join(configDir, c.Schema)
-	for i := range c.Queries {
+	for i := range c.Operations {
-		c.Queries[i] = filepath.Join(configDir, c.Queries[i])
+		c.Operations[i] = filepath.Join(configDir, c.Operations[i])
 	}
 	c.Generated = filepath.Join(configDir, c.Generated)
 
@@ -105,6 +107,15 @@ func (c *Config) ContextPackage() string {
 	return c.ContextType[:i]
 }
 
+func (c *Config) ContextTypeReference() string {
+	if c.ContextType == "" {
+		return ""
+	}
+
+	i := strings.LastIndex(c.ContextType, "/")
+	return c.ContextType[i+1:]
+}
+
 func ReadAndValidateConfig(filename string) (*Config, error) {
 	config := *defaultConfig
 	if filename != "" {

generate/generate.go

@@ -41,6 +41,8 @@ type operation struct {
 	Args []argument `json:"-"`
 	// The type-name for the operation's response type.
 	ResponseName string `json:"-"`
+	// The original location of this query.
+	SourceLocation string `json:"sourceLocation"`
 }
 
 type exportedOperations struct {
@@ -96,8 +98,8 @@ func (g *generator) getDocComment(op *ast.OperationDefinition) string {
 	var commentLines []string
 	sourceLines := strings.Split(op.Position.Src.Input, "\n")
 	for i := op.Position.Line - 1; i > 0; i-- {
-		line := sourceLines[i-1]
+		line := strings.TrimSpace(sourceLines[i-1])
-		if strings.HasPrefix(line, "#") {
+		if strings.HasPrefix(line, "#") && !strings.HasPrefix(line, "# @genqlient") {
 			commentLines = append(commentLines,
 				"// "+strings.TrimSpace(strings.TrimPrefix(line, "#")))
 		} else {
@@ -141,9 +143,10 @@ func (g *generator) addOperation(op *ast.OperationDefinition) error {
 		Name: op.Name,
 		Doc:  g.getDocComment(op),
 		// The newline just makes it format a little nicer
-		Body:         "\n" + builder.String(),
+		Body:           "\n" + builder.String(),
-		Args:         args,
+		Args:           args,
-		ResponseName: responseName,
+		ResponseName:   responseName,
+		SourceLocation: op.Position.Src.Name,
 	})
 
 	return nil
@@ -156,7 +159,7 @@ func Generate(config *Config) (map[string][]byte, error) {
 		return nil, err
 	}
 
-	document, err := getAndValidateQueries(config.Queries, schema)
+	document, err := getAndValidateQueries(config.Operations, schema)
 	if err != nil {
 		return nil, err
 	}
@@ -165,7 +168,7 @@ func Generate(config *Config) (map[string][]byte, error) {
 	// package-name, if it turns out to be more convenient that way.  (As-is,
 	// we generate a broken file, with just (unused) imports.)
 	if len(document.Operations) == 0 {
-		return nil, fmt.Errorf("no queries found in %v", config.Queries)
+		return nil, fmt.Errorf("no queries found in %v", config.Operations)
 	}
 
 	g := newGenerator(config, schema)

generate/generate_test.go

@@ -65,7 +65,7 @@ func TestGenerate(t *testing.T) {
 		t.Run(graphqlFilename, func(t *testing.T) {
 			generated, err := Generate(&Config{
 				Schema:           filepath.Join(dataDir, "schema.graphql"),
-				Queries:          []string{filepath.Join(dataDir, graphqlFilename)},
+				Operations:       []string{filepath.Join(dataDir, graphqlFilename)},
 				Package:          "test",
 				Generated:        goFilename,
 				ExportOperations: queriesFilename,

generate/operation.go.tmpl

@@ -3,7 +3,7 @@ package {{.Config.Package}}
 // Code generated by github.com/Khan/genqlient, DO NOT EDIT.
 
 import (
-    {{- if .Config.ContextType -}}
+    {{if .Config.ContextType -}}
     "{{.Config.ContextPackage}}"
     {{end}}
     {{- if .ImportJSON -}}
@@ -21,7 +21,7 @@ import (
 {{.Doc}}
 func {{.Name}}(
     {{if $.Config.ContextType -}}
-    ctx {{$.Config.ContextType}},
+    ctx {{$.Config.ContextTypeReference}},
     {{end}}
     {{- if not $.Config.ClientGetter -}}
     client graphql.Client,

generate/testdata/queries/InputObject.graphql.json

@@ -1 +1 @@
-{"operations":[{"operationName":"InputObjectQuery","query":"\nquery InputObjectQuery ($query: UserQueryInput) {\n\tuser(query: $query) {\n\t\tid\n\t}\n}\n"}]}
+{"operations":[{"operationName":"InputObjectQuery","query":"\nquery InputObjectQuery ($query: UserQueryInput) {\n\tuser(query: $query) {\n\t\tid\n\t}\n}\n","sourceLocation":"testdata/queries/InputObject.graphql"}]}

generate/testdata/queries/InterfaceNoFragments.graphql.json

@@ -1 +1 @@
-{"operations":[{"operationName":"InterfaceNoFragmentsQuery","query":"\nquery InterfaceNoFragmentsQuery {\n\troot {\n\t\tid\n\t\tname\n\t\tchildren {\n\t\t\tid\n\t\t\tname\n\t\t}\n\t}\n}\n"}]}
+{"operations":[{"operationName":"InterfaceNoFragmentsQuery","query":"\nquery InterfaceNoFragmentsQuery {\n\troot {\n\t\tid\n\t\tname\n\t\tchildren {\n\t\t\tid\n\t\t\tname\n\t\t}\n\t}\n}\n","sourceLocation":"testdata/queries/InterfaceNoFragments.graphql"}]}

generate/testdata/queries/ListInput.graphql.json

@@ -1 +1 @@
-{"operations":[{"operationName":"ListInputQuery","query":"\nquery ListInputQuery ($names: [String]) {\n\tuser(query: {names:$names}) {\n\t\tid\n\t}\n}\n"}]}
+{"operations":[{"operationName":"ListInputQuery","query":"\nquery ListInputQuery ($names: [String]) {\n\tuser(query: {names:$names}) {\n\t\tid\n\t}\n}\n","sourceLocation":"testdata/queries/ListInput.graphql"}]}

generate/testdata/queries/QueryWithAlias.graphql.json

@@ -1 +1 @@
-{"operations":[{"operationName":"QueryWithAlias","query":"\nquery QueryWithAlias {\n\tUser: user {\n\t\tID: id\n\t}\n}\n"}]}
+{"operations":[{"operationName":"QueryWithAlias","query":"\nquery QueryWithAlias {\n\tUser: user {\n\t\tID: id\n\t}\n}\n","sourceLocation":"testdata/queries/QueryWithAlias.graphql"}]}

generate/testdata/queries/QueryWithDoubleAlias.graphql.json

@@ -1 +1 @@
-{"operations":[{"operationName":"QueryWithDoubleAlias","query":"\nquery QueryWithDoubleAlias {\n\tuser {\n\t\tID: id\n\t\tAlsoID: id\n\t}\n}\n"}]}
+{"operations":[{"operationName":"QueryWithDoubleAlias","query":"\nquery QueryWithDoubleAlias {\n\tuser {\n\t\tID: id\n\t\tAlsoID: id\n\t}\n}\n","sourceLocation":"testdata/queries/QueryWithDoubleAlias.graphql"}]}

generate/testdata/queries/QueryWithEnums.graphql.json

@@ -1 +1 @@
-{"operations":[{"operationName":"QueryWithEnums","query":"\nquery QueryWithEnums {\n\tuser {\n\t\troles\n\t}\n\totherUser: user {\n\t\troles\n\t}\n}\n"}]}
+{"operations":[{"operationName":"QueryWithEnums","query":"\nquery QueryWithEnums {\n\tuser {\n\t\troles\n\t}\n\totherUser: user {\n\t\troles\n\t}\n}\n","sourceLocation":"testdata/queries/QueryWithEnums.graphql"}]}

generate/testdata/queries/QueryWithSlices.graphql.json

@@ -1 +1 @@
-{"operations":[{"operationName":"QueryWithSlices","query":"\nquery QueryWithSlices {\n\tuser {\n\t\temails\n\t\temailsOrNull\n\t\temailsWithNulls\n\t\temailsWithNullsOrNull\n\t}\n}\n"}]}
+{"operations":[{"operationName":"QueryWithSlices","query":"\nquery QueryWithSlices {\n\tuser {\n\t\temails\n\t\temailsOrNull\n\t\temailsWithNulls\n\t\temailsWithNullsOrNull\n\t}\n}\n","sourceLocation":"testdata/queries/QueryWithSlices.graphql"}]}

generate/testdata/queries/QueryWithStructs.graphql.json

@@ -1 +1 @@
-{"operations":[{"operationName":"QueryWithStructs","query":"\nquery QueryWithStructs {\n\tuser {\n\t\tauthMethods {\n\t\t\tprovider\n\t\t\temail\n\t\t}\n\t}\n}\n"}]}
+{"operations":[{"operationName":"QueryWithStructs","query":"\nquery QueryWithStructs {\n\tuser {\n\t\tauthMethods {\n\t\t\tprovider\n\t\t\temail\n\t\t}\n\t}\n}\n","sourceLocation":"testdata/queries/QueryWithStructs.graphql"}]}

generate/testdata/queries/SimpleInput.graphql.json

@@ -1 +1 @@
-{"operations":[{"operationName":"SimpleInputQuery","query":"\nquery SimpleInputQuery ($name: String!) {\n\tuser(query: {name:$name}) {\n\t\tid\n\t}\n}\n"}]}
+{"operations":[{"operationName":"SimpleInputQuery","query":"\nquery SimpleInputQuery ($name: String!) {\n\tuser(query: {name:$name}) {\n\t\tid\n\t}\n}\n","sourceLocation":"testdata/queries/SimpleInput.graphql"}]}

generate/testdata/queries/SimpleQuery.graphql.json

@@ -1 +1 @@
-{"operations":[{"operationName":"SimpleQuery","query":"\nquery SimpleQuery {\n\tuser {\n\t\tid\n\t}\n}\n"}]}
+{"operations":[{"operationName":"SimpleQuery","query":"\nquery SimpleQuery {\n\tuser {\n\t\tid\n\t}\n}\n","sourceLocation":"testdata/queries/SimpleQuery.graphql"}]}

generate/testdata/queries/TypeName.graphql.json

@@ -1 +1 @@
-{"operations":[{"operationName":"TypeNameQuery","query":"\nquery TypeNameQuery {\n\tuser {\n\t\t__typename\n\t\tid\n\t}\n}\n"}]}
+{"operations":[{"operationName":"TypeNameQuery","query":"\nquery TypeNameQuery {\n\tuser {\n\t\t__typename\n\t\tid\n\t}\n}\n","sourceLocation":"testdata/queries/TypeName.graphql"}]}

generate/testdata/queries/UnionNoFragments.graphql.json

@@ -1 +1 @@
-{"operations":[{"operationName":"UnionNoFragmentsQuery","query":"\nquery UnionNoFragmentsQuery {\n\trandomLeaf {\n\t\t__typename\n\t}\n}\n"}]}
+{"operations":[{"operationName":"UnionNoFragmentsQuery","query":"\nquery UnionNoFragmentsQuery {\n\trandomLeaf {\n\t\t__typename\n\t}\n}\n","sourceLocation":"testdata/queries/UnionNoFragments.graphql"}]}

generate/testdata/queries/UsesEnumTwice.graphql.json

@@ -1 +1 @@
-{"operations":[{"operationName":"UsesEnumTwiceQuery","query":"\nquery UsesEnumTwiceQuery {\n\tMe: user {\n\t\troles\n\t}\n\tOtherUser: user {\n\t\troles\n\t}\n}\n"}]}
+{"operations":[{"operationName":"UsesEnumTwiceQuery","query":"\nquery UsesEnumTwiceQuery {\n\tMe: user {\n\t\troles\n\t}\n\tOtherUser: user {\n\t\troles\n\t}\n}\n","sourceLocation":"testdata/queries/UsesEnumTwice.graphql"}]}

generate/testdata/queries/unexported.graphql.json

@@ -1 +1 @@
-{"operations":[{"operationName":"unexported","query":"\nquery unexported ($query: UserQueryInput) {\n\tuser(query: $query) {\n\t\tid\n\t}\n}\n"}]}
+{"operations":[{"operationName":"unexported","query":"\nquery unexported ($query: UserQueryInput) {\n\tuser(query: $query) {\n\t\tid\n\t}\n}\n","sourceLocation":"testdata/queries/unexported.graphql"}]}