@lage-run/config 0.9.0 → 0.9.1

package/lib/getMaxWorkersPerTask.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/getMaxWorkersPerTask.ts"],"sourcesContent":["import type { ConfigOptions } from \"./types/ConfigOptions.js\";\n\nexport function getMaxWorkersPerTask(pipelineConfig: ConfigOptions[\"pipeline\"], concurrency: number): Map<string, number> {\n  const maxWorkersPerTask = new Map<string, number>();\n\n  let generalPoolCount = 0;\n  let generatelPoolMaxWorkers = 0;\n\n  let dedicatedPoolCount = 0;\n  let dedicatedPoolMaxWorkers = 0;\n\n  for (const [task, taskConfig] of Object.entries(pipelineConfig)) {\n    if (!Array.isArray(taskConfig) && !task.includes(\"#\")) {\n      const maxWorkerOption: number | undefined =\n        taskConfig.maxWorkers ??\n        // deprecated usage--a \"worker\" target's options should only include WorkerTargetOptions props.\n        taskConfig.options?.maxWorkers;\n\n      if (typeof maxWorkerOption === \"undefined\") {\n        generalPoolCount++;\n        continue;\n      }\n\n      let maxWorkers = 0;\n\n      if (typeof maxWorkerOption !== \"number\") {\n        throw new Error(`Invalid maxWorkers value: ${maxWorkerOption}`);\n      } else {\n        maxWorkers = maxWorkerOption;\n      }\n\n      maxWorkersPerTask.set(task, maxWorkers);\n      dedicatedPoolCount++;\n      dedicatedPoolMaxWorkers += maxWorkers;\n    }\n  }\n\n  if (dedicatedPoolCount > 0 && generalPoolCount > 0) {\n    const avgMaxWorkers = dedicatedPoolMaxWorkers / dedicatedPoolCount;\n    generatelPoolMaxWorkers = Math.max(1, Math.floor(avgMaxWorkers * generalPoolCount));\n  }\n\n  const grandTotal = dedicatedPoolMaxWorkers + generatelPoolMaxWorkers;\n\n  // try to adjust the maxWorkersPerTask to fit the concurrency\n  if (grandTotal > concurrency) {\n    let newTotal = 0;\n    for (const [task, maxWorkers] of maxWorkersPerTask.entries()) {\n      const newMaxWorkers = Math.max(1, Math.floor((maxWorkers / grandTotal) * concurrency));\n      newTotal += newMaxWorkers;\n      maxWorkersPerTask.set(task, newMaxWorkers);\n    }\n\n    if (newTotal > concurrency) {\n      throw new Error(\n        \"Could not adjust maxWorkers per task to fit the concurrency, try reducing the maxWorkers, or increasing the --concurrency CLI argument, or separate the tasks to be run\"\n      );\n    }\n  }\n\n  return maxWorkersPerTask;\n}\n\nexport function getMaxWorkersPerTaskFromOptions(maxWorkersPerTask: string[]): Map<string, number> {\n  return new Map([\n    ...maxWorkersPerTask.map((setting) => {\n      const [task, maxWorkers] = setting.split(/[=:]/);\n      return [task, parseInt(maxWorkers, 10)] as [string, number];\n    }),\n  ]);\n}\n"],"names":["getMaxWorkersPerTask","getMaxWorkersPerTaskFromOptions","pipelineConfig","concurrency","maxWorkersPerTask","Map","generalPoolCount","generatelPoolMaxWorkers","dedicatedPoolCount","dedicatedPoolMaxWorkers","task","taskConfig","Object","entries","Array","isArray","includes","maxWorkerOption","maxWorkers","options","Error","set","avgMaxWorkers","Math","max","floor","grandTotal","newTotal","newMaxWorkers","map","setting","split","parseInt"],"mappings":";;;;;;;;;;;QAEgBA;eAAAA;;QA6DAC;eAAAA;;;AA7DT,SAASD,qBAAqBE,cAAyC,EAAEC,WAAmB;IACjG,MAAMC,oBAAoB,IAAIC;IAE9B,IAAIC,mBAAmB;IACvB,IAAIC,0BAA0B;IAE9B,IAAIC,qBAAqB;IACzB,IAAIC,0BAA0B;IAE9B,KAAK,MAAM,CAACC,MAAMC,WAAW,IAAIC,OAAOC,OAAO,CAACX,gBAAiB;QAC/D,IAAI,CAACY,MAAMC,OAAO,CAACJ,eAAe,CAACD,KAAKM,QAAQ,CAAC,MAAM;YACrD,MAAMC,kBACJN,WAAWO,UAAU,IACrB,+FAA+F;YAC/FP,WAAWQ,OAAO,EAAED;YAEtB,IAAI,OAAOD,oBAAoB,aAAa;gBAC1CX;gBACA;YACF;YAEA,IAAIY,aAAa;YAEjB,IAAI,OAAOD,oBAAoB,UAAU;gBACvC,MAAM,IAAIG,MAAM,CAAC,0BAA0B,EAAEH,iBAAiB;YAChE,OAAO;gBACLC,aAAaD;YACf;YAEAb,kBAAkBiB,GAAG,CAACX,MAAMQ;YAC5BV;YACAC,2BAA2BS;QAC7B;IACF;IAEA,IAAIV,qBAAqB,KAAKF,mBAAmB,GAAG;QAClD,MAAMgB,gBAAgBb,0BAA0BD;QAChDD,0BAA0BgB,KAAKC,GAAG,CAAC,GAAGD,KAAKE,KAAK,CAACH,gBAAgBhB;IACnE;IAEA,MAAMoB,aAAajB,0BAA0BF;IAE7C,6DAA6D;IAC7D,IAAImB,aAAavB,aAAa;QAC5B,IAAIwB,WAAW;QACf,KAAK,MAAM,CAACjB,MAAMQ,WAAW,IAAId,kBAAkBS,OAAO,GAAI;YAC5D,MAAMe,gBAAgBL,KAAKC,GAAG,CAAC,GAAGD,KAAKE,KAAK,CAAC,AAACP,aAAaQ,aAAcvB;YACzEwB,YAAYC;YACZxB,kBAAkBiB,GAAG,CAACX,MAAMkB;QAC9B;QAEA,IAAID,WAAWxB,aAAa;YAC1B,MAAM,IAAIiB,MACR;QAEJ;IACF;IAEA,OAAOhB;AACT;AAEO,SAASH,gCAAgCG,iBAA2B;IACzE,OAAO,IAAIC,IAAI;WACVD,kBAAkByB,GAAG,CAAC,CAACC;YACxB,MAAM,CAACpB,MAAMQ,WAAW,GAAGY,QAAQC,KAAK,CAAC;YACzC,OAAO;gBAACrB;gBAAMsB,SAASd,YAAY;aAAI;QACzC;KACD;AACH"}
+{"version":3,"sources":["../src/getMaxWorkersPerTask.ts"],"sourcesContent":["import type { ConfigOptions } from \"./types/ConfigOptions.js\";\n\nexport function getMaxWorkersPerTask(pipelineConfig: ConfigOptions[\"pipeline\"], concurrency: number): Map<string, number> {\n  const maxWorkersPerTask = new Map<string, number>();\n\n  let generalPoolCount = 0;\n  let generatelPoolMaxWorkers = 0;\n\n  let dedicatedPoolCount = 0;\n  let dedicatedPoolMaxWorkers = 0;\n\n  for (const [task, taskConfig] of Object.entries(pipelineConfig)) {\n    if (!Array.isArray(taskConfig) && !task.includes(\"#\")) {\n      const maxWorkerOption: number | undefined =\n        taskConfig.maxWorkers ??\n        // deprecated usage--a \"worker\" target's options should only include WorkerTargetOptions props.\n        (taskConfig.options?.maxWorkers as number | undefined);\n\n      if (typeof maxWorkerOption === \"undefined\") {\n        generalPoolCount++;\n        continue;\n      }\n\n      let maxWorkers = 0;\n\n      if (typeof maxWorkerOption !== \"number\") {\n        throw new Error(`Invalid maxWorkers value: ${maxWorkerOption}`);\n      } else {\n        maxWorkers = maxWorkerOption;\n      }\n\n      maxWorkersPerTask.set(task, maxWorkers);\n      dedicatedPoolCount++;\n      dedicatedPoolMaxWorkers += maxWorkers;\n    }\n  }\n\n  if (dedicatedPoolCount > 0 && generalPoolCount > 0) {\n    const avgMaxWorkers = dedicatedPoolMaxWorkers / dedicatedPoolCount;\n    generatelPoolMaxWorkers = Math.max(1, Math.floor(avgMaxWorkers * generalPoolCount));\n  }\n\n  const grandTotal = dedicatedPoolMaxWorkers + generatelPoolMaxWorkers;\n\n  // try to adjust the maxWorkersPerTask to fit the concurrency\n  if (grandTotal > concurrency) {\n    let newTotal = 0;\n    for (const [task, maxWorkers] of maxWorkersPerTask.entries()) {\n      const newMaxWorkers = Math.max(1, Math.floor((maxWorkers / grandTotal) * concurrency));\n      newTotal += newMaxWorkers;\n      maxWorkersPerTask.set(task, newMaxWorkers);\n    }\n\n    if (newTotal > concurrency) {\n      throw new Error(\n        \"Could not adjust maxWorkers per task to fit the concurrency, try reducing the maxWorkers, or increasing the --concurrency CLI argument, or separate the tasks to be run\"\n      );\n    }\n  }\n\n  return maxWorkersPerTask;\n}\n\nexport function getMaxWorkersPerTaskFromOptions(maxWorkersPerTask: string[]): Map<string, number> {\n  return new Map([\n    ...maxWorkersPerTask.map((setting) => {\n      const [task, maxWorkers] = setting.split(/[=:]/);\n      return [task, parseInt(maxWorkers, 10)] as [string, number];\n    }),\n  ]);\n}\n"],"names":["getMaxWorkersPerTask","getMaxWorkersPerTaskFromOptions","pipelineConfig","concurrency","maxWorkersPerTask","Map","generalPoolCount","generatelPoolMaxWorkers","dedicatedPoolCount","dedicatedPoolMaxWorkers","task","taskConfig","Object","entries","Array","isArray","includes","maxWorkerOption","maxWorkers","options","Error","set","avgMaxWorkers","Math","max","floor","grandTotal","newTotal","newMaxWorkers","map","setting","split","parseInt"],"mappings":";;;;;;;;;;;QAEgBA;eAAAA;;QA6DAC;eAAAA;;;AA7DT,SAASD,qBAAqBE,cAAyC,EAAEC,WAAmB;IACjG,MAAMC,oBAAoB,IAAIC;IAE9B,IAAIC,mBAAmB;IACvB,IAAIC,0BAA0B;IAE9B,IAAIC,qBAAqB;IACzB,IAAIC,0BAA0B;IAE9B,KAAK,MAAM,CAACC,MAAMC,WAAW,IAAIC,OAAOC,OAAO,CAACX,gBAAiB;QAC/D,IAAI,CAACY,MAAMC,OAAO,CAACJ,eAAe,CAACD,KAAKM,QAAQ,CAAC,MAAM;YACrD,MAAMC,kBACJN,WAAWO,UAAU,IACrB,+FAA+F;YAC9FP,WAAWQ,OAAO,EAAED;YAEvB,IAAI,OAAOD,oBAAoB,aAAa;gBAC1CX;gBACA;YACF;YAEA,IAAIY,aAAa;YAEjB,IAAI,OAAOD,oBAAoB,UAAU;gBACvC,MAAM,IAAIG,MAAM,CAAC,0BAA0B,EAAEH,iBAAiB;YAChE,OAAO;gBACLC,aAAaD;YACf;YAEAb,kBAAkBiB,GAAG,CAACX,MAAMQ;YAC5BV;YACAC,2BAA2BS;QAC7B;IACF;IAEA,IAAIV,qBAAqB,KAAKF,mBAAmB,GAAG;QAClD,MAAMgB,gBAAgBb,0BAA0BD;QAChDD,0BAA0BgB,KAAKC,GAAG,CAAC,GAAGD,KAAKE,KAAK,CAACH,gBAAgBhB;IACnE;IAEA,MAAMoB,aAAajB,0BAA0BF;IAE7C,6DAA6D;IAC7D,IAAImB,aAAavB,aAAa;QAC5B,IAAIwB,WAAW;QACf,KAAK,MAAM,CAACjB,MAAMQ,WAAW,IAAId,kBAAkBS,OAAO,GAAI;YAC5D,MAAMe,gBAAgBL,KAAKC,GAAG,CAAC,GAAGD,KAAKE,KAAK,CAAC,AAACP,aAAaQ,aAAcvB;YACzEwB,YAAYC;YACZxB,kBAAkBiB,GAAG,CAACX,MAAMkB;QAC9B;QAEA,IAAID,WAAWxB,aAAa;YAC1B,MAAM,IAAIiB,MACR;QAEJ;IACF;IAEA,OAAOhB;AACT;AAEO,SAASH,gCAAgCG,iBAA2B;IACzE,OAAO,IAAIC,IAAI;WACVD,kBAAkByB,GAAG,CAAC,CAACC;YACxB,MAAM,CAACpB,MAAMQ,WAAW,GAAGY,QAAQC,KAAK,CAAC;YACzC,OAAO;gBAACrB;gBAAMsB,SAASd,YAAY;aAAI;QACzC;KACD;AACH"}

