feat: add info request for PET metadata including version and build ID#470
Merged
Conversation
Test Coverage Report (Linux)
Coverage unchanged. |
Performance Report (Linux) ➖
Legend
|
Performance Report (macOS)
Legend
|
Performance Report (Windows) ✅
Legend
|
Test Coverage Report (Windows)
Coverage decreased. Please add tests for new code. |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a JSONRPC info request so clients can retrieve PET binary metadata for telemetry and diagnostics.
Changes:
- Documents the new
inforequest andInfoResponseshape. - Adds server handling for
info, returning package version and optional CI build ID. - Adds unit/integration test coverage and a test client helper for the new request.
Show a summary per file
| File | Description |
|---|---|
docs/JSONRPC.md |
Documents the new info JSONRPC API. |
crates/pet/src/jsonrpc.rs |
Registers and implements the info request handler. |
crates/pet/build.rs |
Embeds an optional build ID from CI/build environment variables. |
crates/pet/tests/jsonrpc_client.rs |
Adds test client response type and helper for info. |
crates/pet/tests/jsonrpc_server_test.rs |
Adds an integration test for the info request. |
Copilot's findings
- Files reviewed: 5/5 changed files
- Comments generated: 1
rchiodo
reviewed
May 29, 2026
| @@ -1512,6 +1536,17 @@ mod tests { | |||
| ); | |||
| } | |||
There was a problem hiding this comment.
Copilot generated:
-1552
The build_id assertion .is_none_or(|build_id| !build_id.is_empty()) is tautological — InfoResponse::current() already filters empty strings via .filter(|value| !value.is_empty()), so build_id can only ever be None or Some(non_empty). This assertion cannot fail regardless of implementation behavior. Consider adding a brief comment explaining why the assertion is intentionally weak (env var absent in local builds), or simply drop the build_id check and only assert pet_version.
[verified]
rzhao271
approved these changes
May 29, 2026
Contributor
|
Briefly looked into how to map envs extension version number to PET commit sha from telemetry, so we can correlate regressions to PET changes. I am thinking about this mechanism, will get to the implementation details next week. 
|
StellaHuang95
approved these changes
Jun 5, 2026
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
StellaHuang95
force-pushed
the
sympathetic-eagle
branch
from
1d301e7 to
9081560
Compare
eleanorjboyd
pushed a commit
that referenced
this pull request
Jun 9, 2026
…ression tracking (#473) ## Background PET (Python Environment Tools) is a Rust-based JSONRPC server used by the VS Code Python extension to discover Python environments. PET does not send its own telemetry — instead, it returns metadata to the calling extension (vscode-python-environments), which forwards it via telemetry. To help catch regressions, we need a way to know exactly which PET build a user is running by querying telemetry. [PR #470](#470) added a JSONRPC `info` request that returns PET's version and an optional CI build ID. However, the build number alone isn't enough to pinpoint the exact source code — we also need the git commit hash. This PR extends the `info` response to include the **git commit SHA** baked into the binary at build time. On the extension side, the companion PR ([vscode-python-environments#1548](microsoft/vscode-python-environments#1548)) passes this information along to telemetry, so we can correlate user-reported issues or regressions back to the specific PET commit. ## What Changed ### 1. Build script (`crates/pet/build.rs`) - Added support for three new environment variables that CI systems set automatically: - `PET_COMMIT_SHA` — explicit override (highest priority) - `BUILD_SOURCEVERSION` — set by Azure Pipelines - `GITHUB_SHA` — set by GitHub Actions - When any of these is present and non-empty, the value is embedded into the binary as a compile-time constant via `cargo:rustc-env=PET_COMMIT_SHA=...`. ### 2. JSONRPC response (`crates/pet/src/jsonrpc.rs`) - Added a new optional `commit_sha` field to the `InfoResponse` struct. - `InfoResponse::current()` populates it from the compile-time `PET_COMMIT_SHA` env var (same pattern used for `build_id`). - For local dev builds where no CI env var is set, the field is `None` and omitted from the JSON response. ### 3. JSONRPC documentation (`docs/JSONRPC.md`) - Updated the `InfoResponse` TypeScript interface to document the new `commitSha?: string` field, including where the value is sourced from. ### 4. Tests (`crates/pet/src/jsonrpc.rs`, `crates/pet/tests/jsonrpc_server_test.rs`, `crates/pet/tests/jsonrpc_client.rs`) - Added `commit_sha` field to the test client's `PetInfoResponse` struct. - Added assertions that `commit_sha`, when present, is non-empty (mirrors existing `build_id` assertion pattern). - Added clarifying comments explaining that both `build_id` and `commit_sha` are `None` in local dev builds and only populated in CI. ## How It Works ``` CI build (Azure Pipelines / GitHub Actions) ↓ sets BUILD_SOURCEVERSION or GITHUB_SHA build.rs captures it → bakes into binary as PET_COMMIT_SHA ↓ JSONRPC `info` request → returns { petVersion, buildId, commitSha } ↓ vscode-python-environments extension → includes commitSha in telemetry ↓ Team queries telemetry → correlates regressions to exact PET commit ``` ## Related PRs - [PET PR #470](#470) — Added the `info` JSONRPC request with version and build ID (merged) - [vscode-python-environments PR #1548](microsoft/vscode-python-environments#1548) — Extension-side: passes PET version/build/commit info to telemetry
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.