Azure / Azure/connectors-python-sdk
Align retry safety for mutating connector operations across SDKs
- Langage dominant
- Python
- Étoiles
- 0
- Forks
- 3
- Merge moyen
- 2 j 2 h
- PR mergées (30 j)
- 11
Description
## Description
Align the Python Connector SDK's retry safety contract with the Node.js SDK behavior introduced in [Azure/Connectors-NodeJS-SDK PR #91](https://github.com/Azure/Connectors-NodeJS-SDK/pull/91).
At `main` commit `d273862108d16615009572d730c12950be040a8c`, `ConnectorHttpClient._send_with_retry` retries every HTTP method for `429`, every `5xx` response, and `aiohttp.ClientError`. `ConnectorClientOptions` exposes retry counts and backoff settings but has no method-safety setting. A POST, PUT, PATCH, or DELETE connector action can therefore be submitted again after the service committed it but returned a transient response, or after an ambiguous transport failure.
The cross-language Connector SDK contract should be:
- Retry safe methods (`GET`, `HEAD`, `OPTIONS`, and `TRACE`) according to the configured retry policy.
- Do not automatically retry unsafe methods (`POST`, `PUT`, `PATCH`, and `DELETE`) by default.
- Provide an explicit, language-idiomatic per-client opt-in for applying the configured retry policy to unsafe methods, equivalent to Node.js `retryUnsafeHttpMethods`.
- Preserve the current retry-count, delay, timeout, and exponential-backoff options.
## Motivation
Connector operations include side-effecting actions such as sending messages and creating meetings, chats, channels, or files. Automatically replaying a completed action can duplicate customer-visible effects. This risk and the desired explicit opt-in are protocol-level concerns, not Node.js-specific behavior.
Consistent defaults across the .NET, Python, and Node.js Connector SDKs make client behavior predictable when customers move the same connector integration between languages.
## Acceptance criteria
- Add a `ConnectorClientOptions` setting with Python-idiomatic naming for opting unsafe HTTP methods into retries.
- Safe methods retain the configured retry behavior by default.
- Unsafe methods make one attempt by default for both transient HTTP responses and `aiohttp.ClientError` failures.
- Unsafe methods use the configured retry behavior when explicitly enabled.
- Add focused tests proving at least:
- a transient GET is retried;
- a transient POST is sent once by default;
- a transient POST is retried when explicitly enabled;
- PUT, PATCH, and DELETE follow the unsafe classification.
- Document the default and opt-in behavior in API documentation and release notes.
- Confirm whether implementation is confined to hand-written runtime/options code. Generated-client regeneration is not expected because generated clients use the shared `ConnectorHttpClient` and `ConnectorClientOptions` runtime surface.
## Related work
- Node.js implementation: [Azure/Connectors-NodeJS-SDK PR #91](https://github.com/Azure/Connectors-NodeJS-SDK/pull/91)
- .NET alignment: [Azure/Connectors-NET-SDK issue #269](https://github.com/Azure/Connectors-NET-SDK/issues/269)
Guide de contribution
Ouvrir le guide de contribution
Piste de recherche
Commencez dans ConnectorHttpClient._send_with_retry et ConnectorClientOptions, puis examinez les tests de retry existants ainsi que la surface partagée de runtime/options utilisée par les clients générés. Ajoutez une couverture ciblée pour les méthodes sûres et non sûres, y compris le chemin d’opt-in, et mettez à jour la documentation de l’API et les notes de version afin que le comportement par défaut et le comportement d’opt-in soient documentés.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- nodejs, python
- Domaine
- api
- Type d'issue
- Fonctionnalité
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- Active
- Clarté
- Clairement spécifiée
- Accessibilité débutants
- 68/100