Make spec coverage report error fail the script

[lawrence-forooghian]

Summary by CodeRabbit

• Refactor
  • Improved error handling to ensure the process exits with an error code if an error occurs during execution.

[coderabbitai]

Walkthrough

The error handling in the main function of the coverage report script was refactored. Instead of using a try-catch block inside an async IIFE, error handling is now performed externally using a .catch() on the promise, which logs the error and exits the process with code 1.

Changes

File(s)	Change Summary
scripts/specCoverageReport.ts	Refactored error handling from internal try-catch to external .catch() with process exit on error.

Poem

A script once caught its errors tight,
Now lets them bubble up to light.
With .catch() poised, it will not stall—
Logs the woe, then ends it all.
Rabbits cheer for tidy ends,
Where promise and process both make amends! 🐇✨

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

npm warn EBADENGINE Unsupported engine {
npm warn EBADENGINE package: '@es-joy/jsdoccomment@0.37.1',
npm warn EBADENGINE required: { node: '^14 || ^16 || ^17 || ^18 || ^19 || ^20' },
npm warn EBADENGINE current: { node: 'v24.1.0', npm: '11.3.0' }
npm warn EBADENGINE }
npm warn EBADENGINE Unsupported engine {
npm warn EBADENGINE package: 'eslint-plugin-jsdoc@40.3.0',
npm warn EBADENGINE required: { node: '^14 || ^16 || ^17 || ^18 || ^19' },
npm warn EBADENGINE current: { node: 'v24.1.0', npm: '11.3.0' }
npm warn EBADENGINE }
npm error Exit handler never called!
npm error This is an error with npm itself. Please report this error at:
npm error https://github.com/npm/cli/issues
npm error A complete log of this run can be found in: /.npm/_logs/2025-05-29T10_00_00_507Z-debug-0.log

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f6fbe35 and 1b89de0.

📒 Files selected for processing (1)

• scripts/specCoverageReport.ts (2 hunks)

🧰 Additional context used

🪛 GitHub Actions: Spec coverage report

scripts/specCoverageReport.ts

[error] 358-358: Spec coverage report failed due to unknown spec item key 'RSC11b' found in tests' docstrings. This caused the command 'npm run speccoveragereport' to exit with code 1.

⏰ Context from checks skipped due to timeout of 90000ms (6)

• GitHub Check: test-node (20.x)
• GitHub Check: test-node (16.x)
• GitHub Check: test-node (18.x)
• GitHub Check: test-browser (firefox)
• GitHub Check: test-browser (webkit)
• GitHub Check: test-browser (chromium)

🔇 Additional comments (2)

scripts/specCoverageReport.ts (2)

5-5: LGTM: Import addition is necessary and correct.

The import of exit from the process module is required for the new error handling approach and follows Node.js best practices.

---

449-467: Excellent refactoring that achieves the PR objective.

The error handling refactoring successfully addresses the requirement to make the script fail on errors:

• Before: Errors were caught and logged but the script continued with exit code 0
• After: Errors are caught and the script exits with code 1, properly failing CI/CD pipelines

The approach using .catch() on the promise is cleaner than the previous try-catch pattern and ensures all unhandled promise rejections are caught. The pipeline failure log confirms this is working correctly - the script now properly detects and fails on the unknown spec item key 'RSC11b'.

The implementation follows Node.js best practices:

• Uses standard exit code 1 for failure
• Maintains helpful error logging
• Clean promise chain structure

✨ Finishing Touches

• 📝 Generate Docstrings

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[lawrence-forooghian]

Ah, will also fix the error that this has revealed

[lawrence-forooghian]

ably/specification#324 needs merging first