Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create space link - check the entitlements #7441

Closed
wants to merge 5 commits into from

Conversation

bobbykolev
Copy link
Contributor

@bobbykolev bobbykolev commented Jan 14, 2025

Summary by CodeRabbit

  • New Features

    • Enhanced user space creation logic with license-based entitlement checks
    • Added support for verifying user permissions before generating space creation links
  • Version Update

    • Incremented package version from 0.79.6 to 0.79.7

Copy link

coderabbitai bot commented Jan 14, 2025

Walkthrough

This pull request involves two main changes: updating the package version from "0.79.6" to "0.79.7" and modifying the useCreateSpaceLink hook in the dashboard. The modification enhances user permission checks by introducing a new accountEntitlements variable from the useUserContext hook. The link generation logic now includes an additional check to verify if the user is entitled to create a space based on specific license types.

Changes

File Change Summary
package.json Version bumped from "0.79.6" to "0.79.7"
src/main/topLevelPages/myDashboard/useCreateSpaceLink/useCreateSpaceLink.tsx Added accountEntitlements to destructured hook return and updated link generation logic to check user entitlements

Possibly related PRs

Suggested labels

client

Suggested reviewers

  • ccanos

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7ec232c and 10256ad.

⛔ Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (1)
  • package.json (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • package.json
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Travis CI - Pull Request

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
🪧 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

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.

@bobbykolev bobbykolev changed the title Hotfix create space entitlements Create space link - check the entitlements Jan 14, 2025
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
src/main/topLevelPages/myDashboard/useCreateSpaceLink/useCreateSpaceLink.tsx (2)

18-22: Consider extracting license types to a constant.

The array of valid license entitlements could be moved to a named constant at the file level for better maintainability and reuse.

+const SPACE_CREATION_ENTITLEMENTS = [
+  LicenseEntitlementType.AccountSpaceFree,
+  LicenseEntitlementType.AccountSpacePlus,
+  LicenseEntitlementType.AccountSpacePremium,
+] as const;

 const link = useMemo(() => {
   // ...
-  const isEntitledToCreateSpace = [
-    LicenseEntitlementType.AccountSpaceFree,
-    LicenseEntitlementType.AccountSpacePlus,
-    LicenseEntitlementType.AccountSpacePremium,
-  ].some(entitlement => accountEntitlements.includes(entitlement));
+  const isEntitledToCreateSpace = SPACE_CREATION_ENTITLEMENTS.some(
+    entitlement => accountEntitlements.includes(entitlement)
+  );

24-24: Consider extracting the permission check to a separate function.

The combined check for privileges and entitlements could be more readable if extracted to a named function.

+const hasSpaceCreationPermission = (
+  privileges: AuthorizationPrivilege[],
+  entitlements: LicenseEntitlementType[]
+) => {
+  const isEntitledToCreateSpace = SPACE_CREATION_ENTITLEMENTS.some(
+    entitlement => entitlements.includes(entitlement)
+  );
+  return privileges.includes(AuthorizationPrivilege.CreateSpace) && isEntitledToCreateSpace;
+};

-if (accountPrivileges.includes(AuthorizationPrivilege.CreateSpace) && isEntitledToCreateSpace) {
+if (hasSpaceCreationPermission(accountPrivileges, accountEntitlements)) {
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b6bf111 and 7ec232c.

⛔ Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (3)
  • package.json (1 hunks)
  • src/core/ui/markdown/embed/allowedEmbedUrls.ts (1 hunks)
  • src/main/topLevelPages/myDashboard/useCreateSpaceLink/useCreateSpaceLink.tsx (2 hunks)
✅ Files skipped from review due to trivial changes (1)
  • package.json
🧰 Additional context used
📓 Path-based instructions (2)
src/core/ui/markdown/embed/allowedEmbedUrls.ts (1)

Pattern src/**/*.{ts,tsx,js}: Review the React.js/TypeScript/JavaScript code for best practices and potential bugs.
Ensure that the code adheres to TypeScript's typing system and modern standards.
Use the following code guide documentation in the codebase: 'docs/code-guidelines.md'.
Ensure sufficient error handling and logging is present, but note:

  • We have a global error handler in place. So local try/catch blocks are not required unless they provide value beyond what the global error handler already covers.
  • Avoid flagging the absence of local error handling in cases where the global error handler suffices.
  • Avoid flagging the absence of logging in cases where the global logger is already in place (graphql usage).

Inform about the recommendation of not using non-null assertion,
except on GraphQL queries where the variable is asserted non-null and followed by a
skip: with the same variable.
Examples:

  • Not Required: there's a skip
    {
    variables: { templateId: templateId! },
    skip: !templateId,
    }

Check for common security vulnerabilities such as:

  • SQL Injection
  • XSS (Cross-Site Scripting)
  • CSRF (Cross-Site Request Forgery)
  • Insecure dependencies
  • Sensitive data exposure
src/main/topLevelPages/myDashboard/useCreateSpaceLink/useCreateSpaceLink.tsx (1)

Pattern src/**/*.{ts,tsx,js}: Review the React.js/TypeScript/JavaScript code for best practices and potential bugs.
Ensure that the code adheres to TypeScript's typing system and modern standards.
Use the following code guide documentation in the codebase: 'docs/code-guidelines.md'.
Ensure sufficient error handling and logging is present, but note:

  • We have a global error handler in place. So local try/catch blocks are not required unless they provide value beyond what the global error handler already covers.
  • Avoid flagging the absence of local error handling in cases where the global error handler suffices.
  • Avoid flagging the absence of logging in cases where the global logger is already in place (graphql usage).

Inform about the recommendation of not using non-null assertion,
except on GraphQL queries where the variable is asserted non-null and followed by a
skip: with the same variable.
Examples:

  • Not Required: there's a skip
    {
    variables: { templateId: templateId! },
    skip: !templateId,
    }

Check for common security vulnerabilities such as:

  • SQL Injection
  • XSS (Cross-Site Scripting)
  • CSRF (Cross-Site Request Forgery)
  • Insecure dependencies
  • Sensitive data exposure
🔇 Additional comments (2)
src/core/ui/markdown/embed/allowedEmbedUrls.ts (1)

6-6: Verify security implications of the new embed domain.

While the HTTPS protocol is correctly used, please ensure that:

  1. The demo.arcade.software domain is a trusted source
  2. Consider documenting the purpose of this domain in a comment

Let's verify if this domain is referenced elsewhere in the codebase:

✅ Verification successful

Embed URL implementation is secure and well-implemented

The codebase implements robust security measures for embed URLs:

  • Strict HTTPS-only protocol enforcement
  • Proper origin validation
  • Comprehensive iframe sanitization
  • Strong error handling

The implementation treats arcade.software similarly to other trusted embed sources like YouTube and Vimeo.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for any other references to arcade.software domain
rg -i "arcade\.software"

Length of output: 107


Script:

#!/bin/bash
# Search for documentation and implementation details about embeds
echo "=== Searching for embed-related documentation ==="
fd -e md -e mdx | xargs rg -i "embed|arcade"

echo -e "\n=== Checking embed-related implementation files ==="
fd -e ts -e tsx | grep -i "embed" | xargs cat

Length of output: 9573

src/main/topLevelPages/myDashboard/useCreateSpaceLink/useCreateSpaceLink.tsx (1)

29-29: LGTM! Proper dependency array in useMemo.

The useMemo dependency array correctly includes all the dependencies used within the callback.

# Conflicts:
#	package-lock.json
#	package.json
@bobbykolev bobbykolev closed this Jan 14, 2025
@bobbykolev bobbykolev deleted the hotfix-create-space-entitlements branch January 14, 2025 09:36
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.

3 participants