adds info command (#952)

* adds info command

Author: ykethan

.changeset/unlucky-kangaroos-love.md

@@ -0,0 +1,5 @@
+---
+'@aws-amplify/backend-cli': minor
+---
+
+adds info commands that provides troubleshooting info

.eslint_dictionary.json

@@ -32,6 +32,7 @@
   "ecma",
   "enum",
   "enums",
+  "envinfo",
   "esbuild",
   "esnext",
   "execa",

package-lock.json

@@ -27,6 +27,12 @@ export enum COLOR {
     RED = "31m"
 }
 
+// @public
+export const format: {
+    list: (lines: string[]) => string;
+    indent: (message: string) => string;
+};
+
 // @public (undocumented)
 export enum LogLevel {
     // (undocumented)

packages/cli-core/API.md

@@ -0,0 +1,34 @@
+import * as os from 'node:os';
+import * as assert from 'node:assert';
+import { describe, it } from 'node:test';
+import { format } from './format.js';
+
+void describe('format', () => {
+  void it('should create a list with each line preceded by a dash', () => {
+    const lines = ['Item 1', 'Item 2', 'Item 3'];
+    const expectedOutput = ` - Item 1${os.EOL} - Item 2${os.EOL} - Item 3`;
+    const actualOutput = format.list(lines);
+    assert.strictEqual(actualOutput, expectedOutput);
+  });
+
+  void it('should indent the message by two spaces', () => {
+    const message = `Hello${os.EOL}World`;
+    const expectedOutput = `  Hello${os.EOL}  World`;
+    const actualOutput = format.indent(message);
+    assert.strictEqual(actualOutput, expectedOutput);
+  });
+
+  void it('should return an empty string when the input is empty', () => {
+    const message = '';
+    const expectedOutput = '';
+    const actualOutput = format.indent(message);
+    assert.strictEqual(actualOutput, expectedOutput);
+  });
+
+  void it('should allow chaining indent calls to increase indentation', () => {
+    const message = `Hello${os.EOL}World`;
+    const expectedOutput = `    Hello${os.EOL}    World`;
+    const actualOutput = format.indent(format.indent(message));
+    assert.strictEqual(actualOutput, expectedOutput);
+  });
+});

packages/cli-core/src/format/format.test.ts

@@ -0,0 +1,19 @@
+import * as os from 'node:os';
+
+/**
+ * Formats various inputs into single string.
+ */
+export const format = {
+  list: (lines: string[]) =>
+    lines.map((line: string) => ` - ${line}`).join(os.EOL),
+  indent: (message: string) => {
+    if (message === '') {
+      return '';
+    }
+    const spaces = '  '; // Two spaces for indentation
+    return message
+      .split(os.EOL)
+      .map((line) => `${spaces}${line}`)
+      .join(os.EOL);
+  },
+};

packages/cli-core/src/format/format.ts

@@ -1,4 +1,5 @@
 export * from './prompter/amplify_prompts.js';
 export { COLOR } from './colors.js';
 export * from './printer/printer.js';
+export * from './format/format.js';
 export * from './package-manager-controller/package_manager_controller_factory.js';

packages/cli-core/src/index.ts

@@ -44,6 +44,7 @@
     "@aws-sdk/region-config-resolver": "^3.465.0",
     "@smithy/node-config-provider": "^2.1.3",
     "@smithy/shared-ini-file-loader": "^2.2.5",
+    "envinfo": "^7.11.0",
     "execa": "^8.0.1",
     "is-ci": "^3.0.1",
     "open": "^9.1.0",
@@ -54,6 +55,7 @@
     "@aws-sdk/types": "^3.465.0"
   },
   "devDependencies": {
+    "@types/envinfo": "^7.8.3",
     "@types/yargs": "^17.0.24"
   }
 }

packages/cli/package.json

