platform/graphql_generator/lib/graphql_generator.dart

import 'dart:async';
import 'dart:mirrors';
import 'package:analyzer/dart/element/element.dart';
import 'package:analyzer/dart/element/type.dart';
import 'package:angel_model/angel_model.dart';
import 'package:angel_serialize_generator/build_context.dart';
import 'package:angel_serialize_generator/context.dart';
import 'package:build/build.dart';
import 'package:code_builder/code_builder.dart';
import 'package:graphql_schema/graphql_schema.dart';
import 'package:recase/recase.dart';
import 'package:source_gen/source_gen.dart';

/// Generates GraphQL schemas, statically.
Builder graphQLBuilder(_) {
  return SharedPartBuilder([_GraphQLGenerator()], 'graphql_generator');
}

var _docComment = RegExp(r'^/// ', multiLine: true);
var _graphQLDoc = TypeChecker.fromRuntime(GraphQLDocumentation);
var _graphQLClassTypeChecker = TypeChecker.fromRuntime(GraphQLClass);

class _GraphQLGenerator extends GeneratorForAnnotation<GraphQLClass> {
  @override
  Future<String> generateForAnnotatedElement(
      Element element, ConstantReader annotation, BuildStep buildStep) async {
    if (element is ClassElement) {
      var ctx = element.isEnum
          ? null
          : await buildContext(
              element,
              annotation,
              buildStep,
              buildStep.resolver,
              serializableTypeChecker.hasAnnotationOf(element));
      var lib = buildSchemaLibrary(element, ctx, annotation);
      return lib.accept(DartEmitter()).toString();
    } else {
      throw UnsupportedError('@GraphQLClass() is only supported on classes.');
    }
  }

  bool isInterface(ClassElement clazz) {
    return clazz.isAbstract && !serializableTypeChecker.hasAnnotationOf(clazz);
  }

  bool _isGraphQLClass(InterfaceType clazz) {
    var search = clazz;

    while (search != null) {
      if (_graphQLClassTypeChecker.hasAnnotationOf(search.element)) return true;
      search = search.superclass;
    }

    return false;
  }

  Expression _inferType(String className, String name, DartType type) {
    // Firstly, check if it's a GraphQL class.
    if (type is InterfaceType && _isGraphQLClass(type)) {
      var c = type;
      var name = serializableTypeChecker.hasAnnotationOf(c.element) &&
              c.name.startsWith('_')
          ? c.name.substring(1)
          : c.name;
      var rc = ReCase(name);
      return refer('${rc.snakeCase}GraphQLType');
    }

    // Next, check if this is the "id" field of a `Model`.
    if (TypeChecker.fromRuntime(Model).isAssignableFromType(type) &&
        name == 'id') {
      return refer('graphQLId');
    }

    var primitive = {
      String: 'graphQLString',
      int: 'graphQLInt',
      double: 'graphQLFloat',
      bool: 'graphQLBoolean',
      DateTime: 'graphQLDate'
    };

    // Check to see if it's a primitive type.
    for (var entry in primitive.entries) {
      if (TypeChecker.fromRuntime(entry.key).isAssignableFromType(type)) {
        return refer(entry.value);
      }
    }

    // Next, check to see if it's a List.
    if (type is InterfaceType &&
        type.typeArguments.isNotEmpty &&
        TypeChecker.fromRuntime(Iterable).isAssignableFromType(type)) {
      var arg = type.typeArguments[0];
      var inner = _inferType(className, name, arg);
      return refer('listOf').call([inner]);
    }

    // Nothing else is allowed.
    throw 'Cannot infer the GraphQL type for field $className.$name (type=$type).';
  }

  void _applyDescription(
      Map<String, Expression> named, Element element, String docComment) {
    String docString = docComment;

    if (docString == null && _graphQLDoc.hasAnnotationOf(element)) {
      var ann = _graphQLDoc.firstAnnotationOf(element);
      var cr = ConstantReader(ann);
      docString = cr.peek('description')?.stringValue;
    }

    if (docString != null) {
      named['description'] = literalString(
          docString.replaceAll(_docComment, '').replaceAll('\n', '\\n'));
    }
  }

