Feature: Rework vaultDetails logic #271

infeo · 2024-04-19T15:25:57Z

This PR reworks/fixes the logic in vault details.

Changes:

vaultRole property is extended by a new value (NONE). An admin can access all vaults, but does not have the MEMBER role. This prevents errors done in future changes and keeps the model clean.
vaultDetails component emits now license updates, such that the license alert is displayed in the vault list, if on the server side the license changes
aligned translations key names used in the vaultDetails component
renamed RecoveryKeyDialog to DisplayRecoveryKeyDialog to be aligned with other dialog components
reworked license conditions
- use new license/user-info endpoint
- if the license is violated (aka expired or exceeded), only block grantAccess and addMember
seperated action bar into 4 containers
- vault is a legaceVault and someone needs to claim ownership
- vault is archived
- vault recovery is required
- other/regular vault
if vault is archived, you can still edit existing members (upgrade/downgrade/remove)
make dialogs dependent only on required properties and the "show" variable

Summary by CodeRabbit

New Features
- Introduced new user interface actions for claiming ownership and recovering vault access in the vault management section.
Enhancements
- Improved role-based conditions and actions in the VaultDetails component for better user experience based on user roles and license status.
- Added functionality to track and display accessible vaults in the VaultList component.
Bug Fixes
- Updated error messaging to more accurately reflect license violation scenarios.
Refactor
- Reorganized button actions and conditions in the vault components to align with updated role and license status logic.
Documentation
- Updated text keys in the localization files to enhance clarity and accuracy in user-facing messages.

* add upgradeToOwner button * group in different divs

and related fields/properties

Only block addMember/grantAccess, otherwise allow all features

... and allow removing/editing vault role

coderabbitai · 2024-04-19T15:26:08Z

Walkthrough

The update primarily enhances the management and interaction with vaults in a software application. It revises roles, introduces license status checks, and improves error messaging, ensuring a more intuitive and compliant user experience.

Changes

File Path	Change Summary
`frontend/.../VaultDetails.vue`	Refactored role conditions, added license violation checks, and reorganized button actions.
`frontend/.../VaultList.vue`	Added new computed properties for role and license status handling.
`frontend/src/i18n/de-DE.json`	Renamed actions related to vault management for clarity.
`frontend/src/i18n/en-US.json`	Updated text keys for vault actions and error messages.

Possibly related issues

Bottom of Vault Options 'Mounting' window cuts off half the chosen directory text box. cryptomator#3150: The changes in VaultDetails.vue could address the need for visual improvements and compatibility for the Vault Options window and dialog, enhancing the user experience.

🐇💻
A tiny hop in code, a giant leap in usability,
Refactored roles and licenses in harmony.
Vault doors open with a clearer key,
Errors whisper softly, as clear as can be.
Cheers to the devs, from a rabbit so merry! 🎉🥕

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 2dd4d53 and 4be8991.

Files selected for processing (4)

frontend/src/components/VaultDetails.vue (14 hunks)
frontend/src/components/VaultList.vue (5 hunks)
frontend/src/i18n/de-DE.json (2 hunks)
frontend/src/i18n/en-US.json (2 hunks)

Files skipped from review as they are similar to previous changes (4)

frontend/src/components/VaultDetails.vue
frontend/src/components/VaultList.vue
frontend/src/i18n/de-DE.json
frontend/src/i18n/en-US.json

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.

coderabbitai

Actionable comments posted: 1

frontend/src/components/VaultDetails.vue

Co-authored-by: Sebastian Stenzel <[email protected]>

tobihagemann

Just did a code review for now. Is my assumption right that you didn't really change anything in the UI? Or is there a noteworthy change?

frontend/src/components/VaultDetails.vue

frontend/src/i18n/en-US.json

frontend/src/components/VaultDetails.vue

Co-authored-by: Tobias Hagemann <[email protected]>

infeo · 2024-04-22T14:21:28Z

Is my assumption right that you didn't really change anything in the UI?

Nothing apparently visible. As wrote in the opening comment, i cleaned the license logic, such that only grant access and addMember are blocked. All other features are enabled.

overheadhunter

Didn't test, so take this review with a grain of salt. Code change lgtm though.

SailReal

I really like this change but I still need to run some tests...

Only I do not really understand the reason behind the change from RecoveryKeyDialog to DisplayRecoveryKeyDialog? For me a dialog is already something to display? Things get wild at the latest with showDisplayRecoveryKeyDialog 😅

infeo · 2024-04-23T06:59:07Z

Only I do not really understand the reason behind the change from RecoveryKeyDialog to DisplayRecoveryKeyDialog?

If you are looking at the other *Dialog names, you notices a general scheme of "[Verb][Noun(s)]Dialog": A dialog does something with an object, aka it has an intention/action. A "RecoveryKeyDialog" breaks with this scheme, because it is not clear what the intention of the dialog is. SHould it change th recoveryKey? Should it display it?

I just fitted it into the scheme and from my perspective, it is now clearer and additionally easier to distinc from the recoverVaultDialog.

coderabbitai

Actionable comments posted: 0

Out of diff range and nitpick comments (1)

frontend/src/components/VaultDetails.vue (1)

63-68: Consider adding a confirmation dialog before changing a member's role to 'OWNER'.

SailReal

In

hub/frontend/src/components/VaultDetails.vue

Line 290 in 3a7a132

const vaultKeyJwe = await backend.vaults.accessToken(props.vaultId, true);

