Merge pull request #3866 from iclanton/heft-suppress-browserslist-warning-plugin

Introduce heft-suppress-browserslist-warning-plugin.

Author: iclanton

.github/workflows/ci.yml

@@ -51,17 +51,9 @@ jobs:
 
       - name: Rush retest (install-run-rush)
         run: node common/scripts/install-run-rush.js retest --verbose --production
-        env:
-          # Prevent time-based browserslist update warning
-          # See https://github.com/microsoft/rushstack/issues/2981
-          BROWSERSLIST_IGNORE_OLD_DATA: 1
 
       - name: Ensure repo README is up-to-date
         run: node repo-scripts/repo-toolbox/lib/start.js readme --verify
 
       - name: Rush test (rush-lib)
         run: node apps/rush/lib/start-dev.js test --verbose --production --timeline
-        env:
-          # Prevent time-based browserslist update warning
-          # See https://github.com/microsoft/rushstack/issues/2981
-          BROWSERSLIST_IGNORE_OLD_DATA: 1

apps/heft/heft-plugin.json

@@ -30,6 +30,11 @@
       "pluginName": "run-script-plugin",
       "entryPoint": "./lib/plugins/RunScriptPlugin",
       "optionsSchema": "./lib/schemas/run-script-options.schema.json"
+    },
+    {
+      "entryPoint": "./lib/plugins/SetEnvironmentVariablesPlugin",
+      "pluginName": "set-environment-variables-plugin",
+      "optionsSchema": "./lib/schemas/set-environment-variables-plugin.schema.json"
     }
   ]
 }

apps/heft/src/plugins/SetEnvironmentVariablesPlugin.ts

@@ -0,0 +1,35 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+import type { HeftConfiguration } from '../configuration/HeftConfiguration';
+import type { IHeftTaskSession } from '../pluginFramework/HeftTaskSession';
+import type { IHeftTaskPlugin } from '../pluginFramework/IHeftPlugin';
+
+export const PLUGIN_NAME: string = 'set-environment-variables-plugin';
+
+export interface ISetEnvironmentVariablesPluginOptions {
+  environmentVariablesToSet: Record<string, string>;
+}
+
+export default class SetEnvironmentVariablesPlugin
+  implements IHeftTaskPlugin<ISetEnvironmentVariablesPluginOptions>
+{
+  public apply(
+    taskSession: IHeftTaskSession,
+    heftConfiguration: HeftConfiguration,
+    { environmentVariablesToSet }: ISetEnvironmentVariablesPluginOptions
+  ): void {
+    taskSession.hooks.run.tap(
+      {
+        name: PLUGIN_NAME,
+        stage: Number.MIN_SAFE_INTEGER
+      },
+      () => {
+        for (const [key, value] of Object.entries(environmentVariablesToSet)) {
+          taskSession.logger.terminal.writeLine(`Setting environment variable ${key}=${value}`);
+          process.env[key] = value;
+        }
+      }
+    );
+  }
+}

apps/heft/src/schemas/set-environment-variables-plugin.schema.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "CopyFiles Heft Task Event Options",
+  "description": "Defines configuration used by the \"copyFiles\" Heft task event.",
+  "type": "object",
+
+  "additionalProperties": false,
+  "required": ["environmentVariablesToSet"],
+
+  "properties": {
+    "environmentVariablesToSet": {
+      "type": "object",
+      "pattern": ".+",
+      "additionalProperties": {
+        "type": "string"
+      }
+    }
+  }
+}

apps/heft/src/startWithVersionSelector.ts

@@ -11,8 +11,6 @@ import type { IPackageJson } from '@rushstack/node-core-library';
 import { getToolParameterNamesFromArgs } from './utilities/CliUtilities';
 import { Constants } from './utilities/Constants';
 
