Merge pull request #498 from aws-amplify/main

Release Codegen Repo

Author: alharris-at

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

@@ -8,7 +8,7 @@ module.exports = {
   name: featureName,
   run: async context => {
     try {
-      await codeGen.generateModels(context, getOutputDirParam(context, false));
+      await codeGen.generateModels(context, { overrideOutputDir: getOutputDirParam(context, false) });
     } catch (ex) {
       context.print.info(ex.message);
       console.log(ex.stack);

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

@@ -1,8 +1,37 @@
 const generateModels = require('./models');
 const getOutputDirParam = require('../utils/getOutputDirParam');
 
+/**
+ * Generate the model introspection file for the input schema, and write to disk based on
+ * the output-dir flag passed in by the customer.
+ */
 async function generateModelIntrospection(context) {
-  await generateModels(context, getOutputDirParam(context, true), true);
+  await generateModels(context, {
+    overrideOutputDir: getOutputDirParam(context, true),
+    isIntrospection: true,
+  });
 }
 
-module.exports = generateModelIntrospection;
+/**
+ * Compute the model introspection schema and return in-memory.
+ * @param context the CLI context, necessary for file locations and feature flags.
+ * @returns the latest version of the model introspection schema shape.
+ */
+async function getModelIntrospection(context) {
+  const generatedCode = await generateModels(context, {
+    overrideOutputDir: '.', // Needed to get output working, not used, since writeToDisk is disabled.
+    isIntrospection: true,
+    writeToDisk: false,
+  });
+
+  if (generatedCode.length !== 1) {
+    throw new Error('Expected a single output to be generated for model introspection.');
+  }
+
+  return JSON.parse(generatedCode[0]);
+}
+
+module.exports = {
+  generateModelIntrospection,
+  getModelIntrospection,
+};

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

@@ -45,7 +45,23 @@ const readNumericFeatureFlag = key => {
   }
 };
 
-async function generateModels(context, overrideOutputDir = null, isIntrospection = false) {
+// type GenerateModelsOptions = {
+//   overrideOutputDir?: String;
+//   isIntrospection: Boolean;
+//   writeToDisk: Boolean;
+// }
+
+const defaultGenerateModelsOption = {
+  overrideOutputDir: null,
+  isIntrospection: false,
+  writeToDisk: true,
+};
+
+async function generateModels(context, generateOptions = null) {
+  const { overrideOutputDir, isIntrospection, writeToDisk } = generateOptions
+    ? { ...defaultGenerateModelsOption, ...generateOptions }
+    : defaultGenerateModelsOption;
+
   // steps:
   // 1. Load the schema and validate using transformer
   // 2. get all the directives supported by transformer
@@ -151,15 +167,19 @@ async function generateModels(context, overrideOutputDir = null, isIntrospection
 
   const generatedCode = await Promise.all(codeGenPromises);
 
-  appsyncLocalConfig.forEach((cfg, idx) => {
-    const outPutPath = cfg.filename;
-    fs.ensureFileSync(outPutPath);
-    fs.writeFileSync(outPutPath, generatedCode[idx]);
-  });
+  if (writeToDisk) {
+    appsyncLocalConfig.forEach((cfg, idx) => {
+      const outPutPath = cfg.filename;
+      fs.ensureFileSync(outPutPath);
+      fs.writeFileSync(outPutPath, generatedCode[idx]);
+    });
+
+    generateEslintIgnore(context);
 
-  generateEslintIgnore(context);
+    context.print.info(`Successfully generated models. Generated models can be found in ${overrideOutputDir ?? baseOutputDir}`);
+  }
 
-  context.print.info(`Successfully generated models. Generated models can be found in ${overrideOutputDir ?? baseOutputDir}`);
+  return generatedCode;
 }
 
 async function validateSchema(context) {

packages/amplify-codegen/src/index.js

@@ -5,7 +5,7 @@ const add = require('./commands/add');
 const remove = require('./commands/remove');
 const configure = require('./commands/configure');
 const generateModels = require('./commands/models');
-const generateModelIntrospection = require('./commands/model-intropection');
+const { generateModelIntrospection, getModelIntrospection } = require('./commands/model-intropection');
 const { isCodegenConfigured, switchToSDLSchema } = require('./utils');
 const prePushAddGraphQLCodegenHook = require('./callbacks/prePushAddCallback');
 const prePushUpdateGraphQLCodegenHook = require('./callbacks/prePushUpdateCallback');
@@ -28,4 +28,5 @@ module.exports = {
   handleAmplifyEvent,
   generateModels,
   generateModelIntrospection,
+  getModelIntrospection,
 };

packages/amplify-codegen/tests/commands/model-introspection.test.js

@@ -1,4 +1,4 @@
-const generateModelIntrospection = require('../../src/commands/model-intropection');
+const { generateModelIntrospection, getModelIntrospection } = require('../../src/commands/model-intropection');
 const graphqlCodegen = require('@graphql-codegen/core');
 const mockFs = require('mock-fs');
 const path = require('path');
@@ -10,7 +10,8 @@ const MOCK_OUTPUT_DIR = 'output';
 const MOCK_PROJECT_ROOT = 'project';
 const MOCK_PROJECT_NAME = 'myapp';
 const MOCK_BACKEND_DIRECTORY = 'backend';
-const MOCK_GENERATED_CODE = 'This code is auto-generated!';
+const MOCK_GENERATED_INTROSPECTION = { schemaVersion: 1 }
+const MOCK_GENERATED_CODE = JSON.stringify(MOCK_GENERATED_INTROSPECTION);
 const MOCK_CONTEXT = {
   print: {
     info: jest.fn(),
@@ -39,7 +40,7 @@ const MOCK_CONTEXT = {
 
 
 
-describe('model-intropection command test', () => {
+describe('generateModelIntrospection', () => {
   graphqlCodegen.codegen.mockReturnValue(MOCK_GENERATED_CODE);
   const schemaFilePath = path.join(MOCK_BACKEND_DIRECTORY, 'api', MOCK_PROJECT_NAME);
   const outputDirectory = path.join(MOCK_PROJECT_ROOT, MOCK_OUTPUT_DIR);
@@ -81,4 +82,32 @@ describe('model-intropection command test', () => {
   });
 
   afterEach(mockFs.restore);
+});
+
+describe('getModelIntrospection', () => {
+  graphqlCodegen.codegen.mockReturnValue(MOCK_GENERATED_CODE);
+  const schemaFilePath = path.join(MOCK_BACKEND_DIRECTORY, 'api', MOCK_PROJECT_NAME);
+  const outputDirectory = path.join(MOCK_PROJECT_ROOT, MOCK_OUTPUT_DIR);
+  const mockedFiles = {};
+  mockedFiles[schemaFilePath] = {
+    'schema.graphql': ' type SimpleModel { id: ID! status: String } ',
+  };
+  mockedFiles[outputDirectory] = {};
+
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it('should return model intropection schema', async () => {
+    mockFs(mockedFiles);
+    // assert empty folder before generation
+    expect(fs.readdirSync(outputDirectory).length).toEqual(0);
+
+    const responseObject = await getModelIntrospection(MOCK_CONTEXT);
+    expect(responseObject).toEqual(MOCK_GENERATED_INTROSPECTION);
+
+    // assert model generation succeeds with no file written
+    expect(graphqlCodegen.codegen).toBeCalled();
+    expect(fs.readdirSync(outputDirectory).length).toEqual(0); 
+  });
 });

packages/appsync-modelgen-plugin/src/index.ts

@@ -6,6 +6,7 @@ export interface AppSyncModelPluginConfig extends RawDocumentsConfig {
 
 export * from './plugin';
 export * from './preset';
+export * from './interfaces/introspection';
 
 export const addToSchema = (config: AppSyncModelPluginConfig) => {
   const result: string[] = [];