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: Require Download started before Confirmation #559

Merged
merged 4 commits into from
Oct 28, 2024

Conversation

CelineTrammi
Copy link
Collaborator

@CelineTrammi CelineTrammi commented Oct 28, 2024

Description

Add validation to ensure Download has been started before the user can Confirm a download.

Related Issue(s)

Verification

  • Your code builds clean without any errors or warnings
  • Manual testing done (required)
  • Relevant automated test added (if you find this hard, leave it and we'll help out)
  • All tests run green

Documentation

  • User documentation is updated with a separate linked PR in altinn-studio-docs. (if applicable)

Summary by CodeRabbit

  • New Features

    • Enhanced validation for confirming downloads, ensuring that confirmation cannot occur before a download has started.
    • Introduced a new error message for attempts to confirm downloads prematurely.
  • Bug Fixes

    • Improved error handling related to file transfer statuses and user access rights.
  • Tests

    • Added tests for confirming file transfers before downloads start and for successful download confirmations after file transfers.
  • Documentation

    • Updated error definitions and messages for clarity and consistency.

@CelineTrammi CelineTrammi added the kind/bug Something isn't working label Oct 28, 2024
@CelineTrammi CelineTrammi linked an issue Oct 28, 2024 that may be closed by this pull request
Copy link

coderabbitai bot commented Oct 28, 2024

📝 Walkthrough

Walkthrough

The pull request introduces significant changes to the ConfirmDownloadHandler class, specifically in its Process method, which now enforces stricter validation for confirming downloads. It checks if any recipient's status is DownloadStarted before allowing confirmation, returning an error if this condition is not met. Additionally, the Errors class has been reorganized with new error definitions, including a new error for confirming downloads before they start. Corresponding tests have been added to ensure the new logic is covered.

Changes

File Path Change Summary
src/Altinn.Broker.Application/ConfirmDownload/ConfirmDownloadHandler.cs Modified the Process method to check if any recipient's status is DownloadStarted before confirming a download, returning an error if this condition is not met.
src/Altinn.Broker.Application/Errors.cs Updated error definitions, removed old errors, added new error ConfirmDownloadBeforeDownloadStarted with code 19, and renumbered existing errors sequentially starting from 2.
tests/Altinn.Broker.Tests/FileTransferControllerTests.cs Added a test method ConfirmFileTransferBeforeDownloadStarted_Fails to validate that confirming a download before it starts fails as expected.
tests/Altinn.Broker.Tests/LegacyFileControllerTests.cs Added a test method Download_ConfirmDownloaded_Success to ensure that confirming a download after it has been completed works correctly and updates the statuses as expected.

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.

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.

@CelineTrammi CelineTrammi changed the title Fix/download before confirmation Fix: Require Download started before Confirmation Oct 28, 2024
Copy link

@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: 3

🧹 Outside diff range and nitpick comments (2)
src/Altinn.Broker.Application/ConfirmDownload/ConfirmDownloadHandler.cs (1)

54-54: Track the TODO comment about DownloadFinished status.

The comment indicates a planned enhancement to use DownloadFinished instead of DownloadStarted. This should be tracked to ensure it's not forgotten.

Would you like me to create a GitHub issue to track this enhancement? The issue would cover:

  1. Adding a new DownloadFinished status
  2. Updating the validation logic to use this status
  3. Ensuring backward compatibility during the transition
tests/Altinn.Broker.Tests/FileTransferControllerTests.cs (1)

238-255: LGTM! Consider adding a comment explaining the test scenario.

The test implementation is well-structured and follows the AAA pattern. It effectively verifies that attempting to confirm a download before it starts fails with the correct error message.

Consider adding a brief XML comment above the test method to document the specific scenario being tested and its importance. For example:

+/// <summary>
+/// Verifies that attempting to confirm a file transfer before initiating the download
+/// fails with the appropriate error message. This prevents premature confirmations
+/// that could lead to inconsistent state.
+/// </summary>
 [Fact]
 public async Task ConfirmFileTransferBeforeDownloadStarted_Fails()
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 797cad6 and d5b067f.

📒 Files selected for processing (4)
  • src/Altinn.Broker.Application/ConfirmDownload/ConfirmDownloadHandler.cs (1 hunks)
  • src/Altinn.Broker.Application/Errors.cs (1 hunks)
  • tests/Altinn.Broker.Tests/FileTransferControllerTests.cs (1 hunks)
  • tests/Altinn.Broker.Tests/LegacyFileControllerTests.cs (1 hunks)
🔇 Additional comments (2)
src/Altinn.Broker.Application/Errors.cs (1)

27-27: LGTM! New error definition aligns with PR objectives.

The new ConfirmDownloadBeforeDownloadStarted error is well-defined with a clear message and appropriate HTTP status code. It properly supports the validation requirement ensuring downloads are initiated before confirmation.

tests/Altinn.Broker.Tests/LegacyFileControllerTests.cs (1)

435-436: LGTM! Good addition of download verification.

The explicit check for download success before proceeding with confirmation aligns well with the PR objective of ensuring downloads are initiated before confirmation.

@CelineTrammi CelineTrammi marked this pull request as draft October 28, 2024 12:31
@CelineTrammi CelineTrammi marked this pull request as ready for review October 28, 2024 12:58
Copy link

@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

🧹 Outside diff range and nitpick comments (1)
src/Altinn.Broker.Application/ConfirmDownload/ConfirmDownloadHandler.cs (1)

54-56: LGTM! Consider implementing the TODO comment in a separate PR.

The validation logic correctly checks if the current recipient has started their download before allowing confirmation. This fixes the issue mentioned in the previous review where all recipients were being checked.

However, there's a TODO comment about replacing DownloadStarted with DownloadFinished. This would be a breaking change and should be tracked separately.

Would you like me to create a GitHub issue to track the implementation of DownloadFinished status?

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between d5b067f and 823ee2a.

📒 Files selected for processing (1)
  • src/Altinn.Broker.Application/ConfirmDownload/ConfirmDownloadHandler.cs (1 hunks)
🔇 Additional comments (1)
src/Altinn.Broker.Application/ConfirmDownload/ConfirmDownloadHandler.cs (1)

54-57: Well-integrated validation logic.

The new validation check is cleanly integrated into the existing flow:

  1. It occurs at the right point - after basic checks but before the transaction
  2. Returns a specific error that clearly indicates the issue
  3. Maintains the integrity of the subsequent transaction and cleanup logic

Copy link
Collaborator

@Andreass2 Andreass2 left a comment

Choose a reason for hiding this comment

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

Looks good

@CelineTrammi CelineTrammi merged commit dcd05f3 into main Oct 28, 2024
6 checks passed
@CelineTrammi CelineTrammi deleted the fix/download-before-confirmation branch October 28, 2024 13:05
@coderabbitai coderabbitai bot mentioned this pull request Nov 13, 2024
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Ingen bekreftelse uten nedlastning i Broker
2 participants