feat: use default directives from @aws-amplify/graphql-directives (#796)

Author: Dane Pilcher

dependency_licenses.txt

@@ -684,7 +684,7 @@ Apache License
 
 -----
 
-The following software may be included in this product: @aws-amplify/graphql-schema-test-library, @aws-amplify/graphql-transformer-interfaces, graphql-mapping-template, graphql-transformer-common, graphql-transformer-core. A copy of the source code may be downloaded from https://github.com/aws-amplify/amplify-category-api.git (@aws-amplify/graphql-schema-test-library), https://github.com/aws-amplify/amplify-category-api.git (@aws-amplify/graphql-transformer-interfaces), https://github.com/aws-amplify/amplify-category-api.git (graphql-mapping-template), https://github.com/aws-amplify/amplify-category-api.git (graphql-transformer-common), https://github.com/aws-amplify/amplify-category-api.git (graphql-transformer-core). This software contains the following license and notice below:
+The following software may be included in this product: @aws-amplify/graphql-directives, @aws-amplify/graphql-schema-test-library, @aws-amplify/graphql-transformer-interfaces, graphql-mapping-template, graphql-transformer-common, graphql-transformer-core. A copy of the source code may be downloaded from https://github.com/aws-amplify/amplify-category-api.git (@aws-amplify/graphql-directives), https://github.com/aws-amplify/amplify-category-api.git (@aws-amplify/graphql-schema-test-library), https://github.com/aws-amplify/amplify-category-api.git (@aws-amplify/graphql-transformer-interfaces), https://github.com/aws-amplify/amplify-category-api.git (graphql-mapping-template), https://github.com/aws-amplify/amplify-category-api.git (graphql-transformer-common), https://github.com/aws-amplify/amplify-category-api.git (graphql-transformer-core). This software contains the following license and notice below:
 
 Apache License
                            Version 2.0, January 2004

packages/amplify-codegen/package.json

@@ -21,6 +21,7 @@
     "extract-api": "ts-node ../../scripts/extract-api.ts"
   },
   "dependencies": {
+    "@aws-amplify/graphql-directives": "^1.0.1",
     "@aws-amplify/graphql-docs-generator": "4.2.1",
     "@aws-amplify/graphql-generator": "0.2.4",
     "@aws-amplify/graphql-types-generator": "3.4.6",

packages/amplify-codegen/src/commands/models.js

@@ -3,8 +3,8 @@ const fs = require('fs-extra');
 const globby = require('globby');
 const { FeatureFlags, pathManager } = require('@aws-amplify/amplify-cli-core');
 const { generateModels: generateModelsHelper } = require('@aws-amplify/graphql-generator');
+const { DefaultDirectives } = require('@aws-amplify/graphql-directives');
 const { validateAmplifyFlutterMinSupportedVersion } = require('../utils/validateAmplifyFlutterMinSupportedVersion');
-const defaultDirectiveDefinitions = require('../utils/defaultDirectiveDefinitions');
 const getProjectRoot = require('../utils/getProjectRoot');
 const { getModelSchemaPathParam, hasModelSchemaPathParam } = require('../utils/getModelSchemaPathParam');
 const { isDataStoreEnabled } = require('graphql-transformer-core');
@@ -131,7 +131,7 @@ const getDirectives = async (context, apiResourcePath) => {
       resourceDir: apiResourcePath,
     });
   } catch {
-    return defaultDirectiveDefinitions;
+    return DefaultDirectives.map(directive => directive.definition).join('\n');
   }
 };
 

packages/amplify-codegen/src/utils/defaultDirectiveDefinitions.js

@@ -16,7 +16,6 @@ const getSDLSchemaLocation = require('./getSDLSchemaLocation');
 const switchToSDLSchema = require('./switchToSDLSchema');
 const ensureIntrospectionSchema = require('./ensureIntrospectionSchema');
 const { readSchemaFromFile } = require('./readSchemaFromFile');
