Skip to content

docs(conformance): record cachekit-py's path-encoding 1.2.0 and freshness-headers 1.0.0 copies (LAB-8254) - #160

Merged
27Bslash6 merged 4 commits into
mainfrom
agent/milchick/lab-8254-py-fixtures
Oct 5, 2026
Merged

27Bslash6 merged 4 commits into
mainfrom
agent/milchick/lab-8254-py-fixtures

Conversation

@27Bslash6

Copy link
Copy Markdown
Contributor

Records cachekit-py's byte-identical copies of path-encoding.json 1.2.0 and freshness-headers.json 1.0.0, vendored and CI-executed in cachekit-py#522.

conformance/sdks.json now reads cachekit-py at ce427a2450bdb83a07e30d5b32449c556be1ff00, the merge commit of that PR on main. Both new sha256 values were taken from sha256sum of the copies in cachekit-py's tests/unit/protocol/fixtures/ at that commit:

Fixture sha256
path-encoding.json (1.2.0) 807af0d39ccf3f5afda65577787ac5adcd01ff6617468060161c84267fa7e0cb
freshness-headers.json (1.0.0) 74beb975b6855f52d9dd453279873faf8048a9c3c79a8167cfda099beec5fcd3

The other five pinned cachekit-py copies hash the same at the new commit.

conformance/coverage.md is regenerated. For cachekit-py, API-4 to API-7 and API-17 move from partial (n/m) to partial (gap), and API-18, API-30, API-33, API-34 and API-57 move from uncovered to partial (gap). cachekit-py's copies now hold every vector those ids map to. They stay below covered because each id records a gap that no vector reaches. The cachekit-py totals move from 68 partial / 20 uncovered to 73 / 15.

sdk-feature-matrix.md: the Test vectors in CI cell for cachekit-py lists both fixtures, and note ¹⁶ says cachekit-py vendors this repo's current path-encoding.json and is the only SDK to vendor freshness-headers.json. The same cell called cachekit-py#391 and cachekit-py#397 unreleased, but both have shipped since PyPI 0.21.0 (in the v0.21.0 tag), so the cell now says that.

tools/test_conformance.py: one rendering case borrows three path-encoding.json 1.2.0 rows and expected every SDK to hold none of them. cachekit-py now holds them, so its column reads partial (gap). The case tests how names render, and its status expectation was the only part that changed.

Checked locally: python3 tools/conformance.py check --base origin/main (OK), tools/test_conformance.py (201/201), tools/test_changelog_collect.py, tools/check-version-floors.py.

Closes LAB-8254

@coderabbitai

coderabbitai Bot commented Oct 5, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 15 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

⚙️ Run configuration
  • Configuration used: Repository: cachekit-io/protocol/.coderabbit.yaml
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: 62c54629-abaa-49e3-b25c-0349c0b845e1
📥 Commits

Reviewing files that changed from the base of the PR and between dc24e3d and c4b817b.

📒 Files selected for processing (4)
  • changelog.d/20261005_lab-8254.md
  • conformance/coverage.md
  • conformance/sdks.json
  • sdk-feature-matrix.md

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Repository: cachekit-io/protocol/.coderabbit.yaml
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: f4b02903-5928-4dd7-9eba-15f848cce693
📥 Commits

Reviewing files that changed from the base of the PR and between 4dc126a and dc24e3d.

📒 Files selected for processing (4)
  • changelog.d/20261005_lab-8254.md
  • conformance/coverage.md
  • conformance/sdks.json
  • sdk-feature-matrix.md

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 by CodeRabbit

  • Documentation
    • Updated Python SDK conformance records to include newer path-encoding and freshness-header test vectors, verified in CI.
    • Refreshed reported API coverage and test-vector status across the conformance documentation.
    • Recorded additional fixtures shipped since the previous Python package release.

Walkthrough

The conformance records now identify updated Python fixture versions and hashes, revised API coverage statuses, and the related CI and release details.

Changes

Python fixture conformance

Layer / File(s) Summary
Fixture records and coverage
conformance/sdks.json, conformance/coverage.md, sdk-feature-matrix.md, changelog.d/20261005_lab-8254.md
The records pin cachekit-py to commit ce427a2, add freshness-headers.json 1.0.0, and update path-encoding.json to 1.2.0. Coverage totals change to 73 partial and 15 uncovered, and the listed API statuses change to partial (gap). The changelog and feature matrix record fixture and CI details.

