fix(sdk): mocked data mappings tests, refactor alchemy api key parameter passing

kemuru commented 3 months ago

needs NPM package redeployment., but shoud wait until 1663 is merged too

PR-Codex overview

The focus of this PR is to update API key handling in various files and improve testing setups.

Detailed summary

Updated handling of Alchemy API key in multiple files
Improved testing setup for data mappings
Modified functions to accept API key as a parameter
Added interfaces for result objects in tests

The following files were skipped due to too many changes: kleros-sdk/test/dataMappings.test.ts

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

Summary by CodeRabbit

New Features
- Added support for an API key in various functions, enhancing flexibility and security when interacting with external services.
- Streamlined test execution command for easier use.
Bug Fixes
- Updated test cases to reflect changes in GraphQL endpoints and ABI definitions.
Documentation
- Updated README for clearer instructions on running data mapping tests and using the API key.
Refactor
- Improved type safety in function parameters to enhance reliability and maintainability.
Chores
- Simplified dependency management by removing unnecessary packages.

coderabbitai[bot] commented 3 months ago

Walkthrough

The recent updates to the Kleros SDK improve flexibility and security by allowing the direct passing of the Alchemy API key in various functions, reducing reliance on environment variables. Enhancements in type safety across multiple files and a streamlining of the testing process contribute to a clearer and more efficient development experience for users.

Changes

File Path	Change Summary
kleros-sdk/README.md	Clarified instructions for data mapping tests, simplified test command to `yarn test`, and retained guidance on environment variables.
kleros-sdk/package.json	Removed `dotenv` from `devDependencies`, indicating a change in environment variable management.
kleros-sdk/src/dataMappings/actions/callAction.ts	Modified `callAction` to accept `alchemyApiKey` as a parameter, enhancing function flexibility.
kleros-sdk/src/dataMappings/actions/eventAction.ts	Updated `eventAction` to include `alchemyApiKey` as a parameter.
kleros-sdk/src/dataMappings/executeActions.ts	Changed `context` parameter type to `Record<string, unknown>`, passing `context.alchemyApiKey` to actions.
kleros-sdk/src/dataMappings/utils/replacePlaceholdersWithValues.ts	Updated `context` parameter type to `Record<string, unknown>`.
kleros-sdk/test/dataMappings.test.ts	Updated tests for new API interactions, including changes to the GraphQL endpoint and ABI definitions.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant SDK
    participant API
    User->>SDK: Call Function with alchemyApiKey
    SDK->>API: Pass alchemyApiKey to API request
    API-->>SDK: Return Data
    SDK-->>User: Return Result

🐰 In the meadow so bright,
A rabbit hops with delight,
With keys of Alchemy near,
Now coding brings us cheer!
No more worries, no more fuss,
Just run tests and trust in us! 🌿✨

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 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](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 3 months ago

Deploy Preview for kleros-v2-neo ready!

Name	Link
Latest commit	4c17ea8dd523574d0311a43fddb2f2e9cfd95ad1
Latest deploy log	https://app.netlify.com/sites/kleros-v2-neo/deploys/66ad200204a36a0008c1db4d
Deploy Preview	https://deploy-preview-1663--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 3 months ago

Deploy Preview for kleros-v2-university ready!

Name	Link
Latest commit	4c17ea8dd523574d0311a43fddb2f2e9cfd95ad1
Latest deploy log	https://app.netlify.com/sites/kleros-v2-university/deploys/66ad20027e4d2400083617fe
Deploy Preview	https://deploy-preview-1663--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 3 months ago

Deploy Preview for kleros-v2-testnet ready!

Name	Link
Latest commit	4c17ea8dd523574d0311a43fddb2f2e9cfd95ad1
Latest deploy log	https://app.netlify.com/sites/kleros-v2-testnet/deploys/66ad2002199cd20008503180
Deploy Preview	https://deploy-preview-1663--kleros-v2-testnet.netlify.app
Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.