Merge pull request #85 from maykinmedia/feature/add-custom-field-for-…

…timeout-in-service

Add timeout field to the Service model

manage.py

@@ -4,7 +4,7 @@
 
 def main():
     """Run administrative tasks."""
-    os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'testapp.settings')
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "testapp.settings")
     try:
         from django.core.management import execute_from_command_line
     except ImportError as exc:
@@ -16,5 +16,5 @@ def main():
     execute_from_command_line(sys.argv)
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     main()

tests/test_config_adapter.py

@@ -137,3 +137,31 @@ def test_zgw_auth():
 
     headers = m.last_request.headers
     assert "Authorization" in headers
+
+
+def test_default_timeout():
+    service = ServiceFactory.build(api_root="https://example.com/")
+    adapter = ServiceConfigAdapter(service)
+    client = APIClient.configure_from(adapter)
+
+    with requests_mock.Mocker() as m, client:
+        m.get("https://example.com/foo")
+
+        client.get("foo")
+
+    timeout = m.last_request.timeout
+    assert timeout == 10
+
+
+def test_custom_timeout():
+    service = ServiceFactory.build(api_root="https://example.com/", timeout=30)
+    adapter = ServiceConfigAdapter(service)
+    client = APIClient.configure_from(adapter)
+
+    with requests_mock.Mocker() as m, client:
+        m.get("https://example.com/foo")
+
+        client.get("foo")
+
+    timeout = m.last_request.timeout
+    assert timeout == 30

zgw_consumers/client.py

@@ -68,6 +68,9 @@ def get_client_session_kwargs(self) -> dict[str, Any]:
             case AuthTypes.zgw:
                 kwargs["auth"] = ZGWAuth(service=self.service)
 
+        # set timeout for the requests
+        kwargs["timeout"] = self.service.timeout
+
         return kwargs
 
 

zgw_consumers/migrations/0020_service_timeout.py

@@ -0,0 +1,22 @@
+# Generated by Django 3.2.24 on 2024-02-22 01:41
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("zgw_consumers", "0019_alter_service_uuid"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="service",
+            name="timeout",
+            field=models.PositiveSmallIntegerField(
+                default=10,
+                help_text="Timeout (in seconds) for HTTP calls.",
+                verbose_name="timeout",
+            ),
+        ),
+    ]

zgw_consumers/models/services.py

@@ -72,6 +72,11 @@ class Service(RestAPIService):
         on_delete=models.PROTECT,
         related_name="service_server",
     )
+    timeout = models.PositiveSmallIntegerField(
+        _("timeout"),
+        help_text=_("Timeout (in seconds) for HTTP calls."),
+        default=10,
+    )
 
     objects = ServiceManager()