Skip to content

chore(dapi-grpc): regenerate obj-c client for count-query doc updates#3631

Merged
QuantumExplorer merged 1 commit into
v3.1-devfrom
chore/regen-objc-count-doc-comments
May 12, 2026
Merged

chore(dapi-grpc): regenerate obj-c client for count-query doc updates#3631
QuantumExplorer merged 1 commit into
v3.1-devfrom
chore/regen-objc-count-doc-comments

Conversation

@QuantumExplorer
Copy link
Copy Markdown
Member

@QuantumExplorer QuantumExplorer commented May 12, 2026

Issue being fixed or feature implemented

#3623 rewrote the proto comments on `GetDocumentsCountRequestV0.order_by` and `.limit` (in commit `0f52734820`) to reflect the final count-query semantics, but didn't re-run the obj-c codegen. The generated `Platform.pbobjc.h` still carries the pre-rewrite docstrings referencing the deleted materialize-and-count walker. This PR catches the obj-c client up.

The other generated clients (java, nodejs, python, rust, web) were already in sync at merge time — obj-c is the only outlier.

What was done?

Regenerated `packages/dapi-grpc/clients/platform/v0/objective-c/Platform.pbobjc.h` so its inline doc-comments match the proto source. Two fields updated:

  • `orderBy` — no longer claims "Required when `where` carries an `In` or range operator on the prove path". The `PointLookupProof` path sorts In keys lex-asc unconditionally and doesn't read `order_by`; only `RangeDistinctProof` makes it load-bearing for proof determinism (with empty defaulting to ascending on both prover and verifier sides).
  • `limit` — rewrote to reflect the validate-don't-clamp policy on the prove path (`InvalidLimit` rejection when over `max_query_limit`, since silent clamping would break verification) plus the `DEFAULT_QUERY_LIMIT` compile-time-constant fallback that keeps proof bytes deterministic across operators regardless of their runtime `default_query_limit` tuning.

How Has This Been Tested?

Header-only change in a generated file. No semantic difference — the docstrings are the only thing that changed. Existing CI on dapi-grpc covers the generated client structurally; no new tests warranted.

Breaking Changes

None.

Checklist:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

For repository code-owners and collaborators only

  • I have assigned this pull request to a milestone

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Enhanced documentation for request ordering and limit parameters, clarifying behavior across different execution paths, server-side clamping, determinism requirements, and default handling.

Review Change Stack

The proto comments on `GetDocumentsCountRequestV0.order_by` and
`.limit` were rewritten in #3623 (commit 0f52734) to reflect
the final count-query semantics:

- `order_by` is no longer "Required when `where` carries an `In`
  or range operator on the prove path" — that claim was tied to
  the deleted materialize-and-count walker. The `PointLookupProof`
  path sorts In keys lex-ascending unconditionally, and only
  `RangeDistinctProof` makes `order_by` load-bearing (with empty
  defaulting to ascending on both prover and verifier sides).
- `limit` is "validate-don't-clamp" on the prove path
  (`InvalidLimit` rejection when `limit > max_query_limit`)
  rather than silently clamping, because silent clamping would
  break proof verification. Unset falls back to the compile-time
  `DEFAULT_QUERY_LIMIT` constant, so proof bytes stay
  deterministic across operators regardless of their runtime
  `default_query_limit` tuning.

#3623 updated the proto file but didn't re-run the obj-c codegen,
leaving `Platform.pbobjc.h` with the pre-rewrite comments. This
catches the generated client up. No semantic change — only the
docstrings in the header file.

The other generated clients (java, nodejs, python, rust, web)
were already in sync at merge time; obj-c is the only outlier.
@github-actions github-actions Bot added this to the v3.1.0 milestone May 12, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 12, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: ed2bb457-a025-437c-b5ad-0625ae6c5023

📥 Commits

Reviewing files that changed from the base of the PR and between 030d609 and f6650fc.

📒 Files selected for processing (1)
  • packages/dapi-grpc/clients/platform/v0/objective-c/Platform.pbobjc.h

📝 Walkthrough

Walkthrough

Documentation for GetDocumentsCountRequest_GetDocumentsCountRequestV0 is expanded to clarify orderBy direction handling on split-mode responses, limit validation on prove paths versus server clamping on non-prove paths, and the explicit default limit fallback for deterministic proof bytes.

Changes

GetDocumentsCountRequest field documentation

Layer / File(s) Summary
Updated orderBy and limit field documentation
packages/dapi-grpc/clients/platform/v0/objective-c/Platform.pbobjc.h
Documentation comments for orderBy and limit fields are expanded to explain ordering direction handling in split-mode responses, proof-path ordering reconstruction, prove-path limit validation versus non-prove server clamping, and the explicit default limit fallback for deterministic proof bytes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

A rabbit hops through docs so clear,
Explaining limits far and near,
Proof paths now shine with crystal light,
Where ordering dances, all feels right! 🐰✨

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/regen-objc-count-doc-comments

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@thepastaclaw
Copy link
Copy Markdown
Collaborator

thepastaclaw commented May 12, 2026

Review Gate

Commit: f6650fc2

  • Debounce: 1m ago (need 30m)

  • CI checks: build failure: PR title

  • CodeRabbit review: comment found

  • Off-peak hours: off-peak (02:24 AM PT Tuesday)

  • Run review now (check to override)

@QuantumExplorer QuantumExplorer merged commit fa1e492 into v3.1-dev May 12, 2026
9 of 12 checks passed
@QuantumExplorer QuantumExplorer deleted the chore/regen-objc-count-doc-comments branch May 12, 2026 09:24
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