-const defaultDirectiveDefinitions = require('./defaultDirectiveDefinitions');
 const getRelativeTypesPath = require('./getRelativeTypesPath');
 module.exports = {
   getAppSyncAPIDetails,
@@ -37,6 +36,5 @@ module.exports = {
   switchToSDLSchema,
   ensureIntrospectionSchema,
   readSchemaFromFile,
-  defaultDirectiveDefinitions,
   getRelativeTypesPath,
 };

packages/amplify-codegen/src/utils/index.js

@@ -3,7 +3,7 @@ const {
   validateAmplifyFlutterMinSupportedVersion,
   MINIMUM_SUPPORTED_VERSION_CONSTRAINT,
 } = require('../../src/utils/validateAmplifyFlutterMinSupportedVersion');
-const defaultDirectiveDefinitions = require('../../src/utils/defaultDirectiveDefinitions');
+const { DefaultDirectives } = require('@aws-amplify/graphql-directives');
 const mockFs = require('mock-fs');
 const fs = require('fs');
 const path = require('path');
@@ -308,6 +308,6 @@ function addMocksToContext() {
       },
     ],
   });
-  MOCK_CONTEXT.amplify.executeProviderUtils.mockReturnValue(defaultDirectiveDefinitions);
+  MOCK_CONTEXT.amplify.executeProviderUtils.mockReturnValue(DefaultDirectives.map(directive => directive.definition).join('\n'));
   MOCK_CONTEXT.amplify.pathManager.getBackendDirPath.mockReturnValue(MOCK_BACKEND_DIRECTORY);
 }

packages/amplify-codegen/tests/commands/models.test.js

@@ -39,6 +39,7 @@
     "ts-dedent": "^1.1.0"
   },
   "devDependencies": {
+    "@aws-amplify/graphql-directives": "^1.0.1",
     "@graphql-codegen/testing": "^1.17.7",
     "@graphql-codegen/typescript": "^2.8.3",
     "@types/fs-extra": "^8.1.2",

packages/appsync-modelgen-plugin/package.json

@@ -1,3 +1,4 @@
+import { DefaultDirectives } from '@aws-amplify/graphql-directives';
 import { CodeGenModelMap, CodeGenModel, CodeGenField } from '../../visitors/appsync-visitor';
 import { processConnectionsV2 } from '../../utils/process-connections-v2';
 import {
@@ -7,7 +8,7 @@ import {
   CodeGenFieldConnectionHasOne,
 } from '../../utils/process-connections';
 import { buildSchema, parse, visit } from 'graphql';
-import { directives, scalars } from '../../scalars/supported-directives';
+import { scalars } from '../../scalars/supported-scalars';
 import { AppSyncModelVisitor, CodeGenGenerateEnum } from '../../visitors/appsync-visitor';
 
 describe('GraphQL V2 process connections tests', () => {
@@ -636,6 +637,7 @@ describe('Connection process with custom Primary Key support tests', () => {
       transformerVersion: 2
     };
     const ast = parse(schema);
+    const directives = DefaultDirectives.map(directive => directive.definition).join('\n');
     const builtSchema = buildSchema([schema, directives, scalars].join('\n'))
     const visitor = new AppSyncModelVisitor(
       builtSchema,
@@ -1033,4 +1035,4 @@ describe('Connection process with custom Primary Key support tests', () => {
       });
     });
   })
-});
+});

packages/appsync-modelgen-plugin/src/__tests__/utils/process-connections-v2.test.ts

@@ -1,10 +1,11 @@
 import { buildSchema, GraphQLSchema, parse, visit } from 'graphql';
-import { directives, scalars } from '../../scalars/supported-directives';
+import { AppSyncDirectives, DefaultDirectives, V1Directives, DeprecatedDirective, Directive } from '@aws-amplify/graphql-directives';
+import { scalars } from '../../scalars/supported-scalars';
 import { AppSyncModelDartVisitor } from '../../visitors/appsync-dart-visitor';
 import { CodeGenGenerateEnum } from '../../visitors/appsync-visitor';
 import { DART_SCALAR_MAP } from '../../scalars';
 
