Issue with Client Python SDK Domain dataclass

[KesslerAK]

Bonjour,

j'ai potentiellement un problème avec la définition de la Dataclass pour le model "Domain" (models.py) dans le client python de CleverCloud et le call de création d'un nouveau domain avec la fonction create_new_domain (client.py)

La dataclasse est définie de la façon suivante :

domain: str
is_primary: bool

@classmethod
def from_api_response(cls, data: Any, *, is_primary: bool = False) -> Self:
    data = _mapping(data, model="Domain")
    return cls(
        domain=_require_str(data, "fqdn", model="Domain").rstrip("/"),
        is_primary=is_primary,
    )

De ce que je comprends il y a deux éléments : domain et is_primary.

Mon soucis viendrait de _require_str (models.py) :

`def _require_str(data: Mapping[str, Any], key: str, *, model: str) -> str:
value = data.get(key)
if not isinstance(value, str) or not value:
msg = f"{model}: missing or invalid required field {key!r}"
raise InvalidResponseError(msg)
return value`

Ici data est mappé sur le model "Domain", et key = "fqdn".
donc
domain=_require_str(data, "fqdn", model="Domain").rstrip("/"),
==> _require_str(data, "fqdn", model="Domain") ==> value = data.get("fqdn") alors que data est mappé sur Domain, qui a "domain" et "is_primary".

Dans la version que j'utilisais précédement, je faisais le rstip en amont pour justement créer le "fqdn" :

domain: str
is_primary: bool

@classmethod
def from_api_response(
    cls, data: dict[str, Any], *, is_primary: bool = False
) -> Self:
    fqdn = data.get("fqdn", "").rstrip("/")    #<==================================== LA
    return cls(
        domain=fqdn,
        is_primary=is_primary,
    )

Du coup j'ai l'impression que dans la nouvelle version du client, le rstrip est fait sur le résultat de _require_str alors que le _require_str devrait être fait sur le resultat du rstrip.

Cordialement,
AK.

[sebartyr]

Bonjour AK, et merci beaucoup pour ce signalement, très bien documenté.

Bonne nouvelle : ta relecture a mis au jour un vrai défaut, corrigé depuis. Sur le point principal en revanche, le code lit bien la bonne clé — et si tu as pu en douter, c'est d'abord parce que notre nommage prête à confusion. Je détaille les deux.

Le paramètre model= : un nom trompeur, désolé

model= n'est pas un mapping de schéma, c'est seulement l'étiquette qui sert à composer le message d'erreur :

def _mapping(data: Any, *, model: str) -> Mapping[str, Any]:
    if not isinstance(data, Mapping):
        msg = f"{model}: expected a JSON object, got {type(data).__name__}"
        raise InvalidResponseError(msg)
    return data          # <- le payload est renvoyé tel quel

_mapping(data, model="Domain") vérifie donc simplement que la réponse est un objet JSON, et le renvoie inchangé — il ne « mappe » rien sur la dataclass. data reste le payload brut de l'API ({"fqdn": "app.example.com"}, tel que renvoyé par GET /v2/organisations/{ownerId}/applications/{appId}/vhosts), et data.get("fqdn") est la bonne lecture. Les noms de champs de la dataclass (domain, is_primary) n'entrent en jeu qu'au cls(...), en aval.

Autrement dit, c'est la même mécanique que dans ta version (data.get("fqdn", "").rstrip("/")) ; seul l'ordre validation / nettoyage change. Le nom model= mérite clairement mieux, on le note.

Ton intuition sur l'ordre était juste, et c'est corrigé

Tu as raison : la validation « non vide » portait sur la valeur brute et le rstrip venait après. Un fqdn composé uniquement de slashs ("/", "///") passait donc la validation avant de devenir "", et on construisait un Domain(domain=""). C'est corrigé — la validation porte désormais sur la valeur nettoyée et lève la même InvalidResponseError qu'un champ manquant. Merci de l'avoir repéré.

create_new_domain

Elle n'existait pas encore : le SDK savait lister les domaines et lire le domaine principal, mais pas en attacher un. C'est ajouté, sous le nom create_domain pour rester cohérent avec create_application / create_tcp_redirection :

domain = await client.create_domain("orga_xxx", "app_xxx", domain="app.example.com")

Le nom est débarrassé de son slash final avant d'être percent-encodé, donc il fait l'aller-retour avec Domain.domain, et un suffixe de chemin (example.com/api) reste dans le nom du vhost.

Les deux changements sortent en 0.2.1.

Une dernière question, pour être sûrs de ne pas passer à côté

Si tu es arrivé sur ce fil parce que quelque chose casse réellement chez toi, il se peut que la 0.2.1 ne suffise pas, et j'aimerais autant le savoir maintenant. Le cas le plus probable serait un payload sans fqdn : ta version renvoyait alors silencieusement Domain(domain=""), là où le SDK lève une InvalidResponseError depuis la 0.2.0 (durcissement volontaire, « Response models are parsed strictly » au CHANGELOG) — et la 0.2.1 ne change pas ce comportement.

Si tu croises une InvalidResponseError en conditions réelles, peux-tu nous envoyer le message exact et, si tu l'as, le payload correspondant ? On regardera si l'API renvoie une forme que le SDK devrait accepter.

Merci encore, et n'hésite pas si quelque chose reste flou.