Merge pull request #208 from aws-amplify/master

AaronZyLee · web-flow · commit bc1158213c39 · 2021-07-28T14:20:10.000-07:00
Release codegen v2.26.2
diff --git a/.github/stale.yml b/.github/stale.yml
diff --git a/packages/amplify-codegen-e2e-core/src/init/amplifyPull.ts b/packages/amplify-codegen-e2e-core/src/init/amplifyPull.ts
@@ -55,7 +55,7 @@ export function amplifyPull(
     }
 
     if (settings.emptyDir) {
-      chain.wait(/Successfully pulled backend environment .+ from the cloud\./).wait("Run 'amplify pull' to sync upstream changes.");
+      chain.wait(/Successfully pulled backend environment .+ from the cloud\./).wait("Run 'amplify pull' to sync future upstream changes.");
     } else {
       chain.wait('Post-pull status').wait('Current Environment').wait(tableHeaderRegex).wait(tableSeperator);
     }
diff --git a/packages/amplify-codegen-e2e-tests/src/environment/env.ts b/packages/amplify-codegen-e2e-tests/src/environment/env.ts
@@ -3,8 +3,6 @@ import { nspawn as spawn, getCLIPath, getSocialProviders } from 'amplify-codegen
 export function addEnvironment(cwd: string, settings: { envName: string; numLayers?: number }): Promise<void> {
   return new Promise((resolve, reject) => {
     const chain = spawn(getCLIPath(), ['env', 'add'], { cwd, stripColors: true })
-      .wait('Do you want to use an existing environment?')
-      .sendLine('n')
       .wait('Enter a name for the environment')
       .sendLine(settings.envName)
       .wait('Select the authentication method you want to use:')
@@ -29,8 +27,6 @@ export function addEnvironment(cwd: string, settings: { envName: string; numLaye
 export function addEnvironmentWithImportedAuth(cwd: string, settings: { envName: string; currentEnvName: string }): Promise<void> {
   return new Promise((resolve, reject) => {
     spawn(getCLIPath(), ['env', 'add'], { cwd, stripColors: true })
-      .wait('Do you want to use an existing environment?')
-      .sendConfirmNo()
       .wait('Enter a name for the environment')
       .sendLine(settings.envName)
       .wait('Select the authentication method you want to use:')
@@ -143,8 +139,6 @@ export function addEnvironmentHostedUI(cwd: string, settings: { envName: string
   const { FACEBOOK_APP_ID, FACEBOOK_APP_SECRET, GOOGLE_APP_ID, GOOGLE_APP_SECRET, AMAZON_APP_ID, AMAZON_APP_SECRET } = getSocialProviders();
   return new Promise((resolve, reject) => {
     spawn(getCLIPath(), ['env', 'add'], { cwd, stripColors: true })
-      .wait('Do you want to use an existing environment?')
-      .sendLine('n')
       .wait('Enter a name for the environment')
       .sendLine(settings.envName)
       .wait('Select the authentication method you want to use:')
diff --git a/packages/appsync-modelgen-plugin/src/__tests__/visitors/appsync-swift-visitor.test.ts b/packages/appsync-modelgen-plugin/src/__tests__/visitors/appsync-swift-visitor.test.ts
@@ -15,13 +15,21 @@ const getVisitor = (
   isTimestampFieldsAdded: boolean = true,
   emitAuthProvider: boolean = true,
   generateIndexRules: boolean = true,
-  handleListNullabilityTransparently: boolean = true
+  handleListNullabilityTransparently: boolean = true,
 ) => {
   const ast = parse(schema);
   const builtSchema = buildSchemaWithDirectives(schema);
   const visitor = new AppSyncSwiftVisitor(
     builtSchema,
-    { directives, target: 'swift', scalars: SWIFT_SCALAR_MAP, isTimestampFieldsAdded, emitAuthProvider, generateIndexRules, handleListNullabilityTransparently },
+    {
+      directives,
+      target: 'swift',
+      scalars: SWIFT_SCALAR_MAP,
+      isTimestampFieldsAdded,
+      emitAuthProvider,
+      generateIndexRules,
+      handleListNullabilityTransparently,
+    },
     { selectedType, generate },
   );
   visit(ast, { leave: visitor });
@@ -2063,14 +2071,14 @@ describe('AppSyncSwiftVisitor', () => {
   });
 
   describe('timestamp fields', () => {
-    const schema = /* GraphQL */ `
-      type SimpleModel @model {
-        id: ID!
-        name: String
-        bar: String
-      }
-    `;
     it('should generate timestamp fields if timestamp is enabled', () => {
+      const schema = /* GraphQL */ `
+        type SimpleModel @model {
+          id: ID!
+          name: String
+          bar: String
+        }
+      `;
       const visitor = getVisitor(schema, 'SimpleModel', CodeGenGenerateEnum.code, true);
       const generatedCode = visitor.generate();
       expect(generatedCode).toMatchInlineSnapshot(`
@@ -2109,6 +2117,13 @@ describe('AppSyncSwiftVisitor', () => {
       `);
     });
     it('should keep the original init method if timestamp is disabled', () => {
+      const schema = /* GraphQL */ `
+        type SimpleModel @model {
+          id: ID!
+          name: String
+          bar: String
+        }
+      `;
       const visitor = getVisitor(schema, 'SimpleModel', CodeGenGenerateEnum.code, false);
       const generatedCode = visitor.generate();
       expect(generatedCode).toMatchInlineSnapshot(`
@@ -2131,5 +2146,35 @@ describe('AppSyncSwiftVisitor', () => {
         }"
       `);
     });
+    it('should keep the original init method if timestamp ff is enabled and schema has explicit timestamp fields', () => {
+      const schema = /* GraphQL */ `
+        type SimpleModel @model {
+          id: ID!
+          createdAt: AWSDateTime
+          updatedAt: AWSDateTime
+        }
+      `;
+      const visitor = getVisitor(schema, 'SimpleModel', CodeGenGenerateEnum.code, true);
+      const generatedCode = visitor.generate();
+      expect(generatedCode).toMatchInlineSnapshot(`
+        "// swiftlint:disable all
+        import Amplify
+        import Foundation
+
+        public struct SimpleModel: Model {
+          public let id: String
+          public var createdAt: Temporal.DateTime?
+          public var updatedAt: Temporal.DateTime?
+          
+          public init(id: String = UUID().uuidString,
+              createdAt: Temporal.DateTime? = nil,
+              updatedAt: Temporal.DateTime? = nil) {
+              self.id = id
+              self.createdAt = createdAt
+              self.updatedAt = updatedAt
+          }
+        }"
+      `);
+    });
   });
 });
diff --git a/packages/appsync-modelgen-plugin/src/visitors/appsync-swift-visitor.ts b/packages/appsync-modelgen-plugin/src/visitors/appsync-swift-visitor.ts
@@ -23,9 +23,9 @@ export interface RawAppSyncModelSwiftConfig extends RawAppSyncModelConfig {
    * @type boolean
    * @descriptions optional boolean, if true emits the provider value of @auth directives
    */
-   emitAuthProvider?: boolean;
+  emitAuthProvider?: boolean;
 
-   /**
+  /**
    * @name directives
    * @type boolean
    * @description optional, defines if custom indexes defined by @key directive should be generated.
@@ -90,7 +90,7 @@ export class AppSyncSwiftVisitor<
           isEnum: this.isEnumType(field),
           listType: field.isList ? listType : undefined,
           isListNullable: field.isListNullable,
-          handleListNullabilityTransparently: this.isHasManyConnectionField(field) ? false : this.config.handleListNullabilityTransparently
+          handleListNullabilityTransparently: this.isHasManyConnectionField(field) ? false : this.config.handleListNullabilityTransparently,
         });
       });
       const initParams: CodeGenField[] = this.getWritableFields(obj);
@@ -102,7 +102,7 @@ export class AppSyncSwiftVisitor<
           })
           .join(',\n'),
       ).trim()})`;
-      if (this.config.isTimestampFieldsAdded) {
+      if (this.config.isTimestampFieldsAdded && this.hasReadOnlyFields(obj)) {
         //public constructor
         structBlock.addClassMethod(
           'init',
@@ -120,7 +120,9 @@ export class AppSyncSwiftVisitor<
                 isEnum: this.isEnumType(field),
                 listType: field.isList ? listType : undefined,
                 isListNullable: field.isListNullable,
-                handleListNullabilityTransparently: this.isHasManyConnectionField(field) ? false : this.config.handleListNullabilityTransparently
+                handleListNullabilityTransparently: this.isHasManyConnectionField(field)
+                  ? false
+                  : this.config.handleListNullabilityTransparently,
               },
             };
           }),
@@ -144,7 +146,9 @@ export class AppSyncSwiftVisitor<
                 isEnum: this.isEnumType(field),
                 listType: field.isList ? listType : undefined,
                 isListNullable: field.isListNullable,
-                handleListNullabilityTransparently: this.isHasManyConnectionField(field) ? false : this.config.handleListNullabilityTransparently
+                handleListNullabilityTransparently: this.isHasManyConnectionField(field)
+                  ? false
+                  : this.config.handleListNullabilityTransparently,
               },
             };
           }),
@@ -169,7 +173,9 @@ export class AppSyncSwiftVisitor<
                 isEnum: this.isEnumType(field),
                 listType: field.isList ? listType : undefined,
                 isListNullable: field.isListNullable,
-                handleListNullabilityTransparently: this.isHasManyConnectionField(field) ? false : this.config.handleListNullabilityTransparently
+                handleListNullabilityTransparently: this.isHasManyConnectionField(field)
+                  ? false
+                  : this.config.handleListNullabilityTransparently,
               },
             };
           }),
@@ -214,7 +220,7 @@ export class AppSyncSwiftVisitor<
           isEnum: this.isEnumType(field),
           listType: field.isList ? ListType.ARRAY : undefined,
           isListNullable: field.isListNullable,
-          handleListNullabilityTransparently: this.isHasManyConnectionField(field) ? false : this.config.handleListNullabilityTransparently
+          handleListNullabilityTransparently: this.isHasManyConnectionField(field) ? false : this.config.handleListNullabilityTransparently,
         });
       });
       result.push(structBlock.string);
@@ -228,9 +234,7 @@ export class AppSyncSwiftVisitor<
     Object.values(this.getSelectedModels())
       .filter(m => m.type === 'model')
       .forEach(model => {
-        const schemaDeclarations = new SwiftDeclarationBlock()
-        .asKind('extension')
-        .withName(this.getModelName(model));
+        const schemaDeclarations = new SwiftDeclarationBlock().asKind('extension').withName(this.getModelName(model));
 
         this.generateCodingKeys(this.getModelName(model), model, schemaDeclarations),
           this.generateModelSchema(this.getModelName(model), model, schemaDeclarations);
@@ -239,9 +243,7 @@ export class AppSyncSwiftVisitor<
       });
 
     Object.values(this.getSelectedNonModels()).forEach(model => {
-      const schemaDeclarations = new SwiftDeclarationBlock()
-      .asKind('extension')
-      .withName(this.getNonModelName(model));
+      const schemaDeclarations = new SwiftDeclarationBlock().asKind('extension').withName(this.getNonModelName(model));
 
       this.generateCodingKeys(this.getNonModelName(model), model, schemaDeclarations),
         this.generateModelSchema(this.getNonModelName(model), model, schemaDeclarations);
@@ -350,8 +352,10 @@ export class AppSyncSwiftVisitor<
     const name = `${modelKeysName}.${this.getFieldName(field)}`;
     const typeName = this.getSwiftModelTypeName(field);
     const { connectionInfo } = field;
-    const isRequiredField = ((!this.isHasManyConnectionField(field)) && this.config.handleListNullabilityTransparently) ?
-     this.isRequiredField(field) : this.isFieldRequired(field);
+    const isRequiredField =
+      !this.isHasManyConnectionField(field) && this.config.handleListNullabilityTransparently
+        ? this.isRequiredField(field)
+        : this.isFieldRequired(field);
     const isRequired = isRequiredField ? '.required' : '.optional';
     // connected field
     if (connectionInfo) {
@@ -438,14 +442,14 @@ export class AppSyncSwiftVisitor<
 
   protected generateKeyRules(model: CodeGenModel): string[] {
     const keyDirectives = model.directives
-      .filter((directive) => directive.name === 'key')
-      .map((directive) => {
+      .filter(directive => directive.name === 'key')
+      .map(directive => {
         const name = directive.arguments.name ? `"${directive.arguments.name}"` : 'nil';
         const fields: string = directive.arguments.fields.map((field: string) => `"${field}"`).join(', ');
         return `.index(fields: [${fields}], name: ${name})`;
       });
 
-    return keyDirectives
+    return keyDirectives;
   }
 
   protected isHasManyConnectionField(field: CodeGenField): boolean {
@@ -471,8 +475,8 @@ export class AppSyncSwiftVisitor<
             authRule.push('allow: .private');
             break;
           case AuthStrategy.public:
-              authRule.push('allow: .public');
-              break;
+            authRule.push('allow: .public');
+            break;
           case AuthStrategy.groups:
             authRule.push('allow: .groups');
             authRule.push(`groupClaim: "${rule.groupClaim}"`);
@@ -502,4 +506,8 @@ export class AppSyncSwiftVisitor<
   protected getWritableFields(model: CodeGenModel): CodeGenField[] {
     return model.fields.filter(f => !f.isReadOnly);
   }
+
+  protected hasReadOnlyFields(model: CodeGenModel): boolean {
+    return model.fields.filter(f => f.isReadOnly).length !== 0;
+  }
 }

Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@ export function amplifyPull(`
`55`	`55`	`}`
`56`	`56`
`57`	`57`	`if (settings.emptyDir) {`
`58`		`- chain.wait(/Successfully pulled backend environment .+ from the cloud\./).wait("Run 'amplify pull' to sync upstream changes.");`
	`58`	`+ chain.wait(/Successfully pulled backend environment .+ from the cloud\./).wait("Run 'amplify pull' to sync future upstream changes.");`
`59`	`59`	`} else {`
`60`	`60`	`chain.wait('Post-pull status').wait('Current Environment').wait(tableHeaderRegex).wait(tableSeperator);`
`61`	`61`	`}`