skuba 7.4.0 → 7.5.0-timeout-20240210030715

package/lib/cli/lint/internalLints/deleteFiles.js

@@ -41,6 +41,12 @@ const AUTOFIX_DELETE_FILES = [
   "Dockerfile-incunabulum"
 ];
 const deleteFilesLint = async (mode, logger) => {
+  if (mode === "lint") {
+    return {
+      ok: true,
+      fixable: false
+    };
+  }
   const dir = process.cwd();
   const toDelete = (await Promise.all(
     AUTOFIX_DELETE_FILES.map(

package/lib/cli/lint/internalLints/deleteFiles.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../../src/cli/lint/internalLints/deleteFiles.ts"],
-  "sourcesContent": ["import path from 'path';\nimport { inspect } from 'util';\n\nimport { pathExists, rm } from 'fs-extra';\n\nimport type { Logger } from '../../../utils/logging';\nimport { detectPackageManager } from '../../../utils/packageManager';\nimport type { InternalLintResult } from '../internal';\n\nconst AUTOFIX_DELETE_FILES = [\n  // Try to delete this SEEK-Jobs/gutenberg automation file that may have been\n  // accidentally committed in old versions of skuba.\n  'Dockerfile-incunabulum',\n];\n\nexport const deleteFilesLint = async (\n  mode: 'format' | 'lint',\n  logger: Logger,\n): Promise<InternalLintResult> => {\n  const dir = process.cwd();\n\n  const toDelete = (\n    await Promise.all(\n      AUTOFIX_DELETE_FILES.map(\n        async (filename) =>\n          [filename, await pathExists(path.join(dir, filename))] as const,\n      ),\n    )\n  )\n    .filter(([, exists]) => exists)\n    .map(([filename]) => filename);\n\n  if (mode === 'format') {\n    if (toDelete.length === 0) {\n      return { ok: true, fixable: false };\n    }\n\n    try {\n      await Promise.all(\n        toDelete.map((filename) => {\n          logger.warn(`Deleting ${logger.bold(filename)}.`);\n          return rm(path.join(dir, filename), { force: true });\n        }),\n      );\n\n      return {\n        ok: true,\n        fixable: false,\n      };\n    } catch (err) {\n      logger.warn(logger.bold('Failed to delete files.'));\n      logger.subtle(inspect(err));\n\n      return {\n        ok: true, // It's not really a huge deal if we can't delete these files\n        fixable: false,\n      };\n    }\n  }\n\n  if (toDelete.length) {\n    const packageManager = await detectPackageManager();\n\n    logger.warn(\n      `Some files should be deleted. Run ${logger.bold(\n        packageManager.exec,\n        'skuba',\n        'format',\n      )} to delete them. ${logger.dim('delete-files')}`,\n    );\n\n    return {\n      ok: false,\n      fixable: true,\n      annotations: toDelete.map((filename) => ({\n        path: filename,\n        message: 'This file should be deleted.',\n      })),\n    };\n  }\n\n  return {\n    ok: true,\n    fixable: false,\n  };\n};\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,kBAAiB;AACjB,kBAAwB;AAExB,sBAA+B;AAG/B,4BAAqC;AAGrC,MAAM,uBAAuB;AAAA;AAAA;AAAA,EAG3B;AACF;AAEO,MAAM,kBAAkB,OAC7B,MACA,WACgC;AAChC,QAAM,MAAM,QAAQ,IAAI;AAExB,QAAM,YACJ,MAAM,QAAQ;AAAA,IACZ,qBAAqB;AAAA,MACnB,OAAO,aACL,CAAC,UAAU,UAAM,4BAAW,YAAAA,QAAK,KAAK,KAAK,QAAQ,CAAC,CAAC;AAAA,IACzD;AAAA,EACF,GAEC,OAAO,CAAC,CAAC,EAAE,MAAM,MAAM,MAAM,EAC7B,IAAI,CAAC,CAAC,QAAQ,MAAM,QAAQ;AAE/B,MAAI,SAAS,UAAU;AACrB,QAAI,SAAS,WAAW,GAAG;AACzB,aAAO,EAAE,IAAI,MAAM,SAAS,MAAM;AAAA,IACpC;AAEA,QAAI;AACF,YAAM,QAAQ;AAAA,QACZ,SAAS,IAAI,CAAC,aAAa;AACzB,iBAAO,KAAK,YAAY,OAAO,KAAK,QAAQ,CAAC,GAAG;AAChD,qBAAO,oBAAG,YAAAA,QAAK,KAAK,KAAK,QAAQ,GAAG,EAAE,OAAO,KAAK,CAAC;AAAA,QACrD,CAAC;AAAA,MACH;AAEA,aAAO;AAAA,QACL,IAAI;AAAA,QACJ,SAAS;AAAA,MACX;AAAA,IACF,SAAS,KAAK;AACZ,aAAO,KAAK,OAAO,KAAK,yBAAyB,CAAC;AAClD,aAAO,WAAO,qBAAQ,GAAG,CAAC;AAE1B,aAAO;AAAA,QACL,IAAI;AAAA;AAAA,QACJ,SAAS;AAAA,MACX;AAAA,IACF;AAAA,EACF;AAEA,MAAI,SAAS,QAAQ;AACnB,UAAM,iBAAiB,UAAM,4CAAqB;AAElD,WAAO;AAAA,MACL,qCAAqC,OAAO;AAAA,QAC1C,eAAe;AAAA,QACf;AAAA,QACA;AAAA,MACF,CAAC,oBAAoB,OAAO,IAAI,cAAc,CAAC;AAAA,IACjD;AAEA,WAAO;AAAA,MACL,IAAI;AAAA,MACJ,SAAS;AAAA,MACT,aAAa,SAAS,IAAI,CAAC,cAAc;AAAA,QACvC,MAAM;AAAA,QACN,SAAS;AAAA,MACX,EAAE;AAAA,IACJ;AAAA,EACF;AAEA,SAAO;AAAA,IACL,IAAI;AAAA,IACJ,SAAS;AAAA,EACX;AACF;",
+  "sourcesContent": ["import path from 'path';\nimport { inspect } from 'util';\n\nimport { pathExists, rm } from 'fs-extra';\n\nimport type { Logger } from '../../../utils/logging';\nimport { detectPackageManager } from '../../../utils/packageManager';\nimport type { InternalLintResult } from '../internal';\n\nconst AUTOFIX_DELETE_FILES = [\n  // Try to delete this SEEK-Jobs/gutenberg automation file that may have been\n  // accidentally committed in old versions of skuba.\n  'Dockerfile-incunabulum',\n];\n\nexport const deleteFilesLint = async (\n  mode: 'format' | 'lint',\n  logger: Logger,\n): Promise<InternalLintResult> => {\n  if (mode === 'lint') {\n    // Flagging Dockerfile-incunabulum for deletion is breaking gutenberg installs of skuba as it's (typically) not in source control\n    // TODO: Handle this better (only flag for deletion / delete if in source control)\n\n    return {\n      ok: true,\n      fixable: false,\n    };\n  }\n\n  const dir = process.cwd();\n\n  const toDelete = (\n    await Promise.all(\n      AUTOFIX_DELETE_FILES.map(\n        async (filename) =>\n          [filename, await pathExists(path.join(dir, filename))] as const,\n      ),\n    )\n  )\n    .filter(([, exists]) => exists)\n    .map(([filename]) => filename);\n\n  if (mode === 'format') {\n    if (toDelete.length === 0) {\n      return { ok: true, fixable: false };\n    }\n\n    try {\n      await Promise.all(\n        toDelete.map((filename) => {\n          logger.warn(`Deleting ${logger.bold(filename)}.`);\n          return rm(path.join(dir, filename), { force: true });\n        }),\n      );\n\n      return {\n        ok: true,\n        fixable: false,\n      };\n    } catch (err) {\n      logger.warn(logger.bold('Failed to delete files.'));\n      logger.subtle(inspect(err));\n\n      return {\n        ok: true, // It's not really a huge deal if we can't delete these files\n        fixable: false,\n      };\n    }\n  }\n\n  if (toDelete.length) {\n    const packageManager = await detectPackageManager();\n\n    logger.warn(\n      `Some files should be deleted. Run ${logger.bold(\n        packageManager.exec,\n        'skuba',\n        'format',\n      )} to delete them. ${logger.dim('delete-files')}`,\n    );\n\n    return {\n      ok: false,\n      fixable: true,\n      annotations: toDelete.map((filename) => ({\n        path: filename,\n        message: 'This file should be deleted.',\n      })),\n    };\n  }\n\n  return {\n    ok: true,\n    fixable: false,\n  };\n};\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,kBAAiB;AACjB,kBAAwB;AAExB,sBAA+B;AAG/B,4BAAqC;AAGrC,MAAM,uBAAuB;AAAA;AAAA;AAAA,EAG3B;AACF;AAEO,MAAM,kBAAkB,OAC7B,MACA,WACgC;AAChC,MAAI,SAAS,QAAQ;AAInB,WAAO;AAAA,MACL,IAAI;AAAA,MACJ,SAAS;AAAA,IACX;AAAA,EACF;AAEA,QAAM,MAAM,QAAQ,IAAI;AAExB,QAAM,YACJ,MAAM,QAAQ;AAAA,IACZ,qBAAqB;AAAA,MACnB,OAAO,aACL,CAAC,UAAU,UAAM,4BAAW,YAAAA,QAAK,KAAK,KAAK,QAAQ,CAAC,CAAC;AAAA,IACzD;AAAA,EACF,GAEC,OAAO,CAAC,CAAC,EAAE,MAAM,MAAM,MAAM,EAC7B,IAAI,CAAC,CAAC,QAAQ,MAAM,QAAQ;AAE/B,MAAI,SAAS,UAAU;AACrB,QAAI,SAAS,WAAW,GAAG;AACzB,aAAO,EAAE,IAAI,MAAM,SAAS,MAAM;AAAA,IACpC;AAEA,QAAI;AACF,YAAM,QAAQ;AAAA,QACZ,SAAS,IAAI,CAAC,aAAa;AACzB,iBAAO,KAAK,YAAY,OAAO,KAAK,QAAQ,CAAC,GAAG;AAChD,qBAAO,oBAAG,YAAAA,QAAK,KAAK,KAAK,QAAQ,GAAG,EAAE,OAAO,KAAK,CAAC;AAAA,QACrD,CAAC;AAAA,MACH;AAEA,aAAO;AAAA,QACL,IAAI;AAAA,QACJ,SAAS;AAAA,MACX;AAAA,IACF,SAAS,KAAK;AACZ,aAAO,KAAK,OAAO,KAAK,yBAAyB,CAAC;AAClD,aAAO,WAAO,qBAAQ,GAAG,CAAC;AAE1B,aAAO;AAAA,QACL,IAAI;AAAA;AAAA,QACJ,SAAS;AAAA,MACX;AAAA,IACF;AAAA,EACF;AAEA,MAAI,SAAS,QAAQ;AACnB,UAAM,iBAAiB,UAAM,4CAAqB;AAElD,WAAO;AAAA,MACL,qCAAqC,OAAO;AAAA,QAC1C,eAAe;AAAA,QACf;AAAA,QACA;AAAA,MACF,CAAC,oBAAoB,OAAO,IAAI,cAAc,CAAC;AAAA,IACjD;AAEA,WAAO;AAAA,MACL,IAAI;AAAA,MACJ,SAAS;AAAA,MACT,aAAa,SAAS,IAAI,CAAC,cAAc;AAAA,QACvC,MAAM;AAAA,QACN,SAAS;AAAA,MACX,EAAE;AAAA,IACJ;AAAA,EACF;AAEA,SAAO;AAAA,IACL,IAAI;AAAA,IACJ,SAAS;AAAA,EACX;AACF;",
   "names": ["path"]
 }

package/lib/skuba.d.ts

@@ -1,11 +1,2 @@
 #!/usr/bin/env node
-/**
- * Entry point for the CLI.
- *
- * This is where you end up when you run:
- *
- * ```bash
- * [pnpm|yarn] skuba help
- * ```
- */
 export {};

package/lib/skuba.js

@@ -22,16 +22,19 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
   isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
   mod
 ));
+var import_why_is_node_running = __toESM(require("why-is-node-running"));
 var import_path = __toESM(require("path"));
 var import_args = require("./utils/args");
 var import_command = require("./utils/command");
+var import_env = require("./utils/env");
 var import_error = require("./utils/error");
 var import_help = require("./utils/help");
 var import_logging = require("./utils/logging");
 var import_logo = require("./utils/logo");
 var import_validation = require("./utils/validation");
+const THIRTY_MINUTES = 30 * 60 * 1e3;
 const skuba = async () => {
-  const { commandName } = (0, import_args.parseProcessArgs)(process.argv);
+  const { commandName, args } = (0, import_args.parseProcessArgs)(process.argv);
   if (import_command.COMMAND_SET.has(commandName)) {
     const moduleName = (0, import_command.commandToModule)(commandName);
     const commandModule = require(import_path.default.join(import_command.COMMAND_DIR, moduleName));
@@ -41,7 +44,22 @@ const skuba = async () => {
       return;
     }
     const run = commandModule[moduleName];
-    return run();
+    if (!(0, import_env.isCiEnv)() || args.includes("--no-timeout")) {
+      return run();
+    }
+    const timeoutArg = args.find((arg) => arg.startsWith("--timeout-ms="))?.split("=")[1];
+    const timeoutId = setTimeout(
+      () => {
+        import_logging.log.err(
+          import_logging.log.bold(commandName),
+          "timed out. This may indicate a process hanging - please file an issue."
+        );
+        (0, import_why_is_node_running.default)();
+        process.exit(1);
+      },
+      timeoutArg ? parseInt(timeoutArg, 10) : THIRTY_MINUTES
+    );
+    return run().finally(() => clearTimeout(timeoutId));
   }
   import_logging.log.err(import_logging.log.bold(commandName), "is not recognised as a command.");
   await (0, import_logo.showLogoAndVersionInfo)();

package/lib/skuba.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../src/skuba.ts"],
-  "sourcesContent": ["#!/usr/bin/env node\n\n/**\n * Entry point for the CLI.\n *\n * This is where you end up when you run:\n *\n * ```bash\n * [pnpm|yarn] skuba help\n * ```\n */\n\nimport path from 'path';\n\nimport { parseProcessArgs } from './utils/args';\nimport {\n  COMMAND_DIR,\n  COMMAND_SET,\n  type Command,\n  commandToModule,\n} from './utils/command';\nimport { handleCliError } from './utils/error';\nimport { showHelp } from './utils/help';\nimport { log } from './utils/logging';\nimport { showLogoAndVersionInfo } from './utils/logo';\nimport { hasProp } from './utils/validation';\n\nconst skuba = async () => {\n  const { commandName } = parseProcessArgs(process.argv);\n\n  if (COMMAND_SET.has(commandName)) {\n    const moduleName = commandToModule(commandName as Command);\n\n    /* eslint-disable @typescript-eslint/no-var-requires */\n    const commandModule = require(\n      path.join(COMMAND_DIR, moduleName),\n    ) as unknown;\n\n    if (!hasProp(commandModule, moduleName)) {\n      log.err(log.bold(commandName), \"couldn't run! Please submit an issue.\");\n      process.exitCode = 1;\n      return;\n    }\n\n    const run = commandModule[moduleName] as () => Promise<unknown>;\n\n    return run();\n  }\n\n  log.err(log.bold(commandName), 'is not recognised as a command.');\n  await showLogoAndVersionInfo();\n  showHelp();\n\n  process.exitCode = 1;\n  return;\n};\n\nskuba().catch(handleCliError);\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;AAYA,kBAAiB;AAEjB,kBAAiC;AACjC,qBAKO;AACP,mBAA+B;AAC/B,kBAAyB;AACzB,qBAAoB;AACpB,kBAAuC;AACvC,wBAAwB;AAExB,MAAM,QAAQ,YAAY;AACxB,QAAM,EAAE,YAAY,QAAI,8BAAiB,QAAQ,IAAI;AAErD,MAAI,2BAAY,IAAI,WAAW,GAAG;AAChC,UAAM,iBAAa,gCAAgB,WAAsB;AAGzD,UAAM,gBAAgB,QACpB,YAAAA,QAAK,KAAK,4BAAa,UAAU,CACnC;AAEA,QAAI,KAAC,2BAAQ,eAAe,UAAU,GAAG;AACvC,yBAAI,IAAI,mBAAI,KAAK,WAAW,GAAG,uCAAuC;AACtE,cAAQ,WAAW;AACnB;AAAA,IACF;AAEA,UAAM,MAAM,cAAc,UAAU;AAEpC,WAAO,IAAI;AAAA,EACb;AAEA,qBAAI,IAAI,mBAAI,KAAK,WAAW,GAAG,iCAAiC;AAChE,YAAM,oCAAuB;AAC7B,4BAAS;AAET,UAAQ,WAAW;AACnB;AACF;AAEA,MAAM,EAAE,MAAM,2BAAc;",
-  "names": ["path"]
+  "sourcesContent": ["#!/usr/bin/env node\n\n// @ts-expect-error - no types\nimport whyIsNodeRunning from 'why-is-node-running';\n\n/**\n * Entry point for the CLI.\n *\n * This is where you end up when you run:\n *\n * ```bash\n * [pnpm|yarn] skuba help\n * ```\n */\n\n// eslint-disable-next-line import/order -- why-is-node-running must be imported before anything else\nimport path from 'path';\n\nimport { parseProcessArgs } from './utils/args';\nimport {\n  COMMAND_DIR,\n  COMMAND_SET,\n  type Command,\n  commandToModule,\n} from './utils/command';\nimport { isCiEnv } from './utils/env';\nimport { handleCliError } from './utils/error';\nimport { showHelp } from './utils/help';\nimport { log } from './utils/logging';\nimport { showLogoAndVersionInfo } from './utils/logo';\nimport { hasProp } from './utils/validation';\n\nconst THIRTY_MINUTES = 30 * 60 * 1000;\n\nconst skuba = async () => {\n  const { commandName, args } = parseProcessArgs(process.argv);\n\n  if (COMMAND_SET.has(commandName)) {\n    const moduleName = commandToModule(commandName as Command);\n\n    /* eslint-disable @typescript-eslint/no-var-requires */\n    const commandModule = require(\n      path.join(COMMAND_DIR, moduleName),\n    ) as unknown;\n\n    if (!hasProp(commandModule, moduleName)) {\n      log.err(log.bold(commandName), \"couldn't run! Please submit an issue.\");\n      process.exitCode = 1;\n      return;\n    }\n\n    const run = commandModule[moduleName] as () => Promise<unknown>;\n\n    // If we're not in a CI environment, we don't need to worry about timeouts, which are primarily to prevent\n    // builds running \"forever\" in CI without our knowledge.\n    // Local commands may run for a long time, e.g. `skuba node` and `skuba start`, which are unlikely to be used in CI.\n    if (!isCiEnv() || args.includes('--no-timeout')) {\n      return run();\n    }\n\n    const timeoutArg = args\n      .find((arg) => arg.startsWith('--timeout-ms='))\n      ?.split('=')[1];\n\n    const timeoutId = setTimeout(\n      () => {\n        log.err(\n          log.bold(commandName),\n          'timed out. This may indicate a process hanging - please file an issue.',\n        );\n        // eslint-disable-next-line @typescript-eslint/no-unsafe-call\n        whyIsNodeRunning();\n        // Need to force exit because promises may be hanging so node won't exit on its own.\n        process.exit(1);\n      },\n      timeoutArg ? parseInt(timeoutArg, 10) : THIRTY_MINUTES,\n    );\n\n    return run().finally(() => clearTimeout(timeoutId));\n  }\n\n  log.err(log.bold(commandName), 'is not recognised as a command.');\n  await showLogoAndVersionInfo();\n  showHelp();\n\n  process.exitCode = 1;\n  return;\n};\n\nskuba().catch(handleCliError);\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;AAGA,iCAA6B;AAa7B,kBAAiB;AAEjB,kBAAiC;AACjC,qBAKO;AACP,iBAAwB;AACxB,mBAA+B;AAC/B,kBAAyB;AACzB,qBAAoB;AACpB,kBAAuC;AACvC,wBAAwB;AAExB,MAAM,iBAAiB,KAAK,KAAK;AAEjC,MAAM,QAAQ,YAAY;AACxB,QAAM,EAAE,aAAa,KAAK,QAAI,8BAAiB,QAAQ,IAAI;AAE3D,MAAI,2BAAY,IAAI,WAAW,GAAG;AAChC,UAAM,iBAAa,gCAAgB,WAAsB;AAGzD,UAAM,gBAAgB,QACpB,YAAAA,QAAK,KAAK,4BAAa,UAAU,CACnC;AAEA,QAAI,KAAC,2BAAQ,eAAe,UAAU,GAAG;AACvC,yBAAI,IAAI,mBAAI,KAAK,WAAW,GAAG,uCAAuC;AACtE,cAAQ,WAAW;AACnB;AAAA,IACF;AAEA,UAAM,MAAM,cAAc,UAAU;AAKpC,QAAI,KAAC,oBAAQ,KAAK,KAAK,SAAS,cAAc,GAAG;AAC/C,aAAO,IAAI;AAAA,IACb;AAEA,UAAM,aAAa,KAChB,KAAK,CAAC,QAAQ,IAAI,WAAW,eAAe,CAAC,GAC5C,MAAM,GAAG,EAAE,CAAC;AAEhB,UAAM,YAAY;AAAA,MAChB,MAAM;AACJ,2BAAI;AAAA,UACF,mBAAI,KAAK,WAAW;AAAA,UACpB;AAAA,QACF;AAEA,uCAAAC,SAAiB;AAEjB,gBAAQ,KAAK,CAAC;AAAA,MAChB;AAAA,MACA,aAAa,SAAS,YAAY,EAAE,IAAI;AAAA,IAC1C;AAEA,WAAO,IAAI,EAAE,QAAQ,MAAM,aAAa,SAAS,CAAC;AAAA,EACpD;AAEA,qBAAI,IAAI,mBAAI,KAAK,WAAW,GAAG,iCAAiC;AAChE,YAAM,oCAAuB;AAC7B,4BAAS;AAET,UAAQ,WAAW;AACnB;AACF;AAEA,MAAM,EAAE,MAAM,2BAAc;",
+  "names": ["path", "whyIsNodeRunning"]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "skuba",
-  "version": "7.4.0",
+  "version": "7.5.0-timeout-20240210030715",
   "private": false,
   "description": "SEEK development toolkit for backend applications and packages",
   "homepage": "https://github.com/seek-oss/skuba#readme",
@@ -100,6 +100,7 @@
     "tsconfig-seek": "2.0.0",
     "typescript": "~5.3.0",
     "validate-npm-package-name": "^5.0.0",
+    "why-is-node-running": "^2.2.2",
     "zod": "^3.22.4"
   },
   "devDependencies": {