refactor(web): improve-draw-maintenance-button

[tractorss]

• adds check for phase for draw button

---

PR-Codex overview

The focus of this PR is to refactor the DrawButton component in the MaintenanceButtons directory to use a new custom hook useSortitionModulePhase and introduce a new condition canDraw for enabling the draw button.

Detailed summary

• Added useSortitionModulePhase custom hook
• Introduced canDraw condition based on phase and Period.Evidence
• Refactored conditions for enabling/disabling the draw button

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

Summary by CodeRabbit

• New Features

  • Enhanced the DrawButton component with improved logic for determining when a draw can occur during dispute resolution.
  • Introduced a new condition checking mechanism to better manage the button's enabled/disabled state based on the drawing phase.

• Bug Fixes

  • Corrected issues related to the button's state, ensuring it reflects the current phase accurately.

• Refactor

  • Simplified the logic for enabling the draw simulation, improving code readability and maintainability.

[coderabbitai]

Walkthrough

The updates to the DrawButton component enhance the logic governing the drawing phase of a dispute. By introducing a new hook and simplifying conditional checks, the changes streamline the code, improve readability, and ensure the button’s state accurately reflects the current phase. The result is a more robust and maintainable component that effectively manages the conditions under which a draw can be executed.

Changes

Files	Change Summary
web/src/pages/Cases/CaseDetails/MaintenanceButtons/DrawButton.tsx	Introduced useSortitionModulePhase hook; added canDraw variable with useMemo for draw conditions; simplified draw simulation logic; updated isDisabled state based on canDraw.

Poem

🐰 In fields of code where bunnies play,
A button’s logic found its way.
With hooks and phases, clear and bright,
We draw with glee, all feels just right!
Hops of joy, a dance we spin,
For better flows, let’s all begin! ✨

---

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.
  • @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 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 do a full 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 configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

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

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.

[netlify]

✅ Deploy Preview for kleros-v2-testnet ready!

Name	Link
🔨 Latest commit	ced40d5
🔍 Latest deploy log	https://app.netlify.com/sites/kleros-v2-testnet/deploys/66b3851055deab0008b9ce16
😎 Deploy Preview	https://deploy-preview-1674--kleros-v2-testnet.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[netlify]

❌ Deploy Preview for kleros-v2-neo failed. Why did it fail? →

Name	Link
🔨 Latest commit	ced40d5
🔍 Latest deploy log	https://app.netlify.com/sites/kleros-v2-neo/deploys/66b38510235bba0008084b07

[netlify]

❌ Deploy Preview for kleros-v2-university failed. Why did it fail? →

Name	Link
🔨 Latest commit	ced40d5
🔍 Latest deploy log	https://app.netlify.com/sites/kleros-v2-university/deploys/66b38510111dd80008671452

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[qlty-cloud-legacy]

Code Climate has analyzed commit ced40d5 and detected 1 issue on this pull request.

Here's the issue category breakdown:

Category	Count
Complexity	1

View more on Code Climate.

[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 ef60216 and ced40d5.

Files selected for processing (1)

• web/src/pages/Cases/CaseDetails/MaintenanceButtons/DrawButton.tsx (3 hunks)

Additional comments not posted (5)

web/src/pages/Cases/CaseDetails/MaintenanceButtons/DrawButton.tsx (5)

9-9: New hook imported: useSortitionModulePhase.

The import statement for the new hook useSortitionModulePhase is correctly added. Ensure that this hook is used appropriately in the code.

---

34-34: Initialization of phase variable.

The phase variable is initialized using the useSortitionModulePhase hook. Ensure that this hook returns the expected phase data.

---

38-41: Logic for canDraw variable.

The canDraw variable uses useMemo to encapsulate the conditions under which a draw is permissible. The conditions check if:

1. maintenanceData is defined.
2. The draw has not already occurred (!isDrawn).
3. The current period is Evidence.
4. The phase is drawing.

These conditions seem logical and optimized for determining if a draw can occur.

---

49-49: Usage of canDraw in useSimulateKlerosCoreDraw hook.

The canDraw variable is used in the enabled condition of the useSimulateKlerosCoreDraw hook. This simplifies the logic and ensures the hook is only enabled when a draw is permissible.

---

58-59: Logic for isDisabled variable.

The isDisabled variable uses useMemo to encapsulate the conditions under which the draw button should be disabled. The conditions check if:

1. id is undefined.
2. numberOfVotes is undefined.
3. There is an error (isError).
4. The configuration is loading (isLoading).
5. The draw is not permissible (!canDraw).

These conditions are logical and ensure the button is correctly disabled when necessary.