Skip to content

Telemetry: Remove instance of check for sub-error handling #33356

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
valentinpalkovic merged 1 commit into from
Dec 14, 2025
Merged

Telemetry: Remove instance of check for sub-error handling #33356

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions code/core/src/core-server/withTelemetry.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,11 +137,9 @@ export async function sendTelemetryError(
);

// If this is a StorybookError with sub-errors, send telemetry for each sub-error separately
if (error instanceof StorybookError && error.subErrors.length > 0) {
if (error && 'subErrors' in error && error.subErrors.length > 0) {
for (const subError of error.subErrors) {
if (subError instanceof StorybookError) {
await sendTelemetryError(subError, eventType, options, blocking, error);
}
await sendTelemetryError(subError, eventType, options, blocking, error as StorybookError);
}
}
Comment on lines +140 to 144
Copy link
Contributor

@coderabbitai coderabbitai bot Dec 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

Add defensive checks to prevent runtime errors with non-StorybookError objects.

The change replaces strict type checking with duck-typing ('subErrors' in error), which introduces several type safety risks:

  1. No array validation: error.subErrors.length assumes subErrors is an array, but the in operator only checks property existence. If a non-array subErrors property exists, this will throw at runtime.

  2. Unsafe cast to StorybookError: Line 142 casts error as StorybookError without verification. When this reaches line 130, parent.fullErrorCode may be undefined if the error lacks this property.

  3. Missing structural validation: Each subError is passed recursively without verifying it matches the expected error structure.

While the try-catch block prevents crashes, it may mask legitimate issues and make debugging harder.

Consider adding defensive runtime checks:

-      if (error && 'subErrors' in error && error.subErrors.length > 0) {
+      if (
+        error &&
+        'subErrors' in error &&
+        Array.isArray(error.subErrors) &&
+        error.subErrors.length > 0 &&
+        'fullErrorCode' in error
+      ) {
         for (const subError of error.subErrors) {
           await sendTelemetryError(subError, eventType, options, blocking, error as StorybookError);
         }
       }

Alternatively, verify this change is intentional and document why duck-typing is preferred over instanceof StorybookError.

}
Expand Down
Loading