test(rivetkit-core): cover sleep/destroy guards and prevent_sleep no-op

[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]

• chore(kitchen-sink): configurable endpoint #4766 : 3 dependent PRs (#4754 , #4777 , #4778 )
• 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 👈 (View in Graphite)
• 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

PR: test(rivetkit-core): cover sleep/destroy guards and prevent_sleep no-op
Scope: 87 additions, 0 deletions — pure test additions to rivetkit-rust/packages/rivetkit-core/src/actor/sleep.rs

Summary

This PR adds 6 targeted tests verifying documented invariants from the rivetkit-core CLAUDE.md. The coverage is well-chosen and the test structure is consistent with existing tests in the module.

Strengths

• Invariant coverage matches the spec. The rivetkit-core CLAUDE.md explicitly states ctx.sleep() and ctx.destroy() return ActorLifecycleError::Starting before startup and ActorLifecycleError::Stopping on re-request. Each new test pins exactly one of those behaviors.
• Deprecated no-op tested both ways. set_prevent_sleep_is_a_deprecated_noop calls the API with both true and false and asserts can_sleep() returns CanSleep::Yes in both cases.
• Precise error assertions. Tests assert both group() and code(), tying them to the canonical RivetError taxonomy rather than just checking that an error occurred.
• Inline test placement is justified. The tests need pub(crate) helpers (new_for_sleep_tests, set_sleep_started, can_sleep, etc.) that are inaccessible from an external tests/ crate. The CLAUDE.md exception for private internals applies.

Minor Issues

1. Comment describes "what", not "why"

In set_prevent_sleep_is_a_deprecated_noop:

// The sleep predicate ignores prevent_sleep entirely.
assert_eq!(ctx.can_sleep().await, CanSleep::Yes);

CLAUDE.md says to write comments only when the why is non-obvious, not to describe what the code does. The assert! message above already states the intent. Either remove this line or replace it with the invariant it encodes (e.g. "no CanSleep::PreventSleep variant; set_prevent_sleep is kept only for NAPI bridge compat").

2. Cross-guard scenarios not tested (optional follow-up)

sleep_requested and destroy_requested are independent atomics. Calling sleep() after destroy() has been requested (and vice versa) succeeds silently today. If this is intentional, a comment in the source or a test pinning that behavior would prevent someone from incorrectly adding a cross-guard later.

Not Issues

• double_sleep / double_destroy omit set_ready(true): correct — sleep()/destroy() gate only on sleep.started, not sleep.ready.
• The first sleep() in double_sleep spawns a tracked shutdown task internally. This does not affect the sleep_requested atomic read by the second call, so the test is sound.
• The second can_sleep().await in set_prevent_sleep_is_a_deprecated_noop is technically redundant, but confirming both true and false arguments leave the result unchanged is reasonable for a two-state no-op.

Verdict

Clean, well-scoped test additions. The comment-style issue is minor and does not block merging. The cross-guard gap is a follow-up, not a blocker.

[github-actions]

Preview packages published to npm

Install with:

npm install rivetkit@pr-4750

All packages published as 0.0.0-pr.4750.8a663b7 with tag pr-4750.

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-8a663b7
docker pull rivetdev/engine:full-8a663b7

Individual packages

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