-
Notifications
You must be signed in to change notification settings - Fork 181
/
extension.go
285 lines (259 loc) · 8.07 KB
/
extension.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
// Copyright 2019-present Facebook
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package entgql
import (
"fmt"
"os"
"path/filepath"
"entgo.io/ent/entc"
"entgo.io/ent/entc/gen"
"github.com/99designs/gqlgen/api"
"github.com/99designs/gqlgen/codegen/config"
"github.com/vektah/gqlparser/v2/ast"
)
type (
// Extension implements the entc.Extension for providing GraphQL integration.
Extension struct {
schemaGenerator
entc.DefaultExtension
outputWriter func(*ast.Schema) error
hooks []gen.Hook
templates []*gen.Template
}
// ExtensionOption allows for managing the Extension configuration
// using functional options.
ExtensionOption func(*Extension) error
// SchemaHook is the hook that run after the GQL schema generation.
SchemaHook func(*gen.Graph, *ast.Schema) error
)
// WithSchemaPath sets the filepath to the GraphQL schema to write the
// generated Ent types. If the file does not exist, it will generate a
// new schema. Please note that your gqlgen.yml config file should be
// updated as follows to support multiple schema files:
//
// schema:
// - schema.graphql // existing schema.
// - ent.graphql // generated schema.
func WithSchemaPath(path string) ExtensionOption {
return func(ex *Extension) error {
ex.path = path
return nil
}
}
// WithOutputWriter sets the function to write the generated schema.
func WithOutputWriter(w func(*ast.Schema) error) ExtensionOption {
return func(ex *Extension) error {
ex.outputWriter = w
return nil
}
}
// WithSchemaHook allows users to provide a list of hooks
// to run after the GQL schema generation.
func WithSchemaHook(hooks ...SchemaHook) ExtensionOption {
return func(ex *Extension) error {
ex.schemaHooks = append(ex.schemaHooks, hooks...)
return nil
}
}
// WithConfigPath sets the filepath to gqlgen.yml configuration file
// and injects its parsed version to the global annotations.
//
// Note that, enabling this option is recommended as it improves the
// GraphQL integration,
func WithConfigPath(path string, gqlgenOptions ...api.Option) ExtensionOption {
return func(ex *Extension) (err error) {
cwd, err := os.Getwd()
if err != nil {
return fmt.Errorf("unable to get working directory: %w", err)
}
if err := os.Chdir(filepath.Dir(path)); err != nil {
return fmt.Errorf("unable to enter config dir: %w", err)
}
defer func() {
if cerr := os.Chdir(cwd); cerr != nil {
err = fmt.Errorf("unable to restore working directory: %w", cerr)
}
}()
cfg, err := config.LoadConfig(filepath.Base(path))
if err != nil {
return err
}
ex.cfg = cfg
return nil
}
}
// WithTemplates overrides the default templates (entgql.AllTemplates)
// with specific templates.
func WithTemplates(templates ...*gen.Template) ExtensionOption {
return func(ex *Extension) error {
ex.templates = templates
return nil
}
}
var (
// WithWhereFilters configures the extension to either add or
// remove the WhereTemplate from the code generation templates.
//
// Deprecated: use WithWhereInputs instead. This option is planned
// to be removed in future versions.
WithWhereFilters = WithWhereInputs
)
// WithWhereInputs configures the extension to either add or
// remove the WhereTemplate from the code generation templates.
//
// The WhereTemplate generates GraphQL filters to all types in the ent/schema.
func WithWhereInputs(b bool) ExtensionOption {
return func(ex *Extension) error {
ex.genWhereInput = b
i, exists := ex.hasTemplate(WhereTemplate)
if b && !exists {
ex.templates = append(ex.templates, WhereTemplate)
} else if !b && exists && len(ex.templates) > 0 {
ex.templates = append(ex.templates[:i], ex.templates[i+1:]...)
}
return nil
}
}
// WithNodeDescriptor configures the extension to either add or
// remove the NodeDescriptorTemplate from the code generation templates.
//
// In case this option is enabled, EntGQL generates a `Node()` method for each
// type that returns its representation in one standard way. A common use case for
// this option is to develop an administrator tool on top of Ent as implemented in:
// https://github.com/ent/ent/issues/1000#issuecomment-735663175.
func WithNodeDescriptor(b bool) ExtensionOption {
return func(ex *Extension) error {
i, exists := ex.hasTemplate(NodeDescriptorTemplate)
if b && !exists {
ex.templates = append(ex.templates, NodeDescriptorTemplate)
} else if !b && exists && len(ex.templates) > 0 {
ex.templates = append(ex.templates[:i], ex.templates[i+1:]...)
}
return nil
}
}
// WithRelaySpec enables or disables generating the Relay Node interface.
func WithRelaySpec(enabled bool) ExtensionOption {
return func(e *Extension) error {
e.relaySpec = enabled
return nil
}
}
// WithSchemaGenerator add a hook for generate GQL schema
func WithSchemaGenerator() ExtensionOption {
return func(e *Extension) error {
e.genSchema = true
return nil
}
}
// WithMapScalarFunc allows users to provide a custom function that
// maps an ent.Field (*gen.Field) into its GraphQL scalar type. If the
// function returns an empty string, the extension fallbacks to its
// default mapping.
//
// ex, err := entgql.NewExtension(
// entgql.WithMapScalarFunc(func(f *gen.Field, op gen.Op) string {
// if t, ok := knowType(f, op); ok {
// return t
// }
// // Fallback to the default mapping.
// return ""
// }),
// )
func WithMapScalarFunc(scalarFunc func(*gen.Field, gen.Op) string) ExtensionOption {
return func(ex *Extension) error {
ex.scalarFunc = scalarFunc
return nil
}
}
// NewExtension creates a new extension with the given configuration.
//
// ex, err := entgql.NewExtension(
// entgql.WithSchemaGenerator(),
// entgql.WithSchemaPath("../ent.graphql"),
// entgql.WithWhereInputs(true),
// )
func NewExtension(opts ...ExtensionOption) (*Extension, error) {
ex := &Extension{
templates: AllTemplates,
schemaGenerator: schemaGenerator{
relaySpec: true,
genMutations: true,
},
}
for _, opt := range opts {
if err := opt(ex); err != nil {
return nil, err
}
}
ex.hooks = append(ex.hooks, ex.genSchemaHook(), removeOldAssets)
return ex, nil
}
// Templates of the extension.
func (e *Extension) Templates() []*gen.Template {
return e.templates
}
// Hooks of the extension.
func (e *Extension) Hooks() []gen.Hook {
return e.hooks
}
// Options of the extension.
func (e *Extension) Options() []entc.Option {
return []entc.Option{
entc.FeatureNames(gen.FeatureNamedEdges.Name),
}
}
// genSchema returns a new hook for generating
// the GraphQL schema from the graph.
func (e *Extension) genSchemaHook() gen.Hook {
return func(next gen.Generator) gen.Generator {
return gen.GenerateFunc(func(g *gen.Graph) (err error) {
if err = next.Generate(g); err != nil {
return err
}
if !(e.genSchema || e.genWhereInput || e.genMutations) {
return nil
}
schema, err := e.BuildSchema(g)
if err != nil {
return err
}
if e.outputWriter == nil {
if e.path == "" {
return nil
}
return os.WriteFile(e.path, []byte(printSchema(schema)), 0644)
}
return e.outputWriter(schema)
})
}
}
// hasTemplate reports if the template exists
// in the template list and returns its index.
func (e *Extension) hasTemplate(tem *gen.Template) (int, bool) {
for i := range e.templates {
if e.templates[i].Name() == tem.Templates()[1].Name() {
return i, true
}
}
return -1, false
}
var (
_ entc.Extension = (*Extension)(nil)
camel = gen.Funcs["camel"].(func(string) string)
pascal = gen.Funcs["pascal"].(func(string) string)
plural = gen.Funcs["plural"].(func(string) string)
singular = gen.Funcs["singular"].(func(string) string)
snake = gen.Funcs["snake"].(func(string) string)
)