when the license has expired, the backend returns a 402 for /vaults/${vaultId}/access-token?evenIfArchived=true and is mapped to a PaymentRequiredError which is caught in this method, but results in no vaultKeys being set, and in turn the Show Recovery Key button cannot show the DisplayRecoveryKeyDialog but does nothing due to

hub/frontend/src/components/VaultDetails.vue

Line 191 in 3a7a132

    
           <DisplayRecoveryKeyDialog v-if="displayingRecoveryKey && vault && vaultKeys" ref="displayRecoveryKeyDialog" :vault="vault" :vault-keys="vaultKeys" @close="displayingRecoveryKey = false" />

We should not show this button if vaultKeys is missing.

… vaults

infeo · 2024-04-23T21:27:54Z

@SailReal Thanks for the finding. I fixed it in 2dd4d53 creating an own div for actions possible, when the license is violated.

infeo added 18 commits March 4, 2024 16:09

refactor button bar in vault details:

94568d9

* add upgradeToOwner button * group in different divs

Merge branch 'develop' into feature/260-own-orphaned-vault

6e0192b

rename recovery key dialog component

4f68667

and related fields/properties

renaming recoverVault field to fit into naming scheme

e9dab09

use new license API to get user info about license

8f9e406

more renaming

3aff158

add becomeOwner button also to archiveVault state

9bb88f6

unwrapped button

6a71d5e

reworked license logic

29c6b42

Only block addMember/grantAccess, otherwise allow all features

cleanup vaultRecoveryRequired logic

1355f94

merge licenseViolated and regular buttons div

aa2937e

renaming translation keys

35cebf8

fix wrong legacyVault detection logic

38881f9

button formatting

5d4f41f

remove becomeOwner buttons (see #260 for details)

fa42fb4

show members on archived vaults

a391bac

... and allow removing/editing vault role

reduce diff

28b34ec

update license also in parent component

9396a0e

infeo requested review from SailReal and tobihagemann April 19, 2024 15:25

coderabbitai bot reviewed Apr 19, 2024

View reviewed changes

frontend/src/components/VaultDetails.vue Show resolved Hide resolved

upgrade license if the vault is unarchived

8e5db22

overheadhunter requested changes Apr 20, 2024

View reviewed changes

frontend/src/components/VaultDetails.vue Outdated Show resolved Hide resolved

Use string litaral types for vaultRole property

30d4031

Co-authored-by: Sebastian Stenzel <[email protected]>

infeo requested a review from overheadhunter April 22, 2024 10:02

tobihagemann requested changes Apr 22, 2024

View reviewed changes

frontend/src/components/VaultDetails.vue Outdated Show resolved Hide resolved

frontend/src/i18n/en-US.json Outdated Show resolved Hide resolved

frontend/src/components/VaultDetails.vue Outdated Show resolved Hide resolved

Apply suggestions from review

79d980d

Co-authored-by: Tobias Hagemann <[email protected]>

overheadhunter approved these changes Apr 22, 2024

View reviewed changes

SailReal reviewed Apr 22, 2024

View reviewed changes

infeo added 2 commits April 23, 2024 11:24

use vaultRole type when opening vaultDetails component

e4204c4

simplify

3a7a132

infeo requested a review from tobihagemann April 23, 2024 09:25

coderabbitai bot reviewed Apr 23, 2024

View reviewed changes

SailReal requested changes Apr 23, 2024

View reviewed changes

infeo added 3 commits April 23, 2024 14:52

edit vault metadata does not require vaultKeys

04502b1

refactor button section to have own div, if license is invalid

dde5483

change order of divs to ensure that vaultKeys are present on archived…

2dd4d53

… vaults

infeo requested a review from SailReal April 23, 2024 21:28

Merge branch 'develop' into feature/fix-vault-details-logic

4be8991

SailReal approved these changes Apr 24, 2024

View reviewed changes

tobihagemann approved these changes Apr 24, 2024

View reviewed changes

infeo merged commit dac175f into develop Apr 24, 2024
4 checks passed

infeo deleted the feature/fix-vault-details-logic branch April 24, 2024 14:48

infeo added this to the next milestone Apr 24, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature: Rework vaultDetails logic #271

Feature: Rework vaultDetails logic #271

infeo commented Apr 19, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Apr 19, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

tobihagemann left a comment

infeo commented Apr 22, 2024

overheadhunter left a comment

SailReal left a comment •

edited

Loading

infeo commented Apr 23, 2024

coderabbitai bot left a comment

SailReal left a comment •

edited

Loading

infeo commented Apr 23, 2024

Feature: Rework vaultDetails logic #271

Feature: Rework vaultDetails logic #271

Conversation

infeo commented Apr 19, 2024 • edited by coderabbitai bot Loading

Summary by CodeRabbit

coderabbitai bot commented Apr 19, 2024 • edited Loading

Walkthrough

Changes

Possibly related issues

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

tobihagemann left a comment

Choose a reason for hiding this comment

infeo commented Apr 22, 2024

overheadhunter left a comment

Choose a reason for hiding this comment

SailReal left a comment • edited Loading

Choose a reason for hiding this comment

infeo commented Apr 23, 2024

coderabbitai bot left a comment

Choose a reason for hiding this comment

SailReal left a comment • edited Loading

Choose a reason for hiding this comment

infeo commented Apr 23, 2024

infeo commented Apr 19, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Apr 19, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

SailReal left a comment •

edited

Loading

SailReal left a comment •

edited

Loading