Skip to content

[CHORE]: enforce default limit on get when none is supplied #4942

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

Open
wants to merge 24 commits into
base: main
Choose a base branch
from

Conversation

c-gamble
Copy link
Contributor

@c-gamble c-gamble commented Jun 25, 2025

Description of changes

⚠️Stacked with #4941, which should be merged first.

Enforces a default limit of 1000 on get, list_collections, and list_databases when none is provided, only on the service-based frontend.

Test plan

  • Tests pass locally with pytest for python, yarn test for js, cargo test for rust

Documentation Changes

N/A

Copy link

Reviewer Checklist

Please leverage this checklist to ensure your code review is thorough before approving

Testing, Bugs, Errors, Logs, Documentation

  • Can you think of any use case in which the code does not behave as intended? Have they been tested?
  • Can you think of any inputs or external events that could break the code? Is user input validated and safe? Have they been tested?
  • If appropriate, are there adequate property based tests?
  • If appropriate, are there adequate unit tests?
  • Should any logging, debugging, tracing information be added or removed?
  • Are error messages user-friendly?
  • Have all documentation changes needed been made?
  • Have all non-obvious changes been commented?

System Compatibility

  • Are there any potential impacts on other parts of the system or backward compatibility?
  • Does this change intersect with any items on our roadmap, and if so, is there a plan for fitting them together?

Quality

  • Is this code of a unexpectedly high quality (Readability, Modularity, Intuitiveness)

Copy link
Contributor

propel-code-bot bot commented Jun 25, 2025

Enforce Default and Maximum Limits for get, list_collections, and list_databases (Service-Based Frontend)

This PR enforces a default maximum limit (1000) for collection and database listing and 'get' operations in the Rust service-based frontend when the client does not specify a limit. It also ensures that client-supplied limits exceeding this maximum result in a validation error, making API behavior more predictable and resilient. Test utilities and invariants are updated in Python to support and test this behavior.

Key Changes:
• Introduced a ensure_limit function in Rust to consistently enforce default and maximum result limits for get, list_collections, and list_databases.
• Added a new MaximumLimitExceededError error type for validation when supplied limits exceed the allowed maximum.
• Updated sysdb, service_based_frontend, and API types to propagate and surface invalid limit errors.
• Internal quota and default value handling for result limits refactored for maintainability and code reuse.
• Introduced a Python test constant MAX_DOCUMENTS and a paginated_get utility to validate and handle large test collections efficiently.
• Refactored Python property-based invariants to use paginated retrieval, supporting collections larger than the limit.

Affected Areas:
• Rust service-based frontend (get/list endpoints, sysdb, quota utils, error types)
• Python property-based testing and invariants for collections
• Test infrastructure and constants for maximum document handling

This summary was automatically generated by @propel-code-bot

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.

1 participant