Add cancellation support to the Swift wrapper

.buildkite/download-xcframework.sh

@@ -4,7 +4,6 @@ set -euo pipefail
 
 echo "--- :arrow_down: Downloading xcframework"
 buildkite-agent artifact download target/libwordpressFFI.xcframework.zip . --step "xcframework"
-buildkite-agent artifact download native/swift/Sources/wordpress-api-wrapper/wp_api.swift . --step "xcframework"
-buildkite-agent artifact download native/swift/Sources/wordpress-api-wrapper/wp_localization.swift . --step "xcframework"
+buildkite-agent artifact download 'native/swift/Sources/wordpress-api-wrapper/*.swift' . --step "xcframework"
 unzip target/libwordpressFFI.xcframework.zip -d .
 rm target/libwordpressFFI.xcframework.zip

.buildkite/pipeline.yml

@@ -74,10 +74,7 @@ steps:
           zip -r target/libwordpressFFI.xcframework.zip target/libwordpressFFI.xcframework
         artifact_paths:
           - target/libwordpressFFI.xcframework.zip
-          - native/swift/Sources/wordpress-api-wrapper/wp_api.swift
-          - native/swift/Sources/wordpress-api-wrapper/wp_localization.swift
-          - native/swift/Sources/wordpress-api-wrapper/wp_com.swift
-          - native/swift/Sources/wordpress-api-wrapper/jetpack.swift
+          - native/swift/Sources/wordpress-api-wrapper/*.swift
         agents:
           queue: mac
       - label: ":swift: Build Docs"

.swiftlint.yml

@@ -3,10 +3,8 @@ strict: true
 included:
   - native/swift
 excluded: # paths to ignore during linting. Takes precedence over `included`.
-  - native/swift/Sources/wordpress-api-wrapper/wp_api.swift # auto-generated code
-  - native/swift/Sources/wordpress-api-wrapper/wp_localization.swift # auto-generated code
-  - native/swift/Sources/wordpress-api-wrapper/wp_com.swift # auto-generated code
-  - native/swift/Sources/wordpress-api-wrapper/jetpack.swift # auto-generated code
+  - native/swift/Sources/wordpress-api-wrapper # auto-generated code
+  - native/swift/**/.build
 disabled_rules:
   # Don't think we should enable this rule.
   # See https://github.com/realm/SwiftLint/issues/5263 for context.
@@ -19,4 +17,3 @@ disabled_rules:
   - file_length
   - function_body_length
   - type_body_length
-

Makefile

@@ -102,7 +102,7 @@ _build-apple-%-tvos _build-apple-%-tvos-sim _build-apple-%-watchos _build-apple-
 
 # Build the library for a specific target
 _build-apple-%:
-	cargo $(CARGO_OPTS) $(cargo_config_library) build --target $* --package wp_api --profile $(CARGO_PROFILE)
+	cargo $(CARGO_OPTS) $(cargo_config_library) build --target $* --features export-uncancellable-endpoints --package wp_api --profile $(CARGO_PROFILE)
 	./scripts/swift-bindings.sh target/$*/$(CARGO_PROFILE_DIRNAME)/libwp_api.a
 
 # Build the library for one single platform, including real device and simulator.
@@ -141,7 +141,7 @@ docker-image-web:
 	docker build -t wordpress-rs-web -f wp_rs_web/Dockerfile . --progress=plain
 
 swift-linux-library:
-	cargo build --release --package wp_api
+	cargo build --release --features export-uncancellable-endpoints --package wp_api
 	./scripts/swift-bindings.sh target/release/libwp_api.a
 	mkdir -p target/release/libwordpressFFI-linux
 	cp target/release/swift-bindings/Headers/* target/release/libwordpressFFI-linux/
@@ -272,7 +272,7 @@ validate-localizations:
 	@# Help: Validate localization files using `wp_localization_validation` crate
 	$(rust_docker_run) /bin/bash -c "cargo run --bin wp_localization_validation -- --localization-folder ./wp_localization/localization/"
 
-format-swift:
+fmt-swift:
 	@# Help: Format the Swift binding code
 	xcrun swift format -i -r native/swift/Sources/wordpress-api-wrapper
 

fastlane/Fastfile

@@ -412,8 +412,7 @@ end
 
 def xcframework_bindings_file_path
   dir = File.join(PROJECT_ROOT, 'native', 'swift', 'Sources', 'wordpress-api-wrapper')
-  %w[wp_api.swift wp_localization.swift]
-    .map { |file| File.join(dir, file) }
+  Dir.glob(File.join(dir, '*.swift'))
 end
 
 def remove_lane_context_values(names)

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

@@ -3,6 +3,7 @@ package rs.wordpress.api.kotlin
 import kotlinx.coroutines.delay
 import okio.FileNotFoundException
 import uniffi.wp_api.MediaUploadRequest
+import uniffi.wp_api.RequestContext
 import uniffi.wp_api.RequestExecutor
 import uniffi.wp_api.WpNetworkHeaderMap
 import uniffi.wp_api.WpNetworkRequest
@@ -47,6 +48,10 @@ class MockRequestExecutor(private var stubs: List<Stub> = listOf()) : RequestExe
     override suspend fun sleep(millis: ULong) {
         delay(millis.toLong())
     }
+
+    override fun cancel(context: RequestContext) {
+        // No-op
+    }
 }
 
 val WpNetworkResponse.Companion.empty: WpNetworkResponse

native/kotlin/api/kotlin/src/main/kotlin/rs/wordpress/api/kotlin/DebugMiddleware.kt

@@ -1,4 +1,5 @@
 package rs.wordpress.api.kotlin
+import uniffi.wp_api.RequestContext
 import uniffi.wp_api.RequestExecutor
 import uniffi.wp_api.WpApiMiddleware
 import uniffi.wp_api.WpNetworkRequest
@@ -9,7 +10,8 @@ class DebugMiddleware : WpApiMiddleware {
     override suspend fun process(
         requestExecutor: RequestExecutor,
         response: WpNetworkResponse,
-        request: WpNetworkRequest
+        request: WpNetworkRequest,
+        context: RequestContext?
     ): WpNetworkResponse {
         println("Request: ${request.url()}")
         println("Response:")

native/kotlin/api/kotlin/src/main/kotlin/rs/wordpress/api/kotlin/WpRequestExecutor.kt

@@ -16,6 +16,7 @@ import okhttp3.RequestBody.Companion.toRequestBody
 import uniffi.wp_api.InvalidSslErrorReason
 import uniffi.wp_api.MediaUploadRequest
 import uniffi.wp_api.MediaUploadRequestExecutionException
+import uniffi.wp_api.RequestContext
 import uniffi.wp_api.RequestExecutionErrorReason
 import uniffi.wp_api.RequestExecutionException
 import uniffi.wp_api.RequestExecutor
@@ -150,6 +151,10 @@ class WpRequestExecutor(
         delay(millis.toLong())
     }
 
+    override fun cancel(context: RequestContext) {
+        // No-op
+    }
+
     private fun File.canBeUploaded() = exists() && isFile && canRead()
 
     /**

native/swift/Example/Example.xcodeproj/xcshareddata/xcschemes/Example.xcscheme

@@ -0,0 +1,78 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Scheme
+   LastUpgradeVersion = "1620"
+   version = "1.7">
+   <BuildAction
+      parallelizeBuildables = "YES"
+      buildImplicitDependencies = "YES"
+      buildArchitectures = "Automatic">
+      <BuildActionEntries>
+         <BuildActionEntry
+            buildForTesting = "YES"
+            buildForRunning = "YES"
+            buildForProfiling = "YES"
+            buildForArchiving = "YES"
+            buildForAnalyzing = "YES">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "2479BF7C2B621CB60014A01D"
+               BuildableName = "Example.app"
+               BlueprintName = "Example"
+               ReferencedContainer = "container:Example.xcodeproj">
+            </BuildableReference>
+         </BuildActionEntry>
+      </BuildActionEntries>
+   </BuildAction>
+   <TestAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      shouldAutocreateTestPlan = "YES">
+   </TestAction>
+   <LaunchAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      launchStyle = "0"
+      useCustomWorkingDirectory = "NO"
+      ignoresPersistentStateOnLaunch = "NO"
+      debugDocumentVersioning = "YES"
+      debugServiceExtension = "internal"
+      allowLocationSimulation = "YES">
+      <BuildableProductRunnable
+         runnableDebuggingMode = "0">
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "2479BF7C2B621CB60014A01D"
+            BuildableName = "Example.app"
+            BlueprintName = "Example"
+            ReferencedContainer = "container:Example.xcodeproj">
+         </BuildableReference>
+      </BuildableProductRunnable>
+   </LaunchAction>
+   <ProfileAction
+      buildConfiguration = "Release"
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      savedToolIdentifier = ""
+      useCustomWorkingDirectory = "NO"
+      debugDocumentVersioning = "YES">
+      <BuildableProductRunnable
+         runnableDebuggingMode = "0">
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "2479BF7C2B621CB60014A01D"
+            BuildableName = "Example.app"
+            BlueprintName = "Example"
+            ReferencedContainer = "container:Example.xcodeproj">
+         </BuildableReference>
+      </BuildableProductRunnable>
+   </ProfileAction>
+   <AnalyzeAction
+      buildConfiguration = "Debug">
+   </AnalyzeAction>
+   <ArchiveAction
+      buildConfiguration = "Release"
+      revealArchiveInOrganizer = "YES">
+   </ArchiveAction>
+</Scheme>

native/swift/Sources/wordpress-api/Middleware.swift

@@ -4,7 +4,8 @@ public final class DebugMiddleware: WpApiMiddleware {
     public func process(
         requestExecutor: any WordPressAPIInternal.RequestExecutor,
         response: WordPressAPIInternal.WpNetworkResponse,
-        request: WordPressAPIInternal.WpNetworkRequest
+        request: WordPressAPIInternal.WpNetworkRequest,
+        context: RequestContext?
     ) async throws -> WordPressAPIInternal.WpNetworkResponse {
         debugPrint("Performed request: \(String(describing: try? request.buildURLRequest(additionalHeaders: [:])))")
         debugPrint("Received response: \(response)")

native/swift/Sources/wordpress-api/SafeRequestExecutor.swift

@@ -75,6 +75,14 @@ public final class WpRequestExecutor: SafeRequestExecutor {
             }
     }
 
+    public func cancel(context: RequestContext) {
+        for requestId in context.requestIds() {
+            Task {
+                await self.cancelRequest(withId: requestId)
+            }
+        }
+    }
+
     func perform(_ request: NetworkRequestContent) async -> Result<WpNetworkResponse, RequestExecutionError> {
         do {
             let (data, response) = try await request.perform(
@@ -131,6 +139,26 @@ public final class WpRequestExecutor: SafeRequestExecutor {
     }
 #endif
 
+    private func cancelRequest(withId requestId: String) async {
+#if canImport(Combine)
+        var task = (await self.session.allTasks).first {
+            $0.originalRequest?.requestId == requestId
+        }
+
+        if task == nil {
+            task = await NotificationCenter.default
+                .publisher(for: RequestExecutorDelegate.didCreateTaskNotification)
+                .compactMap { $0.object as? URLSessionTask }
+                .first { $0.originalRequest?.requestId == requestId }
+                .timeout(.seconds(1), scheduler: DispatchQueue.global())
+                .values
+                .first { _ in true }
+        }
+
+        task?.cancel()
+#endif
+    }
+
     private func handleHttpsError(
         _ error: Error,
         for request: NetworkRequestContent

native/swift/Sources/wordpress-api/WordPressAPI.swift

@@ -20,7 +20,7 @@ public actor WordPressAPI {
     }
 
     private let apiUrlResolver: ApiUrlResolver
-    private let requestExecutor: SafeRequestExecutor
+    let requestExecutor: SafeRequestExecutor
     private let apiClientDelegate: WpApiClientDelegate
     package let requestBuilder: UniffiWpApiClient
 

native/swift/Tests/integration-tests/CancellationTests.swift

@@ -0,0 +1,37 @@
+import Foundation
+import Testing
+
+@testable import WordPressAPI
+@testable import WordPressAPIInternal
+
+#if os(macOS)
+
+struct CancellationTests {
+    let api = WordPressAPI.admin()
+
+    @Test
+    func cancelUploadingLongPost() async throws {
+        let file = try #require(Bundle.module.url(forResource: "test-data/test_media.jpg", withExtension: nil))
+        let content = try String(data: Data(contentsOf: file).base64EncodedData(), encoding: .utf8)!
+
+        let title = UUID().uuidString
+        await #expect(
+            throws: WpApiError.RequestExecutionFailed(statusCode: nil, redirects: nil, reason: .cancellationError),
+            performing: {
+                let task = Task {
+                    _ = try await api.posts.create(params: .init(title: title, content: content, meta: nil))
+                    Issue.record("The creating post function should throw")
+                }
+
+                try await Task.sleep(for: .milliseconds(10))
+                task.cancel()
+
+                try await task.value
+            }
+        )
+
+        try await restoreTestServer()
+    }
+}
+
+#endif

native/swift/Tests/integration-tests/MediaTests.swift

@@ -1,5 +1,5 @@
 import Foundation
-import WordPressAPI
+@testable import WordPressAPI
 import Testing
 
 @Suite
@@ -55,6 +55,7 @@ struct MediaTests {
                         fromLocalFileURL: file,
                         fulfilling: progress
                     )
+                    Issue.record("The creating post function should throw")
                 }
 
                 let cancellable = progress.publisher(for: \.fractionCompleted).first { $0 > 0 }.sink { _ in
@@ -83,6 +84,7 @@ struct MediaTests {
                         fromLocalFileURL: file,
                         fulfilling: progress
                     )
+                    Issue.record("The creating post function should throw")
                 }
 
                 let cancellable = progress.publisher(for: \.fractionCompleted).first { $0 > 0 }.sink { _ in

native/swift/Tests/wordpress-api/Support/HTTPStubs.swift

@@ -25,7 +25,9 @@ final class HTTPStubs: SafeRequestExecutor {
         self
     }
 
-    public func execute(_ request: WpNetworkRequest) async -> Result<WpNetworkResponse, RequestExecutionError> {
+    public func execute(
+        _ request: WpNetworkRequest
+    ) async -> Result<WpNetworkResponse, RequestExecutionError> {
         if let response = stub(for: request) {
             return .success(response)
         }
@@ -88,6 +90,10 @@ final class HTTPStubs: SafeRequestExecutor {
         // swiftlint:disable:next force_try
         try! await Task.sleep(nanoseconds: millis * 1000)
     }
+
+    func cancel(context: RequestContext) {
+        // No-op
+    }
 }
 
 extension WpNetworkResponse {

native/swift/Tests/wordpress-api/WordPressAPITests.swift

@@ -79,7 +79,8 @@ private actor CounterMiddleware: Middleware {
     func process(
         requestExecutor: RequestExecutor,
         response: WpNetworkResponse,
-        request: WpNetworkRequest
+        request: WpNetworkRequest,
+        context: RequestContext?
     ) async throws -> WpNetworkResponse {
         count += 1
         return response

native/swift/Tools/.gitignore

@@ -0,0 +1,8 @@
+.DS_Store
+/.build
+/Packages
+xcuserdata/
+DerivedData/
+.swiftpm/configuration/registries.json
+.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
+.netrc