feat: amplify add override root command and skeleton generation (aws-…

…amplify#7684)

* feat: amplify add override root command and skeleton generation

* feat: build and package overrides directory

* test: add unit tests

* fix: updates with PR comments

* test: fix unit tests

Co-authored-by: Ghosh <kaustavg@3c22fb229ff6.ant.amazon.com>

packages/amplify-provider-awscloudformation/amplify-plugin.json

@@ -1,13 +1,14 @@
 {
     "name": "awscloudformation",
-    "aliases": ["awscfn", "aws"],
+    "aliases": ["awscfn", "aws", "root"],
     "type": "provider",
     "commands": [
         "configure",
         "console",
         "reset-cache",
         "setupNewUser",
-        "help"
+        "help",
+        "override"
     ],
     "commandAliases":{
         "resetCache": "reset-cache",

packages/amplify-provider-awscloudformation/package.json

@@ -86,6 +86,7 @@
     "constructs": "~3.2.0",
     "cors": "^2.8.5",
     "deep-diff": "^1.0.2",
+    "execa": "^4.1.0",
     "extract-zip": "^2.0.1",
     "folder-hash": "^4.0.1",
     "fs-extra": "^8.1.0",

packages/amplify-provider-awscloudformation/resources/overrides-resource/override.ts

@@ -0,0 +1,6 @@
+/* Add Amplify Helper dependencies     */
+
+/* TODO: Need to change props to Root-Stack specific props when props are ready */
+export function overrideProps(props: any): void {
+  /* TODO: Add snippet of how to override in comments */
+}

packages/amplify-provider-awscloudformation/resources/overrides-resource/package.json

@@ -0,0 +1,18 @@
+{
+    "name": "overrides",
+    "version": "1.0.0",
+    "description": "",
+    "scripts": {
+      "build": "tsc",
+      "watch": "tsc -w",
+      "test": "echo \"Error: no test specified\" && exit 1"
+    },
+    "dependencies": {
+      "@types/fs-extra": "^9.0.11",
+      "fs-extra": "^9.1.0"
+    },
+    "devDependencies": {
+      "typescript": "^4.2.4"
+    }
+  }
+

packages/amplify-provider-awscloudformation/resources/overrides-resource/tsconfig.json

@@ -0,0 +1,73 @@
+{
+    "compilerOptions": {
+      /* Visit https://aka.ms/tsconfig.json to read more about this file */
+
+      /* Basic Options */
+      // "incremental": true,                         /* Enable incremental compilation */
+      "target": "es6",                                /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
+      "module": "commonjs",                           /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
+      // "lib": [],                                   /* Specify library files to be included in the compilation. */
+      // "allowJs": true,                             /* Allow javascript files to be compiled. */
+      // "checkJs": true,                             /* Report errors in .js files. */
+      // "jsx": "preserve",                           /* Specify JSX code generation: 'preserve', 'react-native', 'react', 'react-jsx' or 'react-jsxdev'. */
+      // "declaration": true,                         /* Generates corresponding '.d.ts' file. */
+      // "declarationMap": true,                      /* Generates a sourcemap for each corresponding '.d.ts' file. */
+      // "sourceMap": true,                           /* Generates corresponding '.map' file. */
+      // "outFile": "./",                             /* Concatenate and emit output to single file. */
+      // "outDir": "./",                              /* Redirect output structure to the directory. */
+      // "rootDir": "./",                             /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+      // "composite": true,                           /* Enable project compilation */
+      // "tsBuildInfoFile": "./",                     /* Specify file to store incremental compilation information */
+      // "removeComments": true,                      /* Do not emit comments to output. */
+      // "noEmit": true,                              /* Do not emit outputs. */
+      // "importHelpers": true,                       /* Import emit helpers from 'tslib'. */
+      // "downlevelIteration": true,                  /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
+      // "isolatedModules": true,                     /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
+
+      /* Strict Type-Checking Options */
+      "strict": false,                                 /* Enable all strict type-checking options. */
+      // "noImplicitAny": true,                       /* Raise error on expressions and declarations with an implied 'any' type. */
+      // "strictNullChecks": true,                    /* Enable strict null checks. */
+      // "strictFunctionTypes": true,                 /* Enable strict checking of function types. */
+      // "strictBindCallApply": true,                 /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
+      // "strictPropertyInitialization": true,        /* Enable strict checking of property initialization in classes. */
+      // "noImplicitThis": true,                      /* Raise error on 'this' expressions with an implied 'any' type. */
+      // "alwaysStrict": true,                        /* Parse in strict mode and emit "use strict" for each source file. */
+
+      /* Additional Checks */
+      // "noUnusedLocals": true,                      /* Report errors on unused locals. */
+      // "noUnusedParameters": true,                  /* Report errors on unused parameters. */
+      // "noImplicitReturns": true,                   /* Report error when not all code paths in function return a value. */
+      // "noFallthroughCasesInSwitch": true,          /* Report errors for fallthrough cases in switch statement. */
+      // "noUncheckedIndexedAccess": true,            /* Include 'undefined' in index signature results */
+      // "noPropertyAccessFromIndexSignature": true,  /* Require undeclared properties from index signatures to use element accesses. */
+
+      /* Module Resolution Options */
+      // "moduleResolution": "node",                  /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+      // "baseUrl": "./",                             /* Base directory to resolve non-absolute module names. */
+      // "paths": {},                                 /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
+      // "rootDirs": [],                              /* List of root folders whose combined content represents the structure of the project at runtime. */
+      // "typeRoots": [],                             /* List of folders to include type definitions from. */
+      // "types": [],                                 /* Type declaration files to be included in compilation. */
+      // "allowSyntheticDefaultImports": true,        /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+      "esModuleInterop": true,                        /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+      // "preserveSymlinks": true,                    /* Do not resolve the real path of symlinks. */
+      // "allowUmdGlobalAccess": true,                /* Allow accessing UMD globals from modules. */
+
+      /* Source Map Options */
+      // "sourceRoot": "",                            /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+      // "mapRoot": "",                               /* Specify the location where debugger should locate map files instead of generated locations. */
+      // "inlineSourceMap": true,                     /* Emit a single file with source maps instead of having a separate file. */
+      // "inlineSources": true,                       /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+
+      /* Experimental Options */
+      // "experimentalDecorators": true,              /* Enables experimental support for ES7 decorators. */
+      // "emitDecoratorMetadata": true,               /* Enables experimental support for emitting type metadata for decorators. */
+
+      /* Advanced Options */
+      "skipLibCheck": true,                           /* Skip type checking of declaration files. */
+      "forceConsistentCasingInFileNames": true        /* Disallow inconsistently-cased references to the same file. */,
+      "outDir": "build"
+    }
+  }
+

packages/amplify-provider-awscloudformation/src/__tests__/utils/override-skeleton-generator-test.ts

@@ -0,0 +1,52 @@
+const path = require('path');
+const fs = require('fs-extra');
+const execa = require('execa');
+
+import { $TSContext } from 'amplify-cli-core';
+import { generateOverrideSkeleton } from '../../utils/override-skeleton-generator';
+
+const mockProjectPath = 'mockProjectPath';
+const context_stub = ({
+  amplify: {
+    pathManager: {
+      getBackendDirPath: () => path.join(mockProjectPath, 'amplify', 'backend'),
+    },
+  },
+} as unknown) as jest.Mocked<$TSContext>;
+
+jest.mock('execa', () => ({
+  sync: jest.fn(),
+}));
+
+jest.mock('fs-extra', () => ({
+  ensureDirSync: jest.fn(),
+  copySync: jest.fn(),
+  existsSync: jest.fn(),
+}));
+
+jest.mock('amplify-cli-core', () => ({
+  getPackageManager: () => ({
+    executable: 'npm',
+  }),
+}));
+
+describe('run override command for root stack', () => {
+  test('generate override skeleton package and build with npm as package manager ', async () => {
+    await generateOverrideSkeleton(context_stub);
+
+    const overridesDirPath = path.join(mockProjectPath, 'amplify', 'backend', 'awscloudformation', 'overrides');
+    expect(fs.ensureDirSync).toBeCalledWith(overridesDirPath);
+
+    expect(execa.sync).toBeCalledWith('npm', ['install'], {
+      cwd: overridesDirPath,
+      stdio: 'pipe',
+      encoding: 'utf-8',
+    });
+
+    expect(execa.sync).toBeCalledWith('tsc', [], {
+      cwd: overridesDirPath,
+      stdio: 'pipe',
+      encoding: 'utf-8',
+    });
+  });
+});

packages/amplify-provider-awscloudformation/src/commands/awscloudformation/override.ts

@@ -0,0 +1,14 @@
+/*
+    entry code for amplify override root
+*/
+
+import { generateOverrideSkeleton } from '../../utils/override-skeleton-generator';
+
+const subcommand = 'override';
+
+module.exports = {
+  name: subcommand,
+  run: async context => {
+    await generateOverrideSkeleton(context);
+  },
+};

packages/amplify-provider-awscloudformation/src/utils/override-skeleton-generator.ts

@@ -0,0 +1,55 @@
+import path from 'path';
+import fs from 'fs-extra';
+import { getPackageManager } from 'amplify-cli-core';
+import execa from 'execa';
+import { $TSContext } from 'amplify-cli-core';
+
+export const generateOverrideSkeleton = async (context: $TSContext): Promise<void> => {
+  // 1. Create skeleton package
+  const backendDir = context.amplify.pathManager.getBackendDirPath();
+
+  const overrideDirPath = path.normalize(path.join(backendDir, 'awscloudformation', 'overrides'));
+
+  if (fs.existsSync(overrideDirPath)) {
+    context.print.warning(`Overrides folder already exists. Please make your changes in ${overrideDirPath} directory`);
+    return;
+  }
+
+  fs.ensureDirSync(overrideDirPath);
+  const overrideResourceDir = path.normalize(path.join(__dirname, '..', '..', 'resources', 'overrides-resource'));
+  fs.copySync(overrideResourceDir, overrideDirPath);
+
+  // 2. Build Override Directory
+
+  buildOverrideDir(overrideDirPath);
+};
+
+function buildOverrideDir(cwd: string) {
+  const packageManager = getPackageManager(cwd);
+
+  if (packageManager === null) {
+    throw new Error('No package manager found. Please install npm or yarn to compile overrides for this project.');
+  }
+
+  try {
+    execa.sync(packageManager.executable, ['install'], {
+      cwd,
+      stdio: 'pipe',
+      encoding: 'utf-8',
+    });
+  } catch (error) {
+    if ((error as any).code === 'ENOENT') {
+      throw new Error(`Packaging overrides failed. Could not find ${packageManager} executable in the PATH.`);
+    } else {
+      throw new Error(`Packaging overrides failed with the error \n${error.message}`);
+    }
+  }
+
+  // run tsc build to build override.ts file
+
+  execa.sync('tsc', [], {
+    cwd,
+    stdio: 'pipe',
+    encoding: 'utf-8',
+  });
+}

packages/amplify-provider-awscloudformation/tsconfig.json

@@ -12,6 +12,7 @@
     "lib",
     "coverage",
     "src/__tests__",
+    "resources/overrides-resource/override.ts"
   ],
   "references": [
     {"path": "../amplify-cli-core"},