Remove quest UI while syncing

[bob0005]

Summary by CodeRabbit

• New Features
  • Enhanced the QuestsMenu display logic to show a loading message when quests are loading, improving user experience during transitions.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
eternum	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 12, 2024 1:03pm
eternum-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 12, 2024 1:03pm

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
eternum-landing	⬜️ Ignored (Inspect)	Visit Preview		Dec 12, 2024 1:03pm

[coderabbitai]

Walkthrough

The changes in this pull request involve the integration of a new hook, useWorldStore, into the TopLeftNavigation component. This hook retrieves the isWorldLoading state, which is then used in the conditional rendering of the QuestsMenu. The display logic for the QuestsMenu now checks both the count of unclaimed quests and the loading state of the world, ensuring the menu is only visible when appropriate. This adjustment alters the control flow by adding a loading state check.

Changes

File	Change Summary
client/src/ui/modules/navigation/TopLeftNavigation.tsx	Added import for useWorldStore, defined worldLoading variable, and modified QuestsMenu rendering logic.

Possibly related PRs

• improve top left navigation on mobile #2127: The changes in the TopLeftNavigation component directly relate to the modifications made in the same file, enhancing the component's responsiveness and rendering logic, which may interact with the new loading state introduced in the main PR.

🐇 In a world where quests unfold,
The loading states are now controlled.
With menus that appear just right,
Adventures await, shining bright!
So hop along, let's start the quest,
With smoother flows, we are truly blessed! 🌟

---

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 generate docstrings to generate docstrings for this PR. (Experiment)
• @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.

[mentatbot]

You are out of MentatBot reviews. Your usage will refresh December 16 at 08:00 AM.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

client/src/ui/modules/navigation/TopLeftNavigation.tsx (1)

Line range hint 327-331: Consider extracting the visibility logic for better readability

While the current implementation works correctly, the conditional logic could be more expressive.

Consider this refactor to improve readability:

-        {unclaimedQuestsCount > 0 && !worldLoading && (
+        {shouldShowQuestsMenu && (
           <div className="absolute right-0 px-4 top-full mt-2">
             <QuestsMenu unclaimedQuestsCount={unclaimedQuestsCount} />
           </div>
         )}

+ // Add this near other state declarations
+ const shouldShowQuestsMenu = unclaimedQuestsCount > 0 && !worldLoading;

This change:

• Makes the rendering logic more self-documenting
• Separates the business logic from the presentation
• Improves maintainability for future condition changes

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e795852 and 85c9c4d.

📒 Files selected for processing (1)

• client/src/ui/modules/navigation/TopLeftNavigation.tsx (3 hunks)

🔇 Additional comments (2)

client/src/ui/modules/navigation/TopLeftNavigation.tsx (2)

26-26: LGTM: Clean import statement

The import follows the project's conventions and is appropriately placed with other store-related imports.

---

100-101: LGTM: Clear and concise state management

The worldLoading state is well-named and follows React's best practices for store selectors.

[github-actions]

Failed to generate code suggestions for PR

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 85c9c4d and 466524c.

📒 Files selected for processing (1)

• client/src/ui/modules/navigation/TopLeftNavigation.tsx (3 hunks)

🔇 Additional comments (3)

client/src/ui/modules/navigation/TopLeftNavigation.tsx (3)

7-7: LGTM!

The import statement follows the project's conventions and is appropriately placed with other store-related imports.

---

100-101: LGTM!

The state variable is well-named and follows the selector pattern correctly. The empty line after the declaration improves code readability.

---

327-337: Verify loading state management

Let's ensure the loading state is properly integrated with the world store and quest updates.

✅ Verification successful

Loading state implementation is properly integrated

The loading state is well-managed with proper synchronization:

• World loading state is centrally managed through useWorldStore
• Loading state transitions are properly handled in World.tsx during data fetching
• Quest count updates are safely memoized based on questClaimStatus, preventing race conditions
• The loading UI in TopLeftNavigation.tsx correctly responds to the world loading state

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for proper loading state management and potential race conditions

# Check world store implementation
echo "Checking world store implementation..."
ast-grep --pattern 'export const useWorldStore = create<$_>($_)'

# Check for race condition prevention
echo "Checking quest count updates during loading..."
ast-grep --pattern 'useUnclaimedQuestsCount'

Length of output: 1090

---

Script:

#!/bin/bash
# Let's check the implementation of useUnclaimedQuestsCount and its loading state handling
echo "Checking useUnclaimedQuestsCount implementation..."
rg -A 10 "export const useUnclaimedQuestsCount" client/src/hooks/helpers/useQuests.tsx

# Check how worldLoading is used in TopLeftNavigation
echo "Checking worldLoading usage..."
rg -A 5 "worldLoading" client/src/ui/modules/navigation/TopLeftNavigation.tsx

# Check if there are any other components using worldLoading state
echo "Checking other worldLoading usages..."
rg "useWorldStore" --type ts --type tsx

Length of output: 1405

---

Script:

#!/bin/bash
# Let's check for any race conditions in quest claim status updates
echo "Checking quest claim status implementation..."
rg -A 10 "useQuestClaimStatus" client/src/hooks/helpers/useQuests.tsx

# Check world store usage across the codebase
echo "Checking world store usage..."
rg "useWorldStore" 

# Check for loading state transitions
echo "Checking where world loading state is set..."
rg "setWorldLoading" -A 5

Length of output: 5419

[coderabbitai]

🛠️ Refactor suggestion

Enhance loading state accessibility and maintainability

While the loading state logic is correct, consider these improvements:

1. Add proper accessibility attributes
2. Use consistent styling approach
3. Make the loading message more informative

Consider applying these changes:

 {worldLoading ? (
-  <div className="absolute right-2 p-4 mt-2 top-full flex flex-row items-center justify-center bg-black/80 rounded-lg">
-    <img src="/images/eternumloader.png" className="w-10" />
-    <div className="ml-4">Quests are loading...</div>
+  <div 
+    className="absolute right-2 px-4 mt-2 top-full flex flex-row items-center justify-center bg-black/80 rounded-lg"
+    role="status"
+    aria-live="polite"
+  >
+    <img 
+      src="/images/eternumloader.png" 
+      className="w-10" 
+      alt="Loading indicator"
+    />
+    <div className="ml-4">Synchronizing quest data with the realm...</div>
   </div>
 ) : (
   unclaimedQuestsCount > 0 && (
     <div className="absolute right-0 px-4 top-full mt-2">
       <QuestsMenu unclaimedQuestsCount={unclaimedQuestsCount} />
     </div>
   )
 )}

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	{worldLoading ? (
	<div className="absolute right-2 p-4 mt-2 top-full flex flex-row items-center justify-center bg-black/80 rounded-lg">
	<img src="/images/eternumloader.png" className="w-10" />
	<div className="ml-4">Quests are loading...</div>
	</div>
	) : (
	unclaimedQuestsCount > 0 && (
	<div className="absolute right-0 px-4 top-full mt-2">
	<QuestsMenu unclaimedQuestsCount={unclaimedQuestsCount} />
	</div>
	)
	{worldLoading ? (
	<div
	className="absolute right-2 px-4 mt-2 top-full flex flex-row items-center justify-center bg-black/80 rounded-lg"
	role="status"
	aria-live="polite"
	>
	<img
	src="/images/eternumloader.png"
	className="w-10"
	alt="Loading indicator"
	/>
	<div className="ml-4">Synchronizing quest data with the realm...</div>
	</div>
	) : (
	unclaimedQuestsCount > 0 && (
	<div className="absolute right-0 px-4 top-full mt-2">
	<QuestsMenu unclaimedQuestsCount={unclaimedQuestsCount} />
	</div>
	)