package/lib/index.d.ts

@@ -7,4 +7,4 @@ export type { ConfigOptions, ConfigFileOptions } from "./types/ConfigOptions.js"
 export type { CacheOptions } from "./types/CacheOptions.js";
 export type { AzureCredentialName } from "./types/CacheOptions.js";
 export type { LoggerOptions } from "./types/LoggerOptions.js";
-export type { Priority } from "./types/Priority.js";
+export { isRunningFromCI } from "./isRunningFromCI.js";

package/lib/index.js

@@ -21,6 +21,9 @@ _export(exports, {
     get getMaxWorkersPerTaskFromOptions () {
         return _getMaxWorkersPerTask.getMaxWorkersPerTaskFromOptions;
     },
+    get isRunningFromCI () {
+        return _isRunningFromCI.isRunningFromCI;
+    },
     get readConfigFile () {
         return _readConfigFile.readConfigFile;
     }
@@ -29,3 +32,4 @@ const _getConfig = require("./getConfig.js");
 const _getConcurrency = require("./getConcurrency.js");
 const _getMaxWorkersPerTask = require("./getMaxWorkersPerTask.js");
 const _readConfigFile = require("./readConfigFile.js");
+const _isRunningFromCI = require("./isRunningFromCI.js");

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["export { getConfig } from \"./getConfig.js\";\nexport { getConcurrency } from \"./getConcurrency.js\";\nexport { getMaxWorkersPerTask, getMaxWorkersPerTaskFromOptions } from \"./getMaxWorkersPerTask.js\";\nexport { readConfigFile } from \"./readConfigFile.js\";\nexport type { PipelineDefinition } from \"./types/PipelineDefinition.js\";\nexport type { ConfigOptions, ConfigFileOptions } from \"./types/ConfigOptions.js\";\nexport type { CacheOptions } from \"./types/CacheOptions.js\";\nexport type { AzureCredentialName } from \"./types/CacheOptions.js\";\nexport type { LoggerOptions } from \"./types/LoggerOptions.js\";\nexport type { Priority } from \"./types/Priority.js\";\n"],"names":["getConcurrency","getConfig","getMaxWorkersPerTask","getMaxWorkersPerTaskFromOptions","readConfigFile"],"mappings":";;;;;;;;;;;QACSA;eAAAA,8BAAc;;QADdC;eAAAA,oBAAS;;QAETC;eAAAA,0CAAoB;;QAAEC;eAAAA,qDAA+B;;QACrDC;eAAAA,8BAAc;;;2BAHG;gCACK;sCACuC;gCACvC"}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["export { getConfig } from \"./getConfig.js\";\nexport { getConcurrency } from \"./getConcurrency.js\";\nexport { getMaxWorkersPerTask, getMaxWorkersPerTaskFromOptions } from \"./getMaxWorkersPerTask.js\";\nexport { readConfigFile } from \"./readConfigFile.js\";\nexport type { PipelineDefinition } from \"./types/PipelineDefinition.js\";\nexport type { ConfigOptions, ConfigFileOptions } from \"./types/ConfigOptions.js\";\nexport type { CacheOptions } from \"./types/CacheOptions.js\";\nexport type { AzureCredentialName } from \"./types/CacheOptions.js\";\nexport type { LoggerOptions } from \"./types/LoggerOptions.js\";\nexport { isRunningFromCI } from \"./isRunningFromCI.js\";\n"],"names":["getConcurrency","getConfig","getMaxWorkersPerTask","getMaxWorkersPerTaskFromOptions","isRunningFromCI","readConfigFile"],"mappings":";;;;;;;;;;;QACSA;eAAAA,8BAAc;;QADdC;eAAAA,oBAAS;;QAETC;eAAAA,0CAAoB;;QAAEC;eAAAA,qDAA+B;;QAOrDC;eAAAA,gCAAe;;QANfC;eAAAA,8BAAc;;;2BAHG;gCACK;sCACuC;gCACvC;iCAMC"}

