[TECH DEBT] Deprecate the callback argument of AsyncAuth.authenticate()
メンテナーはふだん 3 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 68/100
- issue の種類
- リファクタリング
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
- 技術スタック
- python
調査の方向性
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.
索引モデルが issue の本文から書いたものです。
説明
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 doesawait 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 usetask.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.
- On
master, warn withsalt.utils.versions.warn_untilwhen a callback is passed, and point toawaitoradd_done_callback(). - 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.
- 主要言語
- Python
- スター
- 15.8k
- フォーク
- 5.6k
- 平均マージ
- 5日 9時間
- マージ済み PR（30日）
- 99
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
saltstack/salt のほかの issue
-
[Bug]: Scheduled returns scan all accepted minion keys causing extreme load対応中かも このイシューにリンクされたプルリクエストがオープン中、またはマージ済みです。 オープンbug needs-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
saltstack/salt#70789 · コメント 1 件 ·
メンテナーはふだん 3 日以内に返信
-
[Bug]: pip.installed with upgrade=True upgrades a package but returns an empty changes dictionary対応中かも @ITJamie が 1 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 3 日以内に返信
-
bug needs-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 3 日以内に返信
-
[Bug]: Minion with file_client: local crashes on connect: 'AsyncPillar' object has no attribute 'aclose'対応中かも @shawnrruss が 9 日前に担当しました。 オープンbug needs-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 3 日以内に返信
-
[Bug]: mine.update clear=True raises UnboundLocalError on the master and stores nothing対応中かも @cestercian が 11 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
saltstack/salt#70622 · コメント 1 件 ·
メンテナーはふだん 3 日以内に返信
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
btclib-org/btclib-wallet#872 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 87/100
btclib-org/btclib#3093 ·
メンテナーはふだん 1 日以内に返信
-
good first issue
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
patrickballard/wheelgap#269 ·
-
priority: low python
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
LearningCircuit/local-deep-research#8635 ·
メンテナーはふだん 1 日以内に返信
-
documentation
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
buckai-observatory/Automated-Cloud-Removal-and-Seamless-Satellite-Image-Mosaicking-Pipeline#52 ·
メンテナーはふだん 1 日以内に返信