CLI: Fix throwing in readonly environments #31785

JReinhold · 2025-06-16T08:33:43Z

Closes #31709

What I did

Changed the global settings logic to only log a warning if it can't save the file, instead of throwing an error
Don't run global settings logic in CI
Added a utility to more resiliently check for optional, boolean environment variables, and a shortcut isCI that uses that.

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

stories
unit tests
integration tests
end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

Add or update documentation reflecting your changes
If you are deprecating/removing a feature, make sure to update
MIGRATION.MD

Checklist for Maintainers

When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli-storybook/src/sandbox-templates.ts
Make sure this PR contains one of the labels below:
Available labels
- bug: Internal changes that fixes incorrect behavior.
- maintenance: User-facing maintenance tasks.
- dependencies: Upgrading (sometimes downgrading) dependencies.
- build: Internal-facing build tooling & test updates. Will not show up in release changelog.
- cleanup: Minor cleanup style change. Will not show up in release changelog.
- documentation: Documentation only changes. Will not show up in release changelog.
- feature request: Introducing a new feature.
- BREAKING CHANGE: Changes that break compatibility in some way with current major version.
- other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

Greptile Summary

Modified global settings handling to prevent failures in read-only environments like CI systems by replacing error throwing with warning logs.

Removed SavingGlobalSettingsFileError from code/core/src/server-errors.ts
Added CI environment detection to skip global settings in code/core/src/telemetry/storybook-metadata.ts
Updated code/core/src/cli/globalSettings.ts to log warnings instead of throwing errors on save failures
Modified test cases in code/core/src/cli/globalSettings.test.ts to verify new warning behavior

greptile-apps

LGTM

_{4 files reviewed, no comments}
_{Edit PR Review Bot Settings | Greptile}

nx-cloud · 2025-06-16T08:39:51Z

View your CI Pipeline Execution ↗ for commit c458370.

Command	Status	Duration	Result
`nx run-many -t build --parallel=3`	✅ Succeeded	1m 15s	View ↗

☁️ Nx Cloud last updated this comment at 2025-06-18 07:26:31 UTC

shilman · 2025-06-16T09:11:43Z

code/core/src/telemetry/storybook-metadata.ts

