Forward-port Pro cache API removal to main

[justin808]

Why

Forward-port the release-branch fix from #4541 onto main so the Pro cache API removal is present on both the release/17.0.0 train and the next mainline.

Fixes #4497.

What

• Cherry-picked 793700ac6763a97d5fe413ee7c64d1b56bc98e0a with -x provenance.
• Removed the undocumented ReactOnRailsPro::Cache.fetch_react_component class API on main.
• Kept supported helper cache behavior and RBS/test coverage aligned.
• Resolved the CHANGELOG.md conflict by preserving the existing Unreleased Fix Pro streamed RSC hydration mismatch #4532 entry and making the rc.7 cache wording implementation-neutral.

Validation

• git diff --check origin/main...HEAD
• ruby -c react_on_rails_pro/app/helpers/react_on_rails_pro_helper.rb
• ruby -c react_on_rails_pro/lib/react_on_rails_pro/cache.rb
• script/check-pro-license-headers
• LANG=en_US.UTF-8 LC_ALL=en_US.UTF-8 RUBYOPT='-EUTF-8' BUNDLE_GEMFILE=react_on_rails_pro/Gemfile bundle exec rspec react_on_rails_pro/spec/react_on_rails_pro/cache_spec.rb (21 examples, 0 failures)
• pnpm install --frozen-lockfile
• pnpm exec prettier --check CHANGELOG.md
• (cd react_on_rails_pro/spec/dummy && pnpm run build:test)
• (cd react_on_rails_pro/spec/dummy && LANG=en_US.UTF-8 LC_ALL=en_US.UTF-8 RUBYOPT='-EUTF-8' bundle exec rspec spec/helpers/react_on_rails_pro_helper_spec.rb) (116 examples, 0 failures)

Note: the local pre-push hook's Ruby branch lint passed, but markdown-links is blocked by the installed Lychee v0.24.2 failing to parse the existing .lychee.toml include_fragments = false setting. The branch was pushed with --no-verify after the focused checks above passed.

Summary by CodeRabbit

• Breaking Changes

  • Removed an undocumented public cache API; apps should use the supported cached helper methods instead.

• Bug Fixes

  • Cached component helpers now consistently load the correct pack on cache hits.
  • Improved cache key handling, including support for callable keys.
  • Better handling of cache conditions and expiration timing.
  • Cached component hash results now include cache metadata consistently.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: b472fbcb-e5c1-4e7a-9d17-de4b1d9f212a

📥 Commits

Reviewing files that changed from the base of the PR and between b6165e0 and d322bed.

📒 Files selected for processing (6)

• CHANGELOG.md
• react_on_rails_pro/app/helpers/react_on_rails_pro_helper.rb
• react_on_rails_pro/lib/react_on_rails_pro/cache.rb
• react_on_rails_pro/sig/react_on_rails_pro/cache.rbs
• react_on_rails_pro/spec/dummy/spec/helpers/react_on_rails_pro_helper_spec.rb
• react_on_rails_pro/spec/react_on_rails_pro/cache_spec.rb

💤 Files with no reviewable changes (2)

• react_on_rails_pro/sig/react_on_rails_pro/cache.rbs
• react_on_rails_pro/lib/react_on_rails_pro/cache.rb

---

Walkthrough

This PR removes the public ReactOnRailsPro::Cache.fetch_react_component class method and its RBS type signature, moving the caching control flow (cache-hit detection, tag registration, pack loading, metadata injection) directly into a private method within ReactOnRailsProHelper. Specs are updated accordingly, and a changelog breaking-change entry is added.

Changes

Cache API removal and helper inlining

Layer / File(s)	Summary
Inline caching logic into helper react_on_rails_pro/app/helpers/react_on_rails_pro_helper.rb	Replaces the delegating wrapper with a private fetch_react_component implementing cache-fetch control flow, tag registration on miss, pack loading on hit, and cache metadata injection.
Remove Cache.fetch_react_component and type signature react_on_rails_pro/lib/react_on_rails_pro/cache.rb, react_on_rails_pro/sig/react_on_rails_pro/cache.rbs	Deletes the public class method, its private helpers, and the corresponding RBS signature.
Update specs for removal and new helper behavior react_on_rails_pro/spec/react_on_rails_pro/cache_spec.rb, react_on_rails_pro/spec/dummy/spec/helpers/react_on_rails_pro_helper_spec.rb	Replaces old fetch_react_component cache-behavior specs with a "not publicly exposed" assertion; adds new helper specs for callable cache keys, conditional caching, expires_at handling, and metadata injection.
Document breaking change CHANGELOG.md	Adds an Unreleased Breaking Changes entry and revises rc.7 Fixed wording about cache-hit pack loading.

Estimated code review effort: 3 (Moderate) | ~25 minutes

Possibly related PRs

