Azure / Azure/apiops

[BUG] Huge APIs (with many Operations and other artifacts) have the publisher tool fail

オープン
#689 コメント 3 件 リアクション 0 件 担当者 0 名 GitHub で見る
主要言語
C#
スター
448
フォーク
247
PR マージ指標
30日以内にマージされた PR はありません

説明

### Release version

5.00 and onwards

### Describe the bug

I have tried to transfer "The Jira Service Management Public REST API" from one Service to another using the publisher tool. As the amount of operations and possibly other artifacts is significant, the Management API Call to create or update the API results in the Management API returning 422 after a while. Which is fine if it was handled, but of course that is not the case, so the Publisher fails.

### Expected behavior

Here is what I expect publisher to do:

1. Catch the 422 Error: Modify the Publisher Tool to explicitly catch the 422 error. The tool should recognize this specific HTTP status code and handle it appropriately rather than immediately retrying or failing.
2. Implement a Status Check: After catching the 422 error, introduce a function to query the status of the API operation using the Azure Management API. You can use endpoints like GET /apis/{apiId} to check the current status of the ongoing API update.
3. Retry Mechanism: If the status indicates that the API operation is still "in progress," implement a retry loop with a delay (e.g., using sleep) until the process is finished. Make sure to introduce a sensible timeout to avoid indefinite retries.
4. Proceed or Abort Workflow: Based on the final status of the operation, either proceed with the next step of the deployment if the update was successful or abort the workflow with an appropriate error message if the operation ultimately fails.

This approach ensured that the script avoided unnecessary retries and handled conflicts like the 409 error by waiting for the ongoing operation to complete before attempting further updates.

### Actual behavior

After the timeout, the Management APIs return of 422 breaks publisher which aborts with an error. Actually, the requested operation is continued to be carried out in the backend, so ultimately business-logic wise the call has succeeded, we just don't know about it and are left with an unhandled exception.

### Reproduction Steps

I'd try to have publisher publish the "The Jira Service Management Public REST API", or any other API with a HUGE amount of operations and perhaps other artifacts.

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

Publisher ツールの Management API の作成または更新パスから始め、422 レスポンスをどのように処理しているかを、既存の 409 のリトライ動作も含めて確認します。非常に多数の操作を含む API で再現し、その後、ステータスのポーリングが上限のあるタイムアウトで待機すること、および成功または失敗した操作が適切な workflow の結果を生成することを確認します。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
azure, csharp
領域
api, cloud
issue の種類
バグ
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。