@lage-run/scheduler 1.2.7 → 1.2.9

package/CHANGELOG.json

@@ -2,7 +2,55 @@
   "name": "@lage-run/scheduler",
   "entries": [
     {
-      "date": "Tue, 25 Jun 2024 22:03:26 GMT",
+      "date": "Fri, 30 Aug 2024 18:39:54 GMT",
+      "version": "1.2.9",
+      "tag": "@lage-run/scheduler_v1.2.9",
+      "comments": {
+        "patch": [
+          {
+            "author": "beachball",
+            "package": "@lage-run/scheduler",
+            "comment": "Bump @lage-run/hasher to v1.3.0",
+            "commit": "not available"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Wed, 28 Aug 2024 21:12:45 GMT",
+      "version": "1.2.8",
+      "tag": "@lage-run/scheduler_v1.2.8",
+      "comments": {
+        "patch": [
+          {
+            "author": "kchau@microsoft.com",
+            "package": "@lage-run/scheduler",
+            "commit": "8b27a04b8d5916457d1c8219edd1f2d216543954",
+            "comment": "moving runners to its own package, fixing up imports"
+          },
+          {
+            "author": "beachball",
+            "package": "@lage-run/scheduler",
+            "comment": "Bump @lage-run/config to v0.3.7",
+            "commit": "not available"
+          },
+          {
+            "author": "beachball",
+            "package": "@lage-run/scheduler",
+            "comment": "Bump @lage-run/runners to v1.0.1",
+            "commit": "not available"
+          },
+          {
+            "author": "beachball",
+            "package": "@lage-run/scheduler",
+            "comment": "Bump @lage-run/scheduler-types to v0.3.14",
+            "commit": "not available"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Tue, 25 Jun 2024 22:03:40 GMT",
       "version": "1.2.7",
       "tag": "@lage-run/scheduler_v1.2.7",
       "comments": {

package/CHANGELOG.md

@@ -1,12 +1,31 @@
 # Change Log - @lage-run/scheduler
 
-This log was last generated on Tue, 25 Jun 2024 22:03:26 GMT and should not be manually modified.
+This log was last generated on Fri, 30 Aug 2024 18:39:54 GMT and should not be manually modified.
 
 <!-- Start content -->
 
+## 1.2.9
+
+Fri, 30 Aug 2024 18:39:54 GMT
+
+### Patches
+
+- Bump @lage-run/hasher to v1.3.0
+
+## 1.2.8
+
+Wed, 28 Aug 2024 21:12:45 GMT
+
+### Patches
+
+- moving runners to its own package, fixing up imports (kchau@microsoft.com)
+- Bump @lage-run/config to v0.3.7
+- Bump @lage-run/runners to v1.0.1
+- Bump @lage-run/scheduler-types to v0.3.14
+
 ## 1.2.7
 
-Tue, 25 Jun 2024 22:03:26 GMT
+Tue, 25 Jun 2024 22:03:40 GMT
 
 ### Patches
 

package/lib/SimpleScheduler.d.ts

@@ -2,13 +2,13 @@
 /// <reference types="node" />
 /// <reference types="global" />
 import { WrappedTarget } from "./WrappedTarget.js";
-import { TargetRunnerPicker } from "./runners/TargetRunnerPicker.js";
+import { TargetRunnerPicker } from "@lage-run/runners";
 import type { WorkerResult } from "./WrappedTarget.js";
 import type { Logger } from "@lage-run/logger";
 import type { TargetGraph } from "@lage-run/target-graph";
 import type { TargetScheduler, SchedulerRunSummary } from "@lage-run/scheduler-types";
 import type { Pool } from "@lage-run/worker-threads-pool";
-import type { TargetRunnerPickerOptions } from "@lage-run/scheduler-types";
+import type { TargetRunnerPickerOptions } from "@lage-run/runners";
 import type { TargetHasher } from "@lage-run/hasher";
 import type { CacheOptions } from "@lage-run/cache";
 import type { MessagePort } from "worker_threads";

package/lib/SimpleScheduler.js

@@ -13,7 +13,7 @@ const _formatBytes = require("./formatBytes.js");
 const _categorizeTargetRuns = require("./categorizeTargetRuns.js");
 const _targetgraph = require("@lage-run/target-graph");
 const _WrappedTarget = require("./WrappedTarget.js");
-const _TargetRunnerPicker = require("./runners/TargetRunnerPicker.js");
+const _runners = require("@lage-run/runners");
 function _check_private_redeclaration(obj, privateCollection) {
     if (privateCollection.has(obj)) {
         throw new TypeError("Cannot initialize the same private elements twice on an object");
@@ -251,7 +251,7 @@ class SimpleScheduler {
             },
             workerIdleMemoryLimit: options.workerIdleMemoryLimit
         });
-        this.runnerPicker = new _TargetRunnerPicker.TargetRunnerPicker(options.workerData.runners);
+        this.runnerPicker = new _runners.TargetRunnerPicker(options.workerData.runners);
     }
 }
 async function generateTargetRunPromise(target) {

package/lib/index.d.ts

@@ -1,5 +1 @@
-export { NpmScriptRunner } from "./runners/NpmScriptRunner.js";
 export { SimpleScheduler } from "./SimpleScheduler.js";
-export { TargetRunnerPicker } from "./runners/TargetRunnerPicker.js";
-export { WorkerRunner } from "./runners/WorkerRunner.js";
-export { NoOpRunner } from "./runners/NoOpRunner.js";

package/lib/index.js

@@ -2,31 +2,10 @@
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
-function _export(target, all) {
-    for(var name in all)Object.defineProperty(target, name, {
-        enumerable: true,
-        get: all[name]
-    });
-}
-_export(exports, {
-    NpmScriptRunner: function() {
-        return _NpmScriptRunner.NpmScriptRunner;
-    },
-    SimpleScheduler: function() {
+Object.defineProperty(exports, "SimpleScheduler", {
+    enumerable: true,
+    get: function() {
         return _SimpleScheduler.SimpleScheduler;
-    },
-    TargetRunnerPicker: function() {
-        return _TargetRunnerPicker.TargetRunnerPicker;
-    },
-    WorkerRunner: function() {
-        return _WorkerRunner.WorkerRunner;
-    },
-    NoOpRunner: function() {
-        return _NoOpRunner.NoOpRunner;
     }
 });
-const _NpmScriptRunner = require("./runners/NpmScriptRunner.js");
 const _SimpleScheduler = require("./SimpleScheduler.js");
-const _TargetRunnerPicker = require("./runners/TargetRunnerPicker.js");
-const _WorkerRunner = require("./runners/WorkerRunner.js");
-const _NoOpRunner = require("./runners/NoOpRunner.js");

package/lib/workers/targetWorker.js

@@ -4,7 +4,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 const _createCacheProvider = require("../cache/createCacheProvider.js");
 const _workerthreadspool = require("@lage-run/worker-threads-pool");
-const _TargetRunnerPicker = require("../runners/TargetRunnerPicker.js");
+const _runners = require("@lage-run/runners");
 const _worker_threads = require("worker_threads");
 const _logger = /*#__PURE__*/ _interop_require_default(require("@lage-run/logger"));
 function _interop_require_default(obj) {
@@ -31,7 +31,7 @@ async function setup(options) {
         cliArgs: options.taskArgs,
         skipLocalCache: options.skipLocalCache
     });
-    const runnerPicker = new _TargetRunnerPicker.TargetRunnerPicker(runners);
+    const runnerPicker = new _runners.TargetRunnerPicker(runners);
     return {
         options,
         runnerPicker,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lage-run/scheduler",
-  "version": "1.2.7",
+  "version": "1.2.9",
   "description": "Scheduler for Lage",
   "repository": {
     "type": "git",
@@ -20,12 +20,13 @@
     "@lage-run/target-graph": "^0.8.9",
     "@lage-run/logger": "^1.3.0",
     "@lage-run/cache": "^1.3.1",
-    "@lage-run/config": "^0.3.6",
-    "@lage-run/hasher": "^1.2.1",
+    "@lage-run/config": "^0.3.7",
+    "@lage-run/hasher": "^1.3.0",
+    "@lage-run/runners": "^1.0.1",
     "@lage-run/worker-threads-pool": "^0.8.0"
   },
   "devDependencies": {
-    "@lage-run/scheduler-types": "^0.3.13",
+    "@lage-run/scheduler-types": "^0.3.14",
     "@lage-run/monorepo-scripts": "*"
   },
   "publishConfig": {

package/lib/runners/NoOpRunner.d.ts

@@ -1,5 +0,0 @@
-import type { TargetRunner } from "@lage-run/scheduler-types";
-export declare class NoOpRunner implements TargetRunner {
-    shouldRun(): Promise<boolean>;
-    run(): Promise<void>;
-}

package/lib/runners/NoOpRunner.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "NoOpRunner", {
-    enumerable: true,
-    get: function() {
-        return NoOpRunner;
-    }
-});
-class NoOpRunner {
-    async shouldRun() {
-        return true;
-    }
-    async run() {
-    // pass
-    }
-}

package/lib/runners/NpmScriptRunner.d.ts

@@ -1,34 +0,0 @@
-import type { TargetRunner, TargetRunnerOptions } from "@lage-run/scheduler-types";
-import type { Target } from "@lage-run/target-graph";
-export interface NpmScriptRunnerOptions {
-    taskArgs: string[];
-    nodeOptions: string;
-    npmCmd: string;
-}
-/**
- * Runs a npm script on a target.
- *
- * Requires target to have a packageName, and a task.
- *
- * This class deals with these concepts:
- *
- * 1. Spawning the npm client.
- * 2. Generates npm command line arguments
- * 3. Handling exit & error events from child process.
- * 4. Stream stdout & stderr from child process to a logger.
- * 5. Handling the abort controller signal - kills the child process if started.
- * 6. injecting these environment variables into the child process:
- *    - LAGE_PACKAGE_NAME - the name of the package
- *    - LAGE_TASK - the name of the task
- *    - NODE_OPTIONS - the node options to use when spawning the child process
- *    - FORCE_COLOR - set to "1" detect that this is a TTY
- */
-export declare class NpmScriptRunner implements TargetRunner {
-    private options;
-    static gracefulKillTimeout: number;
-    constructor(options: NpmScriptRunnerOptions);
-    private getNpmArgs;
-    private hasNpmScript;
-    shouldRun(target: Target): Promise<boolean>;
-    run(runOptions: TargetRunnerOptions): Promise<void>;
-}

package/lib/runners/NpmScriptRunner.js

@@ -1,145 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "NpmScriptRunner", {
-    enumerable: true,
-    get: function() {
-        return NpmScriptRunner;
-    }
-});
-const _path = require("path");
-const _promises = require("fs/promises");
-const _child_process = require("child_process");
-function _define_property(obj, key, value) {
-    if (key in obj) {
-        Object.defineProperty(obj, key, {
-            value: value,
-            enumerable: true,
-            configurable: true,
-            writable: true
-        });
-    } else {
-        obj[key] = value;
-    }
-    return obj;
-}
-class NpmScriptRunner {
-    getNpmArgs(task, taskTargs) {
-        const extraArgs = taskTargs.length > 0 ? [
-            "--",
-            ...taskTargs
-        ] : [];
-        return [
-            "run",
-            task,
-            ...extraArgs
-        ];
-    }
-    async hasNpmScript(target) {
-        const task = target.options?.script ?? target.task;
-        const packageJsonPath = (0, _path.join)(target.cwd, "package.json");
-        const packageJson = JSON.parse(await (0, _promises.readFile)(packageJsonPath, "utf8"));
-        return !!packageJson.scripts?.[task];
-    }
-    async shouldRun(target) {
-        // By convention, do not run anything if there is no script for this task defined in package.json (counts as "success")
-        return await this.hasNpmScript(target);
-    }
-    async run(runOptions) {
-        const { target , weight , abortSignal  } = runOptions;
-        const { nodeOptions , npmCmd , taskArgs  } = this.options;
-        const task = target.options?.script ?? target.task;
-        let childProcess;
-        /**
-     * Handling abort signal from the abort controller. Gracefully kills the process,
-     * will be handled by exit handler separately to resolve the promise.
-     */ if (abortSignal) {
-            if (abortSignal.aborted) {
-                return;
-            }
-            const abortSignalHandler = ()=>{
-                abortSignal.removeEventListener("abort", abortSignalHandler);
-                if (childProcess && !childProcess.killed) {
-                    const pid = childProcess.pid;
-                    process.stdout.write(`Abort signal detected, attempting to killing process id ${pid}\n`);
-                    childProcess.kill("SIGTERM");
-                    // wait for "gracefulKillTimeout" to make sure everything is terminated via SIGKILL
-                    const t = setTimeout(()=>{
-                        if (childProcess && !childProcess.killed) {
-                            childProcess.kill("SIGKILL");
-                        }
-                    }, NpmScriptRunner.gracefulKillTimeout);
-                    // Remember that even this timeout needs to be unref'ed, otherwise the process will hang due to this timeout
-                    if (t.unref) {
-                        t.unref();
-                    }
-                }
-            };
-            abortSignal.addEventListener("abort", abortSignalHandler);
-        }
-        /**
-     * Actually spawn the npm client to run the task
-     */ const npmRunArgs = this.getNpmArgs(task, taskArgs);
-        const npmRunNodeOptions = [
-            nodeOptions,
-            target.options?.nodeOptions
-        ].filter((str)=>str).join(" ");
-        await new Promise((resolve, reject)=>{
-            childProcess = (0, _child_process.spawn)(npmCmd, npmRunArgs, {
-                cwd: target.cwd,
-                stdio: [
-                    "inherit",
-                    "pipe",
-                    "pipe"
-                ],
-                // This is required for Windows due to https://nodejs.org/en/blog/vulnerability/april-2024-security-releases-2
-                shell: true,
-                env: {
-                    ...process.stdout.isTTY && {
-                        FORCE_COLOR: "1"
-                    },
-                    ...process.env,
-                    ...npmRunNodeOptions && {
-                        NODE_OPTIONS: npmRunNodeOptions
-                    },
-                    LAGE_PACKAGE_NAME: target.packageName,
-                    LAGE_TASK: target.task,
-                    LAGE_WEIGHT: String(weight)
-                }
-            });
-            let exitHandled = false;
-            const handleChildProcessExit = (code)=>{
-                childProcess?.off("exit", handleChildProcessExit);
-                childProcess?.off("error", handleChildProcessExit);
-                if (exitHandled) {
-                    return;
-                }
-                exitHandled = true;
-                childProcess?.stdout?.destroy();
-                childProcess?.stderr?.destroy();
-                childProcess?.stdin?.destroy();
-                if (code === 0) {
-                    return resolve();
-                }
-                reject(new Error(`NPM Script Runner: ${npmCmd} ${npmRunArgs.join(" ")} exited with code ${code}`));
-            };
-            const { pid  } = childProcess;
-            process.stdout.write(`Running ${[
-                npmCmd,
-                ...npmRunArgs
-            ].join(" ")}, pid: ${pid}\n`);
-            const stdout = childProcess.stdout;
-            const stderr = childProcess.stderr;
-            stdout.pipe(process.stdout);
-            stderr.pipe(process.stderr);
-            childProcess.on("exit", handleChildProcessExit);
-            childProcess.on("error", ()=>handleChildProcessExit(1));
-        });
-    }
-    constructor(options){
-        _define_property(this, "options", void 0);
-        this.options = options;
-    }
-}
-_define_property(NpmScriptRunner, "gracefulKillTimeout", 2500);

package/lib/runners/TargetRunnerPicker.d.ts

@@ -1,7 +0,0 @@
-import type { Target } from "@lage-run/target-graph";
-import type { TargetRunner, TargetRunnerPickerOptions } from "@lage-run/scheduler-types";
-export declare class TargetRunnerPicker {
-    private options;
-    constructor(options: TargetRunnerPickerOptions);
-    pick(target: Target): Promise<TargetRunner>;
-}

package/lib/runners/TargetRunnerPicker.js

@@ -1,59 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "TargetRunnerPicker", {
-    enumerable: true,
-    get: function() {
-        return TargetRunnerPicker;
-    }
-});
-const _path = /*#__PURE__*/ _interop_require_default(require("path"));
-const _targetgraph = require("@lage-run/target-graph");
-const _url = require("url");
-function _define_property(obj, key, value) {
-    if (key in obj) {
-        Object.defineProperty(obj, key, {
-            value: value,
-            enumerable: true,
-            configurable: true,
-            writable: true
-        });
-    } else {
-        obj[key] = value;
-    }
-    return obj;
-}
-function _interop_require_default(obj) {
-    return obj && obj.__esModule ? obj : {
-        default: obj
-    };
-}
-class TargetRunnerPicker {
-    async pick(target) {
-        if (target.id === (0, _targetgraph.getStartTargetId)()) {
-            return new (await import("./NoOpRunner.js")).NoOpRunner();
-        }
-        if (!target.type) {
-            target.type = "npmScript";
-        }
-        if (this.options[target.type]) {
-            const config = this.options[target.type];
-            const { script , options  } = config;
-            let importScript = script;
-            if (!importScript.startsWith("file://")) {
-                importScript = (0, _url.pathToFileURL)(importScript).toString();
-            }
-            const runnerModule = await import(importScript);
-            const base = _path.default.basename(script);
-            const runnerName = base.replace(_path.default.extname(base), "");
-            const runner = typeof runnerModule[runnerName] === "function" ? runnerModule[runnerName] : typeof runnerModule.default === "function" ? runnerModule.default : typeof runnerModule.default[runnerName] === "function" ? runnerModule.default[runnerName] : runnerModule;
-            return new runner(options);
-        }
-        throw new Error(`No runner found for target ${target.id}`);
-    }
-    constructor(options){
-        _define_property(this, "options", void 0);
-        this.options = options;
-    }
-}

package/lib/runners/WorkerRunner.d.ts

@@ -1,48 +0,0 @@
-import type { TargetRunner, TargetRunnerOptions } from "@lage-run/scheduler-types";
-import type { Target } from "@lage-run/target-graph";
-export interface WorkerRunnerOptions {
-    taskArgs: string[];
-}
-/**
- * Creates a workerpool per target task definition of "type: worker"
- *
- * Target options are fed into `workerpool`, so target can customize the pool:
- *
- * https://www.npmjs.com/package/workerpool
- *
- * Example:
- *
- * ```ts
- * // lage.config.js
- * {
- *   pipeline: {
- *     "lint": {
- *       type: "worker",
- *       options: {
- *         worker: "workers/lint.js",
- *         maxWorkers: 15
- *       }
- *     }
- *   }
- * }
- * ```
- *
- * ```js
- * // worker.js
- * module.exports = async function lint({ target, abortSignal }) {
- *  if (abortSignal.aborted) {
- *    return;
- *  }
- *
- *  // Do work here - but be sure to have a way to abort via the `abortSignal`
- * }
- * ```
- */
-export declare class WorkerRunner implements TargetRunner {
-    private options;
-    static gracefulKillTimeout: number;
-    constructor(options: WorkerRunnerOptions);
-    shouldRun(target: Target): Promise<boolean>;
-    run(runOptions: TargetRunnerOptions): Promise<any>;
-    getScriptModule(target: Target): Promise<any>;
-}

package/lib/runners/WorkerRunner.js

@@ -1,64 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "WorkerRunner", {
-    enumerable: true,
-    get: function() {
-        return WorkerRunner;
-    }
-});
-const _url = require("url");
-function _define_property(obj, key, value) {
-    if (key in obj) {
-        Object.defineProperty(obj, key, {
-            value: value,
-            enumerable: true,
-            configurable: true,
-            writable: true
-        });
-    } else {
-        obj[key] = value;
-    }
-    return obj;
-}
-class WorkerRunner {
-    async shouldRun(target) {
-        const scriptModule = await this.getScriptModule(target);
-        if (typeof scriptModule.shouldRun === "function") {
-            return await scriptModule.shouldRun(target);
-        }
-        return true;
-    }
-    async run(runOptions) {
-        const { target , weight , abortSignal  } = runOptions;
-        const { taskArgs  } = this.options;
-        const scriptModule = await this.getScriptModule(target);
-        const runFn = typeof scriptModule.run === "function" ? scriptModule.run : typeof scriptModule.default === "function" ? scriptModule.default : scriptModule;
-        if (typeof runFn !== "function") {
-            throw new Error("WorkerRunner: worker script must export a function; you likely need to use `module.exports = function() {...}`");
-        }
-        return await runFn({
-            target,
-            weight,
-            taskArgs,
-            abortSignal
-        });
-    }
-    async getScriptModule(target) {
-        const scriptFile = target.options?.worker ?? target.options?.script;
-        if (!scriptFile) {
-            throw new Error('WorkerRunner: "script" configuration is required - e.g. { type: "worker", script: "./worker.js" }');
-        }
-        let importScript = scriptFile;
-        if (!importScript.startsWith("file://")) {
-            importScript = (0, _url.pathToFileURL)(importScript).toString();
-        }
-        return await import(importScript);
-    }
-    constructor(options){
-        _define_property(this, "options", void 0);
-        this.options = options;
-    }
-}
-_define_property(WorkerRunner, "gracefulKillTimeout", 2500);