fix(ui): Tier List Data Doesn't Reset When Changing Tier List #138
Conversation
|
@HecticKiwi is attempting to deploy a commit to the Infinia Team on Vercel. A member of the Team first needs to authorize it. |
WalkthroughThe pull request introduces modifications to tier initialization and immutability in the CodeRabbit system. In Changes
Possibly related PRs
Suggested reviewers
Poem
Tip CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command 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 using PR comments)
Other keywords and placeholders
CodeRabbit Configuration 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
🧹 Nitpick comments (1)
lib/TierCortex.ts (1)
153-154: Deep copying with JSON.parse/JSON.stringifyUsing
JSON.parse(JSON.stringify(DEFAULT_TIER_TEMPLATE))is a practical way to create a fresh tier list. However, be aware of:
- Performance: For large objects, this can be relatively slow. A structured clone approach or a dedicated deep-copy utility might offer improved performance.
- Potential data loss: If
Tier(or nested objects) include non-JSON-serializable fields (e.g. methods, special object types), they’ll be lost. Currently, this appears acceptable, but keep this gotcha in mind for future changes.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
lib/TierCortex.ts(1 hunks)models/Tier.ts(1 hunks)
🔇 Additional comments (2)
models/Tier.ts (1)
13-13: Reinforce immutability with Readonly<Tier>
Switching from Tier[] to Readonly<Tier>[] is an effective way to prevent accidental modifications to Tier objects. This design choice ensures each Tier in the template remains immutable throughout the application’s lifecycle, aligning well with functional programming principles and reducing unintended mutation side effects.
lib/TierCortex.ts (1)
164-164: Succeeding with a validated final return
Returning initialTiers after the deep copy is correct and safely avoids mutating the original DEFAULT_TIER_TEMPLATE. This aligns perfectly with an immutable design, ensuring updates in one tier list do not affect subsequent tier lists.
| @@ -10,7 +10,7 @@ export default interface Tier { | |||
| placeholder?: string; | |||
| } | |||
|
|
|||
| export type TierTemplate = Record<string, Tier[]>; | |||
| export type TierTemplate = Record<string, Readonly<Tier>[]>; | |||
There was a problem hiding this comment.
Marked the Tier as Readonly to safeguard against this bug in the future
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Description
If you start a tier list, then go back and start another tier list, data gets carried over unexpectedly.
The cause is that when initializing a tier list, a shallow copy of the
DEFAULT_TIER_TEMPLATEis used. When you edit the tier list, it ends up mutating the template tiers, which causes these edits to carry over to the next tier list you start.Fixed by using a deep copy of
DEFAULT_TIER_TEMPLATE.Screenshots
Before
Screen.Recording.2024-12-28.144610.mp4
After
Screen.Recording.2024-12-28.144753.mp4
Checklist:
Summary by CodeRabbit
New Features
Refactor
TierTemplatetype to enforce read-only tier objects.getInitialTiersmethod to create independent tier instances.