Skip to content

Commit

Permalink
Package update (#17)
Browse files Browse the repository at this point in the history
* Support for embedded struct type in resolver

* fix bug in slice pop

* fix bug while finding field

* add 'getFieldCount' to resolve ambiguity

* Increase extensions test coverage

* Remove duplicate unit tests

* rename 'getFieldCount' to 'fieldCount'

* add test for ambiguous field panic

* add unit tests for embedded struct feature

* rename TestEmbedded => TestEmbeddedStruct

* Fixes graph-gophers#357

* Actually fix graph-gophers#357

* Print context to panic log

* Add Example of Custom Errors

Adding example and documentation for how to create custom error
 implementations which include `extensions` within their `error` payload

* Clarify errors for mismatching input implementation

Producing clearer error messages when field input arguments are
 implemented by code:

 * Which does not match the schema e.g. missing field; or
 * Function missing struct wrapper for field arguments

* Allow `schema` to be omitted when using default root op names

* Strip Common Indentation from BlockString Descriptions

Multi-line descriptions need to have their common indentation level
 (which results from indentation of that part of the schema, rather than
 being intentional for the description text) removed to ensure the
 descriptions use the correct value, are formatted correctly etc

This is to meet the condition documented in the GraphQL spec:

https://graphql.github.io/graphql-spec/June2018/#sec-String-Value

> Since block strings represent freeform text often used in indented
>  positions, the string value semantics of a block string excludes
>  uniform indentation and blank initial and trailing lines via
>  BlockStringValue().

* Syntax highlighting fixed in README

* Add walkthrough

Fixed small punctuation and added my walkthrough package

* Update README.md

* Add support for directives in schema parser

* Use operationName from query if missing from POST

* Fix SIGSEGV when client subs to multiple fields

* bugfix: correctly determine fragment usage

In previous versions of this code, this validation would exit when it
encountered a fragment legitimately used twice. This bugfix skips the recursion
but does not stop progress altogether allowing other fragments to be marked as
used.

* Limit the number of concurrent list nodes processed

It uses the current capacity of the limiter as a hint as this is set
based on the maxParallelism field on the schema.

* Remove need for WaitGroup

* More descriptive error when unmarshaling ID/Time

This adds a tiny bit more information to the error messages produced
when unmarshaling an input value to an ID or Time fails.

* Improve README.md

Fixes graph-gophers#307

Add short descriptions for different schema options.
Move community examples to wiki.
Add companies that use this library.

* fix graph-gophers#241

Similar to graph-gophers#407, but adds test cases.

* Add comment explaining why we limit concurrency

* Issue graph-gophers#299: unclear error message in case of multiline string argument

* handle case where interface is type-asserted to same interface

* Issue graph-gophers#299: unclear error message in case of multiline strings

* Issue graph-gophers#299: unclear error message in case of multiline string argument

* Update logic to always check for nil pointer returns

* Adding variables parameter for query validations.

* Fixed `reflect.Value.Type on zero Value` panic when subscription resolver itself panicks

The internal exec Subscribe method had code to deal with subscription resolver panicking
when being called. But when such handling happen, the error is attached to the request
object and it never checked later on.

This leads to some zero checks to fail when we try to extract the type from the resolver's
channel since this variable was never set. Doing this creates a second panic which is not
handled and make the application die.

To fix the issue, we now check if there is errors on the request object before continuing
with the rest of the check, if there is errors, it's because a panic occurs and we return
the response right away.

* Added possibility to customize subscription resolver timeout value

The previous value was hard-coded to 1 second. This is problematic for resolver that
takes more time than this to return a result.

When parsing the schema, it's not possible to pass a custom value for the subscription
resolver timeout.

Extracted from graph-gophers#317

* Allowed Subscription resolver to return `*QueryError` directly

Previously, any error returned by the Subscription resolver was immediately wrapped inside
its own `*QueryError` value even if the returned error was already a `*QueryError`.

Now, when receiving such types, we use it as-is without wrapping again.

* Adding/removing empty lines where needed

* DisableIntrospection should not skip __typename for usages of GraphQL union types

* Add context to validation tracing

Context is needed for tracing to access the current span, in order to
 add tags to it, or create child spans. As presently defined (without a
 context), this cannot be done: new spans could be created, but they
 would not be associated with the existing request trace.

OpenTracingTracer implements the new interface (it never implemented the
 old one). Via this 'extension interface', the tracer configured (or the
 default tracer) will be used as the validation tracer if:

 * The tracer implements the (optional) interface; and
 * A validation tracer isn't provided using the deprecated option

What this means is that the deprecated option is _preferred_ as an
 override. This allows users to migrate in a non-breaking, non-behaviour
 changing way, until such time as they intentionally remove the use of
 the deprecated option. For those who are currently using the default
 tracer, and not supplying a validation tracer, validation will be traced
 immediately with no change required to configuration options.

* Add support for nullable types

This allows to differentiate between an omitted value and a null value
in an input struct.

* Fixed duplicated __typename in response (fixes graph-gophers#369)

* Create CHANGELOG.md

* Update CHANGELOG.md

* ignore JetBrains IDEA and vscode meta directories

* expose packer.Unmarshaler interface as graphql.Unmarshaler
- add tests for graphql.Time as reference implementation

* move packer.Unmarshaler interface to decode.Unmarshaler, so the methods are actually visible

* add types package

Part of graph-gophers#434 and related to graph-gophers#116 this change adds a new package containing all
types used by graphql-go in representing the GraphQL specification. The names
used in this package should match the specification as closely as possible.

In order to have cohesion, all internal packages that use GraphQL types have
been changed to use this new package.

This change is large but mostly mechanical. I recommend starting by reading
through the `types` package to build familiarity. I'll call out places in the
code where I made decisions and what the tradeoffs were.

* add getter for the types.Schema field

This additive function shouldn't break backward compatibility will allow those
who want access to the types to get at an AST version of the `types.Schema`

* unused fields

* rename to match types

* remove unused

* use a string and not an Ident for a FieldDefinition's name

This was an error. When this field was renamed from schema.Field (to avoid
ambiguity) its name field changed to match query.Field (to Ident). This caused a
cascade of useless changes that will be rolled back in the next commit

* fix compile errors introduced by ab449f0

* merge conflict errors

* add location fields to type definitions

* Fix dir in readme

* coerce float64 to int32 in NullInt and vice versa in NullFloat

* errors.Errorf preserves original error similar to fmt.Error

* removed test dependency on errors.Is

* checkErrors ignores the raw error for purposes of determining if the test passed or failed

* Update CHANGELOG.md

* internal/exec: assign parent type name to __typename fields

* Accepting value Json in parameter of request's body in  custom Scalar (graph-gophers#467)

Accept JSON value in resolver args

* Add option for custom panic handler (graph-gophers#468)

Add option for custom panic handler

* Tests showing query variables are validated correctly (graph-gophers#470)

* README nit -- Move '$' out of cut/paste buffer (graph-gophers#473)

Move '$' out of cut/paste buffer

* internal/exec/resolvable: include struct field name in errors (graph-gophers#477)

* internal/exec/resolvable: include struct field name in errors

We were only adding method name, which meant that it was taking
an empty string if the resolver was a struct field. This was
making the error messages hard to parse as the user can't know
which field has the error.

Added a check to use the correct variable.

* improve test

* ci: setup SemaphoreCI v2 (graph-gophers#479)

Update Semaphore configuration

* Support "Interfaces Implementing Interfaces" (graph-gophers#471)

Interface implementing interfaces support https://spec.graphql.org/draft/#sec-Interfaces.Interfaces-Implementing-Interfaces

* README.md: Fix build status badge

I broke this accidentally when removing the legacy SemaphoreCI integration.

* fix golangci lint errors in the codebase (graph-gophers#478)

Added a base golangci-config to the codebase to get
started. Some more changes are pending, and those
checks are commented out in the config.

* Improve Sempahore CI (graph-gophers#481)

Improve Sempahore CI build

* Make some more golang-ci improvements (graph-gophers#483)

* graphql.Time unmarshal unix nano time (graph-gophers#486)

* validation: fix bug in maxDepth fragment spread logic (graph-gophers#492)

* Create codeql-analysis.yml

* Add OpenTelemetry Support (graph-gophers#493)

Add OpenTelemetry tracer implementation

* Improve the Getting Started section

* Update README.md

* Improve the Getting Started section in the README

* Create SECURITY.md

* Fix the OTEL tracer package name (graph-gophers#495)

* Fix parseObjectDef will terminate when object has bad syntax (graph-gophers#491) (graph-gophers#500)

Thank you for your contribution

* Fix remove checkNilCase test helper function (graph-gophers#504)

* Add graphql.Time example (graph-gophers#508)

* Apollo Federation Spec: Fetch service capabilities (graph-gophers#507)

Add basic support for Apollo Federation

Co-authored-by: Alam <[email protected]>
Co-authored-by: pavelnikolov <[email protected]>

* Ignore yarn.lock file

* add support for repeatable directives (graph-gophers#502)

add support for repeatable directives

* Fix example/social code (graph-gophers#510)

The `Friends` field had higher priority than the `FriendsResolver` method. This is the reason why the field was renamed to a value, that doesn't match the GraphQL resolver.

* Fix lint error (graph-gophers#512)

* Refactor trace package (graph-gophers#513)

Remove dependency for graphql-go on OpenTracing and OpenTelemetry except
 where those tracers are explicitly configured for use.

* Adding in primitive value validation. (graph-gophers#515)

* Update README.md

* Update README.md

* Improve type assertion method argument validation (require zero) (graph-gophers#516)

Improve type assertion method argument validation (require zero)

It's tempting to include a context argument (or think it's allowed), but
not discover that this will fail until a query is executed. Validating
the resolver during schema parsing reduces the chance of inadvertant
errors here.

Signed-off-by: Evan Owen <[email protected]>

* Disallow repeat of non repeatable directives (graph-gophers#525)

* Disallow repeat of non repeatable directives

* Remove unnecessary scallar

* Added changes lost after package update

* merging old prs

* adding gqlerrors support

* adding dev message, error code support

* Readded Export query name method functionality after package update

* Fix: extension initialisation and updated error method to return extension details

* updated QueryError Extensions to not emit if empty

---------

Signed-off-by: Evan Owen <[email protected]>
Co-authored-by: Elijah Oyekunle <[email protected]>
Co-authored-by: Pavel Nikolov <[email protected]>
Co-authored-by: Pavel Nikolov <[email protected]>
Co-authored-by: Dorian Thiessen <[email protected]>
Co-authored-by: Ivan <[email protected]>
Co-authored-by: David Ackroyd <[email protected]>
Co-authored-by: pavemaksim <[email protected]>
Co-authored-by: Tony Ghita <[email protected]>
Co-authored-by: Zaydek <[email protected]>
Co-authored-by: Sylvain Cleymans <[email protected]>
Co-authored-by: [email protected] <[email protected]>
Co-authored-by: Nicolas Maquet <[email protected]>
Co-authored-by: Sean Sorrell <[email protected]>
Co-authored-by: Ryan Slade <[email protected]>
Co-authored-by: Thorsten Ball <[email protected]>
Co-authored-by: obei <[email protected]>
Co-authored-by: Quinn Slack <[email protected]>
Co-authored-by: suntoucha <[email protected]>
Co-authored-by: Barry Dutton <[email protected]>
Co-authored-by: Sebastian Motavita <[email protected]>
Co-authored-by: Matthieu Vachon <[email protected]>
Co-authored-by: Epsirom <[email protected]>
Co-authored-by: David Ackroyd <[email protected]>
Co-authored-by: Vincent Composieux <[email protected]>
Co-authored-by: Silvio Ginter <[email protected]>
Co-authored-by: Sam Ko <[email protected]>
Co-authored-by: jinleileiking <[email protected]>
Co-authored-by: Edward Ma <[email protected]>
Co-authored-by: Matt Ho <[email protected]>
Co-authored-by: Tony Ghita <[email protected]>
Co-authored-by: Gustavo Delfim <[email protected]>
Co-authored-by: John Starich <[email protected]>
Co-authored-by: Florian Suess <[email protected]>
Co-authored-by: wejafoo <[email protected]>
Co-authored-by: Agniva De Sarker <[email protected]>
Co-authored-by: Steve Gray <[email protected]>
Co-authored-by: Connor Vanderhook <[email protected]>
Co-authored-by: roaris <[email protected]>
Co-authored-by: Sulthan Alam <[email protected]>
Co-authored-by: Alam <[email protected]>
Co-authored-by: speezepearson <[email protected]>
Co-authored-by: Dallas Phillips <[email protected]>
Co-authored-by: Evan Owen <[email protected]>
Co-authored-by: Igor <[email protected]>
Co-authored-by: Amritansh Kumar <[email protected]>
Co-authored-by: kumaramritansh <[email protected]>
  • Loading branch information
Show file tree
Hide file tree
Showing 92 changed files with 7,208 additions and 1,463 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
/.idea
/.vscode
/internal/validation/testdata/graphql-js
/internal/validation/testdata/node_modules
/vendor
35 changes: 35 additions & 0 deletions .golangci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
run:
timeout: 5m

linters-settings:
gofmt:
simplify: true
govet:
check-shadowing: true
enable-all: true
disable:
- fieldalignment
- deepequalerrors # remove later

linters:
disable-all: true
enable:
- deadcode
- gofmt
- gosimple
- govet
- ineffassign
- exportloopref
- structcheck
- staticcheck
- unconvert
- unused
- varcheck
- misspell
- goimports

issues:
exclude-rules:
- linters:
- unused
path: "graphql_test.go"
35 changes: 35 additions & 0 deletions .semaphore/semaphore.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
version: v1.0
name: Go
agent:
machine:
type: e1-standard-2
os_image: ubuntu2004
blocks:
- name: Style Check
task:
jobs:
- name: fmt
commands:
- sem-version go 1.17
- checkout
- ./scripts/golangci_install.sh -b $(go env GOPATH)/bin v1.42.1
- export PATH=$(go env GOPATH)/bin:$PATH
- golangci-lint run ./...

- name: Test & Build
task:
prologue:
commands:
- sem-version go 1.17
- export PATH=$(go env GOPATH)/bin:$PATH
- checkout
- go version

jobs:
- name: Test
commands:
- go test ./...

- name: Build
commands:
- go build -v .
10 changes: 10 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
CHANGELOG

[v1.1.0](https://github.com/tokopedia/graphql-go/releases/tag/v1.1.0) Release v1.1.0
* [FEATURE] Add types package #437
* [FEATURE] Expose `packer.Unmarshaler` as `decode.Unmarshaler` to the public #450
* [FEATURE] Add location fields to type definitions #454
* [FEATURE] `errors.Errorf` preserves original error similar to `fmt.Errorf` #456
* [BUGFIX] Fix duplicated __typename in response (fixes #369) #443

[v1.0.0](https://github.com/tokopedia/graphql-go/releases/tag/v1.0.0) Initial release
135 changes: 121 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# graphql-go [![Sourcegraph](https://sourcegraph.com/github.com/tokopedia/graphql-go/-/badge.svg)](https://sourcegraph.com/github.com/tokopedia/graphql-go?badge) [![Build Status](https://semaphoreci.com/api/v1/graph-gophers/graphql-go/branches/master/badge.svg)](https://semaphoreci.com/graph-gophers/graphql-go) [![GoDoc](https://godoc.org/github.com/tokopedia/graphql-go?status.svg)](https://godoc.org/github.com/tokopedia/graphql-go)
# graphql-go [![Sourcegraph](https://sourcegraph.com/github.com/tokopedia/graphql-go/-/badge.svg)](https://sourcegraph.com/github.com/tokopedia/graphql-go?badge) [![Build Status](https://tokopedia.semaphoreci.com/badges/graphql-go/branches/master.svg?style=shields)](https://tokopedia.semaphoreci.com/projects/graphql-go) [![GoDoc](https://godoc.org/github.com/tokopedia/graphql-go?status.svg)](https://godoc.org/github.com/tokopedia/graphql-go)

<p align="center"><img src="docs/img/logo.png" width="300"></p>

Expand All @@ -11,13 +11,13 @@ safe for production use.

- minimal API
- support for `context.Context`
- support for the `OpenTracing` standard
- support for the `OpenTelemetry` and `OpenTracing` standards
- schema type-checking against resolvers
- resolvers are matched to the schema based on method sets (can resolve a GraphQL schema with a Go interface or Go struct).
- handles panics in resolvers
- parallel execution of resolvers
- subscriptions
- [sample WS transport](https://github.com/graph-gophers/graphql-transport-ws)
- [sample WS transport](https://github.com/tokopedia/graphql-transport-ws)

## Roadmap

Expand All @@ -26,8 +26,9 @@ Feedback is welcome and appreciated.

## (Some) Documentation

### Basic Sample
### Getting started

In order to run a simple GraphQL server locally create a `main.go` file with the following content:
```go
package main

Expand All @@ -45,9 +46,6 @@ func (_ *query) Hello() string { return "Hello, world!" }

func main() {
s := `
schema {
query: Query
}
type Query {
hello: String!
}
Expand All @@ -57,11 +55,12 @@ func main() {
log.Fatal(http.ListenAndServe(":8080", nil))
}
```

To test:
Then run the file with `go run main.go`. To test:
```sh
$ curl -XPOST -d '{"query": "{ hello }"}' localhost:8080/query
curl -XPOST -d '{"query": "{ hello }"}' localhost:8080/query
```
For more realistic usecases check our [examples section](https://github.com/tokopedia/graphql-go/wiki/Examples).

### Resolvers

Expand Down Expand Up @@ -103,10 +102,118 @@ func (r *helloWorldResolver) Hello(ctx context.Context) (string, error) {
}
```

### Community Examples
### Schema Options

- `UseStringDescriptions()` enables the usage of double quoted and triple quoted. When this is not enabled, comments are parsed as descriptions instead.
- `UseFieldResolvers()` specifies whether to use struct field resolvers.
- `MaxDepth(n int)` specifies the maximum field nesting depth in a query. The default is 0 which disables max depth checking.
- `MaxParallelism(n int)` specifies the maximum number of resolvers per request allowed to run in parallel. The default is 10.
- `Tracer(tracer trace.Tracer)` is used to trace queries and fields. It defaults to `noop.Tracer`.
- `Logger(logger log.Logger)` is used to log panics during query execution. It defaults to `exec.DefaultLogger`.
- `PanicHandler(panicHandler errors.PanicHandler)` is used to transform panics into errors during query execution. It defaults to `errors.DefaultPanicHandler`.
- `DisableIntrospection()` disables introspection queries.

### Custom Errors

Errors returned by resolvers can include custom extensions by implementing the `ResolverError` interface:

```go
type ResolverError interface {
error
Extensions() map[string]interface{}
}
```

Example of a simple custom error:

```go
type droidNotFoundError struct {
Code string `json:"code"`
Message string `json:"message"`
}

func (e droidNotFoundError) Error() string {
return fmt.Sprintf("error [%s]: %s", e.Code, e.Message)
}

func (e droidNotFoundError) Extensions() map[string]interface{} {
return map[string]interface{}{
"code": e.Code,
"message": e.Message,
}
}
```

Which could produce a GraphQL error such as:

```go
{
"errors": [
{
"message": "error [NotFound]: This is not the droid you are looking for",
"path": [
"droid"
],
"extensions": {
"code": "NotFound",
"message": "This is not the droid you are looking for"
}
}
],
"data": null
}
```

### Tracing

By default the library uses `noop.Tracer`. If you want to change that you can use the OpenTelemetry or the OpenTracing implementations, respectively:

```go
// OpenTelemetry tracer
package main

import (
"github.com/tokopedia/graphql-go"
"github.com/tokopedia/graphql-go/example/starwars"
otelgraphql "github.com/tokopedia/graphql-go/trace/otel"
"github.com/tokopedia/graphql-go/trace/tracer"
)
// ...
_, err := graphql.ParseSchema(starwars.Schema, nil, graphql.Tracer(otelgraphql.DefaultTracer()))
// ...
```
Alternatively you can pass an existing trace.Tracer instance:
```go
tr := otel.Tracer("example")
_, err = graphql.ParseSchema(starwars.Schema, nil, graphql.Tracer(&otelgraphql.Tracer{Tracer: tr}))
```


```go
// OpenTracing tracer
package main

import (
"github.com/tokopedia/graphql-go"
"github.com/tokopedia/graphql-go/example/starwars"
"github.com/tokopedia/graphql-go/trace/opentracing"
"github.com/tokopedia/graphql-go/trace/tracer"
)
// ...
_, err := graphql.ParseSchema(starwars.Schema, nil, graphql.Tracer(opentracing.Tracer{}))

// ...
```

If you need to implement a custom tracer the library would accept any tracer which implements the interface below:
```go
type Tracer interface {
TraceQuery(ctx context.Context, queryString string, operationName string, variables map[string]interface{}, varTypes map[string]*introspection.Type) (context.Context, func([]*errors.QueryError))
TraceField(ctx context.Context, label, typeName, fieldName string, trivial bool, args map[string]interface{}) (context.Context, func(*errors.QueryError))
TraceValidation(context.Context) func([]*errors.QueryError)
}
```

[tonyghita/graphql-go-example](https://github.com/tonyghita/graphql-go-example) - A more "productionized" version of the Star Wars API example given in this repository.

[deltaskelta/graphql-go-pets-example](https://github.com/deltaskelta/graphql-go-pets-example) - graphql-go resolving against a sqlite database
### [Examples](https://github.com/tokopedia/graphql-go/wiki/Examples)

[OscarYuen/go-graphql-starter](https://github.com/OscarYuen/go-graphql-starter) - a starter application integrated with dataloader, psql and basic authentication
17 changes: 17 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Security Policy

## Supported Versions

We always try to maintain the library secure and suggest our users to upgrade to the latest stable version. We realize that sometimes this is not possible.

| Version | Supported |
| ------- | ------------------ |
| 1.x | :white_check_mark: |
| < 1.0 | :x: |

## MaxDepth
If you are using the `graphql.MaxDepth` schema option, make sure that you upgrade to version v1.3.0 or higher due to a bug causing security vulnerability in earlier versions.

## Reporting a Vulnerability

If you find a security vulnerability with this library, please, DO NOT submit a pull request right away. Please, report the issue to @pavelnikolov and/or @tony in the Gophers Slack in a private message.
13 changes: 13 additions & 0 deletions decode/decode.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
package decode

// Unmarshaler defines the api of Go types mapped to custom GraphQL scalar types
type Unmarshaler interface {
// ImplementsGraphQLType maps the implementing custom Go type
// to the GraphQL scalar type in the schema.
ImplementsGraphQLType(name string) bool
// UnmarshalGraphQL is the custom unmarshaler for the implementing type
//
// This function will be called whenever you use the
// custom GraphQL scalar type as an input
UnmarshalGraphQL(input interface{}) error
}
Loading

0 comments on commit 6fb9e53

Please sign in to comment.