search

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(routes arweave): add minimal chunk post endpoint PE-5692 #173

Closed karlprieb closed 2 months ago

karlprieb commented 2 months ago

Adds a minimal chunk POST endpoint that receives chunks and sends them to the trusted node. As is, this provides limited utility, but it will serve as a starting point for broadcasting to multiple Arweave nodes. Also note, the Envoy routes have not been changed, so testing this route requires connecting directly to the core service.

coderabbitai[bot] commented 2 months ago
Walkthrough ## Walkthrough This update introduces improvements to chunk posting functionality within the Arweave client setup. Environment variables for chunk post URLs and timeouts are added. The `ArweaveCompositeClient` class is enhanced with chunk broadcasting capabilities using these URLs. An AR.IO Gateway route is implemented to handle chunked posts. Configuration and types associated with chunk broadcasting are updated accordingly. ## Changes | File | Change Summary | |-------------------------|---------------------------------------------------------------------------------------------------------------------------| | docker-compose.yaml | Added environment variables `CHUNK_POST_URLS`, `CHUNK_POST_RESPONSE_TIMEOUT_MS`, and `CHUNK_POST_ABORT_TIMEOUT_MS`. | | src/app.ts | Imported `arweaveRouter` from `./routes/arweave.js` and used it in middleware. | | src/arweave/composite-client.ts | Added chunk broadcasting functionality including constants, interfaces, and the `broadcastChunk` method. | | src/config.ts | Declared constants for chunk post URLs and timeouts. | | src/routes/arweave.ts | Introduced AR.IO Gateway functionality for handling chunked posts to Arweave and exported `arweaveRouter`. | | src/system.ts | Configured `chunkPostUrls` parameter for `arweaveClient` initialization. | | src/types.d.ts | Added and modified interfaces and types related to chunk broadcasting. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant User participant Router as arweaveRouter participant Client as ArweaveCompositeClient participant Arweave participant AR.IO User->>Router: POST /chunk Router->>Client: broadcastChunk(chunkData) Client->>AR.IO: POST chunkData to chunkPostUrls (with timeout handling) AR.IO-->>Client: Respond with ACK/Result Client-->>Router: Chunk broadcast result Router-->>User: Chunk post response ```
Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 0ac375a124e36ebb91dda42a755ad3be21a7ea3a and 5699c35bfb6d52c49d901944b45cdd9294680571.
Files selected for processing (4) * docker-compose.yaml (1 hunks) * src/arweave/composite-client.ts (8 hunks) * src/routes/arweave.ts (1 hunks) * src/types.d.ts (2 hunks)
Files skipped from review as they are similar to previous changes (4) * docker-compose.yaml * src/arweave/composite-client.ts * src/routes/arweave.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 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.
codecov[bot] commented 2 months ago

Codecov Report

Attention: Patch coverage is 82.60870% with 4 lines in your changes missing coverage. Please review.

Project coverage is 67.48%. Comparing base (affcf99) to head (5699c35). Report is 1 commits behind head on develop.

Files Patch % Lines
src/config.ts 82.60% 4 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## develop #173 +/- ## =========================================== + Coverage 67.43% 67.48% +0.04% =========================================== Files 29 29 Lines 7081 7104 +23 Branches 377 379 +2 =========================================== + Hits 4775 4794 +19 - Misses 2305 2309 +4 Partials 1 1 ```

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