Repository navigation
Preserve main-thread cleanup admission during shutdown - #100
Conversation
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars.
 |
| Check name | Status | Explanation | Resolution |
|---|---|---|---|
| Public Api Documentation And Changelog |  |
The PR adds the protected public CheatEnginePlugin.BeginFailedEnableRollback() API with XML documentation and updates libs/CheatEngine.SDK.Hosting/README.md for the changed lifecycle admission con… |
Add a CHANGELOG.md entry under [Unreleased] that documents BeginFailedEnableRollback() and the changed inline MainThread.Invoke admission during OnEnable and OnDisable. Mark the behavior change as Breaking as required by thi… |
-
Check name Status Explanation Description Check Check skipped - CodeRabbit’s high-level summary is enabled. Title check The title "Preserve main-thread cleanup admission during shutdown" is a short imperative sentence of 54 characters with no trailing period, no Conventional Commit or area prefix, and an uppercase firs… Native Abi Evidence PASS: The PR changes only hosting lifecycle, threading, documentation, and lifecycle test files. No file under libs/CheatEngine.SDK.Abi/,native/, ortests/native-abi-fixture/changed. The revie…Lua Stack Balance Tests PASS. The pull request changes only Hosting, documentation, and Hosting test files. It does not change code under libs/CheatEngine.SDK.Lua/, libs/CheatEngine.SDK.Lua.Interop/, source-generators/CheatE… Lua Concurrency Contract PASS: The pull request does not change any file under libs/CheatEngine.SDK.Lua/Runtime/**. The custom check is therefore not applicable.Native Host Emulator Evidence PASS: The pull request does not change tests/native-host-emulator/**ortests/CheatEngine.SDK.Hosting.Tests/Coexistence/**. The changed test file is under `tests/CheatEngine.SDK.Hosting.Tests/Life…Dependency Direction No dependency-direction violation is introduced. The reviewed diff adds only SDK hosting lifecycle admission and rollback behavior in libs/CheatEngine.SDK.Hosting; it adds noCheatEngine.Clientor…Workflow Hygiene The pull request changes no files under .github/. The workflow hygiene conditions therefore do not apply.Public Api And Compatibility PASS. The pull request adds one protected API, CheatEnginePlugin.BeginFailedEnableRollback(), inlibs/CheatEngine.SDK.Hosting/Plugin/CheatEnginePlugin.csand records it in the owning library's `Pu…Full details: Title check
-
Explanation
The title "Preserve main-thread cleanup admission during shutdown" is a short imperative sentence of 54 characters with no trailing period, no Conventional Commit or area prefix, and an uppercase first letter, so it meets the title requirements. It matches the main change: the PR keeps main-thread inline dispatch open during OnEnable/OnDisable and failed-enable rollback so owned cleanup can finish during shutdown, as the changed PluginHost, MainThread, and CheatEnginePlugin files show.
Full details: Native Abi Evidence
-
Explanation
PASS: The PR changes only hosting lifecycle, threading, documentation, and lifecycle test files. No file under
libs/CheatEngine.SDK.Abi/,native/, ortests/native-abi-fixture/changed. The reviewed diff also adds or changes noStructLayout,FieldOffset, function-pointer signature,UnmanagedCallersOnly, orLibraryImportdeclaration. The native ABI evidence requirement is therefore not applicable.
Full details: Lua Stack Balance Tests
-
Explanation
PASS. The pull request changes only Hosting, documentation, and Hosting test files. It does not change code under libs/CheatEngine.SDK.Lua/, libs/CheatEngine.SDK.Lua.Interop/, source-generators/CheatEngine.SDK.SourceGenerators.LuaBindings/, or native/cheatengine-sdk-lua-bridge/. The Lua stack balance criteria therefore do not apply.
Full details: Native Host Emulator Evidence
-
Explanation
PASS: The pull request does not change
tests/native-host-emulator/**ortests/CheatEngine.SDK.Hosting.Tests/Coexistence/**. The changed test file is undertests/CheatEngine.SDK.Hosting.Tests/Lifecycle/, so this check is not applicable.
Full details: Dependency Direction
-
Explanation
No dependency-direction violation is introduced. The reviewed diff adds only SDK hosting lifecycle admission and rollback behavior in
libs/CheatEngine.SDK.Hosting; it adds noCheatEngine.ClientorCheatEngine.Mcpreference, namespace, or package reference. No project file changed, and no newPackageReferencewas added undersrc/orlibs/. The added behavior is SDK lifecycle policy, not Client fluent API, dependency-injection registration, or application workflow policy.
Full details: Public Api And Compatibility
-
Explanation
PASS. The pull request adds one protected API,
CheatEnginePlugin.BeginFailedEnableRollback(), inlibs/CheatEngine.SDK.Hosting/Plugin/CheatEnginePlugin.csand records it in the owning library'sPublicAPI.Unshipped.txt. The diff does not changePublicAPI.Shipped.txt,CompatibilitySuppressions.xml, or anypackages.lock.jsonfile.
-
Full details: Public Api Documentation And Changelog
-
Explanation
The PR adds the protected public
CheatEnginePlugin.BeginFailedEnableRollback()API with XML documentation and updateslibs/CheatEngine.SDK.Hosting/README.mdfor the changed lifecycle admission contract. However, the PR does not modifyCHANGELOG.md, and[Unreleased]remains empty. The PR therefore lacks the required matching changelog entry, including a breaking marker for the lifecycle behavior change.Resolution
Add a
CHANGELOG.mdentry under[Unreleased]that documentsBeginFailedEnableRollback()and the changed inlineMainThread.Invokeadmission duringOnEnableandOnDisable. Mark the behavior change as Breaking as required by this check.
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
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.
Comment @coderabbitai help to get the list of available commands.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
-
-
- Source mode: Auto
- Repository: CheatEngineNet/CheatEngine.SDK
- Branch: codex/lifecycle-cleanup-20261025
- File: .coderabbit.yaml
- Commit: 1e45f32
- Layers: Repository YAML
- Review profile: ASSERTIVE
- Plan: Advanced
- Run ID:
e220f611-0d01-44dd-8197-17eaacafdc6d
-
libs/CheatEngine.SDK.Hosting/Bootstrap/PluginHost.Lifecycle.cslibs/CheatEngine.SDK.Hosting/Bootstrap/PluginHost.cslibs/CheatEngine.SDK.Hosting/Plugin/CheatEnginePlugin.cslibs/CheatEngine.SDK.Hosting/PublicAPI.Unshipped.txtlibs/CheatEngine.SDK.Hosting/README.mdlibs/CheatEngine.SDK.Hosting/Threading/MainThread.cstests/CheatEngine.SDK.Hosting.Tests/Lifecycle/AdmissionLifecycleTests.cstests/CheatEngine.SDK.Hosting.Tests/README.md
🔗 Linked repositories identified
-
CodeRabbit considers these linked repositories for cross-repo context during reviews:
CheatEngineNet/CheatEngine.Client(manual) → reviewed against open PR#70codex/lifecycle-cleanup-20261025instead of the default branch
Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.
-
|
Summary
Plugin shutdown and failed-enable rollback need a bounded way to finish owned cleanup after normal admission closes. Capture the main-thread lifecycle context, permit inline dispatch within that scope, and expose the failed-enable rollback transition consumed by Client hosting. Reject rollback initiated inside nested dispatch work before changing shutdown state, preventing the caller from waiting for its own admission lease.
Scope and ownership
SDK owns the host admission and main-thread dispatch boundary. This adds protected
CheatEnginePlugin.BeginFailedEnableRollback()and updates the unshipped API inventory. No stable API is removed.Validation
dotnet test --project externals/CheatEngine.SDK/tests/CheatEngine.SDK.Hosting.Tests -c Release --no-restore --filter-class '*AdmissionLifecycleTests' --filter-class '*ReentrancyTests' --fail-skips on, with Lua 5.3Compatibility and release impact
Client's companion change consumes the new protected SDK method. Publish a compatible SDK package before releasing the paired Client package. Consumer-visible changes are recorded under Unreleased. This change preserves the tested source integration; it does not claim standalone package or native host qualification.
Checklist
PublicAPI.Unshipped.txt.Summary
MainThread.Invokenow admits inline work on the captured main thread duringOnEnableandOnDisable. Worker dispatch remains closed during those callbacks.CheatEnginePlugin.BeginFailedEnableRollback()for synchronous cleanup afterOnEnablefailure. The host closes general admission and signals shutdown; activation cannot complete if rollback was signaled.Tests