Priority: ⬇️ Low

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

Change: Other

Merge Risk: ⚪ Minimal · up to dc24e

The recorded fixture versions and derived coverage agree, with no identified merge-blocking issue in this profile update.

Architecture Summary

Architecture risk: 🔵 Low · up to dc24e

The change affects 3 systems.

Changed systems: conformance, changelog.d, sdk-feature-matrix.md

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — conformance (service) was modified; 2 changed files map to changed impact.
  • observed — changelog.d (service) was modified; 1 changed file maps to changed impact.
  • observed — sdk-feature-matrix.md (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in changelog.d/20261005_lab-8254.md: Adds the LAB-8254 changelog entry documenting cachekit-py’s vendored fixtures, conformance coverage, CI execution, SDK table and note updates, and the reported release status of two earlier fixture versions.
  • observed — Modified behavior in conformance/coverage.md: The cachekit-py row changes its pinned commit, adds freshness-headers.json 1.0.0, and updates path-encoding.json from 1.1.0 to 1.2.0.
  • observed — Modified behavior in conformance/coverage.md: The cachekit-py summary changes from 68 partial and 20 uncovered requirements to 73 partial and 15 uncovered.
  • observed — Modified behavior in conformance/coverage.md: The cachekit-py statuses for API-4–API-7 change to partial (gap) from coverage fractions; the listed vectors, reference test and gap descriptions remain unchanged.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarises the conformance documentation update and identifies both fixture versions.
Description check ✅ Passed The description directly explains the fixture updates, coverage changes, and validation checks in the pull request.
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 0…
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)
  • Commit to this branch
  • Create a new PR
  • Autopilot · 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.

❤️ Share

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

@kodus-27b

kodus-27b Bot commented Oct 5, 2026 •

Copy link
Copy Markdown

Code Review Completed! 🔥

The code review was successfully completed based on your current configurations.

Kody Guide: Usage and Configuration
Interacting with Kody
  • Request a Review: Ask Kody to review your PR manually by adding a comment with the `@kody start-review` command at the root of your PR.

  • Provide Feedback: Help Kody learn and improve by reacting to its comments with a 👍 for helpful suggestions or a 👎 if improvements are needed.

Providing Context (Files & MCPs)

Add these hints in your PR description (or a comment) to unlock deeper checks:

  • Ticket / Acceptance Criteria: `Refs: ABC-123` (Linear/Jira/Asana/ClickUp/Trello) or a direct ticket link.
  • Bugfix Validation: a Sentry/Datadog/Bugsnag event link (or paste the stack trace/error message).
  • Endpoint Risk: mention the route (e.g., `POST /api/payments`) or controller/action name.
  • Attach a repo file as context: use an explicit marker like `@file:docs/guide.mdx#L10-L50` (replace with your real path).
  • API Contract Docs: include `@file:openapi.yaml` or `@file:swagger.json` when changing routes/schemas.
  • Definition of Done / Standards: include `@file:DOD.md` or `@file:CONTRIBUTING.md` if your repo has them.
  • Design System Source of Truth: include `@file:ui/index.ts` (replace with your DS entrypoint path).
  • Feature Flags: include the flag key/name and `@file:flags.ts` / `@file:config.json` (and optionally the PostHog flag name).
  • Edge/CDN Rules: link the Cloudflare rule/zone or describe the intended redirect/header behavior.
  • Attach an MCP tool output: use `@mcp<provider|tool>` (replace with an installed MCP provider + tool, e.g., `@mcp<sentry|events.search>`).
Current Kody Configuration
Review Options

The following review options are enabled or disabled:

Options Enabled
Bug ✅
Performance ✅
Security ✅
Business Logic ✅

Access your configuration settings here.

kodus-27b[bot]
kodus-27b Bot previously approved these changes Oct 5, 2026
…54-merge

# Conflicts:
#	conformance/coverage.md
#	sdk-feature-matrix.md
coderabbitai[bot]
coderabbitai Bot previously approved these changes Oct 5, 2026
@27Bslash6

Copy link
Copy Markdown
Contributor Author

@kody review --force

@kodus-27b

kodus-27b Bot commented Oct 5, 2026

Copy link
Copy Markdown

Code Review Completed! 🔥

The code review was successfully completed based on your current configurations.

Kody Guide: Usage and Configuration
Interacting with Kody
  • Request a Review: Ask Kody to review your PR manually by adding a comment with the `@kody start-review` command at the root of your PR.

  • Provide Feedback: Help Kody learn and improve by reacting to its comments with a 👍 for helpful suggestions or a 👎 if improvements are needed.

Providing Context (Files & MCPs)

Add these hints in your PR description (or a comment) to unlock deeper checks:

  • Ticket / Acceptance Criteria: `Refs: ABC-123` (Linear/Jira/Asana/ClickUp/Trello) or a direct ticket link.
  • Bugfix Validation: a Sentry/Datadog/Bugsnag event link (or paste the stack trace/error message).
  • Endpoint Risk: mention the route (e.g., `POST /api/payments`) or controller/action name.
  • Attach a repo file as context: use an explicit marker like `@file:docs/guide.mdx#L10-L50` (replace with your real path).
  • API Contract Docs: include `@file:openapi.yaml` or `@file:swagger.json` when changing routes/schemas.
  • Definition of Done / Standards: include `@file:DOD.md` or `@file:CONTRIBUTING.md` if your repo has them.
  • Design System Source of Truth: include `@file:ui/index.ts` (replace with your DS entrypoint path).
  • Feature Flags: include the flag key/name and `@file:flags.ts` / `@file:config.json` (and optionally the PostHog flag name).
  • Edge/CDN Rules: link the Cloudflare rule/zone or describe the intended redirect/header behavior.
  • Attach an MCP tool output: use `@mcp<provider|tool>` (replace with an installed MCP provider + tool, e.g., `@mcp<sentry|events.search>`).
Current Kody Configuration
Review Options

The following review options are enabled or disabled:

Options Enabled
Bug ✅
Performance ✅
Security ✅
Business Logic ✅

Access your configuration settings here.

kodus-27b[bot]
kodus-27b Bot previously approved these changes Oct 5, 2026
…54-merge2

# Conflicts:
#	conformance/coverage.md
#	sdk-feature-matrix.md
@27Bslash6

Copy link
Copy Markdown
Contributor Author

@kody review --force

@kodus-27b

kodus-27b Bot commented Oct 5, 2026

Copy link
Copy Markdown

Code Review Completed! 🔥

The code review was successfully completed based on your current configurations.

Kody Guide: Usage and Configuration
Interacting with Kody
  • Request a Review: Ask Kody to review your PR manually by adding a comment with the `@kody start-review` command at the root of your PR.

  • Provide Feedback: Help Kody learn and improve by reacting to its comments with a 👍 for helpful suggestions or a 👎 if improvements are needed.

Providing Context (Files & MCPs)

Add these hints in your PR description (or a comment) to unlock deeper checks:

  • Ticket / Acceptance Criteria: `Refs: ABC-123` (Linear/Jira/Asana/ClickUp/Trello) or a direct ticket link.
  • Bugfix Validation: a Sentry/Datadog/Bugsnag event link (or paste the stack trace/error message).
  • Endpoint Risk: mention the route (e.g., `POST /api/payments`) or controller/action name.
  • Attach a repo file as context: use an explicit marker like `@file:docs/guide.mdx#L10-L50` (replace with your real path).
  • API Contract Docs: include `@file:openapi.yaml` or `@file:swagger.json` when changing routes/schemas.
  • Definition of Done / Standards: include `@file:DOD.md` or `@file:CONTRIBUTING.md` if your repo has them.
  • Design System Source of Truth: include `@file:ui/index.ts` (replace with your DS entrypoint path).
  • Feature Flags: include the flag key/name and `@file:flags.ts` / `@file:config.json` (and optionally the PostHog flag name).
  • Edge/CDN Rules: link the Cloudflare rule/zone or describe the intended redirect/header behavior.
  • Attach an MCP tool output: use `@mcp<provider|tool>` (replace with an installed MCP provider + tool, e.g., `@mcp<sentry|events.search>`).
Current Kody Configuration
Review Options

The following review options are enabled or disabled:

Options Enabled
Bug ✅
Performance ✅
Security ✅
Business Logic ✅

Access your configuration settings here.

@27Bslash6
27Bslash6 merged commit fdeda4b into main Oct 5, 2026
5 checks passed
@27Bslash6
27Bslash6 deleted the agent/milchick/lab-8254-py-fixtures branch October 5, 2026 17:52
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