[ECO-4952] Start implementing room lifecycle spec #17
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is based on [1] at b4a495e. It’s generated some questions, which I’ve asked on that PR. Note that the spec has been through a few revisions since I started implementing this; I’ve tried to keep everything in sync but some older stuff might still be accidentally there. I’ve implemented most of the specified behaviour for the ATTACH, DETACH, and RELEASE operations. I have not yet implemented RETRY since it’s quite different to those three and I wanted to get eyes on this first chunk of work; have created ably-labs#51 for implementing it. Of the operations that I have implemented, I have not implemented the following (this is accurately reflected by the @SPEC… tags in the tests): - Lifecycle behaviour that relates to another ongoing operation (created ably-labs#52) - Lifecycle behaviour relating to “transient disconnect timeouts” (created ably-labs#48) - Lifecycle behaviour that occurs “asynchronously” outside an operation (created ably-labs#50) - CHA-RL1g2, which refers to emitting “discontinuity events” which are a concept not yet implemented; this will come in ably-labs#53. The room lifecycle manager introduced by this commit is currently a standalone object, which is not integrated with the rest of the SDK. I’ve created ably-labs#47 for doing this integration work. The @SPEC… tags are based on the on the JS rules [2] @ 8c9ce8b, but I camel-cased them and also decided that: - if a test doesn't relate to a spec point, it doesn't need any markers - there should be a way to know that a spec point is tested across multiple tests - there should be a way of marking a spec point as implemented but not tested (so that can show up differently in reporting; important given that we’re also going to use this report as a to-do list of what still needs to be implemented) Part of ably-labs#28. [1] ably/specification#200 [2] https://github.com/ably/ably-js/blob/main/CONTRIBUTING.md#tests-alignment-with-the-ably-features-specification
|
This is an experiment review for experiment Experiment configurationreview_config:
# User configuration for the review
# - benchmark - use the user config from the benchmark reviews
# - <value> - use the value directly
user_review_config:
enable_ai_review: true
enable_rule_comments: false
enable_complexity_comments: false
enable_security_comments: false
enable_tests_comments: false
enable_comment_suggestions: false
enable_functionality_review: false
enable_pull_request_summary: false
enable_review_guide: true
enable_approvals: false
ai_review_config:
# The model responses to use for the experiment
# - benchmark - use the model responses from the benchmark reviews
# - llm - call the language model to generate responses
model_responses:
comments_model: benchmark
comment_area_model: benchmark
comment_validation_model: benchmark
comment_suggestion_model: benchmark
complexity_model: benchmark
functionality_model: benchmark
security_model: benchmark
tests_model: benchmark
pull_request_summary_model: benchmark
review_guide_model: llm
overall_comments_model: benchmark
# The pull request dataset to run the experiment on
pull_request_dataset:
# Sourcery core examples:
- https://github.com/sourcery-ai/core/pull/4607
- https://github.com/sourcery-ai/core/pull/4631
- https://github.com/sourcery-ai/core/pull/4647
# CodeRabbit examples:
- https://github.com/2lambda123/-Orange-OpenSource-oorobot/pull/15
- https://github.com/2lambda123/galaxyproject-galaxy/pull/12
- https://github.com/a0v0/avtoolz/pull/79
- https://github.com/adityask98/Hotaru/pull/10
- https://github.com/agdas/vscode/pull/2
- https://github.com/agluszak/hirschgarten/pull/2
- https://github.com/alexsnow348/insightface/pull/46
- https://github.com/alikuxac/utilities/pull/10
- https://github.com/AlphaDev87/timba-api/pull/49
- https://github.com/AngeloTadeucci/Maple2/pull/239
- https://github.com/AngeloTadeucci/Maple2.File/pull/36
- https://github.com/AngeloTadeucci/Maple2/pull/233
# Examples where CodeRabbit does not generate diagrams
- https://github.com/baptisteArno/typebot.io/pull/1778
- https://github.com/btipling/foundations/pull/33
- https://github.com/btipling/foundations/pull/31
- https://github.com/chintu-777/jaeger/pull/1
- https://github.com/coji/remix-docs-ja/pull/55
- https://github.com/DaveMBush/SmartNgRX/pull/622
- https://github.com/DaveMBush/SmartNgRX/pull/481
- https://github.com/dkittle/party-connections/pull/6
- https://github.com/Drajad-Kusuma-Adi/onstudy-backend/pull/6
- https://github.com/imaami/libcanth/pull/2
# Requested by Tim
- https://github.com/2lambda123/-Orange-OpenSource-oorobot/pull/15
- https://github.com/2lambda123/galaxyproject-galaxy/pull/12
- https://github.com/a0v0/avtoolz/pull/79
- https://github.com/adityask98/Hotaru/pull/10
- https://github.com/agdas/vscode/pull/2
- https://github.com/agluszak/hirschgarten/pull/2
- https://github.com/4DNucleome/PartSeg/pull/1183
- https://github.com/ably/ably-cocoa/pull/1973
- https://github.com/ably-labs/ably-chat-swift/pull/54
- https://github.com/ably-labs/ably-chat-swift/pull/35
# A ton of new classes:
- https://github.com/sourcery-ai/core/pull/4618
# Including database changes to evaluate entity-relationship diagrams
- https://github.com/sourcery-ai/core/pull/4579
# TODO: find some with Alembic
# Brilliant existing examples:
- https://github.com/sourcery-ai/core/pull/4680
- https://github.com/sourcery-ai/core/pull/4684
# Questions to ask to label the review comments
review_comment_labels: []
# - label: correct
# question: Is this comment correct?
# Benchmark reviews generated by running
# python -m scripts.experiment benchmark <experiment_name>
benchmark_reviews:
- dataset_pull_request: https://github.com/sourcery-ai/core/pull/4607
review_pull_request: https://github.com/sourcery-ai-experiments/core/pull/374
- dataset_pull_request: https://github.com/sourcery-ai/core/pull/4631
review_pull_request: https://github.com/sourcery-ai-experiments/core/pull/375
- dataset_pull_request: https://github.com/sourcery-ai/core/pull/4647
review_pull_request: https://github.com/sourcery-ai-experiments/core/pull/376
- dataset_pull_request: https://github.com/2lambda123/-Orange-OpenSource-oorobot/pull/15
review_pull_request: https://github.com/sourcery-ai-experiments/-Orange-OpenSource-oorobot/pull/5
- dataset_pull_request: https://github.com/2lambda123/galaxyproject-galaxy/pull/12
review_pull_request: https://github.com/sourcery-ai-experiments/galaxyproject-galaxy/pull/13
- dataset_pull_request: https://github.com/adityask98/Hotaru/pull/10
review_pull_request: https://github.com/sourcery-ai-experiments/Hotaru/pull/14
- dataset_pull_request: https://github.com/agdas/vscode/pull/2
review_pull_request: https://github.com/sourcery-ai-experiments/vscode/pull/14
- dataset_pull_request: https://github.com/agluszak/hirschgarten/pull/2
review_pull_request: https://github.com/sourcery-ai-experiments/hirschgarten/pull/13
- dataset_pull_request: https://github.com/alikuxac/utilities/pull/10
review_pull_request: https://github.com/sourcery-ai-experiments/utilities/pull/4
- dataset_pull_request: https://github.com/AlphaDev87/timba-api/pull/49
review_pull_request: https://github.com/sourcery-ai-experiments/timba-api/pull/12
- dataset_pull_request: https://github.com/AngeloTadeucci/Maple2/pull/239
review_pull_request: https://github.com/sourcery-ai-experiments/Maple2/pull/23
- dataset_pull_request: https://github.com/AngeloTadeucci/Maple2.File/pull/36
review_pull_request: https://github.com/sourcery-ai-experiments/Maple2.File/pull/12
- dataset_pull_request: https://github.com/AngeloTadeucci/Maple2/pull/233
review_pull_request: https://github.com/sourcery-ai-experiments/Maple2/pull/24
- dataset_pull_request: https://github.com/baptisteArno/typebot.io/pull/1778
review_pull_request: https://github.com/sourcery-ai-experiments/typebot.io/pull/7
- dataset_pull_request: https://github.com/btipling/foundations/pull/33
review_pull_request: https://github.com/sourcery-ai-experiments/foundations/pull/13
- dataset_pull_request: https://github.com/btipling/foundations/pull/31
review_pull_request: https://github.com/sourcery-ai-experiments/foundations/pull/14
- dataset_pull_request: https://github.com/chintu-777/jaeger/pull/1
review_pull_request: https://github.com/sourcery-ai-experiments/jaeger/pull/7
- dataset_pull_request: https://github.com/coji/remix-docs-ja/pull/55
review_pull_request: https://github.com/sourcery-ai-experiments/remix-docs-ja/pull/7
- dataset_pull_request: https://github.com/DaveMBush/SmartNgRX/pull/622
review_pull_request: https://github.com/sourcery-ai-experiments/SmartNgRX/pull/13
- dataset_pull_request: https://github.com/DaveMBush/SmartNgRX/pull/481
review_pull_request: https://github.com/sourcery-ai-experiments/SmartNgRX/pull/14
- dataset_pull_request: https://github.com/dkittle/party-connections/pull/6
review_pull_request: https://github.com/sourcery-ai-experiments/party-connections/pull/7
- dataset_pull_request: https://github.com/Drajad-Kusuma-Adi/onstudy-backend/pull/6
review_pull_request: https://github.com/sourcery-ai-experiments/onstudy-backend/pull/7
- dataset_pull_request: https://github.com/imaami/libcanth/pull/2
review_pull_request: https://github.com/sourcery-ai-experiments/libcanth/pull/7
- dataset_pull_request: https://github.com/2lambda123/-Orange-OpenSource-oorobot/pull/15
review_pull_request: https://github.com/sourcery-ai-experiments/-Orange-OpenSource-oorobot/pull/6
- dataset_pull_request: https://github.com/2lambda123/galaxyproject-galaxy/pull/12
review_pull_request: https://github.com/sourcery-ai-experiments/galaxyproject-galaxy/pull/14
- dataset_pull_request: https://github.com/adityask98/Hotaru/pull/10
review_pull_request: https://github.com/sourcery-ai-experiments/Hotaru/pull/15
- dataset_pull_request: https://github.com/agdas/vscode/pull/2
review_pull_request: https://github.com/sourcery-ai-experiments/vscode/pull/15
- dataset_pull_request: https://github.com/agluszak/hirschgarten/pull/2
review_pull_request: https://github.com/sourcery-ai-experiments/hirschgarten/pull/14
- dataset_pull_request: https://github.com/4DNucleome/PartSeg/pull/1183
review_pull_request: https://github.com/sourcery-ai-experiments/PartSeg/pull/7
- dataset_pull_request: https://github.com/ably/ably-cocoa/pull/1973
review_pull_request: https://github.com/sourcery-ai-experiments/ably-cocoa/pull/6
- dataset_pull_request: https://github.com/ably-labs/ably-chat-swift/pull/54
review_pull_request: https://github.com/sourcery-ai-experiments/ably-chat-swift/pull/11
- dataset_pull_request: https://github.com/ably-labs/ably-chat-swift/pull/35
review_pull_request: https://github.com/sourcery-ai-experiments/ably-chat-swift/pull/12
- dataset_pull_request: https://github.com/sourcery-ai/core/pull/4579
review_pull_request: https://github.com/sourcery-ai-experiments/core/pull/377
|
Reviewer's Guide by SourceryThis pull request implements the initial room lifecycle management functionality for the Ably Chat SDK. It introduces a Class diagram for RoomLifecycleManager and related componentsclassDiagram
class RoomLifecycleManager {
+RoomLifecycleManager(contributors: [Contributor], logger: InternalLogger, clock: SimpleClock)
+performAttachOperation() async throws
+performDetachOperation() async throws
+performReleaseOperation() async
+onChange(bufferingPolicy: BufferingPolicy) -> Subscription<RoomStatusChange>
-changeStatus(to: RoomLifecycle, error: ARTErrorInfo?)
-detachNonFailedContributors() async
-emitStatusChange(change: RoomStatusChange)
-current: RoomLifecycle
-error: ARTErrorInfo?
-contributors: [Contributor]
-logger: InternalLogger
-clock: SimpleClock
-subscriptions: [Subscription<RoomStatusChange>]
}
class Contributor {
+feature: RoomFeature
+channel: RoomLifecycleContributorChannel
}
class RoomLifecycleContributorChannel {
<<protocol>>
+attach() async throws(ARTErrorInfo)
+detach() async throws(ARTErrorInfo)
+state: ARTRealtimeChannelState { get async }
+errorReason: ARTErrorInfo? { get async }
}
class RoomFeature {
<<enum>>
+messages
+presence
+reactions
+occupancy
+typing
}
RoomLifecycleManager --> Contributor
Contributor --> RoomLifecycleContributorChannel
Contributor --> RoomFeature
Class diagram for ErrorCode and ChatErrorclassDiagram
class ErrorCode {
<<enum>>
+inconsistentRoomOptions: Int
+messagesAttachmentFailed: Int
+presenceAttachmentFailed: Int
+reactionsAttachmentFailed: Int
+occupancyAttachmentFailed: Int
+typingAttachmentFailed: Int
+messagesDetachmentFailed: Int
+presenceDetachmentFailed: Int
+reactionsDetachmentFailed: Int
+occupancyDetachmentFailed: Int
+typingDetachmentFailed: Int
+roomInFailedState: Int
+roomIsReleasing: Int
+roomIsReleased: Int
+statusCode: Int
}
class ChatError {
+inconsistentRoomOptions(requested: RoomOptions, existing: RoomOptions)
+attachmentFailed(feature: RoomFeature, underlyingError: ARTErrorInfo)
+detachmentFailed(feature: RoomFeature, underlyingError: ARTErrorInfo)
+roomInFailedState
+roomIsReleasing
+roomIsReleased
+code: ErrorCode
+localizedDescription: String
+cause: ARTErrorInfo?
}
ChatError --> ErrorCode
ChatError --> RoomFeature
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
SourceryAI
reviewed
Sep 30, 2024
There was a problem hiding this comment.
Hey @ruancomelli - I've reviewed your changes - here's some feedback:
Overall Comments:
- Resolve spec questions before merging to ensure alignment with the final specification.
- Review and finalize error codes and status codes to prevent future discrepancies.
- Consider refactoring the RoomLifecycleManager to improve maintainability and modularity.
Here's what I looked at during the review
- 🟡 General issues: 1 issue found
- 🟡 Documentation: 2 issues found
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| // TODO: Make this not trap in the case where the Task is cancelled (as part of the broader https://github.com/ably-labs/ably-chat-swift/issues/29 for handling task cancellation) | ||
| // TODO: what's the correct wait time? (https://github.com/ably/specification/pull/200#discussion_r1763822207) | ||
| // swiftlint:disable:next force_try | ||
| try! await clock.sleep(timeInterval: 1) |
There was a problem hiding this comment.
suggestion (bug_risk): Avoid force unwrapping and handle potential errors
Force unwrapping can lead to runtime crashes. Consider using optional binding or throwing functions to handle potential errors safely. This will make the code more robust and less prone to unexpected crashes.
| When writing a test that relates to a spec point from the Chat SDK features spec, add a comment that contains one of the following tags: | ||
|
|
||
| - `@spec <spec-item-id>` — The test case directly tests all the functionality documented in the spec item. | ||
| - `@specOneOf(m/n) <spec-item-id>` — The test case is the m<sup>th</sup> of n test cases which, together, test all the functionality documented in the spec item. |
There was a problem hiding this comment.
suggestion (documentation): Replace Markdown superscript syntax with plain text
The superscript syntax 'th' won't render correctly in plain text. Consider using 'mth' instead.
| - `@specOneOf(m/n) <spec-item-id>` — The test case is the m<sup>th</sup> of n test cases which, together, test all the functionality documented in the spec item. | ||
| - `@specPartial <spec-item-id>` — The test case tests some, but not all, of the functionality documented in the spec item. This is different to `@specOneOf` in that it implies that the test suite does not fully test this spec item. | ||
|
|
||
| The `<spec-item-id>` parameter should be a spec item identifier such as `CHA-RL3g`. |
There was a problem hiding this comment.
suggestion (documentation): Standardize terminology: 'spec point' vs 'spec item'
The document uses both 'spec point' and 'spec item'. Consider standardizing on one term for consistency throughout the document.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Note: This PR is based on top of ably-labs#72; please review that one first.
This is based on ably/specification#200 at
b4a495e. It’s generated some questions, which I’ve asked on that PR.Note that the spec has been through a few revisions since I started implementing this; I’ve tried to keep everything in sync but some older stuff might still be accidentally there.
I’ve implemented most of the specified behaviour for the
ATTACH,DETACH, andRELEASEoperations. I have not yet implementedRETRYsince it’s quite different to those three and I wanted to get eyes on this first chunk of work; have created ably-labs#51 for implementing it.Of the operations that I have implemented, I have not implemented the following (this is accurately reflected by the
@spec…tags in the tests):RETRYoperation where spec says to ably-labs/ably-chat-swift#50)The room lifecycle manager introduced by this commit is currently a standalone object, which is not integrated with the rest of the SDK. I’ve created ably-labs#47 for doing this integration work.
The
@spec…tags are based on the on the JS rules @8c9ce8b, but I camel-cased them and also decided that:Part of ably-labs#28.
Summary by CodeRabbit
Summary by CodeRabbit
New Features
RoomLifecycleManagerto manage chat room contributor states effectively.SimpleClockprotocol to facilitate asynchronous task management in testing.RoomLifecycleContributorChannelfor testing purposes.Bug Fixes
Tests
RoomLifecycleManagerto ensure robust lifecycle management of chat rooms.