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

UserCard: do not show "Create copy" button if user not allowed to publish the card (#7427) #7440

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

quinarygio
Copy link
Contributor

Fix #7427

@quinarygio quinarygio linked an issue Oct 23, 2024 that may be closed by this pull request
@quinarygio quinarygio marked this pull request as draft October 23, 2024 12:43
@quinarygio quinarygio marked this pull request as ready for review October 23, 2024 13:34
Copy link

coderabbitai bot commented Oct 23, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request introduces significant modifications to both the Cypress integration tests for the User Card functionality and the CardActionsComponent. In the test suite, new test cases have been added to verify the visibility of the "create a copy" button based on user permissions, ensuring that it is hidden when the user is not included in the publisher list. The logic for checking button visibility has been refined, ensuring the copy button appears only when appropriate. Additionally, the tests for the "copy card" feature have been expanded to validate that specific fields are correctly copied from the original card, with particular attention to ensuring the emitter field is not copied. The CardActionsComponent has been updated to include a new method that checks user permissions for publishing cards, affecting the visibility logic of the create copy button. Overall, these changes enhance the robustness of the test suite and improve permission checks related to card actions.

Assessment against linked issues

Objective Addressed Explanation
Verify that the "create a copy" button does not show if the user lacks permission (7427)
Fix the error related to undefined properties when the "create a copy" button is clicked (7427) The PR does not directly address the console error mentioned in the linked issue.

Possibly related PRs

Suggested reviewers

  • freddidierRTE
  • vlo-rte

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 25bfa7b and f7348a6.

📒 Files selected for processing (2)
  • src/test/cypress/cypress/integration/UserCard.spec.js (1 hunks)
  • ui/main/src/app/modules/card/components/card-actions/card-actions.component.ts (2 hunks)
🔇 Additional comments (4)
ui/main/src/app/modules/card/components/card-actions/card-actions.component.ts (3)

31-31: LGTM!

The EntitiesService import is correctly added and necessary for the new functionality.


85-85: LGTM!

The additional check for entity publishing permissions is correctly integrated into the existing visibility logic, properly addressing the PR objective.


89-95: 🛠️ Refactor suggestion

Consider improvements to the publisher check implementation.

While the implementation is functionally correct, there are several potential improvements:

  1. As suggested in the previous review, consider renaming the method to isUserMemberOfAnEntityAllowedToPublishForThisState for better clarity.
  2. Add null check for this.cardState.userCard to prevent potential runtime errors.
  3. Consider caching the user entities to optimize performance when this method is called frequently.

Here's a suggested implementation:

-    private isUserMemberOfAnEntityAllowedToPublishForThisState(): boolean {
-        if (!this.cardState.userCard.publisherList) return true;
-        const userEntities = UserService.getCurrentUserWithPerimeters().userData.entities;
-        const allowedPublishers = EntitiesService.resolveEntities(this.cardState.userCard.publisherList);
-        const userAllowedEntities = allowedPublishers.filter((publisher) => userEntities.includes(publisher.id));
-        return userAllowedEntities.length > 0;
-    }
+    private isUserMemberOfAnEntityAllowedToPublishForThisState(): boolean {
+        if (!this.cardState?.userCard?.publisherList) return true;
+        
+        // Cache user entities at class level or use a memoization decorator
+        const userEntities = UserService.getCurrentUserWithPerimeters().userData.entities;
+        const allowedPublishers = EntitiesService.resolveEntities(this.cardState.userCard.publisherList);
+        
+        return allowedPublishers.some((publisher) => userEntities.includes(publisher.id));
+    }

Let's verify the usage of this method across the codebase:

src/test/cypress/cypress/integration/UserCard.spec.js (1)

1363-1374: LGTM! Test case properly verifies the "Create copy" button visibility.

The test case effectively validates that the "Create copy" button is not shown when a user is not in the publisher list entities, which directly addresses issue #7427. The test follows good practices:

  • Creates a test card with a specific user
  • Switches to another user who shouldn't have copy permissions
  • Verifies the button's absence

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

@freddidierRTE freddidierRTE self-assigned this Oct 24, 2024
freddidierRTE
freddidierRTE previously approved these changes Oct 24, 2024
Comment on lines 89 to 92
private doesTheUserHavePermissionToPublishCard(): boolean {
if (!this.cardState.userCard.publisherList) return true;
const userEntities = UserService.getCurrentUserWithPerimeters().userData.entities;
const allowedPublishers = EntitiesService.resolveEntities(this.cardState.userCard.publisherList);
Copy link
Contributor

Choose a reason for hiding this comment

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

i suggest to name the method isUserMemberOfAnEntityAllowedToPublishForThisState()

This is to be more precise and avoid confusion with the other control : UserService.isWriteRightsForProcessAndState

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

Copy link

sonarcloud bot commented Oct 24, 2024

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.

User card: create copy error
2 participants