Fix upgrade command for outdated dev deps (#2093)

* Failing test for outdated dev deps * Fix outdated devDeps being ignored * Changesets
Shopify · May 8, 2024 · 286589e · 286589e
1 parent ae262b6
commit 286589e
Show file tree

Hide file tree

Showing 3 changed files with 98 additions and 4 deletions.
diff --git a/.changeset/early-rockets-do.md b/.changeset/early-rockets-do.md
@@ -0,0 +1,5 @@
+---
+'@shopify/cli-hydrogen': patch
+---
+
+Fix `h2 upgrade` command to detect outdated devDependencies.
diff --git a/packages/cli/src/commands/hydrogen/upgrade.test.ts b/packages/cli/src/commands/hydrogen/upgrade.test.ts
@@ -142,6 +142,22 @@ async function inTemporaryHydrogenRepo(
   });
 }
 
+function increasePatchVersion(depName: string, deps: Record<string, string>) {
+  const depVersion = deps[depName];
+  if (!depVersion) {
+    throw new Error(
+      `No dependency "${depName}" found in: ${Object.keys(deps || {})}`,
+    );
+  }
+
+  return {
+    [depName]: depVersion.replace(
+      /\.(\d+)$/,
+      (_, patchVersion) => `.${Number(patchVersion) + 1}`,
+    ),
+  };
+}
+
 describe('upgrade', async () => {
   // Create an outdated skeleton package.json for all tests
   const OUTDATED_HYDROGEN_PACKAGE_JSON = createOutdatedSkeletonPackageJson();
@@ -295,13 +311,83 @@ describe('upgrade', async () => {
           cleanGitRepo: true,
           packageJson: {
             dependencies: {
-              // @ts-ignore
-              '@shopify/hydrogen': releases[2].version,
+              '@shopify/hydrogen': releases[2]!.version,
             },
           },
         },
       );
     });
+
+    it('it finds outdated dependencies', async () => {
+      const {releases} = await getChangelog();
+      const latestRelease = releases[0]!;
+
+      expect(
+        getAvailableUpgrades({
+          currentVersion: latestRelease.version,
+          currentDependencies: {},
+          releases,
+        }).availableUpgrades,
+      ).toHaveLength(0);
+
+      const depName = Object.keys(latestRelease.dependencies)[0]!;
+      const devDepName = Object.keys(latestRelease.devDependencies)[0]!;
+
+      // Copy of latest release, no changes
+      expect(
+        getAvailableUpgrades({
+          currentVersion: latestRelease.version,
+          currentDependencies: {
+            [depName]: latestRelease.dependencies[depName]!,
+            [devDepName]: latestRelease.devDependencies[devDepName]!,
+          },
+          releases: [{...latestRelease}, ...releases],
+        }).availableUpgrades,
+      ).toHaveLength(0);
+
+      // Copy of latest release but with increased patch version of a dependency
+      expect(
+        getAvailableUpgrades({
+          currentVersion: latestRelease.version,
+          currentDependencies: {
+            [depName]: latestRelease.dependencies[depName]!,
+          },
+          releases: [
+            {
+              ...latestRelease,
+              dependencies: {
+                ...latestRelease.dependencies,
+                ...increasePatchVersion(depName, latestRelease.dependencies),
+              },
+            },
+            ...releases,
+          ],
+        }).availableUpgrades,
+      ).toHaveLength(1);
+
+      // Copy of latest release but with increased patch version of a dev-dependency
+      expect(
+        getAvailableUpgrades({
+          currentVersion: latestRelease.version,
+          currentDependencies: {
+            [devDepName]: latestRelease.devDependencies[devDepName]!,
+          },
+          releases: [
+            {
+              ...latestRelease,
+              devDependencies: {
+                ...latestRelease.devDependencies,
+                ...increasePatchVersion(
+                  devDepName,
+                  latestRelease.devDependencies,
+                ),
+              },
+            },
+            ...releases,
+          ],
+        }).availableUpgrades,
+      ).toHaveLength(1);
+    });
   });
 
   describe('getSelectedRelease', () => {

diff --git a/packages/cli/src/commands/hydrogen/upgrade.ts b/packages/cli/src/commands/hydrogen/upgrade.ts
@@ -327,14 +327,17 @@ export async function getChangelog(): Promise<ChangeLog> {
   );
 }
 
-export function hasOutdatedDependencies({
+function hasOutdatedDependencies({
   release,
   currentDependencies,
 }: {
   release: Release;
   currentDependencies: Dependencies;
 }) {
-  return Object.entries(release.dependencies).some(([name, version]) => {
+  return Object.entries({
+    ...release.dependencies,
+    ...release.devDependencies,
+  }).some(([name, version]) => {
     const currentDependencyVersion = currentDependencies?.[name];
     if (!currentDependencyVersion) return false;
     const isDependencyOutdated = semver.gt(