Skip to content

docs: fix JWT claim name in Pro license setup#2589

Merged
justin808 merged 1 commit intomasterfrom
jg-codex/fix-2451-jwt-org-claim
Mar 12, 2026
Merged

docs: fix JWT claim name in Pro license setup#2589
justin808 merged 1 commit intomasterfrom
jg-codex/fix-2451-jwt-org-claim

Conversation

@justin808
Copy link
Copy Markdown
Member

@justin808 justin808 commented Mar 11, 2026

Summary

  • update JWT payload example to use the runtime-supported org claim
  • clarify that organization is the verify-task output field name, not the JWT input claim
  • align JSON field table wording with the validator behavior

Fixes #2451

Test Plan

  • docs-only change; no runtime code paths changed

Note

Low Risk
Low risk docs-only change that corrects a claim name in examples and descriptions; no runtime behavior is modified.

Overview
Clarifies React on Rails Pro license documentation by correcting the JWT payload example to use the org claim and updating the verify-task JSON field table to state that organization is derived from org.

Adds a brief note explaining the naming mismatch between the JWT claim (org) and the verifier output field (organization).

Written by Cursor Bugbot for commit 59ff666. Configure here.

Summary by CodeRabbit

  • Documentation
    • Updated license setup documentation to clarify how organization information is sourced from JWT authentication claims and improved explanations of field naming conventions in license verification outputs for enhanced user understanding.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Mar 11, 2026

Walkthrough

Documentation update to react_on_rails_pro/LICENSE_SETUP.md correcting JWT field naming from organization to org to match actual validator requirements, with a clarification note explaining the distinction between JWT input and task output field names.

Changes

Cohort / File(s) Summary
Documentation
react_on_rails_pro/LICENSE_SETUP.md
Updated JWT payload examples to use org claim instead of organization. Added clarification note that JWT input requires org claim while Rake task output displays the field as organization for readability.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

A tiny hop through docs so bright,
Where org now shines in JWT light,
No more confusion, clarity gained,
The runtime and docs are now well-trained! 🐰✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the primary change: fixing the JWT claim name documentation in the Pro license setup guide.
Linked Issues check ✅ Passed The PR successfully addresses all coding requirements from issue #2451: updated JWT examples to use 'org', clarified the distinction between JWT input claim and output field naming, and ensured documentation consistency.
Out of Scope Changes check ✅ Passed All changes are directly scoped to addressing the JWT claim name mismatch in LICENSE_SETUP.md documentation; no unrelated modifications are present.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
  • 📝 Generate docstrings (stacked PR)
  • 📝 Generate docstrings (commit on current branch)
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch jg-codex/fix-2451-jwt-org-claim

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 and usage tips.

@claude
Copy link
Copy Markdown
Contributor

claude Bot commented Mar 11, 2026

Review: docs: fix JWT claim name in Pro license setup

This is a clean, accurate documentation fix. I verified both changes against the source code:

Correctness confirmed:

  • license_validator.rb:183 reads decoded_data["org"] -- the JWT claim is indeed 'org', not 'organization'
  • license_validator.rb:273 also checks decoded_data["org"] for the organization presence check
  • license_task_formatter.rb:11 maps info[:org] to 'organization:' in the output hash, explaining the naming difference the PR documents

Both doc changes are accurate:

  1. The JWT payload example correction (organization -> org) matches the runtime behavior
  2. The clarifying note about 'org' (JWT claim) vs 'organization' (task output field) accurately reflects the formatter's mapping

No issues found. LGTM.

@greptile-apps
Copy link
Copy Markdown

greptile-apps Bot commented Mar 11, 2026

Greptile Summary

This PR fixes a documentation inaccuracy in react_on_rails_pro/LICENSE_SETUP.md by correcting the JWT payload example to use the runtime-supported org claim (instead of the incorrect organization claim), and adds a clarifying note explaining that the verify task output maps orgorganization for readability.

Key changes:

  • JWT payload example updated: "organization": "Your Company""org": "Your Company", matching how LicenseValidator actually reads decoded_data["org"] at runtime.
  • JSON Fields table description for organization now explicitly references the JWT org claim, reducing confusion about the naming mismatch.
  • A prose note added after the JWT example clarifies the org (input claim) vs organization (output field) distinction, which mirrors the mapping in LicenseTaskFormatter#build_result (organization: info[:org]).

