Add GetClaims method to Token struct

[evgenyk]

Introduce the GetClaims method to retrieve claims from the JWT token, along with tests to validate its behavior in different scenarios.

[coderabbitai]

Walkthrough

A new GetClaims() method was introduced to the Token struct in the JWT package, enabling safe extraction of claims as a map. Corresponding unit tests were added to verify the method's behavior for both nil and valid parsed tokens.

Changes

Cohort / File(s)	Change Summary
JWT Token Claims Access jwt/jwt.go	Added GetClaims() method to the Token struct for safe retrieval of JWT claims as a map.
Unit Tests for GetClaims jwt/jwt_test.go	Added TestToken_GetClaims to test GetClaims() for nil and valid parsed token scenarios.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch ev/get_claims

---

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

jwt/jwt_test.go (1)

42-71: Good test coverage, but consider adding edge case.

The test effectively covers the two main scenarios:

• Nil parsed token returning empty map
• Valid MapClaims returning expected claims

However, consider adding a test case for when parsed.Claims is not of type golangjwt.MapClaims to achieve complete code coverage of the third return path in GetClaims().

Add this test case to complete coverage:

t.Run("returns empty map when claims are not MapClaims", func(t *testing.T) {
	token := &Token{
		processing: tokenProcessing{
			parsed: &golangjwt.Token{
				Claims: &golangjwt.RegisteredClaims{
					Subject: "test_subject",
				},
			},
		},
	}
	claims := token.GetClaims()
	assert.NotNil(t, claims)
	assert.Equal(t, 0, len(claims))
})

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 07a4282 and 18aadf8.

📒 Files selected for processing (2)

• jwt/jwt.go (1 hunks)
• jwt/jwt_test.go (2 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

jwt/jwt_test.go (1)

jwt/jwt.go (1)

• Token (21-26)

🔇 Additional comments (1)

jwt/jwt.go (1)

146-154: LGTM! Well-implemented safe claims accessor.

The implementation correctly handles edge cases by:

• Checking for nil parsed token
• Using type assertion with ok pattern
• Returning empty maps as safe defaults

The method integrates well with existing Token methods and follows consistent naming conventions.