Add test coverage for Ably Pub/Sub

[mattheworiordan]

Summary by CodeRabbit

• New Features

  • Added comprehensive end-to-end and unit tests for connection-related CLI commands, including connection stats, testing, and live monitoring.
  • Introduced new configuration for code coverage reporting, enforcing minimum thresholds and supporting multiple output formats.

• Bug Fixes

  • Improved test setup and cleanup logic for better reliability and reduced test runtime.
  • Enhanced Docker-dependent tests to skip gracefully when Docker is unavailable.

• Chores

  • Added new scripts and dev dependencies for running and reporting test coverage.
  • Updated workspace and ignore configurations for improved build and test management.

• Refactor

  • Updated test helper scripts to use more robust and portable pattern matching and process control methods.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This change introduces comprehensive code coverage tooling and configuration to the project, including NYC (Istanbul) setup, new coverage-related scripts, and .gitignore updates. It also adds extensive new unit, integration, and end-to-end tests for CLI connection-related commands, enhances test setup and cleanup logic, and refines several test scripts for improved reliability and compatibility.

Changes

File(s)	Change Summary
.gitignore	Added /coverage/ to ignore coverage reports.
.nycrc.json	Added NYC (Istanbul) configuration for TypeScript coverage, reporters, thresholds, and exclusions.
package.json	Added test coverage scripts, NYC dependencies, removed posttest, and adjusted postinstall script syntax.
pnpm-workspace.yaml	Removed quotes from package globs and added ignoredBuiltDependencies key.
scripts/lint-test-paths.sh	Switched from Bash glob pattern matching to grep-based regex matching for test path checks.
scripts/run-tests.sh	Added --exit flag to Mocha runner to prevent hanging processes.
test/e2e/commands/connections.test.ts	New E2E test suite for CLI connection commands, covering stats, testing, error handling, performance, and live monitoring.
test/integration/commands/channels.test.ts	Added integration tests for connection stats and error recovery scenarios.
test/integration/docker-container-security.test.ts	Added Docker availability checks to conditionally skip tests and cleanup.
test/setup.ts	Refactored test client tracking and cleanup logic, removed verbose/debug logging, and simplified global cleanup.
test/unit/commands/channels/subscribe.test.ts	Refactored test helper to use SIGINT for lifecycle simulation and improved event mocking/cleanup.
test/unit/commands/connections/stats.test.ts	New unit tests for the ConnectionsStats command, covering stats retrieval, output formats, errors, and live mode.
test/unit/commands/connections/test.test.ts	New unit tests for the ConnectionsTest command, covering connection lifecycle, events, errors, and JSON output.
test/unit/commands/logs/connection-lifecycle/subscribe.test.ts	New unit tests for LogsConnectionLifecycleSubscribe, covering channel subscription, event handling, and output formats.
test/unit/commands/logs/connection/subscribe.test.ts	New unit tests for LogsConnectionSubscribe, covering log subscription, connection events, errors, and JSON output.

Sequence Diagram(s)

sequenceDiagram
    participant Tester
    participant CLI
    participant AblyAPI

    Tester->>CLI: Run connection stats/test/logs command
    CLI->>AblyAPI: Send API request (stats/test/logs)
    AblyAPI-->>CLI: Return response (stats/events)
    CLI-->>Tester: Output results (text/JSON)
    Note over CLI,Tester: For live monitoring, CLI subscribes to events and streams output until terminated

Loading

Possibly related PRs

• Initial test coverage #8: Introduced initial test coverage including unit, integration, and e2e tests, which aligns with this PR's focus on expanding and tooling test coverage for CLI commands.

Poem

🐇
A hop, a skip, some tests anew,
Coverage blooms where once it flew.
With NYC's watchful, metric eye,
Each command now dares to try—
Stats and logs, connections too,
All report what rabbits knew:
"A healthy codebase hops right through!"

---

📜 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 58c748b and dfb0f12.

⛔ Files ignored due to path filters (1)

• pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

📒 Files selected for processing (15)

• .gitignore (1 hunks)
• .nycrc.json (1 hunks)
• package.json (3 hunks)
• pnpm-workspace.yaml (1 hunks)
• scripts/lint-test-paths.sh (1 hunks)
• scripts/run-tests.sh (1 hunks)
• test/e2e/commands/connections.test.ts (1 hunks)
• test/integration/commands/channels.test.ts (1 hunks)
• test/integration/docker-container-security.test.ts (13 hunks)
• test/setup.ts (2 hunks)
• test/unit/commands/channels/subscribe.test.ts (1 hunks)
• test/unit/commands/connections/stats.test.ts (1 hunks)
• test/unit/commands/connections/test.test.ts (1 hunks)
• test/unit/commands/logs/connection-lifecycle/subscribe.test.ts (1 hunks)
• test/unit/commands/logs/connection/subscribe.test.ts (1 hunks)

✨ 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.