Add support for output dir arg on models (#478)

* Add support for output dir arg on models

* Fix a null check to be more careful

* Check appropriately for provided output dir

Author: marcvberg

packages/amplify-codegen-e2e-core/src/categories/codegen.ts

@@ -1,9 +1,10 @@
 import { AmplifyFrontend } from '../utils';
 import { getCLIPath, nspawn as spawn } from '..';
 
-export function generateModels(cwd: string): Promise<void> {
+export function generateModels(cwd: string, outputDir?: string): Promise<void> {
   return new Promise((resolve, reject) => {
-    spawn(getCLIPath(), ['codegen', 'models'], { cwd, stripColors: true })
+    const params = ['codegen', 'models', ...(outputDir ? ['--output-dir', outputDir] : [])]
+    spawn(getCLIPath(), params, { cwd, stripColors: true })
     .run((err: Error) => {
       if (!err) {
         resolve();

packages/amplify-codegen-e2e-tests/src/__tests__/datastore-modelgen-android.test.ts

@@ -1,4 +1,4 @@
-import { createNewProjectDir, DEFAULT_ANDROID_CONFIG } from "@aws-amplify/amplify-codegen-e2e-core";
+import { createNewProjectDir, DEFAULT_ANDROID_CONFIG } from '@aws-amplify/amplify-codegen-e2e-core';
 import { deleteAmplifyProject, testCodegenModels } from '../codegen-tests-base';
 
 const schema = 'modelgen/model_gen_schema_with_aws_scalars.graphql';
@@ -17,4 +17,8 @@ describe('Datastore Modelgen tests - Android', () => {
     it(`should generate files at desired location and not delete src files`, async () => {
         await testCodegenModels(DEFAULT_ANDROID_CONFIG, projectRoot, schema);
     });
-});
+
+    it('Should generate files at overridden output path', async () => {
+        await testCodegenModels(DEFAULT_ANDROID_CONFIG, projectRoot, schema, 'app/src/main/guava');
+    });
+});

packages/amplify-codegen-e2e-tests/src/__tests__/datastore-modelgen-flutter.test.ts

@@ -1,4 +1,4 @@
-import { createNewProjectDir, DEFAULT_FLUTTER_CONFIG } from "@aws-amplify/amplify-codegen-e2e-core";
+import { createNewProjectDir, DEFAULT_FLUTTER_CONFIG } from '@aws-amplify/amplify-codegen-e2e-core';
 import { deleteAmplifyProject, testCodegenModels } from '../codegen-tests-base';
 
 const schema = 'modelgen/model_gen_schema_with_aws_scalars.graphql';
@@ -17,4 +17,8 @@ describe('Datastore Modelgen tests - Flutter', () => {
     it(`should generate files at desired location and not delete src files`, async () => {
         await testCodegenModels(DEFAULT_FLUTTER_CONFIG, projectRoot, schema);
     });
-});
+
+  it(`should generate files at overridden location`, async () => {
+    await testCodegenModels(DEFAULT_FLUTTER_CONFIG, projectRoot, schema, 'lib/blueprints');
+  });
+});

packages/amplify-codegen-e2e-tests/src/__tests__/datastore-modelgen-ios.test.ts

@@ -1,4 +1,4 @@
-import { createNewProjectDir, DEFAULT_IOS_CONFIG } from "@aws-amplify/amplify-codegen-e2e-core";
+import { createNewProjectDir, DEFAULT_IOS_CONFIG } from '@aws-amplify/amplify-codegen-e2e-core';
 import { deleteAmplifyProject, testCodegenModels } from '../codegen-tests-base';
 
 const schema = 'modelgen/model_gen_schema_with_aws_scalars.graphql';
@@ -17,4 +17,8 @@ describe('Datastore Modelgen tests - iOS', () => {
     it(`should generate files at desired location and not delete src files`, async () => {
         await testCodegenModels(DEFAULT_IOS_CONFIG, projectRoot, schema);
     });
-});
+
+    it(`should generate files at overridden location`, async () => {
+      await testCodegenModels(DEFAULT_IOS_CONFIG, projectRoot, schema, 'amplification/manufactured/models');
+    });
+});

packages/amplify-codegen-e2e-tests/src/__tests__/datastore-modelgen-js.test.ts

@@ -1,4 +1,4 @@
-import { createNewProjectDir, DEFAULT_JS_CONFIG } from "@aws-amplify/amplify-codegen-e2e-core";
+import { createNewProjectDir, DEFAULT_JS_CONFIG } from '@aws-amplify/amplify-codegen-e2e-core';
 import { deleteAmplifyProject, testCodegenModels } from '../codegen-tests-base';
 
 const schema = 'modelgen/model_gen_schema_with_aws_scalars.graphql';
@@ -17,4 +17,8 @@ describe('Datastore Modelgen tests - JS', () => {
     it(`should generate files at desired location and not delete src files`, async () => {
         await testCodegenModels(DEFAULT_JS_CONFIG, projectRoot, schema);
     });
-});
+
+    it(`should generate files at desired location and not delete src files`, async () => {
+      await testCodegenModels(DEFAULT_JS_CONFIG, projectRoot, schema, 'src/backmodels');
+    });
+});

