minor fixes

Author: keski

graphql-api-generator/README.md

@@ -1,15 +1,16 @@
-# pgschema-to-apischema
+# graphql-api-generator
 The tool in this repository extends a schema for Property Graphs into a GraphQL schema for a GraphQL API, where [the Property Graph schema is assumed to be represented using the GraphQL Schema Definition Language (SDL)](http://blog.liu.se/olafhartig/documents/graphql-schemas-for-property-graphs/). The actual approach to extend the Property Graph schemas into GraphQL API schemas (as implemented by this tool) is documented in the [wiki of this repo](https://github.com/LiUGraphQL/pgschema-to-apischema/wiki).
 
 ## Prerequisites
 ```bash
 $ pip3 install graphql-core-next
+$ pip3 install PyYAML
 ```
 
 ## Example
 ```bash
 $ python3 generator.py \
-      --input resources/schema.graphql \
+      --input schema.graphql \
       --output api-schema.graphql \
       --config resources/config.yml
 ```
@@ -22,7 +23,7 @@ usage: generator.py [-h] --input INPUT [--output OUTPUT] [--config CONFIG]
 optional arguments:
   -h, --help       show this help message and exit
   --input INPUT    Input schema files (separated by commas)
-  --output OUTPUT  Output schema file (default stdout)
+  --output OUTPUT  Output schema file (optional)
   --config CONFIG  Path to configuration file
 ```
 
@@ -41,7 +42,7 @@ generation:
     # 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: false
+    generate_datetime: true
     field_for_creation_date: true
     field_for_last_update_date: true
     # add reverse edges for traversal

graphql-api-generator/generator.py

@@ -4,7 +4,7 @@
 from io import UnsupportedOperation
 
 import yaml
-from utils.utils import *
+from modules.utils import *
 
 string_transforms = {
     'uppercase': uppercase,
@@ -35,6 +35,7 @@ def cmd(args):
     for file in files:
         with open(file, 'r') as f:
             schema_string += f.read() + '\n'
+
     schema = build_schema(schema_string)
 
     # run
@@ -49,10 +50,6 @@ def cmd(args):
 
 
 def run(schema: GraphQLSchema, config: dict):
-    # check if DateTime exists, or should be added
-    if config.get('generation').get('generate_datetime') or config.get('generation').get('field_for_creation_date') or config.get('generation').get('field_for_last_update_date'):
-        datetime_control(schema)
-
     # validate
     if config.get('validate'):
         validate_names(schema, config.get('validate'))
@@ -63,36 +60,45 @@ def run(schema: GraphQLSchema, config: dict):
 
     # API generation
     if config.get('generation'):
+        # check if DateTime exists or should be added
+        if config.get('generation').get('field_for_creation_date'):
+            datetime_control(schema)
+
+        # add query type
         if config.get('generation').get('add_query_type'):
             schema = add_query_type(schema)
+
+        # add mutation type
         if config.get('generation').get('add_mutation_type'):
             schema = add_mutation_type(schema)
 
         # add id
         if config.get('generation').get('field_for_id'):
             schema = add_id_to_types(schema)
 
-        # add creationDate
-        if config.get('generation').get('field_for_creation_date'):
-            schema = add_creation_date_to_types(schema)
-
-        # add lastUpdateDate
-        if config.get('generation').get('field_for_last_update_date'):
-            schema = add_last_update_date_to_types(schema)
-
         # add reverse edges for traversal
         if config.get('generation').get('reverse_edges'):
             schema = add_reverse_edges(schema)
 
         # add edge types
         if config.get('generation').get('edge_types') or config.get('generation').get('create_edge_objects'):
-            schema = add_edge_objects(schema, config.get('generation').get('field_for_creation_date'), config.get('generation').get('field_for_last_update_date'))
+            schema = add_edge_objects(schema)
         if config.get('generation').get('fields_for_edge_types'):
             raise UnsupportedOperation('{0} is currently not supported'.format('fields_for_edge_types'))
 
+        # add creation date
+        if config.get('generation').get('field_for_creation_date'):
+            schema = add_creation_date_to_types(schema)
+
+        # add last update date
+        if config.get('generation').get('field_for_last_update_date'):
+            schema = add_last_update_date_to_types(schema)
+
         # add queries
         if config.get('generation').get('query_by_id'):
             schema = add_get_queries(schema)
+
+        # add filters
         if config.get('generation').get('query_type_filter') or config.get('generation').get('query_list_of'):
             schema = add_enum_filters(schema)
             schema = add_scalar_filters(schema)
@@ -144,7 +150,6 @@ def run(schema: GraphQLSchema, config: dict):
 
 
 def validate_names(schema: GraphQLSchema, validate):
-
     # types and interfaces
     if validate.get('type_names'):
         # type names
@@ -186,7 +191,6 @@ def validate_names(schema: GraphQLSchema, validate):
 
 
 def transform_names(schema: GraphQLSchema, transform):
-
     # types and interfaces
     if transform.get('type_names'):
         if transform.get('type_names') in string_transforms:
@@ -268,7 +272,7 @@ def datetime_control(schema):
         if not is_scalar_type(schema.type_map['DateTime']):
             raise Exception('DateTime exists but is not scalar type: ' + schema.type_map['DateTime'])
     else:
-        schema.type_map['DateTime'] = GraphQLScalarType('DateTime')
+        schema.type_map['DateTime'] = GraphQLScalarType('DateTime', serialize=lambda x: str(x))
         if not is_scalar_type(schema.type_map['DateTime']):
             raise Exception('DateTime could not be added as scalar!')
 
@@ -278,10 +282,9 @@ def datetime_control(schema):
     parser.add_argument('--input', type=str, required=True,
                         help='GraphQL DB schema files (separated by commas), or a path to a schema directory')
     parser.add_argument('--output', type=str,
-                        help='Output schema file (default stdout)')
+                        help='Output schema file (optional)')
     parser.add_argument('--config', type=str,
                         help='Path to configuration file')
-
     cmd(parser.parse_args())
 
 

graphql-api-generator/modules/utils.py

@@ -108,7 +108,7 @@ def add_creation_date_to_types(schema: GraphQLSchema):
     """
     make = ''
     for _type in schema.type_map.values():
-        if not is_schema_defined_type(_type):
+        if not is_object_type(_type) or _type.name == 'Mutation' or _type.name == 'Query':
             continue
         if is_interface_type(_type):
             make += f'extend interface {_type.name} {{ _creationDate: DateTime! }} '
@@ -125,12 +125,12 @@ def add_last_update_date_to_types(schema: GraphQLSchema):
     """
     make = ''
     for _type in schema.type_map.values():
-        if not is_schema_defined_type(_type):
+        if not is_object_type(_type) or _type.name == 'Mutation' or _type.name == 'Query':
             continue
         if is_interface_type(_type):
-            make += f'extend interface {_type.name} {{ _lastUpdateDate: DateTime }} '
+            make += f'extend interface {_type.name} {{ _lastUpdateDate: DateTime! }} '
         else:
-            make += f'extend type {_type.name} {{ _lastUpdateDate: DateTime }} '
+            make += f'extend type {_type.name} {{ _lastUpdateDate: DateTime! }} '
     return add_to_schema(schema, make)
 
 
@@ -477,13 +477,19 @@ def add_scalar_filters(schema: GraphQLSchema):
     for scalar_name, scalar in schema.type_map.items():
         if not is_scalar_type(scalar) or scalar_name in ['Int', 'Float', 'String', 'Boolean', 'ID']:
             continue
-
         make += f'input _{scalar_name}Filter {{' \
                f'   _eq: {scalar_name} ' \
                f'   _neq: {scalar_name} ' \
                f'   _in: [{scalar_name}] ' \
                f'   _nin: [{scalar_name}] ' \
                f'}} '
+        if scalar_name == 'DateTime':
+             make += f'extend input _{scalar_name}Filter {{' \
+                 '   _gt: String ' \
+                 '   _egt: String ' \
+                 '   _lt: String ' \
+                 '   _elt: String ' \
+                 f'}} '
 
     schema = add_to_schema(schema, make)
 
@@ -562,14 +568,8 @@ def get_field_annotations(field: GraphQLField):
     return " ".join(annotation_fields)
 
 
-def add_edge_objects(schema: GraphQLSchema, field_for_creation_date, field_for_last_update_date):
+def add_edge_objects(schema: GraphQLSchema):
     make = ''
-    creation_date_string = ''
-    last_update_date_string = ''
-    if field_for_creation_date:
-        creation_date_string = '_creationDate: Date!'
-    if field_for_last_update_date:
-        last_update_date_string = '_lastUpdateDate: Date'
     for _type in schema.type_map.values():
         if not is_schema_defined_type(_type) or is_interface_type(_type):
             continue
@@ -581,7 +581,7 @@ def add_edge_objects(schema: GraphQLSchema, field_for_creation_date, field_for_l
             for t in connected_types:
                 edge_from = f'{capitalize(field_name)}EdgeFrom{t.name}'
                 annotations = get_field_annotations(field)
-                make += f'type _{edge_from} {{id:ID! source: {t.name}! target: {inner_field_type}! {creation_date_string} {last_update_date_string} {annotations}}}\n'
+                make += f'type _{edge_from} {{id:ID! source: {t.name}! target: {inner_field_type}! {annotations}}}\n'
 
     schema = add_to_schema(schema, make)
     return schema

graphql-api-generator/test/all_tests.py

@@ -1,7 +1,7 @@
 from unittest import TestCase
 from graphql import build_schema
 import generator
-from utils import compare
+from modules.utils import compare
 
 # TODO Many tests...