feat: print out file written for amplify generate commands (#939)

bombguy · edwardfoyle · web-flow · commit 4c1485aa4497 · 2024-01-24T15:01:52.000-08:00
* feat: print out file written for amplify generate commands

* update API.md

* optional chaining

Co-authored-by: Edward Foyle &lt;foyleef@amazon.com&gt;

* optional chaining + prettier

* use splice instead

* pass in printer.log instead of defining print at top-level

* update API.md

* use printer singleton defined in cli

* removing unused import

* removing unused import

* fix platform specific path

* update assertions

* removing unused import

* win path fix

* win path fix

* try strictEqual instead of match

---------

Co-authored-by: Edward Foyle &lt;foyleef@amazon.com&gt;
diff --git a/.changeset/big-dryers-battle.md b/.changeset/big-dryers-battle.md
@@ -0,0 +1,8 @@
+---
+'@aws-amplify/model-generator': minor
+'@aws-amplify/form-generator': minor
+'@aws-amplify/client-config': minor
+'@aws-amplify/backend-cli': minor
+---
+
+print out file written for amplify generate commands
diff --git a/packages/cli/src/client-config/client_config_generator_adapter.ts b/packages/cli/src/client-config/client_config_generator_adapter.ts
@@ -6,6 +6,7 @@ import {
 } from '@aws-amplify/client-config';
 import { DeployedBackendIdentifier } from '@aws-amplify/deployed-backend-client';
 import { AwsCredentialIdentityProvider } from '@aws-sdk/types';
+import { printer } from '../printer.js';
 
 /**
  * Adapts static generateClientConfigToFile from @aws-amplify/client-config call to make it injectable and testable.
@@ -39,7 +40,8 @@ export class ClientConfigGeneratorAdapter {
       this.awsCredentialProvider,
       backendIdentifier,
       outDir,
-      format
+      format,
+      (message) => printer.log(message)
     );
   };
 }
diff --git a/packages/cli/src/commands/generate/config/generate_config_command.test.ts b/packages/cli/src/commands/generate/config/generate_config_command.test.ts
@@ -107,71 +107,86 @@ void describe('generate config command', () => {
       'config --branch branch_name --app-id app_id --out-dir /foo/bar --format mjs'
     );
     assert.equal(generateClientConfigMock.mock.callCount(), 1);
-    assert.deepStrictEqual(generateClientConfigMock.mock.calls[0].arguments, [
-      {
-        name: 'branch_name',
-        namespace: 'app_id',
-        type: 'branch',
-      },
-      '/foo/bar',
-      ClientConfigFormat.MJS,
-    ]);
+    assert.deepStrictEqual(
+      generateClientConfigMock.mock.calls[0].arguments.splice(0, 3),
+      [
+        {
+          name: 'branch_name',
+          namespace: 'app_id',
+          type: 'branch',
+        },
+        '/foo/bar',
+        ClientConfigFormat.MJS,
+      ]
+    );
   });
 
   void it('can generate to custom absolute path', async () => {
     await commandRunner.runCommand(
       'config --stack stack_name --out-dir /foo/bar --format ts'
     );
     assert.equal(generateClientConfigMock.mock.callCount(), 1);
-    assert.deepStrictEqual(generateClientConfigMock.mock.calls[0].arguments, [
-      {
-        stackName: 'stack_name',
-      },
-      '/foo/bar',
-      ClientConfigFormat.TS,
-    ]);
+    assert.deepStrictEqual(
+      generateClientConfigMock.mock.calls[0].arguments.splice(0, 3),
+      [
+        {
+          stackName: 'stack_name',
+        },
+        '/foo/bar',
+        ClientConfigFormat.TS,
+      ]
+    );
   });
 
   void it('can generate to custom relative path', async () => {
     await commandRunner.runCommand(
       'config --stack stack_name --out-dir foo/bar --format mjs'
     );
     assert.equal(generateClientConfigMock.mock.callCount(), 1);
-    assert.deepStrictEqual(generateClientConfigMock.mock.calls[0].arguments, [
-      {
-        stackName: 'stack_name',
-      },
-      'foo/bar',
-      ClientConfigFormat.MJS,
-    ]);
+    assert.deepStrictEqual(
+      generateClientConfigMock.mock.calls[0].arguments.splice(0, 3),
+      [
+        {
+          stackName: 'stack_name',
+        },
+        'foo/bar',
+        ClientConfigFormat.MJS,
+      ]
+    );
   });
 
   void it('can generate config in dart format', async () => {
     await commandRunner.runCommand(
       'config --stack stack_name --out-dir foo/bar --format dart'
     );
     assert.equal(generateClientConfigMock.mock.callCount(), 1);
-    assert.deepStrictEqual(generateClientConfigMock.mock.calls[0].arguments, [
-      {
-        stackName: 'stack_name',
-      },
-      'foo/bar',
-      ClientConfigFormat.DART,
-    ]);
+    assert.deepStrictEqual(
+      generateClientConfigMock.mock.calls[0].arguments.splice(0, 3),
+      [
+        {
+          stackName: 'stack_name',
+        },
+        'foo/bar',
+        ClientConfigFormat.DART,
+      ]
+    );
   });
 
   void it('can generate config in json mobile format', async () => {
     await commandRunner.runCommand(
       'config --stack stack_name --out-dir foo/bar --format json-mobile'
     );
     assert.equal(generateClientConfigMock.mock.callCount(), 1);
-    assert.deepStrictEqual(generateClientConfigMock.mock.calls[0].arguments, [
-      {
-        stackName: 'stack_name',
-      },
-      'foo/bar',
-      ClientConfigFormat.JSON_MOBILE,
-    ]);
+    assert.deepStrictEqual(
+      generateClientConfigMock.mock.calls[0].arguments.splice(0, 3),
+      [
+        {
+          stackName: 'stack_name',
+        },
+        'foo/bar',
+        ClientConfigFormat.JSON_MOBILE,
+      ]
+    );
   });
 
   void it('shows available options in help output', async () => {
diff --git a/packages/cli/src/form-generation/form_generation_handler.ts b/packages/cli/src/form-generation/form_generation_handler.ts
@@ -2,6 +2,7 @@ import { createLocalGraphqlFormGenerator } from '@aws-amplify/form-generator';
 import { createGraphqlDocumentGenerator } from '@aws-amplify/model-generator';
 import { DeployedBackendIdentifier } from '@aws-amplify/deployed-backend-client';
 import { AwsCredentialIdentityProvider } from '@aws-sdk/types';
+import { printer } from '../printer.js';
 
 type FormGenerationParams = {
   modelsOutDir: string;
@@ -32,14 +33,16 @@ export class FormGenerationHandler {
     const modelsResult = await graphqlClientGenerator.generateModels({
       language: 'typescript',
     });
-    await modelsResult.writeToDirectory(modelsOutDir);
+    await modelsResult.writeToDirectory(modelsOutDir, (message) =>
+      printer.log(message)
+    );
     const localFormGenerator = createLocalGraphqlFormGenerator({
       introspectionSchemaUrl: apiUrl,
       graphqlModelDirectoryPath: './graphql',
     });
     const result = await localFormGenerator.generateForms({
       models: modelsFilter,
     });
-    await result.writeToDirectory(uiOutDir);
+    await result.writeToDirectory(uiOutDir, (message) => printer.log(message));
   };
 }
diff --git a/packages/client-config/API.md b/packages/client-config/API.md
@@ -56,7 +56,7 @@ export enum ClientConfigFormat {
 export const generateClientConfig: (credentialProvider: AwsCredentialIdentityProvider, backendIdentifier: DeployedBackendIdentifier) => Promise<ClientConfig>;
 
 // @public
-export const generateClientConfigToFile: (credentialProvider: AwsCredentialIdentityProvider, backendIdentifier: DeployedBackendIdentifier, outDir?: string, format?: ClientConfigFormat) => Promise<void>;
+export const generateClientConfigToFile: (credentialProvider: AwsCredentialIdentityProvider, backendIdentifier: DeployedBackendIdentifier, outDir?: string, format?: ClientConfigFormat, log?: ((message: string) => void) | undefined) => Promise<void>;
 
 // @public
 export const getClientConfigPath: (outDir?: string, format?: ClientConfigFormat) => Promise<string>;
diff --git a/packages/client-config/src/client-config-writer/client_config_writer.ts b/packages/client-config/src/client-config-writer/client_config_writer.ts
@@ -1,4 +1,5 @@
 import _fsp from 'fs/promises';
+import path from 'path';
 import {
   ClientConfig,
   ClientConfigFormat,
@@ -28,10 +29,13 @@ export class ClientConfigWriter {
   writeClientConfig = async (
     clientConfig: ClientConfig,
     outDir?: string,
-    format: ClientConfigFormat = ClientConfigFormat.JSON
+    format: ClientConfigFormat = ClientConfigFormat.JSON,
+    // TODO: update this type when Printer interface gets defined in platform-core.
+    log?: (message: string) => void
   ): Promise<void> => {
     const targetPath = await this.pathResolver(outDir, format);
     const fileContent = this.formatter.format(clientConfig, format);
     await this.fsp.writeFile(targetPath, fileContent);
+    log?.(`File written: ${path.relative(process.cwd(), targetPath)}`);
   };
 }
diff --git a/packages/client-config/src/generate_client_config_to_file.ts b/packages/client-config/src/generate_client_config_to_file.ts
@@ -16,7 +16,9 @@ export const generateClientConfigToFile = async (
   credentialProvider: AwsCredentialIdentityProvider,
   backendIdentifier: DeployedBackendIdentifier,
   outDir?: string,
-  format?: ClientConfigFormat
+  format?: ClientConfigFormat,
+  // TODO: update this type when Printer interface gets defined in platform-core.
+  log?: (message: string) => void
 ): Promise<void> => {
   const packageJson = await readPackageJson();
 
@@ -31,7 +33,7 @@ export const generateClientConfigToFile = async (
     credentialProvider,
     backendIdentifier
   );
-  await clientConfigWriter.writeClientConfig(clientConfig, outDir, format);
+  await clientConfigWriter.writeClientConfig(clientConfig, outDir, format, log);
 };
 
 const readPackageJson = async (): Promise<{
diff --git a/packages/form-generator/API.md b/packages/form-generator/API.md
@@ -19,7 +19,7 @@ export type GraphqlFormGenerator = {
 
 // @public (undocumented)
 export type GraphqlGenerationResult = {
-    writeToDirectory: (directoryPath: string) => Promise<void>;
+    writeToDirectory: (directoryPath: string, log?: (message: string) => void) => Promise<void>;
 };
 
 // @public (undocumented)
diff --git a/packages/form-generator/src/codegen_graphql_form_generation_result.ts b/packages/form-generator/src/codegen_graphql_form_generation_result.ts
@@ -15,7 +15,11 @@ export class CodegenGraphqlFormGeneratorResult
   /**
    * writes the components to a given directory
    */
-  writeToDirectory = async (directoryPath: string) => {
+  writeToDirectory = async (
+    directoryPath: string,
+    // TODO: update this type when Printer interface gets defined in platform-core.
+    log?: (message: string) => void
+  ) => {
     try {
       await fs.stat(directoryPath);
     } catch (e) {
@@ -25,9 +29,11 @@ export class CodegenGraphqlFormGeneratorResult
       this.fileNameComponentMap
     )) {
       if (content) {
-        const fd = await fs.open(path.join(directoryPath, fileName), 'w+');
+        const filePath = path.join(directoryPath, fileName);
+        const fd = await fs.open(filePath, 'w+');
         try {
           await fd.writeFile(content);
+          log?.(`File written: ${path.relative(process.cwd(), filePath)}`);
         } finally {
           await fd.close();
         }
diff --git a/packages/form-generator/src/graphql_form_generator.ts b/packages/form-generator/src/graphql_form_generator.ts
@@ -1,5 +1,9 @@
 export type GraphqlGenerationResult = {
-  writeToDirectory: (directoryPath: string) => Promise<void>;
+  writeToDirectory: (
+    directoryPath: string,
+    // TODO: update this type when Printer interface gets defined in platform-core.
+    log?: (message: string) => void
+  ) => Promise<void>;
 };
 export type FormGenerationOptions = {
   models?: string[];
diff --git a/packages/form-generator/src/local_codegen_graphql_form_generator.test.ts b/packages/form-generator/src/local_codegen_graphql_form_generator.test.ts
@@ -65,9 +65,22 @@ void describe('LocalCodegenGraphqlFormGenerator', () => {
         stat: async () => ({}),
         close: async () => undefined,
       }));
-      await output.writeToDirectory('./');
+      const mockLog = mock.fn();
+      await output.writeToDirectory('./', (message) => mockLog(message));
       const writeArgs = fsMock.mock.calls.flatMap((c) => c.arguments[0]);
-      assert(writeArgs.some((e) => /utils\.[jt]s[x]?/.test(e.toString())));
+      const utilFSWriteArgs = writeArgs.filter((e) =>
+        /utils\.[jt]s[x]?/.test(e.toString())
+      );
+
+      assert(utilFSWriteArgs.length > 0);
+
+      utilFSWriteArgs.forEach((fileName) => {
+        assert(
+          mockLog.mock.calls.some(({ arguments: [logMessage] }) =>
+            new RegExp(`^File written: ${fileName as string}$`).test(logMessage)
+          )
+        );
+      });
     });
     void it('generates index file', async () => {
       const models = ['Post', 'Author', 'Foo'];
@@ -88,9 +101,19 @@ void describe('LocalCodegenGraphqlFormGenerator', () => {
         stat: async () => ({}),
         close: async () => undefined,
       }));
-      await output.writeToDirectory('./');
+      const mockLog = mock.fn();
+      await output.writeToDirectory('./', (message) => mockLog(message));
       const writeArgs = fsMock.mock.calls.flatMap((c) => c.arguments[0]);
       assert(writeArgs.includes('index.js'));
+
+      const logArgs: string[] = mockLog.mock.calls.flatMap(
+        (c) => c.arguments[0]
+      );
+      assert(
+        logArgs.some((logMessage) =>
+          new RegExp('^File written: index.js$').test(logMessage)
+        )
+      );
     });
   });
   void describe('filtering', () => {
@@ -126,13 +149,21 @@ void describe('LocalCodegenGraphqlFormGenerator', () => {
         stat: async () => ({}),
         close: async () => undefined,
       }));
-      await output.writeToDirectory('./');
+      const mockLog = mock.fn();
+      await output.writeToDirectory('./', (message) => mockLog(message));
       const writeArgs = fsMock.mock.calls.flatMap((c) => c.arguments[0]);
+      const logMessages = mockLog.mock.calls.flatMap((c) => c.arguments[0]);
       assert(
         models.every((m) => {
-          return writeArgs.some((arg) =>
+          const didWriteFile = writeArgs.some((arg) =>
             new RegExp(`${m}(Update|Create)Form.d.ts`).test(arg.toString())
           );
+          const didLogMessage = logMessages.some((logMessage) =>
+            new RegExp(`^File written: ${m}(Update|Create)Form.d.ts$`).test(
+              logMessage.toString()
+            )
+          );
+          return didWriteFile && didLogMessage;
         })
       );
     });
