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

[WEB-2474] chore: update page lock authorization #5635

Merged
merged 1 commit into from
Sep 18, 2024

Conversation

aaryan610
Copy link
Collaborator

@aaryan610 aaryan610 commented Sep 18, 2024

Improvements:

This PR updates the authorization for locking/unlocking a page. Now, only the creator/owner of a page can lock/unlock a page.

Plane issue: WEB-2474

Summary by CodeRabbit

  • New Features

    • Updated permission logic for locking pages, now allowing only page owners to lock their respective pages.
  • Bug Fixes

    • Simplified the logic for determining page lock permissions, enhancing clarity and reducing complexity.

Copy link
Contributor

coderabbitai bot commented Sep 18, 2024

Walkthrough

The pull request modifies the canCurrentUserLockPage method in the Page class within the web/core/store/pages/page.ts file. The change simplifies the logic to determine if the current user can lock a page, now only checking if the user is the owner. This removes previous checks related to project roles and permissions, thereby streamlining the permission logic.

Changes

File Change Summary
web/core/store/pages/page.ts Modified the canCurrentUserLockPage getter to only return ownership status.

Possibly related PRs

Suggested labels

🧹chore

Suggested reviewers

  • sriramveeraghanta
  • SatishGandham

Poem

In the garden where pages bloom,
A lock now guards with owner’s room.
No roles to weigh, just simple grace,
A page’s keeper finds their place.
Hopping through code, we cheer and play,
For clarity shines in a simpler way! 🐇✨


Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 146a500 and 18ce3d0.

Files selected for processing (1)
  • web/core/store/pages/page.ts (1 hunks)
Additional comments not posted (1)
web/core/store/pages/page.ts (1)

243-243: Simplification of page lock permission logic looks good!

The change to rely solely on the isCurrentUserOwner computed property to determine if a user can lock the page enhances security by limiting this ability to only the page owners.

However, please verify the impact of this change on the overall user experience and collaboration workflows, especially for scenarios where non-owner users with sufficient permissions were previously allowed to lock pages.

Run the following script to find instances where canCurrentUserLockPage is used:

Verification successful

Approval: Page locking restriction consistently implemented

The change to canCurrentUserLockPage has been consistently implemented across the codebase:

  1. In web/core/store/pages/page.ts, it now returns this.isCurrentUserOwner, restricting page locking to owners.
  2. The UI in web/core/components/pages/editor/header/options-dropdown.tsx uses this property to control the visibility of the lock/unlock option.

This implementation ensures that only page owners can lock pages, maintaining consistency between the backend logic and frontend UI.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Find usage of `canCurrentUserLockPage` to verify impact.

# Test: Search for usage of `canCurrentUserLockPage`. Expect: Review results to ensure the change doesn't break existing functionality.
rg --type typescript $'canCurrentUserLockPage' -A 5

Length of output: 85


Script:

#!/bin/bash
# Description: Verify TypeScript files and search for canCurrentUserLockPage usage

# Step 1: Check for TypeScript files
echo "Checking for TypeScript files:"
fd -e ts

# Step 2: Search for canCurrentUserLockPage in TypeScript files
echo -e "\nSearching for canCurrentUserLockPage in TypeScript files:"
rg "canCurrentUserLockPage" -t ts -C 5

# Step 3: If no results, search in JavaScript files as well
if [ $? -ne 0 ]; then
  echo -e "\nNo results found in TypeScript files. Searching in JavaScript files:"
  rg "canCurrentUserLockPage" -t js -C 5
fi

Length of output: 44466


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 generate interesting stats about this repository and render them as a table.
    -- @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.

@SatishGandham SatishGandham merged commit 441e5fc into preview Sep 18, 2024
14 of 15 checks passed
@SatishGandham SatishGandham deleted the chore/page-lock-access branch September 18, 2024 12:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants