test(runner-configs): assert envoy protocol version

[NathanFlurry]

Description

Please include a summary of the changes and the related issue. Please also include relevant motivation and context.

Type of change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes.

Checklist:

• My code follows the style guidelines of this project
• I have performed a self-review of my 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

[NathanFlurry]

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

• fix(test): stabilize lifecycle, sleep, queue, and run edge cases #4660 : 2 dependent PRs (#4664 , #4665 )
• test(rivetkit): re-enable gateway URL and direct-registry coverage #4659
• fix(rivetkit): keep internal error exposure behavior consistent #4661
• fix(rivetkit): add lifecycle error retry and gateway HTTP routing #4666
• fix(rivetkit-core): remove legacy timeouts #4799
• chore: add CLAUDE.md guidance on test fixtures, SDK regen, and TS client layer #4796
• fix(inspector): stream patched state updates #4795
• fix(rivetkit): refresh stale actor handles #4794
• test(rivetkit-napi): move private tests to crate root #4793
• test(rivetkit-core): move private tests to crate root #4792
• test(runner-configs): assert envoy protocol version #4791 👈 (View in Graphite)
• fix(serverless): split metadata protocol errors #4789 : 1 other dependent PR (#4790 )
• chore(sqlite): add open close lifecycle for envoy actors #4788
• fix(rivetkit): share lifecycle shutdown grace #4810
• fix(pegboard): move sqlite v1 migration into actor workflow #4787 : 1 other dependent PR (#4797 )
• test(rivetkit): cover c.db access from onWake/onSleep/onDestroy #4786
• fix(rivetkit-napi): run onMigrate before createState/onCreate/createVars #4785
• refactor(rivetkit-core): merge ready+started into lifecycle_started, drop redundant napi calls #4784
• fix(rivetkit): drain native sleep side tasks reliably #4782 : 1 other dependent PR (#4783 )
• fix(rivetkit): route raw request fetches to actors #4781
• fix(pegboard): refresh runner config after envoy connect #4778 : 2 other dependent PRs (#4779 , #4798 )
• chore(kitchen-sink): configurable endpoint #4766 : 2 other dependent PRs (#4754 , #4777 )
• refactor(rivetkit-core): rename StopReason to ShutdownKind and kill enum fallthroughs #4765
• chore(envoy-client): log command and event payloads #4751
• fix(rivetkit): minor sleep-cleanup follow-ups #4761
• docs(rivetkit): clean up stale setPreventSleep references in docs and JSDoc #4760
• docs(rivetkit): document keepAwake/waitUntil counter-arm race and surface bridge errors #4759
• test(engine): force overdue branch in alarm-during-sleep test with negative offset #4758
• fix(rivetkit-core): return stopping not starting when sleep/destroy called mid-shutdown #4757
• test(rivetkit): remove sleepWithPreventSleep fixture and tests #4756
• test(engine): add regression test for alarm-during-sleep-transition race #4755
• test(rivetkit-core): cover sleep/destroy guards and prevent_sleep no-op #4750
• docs: add keepAwake vs waitUntil table and internal sleep-sequence invariants #4749
• feat(rivetkit): expose c.keepAwake(promise) through native path #4748
• refactor(rivetkit): deprecate setPreventSleep to no-op in TypeScript #4747
• fix(rivetkit-core): enumerate non-drained counters in grace deadline warn log #4746
• fix(rivetkit-core): abort graceful cleanup task when grace deadline elapses #4745
• fix(rivetkit-core): error on sleep/destroy before startup or already-requested #4743
• fix(rivetkit-core): cap SerializeState shutdown timeout at 15s #4742
• refactor(rivetkit-core): remove prevent_sleep field and deprecate set_prevent_sleep to no-op #4741
• fix(api-public): remove orphan import_export actors module #4764
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

[claude]

Code Review: test(runner-configs): assert envoy protocol version

Overview

This PR adds a single integration test — list_runner_configs_includes_envoy_protocol_version — that verifies the protocol_version field is correctly populated with the envoy protocol version when listing runner configs via the public API.

---

Positives

• Focused test: Tests exactly one behavior (protocol version propagation in list response) without scope creep.
• Correct setup helper: Uses setup_test_namespace_with_envoy which is the right helper for envoy-backed tests, consistent with other envoy tests in the suite.
• Filtered query: Passes runner_name: vec![envoy.pool_name().to_string()] to scope the response to just the envoy's pool, preventing pollution from other test runners.
• Proper cleanup: Calls envoy.shutdown().await at the end, consistent with other tests that spin up envoys.
• Correct constant: Uses common::test_envoy::PROTOCOL_VERSION which is a re-export of rivet_envoy_protocol::PROTOCOL_VERSION — the canonical source of truth, matching how other protocol version assertions are written (e.g. api_runner_configs_refresh_metadata.rs).
• Style: Trailing commas in assert_eq!, lowercase error strings, and overall formatting match the project conventions.

---

Suggestions

1. Parity gap in the top-level test directory

CLAUDE.md requires: "Any behavior, protocol handling, or test coverage added to one runner should be mirrored in the other runner in the same change whenever possible." There is already a top-level api_runner_configs_refresh_metadata.rs (non-runner path) that tests protocol version behavior, with a parallel version at tests/runner/api_runner_configs_refresh_metadata.rs. There is no top-level api_runner_configs_list.rs. If the non-runner list path also exposes protocol_version, a symmetric test should be added in the same PR. If that path does not support it yet, the gap should be documented in .agent/todo/.

2. No before-state assertion

The test only asserts that protocol_version equals the expected value after setup. A before-vs-after contrast (like api_runner_configs_refresh_metadata.rs does with its expose_protocol_version toggle) is not needed here since this is not a refresh test. As long as setup_test_namespace_with_envoy waits for the envoy to register its metadata before returning, the assertion is deterministic and this is fine as-is.

3. Unused tuple element

The second element of the destructured tuple from setup_test_namespace_with_envoy is silently dropped (let (namespace, _, envoy) = ...). This is idiomatic and consistent with the existing pattern in the file.

---

Summary

The test is clean, well-scoped, and follows project conventions correctly. The main open question is whether a corresponding test should be added to the non-runner top-level test path. If that path is out of scope for this PR, document the gap in .agent/todo/ per the CLAUDE.md parity requirement.

[github-actions]

Preview packages published to npm

Install with:

npm install rivetkit@pr-4791

All packages published as 0.0.0-pr.4791.e602178 with tag pr-4791.

Engine binary is shipped via @rivetkit/engine-cli on linux-x64-musl, linux-arm64-musl, darwin-x64, and darwin-arm64. Windows users should use the release installer or set RIVET_ENGINE_BINARY.

Docker images:

docker pull rivetdev/engine:slim-e602178
docker pull rivetdev/engine:full-e602178

Individual packages

npm install rivetkit@pr-4791
npm install @rivetkit/react@pr-4791
npm install @rivetkit/rivetkit-napi@pr-4791
npm install @rivetkit/workflow-engine@pr-4791

[NathanFlurry]

Landed in main via stack-merge fast-forward push. Commits are in main; closing to match.