sovereign 1.0.0b101__tar.gz → 1.0.0b103__tar.gz

{sovereign-1.0.0b101 → sovereign-1.0.0b103}/PKG-INFO

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

{sovereign-1.0.0b101 → sovereign-1.0.0b103}/pyproject.toml

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

{sovereign-1.0.0b101 → sovereign-1.0.0b103}/src/sovereign/context.py

@@ -75,6 +75,7 @@ class TemplateContext:
         new = hash(result)
 
         if old != new:
+            stats.increment("context.updated", tags=[f"context:{name}"])
             self.hashes[name] = new
             # Debounced event notification to the worker
             if self.notify_consumers:

{sovereign-1.0.0b101 → sovereign-1.0.0b103}/src/sovereign/schemas.py

@@ -44,7 +44,7 @@ class CacheStrategy(str, Enum):
 
 
 class SourceData(BaseModel):
-    scopes: Dict[str, List[Dict[str, Any]]] = defaultdict(list)
+    scopes: Dict[str, List[Dict[str, Any]]] = Field(default_factory=dict)
 
 
 class ConfiguredSource(BaseModel):
@@ -410,7 +410,7 @@ class DiscoveryRequest(BaseModel):
         return f"version={self.envoy_version}, cluster={self.node.cluster}, resource={self.resource_type}, names={self.resources}"
 
     def __str__(self) -> str:
-        return f"DiscoverRequest({self.debug()})"
+        return f"DiscoveryRequest({self.debug()})"
 
 
 class DiscoveryResponse(BaseModel):
@@ -645,6 +645,7 @@ class AccessLogConfiguration(BaseSettings):
 class LoggingConfiguration(BaseSettings):
     application_logs: ApplicationLogConfiguration = ApplicationLogConfiguration()
     access_logs: AccessLogConfiguration = AccessLogConfiguration()
+    log_source_diffs: bool = False
 
 
 class ContextFileCache(BaseSettings):

{sovereign-1.0.0b101 → sovereign-1.0.0b103}/src/sovereign/sources/poller.py

@@ -1,3 +1,5 @@
+import json
+import uuid
 import asyncio
 import traceback
 from copy import deepcopy
@@ -7,11 +9,7 @@ from typing import Iterable, Any, Dict, List, Union, Type, Optional
 
 from glom import glom, PathAccessError
 
-from sovereign.schemas import (
-    ConfiguredSource,
-    SourceData,
-    Node,
-)
+from sovereign.schemas import ConfiguredSource, SourceData, Node, config
 from sovereign.utils.entry_point_loader import EntryPointLoader
 from sovereign.sources.lib import Source
 from sovereign.modifiers.lib import Modifier, GlobalModifier
@@ -36,6 +34,179 @@ Mods = Dict[str, Type[Modifier]]
 GMods = Dict[str, Type[GlobalModifier]]
 
 
