[rush] Implementation of Cobuild feature

.gitignore

@@ -64,7 +64,12 @@ jspm_packages/
 *.iml
 
 # Visual Studio Code
-.vscode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+!*.code-workspace
 
 # Rush temporary files
 common/deploy/

.prettierignore

@@ -104,5 +104,8 @@ libraries/rush-lib/assets/rush-init/
 # These are intentionally invalid files
 libraries/heft-config-file/src/test/errorCases/invalidJson/config.json
 
+# common scripts in sandbox repo
+build-tests/rush-redis-cobuild-plugin-integration-test/sandbox/repo/common/scripts/
+
 # We'll consider enabling this later; Prettier reformats code blocks, which affects end-user content
 *.md

.vscode/redis-cobuild.code-workspace

@@ -0,0 +1,20 @@
+{
+  "folders": [
+    {
+      "name": "rush-redis-cobuild-plugin-integration-test",
+      "path": "../build-tests/rush-redis-cobuild-plugin-integration-test"
+    },
+    {
+      "name": "rush-redis-cobuild-plugin",
+      "path": "../rush-plugins/rush-redis-cobuild-plugin"
+    },
+    {
+      "name": "rush-lib",
+      "path": "../libraries/rush-lib"
+    },
+    {
+      "name": ".vscode",
+      "path": "../.vscode"
+    }
+  ]
+}

build-tests/rush-redis-cobuild-plugin-integration-test/.eslintrc.js

@@ -0,0 +1,7 @@
+// This is a workaround for https://github.com/eslint/eslint/issues/3458
+require('@rushstack/eslint-config/patch/modern-module-resolution');
+
+module.exports = {
+  extends: ['@rushstack/eslint-config/profile/node'],
+  parserOptions: { tsconfigRootDir: __dirname }
+};

build-tests/rush-redis-cobuild-plugin-integration-test/.gitignore

@@ -0,0 +1 @@
+redis-data/dump.rdb

build-tests/rush-redis-cobuild-plugin-integration-test/.vscode/tasks.json

@@ -0,0 +1,71 @@
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "type": "shell",
+      "label": "cobuild",
+      "dependsOrder": "sequence",
+      "dependsOn": ["update", "_cobuild"],
+      "problemMatcher": []
+    },
+    {
+      "type": "shell",
+      "label": "_cobuild",
+      "dependsOn": ["build 1", "build 2"],
+      "problemMatcher": []
+    },
+    {
+      "type": "shell",
+      "label": "update",
+      "command": "node ../../lib/runRush.js update",
+      "problemMatcher": [],
+      "presentation": {
+        "echo": true,
+        "reveal": "always",
+        "focus": false,
+        "panel": "dedicated",
+        "showReuseMessage": true,
+        "clear": false
+      },
+      "options": {
+        "cwd": "${workspaceFolder}/sandbox/repo"
+      }
+    },
+    {
+      "type": "shell",
+      "label": "build 1",
+      "command": "node ../../lib/runRush.js --debug cobuild --parallelism 1 --verbose",
+      "problemMatcher": [],
+      "options": {
+        "cwd": "${workspaceFolder}/sandbox/repo"
+      },
+      "presentation": {
+        "echo": true,
+        "reveal": "always",
+        "focus": false,
+        "panel": "dedicated",
+        "showReuseMessage": true,
+        "clear": true
+      },
+      "group": "build"
+    },
+    {
+      "type": "shell",
+      "label": "build 2",
+      "command": "node ../../lib/runRush.js --debug cobuild --parallelism 1 --verbose",
+      "problemMatcher": [],
+      "options": {
+        "cwd": "${workspaceFolder}/sandbox/repo"
+      },
+      "presentation": {
+        "echo": true,
+        "reveal": "always",
+        "focus": false,
+        "panel": "dedicated",
+        "showReuseMessage": true,
+        "clear": true
+      },
+      "group": "build"
+    }
+  ]
+}

build-tests/rush-redis-cobuild-plugin-integration-test/README.md

