Room lifecycle in progress flag

[AndyTWF]

Context

Closes #406
CHA-723

Description

We weren't properly setting and unsetting the room operation in progress flag (we were only setting it to false when attaching). This change rectifies this.

Also included is the fix for async-mutex operation precedence - as the order was the wrong way around.

Checklist

• QA'd by the author.
• Unit tests created (if applicable).
• Integration tests created (if applicable).
• Follow coding style guidelines found here.
• TypeDoc updated (if applicable).
• (Optional) Update documentation for new features.
• Browser tests created (if applicable).
• In repo demo app updated (if applicable).

Testing Instructions (Optional)

N/A

[coderabbitai]

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.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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

[github-actions]

Coverage Report

Status	Category	Percentage	Covered / Total
🟢	Lines	93.62% (🎯 92%)	3171 / 3387
🟢	Statements	93.62% (🎯 92%)	3171 / 3387
🟢	Functions	95.34% (🎯 92%)	246 / 258
🟢	Branches	93.86% (🎯 93%)	841 / 896

File Coverage

File	Stmts	Branches	Functions	Lines	Uncovered Lines
Changed Files
src/core/room-lifecycle-manager.ts	91.39%	93.67%	94.73%	91.39%	156-158, 236-239, 339, 387-388, 416-420, 443-451, 466-467, 522-523, 754-757, 812-830

Generated in workflow #1814 for commit c0becec by the Vitest Coverage Report Action

[sacOO7]

Can we add a private method to avoid code repetition

  atomic(operation: () => Promise<void>, priority: number): Promise<void> {
      return this._mtx.runExclusive(() => {
        this._operationInProgress = true
        return operation().finally(() =>
          this._operationInProgress = false
        )
      }, priority);
  }

So, attach and all other ops would be

  attach(): Promise<void> {
    this._logger.trace('RoomLifecycleManager.attach();');
    return this.atomic(async () => {

[AndyTWF]

Can we add a private method to avoid code repetition

We can in the future - though I'd prefer to keep this PR scoped to just the functionality fixes for now.

[sacOO7]

Can we add a private method to avoid code repetition

We can in the future - though I'd prefer to keep this PR scoped to just the functionality fixes for now.

Sure, I mean, the suggestion is related to the fix. In the future, if we have more atomic operations, we don't need to worry about setting/clearing _operationInProgress flag, as a part of operation itself.

[AndyTWF]

Can we add a private method to avoid code repetition

We can in the future - though I'd prefer to keep this PR scoped to just the functionality fixes for now.

Sure, I mean, the suggestion is related to the fix. In the future, if we have more atomic operations, we don't need to worry about setting/clearing _operationInProgress flag, as a part of operation itself.

There are places

Can we add a private method to avoid code repetition

We can in the future - though I'd prefer to keep this PR scoped to just the functionality fixes for now.

Sure, I mean, the suggestion is related to the fix. In the future, if we have more atomic operations, we don't need to worry about setting/clearing _operationInProgress flag, as a part of operation itself.

The place I don't think it works is in the attach cycle - the attach operation ends (and should fail fast back to the user), but we need to continue the lifecycle operation in the background to retry, so in this instance we don't want to tie the lifecycle op to the attach call but to what happens in the background afterwards.

[sacOO7]

Sure, thanks for the info!

[splindsay-92]

LGTM