Fix: Ensure that SDK getDispute() returns the RTA/Invalid answer #1831
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
WalkthroughThis pull request updates the version of the Changes
Assessment against linked issues
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (3)
🚧 Files skipped from review as they are similar to previous changes (3)
⏰ Context from checks skipped due to timeout of 90000ms (3)
🪧 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 (
|
✅ Deploy Preview for kleros-v2-testnet ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for kleros-v2-university ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for kleros-v2-neo ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
jaybuidl
requested review from
salgozino,
Harman-singh-waraich,
alcercu and
kemuru
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
kleros-sdk/test/getDispute.test.ts (3)
28-61: Add test cases for edge cases and malformed dataWhile the test coverage is good, consider adding these test cases:
- Malformed answer structure (missing required fields)
- Non-hex IDs in answers array
- Snapshot test for the entire dispute object
Example test case for malformed data:
it("should handle malformed answer structure gracefully", async () => { const mockTemplate = { disputeTemplate: { templateData: JSON.stringify({ answers: [ { /* missing id */ }, { id: null }, { id: undefined }, ], }), templateDataMappings: "", }, }; // ... setup mocks ... const result = await getDispute({ disputeId: mockDisputeId, coreSubgraph: mockCoreSubgraph, dtrSubgraph: mockDtrSubgraph, }); expect(result?.answers[0].id).toBe("0x0"); });
198-208: Enhance error test with specific error typeThe error test could be more specific by checking the exact error type.
await expect( getDispute({ disputeId: mockDisputeId, coreSubgraph: mockCoreSubgraph, dtrSubgraph: mockDtrSubgraph, }) - ).rejects.toThrow("Dispute details not found"); + ).rejects.toThrow(NotFoundError); + ).rejects.toThrowError("Dispute details not found for disputeId: 123");
6-8: Consider using more specific mock importsInstead of mocking the entire module, consider mocking specific functions for better test isolation.
-vi.mock("../src/requests/fetchDisputeDetails"); -vi.mock("../src/requests/fetchDisputeTemplateFromId"); +vi.mock("../src/requests/fetchDisputeDetails", () => ({ + default: vi.fn() +})); +vi.mock("../src/requests/fetchDisputeTemplateFromId", () => ({ + default: vi.fn() +}));
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
kleros-sdk/package.json(1 hunks)kleros-sdk/src/utils/getDispute.ts(1 hunks)kleros-sdk/test/getDispute.test.ts(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- kleros-sdk/package.json
⏰ Context from checks skipped due to timeout of 90000ms (18)
- GitHub Check: Redirect rules - kleros-v2-neo
- GitHub Check: Header rules - kleros-v2-neo
- GitHub Check: Pages changed - kleros-v2-neo
- GitHub Check: Redirect rules - kleros-v2-university
- GitHub Check: Redirect rules - kleros-v2-testnet
- GitHub Check: Redirect rules - kleros-v2-testnet
- GitHub Check: Header rules - kleros-v2-university
- GitHub Check: Header rules - kleros-v2-testnet
- GitHub Check: Header rules - kleros-v2-testnet
- GitHub Check: Pages changed - kleros-v2-university
- GitHub Check: Pages changed - kleros-v2-testnet
- GitHub Check: Pages changed - kleros-v2-testnet
- GitHub Check: Copy labels from linked issues
- GitHub Check: SonarCloud
- GitHub Check: contracts-testing
- GitHub Check: Copy labels from linked issues
- GitHub Check: dependency-review
- GitHub Check: Analyze (javascript)
❌ Deploy Preview for kleros-v2-testnet-devtools failed. Why did it fail? →
|
jaybuidl
force-pushed
the
fix/sdk-getdispute-answer0
branch
from
6411a42 to
6d0cbeb
Compare
jaybuidl
dismissed stale reviews from salgozino, Harman-singh-waraich, and coderabbitai[bot]
via
2c9ea33
kemuru
approved these changes
Jan 14, 2025
|
Code Climate has analyzed commit 364cb02 and detected 2 issues on this pull request. Here's the issue category breakdown:
View more on Code Climate. |
|
This was referenced Jan 17, 2025
This was referenced Feb 13, 2025
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves https://github.com/kleros/atlas/issues/369
PR-Codex overview
This PR updates the
@kleros/kleros-sdkpackage version and enhances thegetDisputefunctionality to include a standard "Refuse to Arbitrate" answer in various scenarios. It also adds tests to ensure this behavior works correctly.Detailed summary
versioninpackage.jsonfrom2.1.10to2.1.12.populatedTemplate.answersingetDispute.getDisputeingetDispute.test.ts:0x0or0x00.Summary by CodeRabbit
New Features
Tests
getDisputefunction.Version Update