From cfe3c9d41fe9afa2fa23e0805d2cffccc3c257fa Mon Sep 17 00:00:00 2001
From: Tyler Butler <tylerbu@microsoft.com>
Date: Mon, 24 Oct 2022 17:36:23 -0700
Subject: [PATCH] fix(build-cli): Exclude independent packages when bumping
 release groups (#12652)

When bumping deps scoped to a single release group, the `bump deps` tool
was including independent
packages. This change corrects that behavior so that only the release
group specified will be
updated.

BREAKING CHANGE: The `-p` flag has been changed to specify a package
name, which is consistent with
other commands. Use `--prerelease` to replace former uses of `-p`.
---
 build-tools/packages/build-cli/docs/bump.md   | 10 +++--
 .../build-cli/src/commands/bump/deps.ts       | 28 +++++++-----
 .../packages/build-cli/src/lib/package.ts     | 43 ++++++++-----------
 3 files changed, 41 insertions(+), 40 deletions(-)

diff --git a/build-tools/packages/build-cli/docs/bump.md b/build-tools/packages/build-cli/docs/bump.md
index 5c83ba9adad7..f1caed84e4bb 100644
--- a/build-tools/packages/build-cli/docs/bump.md
+++ b/build-tools/packages/build-cli/docs/bump.md
@@ -58,8 +58,9 @@ Update the dependency version of a specified package or release group. That is,
 
 ```
 USAGE
-  $ flub bump deps [PACKAGE_OR_RELEASE_GROUP] [-p -t latest|newest|greatest|minor|patch|@next|@canary]
-    [--onlyBumpPrerelease] [-g client|server|azure|build-tools] [-x | --install | --commit |  |  | ] [-v]
+  $ flub bump deps [PACKAGE_OR_RELEASE_GROUP] [--prerelease -t
+    latest|newest|greatest|minor|patch|@next|@canary] [--onlyBumpPrerelease] [-g client|server|azure|build-tools | -p
+    <value>] [-x | --install | --commit |  |  | ] [-v]
 
 ARGUMENTS
   PACKAGE_OR_RELEASE_GROUP  The name of a package or a release group.
@@ -67,14 +68,15 @@ ARGUMENTS
 FLAGS
   -g, --releaseGroup=<option>  Only bump dependencies within this release group.
                                <options: client|server|azure|build-tools>
-  -p, --prerelease             Treat prerelease versions as valid versions to update to.
-  -t, --updateType=<option>    Bump the current version of the dependency according to this bump type.
+  -p, --package=<value>        Only bump dependencies of this package.
+  -t, --updateType=<option>    [default: minor] Bump the current version of the dependency according to this bump type.
                                <options: latest|newest|greatest|minor|patch|@next|@canary>
   -v, --verbose                Verbose logging.
   -x, --skipChecks             Skip all checks.
   --[no-]commit                Commit changes to a new branch.
   --[no-]install               Update lockfiles by running 'npm install' automatically.
   --onlyBumpPrerelease         Only bump dependencies that are on pre-release versions.
+  --prerelease                 Treat prerelease versions as valid versions to update to.
 
 DESCRIPTION
   Update the dependency version of a specified package or release group. That is, if one or more packages in the repo
diff --git a/build-tools/packages/build-cli/src/commands/bump/deps.ts b/build-tools/packages/build-cli/src/commands/bump/deps.ts
index f1d3c109bdc8..87e18a54c335 100644
--- a/build-tools/packages/build-cli/src/commands/bump/deps.ts
+++ b/build-tools/packages/build-cli/src/commands/bump/deps.ts
@@ -11,7 +11,13 @@ import { FluidRepo } from "@fluidframework/build-tools";
 
 import { packageOrReleaseGroupArg } from "../../args";
 import { BaseCommand } from "../../base";
-import { checkFlags, dependencyUpdateTypeFlag, releaseGroupFlag, skipCheckFlag } from "../../flags";
+import {
+    checkFlags,
+    dependencyUpdateTypeFlag,
+    packageSelectorFlag,
+    releaseGroupFlag,
+    skipCheckFlag,
+} from "../../flags";
 import {
     generateBumpDepsBranchName,
     generateBumpDepsCommitMessage,
@@ -40,9 +46,9 @@ export default class DepsCommand extends BaseCommand<typeof DepsCommand.flags> {
         updateType: dependencyUpdateTypeFlag({
             char: "t",
             description: "Bump the current version of the dependency according to this bump type.",
+            default: "minor",
         }),
         prerelease: Flags.boolean({
-            char: "p",
             dependsOn: ["updateType"],
             description: "Treat prerelease versions as valid versions to update to.",
         }),
@@ -51,6 +57,11 @@ export default class DepsCommand extends BaseCommand<typeof DepsCommand.flags> {
         }),
         releaseGroup: releaseGroupFlag({
             description: "Only bump dependencies within this release group.",
+            exclusive: ["package"],
+        }),
+        package: packageSelectorFlag({
+            description: "Only bump dependencies of this package.",
+            exclusive: ["releaseGroup"],
         }),
         commit: checkFlags.commit,
         install: checkFlags.install,
@@ -102,11 +113,6 @@ export default class DepsCommand extends BaseCommand<typeof DepsCommand.flags> {
             this.error("ERROR: No dependency provided.");
         }
 
-        /**
-         * The version range or bump type (depending on the CLI arguments) to set.
-         */
-        const versionToSet = flags.updateType ?? "current";
-
         /**
          * A list of package names on which to update dependencies.
          */
@@ -137,9 +143,11 @@ export default class DepsCommand extends BaseCommand<typeof DepsCommand.flags> {
 
         this.logHr();
         this.log(`Dependencies: ${chalk.blue(args.package_or_release_group)}`);
-        this.log(`Packages: ${chalk.blueBright(flags.releaseGroup ?? "all packages")}`);
+        this.log(
+            `Packages: ${chalk.blueBright(flags.releaseGroup ?? flags.package ?? "all packages")}`,
+        );
         this.log(`Prerelease: ${flags.prerelease ? chalk.green("yes") : "no"}`);
-        this.log(`Bump type: ${chalk.bold(versionToSet)}`);
+        this.log(`Bump type: ${chalk.bold(flags.updateType ?? "unknown")}`);
         this.logHr();
         this.log("");
 
@@ -149,7 +157,7 @@ export default class DepsCommand extends BaseCommand<typeof DepsCommand.flags> {
 
         const { updatedPackages, updatedDependencies } = await npmCheckUpdates(
             context,
-            flags.releaseGroup, // if undefined the whole repo will be checked
+            flags.releaseGroup ?? flags.package, // if undefined the whole repo will be checked
             depsToUpdate,
             args.package_or_release_group,
             flags.updateType,
diff --git a/build-tools/packages/build-cli/src/lib/package.ts b/build-tools/packages/build-cli/src/lib/package.ts
index c83e2ae8eb0e..ee0ebf70a3b3 100644
--- a/build-tools/packages/build-cli/src/lib/package.ts
+++ b/build-tools/packages/build-cli/src/lib/package.ts
@@ -70,30 +70,23 @@ export async function npmCheckUpdates(
     // There can be a lot of duplicate log lines from npm-check-updates, so collect and dedupe before logging.
     const upgradeLogLines = new Set<string>();
     const searchGlobs: string[] = [];
-    let repoPath: string;
+    const repoPath = context.repo.resolvedRoot;
 
     const releaseGroupsToCheck =
-        releaseGroup === undefined
+        releaseGroup === undefined // run on the whole repo
             ? [...context.repo.releaseGroups.keys()]
-            : isReleaseGroup(releaseGroup)
+            : isReleaseGroup(releaseGroup) // run on just this release group
             ? [releaseGroup]
             : undefined;
 
-    const packagesToCheck = isReleaseGroup(releaseGroup) ? undefined : releaseGroup;
-
-    // Run on the whole repo
-    if (releaseGroupsToCheck === undefined) {
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        const pkg = context.fullPackageMap.get(releaseGroup!);
-        if (pkg === undefined) {
-            throw new Error(`Package not found in context: ${releaseGroup}`);
-        }
-
-        repoPath = pkg.directory;
-        searchGlobs.push(pkg.directory);
-    } else {
-        repoPath = context.repo.resolvedRoot;
+    const packagesToCheck =
+        releaseGroup === undefined // run on the whole repo
+            ? [...context.independentPackages] // include all independent packages
+            : isReleaseGroup(releaseGroup)
+            ? [] // run on a release group so no independent packages should be included
+            : [context.fullPackageMap.get(releaseGroup)]; // the releaseGroup argument must be a package
 
+    if (releaseGroupsToCheck !== undefined) {
         for (const group of releaseGroupsToCheck) {
             if (group === releaseGroupFilter) {
                 log?.verbose(
@@ -113,21 +106,19 @@ export async function npmCheckUpdates(
 
             searchGlobs.push(
                 ...releaseGroupRoot.workspaceGlobs.map((g) =>
-                    path.join(
-                        path.relative(context.repo.resolvedRoot, releaseGroupRoot.repoPath),
-                        g,
-                    ),
+                    path.join(path.relative(repoPath, releaseGroupRoot.repoPath), g),
                 ),
                 // Includes the root package.json, in case there are deps there that also need upgrade.
-                // path.join(releaseGroupRoot.repoPath, "package.json"),
-                path.relative(context.repo.resolvedRoot, releaseGroupRoot.repoPath),
+                path.relative(repoPath, releaseGroupRoot.repoPath),
             );
         }
     }
 
-    if (packagesToCheck === undefined) {
-        for (const pkg of context.independentPackages) {
-            searchGlobs.push(path.relative(context.repo.resolvedRoot, pkg.directory));
+    if (packagesToCheck !== undefined) {
+        for (const pkg of packagesToCheck) {
+            if (pkg !== undefined) {
+                searchGlobs.push(path.relative(repoPath, pkg.directory));
+            }
         }
     }