kleros / kleros-v2

Kleros version 2
https://v2.kleros.builders
MIT License
58 stars 41 forks source link

fix(web): update-alias-to-object #1629

Closed Harman-singh-waraich closed 1 month ago

Harman-singh-waraich commented 1 month ago

PR-Codex overview

The focus of this PR is to refactor how aliases are handled in the codebase, switching from arrays to objects for better data management.

Detailed summary

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

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes primarily revolve around updating the structure and usage of aliases within the dispute resolution components. This includes altering type definitions, interface declarations, and logic to support a new format for aliases (with name and address properties). Refactoring ensures consistent handling of aliases across different parts of the application.

Changes

Files Change Summaries
web/src/components/DisputePreview/Alias.tsx IAlias interface updated to include name: string and address: '0x${string}' properties; AliasDisplay component now receives name and address instead of alias, adjusted logic to use these properties.
web/src/components/DisputePreview/DisputeContext.tsx Changed iteration logic to map over keys of disputeDetails.aliases and pass name and address props to AliasDisplay components.
web/src/context/NewDisputeContext.tsx Restructured Alias type to AliasArray, modified IDisputeTemplate interface to include aliases property, and adjusted constructDisputeTemplate logic to handle aliasesArray.
web/src/pages/Resolver/NavigationButtons/NextButton.tsx Updated areFilledAddressesValid logic to check for name field in addition to address and isValid.
web/src/pages/Resolver/Parameters/NotablePersons/PersonFields.tsx, index.tsx Renamed Alias type to AliasArray; updated references to aliases to aliasesArray in logic for handling aliases and maintaining consistency in data structure.
web/src/pages/Resolver/index.tsx Restructured JSX elements and adjusted conditional rendering logic within DisputeResolver component to handle scenarios where the user is connected or disconnected, impacting the display of various components within the resolver page.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant DisputeResolver
    participant AliasDisplay
    participant Object.keys

    User->>DisputeResolver: Open Dispute Page
    DisputeResolver->>Object.keys: Get alias keys
    Object.keys-->>DisputeResolver: Return alias keys
    DisputeResolver->>AliasDisplay: Render with name and address
    AliasDisplay->>User: Display name and resolved address

Poem

In the fields of code we roam,
Aliases find their proper home.
Names and addresses, side by side,
Ensuring nothing's left to hide.
As we refactor, lines align,
A clearer path, our code does shine.
🎉 Here's to progress, inch by inch! 🎉


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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
netlify[bot] commented 1 month ago

Deploy Preview for kleros-v2 ready!

Name Link
Latest commit 2abad9ff3f7609416b834a69da2c7ec1d0526e55
Latest deploy log https://app.netlify.com/sites/kleros-v2/deploys/667c3463cf350500083444cd
Deploy Preview https://deploy-preview-1629--kleros-v2.netlify.app
Preview on mobile
Toggle QR Code...

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[bot] commented 1 month ago

Deploy Preview for kleros-v2-university ready!

Name Link
Latest commit 2abad9ff3f7609416b834a69da2c7ec1d0526e55
Latest deploy log https://app.netlify.com/sites/kleros-v2-university/deploys/667c34637552b90008fc9263
Deploy Preview https://deploy-preview-1629--kleros-v2-university.netlify.app
Preview on mobile
Toggle QR Code...

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[bot] commented 1 month ago

Deploy Preview for kleros-v2-neo ready!

Name Link
Latest commit 2abad9ff3f7609416b834a69da2c7ec1d0526e55
Latest deploy log https://app.netlify.com/sites/kleros-v2-neo/deploys/667c346320e7150008466c2b
Deploy Preview https://deploy-preview-1629--kleros-v2-neo.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

codeclimate[bot] commented 1 month ago

Code Climate has analyzed commit 2abad9ff and detected 4 issues on this pull request.

Here's the issue category breakdown:

Category Count
Style 4

View more on Code Climate.

sonarcloud[bot] commented 1 month ago

Quality Gate Passed 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