Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

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

Đang mở
  • Có gì không ổn?
#2,578 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
1/5
Thời gian dự kiến
Dưới một giờ
Mức phù hợp với người mới
45/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
java
Lĩnh vực
documentation

Hướng nghiên cứu

Mở temporal-sdk/src/main/java/io/temporal/client/WorkflowClient.java quanh dòng 704 và xem JavaDoc của các phương thức startUpdate. Kiểm tra cách tùy chọn waitForStage được mô tả, sau đó cập nhật tài liệu để COMPLETED nêu rõ rằng lệnh gọi có thể bị chặn; hoàn tất khi JavaDoc không còn ngụ ý rằng phương thức này luôn bất đồng bộ.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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!

Ngôn ngữ chính
Java
Star
434
Fork
252
Merge trung bình
6 ngày 5 giờ
Pull request đã merge (30 ngày)
25

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của temporalio/sdk-java

Tất cả issue của temporalio/sdk-java

Issue tương tự

Thêm issue về Java

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.