  Library buildSchemaLibrary(
      ClassElement clazz, BuildContext ctx, ConstantReader ann) {
    return Library((b) {
      // Generate a top-level xGraphQLType object

      if (clazz.isEnum) {
        b.body.add(Field((b) {
          // enumTypeFromStrings(String name, List<String> values, {String description}
          var args = <Expression>[literalString(clazz.name)];
          var values =
              clazz.fields.where((f) => f.isEnumConstant).map((f) => f.name);
          var named = <String, Expression>{};
          _applyDescription(named, clazz, clazz.documentationComment);
          args.add(literalConstList(values.map(literalString).toList()));

          b
            ..name = ReCase(clazz.name).snakeCase + 'GraphQLType'
            ..docs.add('/// Auto-generated from [${clazz.name}].')
            ..type = TypeReference((b) => b
              ..symbol = 'GraphQLEnumType'
              ..types.add(refer('String')))
            ..modifier = FieldModifier.final$
            ..assignment = refer('enumTypeFromStrings').call(args, named).code;
        }));
      } else {
        b.body.add(Field((b) {
          var args = <Expression>[literalString(ctx.modelClassName)];
          var named = <String, Expression>{
            'isInterface': literalBool(isInterface(clazz))
          };

          // Add documentation
          _applyDescription(named, clazz, clazz.documentationComment);

          // Add interfaces
          var interfaces = clazz.interfaces.where(_isGraphQLClass).map((c) {
            var name = serializableTypeChecker.hasAnnotationOf(c.element) &&
                    c.name.startsWith('_')
                ? c.name.substring(1)
                : c.name;
            var rc = ReCase(name);
            return refer('${rc.snakeCase}GraphQLType');
          });
          named['interfaces'] = literalList(interfaces);

          // Add fields
          var ctxFields = ctx.fields.toList();

          // Also incorporate parent fields.
          var search = clazz.type;
          while (search != null &&
              !TypeChecker.fromRuntime(Object).isExactlyType(search)) {
            for (var field in search.element.fields) {
              if (!ctxFields.any((f) => f.name == field.name)) {
                ctxFields.add(field);
              }
            }

            search = search.superclass;
          }

          var fields = <Expression>[];
          for (var field in ctxFields) {
            var named = <String, Expression>{};
            var originalField = clazz.fields
                .firstWhere((f) => f.name == field.name, orElse: () => null);

            // Check if it is deprecated.
            var depEl = originalField?.getter ?? originalField ?? field;
            var depAnn =
                TypeChecker.fromRuntime(Deprecated).firstAnnotationOf(depEl);
            if (depAnn != null) {
              var dep = ConstantReader(depAnn);
              var reason = dep.peek('messages')?.stringValue ??
                  dep.peek('expires')?.stringValue ??
                  'Expires: ${deprecated.message}.';
              named['deprecationReason'] = literalString(reason);
            }

            // Description finder...
            _applyDescription(
                named,
                originalField?.getter ?? originalField ?? field,
                originalField?.getter?.documentationComment ??
                    originalField?.documentationComment);

            // Pick the type.
            var doc = _graphQLDoc.firstAnnotationOf(depEl);
            Expression type;
            if (doc != null) {
              var cr = ConstantReader(doc);
              var typeName = cr.peek('typeName')?.symbolValue;
              if (typeName != null)
                type = refer(MirrorSystem.getName(typeName));
            }

            fields.add(refer('field').call([
              literalString(ctx.resolveFieldName(field.name)),
              type ??= _inferType(clazz.name, field.name, field.type)
            ], named));
          }
          named['fields'] = literalList(fields);

          b
            ..name = ctx.modelClassNameRecase.snakeCase + 'GraphQLType'
            ..docs.add('/// Auto-generated from [${ctx.modelClassName}].')
            ..type = refer('GraphQLObjectType')
            ..modifier = FieldModifier.final$
            ..assignment = refer('objectType').call(args, named).code;
        }));
      }
    });
  }
}