add web.headers option, to allow control of response headers

gjcarneiro · Mar 23, 2024 · bde0f0b · bde0f0b
1 parent 4f7936a
commit bde0f0b
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 5 deletions.
diff --git a/example/adhoc.yacron.d/test-utc.yaml b/example/adhoc.yacron.d/test-utc.yaml
@@ -2,6 +2,8 @@ web:
   listen:
      - http://127.0.0.1:8080
      - unix:///tmp/yacron.sock
+  headers:
+    x-foobar: zbr
 
 defaults:
   shell: /bin/bash

diff --git a/yacron/config.py b/yacron/config.py
@@ -248,7 +248,12 @@ class ConfigError(Exception):
     {
         Opt("defaults"): Map(_job_defaults_common),
         Opt("jobs"): Seq(Map(_job_schema_dict)),
-        Opt("web"): Map({"listen": Seq(Str())}),
+        Opt("web"): Map(
+            {
+                "listen": Seq(Str()),
+                Opt("headers"): MapPattern(Str(), Str()),
+            }
+        ),
         Opt("include"): Seq(Str()),
         Opt("logging"): Map(
             {

diff --git a/yacron/cron.py b/yacron/cron.py
@@ -167,9 +167,14 @@ def update_config(self) -> YacronConfig:
         return config
 
     async def _web_get_version(self, request: web.Request) -> web.Response:
-        return web.Response(text=yacron.version.version)
+        assert self.web_config is not None
+        return web.Response(
+            text=yacron.version.version,
+            headers=self.web_config.get("headers", None),
+        )
 
     async def _web_get_status(self, request: web.Request) -> web.Response:
+        assert self.web_config is not None
         out = []
         for name, job in self.cron_jobs.items():
             running = self.running_jobs.get(name, None)
@@ -200,7 +205,9 @@ async def _web_get_status(self, request: web.Request) -> web.Response:
                     }
                 )
         if request.headers.get("Accept") == "application/json":
-            return web.json_response(out)
+            return web.json_response(
+                out, headers=self.web_config.get("headers", None)
+            )
         else:
             lines = []
             for jobstat in out:  # type: Dict[str, Any]
@@ -223,16 +230,20 @@ async def _web_get_status(self, request: web.Request) -> web.Response:
                         name=jobstat["job"], status=status
                     )
                 )
-            return web.Response(text="\n".join(lines))
+            return web.Response(
+                text="\n".join(lines),
+                headers=self.web_config.get("headers", None),
+            )
 
     async def _web_start_job(self, request: web.Request) -> web.Response:
+        assert self.web_config is not None
         name = request.match_info["name"]
         try:
             job = self.cron_jobs[name]
         except KeyError as ex:
             raise web.HTTPNotFound() from ex
         await self.maybe_launch_job(job)
-        return web.Response()
+        return web.Response(headers=self.web_config.get("headers", None))
 
     async def start_stop_web_app(self, web_config: Optional[WebConfig]):
         if self.web_runner is not None and (