+def _deep_diff(old, new, path="") -> list[dict[str, Any]]:
+    changes = []
+    
+    # handle add/remove
+    if (old, new) == (None, None):
+        return changes
+    elif old is None:
+        changes.append({
+            "op": "add",
+            "path": path,
+            "value": new
+        })
+        return changes
+    elif new is None:
+        changes.append({
+            "op": "remove", 
+            "path": path,
+            "old_value": old
+        })
+        return changes
+    
+    # handle completely different types
+    if type(old) is not type(new):
+        changes.append({
+            "op": "change",
+            "path": path,
+            "old_value": old,
+            "new_value": new
+        })
+        return changes
+    
+    # handle fields recursively
+    if isinstance(old, dict) and isinstance(new, dict):
+        all_keys = set(old.keys()) | set(new.keys())
+        
+        for key in sorted(all_keys):
+            old_val = old.get(key)
+            new_val = new.get(key)
+            
+            current_path = f"{path}.{key}" if path else key
+            
+            if key not in old:
+                changes.append({
+                    "op": "add",
+                    "path": current_path,
+                    "value": new_val
+                })
+            elif key not in new:
+                changes.append({
+                    "op": "remove",
+                    "path": current_path,
+                    "old_value": old_val
+                })
+            elif old_val != new_val:
+                nested_changes = _deep_diff(old_val, new_val, current_path)
+                changes.extend(nested_changes)
+    
+    # handle items recursively
+    elif isinstance(old, list) and isinstance(new, list):
+        max_len = max(len(old), len(new))
+        
+        for i in range(max_len):
+            current_path = f"{path}[{i}]" if path else f"[{i}]"
+            
+            if i >= len(old):
+                changes.append({
+                    "op": "add",
+                    "path": current_path,
+                    "value": new[i]
+                })
+            elif i >= len(new):
+                changes.append({
+                    "op": "remove",
+                    "path": current_path,
+                    "old_value": old[i]
+                })
+            elif old[i] != new[i]:
+                nested_changes = _deep_diff(old[i], new[i], current_path)
+                changes.extend(nested_changes)
+
+    # handle primitives
+    else:
+        if old != new:
+            changes.append({
+                "op": "change",
+                "path": path,
+                "old_value": old,
+                "new_value": new
+            })
+    
+    return changes
+
+
+def per_field_diff(old, new) -> list[dict[str, Any]]:
+    changes = []
+    max_len = max(len(old), len(new))
+
+    for i in range(max_len):
+        old_inst = old[i] if i < len(old) else None
+        new_inst = new[i] if i < len(new) else None
+
+        if old_inst is None:
+            changes.append({
+                "op": "add",
+                "path": f"[{i}]",
+                "value": new_inst
+            })
+        elif new_inst is None:
+            changes.append({
+                "op": "remove",
+                "path": f"[{i}]",
+                "old_value": old_inst
+            })
+        elif old_inst != new_inst:
+            # Use the deep diff with index prefix
+            field_changes = _deep_diff(old_inst, new_inst, f"[{i}]")
+            changes.extend(field_changes)
+
+    return changes
+
+
+def _gen_uuid(diff_summary: dict[str, Any]) -> str:
+    blob = json.dumps(diff_summary, sort_keys=True, separators=('', ''))
+    return str(uuid.uuid5(uuid.NAMESPACE_DNS, blob))
+
+
+def source_diff_summary(prev, curr) -> dict[str, Any]:
+    if prev is None:
+        summary = {
+            "type": "initial_load",
+            "scopes": {
+                scope: {"added": len(instances)}
+                for scope, instances in curr.scopes.items()
+                if instances
+            }
+        }
+    else:
+        summary = {
+            "type": "update",
+            "scopes": {}
+        }
+        
+        all_scopes = set(prev.scopes.keys()) | set(curr.scopes.keys())
+
+        for scope in sorted(all_scopes):
+            old = prev.scopes.get(scope, [])
+            new = curr.scopes.get(scope, [])
+
+            n_old = len(old)
+            n_new = len(new)
+
+            scope_changes = {}
+
+            if n_old == 0 and n_new > 0:
+                scope_changes["added"] = n_new
+            elif n_old > 0 and n_new == 0:
+                scope_changes["removed"] = n_old
+            elif old != new:
+                detailed_changes = per_field_diff(old, new)
+                if detailed_changes:
+                    scope_changes["field_changes"] = detailed_changes
+                    scope_changes["count_change"] = n_new - n_old
+
+            if scope_changes:
+                summary["scopes"][scope] = scope_changes
+
+        if not summary["scopes"]:
+            summary = {"type": "no_changes"}
+    
+    summary["uuid"] = _gen_uuid(summary)
+    return summary
+
+
 class SourcePoller:
     def __init__(
         self,
@@ -160,7 +331,10 @@ class SourcePoller:
         try:
             new = SourceData()
             for source in self.sources:
-                new.scopes[source.scope].extend(source.get())
+                scope = source.scope
+                if scope not in new.scopes:
+                    new.scopes[scope] = []
+                new.scopes[scope].extend(source.get())
         except Exception as e:
             self.logger.error(
                 event="Error while refreshing sources",
@@ -179,9 +353,25 @@ class SourcePoller:
         else:
             self.stats.increment("sources.refreshed")
             self.last_updated = datetime.now()
+            old_data = getattr(self, "source_data", None)
             self.instance_count = len(
                 [instance for scope in new.scopes.values() for instance in scope]
             )
+
+            if config.logging.log_source_diffs:
+                diff_summary = source_diff_summary(old_data, new)
+                # printing json directly because the logger is fucking stupid
+                print(
+                    json.dumps(
+                        dict(
+                            event="Sources refreshed with changes",
+                            level="info",
+                            diff=diff_summary,
+                            total_instances=self.instance_count,
+                        )
+                    )
+                )
+
             self.source_data = new
             return True
 
@@ -260,6 +450,8 @@ class SourcePoller:
                     or is_debug_request(node_value)
                 )
                 if match:
+                    if scope not in ret.scopes:
+                        ret.scopes[scope] = []
                     ret.scopes[scope].append(instance)
         return ret
 

{sovereign-1.0.0b101 → sovereign-1.0.0b103}/src/sovereign/templates/resources.html

@@ -14,6 +14,12 @@
       ];
       const resources = resourceNames.map((name, index) => ({ name: name, index: index }));
       let filteredResources = [...resources];
