[BUG] Huge APIs (with many Operations and other artifacts) have the publisher tool fail
- Lenguaje dominante
- C#
- Estrellas
- 448
- Forks
- 247
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
### 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.
Guía de contribución
Línea de trabajo
Comienza en la ruta de creación o actualización de la Management API de la herramienta de publicación y revisa cómo gestiona las respuestas 422, incluido el comportamiento existente de reintento para 409. Reproduce el problema con una API que contenga un número muy grande de operaciones y, después, verifica que el sondeo del estado espere con un tiempo de espera limitado y que las operaciones correctas o fallidas produzcan el resultado de workflow correspondiente.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- azure, csharp
- Área
- api, cloud
- Tipo de issue
- Error
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100