docs(rsc): document use cache examples - #1407

Merged

hi-ogawa merged 36 commits into

mainfrom

docs/use-cache-callable-readme

Aug 6, 2026

hi-ogawa commented Aug 6, 2026 •

edited

Loading

Contributor

follow-up to test(rsc): decrypt cache captures once in use cache example #1403

The two "use cache" examples cover complementary layers, but the local runtime README is currently terse and the callable integration boundaries are otherwise only discoverable from implementation and E2E tests.

This PR documents the local example's argument serialization, Flight replay, temporary-reference children, closure keys, and invalidation semantics. It also documents the callable example's directive forms, server-reference transport, argument admission, encrypted captures, and hydrated form caveat, with cross-links and updated package-level descriptions distinguishing their scope.

hi-ogawa and others added 27 commits

August 5, 2026 09:26


          feat(rsc): demonstrate encrypted cache captures

8732f56

Co-authored-by: OpenCode <noreply@opencode.ai>


          refactor(rsc): split protected cache captures example

b42a63c

Co-authored-by: OpenCode <noreply@opencode.ai>


          Merge origin/main into fix/issue-1393

b63b4eb

Co-authored-by: OpenCode <noreply@opencode.ai>


          chore(rsc): order protected captures route last

cfcc4d2

Co-authored-by: OpenCode <noreply@opencode.ai>


          refactor(rsc): render capture selector on server

38d2d81

Co-authored-by: OpenCode <noreply@opencode.ai>


          test(rsc): verify protected captures across reload

f572f1a

Co-authored-by: OpenCode <noreply@opencode.ai>

nit

c152ca9


          docs(rsc): explain protected capture argument adapter

7612a59

Co-authored-by: OpenCode <noreply@opencode.ai>

nit

77d4c32


          Merge origin/main into fix/issue-1393

144a2b7

Co-authored-by: OpenCode <noreply@opencode.ai>


          fix(rsc): stabilize encrypted form cache keys

9e66ba2

Exclude React form transport fields from cache identity while preserving the original FormData for execution.

Co-authored-by: OpenCode <noreply@opencode.ai>


          docs(rsc): explain form cache key divergence

56bdff7

Co-authored-by: OpenCode <noreply@opencode.ai>


          test(rsc): document encrypted form reload miss

da14545

Keep FormData cache identity unchanged and point to custom form adaptation as the framework-level improvement path.

Co-authored-by: OpenCode <noreply@opencode.ai>


          refactor(rsc): keep cache capture envelope synchronous

2ed49ab

Store the asynchronous encryption result in the envelope so the cache wrapper can inspect its sentinel without awaiting the argument.

Co-authored-by: OpenCode <noreply@opencode.ai>


          refactor(rsc): clarify protected cache key encoding

cd72fec

Co-authored-by: OpenCode <noreply@opencode.ai>

nit

add3c5c


          refactor(rsc): name cache capture encryption explicitly

9b799ad

Co-authored-by: OpenCode <noreply@opencode.ai>

nit

329abcb


          refactor(rsc): remove cache capture key marker

5c0734e

Co-authored-by: OpenCode <noreply@opencode.ai>

nit

f45d329


          docs(rsc): note duplicate capture decryption

09400ad

Co-authored-by: OpenCode <noreply@opencode.ai>


          refactor(rsc): decrypt cache captures once

2f70fe9

Adapt encrypted transport arguments to decoded implementation arguments in the cache runtime, allowing the generated implementation to destructure captures directly.

Co-authored-by: OpenCode <noreply@opencode.ai>


          Merge origin/main into refactor/use-cache-single-decode

8e36cae

Co-authored-by: OpenCode <noreply@opencode.ai>

# Conflicts:
#	packages/plugin-rsc/examples/use-cache-callable/callable-cache-plugin.ts
#	packages/plugin-rsc/examples/use-cache-callable/src/framework/use-cache-runtime.tsx


          Merge origin/main into refactor/use-cache-single-decode

91574ae

Co-authored-by: OpenCode <noreply@opencode.ai>

# Conflicts:
#	packages/plugin-rsc/examples/use-cache-callable/src/framework/use-cache-runtime.tsx


          refactor(rsc): reuse decoded cache arguments

b295216

Use the decoded execution argument serialization directly for cache identity instead of flattening and encoding captures separately.

Co-authored-by: OpenCode <noreply@opencode.ai>


          docs(rsc): clarify cache capture decode boundary

78f8b6a

Co-authored-by: OpenCode <noreply@opencode.ai>


          docs(rsc): document callable cache example

c8bcd7b

Co-authored-by: OpenCode <noreply@opencode.ai>

Base automatically changed from refactor/use-cache-single-decode to main

August 6, 2026 02:55

hi-ogawa and others added 2 commits

August 6, 2026 11:58


          docs(rsc): expand use cache example guides

102635d

Document the local cache runtime semantics alongside the callable server-reference integration, and clarify their complementary scope in the package overview.

Co-authored-by: OpenCode <noreply@opencode.ai>


          Merge origin/main into docs/use-cache-callable-readme

b31de01

Co-authored-by: OpenCode <noreply@opencode.ai>

hi-ogawa changed the title ~~docs(rsc): document callable cache example~~ docs(rsc): document use cache examples

hi-ogawa and others added 4 commits

August 6, 2026 14:20

nit

c39ee3f

nit

1ff663a


          docs(rsc): illustrate use cache transforms

c93c12c

Show how local and callable directives lower into their respective cache runtime contracts, and identify the public transform and server-reference APIs involved.

Co-authored-by: OpenCode <noreply@opencode.ai>

nit

a52860d

hi-ogawa mentioned this pull request

chore(rsc): clarify use cache example #1410

Merged

hi-ogawa and others added 2 commits

August 6, 2026 14:49


          Merge origin/main into docs/use-cache-callable-readme

5e4020a

Co-authored-by: OpenCode <noreply@opencode.ai>


          docs(rsc): align cache guide with routes

22e8837

Co-authored-by: OpenCode <noreply@opencode.ai>

hi-ogawa marked this pull request as ready for review

August 6, 2026 05:51

nit

f66e590

hi-ogawa merged commit 4b0e3c7 into main

22 checks passed

hi-ogawa deleted the docs/use-cache-callable-readme branch

August 6, 2026 06:01

vite-release-bot Bot mentioned this pull request

release: plugin-rsc@0.5.34 #1416

Merged

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

Labels

None yet