Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump page token size to 1MB from 4KB #252

Merged
merged 1 commit into from
Nov 8, 2024
Merged

Conversation

jirwin
Copy link
Contributor

@jirwin jirwin commented Nov 7, 2024

  • Bumps the validation rules on page tokens for list resource types, resources, grants, and entitlements to 1MB

When APIs don't support proper pagination, it forces us to store more state in our own pagination tokens in order to have reliable state. We've come across a use case where the amount of state we need to store is >4KB, which results in validation errors when returning a large token. In this case, the stored token is hundreds of KB, so going to 1MB should give us some headroom.

The max gRPC message size is 4MB. If we're paginating properly, 3MB should hopefully be enough for the contents of any results returned.

Summary by CodeRabbit

  • New Features

    • Increased maximum byte limits for PageToken and NextPageToken fields across various services, enhancing the capacity for handling larger data in requests and responses.
  • Bug Fixes

    • Updated validation error messages to accurately reflect the new length constraints for token fields.

Copy link

coderabbitai bot commented Nov 7, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The changes made in this pull request involve updates to the validation logic for various structures across multiple files related to entitlement, grant, and resource services. Specifically, the maximum length constraints for the PageToken and NextPageToken fields have been increased from 4096 bytes to 1048576 bytes in several request and response messages. The validation error messages have been updated accordingly to reflect these new limits. The overall structure and flow of the validation methods remain unchanged.

Changes

File Path Change Summary
pb/c1/connector/v2/entitlement.pb.validate.go Updated validation logic for EntitlementsServiceListEntitlementsRequest and EntitlementsServiceListEntitlementsResponse to increase PageToken and NextPageToken max length to 1048576 bytes.
pb/c1/connector/v2/grant.pb.validate.go Modified validation for GrantsServiceListGrantsRequest, GrantsServiceListGrantsResponse, and GrantManagerServiceRevokeRequest to increase PageToken and NextPageToken max length to 1048576 bytes.
pb/c1/connector/v2/resource.pb.validate.go Updated validation for ResourcesServiceListResourcesRequest, ResourcesServiceListResourcesResponse, ResourceTypesServiceListResourceTypesRequest, and ResourceTypesServiceListResourceTypesResponse to increase PageToken and NextPageToken max length to 1048576 bytes.
proto/c1/connector/v2/entitlement.proto Increased page_token and next_page_token max byte size from 4096 to 1048576 in EntitlementsServiceListEntitlementsRequest and EntitlementsServiceListEntitlementsResponse.
proto/c1/connector/v2/grant.proto Updated page_token and next_page_token max byte size from 4096 to 1048576 in GrantsServiceListGrantsRequest and GrantsServiceListGrantsResponse.
proto/c1/connector/v2/resource.proto Changed page_token and next_page_token max byte size from 4096 to 1048576 in ResourcesServiceListResourcesRequest, ResourcesServiceListResourcesResponse, ResourceTypesServiceListResourceTypesRequest, and ResourceTypesServiceListResourceTypesResponse.

Poem

In the land of bytes, where tokens grow,
A rabbit hops fast, with data in tow.
From four thousand to one million more,
Our requests now can carry much more!
Hooray for the change, let the data flow,
Bigger tokens for all, let the services glow! 🐇✨


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

@jirwin jirwin merged commit 333509d into main Nov 8, 2024
4 checks passed
@jirwin jirwin deleted the jirwin/bump-page-token-size branch November 8, 2024 00:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants