docs(interop): composition matrix, recommended form, shared-key footgun (LAB-840) - #248
Merged
Merged
Conversation
…ryption-mismatch warning (LAB-840) Augment docs/features/interop-mode.md for released 0.16.0 behaviour: - Decorator-composition matrix: bare/.production/.minimal/.secure produce spec-identical bytes; .io composes but is gated on the saas#91 validator deploy; .local and backend=None are rejected loudly at decoration. - interop= shown as a DecoratorConfig field on every entry point (bare, preset, RORO), with @cache.production(...) called out as the recommended form. - Shared-entry footgun promoted to its own section: interop keys are deliberately function-identity-free, so same (namespace, operation, args) shares one entry including L1 — operation names are a cross-team contract. Expert-panel CRIT applied: encryption config is part of that contract (a plaintext-config binder silently re-stores the value unencrypted at the shared key). - Integrity-checking nuance: no ByteStorage envelope means no checksum — integrity_checking has no effect under interop, and unencrypted interop entries have no corruption detection at all (panel MAJ applied). - Stale 'Available since v0.12.0' replaced with a changelog pointer (0.12/0.13 never hit PyPI; anti-drift: don't pin versions in docs). All executable markdown blocks pass pytest --markdown-docs honestly (no notest silencing; notest only on blocks needing an undefined backend/db).
Code Review Completed! 🔥The code review was successfully completed based on your current configurations. Kody Guide: Usage and ConfigurationInteracting with Kody
Current Kody ConfigurationReview OptionsThe following review options are enabled or disabled:
|
WalkthroughChangesInterop mode documentation
Estimated code review effort: 1 (Trivial) | ~3 minutes 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes LAB-840 (parent LAB-374).
Augments
docs/features/interop-mode.md(created in #220) with the remaining usage material — verified against released 0.16.0 source, not guessed.What's added
@cache,.production,.minimal,.secureall compose → spec-identical bytes (presets change runtime profile, never wire bytes;InteropSerializeris forced regardless of preset);.iocomposes in code but is gated on the saas#91 validator deploy;.local/backend=Nonerejected loudly (TypeError/ConfigurationErrorat decoration).interop=as aDecoratorConfigfield on every entry point — bare, preset, and RORO forms, with@cache.production(interop=..., namespace=..., ttl=...)called out as the recommended form.(namespace, operation)+ matching args share one entry including L1 (process-global, per-namespace). Operation names are a cross-team contract, like queue names._deserialize_interop.integrity_checkinghas no effect under interop (no ByteStorage envelope to checksum), and unencrypted interop entries have no corruption detection at all — under.productionjust as.minimal. Reconciled with the existing "no metadata header" wording.Verification
config/decorator.py(field + preset**kwargspassthrough),decorators/intent.py+local_wrapper.py(.localrejection),decorators/wrapper.py:538-562(L1-only/fast_mode guards),cache_handler.py:604-610(integrity bypass),l1_cache.py:649-683(process-global L1).pytest --markdown-docs docs/→ 121 passed, 0 failed. New executable blocks run honestly;notestonly on blocks needing an undefined backend/db (perdocs/CONTRIBUTING.md).expert-panel-reviewrun at high stakes (4 agents). Surviving findings applied (CRIT encryption-mismatch, MAJ zero-corruption-detection, 5 dedup/wording cuts); rejected "pin v0.13.0" — that version never hit PyPI, changelog pointer is the anti-drift fix.Pre-existing
README.mdmarkdown-docs failures (cacheundefined in fences) exist on clean main and are out of scope.Summary by CodeRabbit