square/workflow-kotlin

Improve lifecycle docs on Workflow, RenderContext

オープン

#356 opened on 2021/03/05

 (3 件のコメント) (1 件のリアクション) (0 人の担当者)Kotlin (112 件のフォーク)github user discovery
documentationgood first issue

Repository metrics

Stars
 (1,120 個のスター)
PR merge metrics
 (平均マージ 55d 8h) (30d で 9 merged PRs)

説明

Quoth @Armaxis:

In Workflow.kt docs there’s a paragraph stating:

This context allows the workflow to interact with the outside world by doing things like listening for events, subscribing to streams of data, rendering child workflows, and performing cleanup when the workflow is about to be torn down by its parent. See the documentation on RenderContext for more information about what it can do. I searched around the RenderContext but haven’t found anything about the cleanup process of workflows. Is there anywhere I can read more in-depth?

Context: I was searching for a way to cancel payment when Workflow is no longer rendered, and it took quite some time to find LifecycleWorker. I wish Workflow would point better to it?

My first instinct was to search for onCleared/onCanceled somewhere in workflows -> then dig around RenderContext -> Cmd+F for cancel -> LifecycleWorker

コントリビューターガイド