Initial changes for saving product images upload statuses in UserDefaults #15196

pmusolino · 2025-02-18T22:46:08Z

Description

Purpose: Implement initial changes to save product image upload statuses in UserDefaults. (The actual save will happen in another PR) Ref. pe5sF9-3Uc
Why:
- Required for background image uploads.
- Ensure a stored queue of image statuses persists when the app is in the background.
- Queue includes siteID and productID.
Background:
- URLSession background configuration doesn't have access to ServiceLocator or similar classes.
- System processes every element in scheduled URLSession upload tasks.
- A queue must function even when the app isn't running.
Implementation:
- Introduces ProductImagesUserDefaultsStatuses for storing statuses in UserDefaults.
- Not currently used; will be implemented in a future PR.
- Suggest skipping the review of ProductImagesUserDefaultsStatuses due to significant changes in a subsequent PR.
Additional Changes:
- More changes than expected due to file relocations.

Questions that may arise:

Why use siteID and productID in ProductImageStatus?:
- Background URLSession doesn't allow request updates during execution or scheduling. If the app goes in background, we do not have any power on it.
- After user actions like pressing save, updating requests isn't feasible.
- Then, Storing IDs helps check statuses from UserDefaults and send subsequent requests at the end of every future upload request.
- Facilitates progress recovery and error management upon app re-launch from the background.

Main changes applied in this PR:

File Movements:
- Moved ProductImageStatus to the Networking layer for background URLSession access.
- Moved ProductOrVariationID enum to Networking layer for consistency.
Enhancements:
- ProductImageStatus and ProductImageAssetType now conform to Codable for UserDefaults storage.
- ProductImageStatus enum cases (uploading, remote, uploadFailure) now accept siteID and productID.
New Implementation:
- ProductImagesUserDefaultsStatuses for ProductImageStatus storage.
- Future changes expected, with unit tests to be added.
Code Updates:
- Updated image upload classes to handle siteID and productID.
- Updated related unit tests.

Testing information

Scenarios Tested:
- Uploading multiple images in a new product, both before and after publishing.
- Uploading multiple images in an existing product, both before and after saving.
- Selecting and saving new images from the WordPress media library.
- Ensuring image re-ordering functionality.
- Uploading images to product variations and saving them before/after upload completion.
- Managing image upload errors effectively.

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.

…d changes

…es in UserDefaults - Modify `ProductImageStatus.swift` to add Codable conformance and additional properties - Create `ProductImagesUserDefaultsStatuses.swift` for managing product image statuses in User Defaults - Move `ProductOrVariationID` in a separate file to define a type-safe identifier for products and variations - Update `Model.swift` to include `ProductOrVariationID` typealias

- Update `ProductImagesCollectionViewDataSource.swift` to include siteID and productID in `ProductImageStatus` cases. - Modify `ProductImagesHeaderTableViewCell.swift` to handle additional parameters in `ProductImageStatus`. - Adjust `Product+Media.swift` to pass siteID and productID when mapping images to `ProductImageStatus`. - Change `ProductImageActionHandler.swift` to incorporate siteID and productID in `ProductImageStatus` handling and updating. - Update `ProductImageStatus+Extension.swift` to manage new parameters in `ProductImageStatus`. - Amend `ProductImagesCollectionViewController.swift` to handle siteID and productID in status cases. - Modify `ProductImagesSaver.swift` to use siteID and productID in status comparison and updates. - Adjust `ProductImagesViewController.swift` to manage `ProductImageStatus` with siteID and productID.

… all statuses without the correct value are now updated. This ensures that even if the statuses were initially created with a nil or outdated productID, they will be updated to the new remoteProductID.

…uploading` and `uploadFailure` cases - Modify `ProductImagesUserDefaultsStatuses.swift` to handle optional `productID` in filtering statuses

dangermattic · 2025-02-18T22:46:50Z

	1 Warning
⚠️	This PR is larger than 300 lines of changes. Please consider splitting it into smaller PRs for easier and faster reviews.

Generated by 🚫 Danger

wpmobilebot · 2025-02-18T22:57:27Z

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

	App Name	WooCommerce iOS
	Build Number	pr15196-e012096
	Version	21.8
	Bundle ID	com.automattic.alpha.woocommerce
	Commit	`e012096`
	App Center Build	WooCommerce - Prototype Builds #13134

Automatticians: You can use our internal self-serve MC tool to give yourself access to App Center if needed.

…e for variations.

…user-defaults

wpmobilebot · 2025-02-21T07:13:41Z

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

…e-product-image-upload-statuses-in-user-defaults

…iationID` in `uploading` and `uploadFailure` cases - Update unit tests

