square/workflow-kotlin

Improve lifecycle docs on Workflow, RenderContext

Open

#356 opened on Mar 5, 2021

View on GitHub
 (3 comments) (1 reaction) (0 assignees)Kotlin (114 forks)github user discovery
documentationgood first issue

Repository metrics

Stars
 (1,120 stars)
PR merge metrics
 (Avg merge 55d 8h) (9 merged PRs in 30d)

Description

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

Contributor guide

Research direction
Improve the lifecycle documentation in Workflow.kt and RenderContext.kt to explicitly mention LifecycleWorker and how to cancel tasks when the workflow is no longer rendered. Provide clear cross references.
Tech stack
kotlin
Domain
mobile
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitKotlin
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75