Repository navigation
feat(settings): typed persistent preferences and readiness - #919
Conversation
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
|
No actionable comments were generated in the recent review.
 |
| Layer / File(s) | Summary |
|---|---|
Settings lifecycle and API src/settings.zig, src/root.zig, docs/settings.md, build.zig.zon |
Settings(T, Codec, max_bytes) tracks live and queued values and manages asynchronous reads and writes. Tests cover readiness, edits, save snapshots, read and write failures, and disabling. The root module exports settings. The guide documents the lifecycle and constraints. The package version changes to 4.1.1, and the package paths include the guide. |
Build and CI checks build.zig, test/settings_compile.zig, .github/workflows/ci.yml |
The general test step and a separate test-settings step run the settings tests. A compile-check exercises the settings API. CI also compiles the settings test root for WebAssembly Emscripten and Android without emitting binaries. |
Priority:
Estimated code review effort: 3 (Moderate) | ~25 minutes
Change: Feature
Sequence Diagram(s)
sequenceDiagram
participant Caller
participant Settings
participant Store as storage.Store
participant Codec
Caller->>Settings: pump(store)
Settings->>Store: start bounded read
Store-->>Settings: read result
Settings->>Codec: decode stored data
Settings->>Store: write queued snapshot after loading
Merge Risk: 
20b7f
-
No actionable issue is identified that would prevent merging after normal checks.
Pre-merge checks: 
-
Check name Status Explanation Title check The title clearly identifies the main change: adding typed persistent settings with readiness handling. Description check The description directly explains the new Settings API, persistence behavior, supported use cases, versioning, and validation results. Docstring Coverage No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat… Linked Issues check Check skipped because no linked issues were found for this pull request. Out of Scope Changes check Check skipped because no linked issues were found for this pull request. Full details: Docstring Coverage
-
Explanation
No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (7 skipped: 7 unsupported.)
-
Finishing Touches
-
🧪 Generate unit tests (beta)
-
- Commit to this branch
- Create a new PR
-
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Comment @coderabbitai help to get the list of available commands.
Add engine.settings.Settings(T, Codec, max_bytes) over the existing storage Store. Games retain their serialized formats and platform providers while sharing async readiness, safe load/edit ordering, snapshot saves, coalesced writes and in-memory fallback. This supports FP language restoration before translated UI and migrates its existing sound settings without changing stored JSON.
Prepares stable 4.1.1. FP currently consumes 4.2.0-rc.1; the settings addition will also be carried onto that release-candidate line without merging unrelated navigation work into stable.
Validation: five lifecycle regression tests pass on Windows; public read/write lifecycle compiles for wasm32-emscripten and aarch64-linux-android. Both checks are in CI. See docs/settings.md for ownership, startup gating and error semantics.