sovereign 0.29.1__py3-none-any.whl → 0.29.3__py3-none-any.whl

sovereign/discovery.py

@@ -99,11 +99,12 @@ def response(request: DiscoveryRequest, xds_type: str) -> ProcessedTemplate:
     :return: An envoy Discovery Response
     """
     template: XdsTemplate = select_template(request, xds_type)
+    node_context = template_context.get_context(request, template)
     context = dict(
         discovery_request=request,
         host_header=request.desired_controlplane,
         resource_names=request.resources,
-        **template_context.get_context(request, template),
+        **node_context,
     )
     content = template(**context)
 
@@ -118,12 +119,28 @@ def response(request: DiscoveryRequest, xds_type: str) -> ProcessedTemplate:
     # Early return if the template is identical
     config_version = compute_hash(content)
     if config_version == request.version_info and not config.discovery_cache.enabled:
-        return ProcessedTemplate(version_info=config_version, resources=[])
+        return ProcessedTemplate(
+            version_info=config_version,
+            resources=[],
+            metadata=[
+                "Detail: no changes",
+                f"Template used: {template}",
+                f"Template memory address: {hex(id(template))}",
+            ],
+        )
 
     if not isinstance(content, dict):
         raise RuntimeError(f"Attempting to filter unstructured data: {content}")
     resources = filter_resources(content["resources"], request.resources)
-    return ProcessedTemplate(resources=resources, version_info=config_version)
+    return ProcessedTemplate(
+        resources=resources,
+        version_info=config_version,
+        metadata=[
+            "Detail: new resources generated",
+            f"Template used: {template}",
+            f"Template memory address: {hex(id(template))}",
+        ],
+    )
 
 
 def deserialize_config(content: str) -> Dict[str, Any]:

sovereign/schemas.py

@@ -142,6 +142,7 @@ class XdsTemplate:
         self.source = self.load_source()
         template_ast = jinja_env.parse(self.source)
         self.jinja_variables = meta.find_undeclared_variables(template_ast)
+        self._repr = f"XdsTemplate({self.loadable=})"
 
     def __call__(
         self, *args: Any, **kwargs: Any
@@ -192,7 +193,7 @@ class XdsTemplate:
         return str(ret)
 
     def __repr__(self) -> str:
-        return f"XdsTemplate({self.loadable=}, {self.is_python_source=}, {self.source=}, {self.jinja_variables=})"
+        return self._repr
 
 
 class ProcessedTemplate:
@@ -200,10 +201,14 @@ class ProcessedTemplate:
         self,
         resources: List[Dict[str, Any]],
         version_info: Optional[str],
+        metadata: Optional[List[str]] = None,
     ) -> None:
         self.resources = resources
         self.version_info = version_info
         self._rendered: Optional[bytes] = None
+        if metadata == None:
+            metadata = []
+        self.metadata = metadata
 
     @property
     def version(self) -> str:
@@ -295,9 +300,7 @@ class Resources(List[str]):
     """
 
     def __contains__(self, item: object) -> bool:
-        if (
-            len(self) == 0
-        ):  # TODO: refactor to remove overriding __contains__; its being used in multiple places
+        if len(self) == 0:
             return True
         return super().__contains__(item)
 
@@ -308,17 +311,13 @@ class Status(BaseModel):
     details: List[Any]
 
 
-def resources_factory() -> Resources:
-    return Resources()
-
-
 class DiscoveryRequest(BaseModel):
     node: Node = Field(..., title="Node information about the envoy proxy")
     version_info: str = Field(
         "0", title="The version of the envoy clients current configuration"
     )
