Skip to content

fix(errors): keep the internal SQL_UNAVAILABLE code out of a published hint - #1495

Merged
prisis merged 1 commit into
alphafrom
fix/errors-internal-code-hint
Nov 5, 2026
Merged

prisis merged 1 commit into
alphafrom
fix/errors-internal-code-hint

Conversation

@prisis

@prisis prisis commented Nov 5, 2026

Copy link
Copy Markdown
Member

Summary

The SUBSCRIPTION_SEED_FAILED hint in packages/errors/src/hints.ts named the internal code SQL_UNAVAILABLE as an example. The generated error reference (errors.mdx) must never publish an internal code, so apps/docs' error-reference.test.ts › never publishes an internal code fails on alpha and on every PR built on it (#1483, #1487, #1488, #1489, #1492, #1494).

This PR drops the example code from the hint and regenerates errors.mdx.

Test plan

  • apps/docs error-reference.test.ts: 8/8 pass
  • @lunora/errors tests: 982/982 pass
  • generate-error-reference.js regenerated (213 published codes)

🤖 Generated with Claude Code

…d hint

The SUBSCRIPTION_SEED_FAILED hint named SQL_UNAVAILABLE as an example. That
code is internal, and the generated error reference must never publish one,
so apps/docs' error-reference test failed on every branch built on alpha.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@qodo-code-review

Copy link
Copy Markdown

Qodo reviews are paused for this user.

Troubleshooting steps vary by plan Learn more →

On a Teams plan?
Reviews resume once this user has a paid seat and their Git account is linked in Qodo.
Link Git account →

Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center?
These require an Enterprise plan - Contact us
Contact us →

@netlify

netlify Bot commented Nov 5, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for lunorash ready!

Name Link
🔨 Latest commit 133753d
🔍 Latest deploy log https://app.netlify.com/projects/lunorash/deploys/6aec29ffdc0b5327dd7b8ba2
😎 Deploy Preview https://deploy-preview-1495--lunorash.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@github-actions

github-actions Bot commented Nov 5, 2026

Copy link
Copy Markdown
Contributor

Thank you for following the naming conventions! 🙏

@github-actions github-actions Bot added package: errors size:XS Size of the change, tests and generated files excluded. labels Nov 5, 2026
@coderabbitai

coderabbitai Bot commented Nov 5, 2026 •

Copy link
Copy Markdown

Explain Change →

Caution

Review failed

The pull request is closed.

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

@prisis
prisis merged commit 84d1302 into alpha Nov 5, 2026
12 of 13 checks passed
@github-actions github-actions Bot added the vouch:trusted PR author is a collaborator, a bot or on the VOUCHED list. label Nov 5, 2026
@prisis
prisis deleted the fix/errors-internal-code-hint branch November 5, 2026 07:02
@qodo-free-for-open-source-projects

Copy link
Copy Markdown
Contributor

PR Summary by Qodo

Remove an internal error code from the published subscription hint

🐞 Bug fix 📝 Documentation 🕐 Less than 10 minutes

Grey Divider

AI Description

• Removes an internal code example from the subscription seed failure hint to keep it out of public
 guidance.
• Regenerates the error reference so its published text matches the corrected hint.
Diagram

graph TD
  A["Error hints"] --> B["Reference generator"] --> C["Published docs"] --> D["Docs guard"]
  E["Error catalog"] --> B
Loading
High-Level Assessment

Removing the example from the source hint and regenerating the page is the right approach: it keeps the hint useful without weakening the test that prevents internal codes from appearing anywhere in the published reference.

Files changed (2) +2 / -2

Bug fix (1) +1 / -1
hints.tsRemove the internal code example from the source hint +1/-1

Remove the internal code example from the source hint

• Removes the named internal code from the SUBSCRIPTION_SEED_FAILED hint that feeds the public reference. The description of error handling and logging remains intact.

packages/errors/src/hints.ts

Documentation (1) +1 / -1
errors.mdxRegenerate the public subscription seed failure entry +1/-1

Regenerate the public subscription seed failure entry

• Removes the internal code example from the generated error reference while retaining the explanation of redacted internal-coded errors.

apps/docs/src/content/docs/errors.mdx

@qodo-free-for-open-source-projects

Copy link
Copy Markdown
Contributor

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Grey Divider

Tip of the day
💡 Did you know, you can turn these tips off under Display > Comment parts

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

Grey Divider

Qodo Logo

@prisis

prisis commented Nov 5, 2026

Copy link
Copy Markdown
Member Author

🎉 This has been released 🎉

alpha

@codecov-commenter

codecov-commenter commented Nov 5, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 83.89%. Comparing base (2d7eb96) to head (133753d).
⚠️ Report is 9 commits behind head on alpha.

Additional details and impacted files
@@            Coverage Diff             @@
##            alpha    #1495      +/-   ##
==========================================
- Coverage   83.97%   83.89%   -0.08%     
==========================================
  Files        2089     2074      -15     
  Lines      126052   124466    -1586     
  Branches    32259    32035     -224     
==========================================
- Hits       105855   104424    -1431     
+ Misses      19447    19303     -144     
+ Partials      750      739      -11     
Files with missing lines Coverage Δ
packages/errors/src/hints.ts 100.00% <ø> (ø)

... and 20 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@codspeed

codspeed Bot commented Nov 5, 2026

Copy link
Copy Markdown

Merging this PR will regress 1 benchmark

1 warning

⚠️ 57 benchmarks are dominated by system calls

System calls cannot be simulated consistently and are left out of the measure. The reported value understates the real cost. Switch to the Walltime instrument to measure them.

Learn more about system calls

See affected benchmarks

⚡ 2 improved benchmarks
❌ 1 regressed benchmark
✅ 350 untouched benchmarks
⏩ 46 skipped benchmarks1

Warning

Please fix the performance issues or acknowledge them on CodSpeed.

Performance Changes

Benchmark BASE HEAD Efficiency
❌ low fanout — 5 sockets × 1 sub each, table match 256.1 µs 858.8 µs -70.18%
⚡ 10 sockets 376.7 ms 8.1 ms ×47
⚡ broadcastWhisper to 128 members 1,443.1 µs 717.1 µs ×2

Tip

Investigate this regression by commenting @codspeedbot fix this regression on this PR, or directly use the CodSpeed MCP with your agent.


Comparing fix/errors-internal-code-hint (133753d) with alpha (9d0fedc)

Open in CodSpeed

Footnotes

  1. 46 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports. ↩

This branch was successfully deployed

No deployments
benchmarks — 133753d0 Deployed Nov 5, 2026 by prisis via Benchmarks #7086
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

package: errors released size:XS Size of the change, tests and generated files excluded. 🟡 Small blast radius vouch:trusted PR author is a collaborator, a bot or on the VOUCHED list.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants