graphql-server

Exmaple clojure graphql server. It uses following technology stacks.

• pedestal ... Web server.
• lacinia ... Clojure GraphQL implementation.
• hodur ... Domain modeling tool.
• OAuth2 ... Token based authentication for web API.
• datomic ... A transactional database.

It works with https://github.com/223kazuki/clj-graphql-client.

Please refer to blog post to know about this app.

Developing

Setup

When you first clone this repository, run:

lein duct setup

This will create files for local configuration, and prep your system for the project.

Start datomic-free

Download datomic-free-0.9.5697.zip from here.

$ unzip datomic-free-0.9.5697.zip
$ cd datomic-free-0.9.5697
$ bin/transactor config/samples/free-transactor-template.properties

Setup schema visualization

In dev profile, schma difined in edn file will be visualized by hodur-visualizer-schema. Then you need GoJS

$ mkdir -p resources/public/scripts
$ curl https://gojs.net/latest/release/go.js -o resources/public/scripts/go.js

Environment

To begin developing, start with a REPL.

lein do clean, repl

Then load the development environment.

user=> (dev)
:loaded

Run go to prep and initiate the system.

dev=> (go)
SLF4J: Class path contains multiple SLF4J bindings.
SLF4J: Found binding in [jar:file:/Users/kazukitsutsumi/.m2/repository/org/slf4j/slf4j-nop/1.7.25/slf4j-nop-1.7.25.jar!/org/slf4j/impl/StaticLoggerBinder.class]
SLF4J: Found binding in [jar:file:/Users/kazukitsutsumi/.m2/repository/ch/qos/logback/logback-classic/1.2.3/logback-classic-1.2.3.jar!/org/slf4j/impl/StaticLoggerBinder.class]
SLF4J: See http://www.slf4j.org/codes.html#multiple_bindings for an explanation.
SLF4J: Actual binding is of type [org.slf4j.helpers.NOPLoggerFactory]
WARNING: requiring-resolve already refers to: #'clojure.core/requiring-resolve in namespace: datomic.common, being replaced by: #'datomic.common/requiring-resolve
Migrated

Creating your [DEV] server...
[Figwheel:WARNING] The watch directory "resources/graphql_server" is not the classpath! A watch directory is must on the classpath and point to the root directory of your namespace source tree. A general all encompassing watch directory will not work.
[Figwheel:WARNING] Attempting to dynamically add "resources/graphql_server" to classpath!
[Figwheel:WARNING] Source directory "resources/graphql_server" is not on the classpath
[Figwheel:WARNING] Please fix this by adding "resources/graphql_server" to your classpath
 I.E.
 For Clojure CLI Tools in your deps.edn file:
    ensure "resources/graphql_server" is in your :paths key

 For Leiningen in your project.clj:
   add it to the :source-paths key

[Figwheel] Compiling build dev to "resources/public/cljs-out/main.js"
[Figwheel] Successfully compiled build dev to "resources/public/cljs-out/main.js" in 17.441 seconds.
[Figwheel] Watching paths: ("dev/src" "resources/graphql_server") to compile build - dev
[Figwheel] Starting Server at http://localhost:9500
Opening URL http://localhost:9500
:initiated

It create two servers in dev profile by default.

• http://localhost:9500 ... Schema visualization by hodur-visualizer-schema.
• http://localhost:8080 ... GraphQL endpoint. It also hosts graphiql authentication routes.

You can try graphql queries in graphiql.

http://localhost:8080/?query=%23%20Welcome%20to%20GraphiQL%0A%23%0A%23%20GraphiQL%20is%20an%20in-browser%20tool%20for%20writing%2C%20validating%2C%20and%0A%23%20testing%20GraphQL%20queries.%0A%23%0A%23%20Type%20queries%20into%20this%20side%20of%20the%20screen%2C%20and%20you%20will%20see%20intelligent%0A%23%20typeaheads%20aware%20of%20the%20current%20GraphQL%20type%20schema%20and%20live%20syntax%20and%0A%23%20validation%20errors%20highlighted%20within%20the%20text.%0A%23%0A%23%20GraphQL%20queries%20typically%20start%20with%20a%20%22%7B%22%20character.%20Lines%20that%20starts%0A%23%20with%20a%20%23%20are%20ignored.%0A%23%0A%23%20An%20example%20GraphQL%20query%20might%20look%20like%3A%0A%23%0A%23%20%20%20%20%20%7B%0A%23%20%20%20%20%20%20%20field(arg%3A%20%22value%22)%20%7B%0A%23%20%20%20%20%20%20%20%20%20subField%0A%23%20%20%20%20%20%20%20%7D%0A%23%20%20%20%20%20%7D%0A%23%0A%23%20Keyboard%20shortcuts%3A%0A%23%0A%23%20%20%20%20%20%20%20Run%20Query%3A%20%20Ctrl-Enter%20(or%20press%20the%20play%20button%20above)%0A%23%0A%23%20%20%20Auto%20Complete%3A%20%20Ctrl-Space%20(or%20just%20start%20typing)%0A%23%0A%0Aquery%20%7B%0A%20%20rikishi(id%3A%201)%20%7B%0A%20%20%20%20id%2C%0A%20%20%20%20shikona%2C%0A%20%20%20%20banduke%2C%0A%20%20%20%20sumobeya%20%7B%0A%20%20%20%20%20%20name%0A%20%20%20%20%20%20rikishis%20%7Bshikona%7D%0A%20%20%20%20%7D%0A%20%20%7D%0A%7D%0A

When you make changes to your source files, use reset to reload any modified files and reset the server.

dev=> (reset)
:reloading (...)
Migrated

Creating your [DEV] server...
:resumed

After reset application, hodur-visualizer-schema will be reloaded if you change schema.edn. But you have to reload graphiql console by yourself because it has access token in its html.

Testing

Testing is fastest through the REPL, as you avoid environment startup time.

dev=> (test)
...

But you can also run tests through Leiningen.

lein test