Add splits support

[adamnolte]

Summary by CodeRabbit

• New Features
  • Enhanced API functionality to support optional split data in GET requests, allowing users to retrieve additional information.
• Bug Fixes
  • Updated method signatures and return types to ensure accurate data handling and response structure.

[coderabbitai]

📝 Walkthrough

Walkthrough

The AutoblocksAPIClient class in src/client.ts has been updated to enhance its method signature by adding an optional splits property. This new parameter allows the method to accept an array of strings, enabling the construction of a query parameter for splits during GET requests. Additionally, the return type of the method has been modified to include the splits data in the response, reflecting these changes in the promise's returned items.

Changes

File	Change Summary
src/client.ts	Updated method signature to include optional splits parameter as an array of strings. Modified return type to include splits in the items of the returned promise.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant AutoblocksAPIClient
    participant API

    Client->>AutoblocksAPIClient: Call method with splits
    AutoblocksAPIClient->>API: Make GET request with splits query parameter
    API-->>AutoblocksAPIClient: Return response with splits data
    AutoblocksAPIClient-->>Client: Return promise with items including splits

Loading

---

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
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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.

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 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 for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

src/client.ts (1)

288-290: Consider simplifying the splitsQueryParam construction

The current implementation is correct, but it can be simplified for better readability and to avoid potential issues with undefined values.

Consider using this alternative implementation:

-    const splitsQueryParam = args.splits
-      ? `?splits=${args.splits?.map(encodeURIComponent).join(',')}`
-      : '';
+    const splitsQueryParam = args.splits && args.splits.length > 0
+      ? `?splits=${args.splits.map(encodeURIComponent).join(',')}`
+      : '';

This change ensures that we only add the query parameter when splits is both defined and non-empty, which is likely the intended behavior.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between e86368e and 23390fd.

📒 Files selected for processing (1)

• src/client.ts (1 hunks)

🔇 Additional comments (3)

src/client.ts (3)

275-275: LGTM: Method signature and return type updates

The changes to the method signature and return type are correct and consistent with the PR objective of adding splits support.

Also applies to: 282-283

---

295-295: LGTM: Correct usage of splitsQueryParam

The splitsQueryParam is correctly appended to both URL constructions, ensuring that the splits are included in the request regardless of whether a specific revision is being fetched or not.

Also applies to: 300-300

---

275-300: Summary: Successful implementation of splits support

The changes made to the getDataset method effectively implement the splits support as intended in the PR objective. The method signature, return type, and URL construction have been updated consistently to handle the new splits parameter. This enhancement allows for more flexible querying of datasets by supporting split-based filtering.

A few key points:

1. The splits parameter is optional, maintaining backward compatibility.
2. The return type now includes splits information for each item, providing more detailed data to the caller.
3. The URL construction logic correctly handles the presence or absence of the splits parameter.

These changes enhance the functionality of the AutoblocksAPIClient class without breaking existing usage, which is a good practice for API evolution.