square/workflow-kotlin

Improve lifecycle docs on Workflow, RenderContext

開放

#356 建立於 2021年3月5日

 (3 則留言) (1 個反應) (0 位負責人)Kotlin (112 個分叉)github user discovery
documentationgood first issue

倉庫指標

星標
 (1,120 顆星)
PR 合併指標
 (平均合併 55天 8小時) (30 天內合併 9 個 PR)

描述

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

貢獻者指南