Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add confirmation step to destroy building #2433

Merged
merged 1 commit into from
Dec 12, 2024
Merged

Conversation

bob0005
Copy link
Collaborator

@bob0005 bob0005 commented Dec 11, 2024

Closes #2432

Summary by CodeRabbit

  • New Features
    • Added a confirmation prompt for destroying buildings to prevent accidental actions.
    • Button text changes from "Destroy" to "Confirm Destroy" based on the confirmation state.

Copy link

vercel bot commented Dec 11, 2024

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 11, 2024 4:23pm
eternum-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 11, 2024 4:23pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
eternum-landing ⬜️ Ignored (Inspect) Visit Preview Dec 11, 2024 4:23pm

Copy link
Contributor

coderabbitai bot commented Dec 11, 2024

Walkthrough

The changes in this pull request modify the BuildingEntityDetails component to introduce a confirmation step for the destruction of buildings. A new state variable, showDestroyConfirm, is added to control the visibility of a confirmation prompt. The handleDestroyBuilding function is updated to either prompt for confirmation or proceed with the destruction based on the state. Additionally, the button text dynamically changes to reflect the action required, enhancing user interaction and preventing accidental destruction.

Changes

File Path Change Summary
client/src/ui/modules/entity-details/BuildingEntityDetails.tsx Added showDestroyConfirm state variable; updated handleDestroyBuilding for confirmation logic; changed button text based on confirmation state.

Assessment against linked issues

Objective Addressed Explanation
Implement confirmation before building destruction (#2432)

Possibly related PRs

  • Fix lingering building preview on view change #2408: The changes in the StructureCard component involve managing state visibility similar to the showDestroyConfirm state in the BuildingEntityDetails component, indicating a focus on user interaction and state management within UI components.

Suggested reviewers

  • aymericdelab

🐰 "In the land of buildings, a choice must be made,
With a click and a pause, no hasty mistake!
'Destroy' turns to 'Confirm,' a thoughtful charade,
A hop and a skip, for the user's sake!" 🐇


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
🪧 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.

Copy link
Contributor

mentatbot bot commented Dec 11, 2024

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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
client/src/ui/modules/entity-details/BuildingEntityDetails.tsx (2)

Line range hint 96-115: Add error handling and loading state

The destroy building operation lacks error handling and loading state management. This could lead to a poor user experience if the operation fails.

Consider implementing these improvements:

 const handleDestroyBuilding = useCallback(() => {
   if (!showDestroyConfirm) {
     setShowDestroyConfirm(true);
     return;
   }

+  setIsLoading(true);
   const tileManager = new TileManager(dojo.setup, {
     col: selectedBuildingHex.outerCol,
     row: selectedBuildingHex.outerRow,
   });
-  tileManager.destroyBuilding(selectedBuildingHex.innerCol, selectedBuildingHex.innerRow);
+  tileManager
+    .destroyBuilding(selectedBuildingHex.innerCol, selectedBuildingHex.innerRow)
+    .then(() => {
       if (
         buildingState.buildingType === BuildingType.Resource &&
         (ResourceIdToMiningType[buildingState.resource!] === ResourceMiningTypes.Forge ||
           ResourceIdToMiningType[buildingState.resource!] === ResourceMiningTypes.Mine)
       ) {
         playDestroyStone();
       } else {
         playDestroyWooden();
       }
       setShowDestroyConfirm(false);
       setLeftNavigationView(LeftView.None);
+    })
+    .catch((error) => {
+      console.error('Failed to destroy building:', error);
+      // Consider showing an error toast/notification here
+    })
+    .finally(() => {
+      setIsLoading(false);
+      setShowDestroyConfirm(false);
+    });

180-180: Enhance button accessibility and visual distinction

While the button text change works, consider improving accessibility and visual distinction for the confirmation state.

Consider these improvements:

-{showDestroyConfirm ? "Confirm Destroy" : "Destroy"}
+{showDestroyConfirm ? (
+  <span aria-live="polite" className="text-red-600 font-bold">
+    Confirm Destroy
+  </span>
+) : (
+  "Destroy"
+)}

This change will:

  • Make the state change announcement clearer for screen readers
  • Provide visual emphasis for the confirmation state
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 6f7e906 and f74ec8f.

📒 Files selected for processing (1)
  • client/src/ui/modules/entity-details/BuildingEntityDetails.tsx (5 hunks)
🔇 Additional comments (1)
client/src/ui/modules/entity-details/BuildingEntityDetails.tsx (1)

34-34: LGTM: Clear and well-structured state management

The state variable is appropriately named and follows React best practices.

Copy link

Failed to generate code suggestions for PR

@ponderingdemocritus ponderingdemocritus merged commit 441f27d into next Dec 12, 2024
7 of 9 checks passed
@ponderingdemocritus ponderingdemocritus deleted the fix/#2232 branch December 12, 2024 09:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[client] Destroy building confirmation
2 participants