Add a deprecation warning environment, restHost and realtimeHost client options

[VeskeR]

These client options have been deprecated in #1973 if favor of the new ClientOptions.endpoint parameter. They were marked as deprecated only in the type declaration file, meaning that non-TypeScript users wouldn't see the deprecation warning. This PR adds an explicit deprecation warning log message when using these deprecated client options.

Even though the mentioned PR added the function to check that the valid combination of endpoint, environment, restHost and realtimeHost options is used, it only informs the user about invalid combinations of options, and does not specify that old options are now deprecated:

ably-js/src/common/lib/util/defaults.ts

Lines 250 to 270 in 6f2b7e6

	function checkIfClientOptionsAreValid(options: ClientOptions) {
	// REC1b
	if (options.endpoint && (options.environment || options.restHost || options.realtimeHost)) {
	// RSC1b
	throw new ErrorInfo(
	'The `endpoint` option cannot be used in conjunction with the `environment`, `restHost`, or `realtimeHost` options.',
	40106,
	400,
	);
	}
	// REC1c
	if (options.environment && (options.restHost || options.realtimeHost)) {
	// RSC1b
	throw new ErrorInfo(
	'The `environment` option cannot be used in conjunction with the `restHost`, or `realtimeHost` options.',
	40106,
	400,
	);
	}
	}

The log message added in this PR is consistent with how we handled deprecated options when going from v1 to v2 ably-js release. For example, see #1681.

Summary by CodeRabbit

• Refactor
  • Improved the handling of deprecated options by ensuring deprecation warnings are logged before validating configuration options.

[coderabbitai]

Walkthrough

The order of operations in the normaliseOptions function was adjusted so that deprecation warnings for certain options are logged before the validation function is called. No changes were made to function signatures or the overall logic beyond this reordering.

Changes

File	Change Summary
src/common/lib/util/defaults.ts	Moved deprecation warning logs before the options validation call in normaliseOptions.

Poem

A shuffle in the order, a hop before the check,
Warnings now come early, before we validate the spec.
Deprecated words whispered, before rules are applied,
In the code’s quiet meadow, logic and logs coincide.
🐇✨

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.2.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.2.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-06-24T19_47_52_521Z-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 6f2b7e6 and 70f678d.

📒 Files selected for processing (1)

• src/common/lib/util/defaults.ts (1 hunks)

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

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

🔇 Additional comments (2)

src/common/lib/util/defaults.ts (2)

279-288: LGTM! Well-implemented deprecation warnings.

The deprecation warnings are properly implemented with clear messaging and appropriate alternatives. The logic correctly checks each deprecated option and uses the logger's deprecated method consistently.

---

290-290: Good UX improvement by reordering validation.

Moving the validation call after deprecation warnings improves the user experience - users will see deprecation warnings before potentially hitting validation errors. This ordering makes sense since deprecation warnings are informational while validation errors are blocking.

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate Unit Tests

• Create PR with Unit Tests
• Post Copyable Unit Tests in Comment
• Commit Unit Tests in branch deprecation-message-for-endpoint-parameters

---

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 auto-generate unit tests to generate unit tests for 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.

[ttypic]

LGTM