Skip to content

Update supported node version and rename cdn - #2332

Open
ttypic wants to merge 3 commits into
integration/react-renamefrom
integration/bump-node-cdn
Open

ttypic wants to merge 3 commits into
integration/react-renamefrom
integration/bump-node-cdn

Conversation

@ttypic

@ttypic ttypic commented Oct 27, 2026 •

Copy link
Copy Markdown
Contributor

Summary by CodeRabbit

  • Breaking Changes
    • The minimum supported Node.js version is now 22 for the packages and their development workflows.
    • The CDN bundle is exposed as AblyPubSub instead of Ably. Create clients with AblyPubSub.createClient.
    • The CDN bundle represents the device package; server-side clients require the server package.
  • Documentation
    • Updated the migration guide and CDN examples to reflect the Node.js requirement and CDN usage changes.

ttypic and others added 3 commits October 27, 2026 12:13
Node.js 20 has reached end of life, so raise engines.node from >=16
to >=22 in the root and in the core, device and server packages. Node
22 is the oldest release line still in long-term support.

- Run the Node test matrices on 22.x and 24.x, and every other
  workflow on 22.x
- Drop the npm ci --ignore-scripts workaround that only existed to
  keep the Node 16 leg installing
- Note the new requirement in the v3 migration guide

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
The CDN bundle is now @ably/pubsub-device and exposes createClient
rather than the client classes, so name its global after the package
family instead of keeping the old Ably name. The file names and URLs
are unchanged. The push and LiveObjects plugin globals keep their
names.

Show the global in the README's CDN example, and cover the rename in
the v3 migration guide.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@ttypic
ttypic requested a review from VeskeR October 27, 2026 12:16
@coderabbitai

coderabbitai Bot commented Oct 27, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review.

Recent review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 1c938393-cdf3-4fcd-bd89-83c01c9aecb5
Commits

Reviewing files that changed from the base of the PR and between 36e71d3 and 944cf5f.

Files ignored due to path filters: 1
  • package-lock.json is excluded by !**/package-lock.json
Files selected for processing: 18
  • .github/workflows/bundle-report.yml
  • .github/workflows/check.yml
  • .github/workflows/docs.yml
  • .github/workflows/publish-cdn.yml
  • .github/workflows/react.yml
  • .github/workflows/spec-coverage-report.yml
  • .github/workflows/test-browser.yml
  • .github/workflows/test-node-uts.yml
  • .github/workflows/test-node.yml
  • .github/workflows/test-package.yml
  • README.md
  • docs/migration-guides/v3/lib.md
  • grunt/esbuild/build.js
  • package.json
  • packages/core/package.json
  • packages/core/types.d.ts
  • packages/device/package.json
  • packages/server/package.json

Included review availability: This review used your included allowance. Your plan provides up to 2 included reviews per hour; 1 remain after this review.

Walkthrough

The pull request raises the declared minimum Node.js version to 22, updates CI Node.js versions, renames the CDN global to AblyPubSub, and changes the documented and declared name of an Auth.requestToken parameter.

Changes

Compatibility updates

Layer / File(s) Summary
Node.js requirements and CI
.github/workflows/*, package.json, packages/*/package.json
The root and package engine requirements change to Node.js >=22. CI workflows use Node.js 22.x, and the Node.js test matrices use 22.x and 24.x. The Node.js test workflow now runs install scripts during npm ci.
CDN global and migration guidance
grunt/esbuild/build.js, README.md, docs/migration-guides/v3/lib.md
The CDN bundle’s UMD library name changes to AblyPubSub. The README and migration guide use the new global and client creation method. The README identifies the CDN bundle as the device build.
Auth parameter declaration
packages/core/types.d.ts
The Auth.requestToken parameter name and its documentation change to tokenParams. Its type, optionality, and return type remain unchanged.

Priority: Normal

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Suggested reviewers: vesker, umair-ably

Merge Risk: Minimal · up to 944cf

No actionable merge-blocking risk is established by the reviewed changes.

Pre-merge checks: Passed 5
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title accurately summarizes the two primary changes: raising the supported Node.js version and renaming the CDN global.
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Documentation-only edits and deletions within survi…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 2 files. (16 skipped: 16 unsupported.)

Finishing Touches
📝 Generate docstrings
  • Commit to this branch
  • Create a new PR
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • 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

A rabbit checks the Node version with care,
Then finds AblyPubSub waiting there.
It nibbles a leaf beside the build,
While fresh migration notes are filled.
And hops away, its checklist sealed.

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

@VeskeR VeskeR left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM, one small note about CDN url for v3

Comment thread README.md
@@ -73,10 +73,15 @@ You can also source the SDK directly in your HTML. (This url will point to the l

```html
<script src="https://cdn.ably.com/lib/ably.min-2.js"></script>

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

this should change to
<script src="https://cdn.ably.com/lib/ably.min-3.js"></script>

for v3 integration branch - also check any other places we might mention cdn url

This branch was successfully deployed

3 active deployments
staging/pull/2332/typedoc — 944cf5f9 Deployed Oct 27, 2026 by github-actions[bot]
staging/pull/2332/features — 944cf5f9 Deployed Oct 27, 2026 by github-actions[bot]
staging/pull/2332/bundle-report — 944cf5f9 Deployed Oct 27, 2026 by github-actions[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants