这是indexloc提供的服务，不要输入任何密码
Skip to content

feat(graphql): add ignore prefixes config option #57

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 27, 2022
Merged

feat(graphql): add ignore prefixes config option #57

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions graphql.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,10 @@ type GraphQLConfig struct {
// `GraphQLDefaultPaginator` is used.
Paginator GraphQLPaginator

// IgnorePrefixes defines path prefixes which should be ignored by the
// GraphQL model generator.
IgnorePrefixes []string

// known keeps track of known structs since they can only be defined once
// per GraphQL endpoint. If used by multiple HTTP operations, they must
// reference the same struct converted to GraphQL schema.
Expand Down Expand Up @@ -374,7 +378,13 @@ func (r *Router) EnableGraphQL(config *GraphQLConfig) {
config.costMap = gqlcost.CostMap{}
config.paginatorType = reflect.TypeOf(config.Paginator).Elem()

outer:
for _, resource := range resources {
for _, prefix := range config.IgnorePrefixes {
if strings.HasPrefix(resource.path, prefix) {
continue outer
}
}
r.handleResource(config, "Query", fields, resource, map[string]bool{})
}

Expand Down
25 changes: 25 additions & 0 deletions graphql_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,8 +194,15 @@ func TestGraphQL(t *testing.T) {
ctx.WriteModel(http.StatusOK, categories[input.CategoryID].products[input.ProductID].stores[input.StoreID])
})

app.Resource("/ignored").Get("get-ignored", "doc",
NewResponse(http.StatusOK, "").Model(struct{ ID string }{}),
).Run(func(ctx Context) {
ctx.WriteHeader(http.StatusOK)
})

app.EnableGraphQL(&GraphQLConfig{
ComplexityLimit: 250,
IgnorePrefixes: []string{"/ignored"},
})

query := strings.Replace(strings.Replace(`{
Expand Down Expand Up @@ -304,4 +311,22 @@ data:
id: target
url: https://www.target.com/
`, "\t", " ", -1), w.Body.String())

// Confirm expected top-level fields in the query API.
w = httptest.NewRecorder()
req, _ = http.NewRequest(http.MethodGet, "/graphql?query={__schema{queryType{fields{name}}}}", nil)
app.ServeHTTP(w, req)

assert.Equal(t, http.StatusOK, w.Code)
assert.YAMLEq(t, strings.Replace(`data:
__schema:
queryType:
fields:
- name: categories
- name: categoriesItem
- name: products
- name: productsItem
- name: stores
- name: storesItem
`, "\t", " ", -1), w.Body.String())
}