equatable ScreenActionSink

Author: square-tomb

Development.podspec

@@ -73,6 +73,7 @@ Pod::Spec.new do |s|
     test_spec.dependency 'BackStackContainer'
     test_spec.dependency 'ModalContainer'
     test_spec.dependency 'AlertContainer'
+    test_spec.dependency 'WorkflowSwiftUI'
     test_spec.requires_app_host = true
     test_spec.app_host_name = 'Development/SampleTicTacToe'
     test_spec.source_files = 'Samples/TicTacToe/Tests/**/*.swift'

Samples/TicTacToe/Sources/Authentication/LoginScreen.swift

@@ -18,8 +18,8 @@ import SwiftUI
 import Workflow
 import WorkflowSwiftUI
 
-struct LoginScreen: SwiftUIScreen {
-    var actionSink: Sink<LoginWorkflow.Action>
+struct LoginScreen: SwiftUIScreen, Equatable {
+    var actionSink: ScreenActionSink<LoginWorkflow.Action>
     var title: String
     var email: String
     var password: String

Samples/TicTacToe/Sources/Authentication/LoginWorkflow.swift

@@ -73,7 +73,7 @@ extension LoginWorkflow {
 
     func render(state: LoginWorkflow.State, context: RenderContext<LoginWorkflow>) -> Rendering {
         LoginScreen(
-            actionSink: context.makeSink(of: Action.self),
+            actionSink: .init(context.makeSink(of: Action.self)),
             title: "Welcome! Please log in to play TicTacToe!",
             email: state.email,
             password: state.password

Samples/TicTacToe/Tests/AuthenticationWorkflowTests.swift

@@ -183,12 +183,10 @@ class AuthenticationWorkflowTests: XCTestCase {
             .expectWorkflow(
                 type: LoginWorkflow.self,
                 producingRendering: LoginScreen(
+                    actionSink: .noop(),
                     title: "",
                     email: "",
-                    onEmailChanged: { _ in },
-                    password: "",
-                    onPasswordChanged: { _ in },
-                    onLoginTapped: {}
+                    password: ""
                 )
             )
             .render { screen in
@@ -210,12 +208,10 @@ class AuthenticationWorkflowTests: XCTestCase {
             .expectWorkflow(
                 type: LoginWorkflow.self,
                 producingRendering: LoginScreen(
+                    actionSink: .noop(),
                     title: "",
                     email: "",
-                    onEmailChanged: { _ in },
-                    password: "",
-                    onPasswordChanged: { _ in },
-                    onLoginTapped: {}
+                    password: ""
                 )
             )
             .expect(
@@ -244,12 +240,10 @@ class AuthenticationWorkflowTests: XCTestCase {
             .expectWorkflow(
                 type: LoginWorkflow.self,
                 producingRendering: LoginScreen(
+                    actionSink: .noop(),
                     title: "",
                     email: "",
-                    onEmailChanged: { _ in },
-                    password: "",
-                    onPasswordChanged: { _ in },
-                    onLoginTapped: {}
+                    password: ""
                 )
             )
             .expect(
@@ -275,12 +269,10 @@ class AuthenticationWorkflowTests: XCTestCase {
             .expectWorkflow(
                 type: LoginWorkflow.self,
                 producingRendering: LoginScreen(
+                    actionSink: .noop(),
                     title: "",
                     email: "",
-                    onEmailChanged: { _ in },
-                    password: "",
-                    onPasswordChanged: { _ in },
-                    onLoginTapped: {}
+                    password: ""
                 )
             )
             .render { screen in

WorkflowSwiftUI/Sources/ScreenActionSink.swift

@@ -0,0 +1,38 @@
+/*
+ * Copyright 2023 Square Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import Workflow
+
+public struct ScreenActionSink<Value>: Equatable {
+    private let sink: Sink<Value>
+
+    // TODO: Only allow this to be initialized by `WorkflowNode.SubtreeManager.Context`?
+    public init(_ sink: Sink<Value>) {
+        self.sink = sink
+    }
+
+    public static func noop<T>() -> ScreenActionSink<T> {
+        ScreenActionSink<T>(Sink { _ in })
+    }
+
+    public func send(_ value: Value) {
+        sink.send(value)
+    }
+
+    public static func == (lhs: ScreenActionSink<Value>, rhs: ScreenActionSink<Value>) -> Bool {
+        true
+    }
+}

WorkflowSwiftUI/Sources/SwiftUIScreen.swift

@@ -27,7 +27,7 @@ public protocol SwiftUIScreen: Screen {
     @ViewBuilder
     static func makeView(model: ObservableValue<Self>) -> Content
 
-    var actionSink: Sink<Action> { get }
+    var actionSink: ScreenActionSink<Action> { get }
 
     static var isDuplicate: ((Self, Self) -> Bool)? { get }
 }