…aving_successfully

…pending upload, then trigger the media upload after adding the observer.

…ic. Instead of direct PHAsset comparison, compare localIdentifier to ensure accurate detection and state updates from "uploading" to "remote." This resolves the issue where hasUnsavedChangesOnImages(...) incorrectly returns true after saving, fixing related test failures.

…id default `ServiceLocator` usage.

pmusolino added 7 commits February 18, 2025 15:48

refactor: moved ProductImageStatus into Networking layer and relate…

358daa8

…d changes

fix: spaces in ProductImageStatus

b7b2078

fix: when a product is published and updateProductID(_:) is called,…

e3c87b8

… all statuses without the correct value are now updated. This ensures that even if the statuses were initially created with a nil or outdated productID, they will be updated to the new remoteProductID.

- Update ProductImageStatus.swift to make productID optional in `…

66c6694

…uploading` and `uploadFailure` cases - Modify `ProductImagesUserDefaultsStatuses.swift` to handle optional `productID` in filtering statuses

update: unit tests regarding product image upload classes

6c678cf

pmusolino added this to the 21.8 milestone Feb 18, 2025

pmusolino added feature: product details Related to adding or editing products, including Product Settings. feature: add/edit products Related to adding or editing products. labels Feb 18, 2025

pmusolino requested review from itsmeichigo, selanthiraiyan and rachelmcr February 18, 2025 22:48

update: removed superfluous comment

d506946

pmusolino changed the title ~~Feat/save product image upload statuses in user defaults~~ Initial changes for saving product images upload statuses in UserDefaults Feb 18, 2025

pmusolino added 5 commits February 19, 2025 00:56

fix: product image variation management, which allow maximum one imag…

51a1cfd

…e for variations.

update: release-notes 21.8

70e0fa9

fix: failing unit tests

27a1146

Merge branch 'trunk' into feat/save-product-image-upload-statuses-in-…

1f96482

…user-defaults

Merge branch 'trunk' into feat/save-product-image-upload-statuses-in-…

c6be542

…user-defaults

wpmobilebot modified the milestones: 21.8, 21.9 Feb 21, 2025

pmusolino added 5 commits February 23, 2025 22:25

update: release-notes

561582a

Merge commit 'a6877f9a55e964ace617c9e82a8b8897db842c53' into feat/sav…

309d947

…e-product-image-upload-statuses-in-user-defaults

- Update ProductImageStatus.swift to use non-optional `ProductOrVar…

c84cef6

…iationID` in `uploading` and `uploadFailure` cases - Update unit tests

fix: test_hasUnsavedChangesOnImages_stays_false_after_uploading_and_s…

1344637

…aving_successfully

refactor: Set up the observer first to wait for the status change to …

f5803bb

…pending upload, then trigger the media upload after adding the observer.

pmusolino added 2 commits February 24, 2025 15:34

update: explicit injection of mock store dependencies in tests to avo…

e012096

…id default `ServiceLocator` usage.

pmusolino marked this pull request as ready for review February 24, 2025 17:11

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Initial changes for saving product images upload statuses in UserDefaults #15196

Initial changes for saving product images upload statuses in UserDefaults #15196

pmusolino commented Feb 18, 2025 •

edited

Loading

dangermattic commented Feb 18, 2025 •

edited

Loading

wpmobilebot commented Feb 18, 2025 •

edited

Loading

wpmobilebot commented Feb 21, 2025

Initial changes for saving product images upload statuses in UserDefaults #15196

Are you sure you want to change the base?

Initial changes for saving product images upload statuses in UserDefaults #15196

Conversation

pmusolino commented Feb 18, 2025 • edited Loading

Description

Questions that may arise:

Main changes applied in this PR:

Testing information

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

dangermattic commented Feb 18, 2025 • edited Loading

wpmobilebot commented Feb 18, 2025 • edited Loading

wpmobilebot commented Feb 21, 2025

pmusolino commented Feb 18, 2025 •

edited

Loading

dangermattic commented Feb 18, 2025 •

edited

Loading

wpmobilebot commented Feb 18, 2025 •

edited

Loading