aws-cdk
Version:
AWS CDK CLI, the command line tool for CDK apps
85 lines • 12.6 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.invokeBuiltinHooks = invokeBuiltinHooks;
const path = require("path");
const toolkit_lib_1 = require("@aws-cdk/toolkit-lib");
const os_1 = require("./os");
const util_1 = require("../../util");
/**
* Invoke hooks for the given init template
*
* Sometimes templates need more complex logic than just replacing tokens. A 'hook' can be
* used to do additional processing other than copying files.
*
* Hooks used to be defined externally to the CLI, by running arbitrarily
* substituted shell scripts in the target directory.
*
* In practice, they're all TypeScript files and all the same, and the dynamism
* that the original solution allowed wasn't used at all. Worse, since the CLI
* is now bundled the hooks can't even reuse code from the CLI libraries at all
* anymore, so all shared code would have to be copy/pasted.
*
* Bundle hooks as built-ins into the CLI, so they get bundled and can take advantage
* of all shared code.
*/
async function invokeBuiltinHooks(ioHelper, target, context) {
switch (target.language) {
case 'csharp':
if (['app', 'sample-app'].includes(target.templateName)) {
return dotnetAddProject(ioHelper, target.targetDirectory, context);
}
break;
case 'fsharp':
if (['app', 'sample-app'].includes(target.templateName)) {
return dotnetAddProject(ioHelper, target.targetDirectory, context, 'fsproj');
}
break;
case 'python':
// We can't call this file 'requirements.template.txt' because Dependabot needs to be able to find it.
// Therefore, keep the in-repo name but still substitute placeholders.
await context.substitutePlaceholdersIn('requirements.txt');
break;
case 'java':
// We can't call this file 'pom.template.xml'... for the same reason as Python above.
await context.substitutePlaceholdersIn('pom.xml');
break;
case 'javascript':
case 'typescript':
// See above, but for 'package.json'.
await context.substitutePlaceholdersIn('package.json');
}
}
async function dotnetAddProject(ioHelper, targetDirectory, context, ext = 'csproj') {
const pname = context.placeholder('name.PascalCased');
const slnPath = path.join(targetDirectory, 'src', `${pname}.sln`);
const csprojPath = path.join(targetDirectory, 'src', pname, `${pname}.${ext}`);
// We retry this command a couple of times. It usually never fails, except on CI where
// we sometimes see:
//
// System.IO.IOException: The system cannot open the device or file specified. : 'NuGet-Migrations'
//
// This error can be caused by lack of permissions on a temporary directory,
// but in our case it's intermittent so my guess is it is caused by multiple
// invocations of the .NET CLI running in parallel, and trampling on each
// other creating a Mutex. There is no fix, and it is annoyingly breaking our
// CI regularly. Retry a couple of times to increase reliability.
//
// - https://github.com/dotnet/sdk/issues/43750
// - https://github.com/dotnet/runtime/issues/80619
// - https://github.com/dotnet/runtime/issues/91987
const MAX_ATTEMPTS = 3;
for (let attempt = 1;; attempt++) {
try {
await (0, os_1.shell)(ioHelper, ['dotnet', 'sln', slnPath, 'add', csprojPath]);
return;
}
catch (e) {
if (attempt === MAX_ATTEMPTS) {
throw new toolkit_lib_1.ToolkitError(`Could not add project ${pname}.${ext} to solution ${pname}.sln. ${(0, util_1.formatErrorMessage)(e)}`);
}
// Sleep for a bit then try again
await new Promise(resolve => setTimeout(resolve, 1000));
}
}
}
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"init-hooks.js","sourceRoot":"","sources":["init-hooks.ts"],"names":[],"mappings":";;AAkDA,gDA8BC;AAhFD,6BAA6B;AAC7B,sDAAoD;AACpD,6BAA6B;AAE7B,qCAAgD;AA6BhD;;;;;;;;;;;;;;;;GAgBG;AACI,KAAK,UAAU,kBAAkB,CAAC,QAAkB,EAAE,MAAkB,EAAE,OAAoB;IACnG,QAAQ,MAAM,CAAC,QAAQ,EAAE,CAAC;QACxB,KAAK,QAAQ;YACX,IAAI,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC;gBACxD,OAAO,gBAAgB,CAAC,QAAQ,EAAE,MAAM,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;YACrE,CAAC;YACD,MAAM;QAER,KAAK,QAAQ;YACX,IAAI,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC;gBACxD,OAAO,gBAAgB,CAAC,QAAQ,EAAE,MAAM,CAAC,eAAe,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;YAC/E,CAAC;YACD,MAAM;QAER,KAAK,QAAQ;YACX,sGAAsG;YACtG,sEAAsE;YACtE,MAAM,OAAO,CAAC,wBAAwB,CAAC,kBAAkB,CAAC,CAAC;YAC3D,MAAM;QAER,KAAK,MAAM;YACT,qFAAqF;YACrF,MAAM,OAAO,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC;YAClD,MAAM;QAER,KAAK,YAAY,CAAC;QAClB,KAAK,YAAY;YACf,qCAAqC;YACrC,MAAM,OAAO,CAAC,wBAAwB,CAAC,cAAc,CAAC,CAAC;IAC3D,CAAC;AACH,CAAC;AAED,KAAK,UAAU,gBAAgB,CAAC,QAAkB,EAAE,eAAuB,EAAE,OAAoB,EAAE,GAAG,GAAG,QAAQ;IAC/G,MAAM,KAAK,GAAG,OAAO,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAAC;IACtD,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,KAAK,EAAE,GAAG,KAAK,MAAM,CAAC,CAAC;IAClE,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,KAAK,IAAI,GAAG,EAAE,CAAC,CAAC;IAE/E,sFAAsF;IACtF,oBAAoB;IACpB,EAAE;IACF,qGAAqG;IACrG,EAAE;IACF,4EAA4E;IAC5E,4EAA4E;IAC5E,yEAAyE;IACzE,6EAA6E;IAC7E,iEAAiE;IACjE,EAAE;IACF,+CAA+C;IAC/C,mDAAmD;IACnD,mDAAmD;IACnD,MAAM,YAAY,GAAG,CAAC,CAAC;IACvB,KAAK,IAAI,OAAO,GAAG,CAAC,GAAI,OAAO,EAAE,EAAE,CAAC;QAClC,IAAI,CAAC;YACH,MAAM,IAAA,UAAK,EAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC;YACrE,OAAO;QACT,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,IAAI,OAAO,KAAK,YAAY,EAAE,CAAC;gBAC7B,MAAM,IAAI,0BAAY,CAAC,yBAAyB,KAAK,IAAI,GAAG,gBAAgB,KAAK,SAAS,IAAA,yBAAkB,EAAC,CAAC,CAAC,EAAE,CAAC,CAAC;YACrH,CAAC;YAED,iCAAiC;YACjC,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC;QAC1D,CAAC;IACH,CAAC;AACH,CAAC","sourcesContent":["import * as path from 'path';\nimport { ToolkitError } from '@aws-cdk/toolkit-lib';\nimport { shell } from './os';\nimport type { IoHelper } from '../../api-private';\nimport { formatErrorMessage } from '../../util';\n\nexport type SubstitutePlaceholders = (...fileNames: string[]) => Promise<void>;\n\n/**\n * Helpers passed to hook functions\n */\nexport interface HookContext {\n  /**\n   * Callback function to replace placeholders on arbitrary files\n   *\n   * This makes token substitution available to non-`.template` files.\n   */\n  readonly substitutePlaceholdersIn: SubstitutePlaceholders;\n\n  /**\n   * Return a single placeholder\n   */\n  placeholder(name: string): string;\n}\n\nexport type InvokeHook = (targetDirectory: string, context: HookContext) => Promise<void>;\n\nexport interface HookTarget {\n  readonly targetDirectory: string;\n  readonly templateName: string;\n  readonly language: string;\n}\n\n/**\n * Invoke hooks for the given init template\n *\n * Sometimes templates need more complex logic than just replacing tokens. A 'hook' can be\n * used to do additional processing other than copying files.\n *\n * Hooks used to be defined externally to the CLI, by running arbitrarily\n * substituted shell scripts in the target directory.\n *\n * In practice, they're all TypeScript files and all the same, and the dynamism\n * that the original solution allowed wasn't used at all. Worse, since the CLI\n * is now bundled the hooks can't even reuse code from the CLI libraries at all\n * anymore, so all shared code would have to be copy/pasted.\n *\n * Bundle hooks as built-ins into the CLI, so they get bundled and can take advantage\n * of all shared code.\n */\nexport async function invokeBuiltinHooks(ioHelper: IoHelper, target: HookTarget, context: HookContext) {\n  switch (target.language) {\n    case 'csharp':\n      if (['app', 'sample-app'].includes(target.templateName)) {\n        return dotnetAddProject(ioHelper, target.targetDirectory, context);\n      }\n      break;\n\n    case 'fsharp':\n      if (['app', 'sample-app'].includes(target.templateName)) {\n        return dotnetAddProject(ioHelper, target.targetDirectory, context, 'fsproj');\n      }\n      break;\n\n    case 'python':\n      // We can't call this file 'requirements.template.txt' because Dependabot needs to be able to find it.\n      // Therefore, keep the in-repo name but still substitute placeholders.\n      await context.substitutePlaceholdersIn('requirements.txt');\n      break;\n\n    case 'java':\n      // We can't call this file 'pom.template.xml'... for the same reason as Python above.\n      await context.substitutePlaceholdersIn('pom.xml');\n      break;\n\n    case 'javascript':\n    case 'typescript':\n      // See above, but for 'package.json'.\n      await context.substitutePlaceholdersIn('package.json');\n  }\n}\n\nasync function dotnetAddProject(ioHelper: IoHelper, targetDirectory: string, context: HookContext, ext = 'csproj') {\n  const pname = context.placeholder('name.PascalCased');\n  const slnPath = path.join(targetDirectory, 'src', `${pname}.sln`);\n  const csprojPath = path.join(targetDirectory, 'src', pname, `${pname}.${ext}`);\n\n  // We retry this command a couple of times. It usually never fails, except on CI where\n  // we sometimes see:\n  //\n  //   System.IO.IOException: The system cannot open the device or file specified. : 'NuGet-Migrations'\n  //\n  // This error can be caused by lack of permissions on a temporary directory,\n  // but in our case it's intermittent so my guess is it is caused by multiple\n  // invocations of the .NET CLI running in parallel, and trampling on each\n  // other creating a Mutex. There is no fix, and it is annoyingly breaking our\n  // CI regularly. Retry a couple of times to increase reliability.\n  //\n  // - https://github.com/dotnet/sdk/issues/43750\n  // - https://github.com/dotnet/runtime/issues/80619\n  // - https://github.com/dotnet/runtime/issues/91987\n  const MAX_ATTEMPTS = 3;\n  for (let attempt = 1; ; attempt++) {\n    try {\n      await shell(ioHelper, ['dotnet', 'sln', slnPath, 'add', csprojPath]);\n      return;\n    } catch (e: any) {\n      if (attempt === MAX_ATTEMPTS) {\n        throw new ToolkitError(`Could not add project ${pname}.${ext} to solution ${pname}.sln. ${formatErrorMessage(e)}`);\n      }\n\n      // Sleep for a bit then try again\n      await new Promise(resolve => setTimeout(resolve, 1000));\n    }\n  }\n}\n"]}