sovereign 1.0.0b124__tar.gz → 1.0.0b126__tar.gz

{sovereign-1.0.0b124 → sovereign-1.0.0b126}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sovereign
-Version: 1.0.0b124
+Version: 1.0.0b126
 Summary: Envoy Proxy control-plane written in Python
 Home-page: https://pypi.org/project/sovereign/
 License: Apache-2.0

{sovereign-1.0.0b124 → sovereign-1.0.0b126}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "sovereign"
-version = "1.0.0b124"
+version = "1.0.0b126"
 description = "Envoy Proxy control-plane written in Python"
 license = "Apache-2.0"
 packages = [

{sovereign-1.0.0b124 → sovereign-1.0.0b126}/src/sovereign/rendering.py

@@ -7,6 +7,8 @@ Functions used to render and return discovery responses to Envoy proxies.
 The templates are configurable. `todo See ref:Configuration#Templates`
 """
 
+import threading
+from multiprocessing import Process, Semaphore, cpu_count
 from typing import Any, Dict, List
 
 import yaml
@@ -27,6 +29,8 @@ from sovereign.schemas import (
     ProcessedTemplate,
 )
 
+# limit render jobs to number of cores
+RENDER_SEMAPHORE = Semaphore(cpu_count())
 
 type_urls = {
     "v2": {
@@ -54,39 +58,52 @@ class RenderJob(pydantic.BaseModel):
     request: DiscoveryRequest
     context: dict[str, Any]
 
+    def spawn(self):
+        t = threading.Thread(target=self._run)
+        t.start()
+
+    def _run(self):
+        with RENDER_SEMAPHORE:
+            proc = Process(target=generate, args=[self])
+            proc.start()
+            proc.join()
+
 
 def generate(job: RenderJob) -> None:
     request = job.request
     tags = [f"type:{request.resource_type}"]
-    stats.increment("template.render", tags=tags)
-    with stats.timed("template.render_ms", tags=tags):
-        content = request.template(
-            discovery_request=request,
-            host_header=request.desired_controlplane,
-            resource_names=request.resources,
-            **job.context,
-        )
-        if not request.template.is_python_source:
-            assert isinstance(content, str)
-            content = deserialize_config(content)
-        assert isinstance(content, dict)
-        resources = filter_resources(content["resources"], request.resources)
-        add_type_urls(request.api_version, request.resource_type, resources)
-        response = ProcessedTemplate(resources=resources)
-        cache.write(
-            job.id,
-            cache.Entry(
-                text=response.model_dump_json(indent=None),
-                len=len(response.resources),
-                version=response.version_info,
-                node=request.node,
-            ),
-        )
-
-
-def batch_generate(jobs: list[RenderJob]) -> None:
-    for job in jobs:
-        generate(job)
+    try:
+        with stats.timed("template.render_ms", tags=tags):
+            content = request.template(
+                discovery_request=request,
+                host_header=request.desired_controlplane,
+                resource_names=request.resources,
+                **job.context,
+            )
+            if not request.template.is_python_source:
+                assert isinstance(content, str)
+                content = deserialize_config(content)
+            assert isinstance(content, dict)
+            resources = filter_resources(content["resources"], request.resources)
+            add_type_urls(request.api_version, request.resource_type, resources)
+            response = ProcessedTemplate(resources=resources)
+            cache.write(
+                job.id,
+                cache.Entry(
+                    text=response.model_dump_json(indent=None),
+                    len=len(response.resources),
+                    version=response.version_info,
+                    node=request.node,
+                ),
+            )
+        tags.append("result:ok")
+    except Exception as e:
+        tags.append("result:err")
+        tags.append(f"error:{e.__class__.__name__.lower()}")
+        if SENTRY_INSTALLED and config.sentry_dsn:
+            sentry_sdk.capture_exception(e)
+    finally:
+        stats.increment("template.render", tags=tags)
 
 
 def deserialize_config(content: str) -> Dict[str, Any]:

sovereign-1.0.0b126/src/sovereign/static/node_expression.js

@@ -0,0 +1,39 @@
+const input = document.getElementById('filterInput');
+const inputMessage = document.getElementById('filterMessage');
+const form = document.getElementById('filterForm');
+
+function validateInput(inputString) {
+  if (!inputString || inputString.trim() === '') {
+    return "empty";
+  }
+  const validationRegex = /^(?:(?:id|cluster|metadata\.[\w\.\=\-]+|locality\.?(?:zone|sub_zone|region))=[a-zA-Z0-9_-]+ ?)*$/;
+  return validationRegex.test(inputString);
+}
+
+window.addEventListener('DOMContentLoaded', () => {
+  const match = document.cookie.match(/(?:^|; )node_expression=([^;]*)/);
+  if (match) {
+    input.value = match[1];
+  }
+});
+
+input.addEventListener('input', (event) => {
+  const result = validateInput(event.target.value);
+  if (result === "empty") {
+    input.className = "input is-dark";
+    inputMessage.innerHTML = "";
+  } else if (result === true) {
+    input.className = "input is-success";
+    inputMessage.innerHTML = "";
+  } else {
+    input.className = "input is-danger";
+    inputMessage.innerHTML = "The node filter expression may have no effect, or be invalid";
+  }
+});
+
+form.addEventListener('submit', (event) => {
+  event.preventDefault();
+  const value = input.value.trim();
+  document.cookie = `node_expression=${value}; path=/ui/resources/; max-age=31536000`;
+  location.reload();
+});

{sovereign-1.0.0b124 → sovereign-1.0.0b126}/src/sovereign/templates/resources.html

@@ -271,6 +271,14 @@
 
 {%- block body %}
     <div class="content">
+        {% if error %}
+        <span class="panel-icon">
+            <i class="fas fa-arrow-right" aria-hidden="true"></i>
+        </span>
+        <div class="notification is-danger">
+            {{ error }}
+        </div>
+        {% endif %}
         <p class="content">
         <div class="columns">
             <div class="column is-narrow">
@@ -303,6 +311,7 @@
                 <form id="filterForm">
                     <input id="filterInput" class="input is-dark" type="text" placeholder="Node filter expression"/>
                 </form>
+                <p id="filterMessage" class="help is-danger"></p>
             </div>
             <div class="column is-narrow">
                 <div class="tooltip">
@@ -322,6 +331,7 @@
         </div>
     </div>
 
+
     {% set count = resources|length %}
     {% if count > 0 %}
     <nav class="panel is-dark" id="resources">

{sovereign-1.0.0b124 → sovereign-1.0.0b126}/src/sovereign/utils/mock.py

@@ -7,6 +7,10 @@ from sovereign.schemas import DiscoveryRequest, Node, Locality, Status
 scrub = re.compile(r"[^a-zA-Z_\.]")
 
 
+class NodeExpressionError(Exception):
+    pass
+
+
 def mock_discovery_request(
     api_version: Optional[str] = "V3",
     resource_type: Optional[str] = None,
@@ -54,7 +58,7 @@ def set_node_expressions(node, expressions):
             field, value = re.split(r"\s*=\s*", expr, maxsplit=1)
             value = f'"{value}"'
         except ValueError:
-            raise ValueError(f"Invalid expression format: {expr}")
+            raise NodeExpressionError(f"Invalid node filter format: {expr}")
 
         field = scrub.sub("", field)
         parts = field.split(".")
@@ -62,7 +66,7 @@ def set_node_expressions(node, expressions):
         try:
             value = ast.literal_eval(value)
         except Exception as e:
-            raise ValueError(f"invalid value: {value}") from e
+            raise NodeExpressionError(f"Invalid node filter value: {value}") from e
 
         current = node
         for part in parts[:-1]:

{sovereign-1.0.0b124 → sovereign-1.0.0b126}/src/sovereign/views/interface.py

@@ -10,7 +10,7 @@ from fastapi.responses import HTMLResponse, JSONResponse, Response
 from sovereign import html_templates, cache
 from sovereign.schemas import DiscoveryTypes, XDS_TEMPLATES
 from sovereign.response_class import json_response_class
-from sovereign.utils.mock import mock_discovery_request
+from sovereign.utils.mock import NodeExpressionError, mock_discovery_request
 
 router = APIRouter()
 
@@ -63,18 +63,31 @@ async def resources(
 ) -> HTMLResponse:
     ret: Dict[str, List[Dict[str, Any]]] = defaultdict(list)
     response = None
-    mock_request = mock_discovery_request(
-        api_version,
-        xds_type,
-        version=envoy_version,
-        region=region,
-        expressions=node_expression.split(),
-    )
+    try:
+        mock_request = mock_discovery_request(
+            api_version,
+            xds_type,
+            version=envoy_version,
+            region=region,
+            expressions=node_expression.split(),
+        )
+        clear_cookie = False
+        error = None
+    except NodeExpressionError as e:
+        mock_request = mock_discovery_request(
+            api_version,
+            xds_type,
+            version=envoy_version,
+            region=region,
+        )
+        clear_cookie = True
+        error = str(e)
+
     response = await cache.blocking_read(mock_request)
     if response:
         ret["resources"] = json.loads(response.text).get("resources", [])
 
-    return html_templates.TemplateResponse(
+    resp = html_templates.TemplateResponse(
         request=request,
         name="resources.html",
         media_type="text/html",
@@ -87,8 +100,12 @@ async def resources(
             "all_types": all_types,
             "version": envoy_version,
             "available_versions": list(XDS_TEMPLATES.keys()),
+            "error": error,
         },
     )
+    if clear_cookie:
+        resp.delete_cookie("node_expression", path="/ui/resources/")
+    return resp
 
 
 @router.get(

{sovereign-1.0.0b124 → sovereign-1.0.0b126}/src/sovereign/worker.py

@@ -1,6 +1,5 @@
 import asyncio
 from typing import Optional, final
-from multiprocessing import Process, cpu_count
 from contextlib import asynccontextmanager
 
 from fastapi import FastAPI, Body
@@ -56,9 +55,11 @@ class RenderQueue:
     def full(self):
         return self._queue.full()
 
+    def task_done(self):
+        self._queue.task_done()
+
 
 ONDEMAND = RenderQueue()
-RENDER_SEMAPHORE = asyncio.Semaphore(cpu_count())
 
 
 def hidden_field(*args, **kwargs):
@@ -96,42 +97,23 @@ if config.sources is not None:
     context_middleware.append(poller.add_to_context)
 
 
-def render(job: rendering.RenderJob):
-    log.debug(f"Spawning render process for {job.id}")
-    process = Process(target=rendering.generate, args=[job])
-    process.start()
-    return process
-
-
-async def submit_render(job: rendering.RenderJob):
-    async with RENDER_SEMAPHORE:
-        process = render(job)
-        # Wait for the process to complete to ensure semaphore is held
-        # until the actual rendering work is done
-        await asyncio.get_event_loop().run_in_executor(None, process.join)
-
-
 async def render_on_event():
     while True:
         # block forever until new context arrives
-        await NEW_CONTEXT.wait()
+        _ = await NEW_CONTEXT.wait()
         log.debug("New context detected, re-rendering templates")
         try:
             if registered := cache.clients():
                 log.debug("New context detected, re-rendering templates")
-                jobs = [
-                    rendering.RenderJob(
+                size = len(registered)
+                stats.increment("template.render_on_event", tags=[f"batch_size:{size}"])
+                for client, request in registered:
+                    job = rendering.RenderJob(
                         id=client,
                         request=request,
                         context=template_context.get_context(request),
                     )
-                    for client, request in registered
-                ]
-                tasks = [submit_render(job) for job in jobs]
-                size = len(tasks)
-                stats.increment("template.render_on_event", tags=[f"batch_size:{size}"])
-                await asyncio.gather(*tasks)
-                log.debug(f"Completed rendering {size} jobs")
+                    job.spawn()
         finally:
             NEW_CONTEXT.clear()
 
@@ -144,16 +126,24 @@ async def render_on_demand():
         job = rendering.RenderJob(
             id=id, request=request, context=template_context.get_context(request)
         )
-        await submit_render(job)
+        job.spawn()
         ONDEMAND.task_done()
 
 
+async def monitor_render_queue():
+    """Periodically report render queue size metrics"""
+    while True:
+        await asyncio.sleep(10)
+        stats.gauge("template.on_demand_queue_size", ONDEMAND._queue.qsize())
+
+
 @asynccontextmanager
 async def lifespan(_: FastAPI):
     # Template Rendering
     log.debug("Starting rendering loops")
     asyncio.create_task(render_on_event())
     asyncio.create_task(render_on_demand())
+    asyncio.create_task(monitor_render_queue())
 
     # Template context
     log.debug("Starting context loop")

sovereign-1.0.0b124/src/sovereign/static/node_expression.js

@@ -1,16 +0,0 @@
-const input = document.getElementById('filterInput');
-const form = document.getElementById('filterForm');
-
-window.addEventListener('DOMContentLoaded', () => {
-  const match = document.cookie.match(/(?:^|; )node_expression=([^;]*)/);
-  if (match) {
-    input.value = match[1];
-  }
-});
-
-form.addEventListener('submit', (event) => {
-  event.preventDefault();
-  const value = input.value.trim();
-  document.cookie = `node_expression=${value}; path=/ui/resources/; max-age=31536000`;
-  location.reload();
-});