Skip to content

Add captured demo logs and a cache traceability report - #199

Open
koriym wants to merge 2 commits into
bearsunday:1.xfrom
koriym:demo-logs-traceability-report
Open

Add captured demo logs and a cache traceability report#199
koriym wants to merge 2 commits into
bearsunday:1.xfrom
koriym:demo-logs-traceability-report

Conversation

@koriym

@koriym koriym commented Aug 19, 2026

Copy link
Copy Markdown
Member

Captured output (tree + JSON, schema-validated) of the four self-verifying demos, committed under demo/logs/, and a report on how much cache traceability and explicitness improved in the next release (docs/cache-traceability-report.md, English and Japanese).

Neither ships in a release: demo/ and docs/ are already export-ignored, verified with git archive.

demo/logs/ holds the validated session output (tree + JSON) of all four
demos; the whole demo/ and docs/ trees are already export-ignored, so
neither the logs nor the report ships in a release archive.
@coderabbitai

coderabbitai Bot commented Aug 19, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: dec71080-d825-4251-b8b1-3d3d890a2052

📥 Commits

Reviewing files that changed from the base of the PR and between 283badd and 39fafe5.

⛔ Files ignored due to path filters (4)
  • demo/logs/run-degraded.log is excluded by !**/*.log
  • demo/logs/run-dependency.log is excluded by !**/*.log
  • demo/logs/run-donut.log is excluded by !**/*.log
  • demo/logs/run.log is excluded by !**/*.log
📒 Files selected for processing (3)
  • demo/run-degraded.php
  • docs/cache-traceability-report.ja.md
  • docs/cache-traceability-report.md

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The pull request adds English and Japanese cache traceability reports. It also updates degraded-path demo text to use the requestedTtl log field and describe the recorded TTL values.

Changes

Cache traceability

Layer / File(s) Summary
Cache traceability report
docs/cache-traceability-report.md, docs/cache-traceability-report.ja.md
The reports document twelve cache conditions, typed event fields, schemas, validation evidence, test results, and logging boundaries.
Degraded demo output alignment
demo/run-degraded.php
The session-I output now uses requestedTtl and distinguishes the requested TTL from the rendered view and ETag TTL.

Estimated code review effort: 2 (Simple) | ~10 minutes

Merge Risk: ⚪ Minimal · up to 39faf

This change adds non-release demo evidence and documentation without introducing an actionable merge-blocking risk; it is merge-ready after normal checks and review.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the two main changes: captured demo logs and the cache traceability report.
Description check ✅ Passed The description accurately summarizes the added demo logs, documentation, validation, and export behavior.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1 files. (2 skipped: 2 unsupported.)
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@codecov

codecov Bot commented Aug 19, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (283badd) to head (39fafe5).

Additional details and impacted files
@@             Coverage Diff             @@
##                 1.x      #199   +/-   ##
===========================================
  Coverage     100.00%   100.00%           
  Complexity       496       496           
===========================================
  Files             96        96           
  Lines           1311      1311           
===========================================
  Hits            1311      1311           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

The session I echo still showed the pre-bearsunday#192 log vocabulary
(put_donut{ttl: ...}) while the tree below it prints requestedTtl. The
API argument names (ttl/sMaxAge) are unchanged; only the described log
fields were stale. Log re-captured.

Report §1 row 5: stores degrade to a warning when the renderer throws,
not when none is bound (an unbound renderer falls back to JsonRenderer
and the store succeeds).
@koriym

koriym commented Aug 21, 2026

Copy link
Copy Markdown
Member Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Aug 21, 2026

Copy link
Copy Markdown
Contributor
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant