Refactor package structure #210
Conversation
WalkthroughThe primary change involves refactoring the handling of presence information within the Yorkie project. Presence-related classes and imports have been moved from the Changes
Poem
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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 as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (13)
- examples/texteditor/src/main/java/com/example/texteditor/EditorViewModel.kt (1 hunks)
- yorkie/src/androidTest/kotlin/dev/yorkie/core/PresenceTest.kt (1 hunks)
- yorkie/src/androidTest/kotlin/dev/yorkie/document/json/JsonTreeTest.kt (2 hunks)
- yorkie/src/main/kotlin/dev/yorkie/api/ElementConverter.kt (2 hunks)
- yorkie/src/main/kotlin/dev/yorkie/api/PresenceConverter.kt (1 hunks)
- yorkie/src/main/kotlin/dev/yorkie/core/Client.kt (1 hunks)
- yorkie/src/main/kotlin/dev/yorkie/document/Document.kt (2 hunks)
- yorkie/src/main/kotlin/dev/yorkie/document/change/Change.kt (1 hunks)
- yorkie/src/main/kotlin/dev/yorkie/document/change/ChangeContext.kt (1 hunks)
- yorkie/src/main/kotlin/dev/yorkie/document/presence/Presence.kt (1 hunks)
- yorkie/src/main/kotlin/dev/yorkie/document/presence/Presences.kt (1 hunks)
- yorkie/src/test/kotlin/dev/yorkie/api/ConverterTest.kt (2 hunks)
- yorkie/src/test/kotlin/dev/yorkie/core/ClientTest.kt (1 hunks)
Files skipped from review due to trivial changes (3)
- yorkie/src/main/kotlin/dev/yorkie/api/PresenceConverter.kt
- yorkie/src/main/kotlin/dev/yorkie/core/Client.kt
- yorkie/src/main/kotlin/dev/yorkie/document/change/Change.kt
Additional comments not posted (14)
yorkie/src/main/kotlin/dev/yorkie/document/presence/Presence.kt (2)
1-1: Package Declaration CorrectnessThe package declaration
package dev.yorkie.document.presencealigns with the PR's objective of restructuring presence-related classes. This is a good practice for maintaining a modular and organized codebase.
Line range hint
1-22: Class Definition and Method ImplementationThe
Presenceclass and its methodsputandclearare well-defined. The use ofinternalvisibility forPresenceChangeensures encapsulation within the module. The methods manipulate the presence data and register changes using theChangeContext, which is a clean and effective way to handle state changes.
[APROVED]yorkie/src/main/kotlin/dev/yorkie/document/presence/Presences.kt (2)
1-1: Package Declaration CorrectnessThe package declaration
package dev.yorkie.document.presenceis correct and reflects the new structure intended by the PR.
Line range hint
1-40: Class Definition and Method ImplementationThe
Presencesclass and its methods are well-implemented. The use of theMapdelegation (by map) is a Kotlin idiomatic way to provide map functionalities directly through thePresencesclass, enhancing code readability and maintainability.yorkie/src/main/kotlin/dev/yorkie/document/change/ChangeContext.kt (2)
8-8: Import Statement UpdateThe import statement
import dev.yorkie.document.presence.PresenceChangecorrectly reflects the new package structure. This ensures that theChangeContextclass can properly utilize thePresenceChangeclass.
Line range hint
8-56: Class Functionality and StructureThe
ChangeContextclass is well-structured. It effectively handles operations and presence changes, ensuring that all modifications are tracked and can be reverted or committed as needed. The methods are clear and perform their intended functions without unnecessary complexity.examples/texteditor/src/main/java/com/example/texteditor/EditorViewModel.kt (2)
15-15: Import Statement UpdateThe import statement
import dev.yorkie.document.presence.PresenceInfois updated to reflect the new package structure, ensuring theEditorViewModelclass can correctly utilize thePresenceInfodata class.
Line range hint
15-98: Class Functionality and ImplementationThe
EditorViewModelclass is robust, handling various aspects of text editing and presence management efficiently. The methods are well-organized, and the class leverages Kotlin's coroutines for asynchronous tasks, which is suitable for the operations it performs.yorkie/src/test/kotlin/dev/yorkie/core/ClientTest.kt (1)
29-29: Import Update: Correctly updated to new package.The import for
PresenceChangehas been updated to reflect the new package structure. This change aligns with the PR's objective of restructuring presence-related classes.yorkie/src/test/kotlin/dev/yorkie/api/ConverterTest.kt (1)
42-42: Import Update: Correctly updated to new package.The import for
PresenceChangehas been updated to reflect the new package structure. This change aligns with the PR's objective of restructuring presence-related classes.yorkie/src/main/kotlin/dev/yorkie/api/ElementConverter.kt (1)
49-49: Import Update: Correctly updated to new package.The import for
Phas been updated to reflect the new package structure. This change aligns with the PR's objective of restructuring presence-related classes.yorkie/src/main/kotlin/dev/yorkie/document/Document.kt (1)
21-27: Updated import statements align with new package structure.The import statements for presence-related classes have been correctly updated to reflect their new location under
dev.yorkie.document.presence. This change is consistent with the PR's objective of aligning with the JavaScript SDK structure.yorkie/src/androidTest/kotlin/dev/yorkie/core/PresenceTest.kt (1)
11-11: Approved: Updated import statement forPresenceInfo.The import statement for
PresenceInfohas been correctly updated to reflect its new package location. Ensure that any other code or files that depend onPresenceInfoare also updated accordingly.yorkie/src/androidTest/kotlin/dev/yorkie/document/json/JsonTreeTest.kt (1)
25-25: Updated import statement to reflect new package structure.The import statement for
Presencehas been updated to reflect its new location underdev.yorkie.document.presence, aligning with the project's restructured package organization.
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (3)
- docker/docker-compose-ci.yml (1 hunks)
- docker/docker-compose.yml (1 hunks)
- yorkie/src/androidTest/kotlin/dev/yorkie/TestAnnotations.kt (1 hunks)
Files skipped from review due to trivial changes (3)
- docker/docker-compose-ci.yml
- docker/docker-compose.yml
- yorkie/src/androidTest/kotlin/dev/yorkie/TestAnnotations.kt
What this PR does / why we need it?
Move presence-related classes to the
presencepackage, aligning with the JS SDK structure.Any background context you want to provide?
What are the relevant tickets?
Fixes #
Checklist
Summary by CodeRabbit
Chores
yorkieservice from0.4.22to0.4.24.Tests
TooManyRequestsExceptionin JsonTree-related tests.