uber / uber/RIBs

Forked Workflows call didComplete() early

Open
#216 1 comment 2 reactions 1 assignee View on GitHub

@neakor is already working on this.

Since Mar 11, 2018.

iOS
Dominant language
Kotlin
Stars
7.9k
Forks
914
PR merge metrics
No merged PRs in 30d

Description

When forking a Workflow the didComplete() is called as soon as the first branch completes. The fix that added didCompleteIfNotYet() guarantees that didComplete() is called only once, but that one time is when the first branch completes. Intuitively, I would expect the didComplete() to be called once all of the branches have completed, but that could be a bad assumption.

Related to #211 and the fix in #214

Example Test Case:

func test_workflowForkCompletionOrder() {
        let workflow = TestWorkflow()
        
        let emptyObservable = Observable.just(((), ()))
        _ = workflow
            .onStep { _ -> Observable<((), ())> in
                return emptyObservable
            }
            .onStep { _, _ -> Observable<((), ())> in
                let forkedStep: Step<(), (), ()>? = emptyObservable.fork(workflow)
                forkedStep?
                    .onStep { _, _ -> Observable<((), ())> in
                        XCTAssertEqual(0, workflow.completeCallCount)
                        return emptyObservable
                    }
                    .commit()
                return emptyObservable
            }
            .onStep { _, _ -> Observable<((), ())> in
                XCTAssertEqual(0, workflow.completeCallCount) // XCTAssertEqual failed: ("0") is not equal to ("1")
                return emptyObservable
            }
            .commit()
            .subscribe(())
        
        XCTAssertEqual(1, workflow.completeCallCount)
        XCTAssertEqual(1, workflow.forkCallCount)
        XCTAssertEqual(0, workflow.errorCallCount)
    }

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.