Skip to content

Conversation

@valentinpalkovic
Copy link
Contributor

@valentinpalkovic valentinpalkovic commented Dec 14, 2025

Closes #

What I did

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 publish.yml --field pr=<PR_NUMBER>

Summary by CodeRabbit

Release Notes

  • Bug Fixes
    • Improved error telemetry to capture more complete diagnostic data from nested error scenarios, enabling better error tracking and system monitoring without affecting user experience.

✏️ Tip: You can customize this high-level summary in your review settings.

@valentinpalkovic valentinpalkovic self-assigned this Dec 14, 2025
@valentinpalkovic valentinpalkovic added bug patch:yes Bugfix & documentation PR that need to be picked to main branch telemetry ci:normal labels Dec 14, 2025
@nx-cloud
Copy link

nx-cloud bot commented Dec 14, 2025

View your CI Pipeline Execution ↗ for commit d8169b5

Command Status Duration Result
nx run-many -t compile,check,knip,test,pretty-d... ✅ Succeeded 10m 27s View ↗

☁️ Nx Cloud last updated this comment at 2025-12-14 11:19:49 UTC

@nx-cloud
Copy link

nx-cloud bot commented Dec 14, 2025

View your CI Pipeline Execution ↗ for commit d8169b5

Command Status Duration Result
nx run-many -t compile,check,knip,test,pretty-d... ⏳ In Progress ... View ↗

☁️ Nx Cloud last updated this comment at 2025-12-14 11:19:01 UTC

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 14, 2025

📝 Walkthrough

Walkthrough

Modifies error handling in telemetry to use a permissive runtime check for subErrors presence instead of strict type checking. Iterates through subErrors unconditionally and invokes sendTelemetryError on each, passing the original error as parent context, removing inner type guards.

Changes

Cohort / File(s) Summary
Telemetry error handling
code/core/src/core-server/withTelemetry.ts
Replaces strict StorybookError type check with permissive runtime check for subErrors property; iterates subErrors unconditionally and sends telemetry for each, allowing non-StorybookError sub-errors to be processed under the same parent context

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10–15 minutes

  • Focus areas: Understand the rationale for removing the strict type guard and verify the permissive runtime check handles edge cases appropriately (e.g., errors with undefined or empty subErrors).

Possibly related PRs

  • storybookjs/storybook#33295: Modifies the same withTelemetry.ts file to iterate and propagate StorybookError subErrors for separate telemetry event emission.
✨ Finishing touches
  • 📝 Generate docstrings

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c4980c1 and d8169b5.

📒 Files selected for processing (1)
  • code/core/src/core-server/withTelemetry.ts (1 hunks)
🧰 Additional context used
📓 Path-based instructions (5)
**/*.{js,jsx,json,html,ts,tsx,mjs}

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

Use ESLint and Prettier configurations that are enforced in the codebase

Files:

  • code/core/src/core-server/withTelemetry.ts
**/*.{ts,tsx}

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

Enable TypeScript strict mode

Files:

  • code/core/src/core-server/withTelemetry.ts
code/**/*.{ts,tsx,js,jsx,mjs}

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

code/**/*.{ts,tsx,js,jsx,mjs}: Use server-side logger from 'storybook/internal/node-logger' for Node.js code
Use client-side logger from 'storybook/internal/client-logger' for browser code
Do not use console.log, console.warn, or console.error directly unless in isolated files where importing loggers would significantly increase bundle size

Files:

  • code/core/src/core-server/withTelemetry.ts
code/**/*.{ts,tsx,js,jsx}

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

Export functions that need to be tested from their modules

Files:

  • code/core/src/core-server/withTelemetry.ts
code/**/*.{js,jsx,json,html,ts,tsx,mjs}

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

code/**/*.{js,jsx,json,html,ts,tsx,mjs}: Run Prettier with --write flag to format code before committing
Run ESLint with yarn lint:js:cmd to check for linting issues and fix errors before committing

Files:

  • code/core/src/core-server/withTelemetry.ts
🧠 Learnings (1)
📚 Learning: 2025-11-05T09:37:25.920Z
Learnt from: Sidnioulz
Repo: storybookjs/storybook PR: 32458
File: code/core/src/components/components/tooltip/WithTooltip.tsx:54-96
Timestamp: 2025-11-05T09:37:25.920Z
Learning: Repo: storybookjs/storybook — In code/core/src/components/components/tooltip/WithTooltip.tsx, the legacy WithTooltip implementation is intentionally reintroduced for backward compatibility and is deprecated; maintainers (per Sidnioulz) do not want maintenance or improvements on it. Prefer WithTooltipNew/Popover; avoid suggesting changes to WithTooltip.* going forward.

Applied to files:

  • code/core/src/core-server/withTelemetry.ts
🧬 Code graph analysis (1)
code/core/src/core-server/withTelemetry.ts (1)
code/core/src/server-errors.ts (1)
  • StorybookError (8-8)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (6)
  • GitHub Check: normal
  • GitHub Check: nx
  • GitHub Check: nx
  • GitHub Check: Core Unit Tests, windows-latest
  • GitHub Check: nx
  • GitHub Check: nx

Comment on lines +140 to 144
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);
}
}
Copy link
Contributor

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.

@valentinpalkovic valentinpalkovic merged commit 87bdf8b into next Dec 14, 2025
74 of 77 checks passed
@valentinpalkovic valentinpalkovic deleted the valentin/telemetry-instance-of-check branch December 14, 2025 11:44
valentinpalkovic added a commit that referenced this pull request Dec 15, 2025
…e-of-check

Telemetry: Remove instance of check for sub-error handling
(cherry picked from commit 87bdf8b)
@github-actions github-actions bot mentioned this pull request Dec 15, 2025
3 tasks
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Dec 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug ci:normal patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch telemetry

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants