feat(codegen): iOS index directive support (#174)

* feat(modelgen): iOS - generate @key metadata

* feat(modelgen): iOS - generate @key metadata, invert params order

* feat(modelgen): generateIndexRules feature flag

* feat(modelgen): generateIndexRules rebase

Author: diegocstn

packages/amplify-codegen-e2e-tests/src/__tests__/feature-flags.test.ts

@@ -5,6 +5,7 @@ import { pathManager } from 'amplify-cli-core';
 const codegenFeatureFlags = {
     "handlelistnullabilitytransparently": true,
     "addtimestampfields": true,
+    "generateIndexRules": true,
     "useappsyncmodelgenplugin": true,
     "usedocsgeneratorplugin": true,
     "usetypesgeneratorplugin": true,

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

@@ -13,6 +13,21 @@ const platformToLanguageMap = {
   javascript: 'javascript',
 };
 
+/**
+ * Returns feature flag value, default to `false`
+ * @param {string} key feature flag id
+ * @returns
+ */
+const readFeatureFlag = (key) => {
+  let flagValue = false;
+  try {
+    flagValue = FeatureFlags.getBoolean(key);
+  } catch (err) {
+    flagValue = false;
+  }
+  return flagValue;
+}
+
 async function generateModels(context) {
   // steps:
   // 1. Load the schema and validate using transformer
@@ -51,21 +66,11 @@ async function generateModels(context) {
   //get modelgen package
   const modelgenPackageMigrationflag = 'codegen.useAppSyncModelgenPlugin';
   const appSyncDataStoreCodeGen = getModelgenPackage(FeatureFlags.getBoolean(modelgenPackageMigrationflag));
-  //get timestamp config value
-  let isTimestampFieldsAdded = false;
-  try {
-    isTimestampFieldsAdded = FeatureFlags.getBoolean('codegen.addTimestampFields');
-  } catch (err) {
-    isTimestampFieldsAdded = false;
-  }
 
-  //get timestamp config value
-  let emitAuthProvider = false;
-  try {
-    emitAuthProvider = FeatureFlags.getBoolean('codegen.emitAuthProvider');
-  } catch (err) {
-    emitAuthProvider = false;
-  }
+  const isTimestampFieldsAdded = readFeatureFlag('codegen.addTimestampFields');
+
+  const generateIndexRules = readFeatureFlag('codegen.generateIndexRules');
+  const emitAuthProvider = readFeatureFlag('codegen.emitAuthProvider');
 
   const appsyncLocalConfig = await appSyncDataStoreCodeGen.preset.buildGeneratesSection({
     baseOutputDir: outputPath,
@@ -75,6 +80,7 @@ async function generateModels(context) {
       directives: directiveDefinitions,
       isTimestampFieldsAdded,
       emitAuthProvider,
+      generateIndexRules,
     },
   });
 

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

@@ -14,12 +14,13 @@ const getVisitor = (
   generate: CodeGenGenerateEnum = CodeGenGenerateEnum.code,
   isTimestampFieldsAdded: boolean = true,
   emitAuthProvider: boolean = true,
+  generateIndexRules: boolean = true,
 ) => {
   const ast = parse(schema);
   const builtSchema = buildSchemaWithDirectives(schema);
   const visitor = new AppSyncSwiftVisitor(
     builtSchema,
-    { directives, target: 'swift', scalars: SWIFT_SCALAR_MAP, isTimestampFieldsAdded, emitAuthProvider },
+    { directives, target: 'swift', scalars: SWIFT_SCALAR_MAP, isTimestampFieldsAdded, emitAuthProvider, generateIndexRules },
     { selectedType, generate },
   );
   visit(ast, { leave: visitor });
@@ -339,6 +340,11 @@ describe('AppSyncSwiftVisitor', () => {
           
           model.pluralName = \\"authorBooks\\"
           
+          model.attributes(
+            .index(fields: [\\"author_id\\"], name: \\"byAuthor\\"),
+            .index(fields: [\\"book_id\\"], name: \\"byBook\\")
+          )
+          
           model.fields(
             .id(),
             .field(authorBook.author_id, is: .required, ofType: .string),

packages/appsync-modelgen-plugin/src/visitors/appsync-swift-visitor.ts

@@ -24,10 +24,18 @@ export interface RawAppSyncModelSwiftConfig extends RawAppSyncModelConfig {
    * @descriptions optional boolean, if true emits the provider value of @auth directives
    */
    emitAuthProvider?: boolean;
+
+   /**
+   * @name directives
+   * @type boolean
+   * @description optional, defines if custom indexes defined by @key directive should be generated.
+   */
+  generateIndexRules?: boolean;
 }
 
 export interface ParsedAppSyncModelSwiftConfig extends ParsedAppSyncModelConfig {
   emitAuthProvider?: boolean;
+  generateIndexRules?: boolean;
 }
 
 export class AppSyncSwiftVisitor<
@@ -45,6 +53,7 @@ export class AppSyncSwiftVisitor<
   ) {
     super(schema, rawConfig, additionalConfig, defaultScalars);
     this._parsedConfig.emitAuthProvider = rawConfig.emitAuthProvider || false;
+    this._parsedConfig.generateIndexRules = rawConfig.generateIndexRules || false;
   }
 
   generate(): string {
@@ -251,13 +260,15 @@ export class AppSyncSwiftVisitor<
     const keysName = lowerCaseFirst(model.name);
     const fields = model.fields.map(field => this.generateFieldSchema(field, keysName));
     const authRules = this.generateAuthRules(model);
+    const keyDirectives = this.config.generateIndexRules ? this.generateKeyRules(model) : [];
     const closure = [
       '{ model in',
       `let ${keysName} = ${this.getModelName(model)}.keys`,
       '',
       ...(authRules.length ? [`model.authRules = ${authRules}`, ''] : []),
       `model.pluralName = "${this.pluralizeModelName(model)}"`,
       '',
+      ...(keyDirectives.length ? ['model.attributes(', indentMultiline(keyDirectives.join(',\n')), ')', ''] : []),
       'model.fields(',
       indentMultiline(fields.join(',\n')),
       ')',
@@ -409,6 +420,18 @@ export class AppSyncSwiftVisitor<
     return !field.isNullable;
   }
 
+  protected generateKeyRules(model: CodeGenModel): string[] {
+    const keyDirectives = model.directives
+      .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
+  }
+
   protected generateAuthRules(model: CodeGenModel): string {
     const authDirectives: AuthDirective[] = (model.directives.filter(d => d.name === 'auth') as any) as AuthDirective[];
     const rules: string[] = [];