river-build / river

MIT License
23 stars 5 forks source link

stream-metadata: fix opensea invalidation url #1014

Closed miguel-nascimento closed 1 month ago

miguel-nascimento commented 1 month ago

I was using the networkId by mistake, the chainId prop from the web3Config.base is the right one.

coderabbitai[bot] commented 1 month ago

Walkthrough

The pull request introduces modifications to the getOpenSeaAPIUrl function by adding a logger parameter for improved error logging and handling. The function now utilizes chainId instead of networkId for constructing the API URL, with specific conditions for certain chainId values. Error handling has been enhanced to log unsupported chainId values prior to throwing errors. Additionally, the refreshOpenSea function has been updated to include the new logger parameter when invoking getOpenSeaAPIUrl.

Changes

Files Change Summary
packages/stream-metadata/src/opensea.ts Modified getOpenSeaAPIUrl to include a logger parameter and updated logic to use chainId instead of networkId. Enhanced error handling for unsupported chainId values. Updated invocation in refreshOpenSea to include logger.

[!TIP]

New features Walkthrough comment now includes: - Possibly related PRs: A list of potentially related PRs to help you recall past context. - Suggested labels: CodeRabbit can now suggest labels by learning from your past PRs. You can also provide custom labeling instructions in the UI or configuration file. Notes: - Please share any feedback in the [discussion post](https://discordapp.com/channels/1134356397673414807/1282535539299323995) on our Discord. - Possibly related PRs, automatic label suggestions based on past PRs, learnings, and possibly related issues require data opt-in (enabled by default).

Recent review details **Configuration used: .coderabbit.yaml** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 5bf29191b334507b5430854976269b4ba9675604 and 7d50084e8235b38f303afc337e8dc72729d96673.
Files selected for processing (1) * packages/stream-metadata/src/opensea.ts (2 hunks)
Additional comments not posted (1)
packages/stream-metadata/src/opensea.ts (1)
`47-47`: **Verify the URL construction in `refreshOpenSea`.** The `refreshOpenSea` function now correctly passes the `logger` parameter to `getOpenSeaAPIUrl`. However, ensure that the URL returned from `getOpenSeaAPIUrl` is correctly formatted and functional by adding tests or logs that verify the URL structure and response. This is crucial for maintaining the integrity of the OpenSea integration, especially after significant changes like these.
Verification successful --- **Ensure URL Functionality with Tests or Logs** The `getOpenSeaAPIUrl` function constructs URLs based on the `chainId` and other parameters. While the logic appears correct, consider adding tests or logs to verify the URLs are functional and meet expectations. This will help maintain the integrity of the OpenSea integration. - Consider adding unit tests for `getOpenSeaAPIUrl` to validate URL formats. - Implement logging to capture constructed URLs for manual verification.
Scripts executed The following scripts were executed for the analysis: Script: ```shell #!/bin/bash # Description: Verify the URL construction in `refreshOpenSea`. # Test: Search for the function usage. Expect: Only occurrences of the new signature. rg --type typescript -A 5 $'refreshOpenSea' ``` Length of output: 77 --- Script: ```shell #!/bin/bash # Description: Verify the URL construction in `refreshOpenSea`. # Test: Search for the function usage. Expect: Only occurrences of the new signature. rg --type ts -A 5 $'refreshOpenSea' ``` Length of output: 1305 --- Script: ```shell #!/bin/bash # Description: Find the definition of `getOpenSeaAPIUrl` to verify URL construction. # Search for the `getOpenSeaAPIUrl` function definition. rg --type ts -A 5 $'function getOpenSeaAPIUrl' ``` Length of output: 47 --- Script: ```shell #!/bin/bash # Description: Search for all occurrences of `getOpenSeaAPIUrl` to locate its definition or import. # Search for `getOpenSeaAPIUrl` in the codebase. rg 'getOpenSeaAPIUrl' ``` Length of output: 222 --- Script: ```shell #!/bin/bash # Description: Extract the implementation of `getOpenSeaAPIUrl` to verify URL construction. # Extract the function implementation from the file. rg --type ts -A 10 'const getOpenSeaAPIUrl' packages/stream-metadata/src/opensea.ts ``` Length of output: 797
--- 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 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` anywhere in the PR title to generate the title automatically. ### 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.