Support tracking media upload progress in Swift (#717)

* Build multipart-form content

* Implement uploading media in the Swift wrapper

* Fix a compiling issue on Linux

* Fix swiftlint format issues

* Fix a swiftlint issue

* Change upload_media error type to the correct one

* Fix swiftlint issues

* Add request_id parameter to the create media API

* Support tracking media upload progress

* Add a code comment

* Post notifications when tasks are created

* Use `URLSession.uploadTask` to upload media

The progress reporting is much more accurate than using
`URLRequest.httpBodyStream`.

* Fix swiftlint issues

* Fix integration tests

* Add integration tests to the Swift wrapper

* Remove an unused import

* Add integration tests for the Swift wrapper

* Add uploading media to the Example app

* Remove an unnecessary docker-compose option

* Fix swiftlint issues

* Fix a compiling issue in the Kotlin tests

* Simplify propogating URLSessionTask progress updates

* Fix dir permission issue in Swift integration tests

* PR Suggestions (#732)

1. Allows uploading videos because small files don’t show progress properly
2. Adds `file.startAccessingSecurityScopedResource` for files outside the app sandbox

---------

Co-authored-by: Jeremy Massel <[email protected]>

Author: crazytonyli

.buildkite/commands/run-swift-tests-linux.sh

@@ -0,0 +1,10 @@
+#!/bin/bash -eu
+
+# Give read/write permissions to `./` for all users
+chmod -R a+rw ./
+
+echo "--- :docker: Setting up Test Server"
+make test-server
+
+echo "--- 🧪 Running Swift Tests"
+make test-swift-linux

.buildkite/pipeline.yml

@@ -103,9 +103,7 @@ steps:
         agents:
           queue: mac
       - label: ":swift: :linux: Build and Test"
-        command: |
-          echo "--- :swift: Building + Testing"
-          make test-swift-linux
+        command: ".buildkite/commands/run-swift-tests-linux.sh"
       - label: ":swift: Lint"
         command: |
           .buildkite/download-xcframework.sh

Makefile

@@ -137,10 +137,6 @@ xcframework-package: xcframework-all
 xcframework-package-checksum:
 	swift package compute-checksum libwordpressFFI.xcframework.zip | tee libwordpressFFI.xcframework.zip.checksum.txt
 
-
-docker-image-swift:
-	docker build -t wordpress-rs-swift -f Dockerfile.swift .
-
 docker-image-web:
 	docker build -t wordpress-rs-web -f wp_rs_web/Dockerfile . --progress=plain
 
@@ -162,8 +158,8 @@ swift-example-app-ios:
 test-swift:
 	$(MAKE) test-swift-$(uname)
 
-test-swift-linux: docker-image-swift
-	docker run $(docker_opts_shared) -it wordpress-rs-swift make test-swift-linux-in-docker
+test-swift-linux:
+	docker compose run --rm swift make test-swift-linux-in-docker
 
 test-swift-linux-in-docker: swift-linux-library
 	swift test -Xlinker -Ltarget/release/libwordpressFFI-linux -Xlinker -lwp_api

Package.resolved

@@ -40,6 +40,7 @@ var package = Package(
             path: "native/swift/Sources/wordpress-api",
             swiftSettings: [
                 .enableExperimentalFeature("StrictConcurrency"),
+                .define("PROGRESS_REPORTING_ENABLED", .when(platforms: [.iOS, .macOS, .tvOS, .watchOS]))
             ]
         ),
         .target(
@@ -63,9 +64,12 @@ var package = Package(
                 .target(name: libwordpressFFI.name)
             ],
             path: "native/swift/Tests/wordpress-api",
-            resources: [.copy("../../../../test-data/integration-test-responses/")]
+            resources: [.copy("../../../../test-data/integration-test-responses/")],
+            swiftSettings: [
+                .define("PROGRESS_REPORTING_ENABLED", .when(platforms: [.iOS, .macOS, .tvOS, .watchOS]))
+            ]
         )
-    ]
+    ].addingIntegrationTests()
 )
 
 // MARK: - Enable local development toolings
@@ -121,3 +125,34 @@ func enableSwiftLint() throws {
     package.dependencies.append(.package(url: "https://github.com/realm/SwiftLint", exact: .init(version)!))
 #endif
 }
+
+extension Array where Element == Target {
+
+    // Run `make test-server` before running integration tests.
+    func addingIntegrationTests() -> Self {
+        var enabled = false
+
+        if Context.environment["BUILDKITE"] != nil {
+            // When running on CI, only enable integration tests on Linux, since macOS CI agent does not have docker.
+            #if os(Linux)
+            enabled = true
+            #endif
+        } else {
+            // Enable integration tests during local development, since we can easily install docker env on our macOS.
+            enabled = true
+        }
+
+        if enabled {
+            return self + [.testTarget(
+                name: "IntegrationTests",
+                dependencies: [
+                    .target(name: "WordPressAPI"),
+                ],
+                path: "native/swift/Tests/integration-tests",
+                resources: [.copy("../../../../test-data/")]
+            )]
+        } else {
+            return self
+        }
+    }
+}