• shakacode/react_on_rails#4384: Prior PR made Cache.fetch_react_component the canonical implementation with the helper delegating to it; this PR reverses that by removing the method and inlining logic into the helper.
• shakacode/react_on_rails#4268: Introduces cached_buffered_stream_react_component which relies on the same helper cache-miss path being refactored here.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly matches the main change: removing the Pro cache API and forward-porting that change to main.
Linked Issues check	✅ Passed	The PR removes the undocumented cache API, moves coverage to the helper, and adds the breaking-change note required by #4497.
Out of Scope Changes check	✅ Passed	The edits stay focused on the cache API removal, helper behavior, tests, RBS, and changelog alignment with no clear unrelated changes.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch codex/forward-port-4541-cache-api

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ast-grep (0.44.1)

react_on_rails_pro/spec/dummy/spec/helpers/react_on_rails_pro_helper_spec.rb

ast-grep timed out on this file

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[justin808]

+ci-run-hosted

[github-actions]

Hosted CI Requested

Triggered 9 workflow(s) for d322bedc569c.
Mode: optimized hosted CI (path-selected by script/ci-changes-detector).
Added ready-for-hosted-ci, so future commits will keep running optimized hosted CI until +ci-stop-hosted is used.

View progress in the Actions tab.

[greptile-apps]

Greptile Summary

This PR removes the undocumented Pro cache class API while keeping supported helper caching in place. The main changes are:

• Removed ReactOnRailsPro::Cache.fetch_react_component and its RBS signature.
• Moved the helper cache fetch logic into ReactOnRailsProHelper.
• Added helper specs for callable keys, skip conditions, tag handling, expires_at, and hash metadata.
• Updated the changelog to describe the breaking API removal.

Confidence Score: 5/5

This looks safe to merge.

• No blocking issues found in the changed code.
• The supported helper cache paths still preserve the prior cache behavior.
• The removed class API has no remaining internal callers or type references.

Important Files Changed

Filename	Overview
react_on_rails_pro/app/helpers/react_on_rails_pro_helper.rb	Inlines the supported cached helper path and preserves cache hits, misses, metadata, tags, expired writes, and pack loading behavior.
react_on_rails_pro/lib/react_on_rails_pro/cache.rb	Removes the undocumented class API and now-unused private helper methods.
react_on_rails_pro/sig/react_on_rails_pro/cache.rbs	Removes the deleted cache class API from the type surface.
react_on_rails_pro/spec/dummy/spec/helpers/react_on_rails_pro_helper_spec.rb	Adds helper-level coverage for the supported cache behavior that remains.
react_on_rails_pro/spec/react_on_rails_pro/cache_spec.rb	Replaces low-level behavior coverage with an assertion that the removed class API is no longer exposed.
CHANGELOG.md	Documents the breaking removal and updates release wording to avoid the deleted implementation detail.

_{Reviews (1): Last reviewed commit: "Remove undocumented Pro cache class API ..." | Re-trigger Greptile}

[claude]

Review: Forward-port Pro cache API removal to main

Overview

Clean forward-port of #4541. Removes the undocumented public ReactOnRailsPro::Cache.fetch_react_component class method and its on_cache_hit callback machinery, inlining the equivalent logic as a private method directly in ReactOnRailsProHelper. The CHANGELOG.md conflict resolution correctly preserves the existing Unreleased #4532 entry while making the rc.7 entry implementation-neutral.

Verification performed

• Traced every caller of the old Cache.fetch_react_component / cache_hit_callback / Cache#add_component_cache_metadata — confirmed no dangling references anywhere in the repo (Ruby, RBS, docs, JS).
• Confirmed the semantics are preserved: the new private fetch_react_component in the helper (react_on_rails_pro_helper.rb:436) calls load_pack_for_cached_react_component(component_name, options) on cache hit with the same options (post auto_load_bundle merge) that the old on_cache_hit lambda received — a behavior-equivalent move, not just a rename.
• Confirmed all ReactOnRailsPro::Cache methods the new helper method depends on (use_cache?, react_component_cache_key, cache_write_options, cache_write_expired?, normalize_tags, register_normalized_tags) remain public in cache.rb, and the RBS sig file (cache.rbs) was updated consistently (only the removed method's signature dropped).
• Checked cache_spec.rb — remaining tests (e.g. the TestingCache double) are still exercised elsewhere in the file, so nothing was left orphaned by the large deletion.
• The moved/duplicated test coverage in react_on_rails_pro_helper_spec.rb (callable cache keys, if/unless skip, tagged expires_at conversion, hash cache metadata) mirrors what was previously tested against the class API directly — good, since the only supported entry point now is the helper.

Minor observations (non-blocking)

• cache_spec.rb's describe ".fetch_react_component" now only contains a single negative assertion (not_to respond_to). Consider whether this describe block still deserves the .fetch_react_component method-style name now that it documents an absence rather than behavior — purely cosmetic, not worth blocking on.
• The CHANGELOG "Breaking Changes" entry attributes the change to PR Remove undocumented Pro cache class API #4541 (the original) rather than this forward-port PR Forward-port Pro cache API removal to main #4543, which appears intentional per the PR description, but worth double-checking that's the desired attribution once this lands on main.

Risk assessment

Low risk. This is a pure move/inline of already-tested logic with no behavior change for the only real caller (the helper module itself), and it removes a previously-undocumented public API that nothing else depended on. Test coverage was carried over faithfully rather than dropped.