feat(graphql-model-transformer): added transformer version feature fl…

…ag (#8328)
aws-amplify · Oct 14, 2021 · 922bf61 · 922bf61
1 parent c73db78
commit 922bf61
Show file tree

Hide file tree

Showing 27 changed files with 92 additions and 54 deletions.
diff --git a/packages/amplify-cli-core/src/__tests__/featureFlags.test.ts b/packages/amplify-cli-core/src/__tests__/featureFlags.test.ts
@@ -48,7 +48,7 @@ describe('feature flags', () => {
 
         await fs.copyFile(templateConfigFileName, projectConfigFileName);
 
-        await FeatureFlags.initialize(({ getCurrentEnvName: () => 'dev' } as unknown) as CLIEnvironmentProvider, undefined, getTestFlags());
+        await FeatureFlags.initialize({ getCurrentEnvName: () => 'dev' } as unknown as CLIEnvironmentProvider, undefined, getTestFlags());
 
         await FeatureFlags.ensureDefaultFeatureFlags(true);
 
@@ -78,7 +78,7 @@ describe('feature flags', () => {
 
         await fs.copyFile(templateConfigFileName, projectConfigFileName);
 
-        await FeatureFlags.initialize(({ getCurrentEnvName: () => 'dev' } as unknown) as CLIEnvironmentProvider, undefined, getTestFlags());
+        await FeatureFlags.initialize({ getCurrentEnvName: () => 'dev' } as unknown as CLIEnvironmentProvider, undefined, getTestFlags());
         await FeatureFlags.ensureDefaultFeatureFlags(true);
 
         const originalConfig = (await fs.readFile(templateConfigFileName)).toString();
@@ -103,7 +103,7 @@ describe('feature flags', () => {
 
         await fs.mkdirs(path.dirname(projectConfigFileName));
 
-        await FeatureFlags.initialize(({ getCurrentEnvName: () => 'dev' } as unknown) as CLIEnvironmentProvider, undefined, getTestFlags());
+        await FeatureFlags.initialize({ getCurrentEnvName: () => 'dev' } as unknown as CLIEnvironmentProvider, undefined, getTestFlags());
         await FeatureFlags.ensureDefaultFeatureFlags(true);
 
         const createdConfig = (await fs.readFile(projectConfigFileName)).toString();
@@ -131,7 +131,7 @@ describe('feature flags', () => {
 
         await fs.copyFile(templateConfigFileName, projectConfigFileName);
 
-        await FeatureFlags.initialize(({ getCurrentEnvName: () => 'dev' } as unknown) as CLIEnvironmentProvider);
+        await FeatureFlags.initialize({ getCurrentEnvName: () => 'dev' } as unknown as CLIEnvironmentProvider);
 
         expect(FeatureFlags.getBoolean('graphQLTransformer.validateTypeNameReservedWords')).toBe(false);
       } finally {
@@ -141,7 +141,7 @@ describe('feature flags', () => {
 
     test('missing environmentProvider argument', async () => {
       await expect(async () => {
-        await FeatureFlags.initialize((undefined as unknown) as CLIContextEnvironmentProvider, undefined, getTestFlags());
+        await FeatureFlags.initialize(undefined as unknown as CLIContextEnvironmentProvider, undefined, getTestFlags());
       }).rejects.toThrowError(`'environmentProvider' argument is required`);
     });
 
@@ -162,10 +162,10 @@ describe('feature flags', () => {
 
       await FeatureFlags.initialize(envProvider, undefined, getTestFlags());
 
-      const transformerVersion = FeatureFlags.getNumber('graphQLTransformer.transformerVersion');
+      const customTransformerVersion = FeatureFlags.getNumber('graphQLTransformer.customTransformerVersion');
       const isDefaultQueryEnabled = FeatureFlags.getBoolean('keyTransformer.defaultQuery');
 
-      expect(transformerVersion).toBe(4);
+      expect(customTransformerVersion).toBe(4);
       expect(isDefaultQueryEnabled).toBe(true);
     });
 
@@ -178,12 +178,12 @@ describe('feature flags', () => {
 
         process.chdir(tempProjectDir);
 
-        await FeatureFlags.initialize(({ getCurrentEnvName: () => 'dev' } as unknown) as CLIEnvironmentProvider, true, getTestFlags());
+        await FeatureFlags.initialize({ getCurrentEnvName: () => 'dev' } as unknown as CLIEnvironmentProvider, true, getTestFlags());
 
-        const transformerVersion = FeatureFlags.getNumber('graphQLTransformer.transformerVersion');
+        const customTransformerVersion = FeatureFlags.getNumber('graphQLTransformer.customTransformerVersion');
         const isDefaultQueryEnabled = FeatureFlags.getBoolean('keyTransformer.defaultQuery');
 
-        expect(transformerVersion).toBe(5);
+        expect(customTransformerVersion).toBe(5);
         expect(isDefaultQueryEnabled).toBe(true);
       } finally {
         rimraf.sync(tempProjectDir);
@@ -232,7 +232,7 @@ describe('feature flags', () => {
 
       expect(effectiveFlags).toMatchObject({
         graphqltransformer: {
-          transformerversion: 3,
+          customtransformerversion: 3,
         },
         keytransformer: {
           defaultquery: false,
@@ -260,7 +260,7 @@ describe('feature flags', () => {
 
       expect(effectiveFlags).toMatchObject({
         graphqltransformer: {
-          transformerversion: 4,
+          customtransformerversion: 4,
         },
         keytransformer: {
           defaultquery: true,
@@ -288,7 +288,7 @@ describe('feature flags', () => {
 
       expect(effectiveFlags).toMatchObject({
         graphqltransformer: {
-          transformerversion: 5,
+          customtransformerversion: 5,
         },
         keytransformer: {
           defaultquery: false,
@@ -316,7 +316,7 @@ describe('feature flags', () => {
 
       expect(effectiveFlags).toMatchObject({
         graphqltransformer: {
-          transformerversion: 6,
+          customtransformerversion: 6,
         },
         keytransformer: {
           defaultquery: true,
@@ -401,7 +401,7 @@ describe('feature flags', () => {
 
       await expect(async () => {
         await FeatureFlags.initialize(envProvider, undefined, getTestFlags());
-      }).rejects.toThrowError(`Invalid number value: 'invalid' for 'transformerversion' in section 'graphqltransformer'`);
+      }).rejects.toThrowError(`Invalid number value: 'invalid' for 'customtransformerversion' in section 'graphqltransformer'`);
     });
 
     test('initialize feature flag provider fail unknown flags', async () => {
@@ -425,15 +425,15 @@ describe('feature flags', () => {
         message: 'Invalid feature flag configuration',
         name: 'JSONValidationError',
         unknownFlags: ['graphqltransformer.foo', 'graphqltransformer.bar'],
-        otherErrors: ['graphqltransformer.transformerversion: should be number'],
+        otherErrors: ['graphqltransformer.customtransformerversion: should be number'],
       });
     });
 
     const getTestFlags = (): Record<string, FeatureFlagRegistration[]> => {
       return {
         graphQLTransformer: [
           {
-            name: 'transformerVersion',
+            name: 'customTransformerVersion',
             type: 'number',
             defaultValueForExistingProjects: 4,
             defaultValueForNewProjects: 5,
@@ -533,7 +533,7 @@ describe('feature flags', () => {
 
     test('error with empty field returns unknown', () => {
       expect(() => {
-        throw new EnvVarFormatError((undefined as unknown) as string);
+        throw new EnvVarFormatError(undefined as unknown as string);
       }).toThrowError(`Invalid variable name format: '<unknown>'`);
     });
 
@@ -594,13 +594,13 @@ describe('feature flags', () => {
       expect(features).toMatchObject({
         project: {
           graphqltransformer: {
-            transformerversion: 5,
+            customtransformerversion: 5,
           },
         },
         environments: {
           dev: {
             graphqltransformer: {
-              transformerversion: 6,
+              customtransformerversion: 6,
             },
           },
         },
@@ -626,7 +626,7 @@ describe('feature flags', () => {
       expect(features).toMatchObject({
         project: {
           graphqltransformer: {
-            transformerversion: 5,
+            customtransformerversion: 5,
           },
         },
         environments: {},
@@ -676,7 +676,7 @@ describe('feature flags', () => {
         environments: {
           dev: {
             graphqltransformer: {
-              transformerversion: 6,
+              customtransformerversion: 6,
             },
           },
         },

diff --git a/packages/amplify-cli-core/src/__tests__/testFiles/project-with-features/cli.json b/packages/amplify-cli-core/src/__tests__/testFiles/project-with-features/cli.json
@@ -4,7 +4,7 @@
   },
   "features": {
     "graphQLTransformer": {
-      "transformerVersion": 5
+      "customTransformerVersion": 5
     }
   }
 }
diff --git a/...ages/amplify-cli-core/src/__tests__/testFiles/testProject-both-files/amplify/cli.dev.json b/...ages/amplify-cli-core/src/__tests__/testFiles/testProject-both-files/amplify/cli.dev.json
@@ -1,7 +1,7 @@
 {
   "features": {
     "graphQLTransformer": {
-      "transformerVersion": 6
+      "customTransformerVersion": 6
     }
   }
 }
diff --git a/packages/amplify-cli-core/src/__tests__/testFiles/testProject-both-files/amplify/cli.json b/packages/amplify-cli-core/src/__tests__/testFiles/testProject-both-files/amplify/cli.json
@@ -4,7 +4,7 @@
   },
   "features": {
     "graphQLTransformer": {
-      "transformerVersion": 5
+      "customTransformerVersion": 5
     }
   }
 }
diff --git a/packages/amplify-cli-core/src/__tests__/testFiles/testProject-initialize-1/amplify/cli.json b/packages/amplify-cli-core/src/__tests__/testFiles/testProject-initialize-1/amplify/cli.json
@@ -4,7 +4,7 @@
   },
   "features": {
     "graphQLTransformer": {
-      "transformerVersion": 3
+      "customTransformerVersion": 3
     },
     "keyTransformer": {
       "defaultQuery": false

diff --git a/...s/amplify-cli-core/src/__tests__/testFiles/testProject-initialize-1/amplify/cli.prod.json b/...s/amplify-cli-core/src/__tests__/testFiles/testProject-initialize-1/amplify/cli.prod.json
@@ -1,7 +1,7 @@
 {
   "features": {
     "graphQLTransformer": {
-      "transformerVersion": 10
+      "customTransformerVersion": 10
     }
   }
 }
diff --git a/...es/amplify-cli-core/src/__tests__/testFiles/testProject-initialize-2/amplify/cli.dev.json b/...es/amplify-cli-core/src/__tests__/testFiles/testProject-initialize-2/amplify/cli.dev.json
@@ -1,7 +1,7 @@
 {
   "features": {
     "graphQLTransformer": {
-      "transformerVersion": 4
+      "customTransformerVersion": 4
     },
     "keyTransformer": {
       "defaultQuery": true

diff --git a/packages/amplify-cli-core/src/__tests__/testFiles/testProject-initialize-2/amplify/cli.json b/packages/amplify-cli-core/src/__tests__/testFiles/testProject-initialize-2/amplify/cli.json
@@ -4,7 +4,7 @@
   },
   "features": {
     "graphQLTransformer": {
-      "transformerVersion": 3
+      "customTransformerVersion": 3
     },
     "keyTransformer": {
       "defaultQuery": false

diff --git a/...s/amplify-cli-core/src/__tests__/testFiles/testProject-initialize-2/amplify/cli.prod.json b/...s/amplify-cli-core/src/__tests__/testFiles/testProject-initialize-2/amplify/cli.prod.json
@@ -1,7 +1,7 @@
 {
   "features": {
     "graphQLTransformer": {
-      "transformerVersion": 10
+      "customTransformerVersion": 10
     }
   }
 }
diff --git a/packages/amplify-cli-core/src/__tests__/testFiles/testProject-initialize-3/.env b/packages/amplify-cli-core/src/__tests__/testFiles/testProject-initialize-3/.env
@@ -1,4 +1,4 @@
-AMPLIFYCLI_GRAPHQLTRANSFORMER__TRANSFORMERVERSION=5
-#AMPLIFYCLI-DEV_GRAPHQLTRANSFORMER__TRANSFORMERVERSION=6
+AMPLIFYCLI_GRAPHQLTRANSFORMER__CUSTOMTRANSFORMERVERSION=5
+#AMPLIFYCLI-DEV_GRAPHQLTRANSFORMER__CUSTOMTRANSFORMERVERSION=6
 AMPLIFYCLI_KEYTRANSFORMER__defaultquery=false
 #AMPLIFYCLI-DEV_KEYTRANSFORMER__defaultquery=true
diff --git a/...es/amplify-cli-core/src/__tests__/testFiles/testProject-initialize-3/amplify/cli.dev.json b/...es/amplify-cli-core/src/__tests__/testFiles/testProject-initialize-3/amplify/cli.dev.json
@@ -1,7 +1,7 @@
 {
   "features": {
     "graphQLTransformer": {
-      "transformerVersion": 4
+      "customTransformerVersion": 4
     },
     "keyTransformer": {
       "defaultQuery": true

diff --git a/packages/amplify-cli-core/src/__tests__/testFiles/testProject-initialize-3/amplify/cli.json b/packages/amplify-cli-core/src/__tests__/testFiles/testProject-initialize-3/amplify/cli.json
@@ -4,7 +4,7 @@
   },
   "features": {
     "graphQLTransformer": {
-      "transformerVersion": 3
+      "customTransformerVersion": 3
     },
     "keyTransformer": {
       "defaultQuery": false

diff --git a/...s/amplify-cli-core/src/__tests__/testFiles/testProject-initialize-3/amplify/cli.prod.json b/...s/amplify-cli-core/src/__tests__/testFiles/testProject-initialize-3/amplify/cli.prod.json
@@ -1,7 +1,7 @@
 {
   "features": {
     "graphQLTransformer": {
-      "transformerVersion": 10
+      "customTransformerVersion": 10
     }
   }
 }
diff --git a/packages/amplify-cli-core/src/__tests__/testFiles/testProject-initialize-4/.env b/packages/amplify-cli-core/src/__tests__/testFiles/testProject-initialize-4/.env
@@ -1,4 +1,4 @@
-AMPLIFYCLI_GRAPHQLTRANSFORMER__TRANSFORMERVERSION=5
-AMPLIFYCLI-DEV_GRAPHQLTRANSFORMER__TRANSFORMERVERSION=6
+AMPLIFYCLI_GRAPHQLTRANSFORMER__CUSTOMTRANSFORMERVERSION=5
+AMPLIFYCLI-DEV_GRAPHQLTRANSFORMER__CUSTOMTRANSFORMERVERSION=6
 AMPLIFYCLI_KEYTRANSFORMER__defaultquery=false
 AMPLIFYCLI-DEV_KEYTRANSFORMER__defaultquery=true
diff --git a/...es/amplify-cli-core/src/__tests__/testFiles/testProject-initialize-4/amplify/cli.dev.json b/...es/amplify-cli-core/src/__tests__/testFiles/testProject-initialize-4/amplify/cli.dev.json
@@ -1,7 +1,7 @@
 {
   "features": {
     "graphQLTransformer": {
-      "transformerVersion": 4
+      "customTransformerVersion": 4
     },
     "keyTransformer": {
       "defaultQuery": true

diff --git a/packages/amplify-cli-core/src/__tests__/testFiles/testProject-initialize-4/amplify/cli.json b/packages/amplify-cli-core/src/__tests__/testFiles/testProject-initialize-4/amplify/cli.json
@@ -4,7 +4,7 @@
   },
   "features": {
     "graphQLTransformer": {
-      "transformerVersion": 3
+      "customTransformerVersion": 3
     },
     "keyTransformer": {
       "defaultQuery": false

diff --git a/...s/amplify-cli-core/src/__tests__/testFiles/testProject-initialize-4/amplify/cli.prod.json b/...s/amplify-cli-core/src/__tests__/testFiles/testProject-initialize-4/amplify/cli.prod.json
@@ -1,7 +1,7 @@
 {
   "features": {
     "graphQLTransformer": {
-      "transformerVersion": 10
+      "customTransformerVersion": 10
     }
   }
 }
diff --git a/packages/amplify-cli-core/src/__tests__/testFiles/testProject-initialize-env-number/.env b/packages/amplify-cli-core/src/__tests__/testFiles/testProject-initialize-env-number/.env
@@ -1 +1 @@
-AMPLIFYCLI_GRAPHQLTRANSFORMER__TRANSFORMERVERSION=invalid
+AMPLIFYCLI_GRAPHQLTRANSFORMER__CUSTOMTRANSFORMERVERSION=invalid
diff --git a/...ify-cli-core/src/__tests__/testFiles/testProject-initialize-unknown-flag/amplify/cli.json b/...ify-cli-core/src/__tests__/testFiles/testProject-initialize-unknown-flag/amplify/cli.json
@@ -4,7 +4,7 @@
   },
   "features": {
     "graphQLTransformer": {
-      "transformerVersion": "it-is-a-string",
+      "customTransformerVersion": "it-is-a-string",
       "foo": "unknown",
       "bar": "unknown"
     }

diff --git a/packages/amplify-cli-core/src/__tests__/testFiles/testProject-initialize/.env b/packages/amplify-cli-core/src/__tests__/testFiles/testProject-initialize/.env
@@ -1,4 +1,4 @@
-#AMPLIFYCLI_GRAPHQLTRANSFORMER__TRANSFORMERVERSION=5
-#AMPLIFYCLI-DEV_GRAPHQLTRANSFORMER__TRANSFORMERVERSION=6
+#AMPLIFYCLI_GRAPHQLTRANSFORMER__CUSTOMTRANSFORMERVERSION=5
+#AMPLIFYCLI-DEV_GRAPHQLTRANSFORMER__CUSTOMTRANSFORMERVERSION=6
 #AMPLIFYCLI_KEYTRANSFORMER__defaultquery=false
 #AMPLIFYCLI-DEV_KEYTRANSFORMER__defaultquery=true
diff --git a/...ages/amplify-cli-core/src/__tests__/testFiles/testProject-initialize/amplify/cli.dev.json b/...ages/amplify-cli-core/src/__tests__/testFiles/testProject-initialize/amplify/cli.dev.json
@@ -1,7 +1,7 @@
 {
   "features": {
     "graphQLTransformer": {
-      "transformerVersion": 4
+      "customTransformerVersion": 4
     },
     "keyTransformer": {
       "defaultQuery": true

diff --git a/packages/amplify-cli-core/src/__tests__/testFiles/testProject-initialize/amplify/cli.json b/packages/amplify-cli-core/src/__tests__/testFiles/testProject-initialize/amplify/cli.json
@@ -4,7 +4,7 @@
   },
   "features": {
     "graphQLTransformer": {
-      "transformerVersion": 3
+      "customTransformerVersion": 3
     },
     "keyTransformer": {
       "defaultQuery": false

diff --git a/...ges/amplify-cli-core/src/__tests__/testFiles/testProject-initialize/amplify/cli.prod.json b/...ges/amplify-cli-core/src/__tests__/testFiles/testProject-initialize/amplify/cli.prod.json
@@ -1,7 +1,7 @@
 {
   "features": {
     "graphQLTransformer": {
-      "transformerVersion": 10
+      "customTransformerVersion": 10
     }
   }
 }
diff --git a/packages/amplify-cli-core/src/__tests__/testFiles/testProject-no-env/amplify/cli.json b/packages/amplify-cli-core/src/__tests__/testFiles/testProject-no-env/amplify/cli.json
@@ -4,7 +4,7 @@
   },
   "features": {
     "graphQLTransformer": {
-      "transformerVersion": 5
+      "customTransformerVersion": 5
     }
   }
 }
diff --git a/...ages/amplify-cli-core/src/__tests__/testFiles/testProject-no-project/amplify/cli.dev.json b/...ages/amplify-cli-core/src/__tests__/testFiles/testProject-no-project/amplify/cli.dev.json
@@ -1,7 +1,7 @@
 {
   "features": {
     "graphQLTransformer": {
-      "transformerVersion": 6
+      "customTransformerVersion": 6
     }
   }
 }
diff --git a/packages/amplify-cli-core/src/feature-flags/featureFlags.ts b/packages/amplify-cli-core/src/feature-flags/featureFlags.ts
@@ -551,6 +551,12 @@ export class FeatureFlags {
         defaultValueForExistingProjects: false,
         defaultValueForNewProjects: true,
       },
+      {
+        name: 'transformerVersion',
+        type: 'number',
+        defaultValueForExistingProjects: 1,
+        defaultValueForNewProjects: 1,
+      },
     ]);
 
     this.registerFlag('frontend-ios', [