Skip to content

feat: Enable use of WorkflowCombineTesting without specifying a concrete Publisher type #387

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
amorde wants to merge 1 commit into
base: main
Choose a base branch
from
+44 −7
Open

feat: Enable use of WorkflowCombineTesting without specifying a concrete Publisher type #387

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions WorkflowCombine/Sources/PublisherWorkflow.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,14 @@ import Combine
import Foundation
import Workflow

struct PublisherWorkflow<WorkflowPublisher: Publisher>: Workflow where WorkflowPublisher.Failure == Never {
typealias Output = WorkflowPublisher.Output
struct PublisherWorkflow<Output>: Workflow {
Copy link
Copy Markdown
Member Author

@amorde amorde Apr 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: This change has the side effect of making this worker only unique against the output of a publisher rather than the concrete publisher type. This can result in two different workers overlapping if they do not specify a key and have the same output type (e.g. Bool).

This is already true for WorkflowReactiveSwift but is a new change for WorkflowCombine

typealias State = Void
typealias Rendering = Void

let publisher: WorkflowPublisher
let publisher: AnyPublisher<Output, Never>

init(publisher: WorkflowPublisher) {
self.publisher = publisher
init<WorkflowPublisher: Publisher>(publisher: WorkflowPublisher) where WorkflowPublisher.Failure == Never, WorkflowPublisher.Output == Output {
self.publisher = publisher.eraseToAnyPublisher()
}

func render(state: State, context: RenderContext<Self>) -> Rendering {
Expand Down
25 changes: 23 additions & 2 deletions WorkflowCombine/Testing/PublisherTesting.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,26 @@ import XCTest
@testable import WorkflowCombine

extension RenderTester {
/// Expect a `Publisher`-based Workflow.
///
/// `PublisherWorkflow` is used to subscribe to `Publisher`s.
///
/// - Parameters:
/// - producingOutput: An output that will be returned when this worker is requested, if any.
/// - key: Key to expect this `Workflow` to be rendered with.
public func expectPublisher<Output>(
producingOutput output: Output? = nil,
key: String = ""
) -> RenderTester<WorkflowType> {
expectWorkflow(
type: PublisherWorkflow<Output>.self,
key: key,
producingRendering: (),
producingOutput: output,
assertions: { _ in }
)
}

/// Expect a `Publisher`-based Workflow.
///
/// `PublisherWorkflow` is used to subscribe to `Publisher`s.
Expand All @@ -31,21 +51,22 @@ extension RenderTester {
/// - publisher: Type of the Publisher-based Workflow to expect
/// - producingOutput: An output that will be returned when this worker is requested, if any.
/// - key: Key to expect this `Workflow` to be rendered with.
@available(*, deprecated, message: "Use expectPublisher(producingOutput:key:) instead")
public func expect<PublisherType: Publisher>(
publisher: PublisherType.Type,
producingOutput output: PublisherType.Output? = nil,
key: String = ""
) -> RenderTester<WorkflowType> where PublisherType.Failure == Never {
expectWorkflow(
type: PublisherWorkflow<PublisherType>.self,
type: PublisherWorkflow<PublisherType.Output>.self,
key: key,
producingRendering: (),
producingOutput: output,
assertions: { _ in }
)
}

@available(*, deprecated, renamed: "expect(publisher:producingOutput:key:)")
@available(*, deprecated, message: "Use expectPublisher(producingOutput:key:) instead")
public func expect<PublisherType: Publisher>(
publisher: PublisherType.Type,
output: PublisherType.Output,
Expand Down
17 changes: 17 additions & 0 deletions WorkflowCombine/TestingTests/PublisherTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,24 +16,41 @@
func testPublisherWorkflow() {
TestWorkflow()
.renderTester()
.expect(

Check warning on line 19 in WorkflowCombine/TestingTests/PublisherTests.swift

View workflow job for this annotation

GitHub Actions / development-tests [iOS 17.5] 

'expect(publisher:producingOutput:key:)' is deprecated: Use expectPublisher(producingOutput:key:) instead

Check warning on line 19 in WorkflowCombine/TestingTests/PublisherTests.swift

View workflow job for this annotation

GitHub Actions / development-tests [iOS 16.4] 

'expect(publisher:producingOutput:key:)' is deprecated: Use expectPublisher(producingOutput:key:) instead

Check warning on line 19 in WorkflowCombine/TestingTests/PublisherTests.swift

View workflow job for this annotation

GitHub Actions / development-tests [iOS 26.2] 

'expect(publisher:producingOutput:key:)' is deprecated: Use expectPublisher(producingOutput:key:) instead
publisher: Publishers.Sequence<[Int], Never>.self,
producingOutput: 1,
key: "123"
)
.render {}

TestWorkflow()
.renderTester()
.expectPublisher(
producingOutput: 1,
key: "123"
)
.render {}
}

func test_publisher_no_output() {
TestWorkflow()
.renderTester()
.expect(

Check warning on line 38 in WorkflowCombine/TestingTests/PublisherTests.swift

View workflow job for this annotation

GitHub Actions / development-tests [iOS 17.5] 

'expect(publisher:producingOutput:key:)' is deprecated: Use expectPublisher(producingOutput:key:) instead

Check warning on line 38 in WorkflowCombine/TestingTests/PublisherTests.swift

View workflow job for this annotation

GitHub Actions / development-tests [iOS 16.4] 

'expect(publisher:producingOutput:key:)' is deprecated: Use expectPublisher(producingOutput:key:) instead

Check warning on line 38 in WorkflowCombine/TestingTests/PublisherTests.swift

View workflow job for this annotation

GitHub Actions / development-tests [iOS 26.2] 

'expect(publisher:producingOutput:key:)' is deprecated: Use expectPublisher(producingOutput:key:) instead
publisher: Publishers.Sequence<[Int], Never>.self,
producingOutput: nil,
key: "123"
)
.render {}
.assertNoAction()

TestWorkflow()
.renderTester()
.expectPublisher(
producingOutput: Int?.none,
key: "123"
)
.render {}
.assertNoAction()
}

struct TestWorkflow: Workflow {
Expand Down
Loading