@@ -0,0 +1,134 @@
+# About
+
+This package enables integration testing of the `RedisCobuildLockProvider` by connecting to an actual Redis created using an [redis](https://hub.docker.com/_/redis) docker image.
+
+# Prerequisites
+
+Docker and docker compose must be installed
+
+# Start the Redis
+
+In this folder run `docker-compose up -d`
+
+# Stop the Redis
+
+In this folder run `docker-compose down`
+
+# Install and build the integration test code
+
+```sh
+rush update
+rush build -t rush-redis-cobuild-plugin-integration-test
+```
+
+# Run the test for lock provider
+
+```sh
+# start the docker container: docker-compose up -d
+# build the code: rushx build
+rushx test-lock-provider
+```
+
+# Integration test in sandbox repo
+
+Sandbox repo folder: **build-tests/rush-redis-cobuild-plugin-integration-test/sandbox/repo**
+
+```sh
+cd sandbox/repo
+rush update
+```
+
+## Case 1: Disable cobuild by setting `RUSH_COBUILD_ENABLED=0`
+
+```sh
+rm -rf common/temp/build-cache && RUSH_COBUILD_ENABLED=0 node ../../lib/runRush.js --debug cobuild
+```
+
+Expected behavior: Cobuild feature is disabled. Run command successfully.
+
+```sh
+RUSH_COBUILD_ENABLED=0 node ../../lib/runRush.js --debug cobuild
+```
+
+Expected behavior: Cobuild feature is disabled. Build cache was restored successfully.
+
+## Case 2: Cobuild enabled, run one cobuild command only
+
+1. Clear redis server
+
+```sh
+(cd ../.. && docker compose down && docker compose up -d)
+```
+
+2. Run `rush cobuild` command
+
+```sh
+rm -rf common/temp/build-cache && node ../../lib/runRush.js --debug cobuild
+```
+
+Expected behavior: Cobuild feature is enabled. Run command successfully.
+You can also see cobuild related logs in the terminal.
+
+```sh
+Get completed state for cobuild:v1::c2df36270ec5faa8ef6497fa7367a476de3e2861:completed: null
+Acquired lock for cobuild:v1::c2df36270ec5faa8ef6497fa7367a476de3e2861:lock: 1, 1 is success
+Set completed state for cobuild:v1::c2df36270ec5faa8ef6497fa7367a476de3e2861:completed: SUCCESS;c2df36270ec5faa8ef6497fa7367a476de3e2861
+```
+
+## Case 3: Cobuild enabled, run two cobuild commands in parallel
+
+> Note: This test requires Visual Studio Code to be installed.
+
+1. Clear redis server
+
+```sh
+(cd ../.. && docker compose down && docker compose up -d)
+```
+
+2. Clear build cache
+
+```sh
+rm -rf common/temp/build-cache
+```
+
+3. Open predefined `.vscode/redis-cobuild.code-workspace` in Visual Studio Code.
+
+4. Open command palette (Ctrl+Shift+P or Command+Shift+P) and select `Tasks: Run Task` and select `cobuild`.
+
+> In this step, two dedicated terminal windows will open. Running `rush cobuild` command under sandbox repo respectively.
+
+Expected behavior: Cobuild feature is enabled, cobuild related logs out in both terminals.
+
+## Case 4: Cobuild enabled, run two cobuild commands in parallel, one of them failed
+
+> Note: This test requires Visual Studio Code to be installed.
+
+1. Making the cobuild command of project "A" fails
+
+**sandbox/repo/projects/a/package.json**
+
+```diff
+  "scripts": {
+-   "cobuild": "node ../build.js a",
++   "cobuild": "sleep 5 && exit 1",
+    "build": "node ../build.js a"
+  }
+```
+
+2. Clear redis server
+
+```sh
+(cd ../.. && docker compose down && docker compose up -d)
+```
+
+3. Clear build cache
+
+```sh
+rm -rf common/temp/build-cache
+```
+
+4. Open predefined `.vscode/redis-cobuild.code-workspace` in Visual Studio Code.
+
+5. Open command palette (Ctrl+Shift+P or Command+Shift+P) and select `Tasks: Run Task` and select `cobuild`.
+
+Expected behavior: Cobuild feature is enabled, cobuild related logs out in both terminals. These two cobuild commands fail because of the failing build of project "A". And, one of them restored the failing build cache created by the other one.

build-tests/rush-redis-cobuild-plugin-integration-test/config/heft.json

@@ -0,0 +1,51 @@
+/**
+ * Defines configuration used by core Heft.
+ */
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/heft/heft.schema.json",
+
+  "eventActions": [
+    {
+      /**
+       * The kind of built-in operation that should be performed.
+       * The "deleteGlobs" action deletes files or folders that match the
+       * specified glob patterns.
+       */
+      "actionKind": "deleteGlobs",
+
+      /**
+       * The stage of the Heft run during which this action should occur. Note that actions specified in heft.json
+       * occur at the end of the stage of the Heft run.
+       */
+      "heftEvent": "clean",
+
+      /**
+       * A user-defined tag whose purpose is to allow configs to replace/delete handlers that were added by other
+       * configs.
+       */
+      "actionId": "defaultClean",
+
+      /**
+       * Glob patterns to be deleted. The paths are resolved relative to the project folder.
+       */
+      "globsToDelete": ["dist", "lib", "temp"]
+    }
+  ],
+
+  /**
+   * The list of Heft plugins to be loaded.
+   */
+  "heftPlugins": [
+    // {
+    //  /**
+    //   * The path to the plugin package.
+    //   */
+    //  "plugin": "path/to/my-plugin",
+    //
+    //  /**
+    //   * An optional object that provides additional settings that may be defined by the plugin.
+    //   */
+    //  // "options": { }
+    // }
+  ]
+}

