examples/todo: extracts TodoSchema

[chris-ramon]

Overview

• examples/todo: extracts todo schema so it can be re-use for demo purposes.

Test plan

• Tested that examples/todo is working as expected:

(todo)-> go run main.go 
Now server is running on port 8080
Get single todo: curl -g 'http://localhost:8080/graphql?query={todo(id:"b"){id,text,done}}'
Create new todo: curl -g 'http://localhost:8080/graphql?query=mutation+_{createTodo(text:"My+new+todo"){id,text,done}}'
Update todo: curl -g 'http://localhost:8080/graphql?query=mutation+_{updateTodo(id:"a",done:true){id,text,done}}'
Load todo list: curl -g 'http://localhost:8080/graphql?query={todoList{id,text,done}}'
Access the web app via browser at 'http://localhost:8080'

(graphql)-> curl -g 'http://localhost:8080/graphql?query={todo(id:"b"){id,text,done}}'
{"data":{"todo":{"done":false,"id":"b","text":"This is the most important"}}}

(graphql)-> curl -g 'http://localhost:8080/graphql?query=mutation+_{createTodo(text:"My+new+todo"){id,text,done}}'
{"data":{"createTodo":{"done":false,"id":"qtVJmbwj","text":"My new todo"}}}

(graphql)-> curl -g 'http://localhost:8080/graphql?query=mutation+_{updateTodo(id:"a",done:true){id,text,done}}'
{"data":{"updateTodo":{"done":true,"id":"a","text":"A todo not to forget"}}}

(graphql)-> curl -g 'http://localhost:8080/graphql?query={todoList{id,text,done}}'
{"data":{"todoList":[{"done":true,"id":"a","text":"A todo not to forget"},{"done":false,"id":"b","text":"This is the most important"},{"done":false,"id":"c","text":"Please do this or else"},{"done":false,"id":"qtVJmbwj","text":"My new todo"}]}}

---

• Tested that TodoSchema works as expected using graphql-go/handler:

package main

import (
	"log"
	"net/http"

	"github.com/graphql-go/graphql/examples/todo/schema"
	"github.com/graphql-go/handler"
)

func main() {
	h := handler.New(&handler.Config{
		Schema:     &schema.TodoSchema,
		Pretty:     true,
		GraphiQL:   false,
		Playground: true,
	})

	http.Handle("/graphql", h)
	log.Println("server running on port :8080")
	http.ListenAndServe(":8080", nil)
}

[maapteh]

Why would you want to add result := executeQuery(r.URL.Query().Get("query"), schema.TodoSchema still?

Just update your curl options for this demo:

curl \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{ "query": "{ todoList { id text } }" }' \
  http://localhost:8080/graphql

Isnt it possible to have an example with POST only server? For example in another setup i learned i could do:

	r := gin.New()
	
	r.GET("/", playgroundHandler())
	r.POST("/graphql", graphqlHandler())
	r.GET("/.well-known/server-health", healthHandler())

and choose myself simple

[maapteh]

this is not utilising your sample given:

	h := handler.New(&handler.Config{
		Schema:     &schema.TodoSchema,
		Pretty:     true,
		GraphiQL:   false,
		Playground: true,
	})

	http.Handle("/graphql", h)
	log.Println("server running on port :8080")
	http.ListenAndServe(":8080", nil)

why not take this static out of the example? and why still give GET example. Bu showcasing POST you close the open Issue #420 and its shown by example it can do it :)

[chris-ramon]

@maapteh yes, the given example just shows how to connect handle.New with schema.TodoSchema, in order to show this kind of examples I've created a new repository graphql-go/handler-examples which we can use to point lib users to in order to show graphql-go/handler related examples.

I think is ok to keep the usage of GET in examples/todo for simplicity of the example itself.

In order to showcase the usage of POST, planning to send a PR for adding a new example examples/http-post which will be based from your PR#573.

[chris-ramon]

^ Related PR for adding examples/http-post: #575

[chris-ramon]

Why would you want to add result := executeQuery(r.URL.Query().Get("query"), schema.TodoSchema still?

@maapteh FMHO we should keep the usage of GET just for simplicity, the usage of the the correct HTTP verb should rely on lib users, if a secure protocol is a requirement then a proper secure protocol should be implemented like HTTPS.

---

Just update your curl options for this demo:

curl \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{ "query": "{ todoList { id text } }" }' \
  http://localhost:8080/graphql

Planning to send a PR for adding examples/http-post in order to show the usage of HTTP POST, and yes we can continue to use curl for consistency with examples/todo to show the usage of the endpoint.

---

Then you dont open a GET option to get the results. All web clients use POST. By giving the options to GET it as well its superweird and users will think they can integrate like this as well. But maybe you like it to act like REST?

As mentioned above, FMHO lib users should decide which HTTP verb to use, we just use GET in the example for simplicity.

---

But nice work, i totally missed the option by default you can open playground and have POST working. This wasn't demonstrated in any example.

Yes, good call, I've created graphql-go/handler-examples/todo for the matter.

---

Im wondering what happens if i turn it off (on production we turn off playground and introspection and deploy another instance with stuff on, which is only reachable internally).

Have a nice day

Using graphql-go/handler the GraphQL Playground can be disable via the Playground: false option, disabling it does not interfere the correct execution of the graphql-go/handler itself.

[chris-ramon]

Isnt it possible to have an example with POST only server? For example in another setup i learned i could do:

	r := gin.New()
	
	r.GET("/", playgroundHandler())
	r.POST("/graphql", graphqlHandler())
	r.GET("/.well-known/server-health", healthHandler())

and choose myself simple

Yes, planning to send a PR for adding a new example: examples/http-post for the matter after margining this PR.

[chris-ramon]

Yes, planning to send a PR for adding a new example: examples/http-post for the matter after margining this PR.

^ Related PR for adding examples/http-post: #575

[maapteh]

Nice work Chris-Ramon!