Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

`startUpdate` JavaDoc says "asynchronously" when it may not be

Aperta
#2,578 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
Meno di un'ora
Idoneità per principianti
45/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Ferma
Stack tecnologico
java
Ambito
documentation

Direzione di ricerca

Apri temporal-sdk/src/main/java/io/temporal/client/WorkflowClient.java intorno alla riga 704 ed esamina il JavaDoc dei metodi startUpdate. Controlla come viene descritta l’opzione waitForStage, quindi aggiorna la documentazione in modo che COMPLETED indichi chiaramente che la chiamata può bloccarsi; il lavoro è terminato quando il JavaDoc non implica più che il metodo sia sempre asincrono.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Expected Behavior

The JavaDoc for startUpdate should indicate that when it's called with a waitForStage of WorkflowUpdateStage.COMPLETED, it's synchronous and blocks until the update is completed.

Actual Behavior

The JavaDoc for startUpdate says the following:

Start a zero argument update workflow request asynchronously.

However, the following code will block until the update is completed:

val updateOptions =
  UpdateOptions.newBuilder<UpdateResult>()
    .setResultClass(UpdateResult::class.java)
    .setWaitForStage(WorkflowUpdateStage.COMPLETED)
    .setUpdateId(updateId)
    .build()
val update = WorkflowClient.startUpdate(stub::doUpdate, updateOptions) // <-- blocks here
val result = update.getResult(5, TimeUnit.SECONDS)

The JavaDoc implies that startUpdate would ignore the waitForStage, always be asynchronous, and block on the update.getResult.

Steps to Reproduce the Problem

  1. Look at JavaDoc for startUpdate
  2. Assume startUpdate is always asynchronous
  3. Call startUpdate with a waitForStage of WorkflowUpdateStage.COMPLETED
  4. See that the startUpdate call was actually synchronous

Specifications

  • Version: latest master
  • Platform: n/a

Requesting that either the word asynchronously is removed from the JavaDoc for the startUpdate methods or it's clear that the function isn't asynchronous in a normal sense.

Thanks!

Lingua principale
Java
Stelle
433
Fork
249
Merge medio
6g 5h
PR unite (30g)
25

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di temporalio/sdk-java

Tutte le issue di temporalio/sdk-java

Issue simili

Altre issue su Java

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.