The fix is fully verified against the source code: license_validator.rb reads decoded_data["org"], and license_task_formatter.rb maps it to the output key organization. The documentation now accurately reflects this behavior.

Confidence Score: 5/5

  • This is a docs-only change that is fully accurate relative to the runtime source code — safe to merge.
  • The single changed file is documentation only. Both corrections (the JWT claim name and the clarifying note) are verified accurate against license_validator.rb and license_task_formatter.rb. No runtime code paths are affected.
  • No files require special attention.

Important Files Changed

Filename Overview
react_on_rails_pro/LICENSE_SETUP.md Corrects the JWT claim name from organization to org in the payload example, and adds a clarifying note that the verify task output maps orgorganization for readability; confirmed accurate against the source code.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A["JWT Token (RSA-256 signed)"] --> B["JWT Payload: sub, iat, exp, plan, org, iss"]
    B --> C["LicenseValidator: reads org claim"]
    C --> D["license_info hash: org key"]
    D --> E["LicenseTaskFormatter: build_result"]
    E --> F["JSON Output field: organization"]
    E --> G["Text Output: Organization line"]
Loading

Last reviewed commit: 59ff666

@justin808 justin808 merged commit cdb0281 into master Mar 12, 2026
10 checks passed
@justin808 justin808 deleted the jg-codex/fix-2451-jwt-org-claim branch March 12, 2026 05:33
justin808 added a commit that referenced this pull request Mar 13, 2026
…k cleanup (#2596)

## Summary
- Added missing changelog entries for PRs #2439, #2477, #2554
- Stamped version header for 16.4.0.rc.9 (collapsed rc.8 into rc.9)
- **Fixed rake task bug**: `collapse_prerelease_sections` removed
section headers but left behind orphaned compare links at the bottom of
CHANGELOG.md. Added `cleanup_collapsed_prerelease_links` to remove these
links and update `[unreleased]` to compare from the last stable version.

## Changes
1. **CHANGELOG.md**: New entries + rc.9 stamp + removed orphaned
`[16.4.0.rc.8]` link
2. **update_changelog.rake**: Added `cleanup_collapsed_prerelease_links`
function, called from `prepare_changelog_for_auto_version`
3. **update_changelog_rake_helpers_spec.rb**: 3 new tests covering link
cleanup (multi-prerelease chain, single prerelease, no prereleases)

## Skipped PRs (not user-visible)
- #2593 — test only (lock instrumentation)
- #2591 — test only (Jest clearMocks)
- #2588 — internal refactoring (Thor shell output)
- #2584 — docs restructuring
- #2587 — internal tooling (release script)
- #2589 — docs fix (JWT claim name)
- #2586 — docs/CI (dead link removal)

## Test plan
- [x] All 13 rake helper tests pass (3 new)
- [ ] CI passes
- [ ] After merge, run `rake release` to publish 16.4.0.rc.9

🤖 Generated with [Claude Code](https://claude.com/claude-code)

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Bug Fixes**
  * Fixed bin/setup failing in pnpm workspace member directories.

* **New Features**
* Added host configuration option for the Node Renderer Fastify worker.

* **Improvements / Changed**
* Automatic installation of react_on_rails_pro enabled for --rsc/--pro
flags.
* Clarified Pro-installation signaling related to immediate hydration
warnings.
* Updated changelog to include RC9 entries and ensure Unreleased links
point to the correct base.

* **Documentation**
* Added startup warning and remediation guidance for unsafe compression
middleware callbacks.

* **Tests**
  * Added tests covering changelog prerelease-link cleanup behavior.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Claude Opus 4.6 <[email protected]>
justin808 added a commit that referenced this pull request Mar 30, 2026
…k cleanup (#2596)

## Summary
- Added missing changelog entries for PRs #2439, #2477, #2554
- Stamped version header for 16.4.0.rc.9 (collapsed rc.8 into rc.9)
- **Fixed rake task bug**: `collapse_prerelease_sections` removed
section headers but left behind orphaned compare links at the bottom of
CHANGELOG.md. Added `cleanup_collapsed_prerelease_links` to remove these
links and update `[unreleased]` to compare from the last stable version.

## Changes
1. **CHANGELOG.md**: New entries + rc.9 stamp + removed orphaned
`[16.4.0.rc.8]` link
2. **update_changelog.rake**: Added `cleanup_collapsed_prerelease_links`
function, called from `prepare_changelog_for_auto_version`
3. **update_changelog_rake_helpers_spec.rb**: 3 new tests covering link
cleanup (multi-prerelease chain, single prerelease, no prereleases)

## Skipped PRs (not user-visible)
- #2593 — test only (lock instrumentation)
- #2591 — test only (Jest clearMocks)
- #2588 — internal refactoring (Thor shell output)
- #2584 — docs restructuring
- #2587 — internal tooling (release script)
- #2589 — docs fix (JWT claim name)
- #2586 — docs/CI (dead link removal)

## Test plan
- [x] All 13 rake helper tests pass (3 new)
- [ ] CI passes
- [ ] After merge, run `rake release` to publish 16.4.0.rc.9

🤖 Generated with [Claude Code](https://claude.com/claude-code)

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Bug Fixes**
  * Fixed bin/setup failing in pnpm workspace member directories.

* **New Features**
* Added host configuration option for the Node Renderer Fastify worker.

* **Improvements / Changed**
* Automatic installation of react_on_rails_pro enabled for --rsc/--pro
flags.
* Clarified Pro-installation signaling related to immediate hydration
warnings.
* Updated changelog to include RC9 entries and ensure Unreleased links
point to the correct base.

* **Documentation**
* Added startup warning and remediation guidance for unsafe compression
middleware callbacks.

* **Tests**
  * Added tests covering changelog prerelease-link cleanup behavior.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Claude Opus 4.6 <[email protected]>
justin808 added a commit that referenced this pull request Apr 6, 2026
…k cleanup (#2596)

## Summary
- Added missing changelog entries for PRs #2439, #2477, #2554
- Stamped version header for 16.4.0.rc.9 (collapsed rc.8 into rc.9)
- **Fixed rake task bug**: `collapse_prerelease_sections` removed
section headers but left behind orphaned compare links at the bottom of
CHANGELOG.md. Added `cleanup_collapsed_prerelease_links` to remove these
links and update `[unreleased]` to compare from the last stable version.

## Changes
1. **CHANGELOG.md**: New entries + rc.9 stamp + removed orphaned
`[16.4.0.rc.8]` link
2. **update_changelog.rake**: Added `cleanup_collapsed_prerelease_links`
function, called from `prepare_changelog_for_auto_version`
3. **update_changelog_rake_helpers_spec.rb**: 3 new tests covering link
cleanup (multi-prerelease chain, single prerelease, no prereleases)

## Skipped PRs (not user-visible)
- #2593 — test only (lock instrumentation)
- #2591 — test only (Jest clearMocks)
- #2588 — internal refactoring (Thor shell output)
- #2584 — docs restructuring
- #2587 — internal tooling (release script)
- #2589 — docs fix (JWT claim name)
- #2586 — docs/CI (dead link removal)

## Test plan
- [x] All 13 rake helper tests pass (3 new)
- [ ] CI passes
- [ ] After merge, run `rake release` to publish 16.4.0.rc.9

🤖 Generated with [Claude Code](https://claude.com/claude-code)

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Bug Fixes**
  * Fixed bin/setup failing in pnpm workspace member directories.

* **New Features**
* Added host configuration option for the Node Renderer Fastify worker.

* **Improvements / Changed**
* Automatic installation of react_on_rails_pro enabled for --rsc/--pro
flags.
* Clarified Pro-installation signaling related to immediate hydration
warnings.
* Updated changelog to include RC9 entries and ensure Unreleased links
point to the correct base.

* **Documentation**
* Added startup warning and remediation guidance for unsafe compression
middleware callbacks.

* **Tests**
  * Added tests covering changelog prerelease-link cleanup behavior.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Claude Opus 4.6 <[email protected]>
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.

Docs: JWT claim name mismatch (LICENSE_SETUP uses organization, runtime requires org)

1 participant