square/workflow-kotlin

Improve lifecycle docs on Workflow, RenderContext

Aberta

#356 aberto em 5 de mar. de 2021

Ver no GitHubGuia do colaborador
 (3 comentários) (1 reação) (0 responsável)Kotlin (112 forks)github user discovery
documentationgood first issue

Métricas do repositório

Stars
 (1.119 estrelas)
Métricas de merge de PR
 (Mesclagem média 55d 8h) (9 fundiu PRs em 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

Guia do colaborador

Direção de pesquisa
Melhore a documentação do ciclo de vida em Workflow.kt e RenderContext.kt para mencionar explicitamente o LifecycleWorker e como cancelar tarefas quando o workflow não estiver mais sendo renderizado. Forneça referências cruzadas claras.
Pilha de tecnologia
kotlin
Domain
mobile
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitKotlin
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75