Package.swift

@@ -28,6 +28,17 @@ services:
             timeout: 1s
             retries: 30
 
+    swift:
+        build:
+            context: .
+            dockerfile: swift.Dockerfile
+        volumes:
+            - ./:/app
+        working_dir: /app
+        environment:
+            - TEST_ALL_PLUGINS
+            - CARGO_HOME=/app/.cargo
+
     database:
         image: 'public.ecr.aws/docker/library/mariadb:11.2'
         ports:

docker-compose.yml

@@ -67,7 +67,8 @@ class MediaEndpointTest {
             requestBuilder.media().create(
                 params = MediaCreateParams(title = title),
                 "test_media.jpg",
-                "image/jpeg"
+                "image/jpeg",
+                null
             )
         }.assertSuccessAndRetrieveData().data
         assertEquals(title, response.title.rendered)

native/kotlin/api/kotlin/src/integrationTest/kotlin/MediaEndpointTest.kt

@@ -20,6 +20,7 @@
 		24A3C32F2BA8F96F00162AD1 /* LoginView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 24A3C32E2BA8F96F00162AD1 /* LoginView.swift */; };
 		24A3C3362BAA874C00162AD1 /* LoginManager.swift in Sources */ = {isa = PBXBuildFile; fileRef = 24A3C3352BAA874C00162AD1 /* LoginManager.swift */; };
 		24E77D032CE44DD900F6998C /* WordPressAPI in Frameworks */ = {isa = PBXBuildFile; productRef = 24E77D022CE44DD900F6998C /* WordPressAPI */; };
+		4A0CD45C2DD15C280046FE28 /* UploadView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 4A0CD45B2DD15C280046FE28 /* UploadView.swift */; };
 /* End PBXBuildFile section */
 
 /* Begin PBXFileReference section */
@@ -36,6 +37,7 @@
 		24A3C32E2BA8F96F00162AD1 /* LoginView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = LoginView.swift; sourceTree = "<group>"; };
 		24A3C3342BAA45B800162AD1 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
 		24A3C3352BAA874C00162AD1 /* LoginManager.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = LoginManager.swift; sourceTree = "<group>"; };
+		4A0CD45B2DD15C280046FE28 /* UploadView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = UploadView.swift; sourceTree = "<group>"; };
 /* End PBXFileReference section */
 
 /* Begin PBXFrameworksBuildPhase section */
@@ -59,6 +61,7 @@
 				242D64932C3608C6007CA96C /* ListView.swift */,
 				242D64912C360687007CA96C /* RootListView.swift */,
 				24A3C32E2BA8F96F00162AD1 /* LoginView.swift */,
+				4A0CD45B2DD15C280046FE28 /* UploadView.swift */,
 			);
 			path = UI;
 			sourceTree = "<group>";
@@ -189,6 +192,7 @@
 			isa = PBXSourcesBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
+				4A0CD45C2DD15C280046FE28 /* UploadView.swift in Sources */,
 				242D64922C360687007CA96C /* RootListView.swift in Sources */,
 				2479BF812B621CB60014A01D /* ExampleApp.swift in Sources */,
 				24A3C32F2BA8F96F00162AD1 /* LoginView.swift in Sources */,

native/swift/Example/Example.xcodeproj/project.pbxproj

@@ -12,6 +12,8 @@ struct ExampleApp: App {
     @StateObject
     var loginManager = LoginManager()
 
+    @State var showUploadView = false
+
     let rootListItems = [
         RootListData(name: "Application Passwords", callback: {
             try await WordPressAPI.globalInstance.applicationPasswords.listWithEditContext(userId: 1)
@@ -70,29 +72,36 @@ struct ExampleApp: App {
 
                     // Initial content for the third column.
                     Text("Select a category of settings in the sidebar.")
-                }.toolbar(content: {
-                    #if os(macOS)
-                    ToolbarItem {
+                }
+                .sheet(isPresented: $showUploadView) {
+                    UploadView()
+                }
+                .toolbar(content: {
+                    ToolbarItem(placement: toolbarItemPlacement) {
                         Button("Log Out") {
                             Task {
                                 await loginManager.logout()
                             }
                         }
                     }
-                    #else
-                    ToolbarItem(placement: .bottomBar) {
-                        Button("Log Out") {
-                            Task {
-                                await loginManager.logout()
-                            }
+                    ToolbarItem(placement: toolbarItemPlacement) {
+                        Button("Add Media File") {
+                            showUploadView = true
                         }
                     }
-                    #endif
                 })
             } else {
                 LoginView()
             }
         }
         .environmentObject(loginManager)
     }
+
+    var toolbarItemPlacement: ToolbarItemPlacement {
+        #if os(macOS)
+        .automatic
+        #else
+        .bottomBar
+        #endif
+    }
 }