@@ -57,10 +57,10 @@ export const computeStorybookMetadata = async ({
  mainConfig?: StorybookConfig & Record<string, any>;
  configDir: string;
 }): Promise<StorybookMetadata> => {
-  const settings = await globalSettings();
+  const settings = process.env.CI === 'true' ? undefined : await globalSettings();


Seeing several different usages of process.env.CI in the codebase. This one seems like the safest to me:

storybook/code/core/src/telemetry/telemetry.ts

Line 48 in 2155bb8

inCI: Boolean(process.env.CI),

Boolean('false') returns true, seems pretty bad to me.

Ie. CI=false storybook dev would make that thing become true.

Although process.env.CI === 'true' wouldn't support CI=1, but I'm not sure how many use that.

Should we use this

storybook/code/core/src/core-server/presets/common-preset.ts

Lines 173 to 188 in c2d246c

const optionalEnvToBoolean = (input: string | undefined): boolean | undefined => {

if (input === undefined) {

return undefined;

}

if (input.toUpperCase() === 'FALSE') {

return false;

}

if (input.toUpperCase() === 'TRUE') {

return true;

}

if (typeof input === 'string') {

return true;

}

return undefined;

};

Slight detour but can we also fix that across the codebase? If Boolean('false') returns true that's a bug. And there's a ton of other places that just refer to process.env.CI directly.

alright, I refactored it to export a utility from storybook/internal/common and used that everywhere we were reading a boolean env. please re-review @shilman or @tmeasday.

shilman

Looks good with one minor nit

storybook-pr-benchmarking · 2025-06-18T07:32:00Z

Package Benchmarks

^{Commit: c458370, ran on 18 June 2025 at 07:31:55 UTC}

The following packages have significant changes to their size or dependencies:

`storybook`

	Before	After	Difference
Dependency count	49	49	0
Self size	31.87 MB	31.90 MB	🚨 +30 KB 🚨
Dependency size	17.41 MB	17.41 MB	0 B
Bundle Size Analyzer	Link	Link

`@storybook/nextjs`

	Before	After	Difference
Dependency count	531	531	0
Self size	902 KB	217 KB	🎉 -686 KB 🎉
Dependency size	58.92 MB	58.92 MB	🎉 -172 B 🎉
Bundle Size Analyzer	Link	Link

`@storybook/nextjs-vite`

	Before	After	Difference
Dependency count	131	131	0
Self size	3.07 MB	2.39 MB	🎉 -685 KB 🎉
Dependency size	22.30 MB	22.30 MB	🎉 -500 B 🎉
Bundle Size Analyzer	Link	Link

`sb`

	Before	After	Difference
Dependency count	50	50	0
Self size	1 KB	1 KB	0 B
Dependency size	49.27 MB	49.30 MB	🚨 +30 KB 🚨
Bundle Size Analyzer	Link	Link

`@storybook/cli`

	Before	After	Difference
Dependency count	216	216	0
Self size	582 KB	582 KB	🎉 -39 B 🎉
Dependency size	94.59 MB	94.64 MB	🚨 +47 KB 🚨
Bundle Size Analyzer	Link	Link

`@storybook/codemod`

	Before	After	Difference
Dependency count	185	185	0
Self size	31 KB	31 KB	0 B
Dependency size	78.72 MB	78.75 MB	🚨 +30 KB 🚨
Bundle Size Analyzer	Link	Link

`create-storybook`

	Before	After	Difference
Dependency count	1	1	0
Self size	12.47 MB	12.49 MB	🚨 +16 KB 🚨
Dependency size	98 KB	98 KB	0 B
Bundle Size Analyzer	Link	Link

tmeasday

I have a couple questions but looks good otherwise, good improvement.

tmeasday · 2025-06-18T23:41:24Z

code/core/src/common/utils/envs.ts

+  if (input.toUpperCase() === 'TRUE' || input === '1') {
+    return true;
+  }


This is redundant right.. do we think it's better for brevity? Should this function be unit tested?

tmeasday · 2025-06-18T23:42:01Z

code/core/src/common/utils/envs.ts

+ * Doing Boolean(process.env.CI) or !process.env.CI is not enough, because users might set CI=false
+ * or CI=0, which would be truthy, and thus return true in those cases.
+ */
+export const isCI = optionalEnvToBoolean(process.env.CI);


Is it OK for this file to read process.env? It's never used in a scenario where one of those might be undefined?

dont throw on global settings write error, dont run in CI

bf57669

JReinhold requested review from tmeasday and shilman June 16, 2025 08:33

JReinhold self-assigned this Jun 16, 2025

JReinhold added bug ci: do not merge cli telemetry ci:normal patch:yes Bugfix & documentation PR that need to be picked to main branch and removed ci: do not merge labels Jun 16, 2025

greptile-apps bot reviewed Jun 16, 2025

View reviewed changes

shilman reviewed Jun 16, 2025

View reviewed changes

shilman approved these changes Jun 16, 2025

View reviewed changes

add more resilient utility for boolean environment variables

c458370

tmeasday approved these changes Jun 18, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

CLI: Fix throwing in readonly environments #31785

CLI: Fix throwing in readonly environments #31785

JReinhold commented Jun 16, 2025 •

edited

Loading

Uh oh!

greptile-apps bot left a comment

Uh oh!

nx-cloud bot commented Jun 16, 2025 •

edited

Loading

Uh oh!

shilman Jun 16, 2025

Uh oh!

JReinhold Jun 16, 2025

Uh oh!

tmeasday Jun 16, 2025

Uh oh!

shilman Jun 17, 2025

Uh oh!

JReinhold Jun 18, 2025 •

edited

Loading

Uh oh!

shilman left a comment

Uh oh!

storybook-pr-benchmarking bot commented Jun 18, 2025

Uh oh!

tmeasday left a comment

Uh oh!

tmeasday Jun 18, 2025

Uh oh!

tmeasday Jun 18, 2025

Uh oh!

Uh oh!

	const optionalEnvToBoolean = (input: string \| undefined): boolean \| undefined => {
	if (input === undefined) {
	return undefined;
	}
	if (input.toUpperCase() === 'FALSE') {
	return false;
	}
	if (input.toUpperCase() === 'TRUE') {
	return true;
	}
	if (typeof input === 'string') {
	return true;
	}
	return undefined;
	};

Uh oh!

CLI: Fix throwing in readonly environments #31785

Are you sure you want to change the base?

CLI: Fix throwing in readonly environments #31785

Conversation

JReinhold commented Jun 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What I did

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

Manual testing

Documentation

Checklist for Maintainers

🦋 Canary release

Greptile Summary

Uh oh!

greptile-apps bot left a comment

Choose a reason for hiding this comment

Uh oh!

nx-cloud bot commented Jun 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

shilman Jun 16, 2025

Choose a reason for hiding this comment

Uh oh!

JReinhold Jun 16, 2025

Choose a reason for hiding this comment

Uh oh!

tmeasday Jun 16, 2025

Choose a reason for hiding this comment

Uh oh!

shilman Jun 17, 2025

Choose a reason for hiding this comment

Uh oh!

JReinhold Jun 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shilman left a comment

Choose a reason for hiding this comment

Uh oh!

storybook-pr-benchmarking bot commented Jun 18, 2025

Package Benchmarks

storybook

@storybook/nextjs

@storybook/nextjs-vite

sb

@storybook/cli

@storybook/codemod

create-storybook

Uh oh!

tmeasday left a comment

Choose a reason for hiding this comment

Uh oh!

tmeasday Jun 18, 2025

Choose a reason for hiding this comment

Uh oh!

tmeasday Jun 18, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

JReinhold commented Jun 16, 2025 •

edited

Loading

nx-cloud bot commented Jun 16, 2025 •

edited

Loading

JReinhold Jun 18, 2025 •

edited

Loading

`storybook`

`@storybook/nextjs`

`@storybook/nextjs-vite`

`sb`

`@storybook/cli`

`@storybook/codemod`

`create-storybook`