From ec97d4b6fe1670f982f67031cf9c17dd9a0e6cd9 Mon Sep 17 00:00:00 2001
From: Daniel Choudhury <dannychoudhury@gmail.com>
Date: Thu, 1 Aug 2024 22:44:27 +0700
Subject: [PATCH] fix(cli-cache): Remove RW CLI cache on upgrade (#11135)

This change removes the redwood cli plugin cache in
`.redwood/commandCache.json` on running `rw upgrade`.

This prevents the redwood CLI from using outdated versions of CLI
plugins, and is particularly important when they same alias.

**Before**
running `yarn rw sb` -> would use the outdated storybook-cli package,
and error out.

**After**
with no commandCache, it'll create a new command cache, and attempt to
install the new vite CLI
---
 .changesets/11135.md                 | 11 +++++++++++
 packages/cli/src/commands/upgrade.js | 24 ++++++++++++++++++++++++
 packages/cli/src/lib/plugin.js       |  2 +-
 3 files changed, 36 insertions(+), 1 deletion(-)
 create mode 100644 .changesets/11135.md

diff --git a/.changesets/11135.md b/.changesets/11135.md
new file mode 100644
index 000000000000..932c7fa1fd0e
--- /dev/null
+++ b/.changesets/11135.md
@@ -0,0 +1,11 @@
+- fix(cli-cache): Remove RW CLI cache on upgrade (#11135) by @dac09
+
+This change removes the redwood cli plugin cache in `.redwood/commandCache.json` on running `rw upgrade`. 
+
+This prevents the redwood CLI from using outdated versions of CLI plugins, and is particularly important when they same alias.
+
+**Before**
+running `yarn rw sb` -> would use the outdated storybook-cli package, and error out.
+
+**After**
+with no commandCache, it'll create a new command cache, and attempt to install the new vite CLI
diff --git a/packages/cli/src/commands/upgrade.js b/packages/cli/src/commands/upgrade.js
index 08f16a568fcb..db4cf8df4a7a 100644
--- a/packages/cli/src/commands/upgrade.js
+++ b/packages/cli/src/commands/upgrade.js
@@ -12,6 +12,7 @@ import { getConfig } from '@redwoodjs/project-config'
 import { getPaths } from '../lib'
 import c from '../lib/colors'
 import { generatePrismaClient } from '../lib/generatePrismaClient'
+import { PLUGIN_CACHE_FILENAME } from '../lib/plugin'
 
 export const command = 'upgrade'
 export const description = 'Upgrade all @redwoodjs packages via interactive CLI'
@@ -116,6 +117,10 @@ export const handler = async ({ dryRun, tag, verbose, dedupe }) => {
         task: (ctx) => downloadYarnPatches(ctx, { dryRun, verbose }),
         enabled: (ctx) => ctx.versionToUpgradeTo?.includes('canary'),
       },
+      {
+        title: 'Removing CLI cache',
+        task: (ctx) => removeCliCache(ctx, { dryRun, verbose }),
+      },
       {
         title: 'Running yarn install',
         task: (ctx) => yarnInstall(ctx, { dryRun, verbose }),
@@ -206,6 +211,25 @@ async function yarnInstall({ verbose }) {
   }
 }
 
+/**
+ * Removes the CLI plugin cache. This prevents the CLI from using outdated versions of the plugin,
+ * when the plugins share the same alias. e.g. `rw sb` used to point to `@redwoodjs/cli-storybook` but now points to `@redwoodjs/cli-storybook-vite`
+ */
+async function removeCliCache(ctx, { dryRun, verbose }) {
+  const cliCacheDir = path.join(
+    getPaths().generated.base,
+    PLUGIN_CACHE_FILENAME,
+  )
+
+  if (verbose) {
+    console.log('Removing CLI cache at: ', cliCacheDir)
+  }
+
+  if (!dryRun) {
+    fs.removeSync(cliCacheDir)
+  }
+}
+
 async function setLatestVersionToContext(ctx, tag) {
   try {
     const foundVersion = await latestVersion(
diff --git a/packages/cli/src/lib/plugin.js b/packages/cli/src/lib/plugin.js
index ac522f8542ee..dd4ecd47683c 100644
--- a/packages/cli/src/lib/plugin.js
+++ b/packages/cli/src/lib/plugin.js
@@ -14,7 +14,7 @@ const { Select } = require('enquirer')
 /**
  * The file inside .redwood which will contain cached plugin command mappings
  */
-const PLUGIN_CACHE_FILENAME = 'commandCache.json'
+export const PLUGIN_CACHE_FILENAME = 'commandCache.json'
 
 /**
  * A cache of yargs information for redwood commands that are available from plugins.