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

fix: prevent commentor/viewer from enabling hidden columns #8268

Open
wants to merge 6 commits into
base: develop
Choose a base branch
from

Conversation

sreehari2003
Copy link
Contributor

@sreehari2003 sreehari2003 commented Apr 13, 2024

Change Summary

Change type

  • feat: (new feature for the user, not a new feature for build script)
  • fix: (bug fix for the user, not a fix to a build script)
  • docs: (changes to the documentation)
  • style: (formatting, missing semi colons, etc; no production code change)
  • refactor: (refactoring production code, eg. renaming a variable)
  • test: (adding missing tests, refactoring tests; no production code change)
  • chore: (updating grunt tasks etc; no production code change)

Test/ Verification

Provide summary of changes.

Additional information / screenshots (optional)

Anything for maintainers to be made aware of

Summary by CodeRabbit

  • New Features
    • Added role-based visibility for fields in the toolbar, enhancing user interface customization based on project roles.
    • Introduced conditional visibility for columns in views, allowing users to specify exceptions via an optional parameter.

Copy link
Contributor

coderabbitai bot commented Apr 13, 2024

Walkthrough

Walkthrough

The recent updates focus on enhancing role-based visibility and interaction with fields in a GUI component. New functionality includes checking user roles to determine the visibility of certain fields and introducing conditional logic for displaying columns based on specified IDs. These changes aim to improve user experience by tailoring interface interactions to user permissions and specific conditions.

Changes

File Path Change Summary
.../smartsheet/toolbar/FieldsMenu.vue Added ProjectRoles import, shouldShowField function for role-based field visibility, and useRoles hook for fetching roles.
.../composables/useViewColumns.ts Modified showAll function to accept ignoreIds, implementing conditional logic for field display based on these IDs.

Assessment against linked issues

Objective Addressed Explanation
Commenter/Viewer shouldn’t see hidden columns in the Fields menu. (#7867)
Ensure role-based visibility of fields and columns. (#7867)

The changes introduced in the FieldsMenu.vue and useViewColumns.ts files directly address the issue where Commenter/Viewer roles were previously able to view but not interact with certain hidden columns, as described in issue #7867. The implementation of role-based logic in the visibility of fields ensures that only appropriate roles can see and interact with specific fields and columns, aligning with the desired behavior outlined in the issue.


Recent Review Details

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 048ea0c and 8de2ab4.
Files selected for processing (1)
  • packages/nc-gui/components/smartsheet/toolbar/FieldsMenu.vue (9 hunks)
Files skipped from review as they are similar to previous changes (1)
  • packages/nc-gui/components/smartsheet/toolbar/FieldsMenu.vue

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>.
    • 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 show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

@dstala dstala requested a review from pranavxc April 13, 2024 10:50
Copy link
Member

@dstala dstala left a comment

Choose a reason for hiding this comment

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

For viewer/commenter role, shouldn't display the fields count - misleading
Screenshot 2024-04-16 at 12 51 42 PM

@sreehari2003
Copy link
Contributor Author

fix: prevent commentor/viewer from enabling hidden columns

  • Video https://sreehari-jayaraj.neetorecord.com/watch/399d7ab6-8a6c-42c8-9bf7-f279311e221b
  • This will break when the user clicks on the show all fields button , when someone clicks on the view all fields button an API call is triggered to convert all columns shown to true. we could hide the view and hide columns button from read-only access users. please let me know if we that issue can be fixed by some other way.
    n

@dstala I have fixed the hidden count issue and the issue I mentioned here.
video - https://sreehari-jayaraj.neetorecord.com/watch/dc028659-0a00-49aa-8fd6-64c7f685aa70

Copy link
Contributor

@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: 1

packages/nc-gui/composables/useViewColumns.ts Outdated Show resolved Hide resolved
Copy link
Member

@dstala dstala left a comment

Choose a reason for hiding this comment

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

for viewer, the fields count is always hidden. we should exclude default count. but if user hides some more fields explicitly, count for those should be visible

@sreehari2003
Copy link
Contributor Author

sreehari2003 commented Apr 17, 2024

for viewer, the fields count is always hidden. we should exclude default count. but if user hides some more fields explicitly, count for those should be visible

@dstala I have added this feature. Please see this video - https://sreehari-jayaraj.neetorecord.com/watch/ec9fdbd5-24d8-4e2f-aa78-d6b2f7cea42e

Copy link
Member

@dstala dstala left a comment

Choose a reason for hiding this comment

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

the solution is broken for editor & creator roles. the said changes should only be applied to viewer/commenter role. that likely explains why tests are failing. you can investigate further.

@sreehari2003
Copy link
Contributor Author

sreehari2003 commented Apr 18, 2024

the solution is broken for editor & creator roles. the said changes should only be applied to viewer/commenter role. that likely explains why tests are failing. you can investigate further.

I have fixed the issue.

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.

🐛 Bug: Commenter/Viewer can enable columns in View but they show empty
2 participants