Merge branch 'main' of github.com:square/workflow-swift into tomb/swiftui-testbed

* 'main' of github.com:square/workflow-swift:
  Add WorkflowSwiftUIExperimental  (#252)
  Add convenience method for library definitions to reduce boilerplate (#251)
  [release]: bump to version 3.4.0 (#250)
  RxSwift 6.6 (#212)
  Expose 'screen' on WorkflowHostingController (#246)
  [fix]: address some RenderTester limitations with optionals (#245)
  Resolved Swift 5.9 compilation warning related to UnsafeRawPointer object conversion (#243)
  Bump activesupport from 6.1.7.3 to 6.1.7.6 (#242)

Author: square-tomb

Development.podspec

@@ -17,6 +17,7 @@ Pod::Spec.new do |s|
   s.dependency 'WorkflowRxSwift'
   s.dependency 'WorkflowCombine'
   s.dependency 'WorkflowConcurrency'
+  s.dependency 'WorkflowSwiftUIExperimental'
   s.dependency 'ViewEnvironment'
   s.dependency 'ViewEnvironmentUI'
 

Gemfile.lock

@@ -3,7 +3,7 @@ GEM
   specs:
     CFPropertyList (3.0.5)
       rexml
-    activesupport (6.1.7.3)
+    activesupport (6.1.7.6)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -66,10 +66,10 @@ GEM
     fuzzy_match (2.0.4)
     gh_inspector (1.1.3)
     httpclient (2.8.3)
-    i18n (1.12.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     json (2.6.1)
-    minitest (5.18.0)
+    minitest (5.19.0)
     molinillo (0.8.0)
     nanaimo (0.3.0)
     nap (1.1.0)
@@ -88,7 +88,7 @@ GEM
       colored2 (~> 3.1)
       nanaimo (~> 0.3.0)
       rexml (~> 3.2.4)
-    zeitwerk (2.6.7)
+    zeitwerk (2.6.11)
 
 PLATFORMS
   ruby

Package.swift

@@ -12,87 +12,45 @@ let package = Package(
     products: [
         // MARK: Workflow
 
-        .library(
-            name: "Workflow",
-            targets: ["Workflow"]
-        ),
-        .library(
-            name: "WorkflowTesting",
-            targets: ["WorkflowTesting"]
-        ),
+        .singleTargetLibrary("Workflow"),
+        .singleTargetLibrary("WorkflowTesting"),
 
         // MARK: WorkflowUI
 
-        .library(
-            name: "WorkflowUI",
-            targets: ["WorkflowUI"]
-        ),
-        .library(
-            name: "WorkflowSwiftUI",
-            targets: ["WorkflowSwiftUI"]
-        ),
+        .singleTargetLibrary("WorkflowUI"),
+        .singleTargetLibrary("WorkflowSwiftUI"),
 
         // MARK: WorkflowReactiveSwift
 
-        .library(
-            name: "WorkflowReactiveSwift",
-            targets: ["WorkflowReactiveSwift"]
-        ),
-        .library(
-            name: "WorkflowReactiveSwiftTesting",
-            targets: ["WorkflowReactiveSwiftTesting"]
-        ),
+        .singleTargetLibrary("WorkflowReactiveSwift"),
+        .singleTargetLibrary("WorkflowReactiveSwiftTesting"),
 
         // MARK: WorkflowRxSwift
 
-        .library(
-            name: "WorkflowRxSwift",
-            targets: ["WorkflowRxSwift"]
-        ),
-        .library(
-            name: "WorkflowRxSwiftTesting",
-            targets: ["WorkflowRxSwiftTesting"]
-        ),
+        .singleTargetLibrary("WorkflowRxSwift"),
+        .singleTargetLibrary("WorkflowRxSwiftTesting"),
 
         // MARK: WorkflowCombine
 
-        .library(
-            name: "WorkflowCombine",
-            targets: ["WorkflowCombine"]
-        ),
-        .library(
-            name: "WorkflowCombineTesting",
-            targets: ["WorkflowCombineTesting"]
-        ),
+        .singleTargetLibrary("WorkflowCombine"),
+        .singleTargetLibrary("WorkflowCombineTesting"),
 
         // MARK: WorkflowConcurrency
 
-        .library(
-            name: "WorkflowConcurrency",
-            targets: ["WorkflowConcurrency"]
-        ),
-        .library(
-            name: "WorkflowConcurrencyTesting",
-            targets: ["WorkflowConcurrencyTesting"]
-        ),
+        .singleTargetLibrary("WorkflowConcurrency"),
+        .singleTargetLibrary("WorkflowConcurrencyTesting"),
 
         // MARK: ViewEnvironment
 
-        .library(
-            name: "ViewEnvironment",
-            targets: ["ViewEnvironment"]
-        ),
+        .singleTargetLibrary("ViewEnvironment"),
 
         // MARK: ViewEnvironmentUI
 
-        .library(
-            name: "ViewEnvironmentUI",
-            targets: ["ViewEnvironmentUI"]
-        ),
+        .singleTargetLibrary("ViewEnvironmentUI"),
     ],
     dependencies: [
         .package(url: "https://github.com/ReactiveCocoa/ReactiveSwift.git", from: "7.1.1"),
-        .package(url: "https://github.com/ReactiveX/RxSwift.git", from: "6.2.0"),
+        .package(url: "https://github.com/ReactiveX/RxSwift.git", from: "6.6.0"),
         .package(url: "https://github.com/nicklockwood/SwiftFormat", exact: "0.44.14"),
     ],
     targets: [
@@ -246,3 +204,13 @@ let package = Package(
     ],
     swiftLanguageVersions: [.v5]
 )
+
+// MARK: Helpers
+
+extension PackageDescription.Product {
+    static func singleTargetLibrary(
+        _ name: String
+    ) -> PackageDescription.Product {
+        .library(name: name, targets: [name])
+    }
+}

ViewEnvironmentUI/Sources/ViewEnvironmentPropagating.swift

@@ -401,11 +401,11 @@ public final class ViewEnvironmentUpdateObservationLifetime {
 }
 
 private enum ViewEnvironmentPropagatingNSObjectAssociatedKeys {
-    static var needsEnvironmentUpdate = NSObject()
-    static var needsUpdateObservers = NSObject()
-    static var ancestorOverride = NSObject()
-    static var descendantsOverride = NSObject()
-    static var customizations = NSObject()
+    static var needsEnvironmentUpdate: UInt8 = 0
+    static var needsUpdateObservers: UInt8 = 0
+    static var ancestorOverride: UInt8 = 0
+    static var descendantsOverride: UInt8 = 0
+    static var customizations: UInt8 = 0
 }
 
 extension ViewEnvironmentPropagating {

WorkflowReactiveSwift.podspec

@@ -20,10 +20,14 @@ Pod::Spec.new do |s|
 
   s.dependency 'Workflow', "#{s.version}"
 
+  s.pod_target_xcconfig = { 'APPLICATION_EXTENSION_API_ONLY' => 'YES' }
+
   s.test_spec 'Tests' do |test_spec|
     test_spec.source_files = 'WorkflowReactiveSwift/Tests/**/*.swift'
     test_spec.framework = 'XCTest'
     test_spec.library = 'swiftos'
     test_spec.dependency 'WorkflowTesting', "#{s.version}"
+
+    test_spec.pod_target_xcconfig = { 'APPLICATION_EXTENSION_API_ONLY' => 'NO' }
   end
 end

WorkflowReactiveSwift/Testing/SignalProducerWorkflowTesting.swift

@@ -21,43 +21,27 @@ import XCTest
 @testable import WorkflowReactiveSwift
 
 extension RenderTester {
-    /// Expect a `SignalProducer`.
+    /// Expect a `SignalProducer` with an optional output.
     ///
     /// `SignalProducerWorkflow` is used to subscribe to `SignalProducer`s and `Signal`s.
     ///
     ///  ⚠️ N.B. If you are testing a case in which multiple `SignalProducerWorkflow`s are expected, **only one of them** may have a non-nil `producingOutput` parameter.
     ///
     /// - Parameters:
+    ///   - outputType: The `OutputType` of the expected `SignalProducerWorkflow`. Typically this will be correctly inferred by the type system, but may need to be explicitly specified if particular optionality is desired.
     ///   - producingOutput: An output that should be returned when this worker is requested, if any.
     ///   - key: Key to expect this `Workflow` to be rendered with.
     public func expectSignalProducer<OutputType>(
-        producingOutput output: OutputType? = nil,
-        key: String = "",
-        file: StaticString = #file, line: UInt = #line
-    ) -> RenderTester<WorkflowType> {
-        expectWorkflow(
-            type: SignalProducerWorkflow<OutputType>.self,
-            key: key,
-            producingRendering: (),
-            producingOutput: output,
-            assertions: { _ in }
-        )
-    }
-
-    /// Expect a `SignalProducer` with the specified `outputType` that produces no `Output`.
-    ///
-    /// - Parameters:
-    ///   - outputType: The `OutputType` of the expected `SignalProducerWorkflow`.
-    ///   - key: Key to expect this `Workflow` to be rendered with.
-    public func expectSignalProducer<OutputType>(
-        outputType: OutputType.Type,
+        outputType: OutputType.Type = OutputType.self,
+        producingOutput: OutputType? = nil,
         key: String = "",
         file: StaticString = #file, line: UInt = #line
     ) -> RenderTester<WorkflowType> {
         expectWorkflow(
             type: SignalProducerWorkflow<OutputType>.self,
             key: key,
             producingRendering: (),
+            producingOutput: producingOutput,
             assertions: { _ in }
         )
     }

WorkflowReactiveSwift/TestingTests/SignalProducerTests.swift

@@ -50,6 +50,16 @@ class SignalProducerTests: XCTestCase {
             .render {}
     }
 
+    func test_signalProducerWorkflow_optionalOutput() {
+        OptionalOutputWorkflow()
+            .renderTester()
+            .expectSignalProducer(
+                outputType: Int?.self, // comment this out & test fails
+                producingOutput: nil as Int?
+            )
+            .render {}
+    }
+
     private struct TestWorkflow: Workflow {
         typealias State = Void
         typealias Rendering = Void
@@ -64,4 +74,16 @@ class SignalProducerTests: XCTestCase {
             }
         }
     }
+
+    private struct OptionalOutputWorkflow: Workflow {
+        typealias State = Void
+        typealias Rendering = Void
+        typealias Output = Int?
+
+        func render(state: State, context: RenderContext<Self>) -> Rendering {
+            SignalProducer(value: Int?.some(1))
+                .mapOutput { _ in AnyWorkflowAction<Self>.noAction }
+                .rendered(in: context)
+        }
+    }
 }

WorkflowRxSwift.podspec

@@ -19,16 +19,17 @@ Pod::Spec.new do |s|
     s.source_files = 'WorkflowRxSwift/Sources/**/*.swift'
 
     s.dependency 'Workflow', "#{s.version}"
-    s.dependency 'RxSwift', '~> 6.2'
+    s.dependency 'RxSwift', '~> 6.6'
 
-    # https://github.com/ReactiveX/RxSwift/pull/2475
-    # s.pod_target_xcconfig = { 'APPLICATION_EXTENSION_API_ONLY' => 'YES' }
+    s.pod_target_xcconfig = { 'APPLICATION_EXTENSION_API_ONLY' => 'YES' }
 
     s.test_spec 'Tests' do |test_spec|
         test_spec.source_files = 'WorkflowRxSwift/Tests/**/*.swift'
         test_spec.framework = 'XCTest'
         test_spec.library = 'swiftos'
         test_spec.dependency 'WorkflowTesting', "#{s.version}"
         test_spec.dependency 'WorkflowReactiveSwift', "#{s.version}"
+
+        test_spec.pod_target_xcconfig = { 'APPLICATION_EXTENSION_API_ONLY' => 'NO' }
     end
 end

WorkflowRxSwift/Testing/ObservableTesting.swift

@@ -24,9 +24,11 @@ extension RenderTester {
     /// Expect the given worker. It will be checked for `isEquivalent(to:)` with the requested worker.
 
     /// - Parameters:
-    ///   - worker: The worker to be expected
-    ///   - output: An output that should be returned when this worker is requested, if any.
+    ///   - outputType: The `OutputType` of the expected `ObservableWorkflow`.
+    ///   - producingOutput: An output that should be returned when this worker is requested, if any.
+    ///   - key: Key to expect this `Workflow` to be rendered with.
     public func expectObservable<OutputType>(
+        outputType: OutputType.Type = OutputType.self,
         producingOutput output: OutputType? = nil,
         key: String = "",
         file: StaticString = #file, line: UInt = #line

WorkflowRxSwift/TestingTests/ObservableTests.swift

@@ -28,7 +28,18 @@ class ObservableTests: XCTestCase {
             .render {}
     }
 
-    struct TestWorkflow: Workflow {
+    func test_observableWorkflow_optionalOutputType() {
+        OptionalOutputWorkflow()
+            .renderTester()
+            .expectObservable(
+                outputType: Int?.self, // comment this out & test fails
+                producingOutput: nil as Int?,
+                key: "123"
+            )
+            .render {}
+    }
+
+    private struct TestWorkflow: Workflow {
         typealias State = Void
         typealias Rendering = Void
 
@@ -38,4 +49,17 @@ class ObservableTests: XCTestCase {
                 .running(in: context, key: "123")
         }
     }
+
+    private struct OptionalOutputWorkflow: Workflow {
+        typealias State = Void
+        typealias Rendering = Void
+        typealias Output = Int?
+
+        func render(state: State, context: RenderContext<Self>) -> Rendering {
+            Observable.from([1])
+                .map { Int?.some($0) }
+                .mapOutput { _ in AnyWorkflowAction<Self>.noAction }
+                .rendered(in: context, key: "123")
+        }
+    }
 }