Skip to content

Conversation

franrob-projects
Copy link
Contributor

@franrob-projects franrob-projects commented Sep 16, 2025

ably-js page unload behaviour

  • Add browser page unload behavior documentation for ably-js.

How to adjust the realtimeRequestTimeout to a higher value (on ably-js)

  • Added realtimeRequestTimeout configuration option - New 10,000ms default timeout setting for realtime.

Why is my Ably realtime connection sometimes disconnecting and reconnecting?

  • Added explanation of normal Ably infrastructure disconnections (autoscaling, rebalancing, deployments) with automatic SDK reconnection and state recovery.

Should I monitor for non-2xx network requests to identify issues?

  • Documents proper error detection using SDK mechanisms (connection/channel state changes, logs) and warns against monitoring HTTP status codes which can be misleading.

Will I receive an error if a client publishes with the connection in the Failed, Disconnected or Suspended states?

  • Enhanced descriptions for disconnected, suspended, closing, closed, and failed states with specific error codes and publishing behavior details.

Can I change my connection's clientId after connecting?

  • Explains that clientId cannot be changed once set, with details on late initialization scenarios for authCallback and opaque token processing.

How can I use ably-js session recovery over a page reload when I have multiple SDK instances for the same origin?

  • Documents sessionStorage key collision issues and provides solution for managing independent recovery keys across multiple ably-js instances on the same origin.

Why am I seeing every message multiple times?

  • Documents common causes (multiple SDK instances, duplicate subscriptions) with code examples and solutions, plus notes on known bugs in specific ably-java versions.

CORB blocked cross-origin response error when using ably-js from a contentScript scope in a Chrome extension in Chrome 73+

  • Documents CORB (Cross-Origin Resource Blocking) issues in Chrome 73+ and provides solutions including background script usage and WebSocket-only transport workarounds.

Why are my concurrent connection counts higher than expected?

  • Documents common causes (server-side Realtime usage, multiple SDK instances, browser tabs) with solutions and monitoring steps for connection count issues.

SSL certificate issues communicating with Ably

  • Documents common SSL certificate errors, root causes (outdated CA certificates), and provides platform-specific solutions for updating root certificates and language-specific fixes

ClassNotFoundException when using Proguard with ably-java

  • Documents ClassNotFoundException issues with code obfuscation and provides ProGuard keep rules to preserve Ably and MessagePack classes from being removed.

Using ably-js-react native, connection attempts or rest requests appear to timeout immediately

  • removed

Is it necessary to implement auto-renewal of tokens when using Token Auth?

  • Added documentation explaining Ably SDK's automatic token renewal system, including the 30-second renewal timing.

Is it possible to dynamically change the channels a user has access to without disconnecting?

  • Added documentation for dynamic channel access control, explaining how to use the authorize() method to change user permissions without disconnecting.

Do you have a max TTL for tokens?

  • Specifies maximum time-to-live limits for access tokens (24 hours), device tokens (5 years), and revocable tokens (1 hour) with error code reference.

remove When I try installing ably-js with npm, I get Error while executing: /usr/bin/git ls-remote -h -t

  • Removed commit for later discussion with team.

remove https://github.com/ably-forks/msgpack-js.git

  • Removed commit for later discussion with team.

Tidy up commit


Redirects: General FAQ

FAQ: https://faqs.ably.com/realtime-api-and-client-libraries

Jira: EDU-2073

Copy link

coderabbitai bot commented Sep 16, 2025

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch EDU-2073-remove-realtime-api-and-client-libraries-section-of-faqs

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
🧪 Early access (Sonnet 4.5): enabled

We are currently testing the Sonnet 4.5 model, which is expected to improve code review quality. However, this model may lead to increased noise levels in the review comments. Please disable the early access features if the noise level causes any inconvenience.

Note:

  • Public repositories are always opted into early access features.
  • You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.

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

@franrob-projects franrob-projects force-pushed the EDU-2073-remove-realtime-api-and-client-libraries-section-of-faqs branch 4 times, most recently from 873d23f to 2e93f88 Compare September 17, 2025 11:55
@franrob-projects franrob-projects added the review-app Create a Heroku review app label Sep 17, 2025
@ably-ci ably-ci temporarily deployed to ably-docs-edu-2073-remo-ldtbb4 September 17, 2025 14:30 Inactive
@franrob-projects franrob-projects changed the title Edu 2073 remove realtime api and client libraries section of faqs Edu 2073 Remove Realtime API faqs Sep 17, 2025
@franrob-projects franrob-projects temporarily deployed to ably-docs-edu-2073-remo-ldtbb4 September 17, 2025 15:06 Inactive
…the Failed, Disconnected or Suspended states?
… multiple SDK instances for the same origin?
…ntentScript scope in a Chrome extension in Chrome 73+
@franrob-projects franrob-projects force-pushed the EDU-2073-remove-realtime-api-and-client-libraries-section-of-faqs branch from 2f3b65f to ac17e04 Compare September 17, 2025 15:12
@franrob-projects franrob-projects temporarily deployed to ably-docs-edu-2073-remo-ldtbb4 September 17, 2025 15:12 Inactive
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds comprehensive FAQ documentation to the Ably docs covering common issues with the Realtime API and client libraries. The purpose is to migrate and expand frequently asked questions from external sources into the main documentation.

  • Adds troubleshooting guides for connection issues, SSL certificates, and duplicate messages
  • Documents authentication behavior including token renewal and dynamic access control
  • Provides configuration guidance for browser environments and multiple SDK instances

Reviewed Changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.

Show a summary per file
File Description
src/pages/docs/platform/pricing/faqs.mdx Adds FAQ about high concurrent connection counts with troubleshooting steps
src/pages/docs/platform/errors/index.mdx Adds monitoring best practices and SSL certificate troubleshooting
src/pages/docs/getting-started/setup.mdx Minor formatting - adds blank lines after code blocks
src/pages/docs/connect/states.mdx Documents system disconnections and enhanced connection state descriptions
src/pages/docs/connect/index.mdx Adds browser page unload behavior documentation
src/pages/docs/channels/index.mdx Adds troubleshooting section for duplicate message issues
src/pages/docs/auth/token.mdx Documents token renewal timing, TTL limits, and dynamic access control
src/pages/docs/auth/identified-clients.mdx Documents clientId immutability rules
content/partials/types/_realtime_client_options.textile Adds realtimeRequestTimeout configuration option

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@franrob-projects franrob-projects marked this pull request as ready for review September 18, 2025 08:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
review-app Create a Heroku review app
Development

Successfully merging this pull request may close these issues.

2 participants