+
+      // Function to set envoy_version cookie and reload page
+      function setEnvoyVersion(version) {
+        document.cookie = `envoy_version=${version}; path=/ui/resources/; max-age=31536000`;
+        window.location.reload();
+      }
     </script>
     <style>
         #filterInput {
@@ -284,7 +290,7 @@
                             </div>
                             {% for v in available_versions %}
                                 <a class="dropdown-item{% if v == version %} is-active{% endif %}"
-                                   href="/ui/set-version?version={{ v }}">
+                                   href="#" onclick="setEnvoyVersion('{{ v }}'); return false;">
                                     {{ v.replace('_', '') }}
                                 </a>
                             {% endfor %}

{sovereign-1.0.0b101 → sovereign-1.0.0b103}/src/sovereign/views/api.py

@@ -11,6 +11,20 @@ from sovereign.utils.mock import mock_discovery_request
 router = APIRouter()
 
 
+def _traverse(data, prefix, expressions):
+    for key, value in data.items():
+        path = f"{prefix}.{key}" if prefix else key
+        if isinstance(value, dict):
+            yield from _traverse(value, path, expressions)
+        else:
+            yield f"{path}={value}"
+
+
+def expand_metadata_to_expr(m):
+    exprs = []
+    yield from _traverse(m, "", exprs)
+
+
 @router.get("/resources/{resource_type}", summary="Get resources for a given type")
 async def resource(
     resource_type: DiscoveryTypes = Path(title="xDS Resource type"),
@@ -19,16 +33,25 @@ async def resource(
     service_cluster: Optional[str] = Query("*", title="Envoy Service cluster"),
     region: Optional[str] = Query(None, title="Locality Zone"),
     version: Optional[str] = Query(None, title="Envoy Semantic Version"),
+    metadata: Optional[str] = Query(None, title="Envoy node metadata to filter by"),
 ) -> Response:
+    expressions = [f"cluster={service_cluster}"]
+    try:
+        metadata = json.loads(metadata or "{}")
+        for expr in expand_metadata_to_expr(metadata):
+            expressions.append(expr)
+    except Exception:
+        pass
     kwargs = dict(
         api_version=api_version,
         resource_type=DiscoveryTypes(resource_type).value,
         resource_names=resource_name,
         version=version,
         region=region,
-        expressions=[f"cluster={service_cluster}"],
+        expressions=expressions,
     )
     req = mock_discovery_request(**{k: v for k, v in kwargs.items() if v is not None})
+    print(req)
     response = await cache.blocking_read(req)
     if content := getattr(response, "text", None):
         return Response(content, media_type="application/json")

{sovereign-1.0.0b101 → sovereign-1.0.0b103}/src/sovereign/views/interface.py

@@ -5,7 +5,7 @@ from typing import Any, Dict, List
 from fastapi import APIRouter, Cookie, Path, Query
 from fastapi.encoders import jsonable_encoder
 from fastapi.requests import Request
-from fastapi.responses import HTMLResponse, JSONResponse, RedirectResponse, Response
+from fastapi.responses import HTMLResponse, JSONResponse, Response
 
 from sovereign import html_templates, cache
 from sovereign.schemas import DiscoveryTypes, XDS_TEMPLATES
@@ -18,6 +18,7 @@ all_types = [t.value for t in DiscoveryTypes]
 
 
 @router.get("/")
+@router.get("/resources")
 async def ui_main(request: Request) -> HTMLResponse:
     try:
         return html_templates.TemplateResponse(
@@ -42,21 +43,6 @@ async def ui_main(request: Request) -> HTMLResponse:
         )
 
 
-@router.get(
-    "/set-version", summary="Filter the UI by a certain Envoy Version (stores a Cookie)"
-)
-async def set_envoy_version(
-    request: Request,
-    version: str = Query(
-        "__any__", title="The clients envoy version to emulate in this XDS request"
-    ),
-) -> Response:
-    url = request.headers.get("Referer", "/ui")
-    response = RedirectResponse(url=url)
-    response.set_cookie(key="envoy_version", value=version)
-    return response
-
-
 @router.get(
     "/resources/{xds_type}", summary="List available resources for a given xDS type"
 )

{sovereign-1.0.0b101 → sovereign-1.0.0b103}/src/sovereign/worker.py

@@ -1,8 +1,7 @@
 import asyncio
 from typing import Optional
-from multiprocessing import Process
+from multiprocessing import Process, cpu_count
 from contextlib import asynccontextmanager
-from concurrent.futures import ThreadPoolExecutor
 
 from fastapi import FastAPI, Body
 
@@ -23,10 +22,9 @@ from sovereign.context import NEW_CONTEXT
 
 ClientId = str
 ONDEMAND: asyncio.Queue[tuple[ClientId, DiscoveryRequest]] = asyncio.Queue(100)
-executor = ThreadPoolExecutor(4)
+RENDER_SEMAPHORE = asyncio.Semaphore(cpu_count())
 
 
-# TODO: do something about this ---------------------------------------
 def hidden_field(*args, **kwargs):
     return "(value hidden)"
 
@@ -62,43 +60,37 @@ if config.sources is not None:
     context_middleware.append(poller.add_to_context)
 
 
-if poller is not None:
-    poller.lazy_load_modifiers(config.modifiers)
-    poller.lazy_load_global_modifiers(config.global_modifiers)
-
-template_context.middleware = context_middleware
-# ---------------------------------------------------------------------
-
-
 def render(job: rendering.RenderJob):
     log.debug(f"Spawning render process for {job.id}")
     Process(target=rendering.generate, args=[job]).start()
 
 
-def batch_render(jobs: list[rendering.RenderJob]):
-    log.debug("Spawning batch render process for all clients")
-    Process(target=rendering.batch_generate, args=[jobs]).start()
+async def submit_render(job: rendering.RenderJob):
+    async with RENDER_SEMAPHORE:
+        render(job)
 
 
 async def render_on_event():
     while True:
         # block forever until new context arrives
         await NEW_CONTEXT.wait()
-        stats.increment("template.render_on_event")
         log.debug("New context detected, re-rendering templates")
         try:
             if registered := cache.clients():
                 log.debug("New context detected, re-rendering templates")
-                batch_render(
-                    [
-                        rendering.RenderJob(
-                            id=client,
-                            request=request,
-                            context=template_context.get_context(request),
-                        )
-                        for client, request in registered
-                    ]
-                )
+                jobs = [
+                    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")
         finally:
             NEW_CONTEXT.clear()
 
@@ -111,7 +103,7 @@ async def render_on_demand():
         job = rendering.RenderJob(
             id=id, request=request, context=template_context.get_context(request)
         )
-        await asyncio.get_event_loop().run_in_executor(executor, render, job)
+        await submit_render(job)
         ONDEMAND.task_done()
 
 
@@ -124,25 +116,19 @@ async def lifespan(_: FastAPI):
 
     # Template context
     log.debug("Starting context loop")
+    template_context.middleware = context_middleware
     asyncio.create_task(template_context.start())
     await NEW_CONTEXT.wait()  # first refresh finished
 
     # Source polling
     if poller is not None:
         log.debug("Starting source poller")
-        import threading
-
-        threading.Thread(target=poller_thread, args=[poller], daemon=True).start()
+        poller.lazy_load_modifiers(config.modifiers)
+        poller.lazy_load_global_modifiers(config.global_modifiers)
+        asyncio.create_task(poller.poll_forever())
     yield
 
 
-def poller_thread(poller):
-    log.debug("Starting source poller")
-    loop = asyncio.new_event_loop()
-    asyncio.set_event_loop(loop)
-    loop.run_until_complete(poller.poll_forever())
-
-
 worker = FastAPI(lifespan=lifespan)
 try:
     import sentry_sdk