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 system fields from getting deleted manually #8285

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

Conversation

sreehari2003
Copy link
Contributor

@sreehari2003 sreehari2003 commented Apr 16, 2024

Change Summary

Provide summary of changes with issue number if any.

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

  • Bug Fixes
    • Updated the logic in the menu to correctly display the delete option for columns based on specific conditions (presence of a primary key and deletion permissions).
  • Documentation
    • Added a new label in the language file related to deleting system fields.

Copy link
Contributor

coderabbitai bot commented Apr 16, 2024

Walkthrough

Walkthrough

The update in the Menu.vue component introduces a condition to prevent the deletion of columns marked as primary keys (pk). This change ensures that primary keys, which are crucial for database integrity, are not removed through the GUI, aligning with the need to maintain consistent data management practices.

Changes

File Path Change Summary
.../smartsheet/header/Menu.vue Refactored delete action handling, added tooltips, and reorganized menu items
.../lang/en.json Added a new label for system field deletion message

Assessment against linked issues

Objective Addressed Explanation
Prevent manual deletion of primary keys (#8236)
Ensure system fields can be displayed but not edited or deleted (#8236) The changes primarily focus on preventing deletion of primary keys, not editing or displaying system fields.

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.

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.

@sreehari2003 instead of removing delete option, it would be preferred to have it still in the menu - but keep it disabled. On hover- we can show tooltip Deleting system field is not allowed

@sreehari2003
Copy link
Contributor Author

sreehari2003 commented Apr 17, 2024

@sreehari2003 instead of removing delete option, it would be preferred to have it still in the menu - but keep it disabled. On hover- we can show tooltip Deleting system field is not allowed.

@dstala I have added the tooltip.

image

@rameshmane7218 rameshmane7218 added the 🛑 Status: Do Not Merge Used in PR only. The PR cannot be merged due to some reasons. label Apr 18, 2024
@rameshmane7218 rameshmane7218 self-requested a review April 18, 2024 07:54
@rameshmane7218 rameshmane7218 removed the 🛑 Status: Do Not Merge Used in PR only. The PR cannot be merged due to some reasons. label Apr 23, 2024
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: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between d49ffd2 and e7417f4.
Files ignored due to path filters (1)
  • packages/nc-gui/lang/en.json is excluded by !**/*.json
Files selected for processing (1)
  • packages/nc-gui/components/smartsheet/header/Menu.vue (1 hunks)
Additional comments not posted (1)
packages/nc-gui/components/smartsheet/header/Menu.vue (1)

471-480: Ensure deletion prevention logic is robust and clear.

The implementation of the deletion prevention logic using isDeleteAllowed and checking if the column is a primary key (column?.pk) is a good approach. It effectively prevents the deletion of system fields, aligning with the PR's objectives. The tooltip providing feedback when deletion is not allowed enhances user experience by making the restrictions clear.

@sreehari2003 sreehari2003 force-pushed the 8236-fix-remove-delete-system-fields branch from e7417f4 to be77f75 Compare May 17, 2024 11:38
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: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between e7417f4 and be77f75.
Files selected for processing (1)
  • packages/nc-gui/components/smartsheet/header/Menu.vue (1 hunks)
Additional comments not posted (1)
packages/nc-gui/components/smartsheet/header/Menu.vue (1)

531-540: Ensure tooltip and delete option behavior aligns with requirements.

The tooltip correctly displays a message when the delete action is not allowed, and the delete option is disabled for primary keys (column?.pk) and when deletion is not allowed (!isDeleteAllowed). This aligns with the PR objectives to prevent deletion of system fields.

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

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between be77f75 and 7740360.
Files selected for processing (1)
  • packages/nc-gui/components/smartsheet/header/Menu.vue (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • packages/nc-gui/components/smartsheet/header/Menu.vue

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: Primary key shouldn't be deleted manually.
3 participants