-const HEFT_PACKAGE_NAME: string = '@rushstack/heft';
-
 // Excerpted from PackageJsonLookup.tryGetPackageFolderFor()
 function tryGetPackageFolderFor(resolvedFileOrFolderPath: string): string | undefined {
   // Two lookups are required, because get() cannot distinguish the undefined value
@@ -82,16 +80,16 @@ function tryStartLocalHeft(): boolean {
 
       // Does package.json have a dependency on Heft?
       if (
-        !(packageJson.dependencies && packageJson.dependencies[HEFT_PACKAGE_NAME]) &&
-        !(packageJson.devDependencies && packageJson.devDependencies[HEFT_PACKAGE_NAME])
+        !(packageJson.dependencies && packageJson.dependencies[Constants.heftPackageName]) &&
+        !(packageJson.devDependencies && packageJson.devDependencies[Constants.heftPackageName])
       ) {
         // No explicit dependency on Heft
         return false;
       }
 
       // To avoid a loading the "resolve" NPM package, let's assume that the Heft dependency must be
       // installed as "<projectFolder>/node_modules/@rushstack/heft".
-      const heftFolder: string = path.join(projectFolder, 'node_modules', HEFT_PACKAGE_NAME);
+      const heftFolder: string = path.join(projectFolder, 'node_modules', Constants.heftPackageName);
 
       heftEntryPoint = path.join(heftFolder, 'lib', 'start.js');
       if (!fs.existsSync(heftEntryPoint)) {

apps/heft/src/utilities/Constants.ts

@@ -33,4 +33,6 @@ export class Constants {
   public static verboseParameterShortName: string = '-v';
 
   public static maxParallelism: number = 100;
+
+  public static heftPackageName: string = '@rushstack/heft';
 }

apps/heft/src/utilities/CoreConfigFiles.ts

@@ -77,23 +77,28 @@ export class CoreConfigFiles {
     rigConfig?: IRigConfig | undefined
   ): Promise<IHeftConfigurationJson> {
     if (!CoreConfigFiles._heftConfigFileLoader) {
+      let heftPluginPackageFolder: string | undefined;
+
       const pluginPackageResolver: (
         options: IJsonPathMetadataResolverOptions<IHeftConfigurationJson>
       ) => string = (options: IJsonPathMetadataResolverOptions<IHeftConfigurationJson>) => {
         const { propertyValue, configurationFilePath } = options;
-        if (propertyValue === '@rushstack/heft') {
+        if (propertyValue === Constants.heftPackageName) {
           // If the value is "@rushstack/heft", then resolve to the Heft package that is
           // installed in the project folder. This avoids issues with mismatched versions
           // between the project and the globally installed Heft. Use the PackageJsonLookup
           // class to find the package folder to avoid hardcoding the path for compatibility
           // with bundling.
-          const pluginPackageFolder: string | undefined =
-            PackageJsonLookup.instance.tryGetPackageFolderFor(__dirname);
-          if (!pluginPackageFolder) {
+          if (!heftPluginPackageFolder) {
+            heftPluginPackageFolder = PackageJsonLookup.instance.tryGetPackageFolderFor(__dirname);
+          }
+
+          if (!heftPluginPackageFolder) {
             // This should never happen
             throw new InternalError('Unable to find the @rushstack/heft package folder');
           }
-          return pluginPackageFolder;
+
+          return heftPluginPackageFolder;
         } else {
           const configurationFileDirectory: string = path.dirname(configurationFilePath);
           return Import.resolvePackage({

build-tests/heft-sass-test/config/heft.json

@@ -10,7 +10,23 @@
       "cleanFiles": [{ "includeGlobs": ["dist", "lib", "lib-commonjs", "temp"] }],
 
       "tasksByName": {
+        "set-browserslist-ignore-old-data-env-var": {
+          "taskPlugin": {
+            "pluginPackage": "@rushstack/heft",
+            "pluginName": "set-environment-variables-plugin",
+            "options": {
+              "environmentVariablesToSet": {
+                // Suppress the "Browserslist: caniuse-lite is outdated" warning. Although the warning is
+                // potentially useful, the check is performed in a way that is nondeterministic and can cause
+                // Rush pipelines to fail. Moreover, the outdated version is often irrelevant and/or nontrivial
+                // to upgrade. See this thread for details: https://github.com/microsoft/rushstack/issues/2981
+                "BROWSERSLIST_IGNORE_OLD_DATA": "1"
+              }
+            }
+          }
+        },
         "sass": {
+          "taskDependencies": ["set-browserslist-ignore-old-data-env-var"],
           "taskPlugin": {
             "pluginPackage": "@rushstack/heft-sass-plugin"
           }

build-tests/install-test-workspace/workspace/common/pnpm-lock.yaml

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@rushstack/heft-web-rig",
+      "comment": "Include the `set-environment-variables-plugin` plugin from the `@rushstack/heft` package to set the `BROWSERSLIST_IGNORE_OLD_DATA` environment variable to `1` to suppress the warning printed when the `browserslist` package decides it's out of date.",
+      "type": "minor"
+    }
+  ],
+  "packageName": "@rushstack/heft-web-rig"
+}