@@ -0,0 +1,91 @@
+import * as os from 'node:os';
+import { describe, it, mock } from 'node:test';
+import { createInfoCommand } from './info_command_factory.js';
+import { InfoCommand } from './info_command.js';
+import { EnvironmentInfoProvider } from '../../info/env_info_provider.js';
+import { CdkInfoProvider } from '../../info/cdk_info_provider.js';
+import { TestCommandRunner } from '../../test-utils/command_runner.js';
+import { printer } from '../../printer.js';
+import assert from 'node:assert';
+import yargs from 'yargs';
+
+void describe('createInfoCommand', () => {
+  void it('should return an instance of InfoCommand', () => {
+    const result = createInfoCommand();
+    assert.ok(result instanceof InfoCommand);
+  });
+});
+
+void describe('info command run', () => {
+  const command = createInfoCommand();
+  const parser = yargs().command(command);
+  const commandRunner = new TestCommandRunner(parser);
+
+  void it('includes info subcommands in help output', async () => {
+    const output = await commandRunner.runCommand(['info', '--help']);
+    assert.match(
+      output,
+      /info\W*Generates information for Amplify troubleshooting/
+    );
+  });
+
+  void it('test info command run', async () => {
+    const environmentInfoProviderMock = new EnvironmentInfoProvider();
+    const cdkInfoProviderMock = new CdkInfoProvider();
+
+    const cdkMockValue = `
+    AWS environment variables:
+      AWS_STS_REGIONAL_ENDPOINTS = regional
+      AWS_NODEJS_CONNECTION_REUSE_ENABLED = 1
+      AWS_SDK_LOAD_CONFIG = 1
+    CDK environment variables:
+      CDK_DEBUG = true
+      CDK_DISABLE_VERSION_CHECK = true
+    `;
+
+    const environmentInfoMockValue = `
+    System:
+      CPU: fake
+      Memory: fake
+      OS: fakeOS
+      Shell: /fake/path
+    Binaries:
+      Node: 0.0.0 - /fake/path
+      npm: 0.0.0 - /fake/path
+      pnpm: 0.0.0 - /fake/path
+      Yarn: 0.0.0 - /fake/path
+    NPM Packages:
+      fake: 0.0.0
+      `;
+
+    const infoMock = mock.method(
+      environmentInfoProviderMock,
+      'getEnvInfo',
+      async () => environmentInfoMockValue
+    );
+
+    const cdkInfoMock = mock.method(
+      cdkInfoProviderMock,
+      'getCdkInfo',
+      async () => cdkMockValue
+    );
+
+    const mockPrinter = mock.method(printer, 'print', () => ({}));
+
+    const command = new InfoCommand(
+      environmentInfoProviderMock,
+      cdkInfoProviderMock
+    );
+    const parser = yargs().command(command);
+    const commandRunner = new TestCommandRunner(parser);
+    await commandRunner.runCommand(['info']);
+
+    assert.equal(infoMock.mock.callCount(), 1);
+    assert.equal(cdkInfoMock.mock.callCount(), 1);
+    assert.equal(mockPrinter.mock.callCount(), 1);
+    assert.strictEqual(
+      mockPrinter.mock.calls[0].arguments[0],
+      `${environmentInfoMockValue}${os.EOL}${cdkMockValue}`
+    );
+  });
+});

packages/cli/src/commands/info/info_command.test.ts

@@ -0,0 +1,48 @@
+import * as os from 'node:os';
+import { Argv, CommandModule } from 'yargs';
+import { CdkInfoProvider } from '../../info/cdk_info_provider.js';
+import { EnvironmentInfoProvider } from '../../info/env_info_provider.js';
+import { printer } from '../../printer.js';
+
+/**
+ * Represents the InfoCommand class.
+ */
+export class InfoCommand implements CommandModule<object> {
+  /**
+   * @inheritDoc
+   */
+  readonly command: string;
+
+  /**
+   * @inheritDoc
+   */
+  readonly describe: string;
+
+  /**
+   * Creates top level entry point for generate command.
+   */
+  constructor(
+    private readonly environmentInfoProvider: EnvironmentInfoProvider,
+    private readonly cdkInfoProvider: CdkInfoProvider
+  ) {
+    this.command = 'info';
+    this.describe = 'Generates information for Amplify troubleshooting';
+  }
+
+  /**
+   * @inheritDoc
+   */
+  handler = async (): Promise<void> => {
+    const environmentInfo = await this.environmentInfoProvider.getEnvInfo();
+    const cdkInfo = await this.cdkInfoProvider.getCdkInfo();
+
+    printer.print(`${environmentInfo}${os.EOL}${cdkInfo}`);
+  };
+
+  /**
+   * @inheritDoc
+   */
+  builder = (yargs: Argv): Argv => {
+    return yargs.version(false).help();
+  };
+}