package/lib/isRunningFromCI.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Detect if we're running in a CI environment:
+ * - `process.env.TF_BUILD` for ADO
+ * - `process.env.CI` for most others
+ * - not running in a test (`process.env.NODE_ENV` is `test` or `process.env.JEST_WORKER_ID` is set)
+ */
+export declare const isRunningFromCI: boolean;

package/lib/isRunningFromCI.js

@@ -0,0 +1,16 @@
+/**
+ * Detect if we're running in a CI environment:
+ * - `process.env.TF_BUILD` for ADO
+ * - `process.env.CI` for most others
+ * - not running in a test (`process.env.NODE_ENV` is `test` or `process.env.JEST_WORKER_ID` is set)
+ */ "use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "isRunningFromCI", {
+    enumerable: true,
+    get: function() {
+        return isRunningFromCI;
+    }
+});
+const isRunningFromCI = process.env.NODE_ENV !== "test" && !process.env.JEST_WORKER_ID && (!!process.env.CI || !!process.env.TF_BUILD);

package/lib/isRunningFromCI.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/isRunningFromCI.ts"],"sourcesContent":["/**\n * Detect if we're running in a CI environment:\n * - `process.env.TF_BUILD` for ADO\n * - `process.env.CI` for most others\n * - not running in a test (`process.env.NODE_ENV` is `test` or `process.env.JEST_WORKER_ID` is set)\n */\nexport const isRunningFromCI: boolean =\n  process.env.NODE_ENV !== \"test\" && !process.env.JEST_WORKER_ID && (!!process.env.CI || !!process.env.TF_BUILD);\n"],"names":["isRunningFromCI","process","env","NODE_ENV","JEST_WORKER_ID","CI","TF_BUILD"],"mappings":"AAAA;;;;;CAKC;;;;+BACYA;;;eAAAA;;;AAAN,MAAMA,kBACXC,QAAQC,GAAG,CAACC,QAAQ,KAAK,UAAU,CAACF,QAAQC,GAAG,CAACE,cAAc,IAAK,CAAA,CAAC,CAACH,QAAQC,GAAG,CAACG,EAAE,IAAI,CAAC,CAACJ,QAAQC,GAAG,CAACI,QAAQ,AAAD"}

