Use typeOf instead as key of KClass in InstanceKeeper#getOrCreate

[arkivanov]

Summary by CodeRabbit

• Enhancements

  • Improved instance management logic for more precise instance creation and retrieval.

• Testing

  • Updated test cases to ensure correct behavior with new instance management logic.

[coderabbitai]

Walkthrough

The recent changes to the InstanceKeeper class and its associated tests involve altering the way instances are keyed and managed. Specifically, the key for storing instances has been updated from using T::class to typeOf<T>(). This impacts both the getOrCreate and getOrCreateSimple methods, ensuring more precise instance management. Corresponding test cases have been updated to validate the new keying mechanism, covering various scenarios of instance creation and retrieval.

Changes

Files	Change Summary
instance-keeper/src/commonMain/kotlin/com/arkivanov/essenty/instancekeeper/InstanceKeeperExt.kt	Updated instance keying from T::class to typeOf<T>() in getOrCreate and getOrCreateSimple methods.
instance-keeper/src/commonTest/kotlin/com/arkivanov/essenty/instancekeeper/InstanceKeeperExtTest.kt	Added new test cases to cover scenarios with different keys and types, ensuring correct instance management.

In code's vast realm, a change took flight,
From T::class to typeOf<T>(), a shift so bright.
Instances kept with a keener eye,
Ensuring uniqueness as time goes by.
Tests evolved to match the pace,
In this keeper's tale, a smoother grace.
🌟

---

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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.

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)

• @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 full the 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 help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

[coderabbitai]

Actionable comments posted: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e1014b8 and ed1d623.

Files selected for processing (2)

• instance-keeper/src/commonMain/kotlin/com/arkivanov/essenty/instancekeeper/InstanceKeeperExt.kt (3 hunks)
• instance-keeper/src/commonTest/kotlin/com/arkivanov/essenty/instancekeeper/InstanceKeeperExtTest.kt (2 hunks)

Additional comments not posted (10)

instance-keeper/src/commonMain/kotlin/com/arkivanov/essenty/instancekeeper/InstanceKeeperExt.kt (2)

23-26: Change to use typeOf<T>() as a key is correctly implemented.

---

39-45: Change to use typeOf<T>() as a key in getOrCreateSimple is correctly implemented.

instance-keeper/src/commonTest/kotlin/com/arkivanov/essenty/instancekeeper/InstanceKeeperExtTest.kt (8)

13-15: Test for getOrCreate with the same key returning the same instance is correctly implemented.

---

21-25: Test for getOrCreate with different keys returning a new instance is correctly implemented.

---

29-31: Test for getOrCreate with the same type returning the same instance is correctly implemented.

---

37-41: Test for getOrCreate with different types returning a new instance is correctly implemented.

---

45-47: Test for getOrCreateSimple with the same key returning the same instance is correctly implemented.

---

53-57: Test for getOrCreateSimple with different keys returning a new instance is correctly implemented.

---

61-63: Test for getOrCreateSimple with the same type returning the same instance is correctly implemented.

---

69-73: Test for getOrCreateSimple with different types returning a new instance is correctly implemented.