lage 1.1.2 → 1.3.0

package/CHANGELOG.json

@@ -2,7 +2,82 @@
   "name": "lage",
   "entries": [
     {
-      "date": "Wed, 01 Dec 2021 19:18:35 GMT",
+      "date": "Fri, 07 Jan 2022 21:55:13 GMT",
+      "tag": "lage_v1.3.0",
+      "version": "1.3.0",
+      "comments": {
+        "minor": [
+          {
+            "author": "kchau@microsoft.com",
+            "package": "lage",
+            "comment": "speeding up by bumping backfill & workspace-tools. now supports npm 7",
+            "commit": "48de07b8d01b1be7a00b13e0f099231e9cc768c4"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Mon, 03 Jan 2022 23:13:44 GMT",
+      "tag": "lage_v1.2.0",
+      "version": "1.2.0",
+      "comments": {
+        "minor": [
+          {
+            "author": "mhuan13@gmail.com",
+            "package": "lage",
+            "comment": "Allow explicit parralel scheduling of transitive dependencies with ^^ prefix",
+            "commit": "c3c1c7378f5fdc1e77fbe1aad38627d5d23a8d30"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Sat, 04 Dec 2021 00:24:11 GMT",
+      "tag": "lage_v1.1.4",
+      "version": "1.1.4",
+      "comments": {
+        "patch": [
+          {
+            "author": "ken@gizzar.com",
+            "package": "lage",
+            "comment": "fixes the tasks that have the package in its id",
+            "commit": "95affe7fc481d92940dd7b9f11a40051fc320865"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Thu, 02 Dec 2021 22:25:07 GMT",
+      "tag": "lage_v1.1.3",
+      "version": "1.1.3",
+      "comments": {
+        "none": [
+          {
+            "author": "4123478+tido64@users.noreply.github.com",
+            "package": "lage",
+            "comment": "Disable GPG signing in tests to ensure it won't fail",
+            "commit": "8198557e7a36803d736ae3b5c816166389ba30a7"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Thu, 02 Dec 2021 20:21:01 GMT",
+      "tag": "lage_v1.1.3",
+      "version": "1.1.3",
+      "comments": {
+        "patch": [
+          {
+            "author": "elcraig@microsoft.com",
+            "package": "lage",
+            "comment": "Prevent truncation of error summary logs",
+            "commit": "defd554aa2e4a330f865b41b78792a35a831ea64"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Wed, 01 Dec 2021 19:18:41 GMT",
       "tag": "lage_v1.1.2",
       "version": "1.1.2",
       "comments": {

package/CHANGELOG.md

@@ -1,12 +1,44 @@
 # Change Log - lage
 
-This log was last generated on Wed, 01 Dec 2021 19:18:35 GMT and should not be manually modified.
+This log was last generated on Fri, 07 Jan 2022 21:55:13 GMT and should not be manually modified.
 
 <!-- Start content -->
 
+## 1.3.0
+
+Fri, 07 Jan 2022 21:55:13 GMT
+
+### Minor changes
+
+- speeding up by bumping backfill & workspace-tools. now supports npm 7 (kchau@microsoft.com)
+
+## 1.2.0
+
+Mon, 03 Jan 2022 23:13:44 GMT
+
+### Minor changes
+
+- Allow explicit parralel scheduling of transitive dependencies with ^^ prefix (mhuan13@gmail.com)
+
+## 1.1.4
+
+Sat, 04 Dec 2021 00:24:11 GMT
+
+### Patches
+
+- fixes the tasks that have the package in its id (ken@gizzar.com)
+
+## 1.1.3
+
+Thu, 02 Dec 2021 20:21:01 GMT
+
+### Patches
+
+- Prevent truncation of error summary logs (elcraig@microsoft.com)
+
 ## 1.1.2
 
-Wed, 01 Dec 2021 19:18:35 GMT
+Wed, 01 Dec 2021 19:18:41 GMT
 
 ### Patches
 

package/beachball.config.js

@@ -0,0 +1,17 @@
+// @ts-check
+/** @type {import('beachball').BeachballConfig}*/
+module.exports = {
+  ignorePatterns: [
+    '.*ignore',
+    '.github/**',
+    'beachball.config.js',
+    'decks/**',
+    'docs/**',
+    'jasmine.json',
+    'jest.config.js',
+    'renovate.json',
+    'tests/**',
+    // This one is especially important (otherwise dependabot would be blocked by change file requirements)
+    'yarn.lock',
+  ],
+};

package/lib/logger/reporters/NpmLogReporter.js

@@ -158,7 +158,10 @@ class NpmLogReporter {
                 const taskLogs = (_a = targets.get(failedTargetId)) === null || _a === void 0 ? void 0 : _a.logger.getLogs();
                 npmlog_1.default.error("", `[${chalk_1.default.magenta(packageName)} ${chalk_1.default.cyan(task)}] ${chalk_1.default.redBright("ERROR DETECTED")}`);
                 if (taskLogs) {
-                    npmlog_1.default.error("", taskLogs === null || taskLogs === void 0 ? void 0 : taskLogs.map((entry) => entry.msg).join("\n"));
+                    for (const entry of taskLogs) {
+                        // Log each entry separately to prevent truncation
+                        npmlog_1.default.error("", entry.msg);
+                    }
                 }
                 hr();
             }

package/lib/task/Pipeline.d.ts

@@ -14,6 +14,7 @@ export declare const START_TARGET_ID = "__start";
 export declare class Pipeline {
     private workspace;
     private config;
+    private cachedTransitiveTaskDependencies;
     /** Target represent a unit of work and the configuration of how to run it */
     targets: Map<string, PipelineTarget>;
     /** Target dependencies determine the run order of the targets  */
@@ -48,7 +49,7 @@ export declare class Pipeline {
      */
     private generateFactoryTargets;
     /**
-     * Converts target configuration to pipeline target
+     * Converts target configuration to pipeline targets
      * @param id
      * @param target
      */
@@ -63,6 +64,12 @@ export declare class Pipeline {
      * Adds all the target dependencies to the graph
      */
     addDependencies(): void;
+    /**
+     * Gets a list of package names that are direct or indirect dependencies of rootPackageName in this.graph,
+     * and caches them on the Pipeline.
+     * @param packageName the root package to begin walking from
+     */
+    getTransitiveGraphDependencies(packageName: string): Set<string>;
     generateTargetGraph(): [string, string][];
     loadConfig(config: Config): void;
     private getTargetPriority;

package/lib/task/Pipeline.js

@@ -23,6 +23,7 @@ class Pipeline {
     constructor(workspace, config) {
         this.workspace = workspace;
         this.config = config;
+        this.cachedTransitiveTaskDependencies = new Map();
         /** Target represent a unit of work and the configuration of how to run it */
         this.targets = new Map([
             [
@@ -33,6 +34,7 @@ class Pipeline {
                     run: () => { },
                     task: exports.START_TARGET_ID,
                     hidden: true,
+                    cache: false,
                 },
             ],
         ]);
@@ -127,7 +129,7 @@ class Pipeline {
         return Array.isArray(targets) ? targets : [targets];
     }
     /**
-     * Converts target configuration to pipeline target
+     * Converts target configuration to pipeline targets
      * @param id
      * @param target
      */
@@ -138,6 +140,13 @@ class Pipeline {
                 Object.assign(Object.assign({}, target), { id: targetId, cache: target.cache !== false, cwd: this.workspace.root, task: id, run: this.runTask(targetId, this.workspace.root, target.run) || (() => { }) }),
             ];
         }
+        else if (id.includes("#")) {
+            const { packageName: pkg, task } = (0, taskId_1.getPackageAndTask)(id);
+            return [
+                Object.assign(Object.assign({}, target), { id, cache: target.cache !== false, task: id, cwd: path_1.default.dirname(this.packageInfos[pkg].packageJsonPath), packageName: pkg, run: this.runTask(id, path_1.default.dirname(this.packageInfos[pkg].packageJsonPath), target.run) ||
+                        this.maybeRunNpmTask(task, this.packageInfos[pkg]) }),
+            ];
+        }
         else {
             const packages = Object.entries(this.packageInfos);
             return packages.map(([pkg, _info]) => {
@@ -189,6 +198,8 @@ class Pipeline {
              * - for any deps like package#task, we simply add the singular dependency (source could be a single package or all packages)
              * - for anything that starts with a "^", we add the package-tasks according to the topological package graph
              *    NOTE: in a non-strict mode (TODO), the dependencies can come from transitive task dependencies
+             * - for anything that starts with a "^^", we add the package-tasks from the transitive dependencies in the topological
+             *    package graph.
              * - for {"pkgA#task": ["dep"]}, we interpret to add "pkgA#dep"
              * - for anything that is a string without a "^", we treat that string as the name of a task, adding all targets that way
              *    NOTE: in a non-strict mode (TODO), the dependencies can come from transitive task dependencies
@@ -202,11 +213,13 @@ class Pipeline {
                 }
                 else if (dep.startsWith("^") && packageName) {
                     // topo dep -> build: ['^build']
-                    const depTask = dep.substr(1);
+                    const [depTask, dependencySet] = dep.startsWith("^^") ?
+                        [dep.substr(2), [...this.getTransitiveGraphDependencies(packageName)]]
+                        : [dep.substr(1), this.graph[packageName].dependencies];
                     const dependencyIds = targets
                         .filter((needle) => {
                         const { task, packageName: needlePackageName } = needle;
-                        return (task === depTask && this.graph[packageName].dependencies.some((depPkg) => depPkg === needlePackageName));
+                        return (task === depTask && dependencySet.some((depPkg) => depPkg === needlePackageName));
                     })
                         .map((needle) => needle.id);
                     for (const dependencyId of dependencyIds) {
@@ -231,6 +244,44 @@ class Pipeline {
             }
         }
     }
+    /**
+     * Gets a list of package names that are direct or indirect dependencies of rootPackageName in this.graph,
+     * and caches them on the Pipeline.
+     * @param packageName the root package to begin walking from
+     */
+    getTransitiveGraphDependencies(packageName) {
+        var _a, _b;
+        const cachedResult = this.cachedTransitiveTaskDependencies.get(packageName);
+        if (cachedResult) {
+            return (cachedResult === "walk-in-progress")
+                // There is a recursive walk over this set of dependencies in progress.
+                // If we hit this case, that means that a dependency of this package depends on it.
+                //
+                // In this case we return an empty set to omit this package and it's downstream from its
+                // dependency
+                ? new Set()
+                // we already computed this for this package, return the cached result.
+                : cachedResult;
+        }
+        else {
+            // No cached result. Compute now with a recursive walk
+            // mark that we are traversing this package to prevent infinite recursion
+            // in cases of circular dependencies
+            this.cachedTransitiveTaskDependencies.set(packageName, 'walk-in-progress');
+            let immediateDependencies = (_b = (_a = this.graph[packageName]) === null || _a === void 0 ? void 0 : _a.dependencies) !== null && _b !== void 0 ? _b : [];
+            // build the set of transitive dependencies by recursively walking the
+            // immediate dependencies' dependencies.
+            let transitiveDepSet = new Set(immediateDependencies);
+            for (let immediateDependency of immediateDependencies) {
+                for (let transitiveSubDependency of this.getTransitiveGraphDependencies(immediateDependency)) {
+                    transitiveDepSet.add(transitiveSubDependency);
+                }
+            }
+            // Cache the result and return
+            this.cachedTransitiveTaskDependencies.set(packageName, transitiveDepSet);
+            return transitiveDepSet;
+        }
+    }
     generateTargetGraph() {
         const scope = (0, getPipelinePackages_1.getPipelinePackages)(this.workspace, this.config);
         const tasks = this.config.command;

package/lib/task/WrappedTarget.js

@@ -55,7 +55,7 @@ class WrappedTarget {
         let hash = null;
         let cacheHit = false;
         const { target, root, config, cacheOptions } = this;
-        if (config.cache) {
+        if (config.cache && target.cache) {
             hash = await (0, backfill_1.cacheHash)(target.id, target.cwd, root, cacheOptions, config.args);
             if (hash && !config.resetCache) {
                 cacheHit = await (0, backfill_1.cacheFetch)(hash, target.id, target.cwd, cacheOptions);

package/lib/types/ConfigOptions.d.ts

@@ -6,7 +6,8 @@ import { QueueOptions } from "bullmq";
 export declare type NpmClient = "npm" | "yarn" | "pnpm";
 export interface ConfigOptions {
     /**
-     * Defines the task pipeline, prefix with "^" character to denote a topological dependency
+     * Defines the task pipeline, prefix with "^" character to denote a direct topological dependency,
+     * prefix with ^^ to denote a transitive topological dependency.
      *
      * Example:
      *
@@ -15,6 +16,8 @@ export interface ConfigOptions {
      *   build: ["^build"],
      *   test: ["build"],
      *   lint: []
+     *   bundle: ["^^transpile"],
+     *   transpile: [],
      * }
      * ```
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lage",
-  "version": "1.1.2",
+  "version": "1.3.0",
   "description": "A monorepo task runner",
   "repository": {
     "url": "https://github.com/microsoft/lage"
@@ -31,7 +31,7 @@
   },
   "dependencies": {
     "abort-controller": "^3.0.0",
-    "backfill": "^6.1.10",
+    "backfill": "^6.1.11",
     "backfill-cache": "^5.3.0",
     "backfill-config": "^6.2.0",
     "backfill-logger": "^5.1.3",
@@ -46,7 +46,7 @@
     "p-graph": "^1.1.1",
     "p-limit": "^3.1.0",
     "p-profiler": "^0.2.1",
-    "workspace-tools": "^0.16.2",
+    "workspace-tools": "^0.18.2",
     "yargs-parser": "^18.1.3"
   },
   "devDependencies": {