woocommerce-ios icon indicating copy to clipboard operation
woocommerce-ios copied to clipboard

Background image upload for products without attaching images to the products (unit test of `ProductImageActionHandler`)

Open pmusolino opened this issue 9 months ago • 6 comments

Part 7 of the changes needed for product image upload in the background.

Before merging this PR, make sure to merge this one.

Description

This PR just updates unit tests for ProductImageActionHandler when backgroundProductImageUpload feature flag is enabled.

Testing information

Unit Tests should pass ✅


  • [ x] I have considered if this change warrants user-facing release notes and have added them to RELEASE-NOTES.txt if necessary.

Reviewer (or Author, in the case of optional code reviews):

Please make sure these conditions are met before approving the PR, or request changes if the PR needs improvement:

  • [ ] The PR is small and has a clear, single focus, or a valid explanation is provided in the description. If needed, please request to split it into smaller PRs.
  • [ ] Ensure Adequate Unit Test Coverage: The changes are reasonably covered by unit tests or an explanation is provided in the PR description.
  • [ ] Manual Testing: The author listed all the tests they ran, including smoke tests when needed (e.g., for refactorings). The reviewer confirmed that the PR works as expected on all devices (phone/tablet) and no regressions are added.

pmusolino avatar Mar 07 '25 15:03 pmusolino

@coderabbitai review

pmusolino avatar Mar 07 '25 15:03 pmusolino

[!IMPORTANT]

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

Walkthrough

This change introduces six new tests in the ProductImageActionHandlerTests suite. The added test methods verify the behavior of media uploads when a background upload feature flag is enabled. They assess scenarios for successful and unsuccessful uploads, ensure that UIImage uploads correctly pass a filename and alt text, update the uploading status accurately, handle the discard of an upload, and propagate product ID updates to existing statuses.

Changes

File Path Change Summary
WooCommerce/.../ProductImageActionHandlerTests.swift Added six new test methods:
- test_uploading_media_successfully_if_feature_flag_enabled
- test_uploading_media_unsuccessfully_if_feature_flag_enabled
- test_uploading_UIImage_passes_filename_and_altText_to_MediaAction_in_background
- test_uploading_UIImage_adds_uploading_status_with_UIImage_asset_type_in_background
- test_productImageStatuses_are_updated_correctly_after_discard_upload_in_background
- test_updateProductID_propagates_to_existing_upload_statuses_in_background

Sequence Diagram(s)

sequenceDiagram
  participant Tester
  participant Handler as ProductImageActionHandler
  participant Media as MediaAction

  Tester->>Handler: Initiate media upload (feature flag enabled)
  Handler->>Media: Process media upload request
  alt Upload is Successful
    Media-->>Handler: Return success status
    Handler-->>Tester: Update status to "upload successful"
  else Upload Fails
    Media-->>Handler: Return error status
    Handler-->>Tester: Update status to "upload failed"
  end
sequenceDiagram
  participant Tester
  participant Handler as ProductImageActionHandler

  Tester->>Handler: Issue discard upload request
  Handler-->>Tester: Update product image status to "discarded"
  
  Tester->>Handler: Request product ID update for ongoing uploads
  Handler-->>Tester: Propagate product ID to existing upload statuses

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

coderabbitai[bot] avatar Mar 07 '25 15:03 coderabbitai[bot]

:white_check_mark: Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

coderabbitai[bot] avatar Mar 07 '25 15:03 coderabbitai[bot]

WooCommerce iOS📲 You can test the changes from this Pull Request in WooCommerce iOS by scanning the QR code below to install the corresponding build.

App NameWooCommerce iOS WooCommerce iOS
Build Numberpr15290-8cc25ec
Version21.9
Bundle IDcom.automattic.alpha.woocommerce
Commit8cc25ec3d61b71aa35c7269cea5bd33d361325c6
App Center BuildWooCommerce - Prototype Builds #13321
Automatticians: You can use our internal self-serve MC tool to give yourself access to App Center if needed.

wpmobilebot avatar Mar 07 '25 16:03 wpmobilebot

Version 22.0 has now entered code-freeze, so the milestone of this PR has been updated to 22.1.

wpmobilebot avatar Mar 21 '25 11:03 wpmobilebot

Version 22.1 has now entered code-freeze, so the milestone of this PR has been updated to 22.2.

wpmobilebot avatar Apr 04 '25 09:04 wpmobilebot