Send DeviceId to Hub during vault key retrieval

[SailReal]

See cryptomator/hub#320

[coderabbitai]

Walkthrough

The pull request updates the getAccessToken method in the VaultService class by adding an extra parameter for a device identifier. The method signature is changed from accepting only a vault identifier (vaultId) to requiring both vaultId and deviceId. This modification is propagated across multiple classes (VaultAddGroup, VaultAddUser, VaultCreateTemplate, and VaultRecoveryKey), where the method calls are updated to include the new parameter. Additionally, the implementation of getAccessToken now embeds the device identifier as a header in the HTTP request used to retrieve the access token. The error handling logic remains unchanged, ensuring that exceptions such as unexpected status codes are still managed as before.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0ef83e8 and 718cf32.

📒 Files selected for processing (5)

• src/main/java/org/cryptomator/hubcli/Backend.java (1 hunks)
• src/main/java/org/cryptomator/hubcli/VaultAddGroup.java (1 hunks)
• src/main/java/org/cryptomator/hubcli/VaultAddUser.java (1 hunks)
• src/main/java/org/cryptomator/hubcli/VaultCreateTemplate.java (1 hunks)
• src/main/java/org/cryptomator/hubcli/VaultRecoveryKey.java (1 hunks)

🔇 Additional comments (5)

src/main/java/org/cryptomator/hubcli/VaultRecoveryKey.java (1)

41-41: LGTM! Device ID is properly integrated into the vault key retrieval process.

The change correctly incorporates the device identifier when retrieving the vault access token, maintaining the existing error handling.

src/main/java/org/cryptomator/hubcli/VaultCreateTemplate.java (1)

48-48: LGTM! Device ID is properly integrated into the vault key retrieval process.

The change correctly incorporates the device identifier when retrieving the vault access token, maintaining the existing error handling.

src/main/java/org/cryptomator/hubcli/VaultAddUser.java (1)

69-69: LGTM! Device ID is properly integrated into the vault key retrieval process.

The change correctly incorporates the device identifier when retrieving the vault access token, with proper JWT expiration validation and error handling.

src/main/java/org/cryptomator/hubcli/VaultAddGroup.java (1)

55-55: LGTM! Device ID is properly integrated into the vault key retrieval process.

The change correctly incorporates the device identifier when retrieving the vault access token, with proper JWT expiration validation and error handling.

src/main/java/org/cryptomator/hubcli/Backend.java (1)

103-104: LGTM! Implementation aligns with PR objectives.

The changes correctly implement the requirement to send the DeviceId to Hub during vault key retrieval by adding it as a request header.

Consider adding input validation for the deviceId parameter to ensure it's not null or empty:

 public HttpResponse<String> getAccessToken(UUID vaultId, String deviceId) throws IOException, InterruptedException, UnexpectedStatusCodeException {
+    if (deviceId == null || deviceId.trim().isEmpty()) {
+        throw new IllegalArgumentException("deviceId must not be null or empty");
+    }
     var vaultKeyReq = createRequest("vaults/" + vaultId + "/access-token").header("deviceId", deviceId).GET().build();

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 generate docstrings to generate docstrings for this PR. (Beta)
• @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.

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