[PUB-1529] Update bitwise value for HAS_STATE flag

[VeskeR]

HAS_STATE flag was to moved to attach flags in https://github.com/ably/realtime/pull/7230

Resolves PUB-1529

Summary by CodeRabbit

• Refactor
  • Enhanced internal message flag management to improve system consistency and maintainability, paving the way for smoother future enhancements without impacting the user experience.

[coderabbitai]

Walkthrough

This change updates the bitwise assignment of the HAS_STATE flag in the protocol message type definition. The flag’s value is moved from 1 << 26 to 1 << 7, adjusting its bit position within the flags object while leaving all other flag values unchanged.

Changes

File	Change Summary
src/.../protocolmessage.ts	Updated HAS_STATE flag from 1 << 26 to 1 << 7 in the flags object

Assessment against linked issues

Objective	Addressed	Explanation
Update HAS_STATE is now an attach flag [PUB-1529]	✅

Poem

Oh, I'm a rabbit, so spry and keen,
Hopping through code in a meadow green.
I've moved a flag from high to low,
Letting the new attach flag glow.
Carrots and code—what a joyful scene!
🥕✨

---

📜 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 706d4ba and 1aa89e3.

📒 Files selected for processing (1)

• src/common/lib/types/protocolmessage.ts (1 hunks)

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

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

🔇 Additional comments (1)

src/common/lib/types/protocolmessage.ts (1)

53-53:

Details

❓ Verification inconclusive

Verify compatibility with existing code after flag value change

The HAS_STATE flag has been moved from position 1 << 26 to 1 << 7, changing its value from 67108864 to 128. This aligns with the PR description mentioning that the flag was moved to attach flags as part of a previous change in PR #7230.

Moving this flag from the "Channel mode flags" section (which start at bit 16) to be grouped with "Channel attach state flags" is a significant change that could impact compatibility with existing code that expects the old bit position.

---

🏁 Script executed:

#!/bin/bash
# Search for any direct uses of the numerical values corresponding to HAS_STATE
# Old value: 67108864 (1 << 26)
# New value: 128 (1 << 7)

echo "Checking for direct usages of the old numerical value (67108864)"
rg "67108864" --type ts --type js

echo "Checking for any potential direct bitwise operations with HAS_STATE"
rg "HAS_STATE.*\&|\&.*HAS_STATE" --type ts --type js

echo "Checking for tests that might need to be updated"
rg "HAS_STATE" --type test

Length of output: 535

---

Action: Verify Compatibility Impact of HAS_STATE Flag Change

The search results show no direct references to the old numerical value (67108864) or bitwise operations that might be affected by the update to 1 << 7 (128). However, the test file search did not complete due to an unrecognized file type for tests. Please manually verify that the tests correctly reflect this flag change and that no functionality is broken by the update. The key location is:

• File: src/common/lib/types/protocolmessage.ts (Line 53 – HAS_STATE: 1 << 7,)

✨ 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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