packages/amplify-codegen-e2e-tests/src/codegen-tests-base/datastore-modelgen.ts

@@ -5,12 +5,12 @@ import {
     createRandomName,
     generateModels,
     AmplifyFrontendConfig
-} from "@aws-amplify/amplify-codegen-e2e-core";
+} from '@aws-amplify/amplify-codegen-e2e-core';
 import { existsSync } from "fs";
 import path from 'path';
 import { isNotEmptyDir, generateSourceCode } from '../utils';
 
-export async function testCodegenModels(config: AmplifyFrontendConfig, projectRoot: string, schema: string) {
+export async function testCodegenModels(config: AmplifyFrontendConfig, projectRoot: string, schema: string, outputDir?: string) {
     const name = createRandomName();
 
     // init project and add API category
@@ -24,10 +24,10 @@ export async function testCodegenModels(config: AmplifyFrontendConfig, projectRo
     const userSourceCodePath = generateSourceCode(projectRoot, config.srcDir);
 
     //generate models
-    await expect(generateModels(projectRoot)).resolves.not.toThrow();
+    await expect(generateModels(projectRoot, outputDir)).resolves.not.toThrow();
 
     // pre-existing file should still exist
     expect(existsSync(userSourceCodePath)).toBe(true);
     // datastore models are generated at correct location
-    expect(isNotEmptyDir(path.join(projectRoot, config.modelgenDir))).toBe(true);
-}
+    expect(isNotEmptyDir(outputDir ? outputDir : path.join(projectRoot, config.modelgenDir))).toBe(true);
+}

packages/amplify-codegen/src/commands/model-intropection.js

@@ -3,12 +3,12 @@ const path = require('path');
 
 async function generateModelIntrospection(context) {
   // Verify override path flag is provided
-  const outputDirParam = context.parameters.options ? context.parameters.options['output-dir'] : null;
+  const outputDirParam = context.parameters?.options?.['output-dir'];
   if ( !outputDirParam || typeof(outputDirParam) !== 'string' ) {
     throw new Error('Expected --output-dir flag with value to be set for model introspection command.');
   }
   const outputDirPath = path.isAbsolute(outputDirParam) ? outputDirParam : path.join(context.amplify.getEnvInfo().projectPath, outputDirParam);
   await generateModels(context, outputDirPath, true);
 }
 
-module.exports = generateModelIntrospection;
+module.exports = generateModelIntrospection;

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

@@ -76,7 +76,12 @@ async function generateModels(context, outputDirPath = null, isIntrospection = f
   });
 
   const schemaContent = loadSchema(apiResourcePath);
-  const outputPath = outputDirPath || path.join(projectRoot, getModelOutputPath(context));
+
+  const outputDirParam = context.parameters?.options?.['output-dir'];
+  if ( !outputDirPath && outputDirParam && typeof(outputDirParam) !== 'string' ) {
+    throw new Error('Expected provided --output-dir flag to be given output location as input.');
+  }
+  const outputPath = outputDirPath ?? outputDirParam ?? path.join(projectRoot, getModelOutputPath(context));
   const schema = parse(schemaContent);
   const projectConfig = context.amplify.getProjectConfig();