package generate import ( "fmt" "strconv" "strings" "github.com/vektah/gqlparser/ast" ) type typeBuilder struct { typeName string strings.Builder *generator } func (g *generator) baseTypeForOperation(operation ast.Operation) *ast.Definition { switch operation { case ast.Query: return g.schema.Query case ast.Mutation: return g.schema.Mutation case ast.Subscription: return g.schema.Subscription default: panic(fmt.Sprintf("unexpected operation: %v", operation)) } } func (g *generator) getTypeForOperation(operation *ast.OperationDefinition) (name string, err error) { // TODO: configure ResponseName format name = operation.Name + "Response" if def, ok := g.typeMap[name]; ok { // TODO: check for and handle conflicts a better way return "", fmt.Errorf("%s already defined:\n%s", name, def) } selectionSet, err := selections(operation.SelectionSet) if err != nil { return "", err } return g.addTypeForDefinition( name, g.baseTypeForOperation(operation.Operation), selectionSet) } func (g *generator) addTypeForDefinition(nameOverride string, typ *ast.Definition, selectionSet []selection) (name string, err error) { goName, ok := builtinTypes[typ.Name] if ok { return goName, nil } if nameOverride != "" { name = nameOverride } else { // TODO: casing should be configurable name = upperFirst(typ.Name) } // TODO: in some cases we can deduplicate, do that // TODO: nicer naming scheme i := 0 origName := name for g.typeMap[name] != "" { i++ name = origName + strconv.Itoa(i) } builder := &typeBuilder{typeName: name, generator: g} fmt.Fprintf(builder, "type %s ", name) err = builder.writeTypedef(typ, selectionSet) if err != nil { return "", err } g.typeMap[name] = builder.String() return name, nil } func (g *generator) getTypeForInputType(typ *ast.Type) (string, error) { builder := &typeBuilder{typeName: upperFirst(typ.Name()), generator: g} err := builder.writeType(typ, selectionsForType(g, typ)) return builder.String(), err } // TODO: this is really "field" now, rename it type selection interface { Alias() string Type() *ast.Type SelectionSet() ([]selection, error) } type field struct{ field *ast.Field } func (s field) Alias() string { if s.field.Alias != "" { return s.field.Alias } // TODO: is this case needed? tests don't seem to get here. return s.field.Name } func (s field) Type() *ast.Type { if s.field.Definition == nil { return nil } return s.field.Definition.Type } func (s field) SelectionSet() ([]selection, error) { return selections(s.field.SelectionSet) } func selections(selectionSet ast.SelectionSet) ([]selection, error) { retval := make([]selection, len(selectionSet)) for i, selection := range selectionSet { switch selection := selection.(type) { case *ast.Field: retval[i] = field{selection} case *ast.FragmentSpread, *ast.InlineFragment: return nil, fmt.Errorf("not implemented: %T", selection) default: return nil, fmt.Errorf("invalid selection type: %v", selection) } } return retval, nil } type inputField struct { *generator field *ast.FieldDefinition } func (s inputField) Alias() string { return s.field.Name } func (s inputField) Type() *ast.Type { return s.field.Type } func (s inputField) SelectionSet() ([]selection, error) { return selectionsForType(s.generator, s.field.Type), nil } func selectionsForType(g *generator, typ *ast.Type) []selection { def := g.schema.Types[typ.Name()] selectionSet := make([]selection, len(def.Fields)) for i, field := range def.Fields { selectionSet[i] = inputField{g, field} } return selectionSet } func (builder *typeBuilder) writeField(selection selection) error { jsonName := selection.Alias() // We need an exportable name for JSON-marshaling. goName := upperFirst(jsonName) builder.WriteString(goName) builder.WriteRune(' ') typ := selection.Type() if typ == nil { // Unclear why gqlparser hasn't already rejected this, // but empirically it might not. return fmt.Errorf("undefined field %v", selection.Alias()) } selectionSet, err := selection.SelectionSet() if err != nil { return err } err = builder.writeType(typ, selectionSet) if err != nil { return err } if builder.schema.Types[typ.Name()].IsAbstractType() { // abstract types are handled in our UnmarshalJSON builder.WriteString(" `json:\"-\"`") } else if jsonName != goName { fmt.Fprintf(builder, " `json:\"%s\"`", jsonName) } builder.WriteRune('\n') return nil } var builtinTypes = map[string]string{ "Int": "int", // TODO: technically int32 is always enough, use that? "Float": "float64", "String": "string", "Boolean": "bool", "ID": "string", // TODO: named type for IDs? } func (builder *typeBuilder) writeType(typ *ast.Type, selectionSet []selection) error { // gqlgen does slightly different things here since it defines names for // all the intermediate types, but its implementation may be useful to crib // from: // https://github.com/99designs/gqlgen/blob/master/plugin/modelgen/models.go#L113 // TODO: or maybe we should do that? if typ.Elem != nil { // Type is a list. builder.WriteString("[]") typ = typ.Elem } if !typ.NonNull { builder.WriteString("*") } def := builder.schema.Types[typ.Name()] // Writes a typedef elsewhere (if not already defined) name, err := builder.addTypeForDefinition("", def, selectionSet) if err != nil { return err } builder.WriteString(name) return nil } func (builder *typeBuilder) writeTypedef(typedef *ast.Definition, selectionSet []selection) error { switch typedef.Kind { case ast.Object, ast.InputObject: builder.WriteString("struct {\n") for _, field := range selectionSet { err := builder.writeField(field) if err != nil { return err } } builder.WriteString("}") // If any field is abstract, we need an UnmarshalJSON method to handle // it. return builder.maybeWriteUnmarshal(selectionSet) case ast.Interface, ast.Union: // First, write the interface type. builder.WriteString("interface {\n") implementsMethodName := fmt.Sprintf("implementsGraphQLInterface%v", builder.typeName) // TODO: Also write GetX() accessor methods for fields of the interface builder.WriteString(implementsMethodName) builder.WriteString("()\n") builder.WriteString("}") // Then, write the implementations. // TODO(benkraft): Put a doc-comment somewhere with the list. for _, impldef := range builder.schema.GetPossibleTypes(typedef) { name, err := builder.addTypeForDefinition("", impldef, selectionSet) if err != nil { return err } // HACK HACK HACK builder.typeMap[name] += fmt.Sprintf( "\nfunc (v %v) %v() {}", name, implementsMethodName) } return nil case ast.Enum: // All GraphQL enums have underlying type string (in the Go sense). builder.WriteString("string\n") builder.WriteString("const (\n") for _, val := range typedef.EnumValues { // TODO: casing should be configurable fmt.Fprintf(builder, "%s %s = \"%s\"\n", goConstName(val.Name+"_"+builder.typeName), builder.typeName, val.Name) } builder.WriteString(")\n") return nil case ast.Scalar: // TODO(benkraft): Handle custom scalars. return fmt.Errorf("not implemented: %v", typedef.Kind) default: return fmt.Errorf("unexpected kind: %v", typedef.Kind) } }