Feat/dynamic context validation in sdk

Harman-singh-waraich commented 1 month ago

adds dynamic context validation in sdk.
sdk will try to retrieve the variables while populating mapping with context, and if a variable is not provided it will throw error
Example:

PR-Codex overview

This PR focuses on significant updates and refactoring within the kleros-sdk, including the removal of obsolete files, enhancements in error handling, and the introduction of new utility functions. It also updates the TypeScript configuration and improves the integration of GraphQL queries.

Detailed summary

Deleted obsolete files in tsconfig, kleros-sdk/src/dataMappings, and web/src/hooks.
Added new TypeScript configuration files: base18.json, base20.json.
Enhanced error handling with new error classes in kleros-sdk/src/errors.
Refactored action imports to use relative paths.
Updated SDK configuration in kleros-sdk/src/sdk.ts.
Improved GraphQL query handling in web/src/hooks/queries.
Added utility functions for template processing in kleros-sdk/src/dataMappings/utils.
Updated README and package versions in kleros-sdk/package.json.
Introduced new snapshots for testing in kleros-sdk/test/__snapshots__.

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

Summary by CodeRabbit

New Features
- Introduced validation for template variables to enhance error handling.
- Added a utility for extracting variable names from Mustache templates.
- Implemented functions to fetch dispute details and templates using GraphQL.
- Enhanced the GraphQL schema for disputes with new fields.
- Updated the Evidence component to fetch dispute details instead of evidence group data.
- Enhanced the CaseDetails component's routing for the evidence section.
- Improved type safety and configuration for the SDK.
- Enhanced integration with the Kleros SDK for streamlined configuration.
- Added a new function to process dispute request data from events.
- Expanded data sources in subgraph configurations for better data handling.
- Updated SDK methods to remove unnecessary parameters for improved usability.
- Consolidated access to multiple modules for easier imports.
- Added a new function to fetch dispute details from a GraphQL endpoint.
- Introduced new type definitions for dispute parameters and SDK configuration.
- Added new environment variables for Graph API integration.
- Enhanced error handling with specific error classes for better context.
- Added a new function to retrieve reality data with improved error handling.
- Introduced new error classes for better specificity in error reporting.
- Added a new function to fetch dispute templates from a GraphQL endpoint.
- Enhanced caching for GraphQL clients to optimize resource usage.
Bug Fixes
- Improved error handling for missing context variables in templates.
- Simplified function parameters in various actions for better usability.
- Updated test cases to align with new dispute template structures.
- Enhanced error handling for public client configuration.
- Updated TypeScript configuration for improved compilation settings.

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes simplify the SDK's function signatures by removing the alchemyApiKey parameter from several functions, including callAction, eventAction, and executeActions. A new function, validateContext, is introduced to ensure required variables are present in the context before rendering templates. Type safety is enhanced across various functions. Significant updates are made to the subgraph.yaml files and the package.json for versioning and data source configurations. Additionally, new TypeScript configuration files are added, and existing configurations are modified to reflect changes in module handling and output settings.

Changes

File Path	Change Summary
kleros-sdk/package.json	Updated version to `2.1.7`, modified main entry point, added new dependencies, and updated scripts.
kleros-sdk/src/dataMappings/actions/callAction.ts	Removed `alchemyApiKey` parameter from `callAction` function signature and updated error handling.
kleros-sdk/src/dataMappings/actions/eventAction.ts	Removed `alchemyApiKey` parameter from `eventAction` function signature and updated error handling.
kleros-sdk/src/dataMappings/executeActions.ts	Updated `initialContext` parameter type for `executeActions` function; removed `context.alchemyApiKey`.
kleros-sdk/src/dataMappings/utils/replacePlaceholdersWithValues.ts	Added function `validateContext` to validate template variables in context.
kleros-sdk/test/dataMappings.test.ts	Enhanced dispute template tests with new properties and updated handling for missing variables.
subgraph/core/src/entities/Dispute.ts	Added `updateDisputeRequestData` function and modified `createDisputeFromEvent` to call it.
web/src/context/Web3Provider.tsx	Added `configureSDK` import and modified `alchemyTransport` function definition.
subgraph/core-neo/subgraph.yaml	Added new data sources and updated versioning in the subgraph configuration.
subgraph/core-university/subgraph.yaml	Added new data sources and updated versioning in the subgraph configuration.
subgraph/core/subgraph.yaml	Added new data sources, updated versioning, and modified event handlers in the subgraph configuration.
kleros-sdk/src/index.ts	Exported all entities from `./sdk`, `./types`, `./utils`, `./dataMappings`, and `./dataMappings/utils`.
kleros-sdk/tsconfig.json	Updated TypeScript configuration, changing output directory and extending a new base config.
kleros-sdk/vitest.config.ts	Introduced new configuration file for Vitest, excluding specific directories from test runs.
tsconfig/base.json	Deleted file containing TypeScript configuration settings.
tsconfig/base18.json	Added new TypeScript configuration extending from `@tsconfig/node18/tsconfig.json`.
tsconfig/base20.json	Added new TypeScript configuration extending from `@tsconfig/node20/tsconfig.json`.
tsconfig/react-library.json	Updated configuration to extend from `base20.json` and change ECMAScript library version.
web/tsconfig.json	Removed `"target": "es2020"` from TypeScript configuration.

Possibly related PRs

#1702: The changes in this PR involve modifications to the totalCoherent and totalResolvedDisputes properties, which are relevant to the callAction function's logic in the main PR, as both involve handling user metrics related to disputes and voting.

Suggested labels

Type: Enhancement :sparkles:, Package: Web

Suggested reviewers

alcercu

🐰 In the fields where we play,
New functions hop in every day!
With keys for graphs, we leap and bound,
In code and joy, our changes found!
So gather 'round, both near and far,
For every change, we raise a star! 🌟

🪧 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 , 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 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` or `@coderabbitai title` 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](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](http://discord.gg/coderabbit) 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-testnet ready!

Name	Link
Latest commit	7b2ccd3818f507353bae044f162ca01eb7563975
Latest deploy log	https://app.netlify.com/sites/kleros-v2-testnet/deploys/671b41ad9ecef700084fb7dc
Deploy Preview	https://deploy-preview-1703--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[bot] commented 1 month ago

Deploy Preview for kleros-v2-university ready!

Name	Link
Latest commit	7b2ccd3818f507353bae044f162ca01eb7563975
Latest deploy log	https://app.netlify.com/sites/kleros-v2-university/deploys/671b41add8fc25000815fa7b
Deploy Preview	https://deploy-preview-1703--kleros-v2-university.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[bot] commented 1 month ago

Deploy Preview for kleros-v2-neo ready!

Name	Link
Latest commit	7b2ccd3818f507353bae044f162ca01eb7563975
Latest deploy log	https://app.netlify.com/sites/kleros-v2-neo/deploys/671b41addbf1160008c89689
Deploy Preview	https://deploy-preview-1703--kleros-v2-neo.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[bot] commented 1 month ago

Deploy Preview for kleros-v2-testnet-devtools ready!

Name	Link
Latest commit	7b2ccd3818f507353bae044f162ca01eb7563975
Latest deploy log	https://app.netlify.com/sites/kleros-v2-testnet-devtools/deploys/671b41addc5fd700089969bf
Deploy Preview	https://deploy-preview-1703--kleros-v2-testnet-devtools.netlify.app
Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.