build-tests/rush-redis-cobuild-plugin-integration-test/config/rush-project.json

@@ -0,0 +1,8 @@
+{
+  "operationSettings": [
+    {
+      "operationName": "build",
+      "outputFolderNames": ["lib", "dist"]
+    }
+  ]
+}

build-tests/rush-redis-cobuild-plugin-integration-test/docker-compose.yml

@@ -0,0 +1,10 @@
+version: '3.7'
+
+services:
+  redis:
+    image: redis:6.2.10-alpine
+    command: redis-server --save "" --loglevel warning --requirepass redis123
+    ports:
+      - '6379:6379'
+    volumes:
+      - ./redis-data:/data

build-tests/rush-redis-cobuild-plugin-integration-test/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "rush-redis-cobuild-plugin-integration-test",
+  "version": "1.0.0",
+  "private": true,
+  "description": "Tests connecting to an redis server",
+  "license": "MIT",
+  "scripts": {
+    "_phase:build": "heft build --clean",
+    "build": "heft build --clean",
+    "test-lock-provider": "node ./lib/testLockProvider.js"
+  },
+  "devDependencies": {
+    "@microsoft/rush-lib": "workspace:*",
+    "@rushstack/eslint-config": "workspace:*",
+    "@rushstack/heft": "workspace:*",
+    "@rushstack/node-core-library": "workspace:*",
+    "@rushstack/rush-redis-cobuild-plugin": "workspace:*",
+    "@types/http-proxy": "~1.17.8",
+    "@types/node": "14.18.36",
+    "eslint": "~8.7.0",
+    "http-proxy": "~1.18.1",
+    "typescript": "~4.8.4"
+  }
+}

build-tests/rush-redis-cobuild-plugin-integration-test/sandbox/repo/.gitignore

@@ -0,0 +1,4 @@
+# Rush temporary files
+common/deploy/
+common/temp/
+common/autoinstallers/*/.npmrc

build-tests/rush-redis-cobuild-plugin-integration-test/sandbox/repo/common/config/rush-plugins/rush-redis-cobuild-plugin.json

@@ -0,0 +1,4 @@
+{
+  "url": "redis://localhost:6379",
+  "password": "redis123"
+}