Il est intéressant de pouvoir mettre de timeout sur les requêtes pour éviter les requête qui tournent dans le vide.
Structure configuration
Ajout de timeout pour toutes les requête API, récupération de la valeur du time out depuis la configuration section routing avec pour clef <nom_route>_timeout et pour valeur le nombre en secondes du timeout ou rien qui correspond à aucun timeout.
Il y aura une valeur globale dans la section store_api pour le timeout par défaut des requêtes (clef timeout)
Cas particulier des requêtes avec upload de fichiers, il est possible de moduler la valeur du timeout selon la taille du fichier (sont concerné toute requête faite avec fonction ApiRequester().route_upload_file()). La valeur sera une dictionnaire json sur une seule ligne
avec pour clef la taille en octet et pour valeur te temps en seconde du time out ou 'null' pour ne pas avoir de timeout. Il sera toujours possible de mettre une unique valeur pour le timeout ou pas de valeur pour supprimé le timeout.
Si la taille du fichier est inférieur à la plus petite valeur du tableau le timeout par défaut est utilisé, sinon c'est la plus grande valeur inférieur à la taille du fichier qui est utilisée. par exemple pour un dictionnaire {'1000': 4, '2000': 8, '3000': null} les fichiers de taille inférieur à 1000 octets la valeur par défaut est utilisée, de 1000 à 2000 octets timeout de 4s de 2000 à 3000 octets timeout de 8s au dessus de 3000 octets il n'y a plus de timeout.
Exemple de la configuration
[store_api]
# timeout par défaut 60s
timeout=60
[routing]
# route user_get pas de timeout
user_get=${store_api:root_url}/users/me
user_get_timeout=
# route me_get timeout de 10s
me_get=${store_api:root_url}/users/me
me_get_timeout=10
# upload_push_data timeout selon la taille du fichier :
# - 0 à 1000 octets valeur par défaut
# - de 1000 à 2000 octets timeout de 4s
# - plus de 2000 octets timeout de 8s
upload_push_data=${upload_get}/data
upload_push_data_timeout={"1000": 4, "2000":8}
# upload_push_md5 timeout fixe à 60s
upload_push_md5=${upload_get}/md5
upload_push_md5_timeout=60
Modification à mener
[x] modification de ApiRequester().__url_request() : ajout timeout en paramètre, utilisation du paramètre pour lancer la requête
[x] modification de ApiRequester().url_request() : ajout timeout en paramètre, gestion de l'erreur de timeout
[x] modification de ApiRequester().route_request() : ajout timeout en paramètre + recherche du timeout dans la conf pour la route donné si non donnée en paramètre
[x] modification de ApiRequester().route_upload_file() ajout timeout en paramètre + recherche du timeout dans la conf pour la route donné si non donnée en paramètre (cas particulier de paramétrage selon ta taille du fichier)
[x] modification UploadAction.__push_files : gestion de l'erreur de timeout comme pour ConflictError.
[x] __main__.py voir si besoin gestion de l'erreur de timeout
Il est intéressant de pouvoir mettre de timeout sur les requêtes pour éviter les requête qui tournent dans le vide.
Structure configuration
Ajout de timeout pour toutes les requête API, récupération de la valeur du time out depuis la configuration section
routingavec pour clef<nom_route>_timeoutet pour valeur le nombre en secondes du timeout ou rien qui correspond à aucun timeout. Il y aura une valeur globale dans la sectionstore_apipour le timeout par défaut des requêtes (cleftimeout)Cas particulier des requêtes avec upload de fichiers, il est possible de moduler la valeur du timeout selon la taille du fichier (sont concerné toute requête faite avec fonction
ApiRequester().route_upload_file()). La valeur sera une dictionnaire json sur une seule ligne avec pour clef la taille en octet et pour valeur te temps en seconde du time out ou 'null' pour ne pas avoir de timeout. Il sera toujours possible de mettre une unique valeur pour le timeout ou pas de valeur pour supprimé le timeout. Si la taille du fichier est inférieur à la plus petite valeur du tableau le timeout par défaut est utilisé, sinon c'est la plus grande valeur inférieur à la taille du fichier qui est utilisée. par exemple pour un dictionnaire{'1000': 4, '2000': 8, '3000': null}les fichiers de taille inférieur à 1000 octets la valeur par défaut est utilisée, de 1000 à 2000 octets timeout de 4s de 2000 à 3000 octets timeout de 8s au dessus de 3000 octets il n'y a plus de timeout.Exemple de la configuration
Modification à mener
ApiRequester().__url_request(): ajout timeout en paramètre, utilisation du paramètre pour lancer la requêteApiRequester().url_request(): ajout timeout en paramètre, gestion de l'erreur de timeoutApiRequester().route_request(): ajout timeout en paramètre + recherche du timeout dans la conf pour la route donné si non donnée en paramètreApiRequester().route_upload_file()ajout timeout en paramètre + recherche du timeout dans la conf pour la route donné si non donnée en paramètre (cas particulier de paramétrage selon ta taille du fichier)UploadAction.__push_files: gestion de l'erreur de timeout comme pour ConflictError.__main__.pyvoir si besoin gestion de l'erreur de timeout