feat(apps): add cache debug commands (+cache-get/-delete/-clear) - #1896
Merged
Conversation
Add three apps-domain cache debug shortcuts for inspecting/clearing an app's runtime cache: - +cache-get: read a business key's value + metadata (hit/miss) - +cache-delete: delete a single key (idempotent, write) - +cache-clear: clear all cache in an environment (high-risk-write, --yes) value renders raw on --format json, deserialized on --format pretty; value_size_bytes is computed CLI-side; --environment auto-selects the branch when omitted. Includes unit tests (hit/miss/dry-run/confirmation) and the lark-apps cache skill reference.
Follow-up hardening for the cache debug commands (+cache-get/-delete/-clear): - Normalize ttl_ms / deleted_key_count via a new cacheInt() helper so --format json emits a stable JSON number (or null) regardless of whether the server sends the value as a number or a string. Aligns with the repo convention that numeric wire fields may arrive as strings; previously these were passed through raw, leaving the output type at the server's mercy. - Add unit tests locking the string-wire -> JSON number contract for both cache-get ttl_ms and cache-delete deleted_key_count. - Tidy two comments: soften cacheBool's speculative "historical wire form" claim to a defensive-tolerance note, and drop implementation jargon from cache-delete's risk-level rationale.
github-actions
Bot
added
the
size/L
📝 WalkthroughWalkthroughAdds ChangesApplication runtime cache
Estimated code review effort: 3 (Moderate) | ~30 minutes Sequence Diagram(s)sequenceDiagram
participant CLI
participant CacheShortcut
participant CacheAPI
participant Renderer
CLI->>CacheShortcut: invoke cache command
CacheShortcut->>CacheAPI: read, delete, or clear cache
CacheAPI-->>CacheShortcut: return cache result
CacheShortcut->>Renderer: format normalized output
Renderer-->>CLI: emit JSON or pretty result
Suggested labels: Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
shortcuts/apps/apps_cache_test.go (1)
217-223: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winError-path tests only check
err != nil, no typed metadata assertion.Both tests exercise error paths (required
--key, missing--yesconfirmation) but only assert that an error occurred, not its typed classification. As per coding guidelines,**/*_test.goerror-path tests must assert typed metadata viaerrs.ProblemOf(category/subtype/param) and cause preservation, not just error presence.
shortcuts/apps/apps_cache_test.go#L217-L223: inTestAppsCacheGet_RequiresKey, asserterrs.ProblemOf(err)category/subtype (e.g. validation/invalid-argument) in addition to the non-nil check.shortcuts/apps/apps_cache_test.go#L311-L317: inTestAppsCacheClear_RequiresConfirmation, assert the confirmation-gate error's typed category/subtype similarly.Note: if the required-flag/confirmation-gate errors at this layer are raw framework errors rather than
errs.*typed problems, this guideline may not cleanly apply here — worth confirming the actual error type returned by the flag/confirmation middleware before making this change.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@shortcuts/apps/apps_cache_test.go` around lines 217 - 223, Update TestAppsCacheGet_RequiresKey in shortcuts/apps/apps_cache_test.go:217-223 and TestAppsCacheClear_RequiresConfirmation in shortcuts/apps/apps_cache_test.go:311-317 to assert errs.ProblemOf(err) typed category/subtype and preserved cause in addition to checking err is non-nil. First confirm the flag/confirmation middleware returns an errs.* problem; if it returns a raw framework error, use the appropriate typed assertion or adjust only as needed to preserve the actual error contract.Source: Coding guidelines
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@shortcuts/apps/apps_cache_test.go`:
- Around line 217-223: Update TestAppsCacheGet_RequiresKey in
shortcuts/apps/apps_cache_test.go:217-223 and
TestAppsCacheClear_RequiresConfirmation in
shortcuts/apps/apps_cache_test.go:311-317 to assert errs.ProblemOf(err) typed
category/subtype and preserved cause in addition to checking err is non-nil.
First confirm the flag/confirmation middleware returns an errs.* problem; if it
returns a raw framework error, use the appropriate typed assertion or adjust
only as needed to preserve the actual error contract.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 324e8e91-08b2-41af-a15d-4bf25b9bbf38
📒 Files selected for processing (9)
shortcuts/apps/apps_cache_clear.goshortcuts/apps/apps_cache_delete.goshortcuts/apps/apps_cache_get.goshortcuts/apps/apps_cache_test.goshortcuts/apps/cache_common.goshortcuts/apps/shortcuts.goshortcuts/apps/shortcuts_test.goskills/lark-apps/SKILL.mdskills/lark-apps/references/lark-apps-cache.md
Resolve shortcut-count test conflict (cache 3 + automation 6 + role 9 → 82) and update the cache dry-run test helper to the new data.api envelope shape.
Resolve SKILL.md routing conflict (keep cache row + adopt main's updated release row) and fix the lark-apps-cache.md lark-shared link path to satisfy main's new skill-link contract test.
🚀 PR Preview Install Guide🧰 CLI updatenpm i -g https://pkg.pr.new/larksuite/cli/@larksuite/cli@f174c3d199a2e4b185ad643d03435011b49db2aa🧩 Skill updatenpx skills add larksuite/cli#feat/apps-cache-cli -y -g |
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## main #1896 +/- ##
==========================================
+ Coverage 75.08% 75.41% +0.33%
==========================================
Files 905 928 +23
Lines 96066 98165 +2099
==========================================
+ Hits 72128 74035 +1907
- Misses 18387 18490 +103
- Partials 5551 5640 +89 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
chenxingyang1019
force-pushed
the
feat/apps-cache-cli
branch
from
July 23, 2026 08:57
c58b89c to
0a0f406
Compare
liangshuo-1
approved these changes
Jul 31, 2026
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
2 participants
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.
What
Adds three Miaoda app runtime cache debug commands to the
appsdomain, mirroring the db/file command family conventions:+cache-getspark:app:read+cache-deletespark:app:write+cache-clearspark:app:write--yes)GET/DELETE /apps/{app_id}/cache,POST /apps/{app_id}/cache/clear.--environment dev|online; omit to let the server auto-select the branch (multi-env app → dev, single-env → online). Env goes in query for get/delete, in body for clear.+cache-getoutput: on hit{key, environment, exists, ttl_ms, value_size_bytes, value}; on missexists:falsewithttl_ms/value_size_bytesnull and novalue.value_size_bytesis computed CLI-side;valueis raw passthrough under--format jsonand deserialized/indented under--format pretty(raw fallback for non-JSON).ttl_ms,deleted_key_count) are normalized to a stable JSON number/null so the output type does not drift with the server's wire form.Testing
Summary by CodeRabbit
+cache-getto retrieve an app runtime cache key (hit/miss, TTL, value size, pretty/raw output) with--environment.+cache-deleteto delete a single key (idempotent: missing keys succeed) with pretty-mode messaging and--environment.+cache-clearto clear all cache entries for an app/environment (requires confirmation, supports dry-run, reports deleted count).