Skip to content

Re-vendor api.proto (201 -> 236 RPCs) and update testkit stubs #1

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.

Sign up for GitHub

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

Merged
nicolaslara merged 2 commits into from
Aug 8, 2026
Merged

Re-vendor api.proto (201 -> 236 RPCs) and update testkit stubs #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
420d2bd
chore(proto): re-vendor api.proto (201 -> 236 RPCs) + 35 mock stub arms
nicolaslara Aug 7, 2026
256fff1
fix(testkit): environment_get_or_create stub — EnvironmentMetadata ga…
nicolaslara Aug 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions crates/modal-rust-sdk/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@ higher-level `modal-rust` facade (decorator, `.local()` / `.remote()`, deploy +
features dropped) + `prost`, `serde` + `serde_cbor`, `toml`, `reqwest`
(rustls only — no system OpenSSL), `sha2`, `walkdir`, `ignore`. The vendored
proto (`proto/api.proto`) is copied verbatim from the official Modal Python
SDK; the auth/channel/codec *structure* follows the unofficial `modal-rs`, but
SDK — see [`proto/SOURCE.toml`](proto/SOURCE.toml) for the exact upstream
revision and the re-vendoring steps; the auth/channel/codec *structure*
follows the unofficial `modal-rs`, but
**neither is a build- or run-time dependency** (both are read-only references;
see `NOTICE`).
- **Auth + channel.** Credentials/endpoint resolve from the environment or
Expand Down Expand Up @@ -47,7 +49,7 @@ higher-level `modal-rust` facade (decorator, `.local()` / `.remote()`, deploy +

## Coverage matrix (control plane)

Scope: this crate currently calls **18 distinct RPCs** out of the ~200 in the
Scope: this crate currently calls **18 distinct RPCs** out of the ~240 in the
vendored `proto/api.proto`. The matrix below is grouped by object/area. Status:
**Implemented** = we call this RPC in `ops/*` or `client.rs`; **Partial** = the
RPC is called but only a subset of its semantics/fields is exercised;
Expand Down
26 changes: 26 additions & 0 deletions crates/modal-rust-sdk/proto/SOURCE.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Provenance for the vendored `api.proto`.
#
# `proto/api.proto` is a byte-for-byte copy of Modal's public client proto.
# `crates/modal-rust-testkit/proto/api.proto` is the same file with a one-line
# "keep in sync" header prepended; both are compiled by their crate's build.rs.
#
# To re-vendor:
# curl -sL "$url" -o crates/modal-rust-sdk/proto/api.proto
# { echo '// copied verbatim from crates/modal-rust-sdk/proto/api.proto; keep in sync.'; \
# cat crates/modal-rust-sdk/proto/api.proto; } > crates/modal-rust-testkit/proto/api.proto
# cargo test # new/changed RPCs surface as missing ModalClient trait methods
#
# Then update `commit` and `synced` below, and add a `mock_unimplemented!` arm in
# crates/modal-rust-testkit/src/servicer.rs for every RPC the SDK does not call.

repo = "https://github.com/modal-labs/modal-client"
path = "modal_proto/api.proto"
url = "https://raw.githubusercontent.com/modal-labs/modal-client/main/modal_proto/api.proto"

# Upstream commit this copy was taken at.
commit = "1d53eec296"
commit_date = "2026-08-07"
synced = "2026-08-07"

# 236 RPCs on service ModalClient at this revision.
rpc_count = 236
Loading