package/lib/types/CacheOptions.d.ts

@@ -31,7 +31,7 @@ type ExtendedCacheStorageConfig = Exclude<BackfillCacheOptions["cacheStorageConf
 export type CacheOptions = Omit<BackfillCacheOptions, "cacheStorageConfig"> & {
     /**
      * Use this to specify a remote cache provider such as `'azure-blob'`.
-     * @see https://github.com/microsoft/backfill#configuration
+     * @see https://www.npmjs.com/package/backfill#configuration
      */
     cacheStorageConfig?: ExtendedCacheStorageConfig;
     /**

package/lib/types/ConfigOptions.d.ts

@@ -1,5 +1,5 @@
 import type { CacheOptions } from "./CacheOptions.js";
-import type { Priority } from "./Priority.js";
+import type { Priority } from "@lage-run/target-graph";
 import type { PipelineDefinition } from "./PipelineDefinition.js";
 import type { LoggerOptions } from "./LoggerOptions.js";
 import type { TargetRunnerPickerOptions } from "@lage-run/runners";
@@ -17,7 +17,8 @@ export interface ConfigOptions {
      * - No prefix for dependencies on tasks for the same package.
      * - Prefix with `^` to denote a direct package-topological dependency. (e.g. `^build` means run the `build` task
      *   in topological order by package.)
-     * - Prefix with `^^` to denote a transitive package-topological dependency. (e.g. `^^transpile` means run the `transpile` task for nested dependencies, but *not* for the current package.)
+     * - Prefix with `^^` to denote a transitive package-topological dependency. (e.g. `^^transpile` means run the
+     *   `transpile` task for nested dependencies, but *not* for the current package.)
      * - Use `packageName#taskName` to denote a dependency on a specific package's task: in the example below,
      *   package `foo`'s `build` task depends on package `bar`'s `bundle` task.
      *
@@ -50,8 +51,9 @@ export interface ConfigOptions {
      */
     loggerOptions: LoggerOptions;
     /**
-     * Custom runners for tasks in the pipeline. The key is the task name, and the value is a configuration describing what would be
-     * passed to the runner constructor.
+     * Custom runners for tasks in the pipeline.
+     *
+     * Keys are runner names, to be used as `TargetConfig.type` in the lage config.
      */
     runners: TargetRunnerPickerOptions;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lage-run/config",
-  "version": "0.9.0",
+  "version": "0.9.1",
   "description": "Config management for Lage",
   "repository": {
     "type": "git",
@@ -19,9 +19,9 @@
   },
   "dependencies": {
     "@lage-run/logger": "^1.3.3",
-    "@lage-run/runners": "^1.3.1",
-    "@lage-run/target-graph": "^0.13.0",
-    "backfill-config": "^6.7.1",
+    "@lage-run/runners": "^1.4.0",
+    "@lage-run/target-graph": "^0.14.0",
+    "backfill-config": "^6.7.2",
     "cosmiconfig": "^9.0.1",
     "workspace-tools": "^0.41.0"
   },

package/lib/types/Priority.d.ts

@@ -1,8 +0,0 @@
-export interface Priority {
-    /** package name, as in package.json */
-    package?: string;
-    /** task name, as listed in the `scripts` section of package.json */
-    task: string;
-    /** priority, the higher the more priority; undefined priority means lowest priority*/
-    priority: number;
-}

package/lib/types/Priority.js

@@ -1,4 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});

package/lib/types/Priority.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":[],"names":[],"mappings":""}