-const buildSchemaWithDirectives = (schema: String): GraphQLSchema => {
+const buildSchemaWithDirectives = (schema: String, directives: String): GraphQLSchema => {
   return buildSchema([schema, directives, scalars].join('\n'));
 };
 
@@ -16,6 +17,7 @@ const getVisitor = ({
   transformerVersion = 1,
   dartUpdateAmplifyCoreDependency = false,
   respectPrimaryKeyAttributesOnConnectionField = false,
+  directives = DefaultDirectives,
 }: {
   schema: string;
   selectedType?: string;
@@ -24,13 +26,15 @@ const getVisitor = ({
   transformerVersion?: number;
   dartUpdateAmplifyCoreDependency?: boolean;
   respectPrimaryKeyAttributesOnConnectionField?: boolean;
+  directives?: readonly Directive[];
 }) => {
   const ast = parse(schema);
-  const builtSchema = buildSchemaWithDirectives(schema);
+  const stringDirectives = directives.map(directive => directive.definition).join('\n');
+  const builtSchema = buildSchemaWithDirectives(schema, stringDirectives);
   const visitor = new AppSyncModelDartVisitor(
     builtSchema,
     {
-      directives,
+      directives: stringDirectives,
       target: 'dart',
       scalars: DART_SCALAR_MAP,
       isTimestampFieldsAdded,
@@ -85,7 +89,7 @@ describe('AppSync Dart Visitor', () => {
           book: String
         }
       `;
-      const visitor = getVisitor({ schema });
+      const visitor = getVisitor({ schema, directives: [...AppSyncDirectives, ...V1Directives, DeprecatedDirective] });
       const generatedCode = visitor.generate();
       expect(generatedCode).toMatchSnapshot();
     });
@@ -272,7 +276,7 @@ describe('AppSync Dart Visitor', () => {
       `;
       const outputModels: string[] = ['Todo', 'Task'];
       outputModels.forEach(model => {
-        const generatedCode = getVisitor({schema, selectedType: model}).generate();
+        const generatedCode = getVisitor({schema, selectedType: model, directives: [...AppSyncDirectives, ...V1Directives, DeprecatedDirective] }).generate();
         expect(generatedCode).toMatchSnapshot();
       });
     });
@@ -301,7 +305,7 @@ describe('AppSync Dart Visitor', () => {
       `;
       const outputModels: string[] = ['Blog', 'Comment', 'Post'];
       outputModels.forEach(model => {
-        const generatedCode = getVisitor({ schema, selectedType: model }).generate();
+        const generatedCode = getVisitor({ schema, selectedType: model, directives: [...AppSyncDirectives, ...V1Directives, DeprecatedDirective] }).generate();
         expect(generatedCode).toMatchSnapshot();
       });
     });
@@ -457,7 +461,7 @@ describe('AppSync Dart Visitor', () => {
       `;
       const outputModels: string[] = ['Blog', 'Comment', 'Post'];
       outputModels.forEach(model => {
-        const generatedCode = getVisitor({ schema, selectedType: model }).generate();
+        const generatedCode = getVisitor({ schema, selectedType: model, directives: [...AppSyncDirectives, ...V1Directives, DeprecatedDirective] }).generate();
         expect(generatedCode).toMatchSnapshot();
       });
     });

packages/appsync-modelgen-plugin/src/__tests__/visitors/appsync-dart-visitor.test.ts

@@ -1,6 +1,7 @@
 import { buildSchema, GraphQLSchema, parse, visit } from 'graphql';
+import { DefaultDirectives } from '@aws-amplify/graphql-directives';
 import { validateJava } from '../utils/validate-java';
-import { directives, scalars } from '../../scalars/supported-directives';
+import { scalars } from '../../scalars/supported-scalars';
 import { AppSyncModelJavaVisitor } from '../../visitors/appsync-java-visitor';
 import { CodeGenGenerateEnum } from '../../visitors/appsync-visitor';
 import { JAVA_SCALAR_MAP } from '../../scalars';
@@ -13,6 +14,9 @@ const defaultJavaVisitorSettings = {
   respectPrimaryKeyAttributesOnConnectionField: false,
   generateModelsForLazyLoadAndCustomSelectionSet: true
 }
+
+const directives = DefaultDirectives.map(directive => directive.definition).join('\n');
+
 const buildSchemaWithDirectives = (schema: String): GraphQLSchema => {
   return buildSchema([schema, directives, scalars].join('\n'));
 };