Shipping Labels: Migrate to the config endpoint for syncing shipping labels in Woo Shipping plugin #15800

itsmeichigo · 2025-06-23T10:18:49Z

Closes WOOMOB-646

Description

This PR wraps up the migration for syncing shipping labels on the Order details screen. Detailed changes:

Updates WooShippingAction and WooShippingStore with a new method to sync shipping labels. This uses the same config endpoint underneath like loadingConfig, but it extracts the purchased shipping labels in the response and persists them in the storage.
Updates the order details screen:
- Checks for the feature flag and whether the store has Woo Shipping extension installed. If yes, use the new syncing method in WooShippingAction. Otherwise, fall back to the legacy method in ShippingLabelAction.
- Sorts the fetched shipping labels by either shipment ID if available or created date. This fixes the issue with the labels jumping in positions after syncing.
- Updates the section title for purchased labels based on shipment IDs if available and fall back to their index otherwise.
- Updates unit tests to confirm logic changes.

Testing steps

TC1: Regression check for a store with the legacy extension

Log in to a test store with the Woo Tax plugin without the Woo Shipping (deactivate it if you have it installed). Use the smoke testing store [P91TBi-bVe-p2] if you don't already have a store that you used to create shipping labels with this extension.
Navigate to an order with physical products.
Confirm that the legacy endpoint GET wc/v1/connect/label is triggered.
Create a shipping label for the order - ensure to split items into multiple packages.
Navigate back to the order details and confirm that purchased labels are displayed with package indices in ASC orders.
Navigate back and forth from the order details screen and confirm that the position of the purchased label sections is not changed.

TC2: Testing store with Woo Shipping

Log in to a test store with the Woo Shipping plugin set up.
Navigate to a paid order with physical products.
Confirm that the new endpoint GET wcshipping/v1/config/label-purchase is triggered.
Select Create shipping label button and proceed to split items into multiple shipments and purchase labels for all of them.
Navigate back to the order details and confirm that purchased labels are displayed with package indices in ASC orders.
Select View purchased label and confirm that the correct shipment is displayed. The index of the shipment should match the selected package's.
Navigate back and forth from the order details screen and confirm that the position of the purchased label sections is not changed.

TC3: With feature flag disabled.

Disable the feature flag revampedShippingLabelCreation and rebuild the app.
Log in to the same store and select the same order in TC2.
Confirm that the legacy endpoint GET wc/v1/connect/label is triggered.
Confirm that purchased labels are displayed with package indices in ASC orders.
Navigate back and forth from the order details screen and confirm that the position of the purchased label sections is not changed.

Testing information

Tested and confirm the changes with simulator iPhone 16 iOS 18.4.

Screenshots

Simulator.Screen.Recording.-.iPhone.16.-.2025-06-24.at.13.36.38.mp4

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

… config endpoint

…oomob-646-migrate-to-config-endpoint-order-details

…oller

wpmobilebot · 2025-06-23T10:28:01Z

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

	App Name	WooCommerce iOS Prototype
	Build Number	`30708`
	Version	`PR #15800`
	Bundle ID	`com.automattic.alpha.woocommerce`
	Commit	`5301b3f`
	Installation URL	1c20p05cmcnc0

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

…-details

RafaelKayumov

Left a few non blocking comments.

RafaelKayumov · 2025-06-24T21:49:40Z

Modules/Sources/Yosemite/Stores/WooShippingStore.swift

