Merge pull request #31796 from storybookjs/valentin/circumvent-npm-peer-dep-error-during-upgrade

Core: Enhance package manager install methods to support optional force flag
(cherry picked from commit c8f2db1)

Author: valentinpalkovic

code/core/src/common/js-package-manager/BUNProxy.ts

@@ -190,10 +190,10 @@ export class BUNProxy extends JsPackageManager {
     };
   }
 
-  protected runInstall() {
+  protected runInstall(options?: { force?: boolean }) {
     return this.executeCommand({
       command: 'bun',
-      args: ['install', ...this.getInstallArgs()],
+      args: ['install', ...this.getInstallArgs(), ...(options?.force ? ['--force'] : [])],
       stdio: 'inherit',
       cwd: this.cwd,
     });

code/core/src/common/js-package-manager/JsPackageManager.ts

@@ -134,8 +134,8 @@ export abstract class JsPackageManager {
     return false;
   }
 
-  async installDependencies() {
-    await prompt.executeTask(() => this.runInstall(), {
+  async installDependencies(options?: { force?: boolean }) {
+    await prompt.executeTask(() => this.runInstall(options), {
       id: 'install-dependencies',
       intro: 'Installing dependencies...',
       error: 'An error occurred while installing dependencies.',
@@ -146,13 +146,16 @@ export abstract class JsPackageManager {
     this.clearInstalledVersionCache();
   }
 
-  async dedupeDependencies() {
-    await prompt.executeTask(() => this.runInternalCommand('dedupe', [], this.cwd), {
-      id: 'dedupe-dependencies',
-      intro: 'Deduplicating dependencies...',
-      error: 'An error occurred while deduplicating dependencies.',
-      success: 'Dependencies deduplicated',
-    });
+  async dedupeDependencies(options?: { force?: boolean }) {
+    await prompt.executeTask(
+      () => this.runInternalCommand('dedupe', [...(options?.force ? ['--force'] : [])], this.cwd),
+      {
+        id: 'dedupe-dependencies',
+        intro: 'Deduplicating dependencies...',
+        error: 'An error occurred while deduplicating dependencies.',
+        success: 'Dependencies deduplicated',
+      }
+    );
 
     // Clear installed version cache after installation
     this.clearInstalledVersionCache();
@@ -535,7 +538,7 @@ export abstract class JsPackageManager {
     const resolutions = this.getResolutions(packageJson, versions);
     this.writePackageJson({ ...packageJson, ...resolutions }, operationDir);
   }
-  protected abstract runInstall(): ExecaChildProcess;
+  protected abstract runInstall(options?: { force?: boolean }): ExecaChildProcess;
 
   protected abstract runAddDeps(
     dependencies: string[],

code/core/src/common/js-package-manager/NPMProxy.ts

@@ -186,10 +186,10 @@ export class NPMProxy extends JsPackageManager {
     };
   }
 
-  protected runInstall() {
+  protected runInstall(options?: { force?: boolean }) {
     return this.executeCommand({
       command: 'npm',
-      args: ['install', ...this.getInstallArgs()],
+      args: ['install', ...this.getInstallArgs(), ...(options?.force ? ['--force'] : [])],
       cwd: this.cwd,
       stdio: prompt.getPreferredStdio(),
     });

code/core/src/common/js-package-manager/PNPMProxy.ts

@@ -195,10 +195,10 @@ export class PNPMProxy extends JsPackageManager {
     };
   }
 
-  protected runInstall() {
+  protected runInstall(options?: { force?: boolean }) {
     return this.executeCommand({
       command: 'pnpm',
-      args: ['install', ...this.getInstallArgs()],
+      args: ['install', ...this.getInstallArgs(), ...(options?.force ? ['--force'] : [])],
       stdio: prompt.getPreferredStdio(),
       cwd: this.cwd,
     });

code/core/src/common/js-package-manager/Yarn1Proxy.ts

@@ -141,10 +141,10 @@ export class Yarn1Proxy extends JsPackageManager {
     };
   }
 
-  protected runInstall() {
+  protected runInstall(options?: { force?: boolean }) {
     return this.executeCommand({
       command: 'yarn',
-      args: ['install', ...this.getInstallArgs()],
+      args: ['install', ...this.getInstallArgs(), ...(options?.force ? ['--force'] : [])],
       stdio: prompt.getPreferredStdio(),
       cwd: this.cwd,
     });

code/lib/cli-storybook/src/upgrade.ts

@@ -427,7 +427,12 @@ export async function upgrade(options: UpgradeOptions): Promise<void> {
             ? JsPackageManagerFactory.getPackageManager({ force: options.packageManager })
             : storybookProjects[0].packageManager;
 
-        await rootPackageManager.installDependencies();
+        if (rootPackageManager.type === 'npm') {
+          // see https://github.com/npm/cli/issues/8059 for more details
+          await rootPackageManager.installDependencies({ force: true });
+        } else {
+          await rootPackageManager.installDependencies();
+        }
 
         if (rootPackageManager.type !== 'yarn1' && rootPackageManager.isStorybookInMonorepo()) {
           logger.warn(
@@ -442,7 +447,12 @@ export async function upgrade(options: UpgradeOptions): Promise<void> {
             }));
 
           if (dedupe) {
-            await rootPackageManager.dedupeDependencies();
+            if (rootPackageManager.type === 'npm') {
+              // see https://github.com/npm/cli/issues/8059 for more details
+              await rootPackageManager.dedupeDependencies({ force: true });
+            } else {
+              await rootPackageManager.dedupeDependencies();
+            }
           } else {
             logger.log(
               `If you find any issues running Storybook, you can run ${rootPackageManager.getRunCommand('dedupe')} manually to deduplicate your dependencies and try again.`