tokopedia
diff --git a/‎.gitignore
Lines changed: 2 additions & 0 deletions b/‎.gitignore
Lines changed: 2 additions & 0 deletions
diff --git a/‎.golangci.yml
Lines changed: 35 additions & 0 deletions b/‎.golangci.yml
Lines changed: 35 additions & 0 deletions
diff --git a/‎.semaphore/semaphore.yml
Lines changed: 35 additions & 0 deletions b/‎.semaphore/semaphore.yml
Lines changed: 35 additions & 0 deletions
diff --git a/‎CHANGELOG.md
Lines changed: 10 additions & 0 deletions b/‎CHANGELOG.md
Lines changed: 10 additions & 0 deletions
diff --git a/‎README.md
Lines changed: 121 additions & 14 deletions b/‎README.md
Lines changed: 121 additions & 14 deletions
diff --git a/‎SECURITY.md
Lines changed: 17 additions & 0 deletions b/‎SECURITY.md
Lines changed: 17 additions & 0 deletions
diff --git a/‎decode/decode.go
Lines changed: 13 additions & 0 deletions b/‎decode/decode.go
Lines changed: 13 additions & 0 deletions
@@ -1,3 +1,5 @@
+/.idea
+/.vscode
 /internal/validation/testdata/graphql-js
 /internal/validation/testdata/node_modules
 /vendor
@@ -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"
@@ -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 .
@@ -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
@@ -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>
 
@@ -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
 
@@ -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
 
@@ -45,9 +46,6 @@ func (_ *query) Hello() string { return "Hello, world!" }
 
 func main() {
         s := `
-                schema {
-                        query: Query
-                }
                 type Query {
                         hello: String!
                 }
@@ -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
 
@@ -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
 
@@ -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.
@@ -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
+}