Merge pull request #46 from LiUGraphQL/add-tool-for-creating-graphql-server

Add tool for creating graphql server

Author: keski

.gitignore

@@ -4,4 +4,4 @@
 __pycache__/
 venv*/
 .cache/
-bin/
+generated-example-server/

README.md

@@ -1,2 +1,36 @@
 # woo.sh
-Framework for generating a GraphQL server backed by a database.
+Framework for generating an [Apollo GraphQL](https://www.apollographql.com/) based server,
+backed by a configurable database.
+
+# Try it out
+The example is based on a simplified version of the Star Wars GraphQL schema and requires a running
+instance of ArangoDB.
+```bash
+$ sh ./woo.sh --input example/db-schema/ \
+              --output ./generated-example-server \
+              --config example/config.yml \
+              --driver arangodb \
+              --custom-api-schema example/custom-api-schema.graphql \
+              --custom-resolvers example/custom-resolvers.js
+
+$ npm server.js
+
+Waiting for ArangoDB to become available at http://localhost:8529
+ArangoDB is now available at http://localhost:8529
+Database dev-db deleted: true
+Database 'dev-db' created
+Collection 'Droid' created
+Collection 'Species' created
+Collection 'Planet' created
+Collection 'Human' created
+Collection 'Starship' created
+Edge collection 'FriendsEdgeFromDroid' created
+Edge collection 'HomeWorldEdgeFromDroid' created
+Edge collection 'SpeciesEdgeFromDroid' created
+Edge collection 'OriginEdgeFromSpecies' created
+Edge collection 'StarshipsEdgeFromHuman' created
+Edge collection 'FriendsEdgeFromHuman' created
+Edge collection 'HomeWorldEdgeFromHuman' created
+Edge collection 'SpeciesEdgeFromHuman' created
+GraphQL service ready at: http://localhost:4000/
+```

example/config.yml

@@ -0,0 +1,42 @@
+validate:
+    type_names: PascalCase
+    field_names: camelCase
+    enum_values: PascalCase
+transform:
+    type_names: PascalCase
+    field_names: camelCase
+    enum_values: uppercase
+    drop_comments: true
+generation:
+    add_query_type: true
+    add_mutation_type: true
+    # add id field to all schema types
+    field_for_id: true
+    # add creation date and last update date field(s) to all schema types
+    generate_datetime: true
+    field_for_creation_date: true
+    field_for_last_update_date: true
+    # add reverse edges for traversal
+    reverse_edges: true
+    # add edge types
+    edge_types: false
+    fields_for_edge_types: false
+    # add queries
+    query_by_id: true
+    query_type_filter: true
+    query_list_of: true
+    query_by_key: true
+    # add input types
+    input_to_create_objects: true
+    input_to_update_objects: true
+    # add edge input types (update not supported)
+    input_to_create_edge_objects: true
+    input_to_update_edge_objects: false
+    # add mutations
+    create_objects: true
+    update_objects: true
+    delete_objects: false
+    # add edge mutations (update and delete not supported)
+    create_edge_objects: true
+    update_edge_objects: false
+    delete_edge_objects: false

example/custom-api-schema.graphql

@@ -0,0 +1,3 @@
+extend type Query {
+    hello: String!
+}

example/custom-resolvers.js

@@ -0,0 +1,9 @@
+module.exports = {
+    get: function(options) {
+        return {
+            Query: {
+                hello: async (parent, args, context, info) => "Custom function says hello!"
+            }
+        };
+    }
+};

example/db-schema/starwars-db.graphql

@@ -0,0 +1,48 @@
+enum Episode {
+  NEWHOPE
+  EMPIRE
+  JEDI
+}
+
+interface Character {
+  name: String
+  friends: [Character]
+  homeWorld: Planet
+  species: Species
+}
+
+type Human implements Character {
+  name: String!
+  friends: [Character]
+  homeWorld: Planet
+  species: Species
+  appearsIn: [Episode]!
+  starships: [Starship]
+  totalCredits: Int
+}
+
+
+type Droid implements Character {
+  name: String!
+  friends: [Character]
+  homeWorld: Planet
+  species: Species
+  appearsIn: [Episode]!
+  primaryFunction: String
+}
+
+type Planet {
+  name: String
+  climate: String
+}
+
+type Species {
+  name: String
+  lifespan: Int
+  origin: Planet
+}
+
+type Starship {
+  name: String!
+  length: Float
+}

graphql-resolver-generator/generator.py

@@ -39,13 +39,16 @@ def generate(input_file, output_dir):
                 'name': camelCase(type_name),
                 'fields': [],
                 'edgeFields': [],
+                'DateTime': [],
                 'hasKeyDirective': f'_KeyFor{type_name}' in schema.type_map.keys()
             }
             # add object fields
             for field_name, field_type in _type.fields.items():
                 inner_field_type = get_named_type(field_type.type)
                 if is_schema_defined_object_type(inner_field_type) or is_interface_type(inner_field_type):
                     t['fields'].append(field_name)
+                if inner_field_type.name == 'DateTime':
+                    t['DateTime'].append(field_name)
                 if field_name[0] == '_':
                     continue
                 if is_schema_defined_object_type(inner_field_type) or is_interface_type(inner_field_type):

graphql-resolver-generator/resources/resolver.template

@@ -67,6 +67,9 @@ const resolvers = {
 % for type in data['types']:
     ${type['Name']}: {
         id: (parent, args, context, info) => parent._id,
+        % for field in type['DateTime']:
+        ${field}: async (parent, args, context, info) => new Date(parent.${field}),
+        % endfor
         % for field in type['fields']:
         ${field}: async (parent, args, context, info) =>
             await driver.getEdge(parent, args, info),

graphql-server/README.md

@@ -0,0 +1,19 @@
+# graphql-server
+This tool is the basis for automatically setting up a GraphQL server, with a configurable
+database backend. The GraphQL server is based on [Apollo GraphQL](https://www.apollographql.com/).
+Each backend requires a specific `driver`. Different drivers may offer different support when it
+comes to e.g. transaction and concurrency support. Refer to the documentation provided for each
+driver.
+
+## Drivers
+- ArangoDB
+
+## Prerequisites
+- npm (Node)
+
+## Example
+Generate a `woosh-server` based on a simplified version of the Star Wars GraphQL schema, and
+backed by [ArangoDB](https://www.arangodb.com/).
+```bash
+$ ./build.sh
+```