ar-io / ar-io-node

A scalable and modular gateway built for the permaweb atop the Arweave permanent data storage network.
https://ar.io
GNU Affero General Public License v3.0
97 stars 65 forks source link

feat(data-sources): send node version #144

Closed karlprieb closed 3 months ago

coderabbitai[bot] commented 3 months ago
Walkthrough ## Walkthrough The changes introduce new request attribute headers, specifically for node release information, across various parts of the codebase. This involves adding new constants, updating test cases, refactoring request handling logic, and modifying type definitions. The goal is to ensure that the `AR_IO_NODE_RELEASE` environment variable and related headers are properly managed and tested throughout the application. ## Changes | File Path | Change Summary | |-------------------------------------|---------------------------------------------------------------------------------------------------| | `docker-compose.yaml` | Added an environment variable `AR_IO_NODE_RELEASE` to the services section. | | `src/constants.ts` | Added `nodeRelease` and `originNodeRelease` constants to the `headerNames` object. | | `src/data/ar-io-data-source.test.ts`| Updated tests to include `nodeRelease` in `requestAttributes`. | | `src/data/ar-io-data-source.ts` | Refactored request attributes handling and updated `parseResponse` method. | | `src/data/gateway-data-source.test.ts` | Added new header `'X-AR-IO-Origin': 'node-url'` and modified test cases. | | `src/data/gateway-data-source.ts` | Refactored request attributes handling logic. | | `src/lib/request-attributes.test.ts`| Introduced functions for generating and parsing request attributes. | | `src/lib/request-attributes.ts` | Added functions for generating and parsing request attributes, including node release headers. | | `src/routes/data/handlers.ts` | Added `nodeReleaseHeader` variable in `getRequestAttributes` function. | | `src/types.d.ts` | Added `nodeRelease` and `originNodeRelease` properties to `RequestAttributes` interface. | | `src/data/s3-data-source.ts` | Refactored to use `generateRequestAttributes` for handling request attributes. | | `src/data/tx-chunks-data-source.ts` | Modified `requestAttributes` structure to use `generateRequestAttributes`. | | `test/end-to-end/data.test.ts` | Updated test cases and descriptions to include `nodeRelease` headers and assertions. |

Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 626a6830b7b121d2aed7708a1d49a66f7669ebf6 and 8256ae9ad2f1b152784ea8ff480bdb195c16df32.
Files selected for processing (11) * docker-compose.yaml (1 hunks) * src/constants.ts (1 hunks) * src/data/ar-io-data-source.test.ts (3 hunks) * src/data/ar-io-data-source.ts (4 hunks) * src/data/gateway-data-source.test.ts (4 hunks) * src/data/gateway-data-source.ts (3 hunks) * src/data/s3-data-source.ts (4 hunks) * src/lib/request-attributes.test.ts (1 hunks) * src/lib/request-attributes.ts (1 hunks) * src/routes/data/handlers.ts (5 hunks) * src/types.d.ts (1 hunks)
Files skipped from review as they are similar to previous changes (11) * docker-compose.yaml * src/constants.ts * src/data/ar-io-data-source.test.ts * src/data/ar-io-data-source.ts * src/data/gateway-data-source.test.ts * src/data/gateway-data-source.ts * src/data/s3-data-source.ts * src/lib/request-attributes.test.ts * src/lib/request-attributes.ts * src/routes/data/handlers.ts * src/types.d.ts
--- 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.
codecov[bot] commented 3 months ago

Codecov Report

Attention: Patch coverage is 98.52941% with 2 lines in your changes missing coverage. Please review.

Project coverage is 65.10%. Comparing base (f544fb5) to head (8256ae9).

Files Patch % Lines
src/data/ar-io-data-source.ts 90.90% 2 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## develop #144 +/- ## =========================================== + Coverage 64.52% 65.10% +0.57% =========================================== Files 25 27 +2 Lines 6481 6580 +99 Branches 293 306 +13 =========================================== + Hits 4182 4284 +102 + Misses 2298 2295 -3 Partials 1 1 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.