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 archived vault migration during Hub upgrade #270

Merged
merged 1 commit into from
Apr 12, 2024

Conversation

SailReal
Copy link
Member

@SailReal SailReal commented Apr 12, 2024

Posting new access-tokens does not harm for archived vaults. Hard and soft boundaries are still respected.

Fixes #269

Summary by CodeRabbit

  • Bug Fixes
    • Removed restrictions on accessing archived vaults, allowing users to access their archived content without limitations.
    • Updated the response behavior for accessing archived vaults, ensuring users receive a successful status, enhancing usability.

Posting new access-tokens does not harm for archived vaults. Hard and
soft boundaries are still respected.

Fixes #269
Copy link

coderabbitai bot commented Apr 12, 2024

Walkthrough

The recent changes involve modifying how archived vaults are handled in the VaultResource class by removing checks that previously prevented access to archived vaults. Additionally, the associated tests have been updated to reflect new expectations where accessing archived vaults now returns an HTTP 200 status, indicating successful access.

Changes

File Path Change Summary
.../api/VaultResource.java Removed checks for vault being archived in grantAccess method.
.../api/VaultResourceTest.java Updated HTTP status codes for accessing archived vaults from 403 and 410 to 200

Assessment against linked issues

Objective Addressed Explanation
Enable unarchiving vaults post-upgrade and manage ownership claims (Issue #269) Changes suggest easier access to archived vaults, but specific unarchiving capability and ownership management confirmation is unclear.
Prevent orphaned vaults and enable admin to claim ownership (Issue #260) No changes related to orphaned vault management or admin intervention.

Possibly related issues

  • Issue Removing vault-owning user can lead to orphaned, unmanagable vaults #260: The changes might indirectly affect how orphaned vaults are accessed, but do not address ownership claiming or admin intervention directly.
  • Issue #3352: While not directly related, the ease of access changes could influence how vaults are interacted with in system file managers, potentially impacting visibility and access issues discussed in this issue.

🐇✨
A hop, a skip, in the code we dip,
Changes abound, in vaults unzipped.
No more locks on the archived box,
Access for all, as the rabbit talks.
Celebrate we do, with a carrot or two! 🥕🥕
🌟🐰


Recent Review Details

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between ead4705 and c42ccba.
Files selected for processing (2)
  • backend/src/main/java/org/cryptomator/hub/api/VaultResource.java (1 hunks)
  • backend/src/test/java/org/cryptomator/hub/api/VaultResourceTest.java (2 hunks)
Additional comments not posted (5)
backend/src/main/java/org/cryptomator/hub/api/VaultResource.java (3)

Line range hint 1-1: Overview of changes in VaultResource.java.

The changes in this file are focused on modifying the behavior of archived vaults to allow operations on them as if they were active. This is achieved by removing checks that previously prevented such operations.


Line range hint 1-1: Ensure proper handling of archived vaults in grantAccess.

The removal of checks for archived vaults in the grantAccess method should be carefully verified to ensure it does not introduce security vulnerabilities or logical errors. This change is intended to allow operations on archived vaults, but it is crucial to ensure that it does not inadvertently allow unauthorized access.


Line range hint 1-1: Review handling of ignoreArchived parameter in unlock method.

The unlock method includes a parameter ignoreArchived that allows the method to ignore the archived status of the vault. This change should be verified to ensure it is implemented correctly and does not introduce security vulnerabilities. Specifically, verify that the method correctly handles cases where ignoreArchived is set to true and false.

backend/src/test/java/org/cryptomator/hub/api/VaultResourceTest.java (2)

165-168: The modification to expect a 200 status code for archived vaults when evenIfArchived is set to true aligns with the PR's objectives. This ensures that the test reflects the new functionality correctly.


381-385: Adding a test to verify that accessing tokens for archived vaults returns a 200 status code under the correct conditions is a necessary validation for the new functionality. This test ensures that the system behaves as expected when the evenIfArchived parameter is used.


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.

Comment on lines 164 to 169
@Test
@DisplayName("GET /vaults/7E57C0DE-0000-4000-8000-00010000AAAA/access-token returns 403 for archived vaults with evenIfArchived set to true")
@DisplayName("GET /vaults/7E57C0DE-0000-4000-8000-00010000AAAA/access-token returns 200 for archived vaults with evenIfArchived set to true")
public void testUnlockArchived3() throws SQLException {
when().get("/vaults/{vaultId}/access-token?evenIfArchived=true", "7E57C0DE-0000-4000-8000-00010000AAAA")
.then().statusCode(403);
.then().statusCode(200);
}
Copy link
Member

Choose a reason for hiding this comment

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

Why did the old test succeed? 😭

Copy link
Member Author

Choose a reason for hiding this comment

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

Quiet exactly for the same reason described in the bug report: In the testGrantAccessArchived, the access-token wasn't added because this vault is archived and then the GET /vaults/{vaultId}/access-token?evenIfArchived=true resource throws a ForbiddenException (403).

@SailReal SailReal merged commit 36d5b22 into develop Apr 12, 2024
4 checks passed
@SailReal SailReal deleted the feature/fix-migrate-archived-vaults branch April 12, 2024 18:27
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.

After upgrade 1.2.2 -> 1.3.3, archived vault can't be unarchived
2 participants