feat(info): unbundle/index filters, supported manifest versions

Walkthrough

## Walkthrough The changes focus on updating how ANS-104 filters are extracted, parsed, and used within the system. Notably, there’s a shift from parsing environment variables directly in the code to utilizing pre-parsed constants for better clarity and maintainability. Additionally, the `/ar-io/info` endpoint now returns more detailed information concerning the ANS-104 bundle and data item filters, along with supported manifest versions. ## Changes | **Files** | **Change Summary** | |-------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `src/config.ts` | Updated constants for ANS-104 filter configurations to use pre-parsed values instead of directly parsing environment variables in-place. | | `src/routes/ar-io.ts` | Enhanced the `/ar-io/info` endpoint to include additional fields: `ans104UnbundleFilter`, `ans104IndexFilter`, and `supportedManifestVersions`. |

Recent review details

**Configuration used: CodeRabbit UI** **Review profile: CHILL**

Commits

Files that changed from the base of the PR and between afce8a4c2a3c9e3efbfe680d10d27cbf3ad02cf8 and dbb39aab55bba13ff6905775a49202badebac14a.

Files selected for processing (2)

* src/config.ts (1 hunks) * src/routes/ar-io.ts (1 hunks)

Additional comments not posted (3)

src/routes/ar-io.ts (1)
`56-58`: **Ensure Consistency and Correctness in Endpoint Response** The addition of `ans104UnbundleFilter`, `ans104IndexFilter`, and `supportedManifestVersions` to the `/ar-io/info` endpoint enhances the API's functionality by providing more detailed configuration information. Ensure that these fields are correctly populated from the configuration and that their values are accurate and consistent with the system's current state and configuration.

src/config.ts (2)
`93-97`: **Refactor and Verify Environment Variable Parsing and Usage** The refactoring of `ANS104_UNBUNDLE_FILTER_*` constants to use a parsed and canonicalized version of the environment variable enhances clarity and potentially performance. However, ensure the parsing logic correctly handles various input scenarios and that the canonicalization process does not introduce any unintended alterations to the filter configurations. ```diff - export const ANS104_UNBUNDLE_FILTER_STRING = canonicalize( - JSON.parse(env.varOrDefault('ANS104_UNBUNDLE_FILTER', '{"never": true}')), - ); + export const ANS104_UNBUNDLE_FILTER_STRING = canonicalize( + ANS104_UNBUNDLE_FILTER_PARSED, + ); ```

Verification successful
--- **Refactor and Verify Environment Variable Parsing and Usage** The refactoring of `ANS104_UNBUNDLE_FILTER_*` constants to use a parsed and canonicalized version of the environment variable enhances clarity and potentially performance. However, ensure the parsing logic correctly handles various input scenarios and that the canonicalization process does not introduce any unintended alterations to the filter configurations. - The `ANS104_UNBUNDLE_FILTER` environment variable is used consistently across several files, including `src/config.ts`, `src/system.ts`, and multiple test files. This consistency ensures that any changes to the parsing and canonicalization logic will have a widespread impact and must be thoroughly tested. - The suggested refactor to use `ANS104_UNBUNDLE_FILTER_PARSED` in the canonicalization process is appropriate and aligns with the existing usage patterns. - Ensure that the test cases in `test/end-to-end` are updated to reflect any changes in the parsing logic to maintain test coverage and reliability. ```diff - export const ANS104_UNBUNDLE_FILTER_STRING = canonicalize( - JSON.parse(env.varOrDefault('ANS104_UNBUNDLE_FILTER', '{"never": true}')), - ); + export const ANS104_UNBUNDLE_FILTER_STRING = canonicalize( + ANS104_UNBUNDLE_FILTER_PARSED, + ); ```

Scripts executed
The following scripts were executed for the analysis: --- Script: ```shell #!/bin/bash # Description: Verify the correct handling of environment variables for ANS104_UNBUNDLE_FILTER. # Test: Search for other usages of the ANS104_UNBUNDLE_FILTER environment variable to ensure consistency. rg --type typescript $'ANS104_UNBUNDLE_FILTER' ``` Length of output: 80 --- --- Script: ```shell #!/bin/bash # Description: Verify the correct handling of environment variables for ANS104_UNBUNDLE_FILTER. # Test: Search for other usages of the ANS104_UNBUNDLE_FILTER environment variable to ensure consistency. rg --type ts $'ANS104_UNBUNDLE_FILTER' ``` Length of output: 1513
--- `104-108`: **Refactor and Verify Environment Variable Parsing and Usage** Similar to the unbundling filter, the indexing filter constants (`ANS104_INDEX_FILTER_*`) have been refactored to use parsed and canonicalized environment variable values. This change should be verified to ensure it correctly interprets and applies the intended filter configurations without any data integrity issues. ```diff - export const ANS104_INDEX_FILTER_STRING = canonicalize( - JSON.parse(env.varOrDefault('ANS104_INDEX_FILTER', '{"never": true}')), - ); + export const ANS104_INDEX_FILTER_STRING = canonicalize( + ANS104_INDEX_FILTER_PARSED, + ); ```

Verification successful
--- **Refactor and Verify Environment Variable Parsing and Usage** The refactor for the `ANS104_INDEX_FILTER` constants appears to be consistent with the intended changes. The environment variable `ANS104_INDEX_FILTER` is used in various parts of the codebase, including tests and documentation. The updated approach using `ANS104_INDEX_FILTER_PARSED` and `ANS104_INDEX_FILTER_STRING` is correctly reflected in the `src/config.ts` and other relevant files. - **Files and lines where `ANS104_INDEX_FILTER` is used:** - `src/config.ts` - `src/system.ts` - `src/routes/ar-io.ts` - `test/end-to-end/bundler-sidecar.test.ts` - `test/end-to-end/indexing.test.ts` - `test/end-to-end/webhook.test.ts` - `test/end-to-end/data-sources.test.ts` - `docker-compose.yaml` - `README.md` - `docs/envs.md` The refactor ensures that the environment variable is parsed and canonicalized correctly, and the changes are consistently applied across the codebase.

Scripts executed
The following scripts were executed for the analysis: --- Script: ```shell #!/bin/bash # Description: Verify the correct handling of environment variables for ANS104_INDEX_FILTER. # Test: Search for other usages of the ANS104_INDEX_FILTER environment variable to ensure consistency. rg --type typescript $'ANS104_INDEX_FILTER' ``` Length of output: 77 --- --- Script: ```shell #!/bin/bash # Description: Verify the correct handling of environment variables for ANS104_INDEX_FILTER. # Test: Search for other usages of the ANS104_INDEX_FILTER environment variable to ensure consistency. rg 'ANS104_INDEX_FILTER' ``` Length of output: 1789

--- 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?

- [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.

ar-io / ar-io-node

feat(info): unbundle/index filters, supported manifest versions #156

Codecov Report