+                                          orderID: Int64,
+                                          shippingLabels: [ShippingLabel],
+                                          onCompletion: @escaping () -> Void) {
+        guard shippingLabels.isEmpty == false else {


Super NIT: I'd replace the double negation by:

if shippingLabels.isEmpty { return onCompletion() }

Done in 820fb02.

RafaelKayumov · 2025-06-24T21:52:03Z

Modules/Sources/Yosemite/Stores/WooShippingStore.swift

+                              shippingLabels: [ShippingLabel],
+                              storageOrder: StorageOrder,
+                              using storage: StorageType) {
+


NIt: extra line

Removed in 820fb02.

RafaelKayumov · 2025-06-24T21:59:09Z

Modules/Sources/Yosemite/Stores/WooShippingStore.swift

+        }
+    }
+
+    func update(shippingLabel storageShippingLabel: StorageShippingLabel, withRefund refund: ShippingLabelRefund?, using storage: StorageType) {


Duplicate as well

Updated in 820fb02.

RafaelKayumov · 2025-06-24T22:25:30Z

WooCommerce/Classes/ViewModels/Order Details/OrderDetailsViewModel.swift

+    @MainActor func syncShippingLabelsForWooShipping() async -> [ShippingLabel] {
+        await withCheckedContinuation { continuation in
+            stores.dispatch(WooShippingAction.syncShippingLabels(siteID: order.siteID, orderID: order.orderID) { result in
+                switch result {
+                case .success(let shippingLabels):
+                    ServiceLocator.analytics.track(event: .shippingLabelsAPIRequest(
+                        result: .success,
+                        isRevampedFlow: true
+                    ))
+                    continuation.resume(returning: shippingLabels)
+                case .failure(let error):
+                    ServiceLocator.analytics.track(event: .shippingLabelsAPIRequest(
+                        result: .failed(error: error),
+                        isRevampedFlow: true
+                    ))
+                    if error as? DotcomError == .noRestRoute {
+                        DDLogError("⚠️ Endpoint for synchronizing shipping labels is unreachable. WC Shipping plugin may be missing.")
+                    } else {
+                        DDLogError("⛔️ Error synchronizing shipping labels: \(error)")
+                    }
+                    continuation.resume(returning: [])
+                }
+            })
+        }
+    }
+
+    @MainActor func syncShippingLabelsForLegacyPlugin(isRevampedFlow: Bool) async -> [ShippingLabel] {
+        await withCheckedContinuation { continuation in
+            stores.dispatch(ShippingLabelAction.synchronizeShippingLabels(siteID: order.siteID, orderID: order.orderID) { result in
+                switch result {
+                case .success(let shippingLabels):
+                    ServiceLocator.analytics.track(event: .shippingLabelsAPIRequest(
+                        result: .success,
+                        isRevampedFlow: isRevampedFlow
+                    ))
+                    continuation.resume(returning: shippingLabels)
+                case .failure(let error):
+                    ServiceLocator.analytics.track(event: .shippingLabelsAPIRequest(
+                        result: .failed(error: error),
+                        isRevampedFlow: isRevampedFlow
+                    ))
+                    if error as? DotcomError == .noRestRoute {
+                        DDLogError("⚠️ Endpoint for synchronizing shipping labels is unreachable. WC Shipping plugin may be missing.")
+                    } else {
+                        DDLogError("⛔️ Error synchronizing shipping labels: \(error)")
+                    }
+                    continuation.resume(returning: [])
+                }
+            })
+        }
+    }


The completion closure for ShippingLabelAction and WooShippingAction looks the same (despite isRevampedFlow value, but I think it can be passed as attribute for both cases). I'd consider extracting and making it reusable.

Updated in 370fcbe.

RafaelKayumov · 2025-06-24T22:31:49Z

WooCommerce/Classes/ViewModels/Order Details/OrderDetailsDataSource.swift

+                let title = {
+                    guard let shipmentID = shippingLabel.shipmentID,
+                          let intID = Int(shipmentID) else {
+                        return String.localizedStringWithFormat(Title.shippingLabelPackageFormat, index + 1)
+                    }
+                    return String.localizedStringWithFormat(Title.shippingLabelPackageFormat, intID + 1)
+                }()


I'd also add a unit test to make sure that if a shippingLabel contains proper shipmentID then shippingLabelSections have proper titles as well.

Added test in 5301b3f.

RafaelKayumov · 2025-06-24T22:32:27Z

WooCommerce/Classes/ViewModels/Order Details/OrderDetailsResultsControllers.swift

+        order.shippingLabels.sorted(by: { label1, label2 in
+            if let shipmentID1 = label1.shipmentID,
+               let shipmentID2 = label2.shipmentID {
+                return shipmentID1.localizedStandardCompare(shipmentID2) == .orderedAscending
+            }
+            return label1.dateCreated < label2.dateCreated
+        })


I'd add a unit test to make sure that shippingLabels are sorted basing on shipmentID values

The test added in 5301b3f should cover this already.

itsmeichigo added 6 commits June 23, 2025 15:32

Update WooShippingAction and store to support syncing labels with the…

50edc68

… config endpoint

Use config endpoint for syncing labels

b057e2f

Sort shipments by either IDs or dateCreated

f0e01e9

Merge branch 'woomob-646-parse-shipmentID-for-shipping-labels' into w…

6434d42

…oomob-646-migrate-to-config-endpoint-order-details

Sort and display shipments by shipment ID if possible

cc6d6e8

Keep shippingLabels computed variable for order details results contr…

4900039

…oller

itsmeichigo added this to the 22.7 milestone Jun 23, 2025

itsmeichigo added type: task An internally driven task. feature: shipping labels Related to creating, ordering, or printing shipping labels. labels Jun 23, 2025

Restore feature flag check

2a9c335

Base automatically changed from woomob-646-parse-shipmentID-for-shipping-labels to trunk June 24, 2025 02:53

itsmeichigo added 4 commits June 24, 2025 10:16

Merge branch 'trunk' into woomob-646-migrate-to-config-endpoint-order…

b9ef21a

…-details

Update syncShippingLabels logic and add unit tests

c978671

Revert unintended changes

1ef3896

Update release notes

d4ea0b7

itsmeichigo marked this pull request as ready for review June 24, 2025 06:41

itsmeichigo requested a review from RafaelKayumov June 24, 2025 06:41

RafaelKayumov approved these changes Jun 24, 2025

View reviewed changes

itsmeichigo added 3 commits June 25, 2025 12:33

Address nit picking comments

820fb02

Reduce code duplication for syncing shipping labels

370fcbe

Add test for shipping label sections

5301b3f

itsmeichigo merged commit 895f41e into trunk Jun 25, 2025
13 checks passed

itsmeichigo deleted the woomob-646-migrate-to-config-endpoint-order-details branch June 25, 2025 07:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Shipping Labels: Migrate to the config endpoint for syncing shipping labels in Woo Shipping plugin #15800

Shipping Labels: Migrate to the config endpoint for syncing shipping labels in Woo Shipping plugin #15800

Uh oh!

itsmeichigo commented Jun 23, 2025 •

edited

Loading

Uh oh!

wpmobilebot commented Jun 23, 2025 •

edited

Loading

Uh oh!

RafaelKayumov left a comment

Uh oh!

RafaelKayumov Jun 24, 2025

Uh oh!

itsmeichigo Jun 25, 2025

Uh oh!

RafaelKayumov Jun 24, 2025

Uh oh!

itsmeichigo Jun 25, 2025

Uh oh!

RafaelKayumov Jun 24, 2025

Uh oh!

itsmeichigo Jun 25, 2025

Uh oh!

RafaelKayumov Jun 24, 2025

Uh oh!

itsmeichigo Jun 25, 2025

Uh oh!

RafaelKayumov Jun 24, 2025

Uh oh!

itsmeichigo Jun 25, 2025

Uh oh!

RafaelKayumov Jun 24, 2025

Uh oh!

itsmeichigo Jun 25, 2025

Uh oh!

Uh oh!

Uh oh!

Shipping Labels: Migrate to the config endpoint for syncing shipping labels in Woo Shipping plugin #15800

Shipping Labels: Migrate to the config endpoint for syncing shipping labels in Woo Shipping plugin #15800

Uh oh!

Conversation

itsmeichigo commented Jun 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Testing steps

TC1: Regression check for a store with the legacy extension

TC2: Testing store with Woo Shipping

TC3: With feature flag disabled.

Testing information

Screenshots

Uh oh!

wpmobilebot commented Jun 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

RafaelKayumov left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

itsmeichigo commented Jun 23, 2025 •

edited

Loading

wpmobilebot commented Jun 23, 2025 •

edited

Loading