diff --git a/packages/model-generator/API.md b/packages/model-generator/API.md
@@ -119,7 +119,7 @@ export type GenerateOptions = GenerateGraphqlCodegenOptions | GenerateModelsOpti
 
 // @public (undocumented)
 export type GenerationResult = {
-    writeToDirectory: (directoryPath: string) => Promise<void>;
+    writeToDirectory: (directoryPath: string, log?: (message: string) => void) => Promise<void>;
     getResults: () => Promise<Record<string, string>>;
 };
 
diff --git a/packages/model-generator/src/appsync_graphql_generation_result.test.ts b/packages/model-generator/src/appsync_graphql_generation_result.test.ts
@@ -6,9 +6,10 @@ import assert from 'assert';
 
 void describe('AppsyncGraphqlDocumentGenerationResult', () => {
   void it('writes a map of files to disk', async () => {
-    const writeMock = mock.method(fs, 'writeFile');
+    const writeFileMock = mock.method(fs, 'writeFile');
+    const logMock = mock.fn();
     mock.method(fs, 'mkdir').mock.mockImplementation(async () => null);
-    writeMock.mock.mockImplementation(async () => null);
+    writeFileMock.mock.mockImplementation(async () => null);
     const filePathWithDir = path.join('a-third', 'fake-file', '.type');
     const files: Record<string, string> = {
       'fake-file': 'my \n fake file \n contents',
@@ -19,14 +20,24 @@ void describe('AppsyncGraphqlDocumentGenerationResult', () => {
     const result = new AppsyncGraphqlGenerationResult(files);
     const directory = './fake-dir';
 
-    await result.writeToDirectory(directory);
+    await result.writeToDirectory(directory, (message) => logMock(message));
 
     Object.entries(files).forEach(([fileName, content]) => {
       const resolvedName = path.resolve(path.join(directory, fileName));
-      const writeCall = writeMock.mock.calls.find(
+      const writeFileCall = writeFileMock.mock.calls.find(
         ({ arguments: [f] }) => resolvedName === f
       );
-      assert.deepEqual(writeCall?.arguments, [resolvedName, content]);
+      const logCall = logMock.mock.calls.find(({ arguments: [message] }) =>
+        message.includes(path.join(directory, fileName))
+      );
+      assert.deepEqual(writeFileCall?.arguments, [resolvedName, content]);
+      assert.strictEqual(
+        logCall?.arguments[0],
+        `File written: ${path.relative(
+          '.',
+          path.resolve(path.join(directory, fileName))
+        )}`
+      );
     });
   });
 });
diff --git a/packages/model-generator/src/appsync_graphql_generation_result.ts b/packages/model-generator/src/appsync_graphql_generation_result.ts
diff --git a/packages/model-generator/src/model_generator.ts b/packages/model-generator/src/model_generator.ts