-    resource_names: Resources = Field(
-        default_factory=resources_factory, title="List of requested resource names"
+    resource_names: List[str] = Field(
+        default_factory=list, title="List of requested resource names"
     )
     hide_private_keys: bool = False
     type_url: Optional[str] = Field(
@@ -360,11 +359,6 @@ class DiscoveryRequest(BaseModel):
             self.desired_controlplane,
         )
 
-    @field_validator("resource_names", mode="before")
-    @classmethod
-    def validate_resources(cls, v: Union[Resources, List[str]]) -> Resources:
-        return Resources(v)
-
 
 class DiscoveryResponse(BaseModel):
     version_info: str = Field(

sovereign/templates/resources.html

@@ -60,6 +60,8 @@
         </p>
     </div>
 
+    {% set count = resources|length %}
+    {% if count > 0 %}
     <nav class="panel is-dark" id="resources">
         <p class="panel-heading">
             {{ resource_type|capitalize }}
@@ -82,7 +84,6 @@
         </div>
 
         {% set res = resources|selectattr('get')|list %}
-        {% set count = res|length %}
         {% set plural = {
             0: 'resources',
             1: 'resource'
@@ -95,7 +96,9 @@
                 <div class="notification is-danger">
                     {{ resource["sovereign_error"] }}
                 </div>
+                <pre>
                 {{ resource["sovereign_error"] }}
+                </pre>
             {% else %}
             {% set name = resource.get('name') or resource['cluster_name'] %}
             <a class="panel-block has-text-weight-medium"
@@ -107,59 +110,84 @@
                 </a>
             {% endif %}
         {% endfor %}
-        <div class="panel-block">
-            <p class="content is-small">
-                {{ count }} {{ plural.get(count, 'resources') }}
-            </p>
-        </div>
-    </nav>
-
-    {% if resource_type == 'routes' %}
-        <nav class="panel" id="virtual_hosts">
-            <p class="panel-heading">
-                Virtual Hosts
-            </p>
             <div class="panel-block">
-                <p class="control has-icons-left">
-                    <label for="search_filter_virtual_hosts">
-                        <input
-                                class="input"
-                                type="text"
-                                id="search_filter_virtual_hosts"
-                                onkeyup="filter_results('search_filter_virtual_hosts', 'virtual_hosts')"
-                                placeholder="Filter resources by any string"
-                        >
-                    </label>
-                    <span class="icon is-left">
-                <i class="fas fa-search" aria-hidden="true"></i>
-            </span>
+                <p class="content is-small">
+                    {{ count }} {{ plural.get(count, 'resources') }}
                 </p>
             </div>
+        </nav>
 
-            {% set vs_count = 0 %}
+        {% if resource_type == 'routes' %}
             {% for resource in res %}
-                {% set vs_len = resource['virtual_hosts']|length %}
-                {% set vs_count = vs_count + vs_len %}
-                {% for virtualhost in resource['virtual_hosts'] %}
-                    {% if loop.first and loop.last %}
-                        {# A single virtualhost makes no sense to render. It will be in one of the routes above. #}
-                    {% else %}
+                <nav class="panel" id="virtual_hosts">
+                    <p class="panel-heading">
+                    Virtual Hosts (Route Configuration: {{ resource["name"] }})
+                    </p>
+                    <div class="panel-block">
+                        <p class="control has-icons-left">
+                            <label for="search_filter_virtual_hosts">
+                                <input
+                                        class="input"
+                                        type="text"
+                                        id="search_filter_virtual_hosts"
+                                        onkeyup="filter_results('search_filter_virtual_hosts', 'virtual_hosts')"
+                                        placeholder="Filter resources by any string"
+                                >
+                            </label>
+                            <span class="icon is-left">
+                        <i class="fas fa-search" aria-hidden="true"></i>
+                    </span>
+                        </p>
+                    </div>
+
+                    {% for virtualhost in resource['virtual_hosts'] %}
                         <a class="panel-block"
                            href="/ui/resources/routes/{{ resource['name'] }}/{{ virtualhost['name'] }}">
-            <span class="panel-icon">
-                <i class="fas fa-arrow-right" aria-hidden="true"></i>
-            </span>
+                        <span class="panel-icon">
+                            <i class="fas fa-arrow-right" aria-hidden="true"></i>
+                        </span>
                             {{ virtualhost['name'] }}
                         </a>
-                    {% endif %}
-                {% endfor %}
+                    {% endfor %}
+                </nav>
             {% endfor %}
-            <div class="panel-block">
-                <p class="content is-small">
-                    {{ vs_count }} {{ plural.get(vs_count, 'resources') }}
-                </p>
-            </div>
-        </nav>
+        {% endif %}
+    {% else %}
+        <span class="panel-icon">
+            <i class="fas fa-arrow-right" aria-hidden="true"></i>
+        </span>
+        <div class="notification is-danger">
+            No resources found
+        </div>
+    {% endif %}
+    {% if show_debuginfo %}
+    <pre>
+    {%- if discovery_request != None %}
+    ---
+    DiscoveryRequest:
+      Node:
+        Id: {{ discovery_request.node.id }}
+        Cluster: {{ discovery_request.node.cluster }}
+        Metadata: {{ discovery_request.node.metadata }}
+        Locality: {{ discovery_request.node.locality }}
+        Build Version: {{ discovery_request.node.build_version }}
+      Version Info: {{ discovery_request.version_info }}
+      Resource Names: {{ discovery_request.resources or "*" }}
+      # Sovereign-generated fields
+      Envoy Version: {{ discovery_request.envoy_version }}
+      Client Uid: {{ discovery_request.uid }}
+      Host Header: {{ discovery_request.desired_controlplane }}
+    {%- endif %}
+    {%- if discovery_response != None %}
+    ---
+    DiscoveryResponse:
+      Metadata:
+        {%- for line in discovery_response.metadata %}
+        {{ line }}
+        {%- endfor %}
+      Config version: {{ discovery_response.version }}
+    {%- endif %}
+    </pre>
     {% endif %}
 {% endblock -%}
 {% block footer %}

sovereign/utils/mock.py

@@ -1,6 +1,6 @@
 from typing import Optional, Dict, List
 from random import randint
-from sovereign.schemas import DiscoveryRequest, Node, Locality, Resources, Status
+from sovereign.schemas import DiscoveryRequest, Node, Locality, Status
 
 
 def mock_discovery_request(
@@ -12,9 +12,7 @@ def mock_discovery_request(
     error_message: Optional[str] = None,
 ) -> DiscoveryRequest:
     if resource_names is None:
-        resource_names = Resources()
-    else:
-        resource_names = Resources(resource_names)
+        resource_names = []
     request = DiscoveryRequest(
         type_url=None,
         node=Node(

sovereign/views/admin.py

@@ -6,7 +6,6 @@ from fastapi.responses import JSONResponse
 from fastapi.encoders import jsonable_encoder
 from sovereign import config, stats, poller, template_context
 from sovereign.discovery import select_template
-from sovereign.schemas import Resources
 from sovereign.utils.mock import mock_discovery_request
 from sovereign.views.discovery import perform_discovery
 
@@ -32,7 +31,7 @@ async def display_config(
     ret: Dict[str, List[Dict[str, Any]]] = defaultdict(list)
     mock_request = mock_discovery_request(
         service_cluster=service_cluster,
-        resource_names=Resources(resource_names),
+        resource_names=resource_names,
         version=version,
         region=region,
     )

sovereign/views/discovery.py

@@ -123,18 +123,18 @@ async def perform_discovery(
             api_version,
             resource_type,
             req.envoy_version,
-            req.resource_names,
+            req.resources,
             req.desired_controlplane,
             req.hide_private_keys,
             req.type_url,
             req.node.cluster,
             req.node.locality,
+            # TODO: this is very bad and everyone should feel bad. Remove this in the next breaking release
             req.node.metadata.get("auth", None),
             req.node.metadata.get("num_cpus", None),
-        ] + extra_metadata
-
+        ]
+        hash_keys += extra_metadata
         cache_key = compute_hash(hash_keys)
-
         if template := await cache.get(key=cache_key, default=None):
             logs.access_logger.queue_log_fields(CACHE_XDS_HIT=True)
             return template  # type: ignore[no-any-return]

sovereign/views/interface.py

@@ -89,16 +89,18 @@ async def resources(
     envoy_version: str = Cookie(
         "__any__", title="The clients envoy version to emulate in this XDS request"
     ),
+    debug: str = Query(0, title="Show debug information on errors"),
 ) -> HTMLResponse:
     ret: Dict[str, List[Dict[str, Any]]] = defaultdict(list)
+    response = None
+    mock_request = mock_discovery_request(
+        service_cluster=service_cluster,
+        version=envoy_version,
+        region=region,
+    )
     try:
         response = await perform_discovery(
-            req=mock_discovery_request(
-                service_cluster=service_cluster,
-                resource_names=[],
-                version=envoy_version,
-                region=region,
-            ),
+            req=mock_request,
             api_version=api_version,
             resource_type=xds_type,
             skip_auth=True,
@@ -106,12 +108,15 @@ async def resources(
     except KeyError as e:
         ret["resources"] = [{"sovereign_error": str(e)}]
     else:
-        ret["resources"] += response.deserialize_resources()
+        ret["resources"] = response.deserialize_resources()
     return html_templates.TemplateResponse(
         request=request,
         name="resources.html",
         media_type="text/html",
         context={
+            "show_debuginfo": True if debug else False,
+            "discovery_response": response,
+            "discovery_request": mock_request,
             "resources": ret["resources"],
             "resource_type": xds_type,
             "all_types": all_types,

{sovereign-0.29.1.dist-info → sovereign-0.29.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sovereign
-Version: 0.29.1
+Version: 0.29.3
 Summary: Envoy Proxy control-plane written in Python
 Home-page: https://pypi.org/project/sovereign/
 License: Apache-2.0
@@ -38,7 +38,7 @@ Requires-Dist: cachelib (>=0.10.2,<0.11.0)
 Requires-Dist: cachetools (>=5.3.2,<6.0.0)
 Requires-Dist: cashews[redis] (>=6.3.0,<7.0.0) ; extra == "caching"
 Requires-Dist: croniter (>=1.4.1,<2.0.0)
-Requires-Dist: cryptography (>=43.0.1,<44.0.0)
+Requires-Dist: cryptography (>=42.0.0,<43.0.0)
 Requires-Dist: datadog (>=0.47.0,<0.48.0) ; extra == "statsd"
 Requires-Dist: fastapi (>=0.110.0,<0.111.0)
 Requires-Dist: glom (>=23.3.0,<24.0.0)

{sovereign-0.29.1.dist-info → sovereign-0.29.3.dist-info}/RECORD

@@ -3,7 +3,7 @@ sovereign/app.py,sha256=udDhuprAcJdYNgXufl94-oh-G74H9hXVzr8cKhgdQYI,4087
 sovereign/configuration.py,sha256=BCezlWYIpTsFRZwQIBwU-XrfBk1MdjTKMLA8huN-VPg,2484
 sovereign/constants.py,sha256=qdWD1lTvkaW5JGF7TmZhfksQHlRAJFVqbG7v6JQA9k8,46
 sovereign/context.py,sha256=Vwr-Jmo1I_05rFraxv6GoYEC83oFl87LG16px4R7IfA,6461
-sovereign/discovery.py,sha256=KHnWXUlceUglbR9eV5Q6LjPOpGv2dcrGOSus9-QLQJM,5952
+sovereign/discovery.py,sha256=LrgrojgehyZIObZl4wICi_s5PHwIl73wSym3tSNBkfI,6409
 sovereign/dynamic_config/__init__.py,sha256=QoRNcuCAqV26zeyHm0iavsR55K3TwMohabWpPGIq_rM,2838
 sovereign/dynamic_config/deser.py,sha256=CYTP9UNx8falCXU_bEaWGNatyQlYrV4T57NPXNhTn0o,1842
 sovereign/dynamic_config/loaders.py,sha256=HxDT-6hlqg_ewPjrFu2RaWi6O1mmJ_Mpnu8AQk_enNg,2923
@@ -17,7 +17,7 @@ sovereign/middlewares.py,sha256=UoLdfhqMj_E6jXgtr-n0maQIBYe9n95s3BwaQZfebHo,3097
 sovereign/modifiers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sovereign/modifiers/lib.py,sha256=DbXsxrrjnFE4Y7rbwpeiM5tS5w5NBwSdYH58AtDTP0I,2884
 sovereign/response_class.py,sha256=beMAFV-4L6DwyWzJzy71GkEW4gb7fzH1jd8-Tul13cU,427
-sovereign/schemas.py,sha256=nkpMVLwdtODmyfbwu5PEExxFKFLY3H0Oj4mqB9HJnfI,31552
+sovereign/schemas.py,sha256=NfbBub6Fnozrb-cQNwchwIH0FRlVozycOhmm6Vyqpb4,31286
 sovereign/server.py,sha256=z8Uz1UYIZix0S40Srk774WIMDN2jl2SozO8irib0wc4,1402
 sovereign/sources/__init__.py,sha256=g9hEpFk8j5i1ApHQpbc9giTyJW41Ppgsqv5P9zGxOJk,78
 sovereign/sources/file.py,sha256=prUThsDCSPNwZaZpkKXhAm-GVRZWbBoGKGU0It4HHXs,690
@@ -29,7 +29,7 @@ sovereign/static/style.css,sha256=vG8HPsbCbPIZfHgy7gSeof97Pnp0okkyaXyJzIEEW-8,44
 sovereign/statistics.py,sha256=Xfj4oWMfCkbYc2ibF7rDUpbw6Zw6dI4N5BpCLDQc4j4,2336
 sovereign/templates/base.html,sha256=5vw3-NmN291pXRdArpCwhSce9bAYBWCJVRhvO5EmE9g,2296
 sovereign/templates/err.html,sha256=a3cEzOqyqWOIe3YxfTEjkxbTfxBxq1knD6GwzEFljfs,603
-sovereign/templates/resources.html,sha256=r67x1FeUgczh-0JlwFFu-qG_b2u9t-_P_If9jlKg2ZI,6832
+sovereign/templates/resources.html,sha256=_mcqw3POMEI0uWR4xF1QlCsdmzgWheYT5zklJhHdPqE,7857
 sovereign/templates/ul_filter.html,sha256=LrzZv5408Qq5UP4lcHVRwY2G6lXd3IiSNiJn1aH7Yqo,666
 sovereign/testing/loaders.py,sha256=mcmErhI9ZkJUBZl8jv2qP-PCBRFeAIgyBFlfCgU4Vvk,199
 sovereign/testing/modifiers.py,sha256=7_c2hWXn_sYJ6997N1_uSWtClOikcOzu1yRCY56-l-4,361
@@ -46,20 +46,20 @@ sovereign/utils/crypto/suites/fernet_cipher.py,sha256=rP6M5ys1vctyadOxDGNFoyerWP
 sovereign/utils/dictupdate.py,sha256=JkDjg16u7sW6A_4Q2oX1PY_MtJU7m1VivZWn9VLZ9V8,2559
 sovereign/utils/eds.py,sha256=sCEDj1y-0Crs40cHZLiPGVb7ed1f8vFqgHLY5R2LMbw,4377
 sovereign/utils/entry_point_loader.py,sha256=BEVodk-um70RvT1nSOu_IB-hr1K4ppthXod0VZEiZJ8,526
-sovereign/utils/mock.py,sha256=s2LS8RzGjwIqsgDPQnpQs6W39hehq88II0dOefvoq0w,1342
+sovereign/utils/mock.py,sha256=M4hvNKSS3c4wYwHgVaHtwMspoufzZR4rCx_3TB-HD4U,1261
 sovereign/utils/resources.py,sha256=rPrWgcIt4YhV-Dz88_kr5WrQNiSKt-jTlOZ8EIJxJx8,472
 sovereign/utils/templates.py,sha256=FE_H_oE7VrS3X_VN1z_g10b9-rpmi1_gL-cMxi5XtXU,1057
 sovereign/utils/timer.py,sha256=_dUtEasj0BKbWYuQ_T3HFIyjurXXj-La-dNSMAwKMSo,795
 sovereign/utils/version_info.py,sha256=vbAiUyz6v3-zSOoS-7HwrvJie729RgIKy0Bt091Z6RE,349
 sovereign/utils/weighted_clusters.py,sha256=bPzuRE7Qgvv04HcR2AhMDvBrFlZ8AfteweLKhY9SvWg,1166
 sovereign/views/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sovereign/views/admin.py,sha256=9jUI3YqaU42AtzCCOCKDcfj_2JXoaMU6eOAD6WYPjoI,4312
+sovereign/views/admin.py,sha256=DlazEqI8P9M3h1llVUgRoAnUlmjYH3f1UZnrQmzLXI8,4261
 sovereign/views/crypto.py,sha256=o8NSyiUBy7v1pMOXt_1UBi68FNcGkXSlEVg9C18y8kY,3324
-sovereign/views/discovery.py,sha256=9TyXfS3nW7I7Bkeg-KdsTeCm1N9WSCvDj_pTAi1V4bo,6067
+sovereign/views/discovery.py,sha256=BmsHsBe_N33_VahkLQda3CfuIqJZAHSA0Bndg9KagQM,6187
 sovereign/views/healthchecks.py,sha256=_WkMunlrFpqGTLgtNtRr7gCsDCv5kiuYxCyTi-dMEKM,1357
-sovereign/views/interface.py,sha256=TFXbYp5oXZPRkVnAo-NWQFBb8XMtB519FaV78ludCcI,7055
-sovereign-0.29.1.dist-info/LICENSE.txt,sha256=2X125zvAb9AYLjCgdMDQZuufhm0kwcg31A8pGKj_-VY,560
-sovereign-0.29.1.dist-info/METADATA,sha256=L-Jn-sqfELFxS3Pu-VuG7tM6ZHvt1-j3uyXhtH4MpC0,6607
-sovereign-0.29.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-sovereign-0.29.1.dist-info/entry_points.txt,sha256=2mUHQjqeXEokMF6ZjDmvqQ9Fxk-Or2S4eC0h70ZxKmk,1201
-sovereign-0.29.1.dist-info/RECORD,,
+sovereign/views/interface.py,sha256=MRn4HN7Ngo4H2Ha6LCPCimUqI9Q95XTtan0pzmvISus,7255
+sovereign-0.29.3.dist-info/LICENSE.txt,sha256=2X125zvAb9AYLjCgdMDQZuufhm0kwcg31A8pGKj_-VY,560
+sovereign-0.29.3.dist-info/METADATA,sha256=AivJbWTs_OkESWdv3x0BLvuGiIQDIm4AqMX3U1QadJ0,6607
+sovereign-0.29.3.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+sovereign-0.29.3.dist-info/entry_points.txt,sha256=2mUHQjqeXEokMF6ZjDmvqQ9Fxk-Or2S4eC0h70ZxKmk,1201
+sovereign-0.29.3.dist-info/RECORD,,