[TECH DEBT] Deprecate the callback argument of AsyncAuth.authenticate()

Đang mở
  • Có gì không ổn?
#70,714 0 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 3 ngày

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

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
68/100
Loại issue
Tái cấu trúc
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
python
Lĩnh vực
backend-api-design

Hướng nghiên cứu

Start by locating AsyncAuth.authenticate() and its tests in the Salt codebase; the issue does not name specific files or tests. Check how salt.utils.versions.warn_until is used for deprecations, then add the warning on master when a callback is passed, pointing callers to await or add_done_callback(). Done means the warning is covered by tests and the 3008.x behavior remains unchanged.

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

Mô tả

tech-debt
Description of the tech debt to be addressed, include links and screenshots

AsyncAuth.authenticate(callback=None) takes an optional callback that is called with the result when the sign-in succeeds. It is left over from the Tornado callback style.

  • Nothing in salt/ passes a callback. Every caller does await auth.authenticate().
  • It is not documented.
  • With #70603 the callback is only called when the sign-in succeeds. A failed sign-in never reaches it, so a caller using a callback is not told about the failure.
  • authenticate() returns a task. A caller that wants a notification can use task.add_done_callback(), which is also called when the sign-in fails.
Proposed change

Do not change this in #70603 or its 3008.x version, which only fix cancellation and error handling.

  1. On master, warn with salt.utils.versions.warn_until when a callback is passed, and point to await or add_done_callback().
  2. Remove the argument once the warning period is over.

Leave 3008.x as it is.

Related: #70603, #70366, #70712.

Versions Report

No user-visible change until the warning is added. Targets the master branch.

Ngôn ngữ chính
Python
Star
15.8k
Fork
5.6k
Merge trung bình
5 ngày 9 giờ
Pull request đã merge (30 ngày)
99

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 saltstack/salt

Tất cả issue của saltstack/salt

Issue tương tự

Thêm issue về Python

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.