Fix: coalesce nulls when Hasura claims don't exist

[coel]

Explain your changes

When Hasura claims are not included in the token the resultant null claim causes getUserOrganizations() to return null due to an exception trying to spread the null.

Checklist

• I have read the “Pull requests” section in the contributing guidelines.
• I agree to the terms within the code of conduct.

🛟 If you need help, consider asking for advice over in the Kinde community.

[coderabbitai]

Walkthrough

The pull request introduces changes to two files: KindeBrowserClient.js and getUserOrganizations.ts. In KindeBrowserClient.js, the userOrganizations state property is modified to initialize as null instead of an empty array. In getUserOrganizations.ts, the handling of hasuraOrgCodes and hasuraOrganizations variables is updated to use a nullish coalescing operator, ensuring that any null or undefined values are replaced with an empty array. These changes enhance the robustness of the code without altering the overall logic or functionality.

Changes

File	Change Summary
src/frontend/KindeBrowserClient.js	Modified userOrganizations state initialization from [] to null.
src/session/getUserOrganizations.ts	Updated type assertions for hasuraOrgCodes and hasuraOrganizations to use ?? [] for robustness.

Suggested reviewers

• peterphanouvong
• evgenyk
• alex72508

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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 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

🧹 Outside diff range and nitpick comments (2)

src/session/getUserOrganizations.ts (1)

23-29: Overall improvement in null handling with a suggestion for error logging

These changes significantly improve the robustness of the getUserOrganizationsFactory function by ensuring that hasuraOrgCodes and hasuraOrganizations are always arrays, even when the corresponding claims are null or undefined. This directly addresses the issue described in the PR objectives and prevents exceptions when spreading these values.

While the changes are excellent, consider enhancing the error logging in the catch block. Currently, it only logs the error in debug mode. It might be beneficial to log specific information about which claim (if any) was null or undefined, to aid in future debugging or monitoring.

For example:

} catch (error) {
  if (config.isDebugMode) {
    console.debug('getUserOrganization error:', error);
    if (error instanceof TypeError) {
      console.debug('Possible null claim value. hasuraOrgCodes:', hasuraOrgCodes, 'hasuraOrganizations:', hasuraOrganizations);
    }
  }
  return null;
}

This additional logging could provide more context about the nature of any errors that occur, while still maintaining the current behavior of returning null on error.

src/frontend/KindeBrowserClient.js (1)

26-26: Approve change with suggestion for improvement

The change to initialize userOrganizations as null aligns well with the PR objective of handling cases where Hasura claims don't exist. This allows for a clear distinction between "no data fetched yet" (null) and "fetched but empty" (empty array).

However, to ensure robustness, consider updating the getUserOrganizations function to handle the null case:

const getUserOrganizations = () => {
-  return state.userOrganizations;
+  return state.userOrganizations ?? [];
};

This change ensures that consumers of getUserOrganizations always receive an array, maintaining backwards compatibility while allowing for the new null initial state.

Additionally, consider adding a comment explaining the rationale behind using null instead of an empty array for initial state:

userOrganizations: null // Initialized as null to distinguish between "no data fetched" and "fetched but empty"

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 4b83d80 and b283662.

📒 Files selected for processing (2)

• src/frontend/KindeBrowserClient.js (1 hunks)
• src/session/getUserOrganizations.ts (1 hunks)

🧰 Additional context used

🔇 Additional comments (2)

src/session/getUserOrganizations.ts (2)

23-23: Excellent addition of null coalescing operator

The addition of ?? [] is a great improvement. It ensures that hasuraOrgCodes will always be an array, even if the claim value is null or undefined. This change directly addresses the issue mentioned in the PR objectives and prevents potential exceptions when spreading this value later in the function.

---

29-29: Consistent null handling for hasuraOrganizations

This change mirrors the improvement made to hasuraOrgCodes, ensuring that hasuraOrganizations is always an array. This consistency in handling potential null values from claim data is commendable and further strengthens the function's resilience.