Merge pull request #40 from LiUGraphQL/Time-data-for-node-and-edge-creation

Time data for node and edge creation

Author: hartig

README.md

@@ -40,6 +40,10 @@ generation:
     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: false
+    field_for_creation_date: true
+    field_for_last_update_date: true
     # add reverse edges for traversal
     reverse_edges: true
     # add edge types

graphql-api-generator/generator.py

@@ -49,6 +49,10 @@ 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'))
@@ -68,13 +72,21 @@ def run(schema: GraphQLSchema, config: dict):
         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)
+            schema = add_edge_objects(schema, config.get('generation').get('field_for_creation_date'), config.get('generation').get('field_for_last_update_date'))
         if config.get('generation').get('fields_for_edge_types'):
             raise UnsupportedOperation('{0} is currently not supported'.format('fields_for_edge_types'))
 
@@ -132,6 +144,7 @@ def run(schema: GraphQLSchema, config: dict):
 
 
 def validate_names(schema: GraphQLSchema, validate):
+
     # types and interfaces
     if validate.get('type_names'):
         # type names
@@ -173,6 +186,7 @@ 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:
@@ -248,6 +262,17 @@ def drop_comments(schema):
                 field.description = None
 
 
+def datetime_control(schema):
+    type_names = set(schema.type_map.keys())
+    if 'DateTime' in type_names:
+        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')
+        if not is_scalar_type(schema.type_map['DateTime']):
+            raise Exception('DateTime could not be added as scalar!')
+
+
 if __name__ == '__main__':
     parser = argparse.ArgumentParser()
     parser.add_argument('--input', type=str, required=True,

graphql-api-generator/resources/config.yml

@@ -12,6 +12,10 @@ generation:
     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: false
+    field_for_creation_date: true
+    field_for_last_update_date: true
     # add reverse edges for traversal
     reverse_edges: true
     # add edge types

graphql-api-generator/test/all_tests.py

@@ -50,3 +50,69 @@ def test_add_input_to_create_1(self):
         ''')
         schema_out = generator.run(schema_in, config)
         assert compare.is_equals_schema(schema_out, expected)
+
+    def test_add_crationDate_1(self):
+        schema_in = build_schema('''
+            type Test
+        ''')
+        config = {'generation': {'field_for_creation_date': True}}
+        expected = build_schema('''
+           scalar DateTime
+           type Test {
+               _creationDate: DateTime!
+           }
+        ''')
+        schema_out = generator.run(schema_in, config)
+        assert compare.is_equals_schema(schema_out, expected)
+
+    def test_add_lastUpdateDate_1(self):
+        schema_in = build_schema('''
+           type Test
+        ''')
+        config = {'generation': {'field_for_last_update_date': True}}
+        expected = build_schema('''
+           scalar DateTime
+           type Test {
+               _lastUpdateDate: DateTime
+           }
+        ''')
+        schema_out = generator.run(schema_in, config)
+        assert compare.is_equals_schema(schema_out, expected)
+
+    def test_datetime_scalar_1(self):
+        schema_in = build_schema('''
+            type datetime_test
+        ''')
+        config = {'generation': {'generate_datetime': True}}
+        try:
+            run(schema_in, config)
+            assert True
+        except:
+            assert False
+
+    def test_datetime_scalar_2(self):
+        schema_in = build_schema('''
+            scalar DateTime
+            type datetime_test { date: DateTime! }
+        ''')
+        config = {'generation': {'generate_datetime': True}}
+        try:
+            generator.run(schema_in, config)
+            assert True
+        except:
+            assert False
+
+    def test_datetime_scalar_3(self):
+        schema_in = build_schema('''
+            type DateTime {
+                date: String!
+                time: String!
+            }
+            type datetime_test { date: DateTime! }
+        ''')
+        config = {'generation': {'generate_datetime': True}}
+        try:
+            generator.run(schema_in, config)
+            assert False
+        except:
+            assert True

graphql-api-generator/utils/utils.py

@@ -98,6 +98,40 @@ def add_id_to_types(schema: GraphQLSchema):
     return add_to_schema(schema, make)
 
 
+def add_creation_date_to_types(schema: GraphQLSchema):
+    """
+    Extend all object types in the schema with an creationDate field.
+    :param schema:
+    :return:
+    """
+    make = ''
+    for _type in schema.type_map.values():
+        if not is_schema_defined_type(_type):
+            continue
+        if is_interface_type(_type):
+            make += f'extend interface {_type.name} {{ _creationDate: DateTime! }} '
+        else:
+            make += f'extend type {_type.name} {{ _creationDate: DateTime! }} '
+    return add_to_schema(schema, make)
+
+
+def add_last_update_date_to_types(schema: GraphQLSchema):
+    """
+    Extend all object types in the schema with an lastUpdateDate field.
+    :param schema:
+    :return:
+    """
+    make = ''
+    for _type in schema.type_map.values():
+        if not is_schema_defined_type(_type):
+            continue
+        if is_interface_type(_type):
+            make += f'extend interface {_type.name} {{ _lastUpdateDate: DateTime }} '
+        else:
+            make += f'extend type {_type.name} {{ _lastUpdateDate: DateTime }} '
+    return add_to_schema(schema, make)
+
+
 def copy_wrapper_structure(_type: GraphQLType, original: GraphQLType):
     """
     Copy the wrapper structure of original to _type.
@@ -526,8 +560,14 @@ def get_field_annotations(field: GraphQLField):
     return " ".join(annotation_fields)
 
 
-def add_edge_objects(schema: GraphQLSchema):
+def add_edge_objects(schema: GraphQLSchema, field_for_creation_date, field_for_last_update_date):
     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
@@ -539,7 +579,7 @@ def add_edge_objects(schema: GraphQLSchema):
             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}! {annotations}}}\n'
+                make += f'type _{edge_from} {{id:ID! source: {t.name}! target: {inner_field_type}! {creation_date_string} {last_update_date_string} {annotations}}}\n'
 
     schema = add_to_schema(schema, make)
     return schema