-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #150 from 0xff-dev/main
feat: graphql base framework for bff server
- Loading branch information
Showing
14 changed files
with
5,697 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -245,4 +245,10 @@ catalog-push: ## Push a catalog image. | |
| # CLI Arcadia | ||
| .PHONY: arctl | ||
| arctl: fmt vet ## Build manager binary. | ||
| go build -o bin/arctl arctl/*.go | ||
| go build -o bin/arctl arctl/*.go | ||
|
|
||
| # graphql-server go | ||
| gql-gen: | ||
| @go run github.com/99designs/[email protected] generate | ||
| build-graphql-server: | ||
| @CGO_ENABLED=0 GOOS=linux go build -o go-bff-server graphql-server/go-server/main.go | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| # Where are all the schema files located? globs are supported eg src/**/*.graphqls | ||
| schema: | ||
| - graphql-server/go-server/graph/*.graphqls | ||
|
|
||
| # Where should the generated server code go? | ||
| exec: | ||
| filename: graphql-server/go-server/graph/generated.go | ||
| package: graph | ||
|
|
||
| # Uncomment to enable federation | ||
| # federation: | ||
| # filename: graph/federation.go | ||
| # package: graph | ||
|
|
||
| # Where should any generated models go? | ||
| model: | ||
| filename: graphql-server/go-server/graph/model/models_gen.go | ||
| package: model | ||
|
|
||
| # Where should the resolver implementations go? | ||
| resolver: | ||
| layout: follow-schema | ||
| dir: graphql-server/go-server/graph | ||
| package: graph | ||
| filename_template: "{name}.resolvers.go" | ||
| # Optional: turn on to not generate template comments above resolvers | ||
| # omit_template_comment: false | ||
|
|
||
| # Optional: turn on use ` + "`" + `gqlgen:"fieldName"` + "`" + ` tags in your models | ||
| # struct_tag: json | ||
|
|
||
| # Optional: turn on to use []Thing instead of []*Thing | ||
| # omit_slice_element_pointers: false | ||
|
|
||
| # Optional: turn on to omit Is<Name>() methods to interface and unions | ||
| # omit_interface_checks : true | ||
|
|
||
| # Optional: turn on to skip generation of ComplexityRoot struct content and Complexity function | ||
| # omit_complexity: false | ||
|
|
||
| # Optional: turn on to not generate any file notice comments in generated files | ||
| # omit_gqlgen_file_notice: false | ||
|
|
||
| # Optional: turn on to exclude the gqlgen version in the generated file notice. No effect if `omit_gqlgen_file_notice` is true. | ||
| # omit_gqlgen_version_in_file_notice: false | ||
|
|
||
| # Optional: turn off to make struct-type struct fields not use pointers | ||
| # e.g. type Thing struct { FieldA OtherThing } instead of { FieldA *OtherThing } | ||
| struct_fields_always_pointers: false | ||
|
|
||
| # Optional: turn off to make resolvers return values instead of pointers for structs | ||
| # resolvers_always_return_pointers: false | ||
|
|
||
| # Optional: turn on to return pointers instead of values in unmarshalInput | ||
| # return_pointers_in_unmarshalinput: false | ||
|
|
||
| # Optional: wrap nullable input fields with Omittable | ||
| # nullable_input_omittable: true | ||
|
|
||
| # Optional: set to speed up generation time by not performing a final validation pass. | ||
| # skip_validation: true | ||
|
|
||
| # Optional: set to skip running `go mod tidy` when generating server code | ||
| # skip_mod_tidy: true | ||
|
|
||
| # gqlgen will search for any type names in the schema in these go packages | ||
| # if they match it will use them, otherwise it will generate them. | ||
| autobind: | ||
| # - "github.com/00/gqlgen-todos/graph/model" | ||
|
|
||
| # This section declares type mapping between the GraphQL and go type systems | ||
| # | ||
| # The first line in each type will be used as defaults for resolver arguments and | ||
| # modelgen, the others will be allowed when binding to fields. Configure them to | ||
| # your liking | ||
| models: | ||
| ID: | ||
| model: | ||
| - github.com/99designs/gqlgen/graphql.ID | ||
| - github.com/99designs/gqlgen/graphql.Int | ||
| - github.com/99designs/gqlgen/graphql.Int64 | ||
| - github.com/99designs/gqlgen/graphql.Int32 | ||
| Int: | ||
| model: | ||
| - github.com/99designs/gqlgen/graphql.Int | ||
| - github.com/99designs/gqlgen/graphql.Int64 | ||
| - github.com/99designs/gqlgen/graphql.Int32 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| ## How to develop | ||
|
|
||
| **There can only be one Query structure in all schemas, and Mutation can have one or none.** | ||
| **Query and Mutation define the entry point to the service. The fields, functions, defined below these two structures are what the front-end uses to query.** | ||
|
|
||
|
|
||
| Now that there is a `datasource` definition in the code, we can add new structures and related functions as follows. | ||
|
|
||
| ### Add schema | ||
|
|
||
| go to `graph` dir. | ||
|
|
||
| ```shell | ||
| cat << EOF > x.graphqls | ||
| type X { | ||
| name: String | ||
| } | ||
| EOF | ||
| ``` | ||
|
|
||
| ### Add a query function | ||
|
|
||
| The `graph/datasource.graphqls` file defines the Query structure, so we need to edit this file to add a function. | ||
|
|
||
| ```shell | ||
| type Query { | ||
| ds(input: QueryDatasource!): [Datasource!] | ||
| findX(input: String!): String! | ||
| } | ||
| ``` | ||
|
|
||
| ### generate resolver | ||
|
|
||
| in the root dir of the project: | ||
|
|
||
| ```shell | ||
| make gql-gen | ||
| ``` | ||
|
|
||
| Looking at `datasource.resolver.go`, I can see the addition of the function we defined: | ||
|
|
||
| ```go | ||
| func (r *queryResolver) FindX(ctx context.Context, input string) (string, error) { | ||
| panic(fmt.Errorf("not implemented: FindX - findX")) | ||
| } | ||
| ``` | ||
|
|
||
| The file `model/model_gen.go` has a new structure x that we defined. | ||
|
|
||
| All we have to do is just implement the `FindX` function. And the content of the function is up to you to play with. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| scalar Time | ||
| scalar Map | ||
|
|
||
| type Condition { | ||
| type: String! | ||
| status: String! | ||
| lastTransitionTime: Time! | ||
| lastSuccessfulTime: Time | ||
| reason: String! | ||
| message: String | ||
| } | ||
|
|
||
|
|
||
| type DatasourceStatus { | ||
| conditions: [Condition!] | ||
| } | ||
| type DatasourceSpec { | ||
| url: String | ||
| authsecret: String | ||
| } | ||
|
|
||
| type Datasource { | ||
| kind: String! | ||
| apiVersion: String! | ||
| name: String! | ||
| namespace: String! | ||
| uid: String! | ||
| resourceVersion: String! | ||
| generation: Int! | ||
| creationTimestamp: Time! | ||
| deletionTimestamp: Time | ||
| labels: Map | ||
| annotations: Map | ||
| finalizers: [String!] | ||
| spec: DatasourceSpec | ||
| status: DatasourceStatus | ||
| } | ||
|
|
||
| input QueryDatasource { | ||
| # 有name直接根据name查询 | ||
| name: String | ||
| namespace: String! | ||
| labelSelector: String | ||
| fieldSelector: String | ||
| } | ||
| type Query { | ||
| ds(input: QueryDatasource!): [Datasource!] | ||
| } | ||
|
|
||
| input CreateDatasource { | ||
| name: String! | ||
| namespace: String! | ||
| url: String | ||
| authsecret: String | ||
| } | ||
|
|
||
| type Mutation { | ||
| createDatasource(input: CreateDatasource!): Datasource! | ||
| } |
Oops, something went wrong.