validio-sdk 0.22.0__tar.gz → 0.22.2__tar.gz

{validio_sdk-0.22.0 → validio_sdk-0.22.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: validio-sdk
-Version: 0.22.0
+Version: 0.22.2
 Summary: SDK to interact with the Validio platform
 Home-page: https://validio.io/
 License: Apache-2.0

{validio_sdk-0.22.0 → validio_sdk-0.22.2}/pyproject.toml

@@ -3,7 +3,7 @@ name = "validio-sdk"
 # This version does not represent the released version or any tag. For each
 # release we automatically bump this before building and publishing so this
 # should be kept at 0.0.1dev1
-version = "0.22.0"
+version = "0.22.2"
 description = "SDK to interact with the Validio platform"
 authors = ["Validio <support@validio.io>"]
 license = "Apache-2.0"

validio_sdk-0.22.2/validio_sdk/client/__init__.py

@@ -0,0 +1,3 @@
+from .client import Client, Session
+
+__all__ = ["Session", "Client"]

{validio_sdk-0.22.0 → validio_sdk-0.22.2}/validio_sdk/client/client.py

@@ -1,9 +1,15 @@
-"""A client used to send GraphQL requests with sensible defaults for Validio."""
+"""A client used to send GraphQL requests with sensible defaults for Validio.
+
+The client simply wraps a [gql.client.Client] and works the same way regarding
+sessions to support safe use of the client in parallel. More details can be
+found at https://gql.readthedocs.io/en/latest/advanced/async_advanced_usage.html
+"""
 
 from typing import Any
 
 from gql import Client as GqlClient
 from gql import gql
+from gql.client import AsyncClientSession
 from gql.transport.aiohttp import AIOHTTPTransport
 
 import validio_sdk.metadata
@@ -12,17 +18,55 @@ from validio_sdk.config import Config, ValidioConfig
 USER_AGENT = f"validio-sdk@{validio_sdk.metadata.version()}"
 
 
+class Session:
+    """A session to perform multiple requests.
+
+    **NOTE!** The client used in the examples below is in beta and breaking
+    changes may happen.
+
+    A session will support running multiple requests with the same client. It
+    will ensure the connection is open and not closed until the session goes out
+    of scope.
+    """
+
+    def __init__(self, session: AsyncClientSession):
+        """Constructor.
+
+        :params session: An `AsyncClientSession` created from a GraphQL client
+        """
+        self.session = session
+
+    async def execute(
+        self, query: str, variable_values: dict[str, Any] | None = None
+    ) -> Any:
+        """Execute a query in the session.
+
+        :param query: The query to be executed
+        :variable_values: Variable values if the query contains such
+        :returns: The API response
+        """
+        graphql_query = gql(query)
+        return await self.session.execute(
+            graphql_query, variable_values=variable_values
+        )
+
+
 class Client:
     """A GraphQL client with sensible defaults for Validio.
 
+    **NOTE!** The client used in the examples below is in beta and breaking
+    changes may happen.
+
     It will be created by reading the Validio configuration just like the CLI
     tool and ensure the correct headers are passed.
 
     If no `ValidioConfig` is passed when constructing the client, it will
     fallback to first look for required environment variables:
-        - `VALIDIO_ENDPOINT`
-        - `VALIDIO_ACCESS_KEY`
-        - `VALIDIO_CONFIG_PATH`
+
+    - `VALIDIO_ENDPOINT`
+    - `VALIDIO_ACCESS_KEY`
+    - `VALIDIO_SECRET_ACCESS_KEY`
+
     If not all of them are found, it will look for a configuration file. It will
     first look in the path set in `VALIDIO_CONFIG_PATH` and if that one is empty
     it will look in the default OS dependant system directory.
@@ -54,32 +98,33 @@ class Client:
 
         self.client = GqlClient(transport=transport, fetch_schema_from_transport=True)
 
-    def execute(
-        self,
-        query: str,
-        variable_values: dict[str, Any] | None = None,
-    ) -> Any:
-        """Execute a GraphQL request.
+    async def __aenter__(self):  # type: ignore
+        """Enter async context.
 
-        :param query: The query to be executed
-        :variable_values: Variable values if the query contains such
-        :returns: The API response
+        Will return a session to reuse transport for API calls. This is needed
+        to do concurrent requests to ensure the transport is opened, waits for
+        each request and don't close the connection before exiting the context.
         """
-        graphql_query = gql(query)
-        return self.client.execute(graphql_query, variable_values=variable_values)
+        session = await self.client.connect_async()  # type: ignore
+        return Session(session)
+
+    async def __aexit__(self, *args):  # type: ignore
+        """Exit context.
+
+        Will close the session.
+        """
+        await self.client.close_async()  # type: ignore
 
-    async def execute_async(
+    async def execute(
         self,
         query: str,
         variable_values: dict[str, Any] | None = None,
     ) -> Any:
-        """Execute a GraphQL request async.
+        """Execute a GraphQL request.
 
         :param query: The query to be executed
         :variable_values: Variable values if the query contains such
         :returns: The API response
         """
-        graphql_query = gql(query)
-        return await self.client.execute_async(
-            graphql_query, variable_values=variable_values
-        )
+        async with self as session:
+            return await session.execute(query, variable_values=variable_values)

{validio_sdk-0.22.0 → validio_sdk-0.22.2}/validio_sdk/resource/_diff.py

@@ -19,6 +19,7 @@ from validio_sdk.resource._errors import (
 from validio_sdk.resource._field_selector import SelectorWithFieldName
 from validio_sdk.resource._resource import DiffContext, Resource
 from validio_sdk.resource._util import SourceSchemaReinference, _sanitize_error
+from validio_sdk.resource.channels import Channel
 from validio_sdk.resource.credentials import Credential
 from validio_sdk.resource.replacement import (
     CascadeReplacementReason,
@@ -504,13 +505,30 @@ def diff(
     for field in manifest_object._mutable_fields():
         manifest = getattr(manifest_object, field)
         server = getattr(server_object, field)
+
         if manifest != server:
+            # This is a temporary fix to support marking secret fields as
+            # changed on a `Channel`. If the field is both in `_mutable_fields`
+            # and also in `_secret_fields` we will flag `secrets_changed` if
+            # there has been an update. This ensures that the value is redacted
+            # by default when displaying the config.
+            secrets_changed = False
+            if (
+                isinstance(manifest_object, Channel)
+                and field in manifest_object._secret_fields()
+            ):
+                secrets_changed = True
+
             # Whenever we find there's a change to make, grab all fields on both
             # resource versions so that we can present them as a diff.
             # Regardless of at what depth we find a change, the diff we present
             # will always start from the root resource itself. We pass those objects
             # around for this purpose.
-            return ResourceUpdate(manifest_resource, server_resource)
+            return ResourceUpdate(
+                manifest_resource,
+                server_resource,
+                secrets_changed=secrets_changed,
+            )
 
     # Some fields require the resource to be re-created if the type changes
     # e.g. going from a dynamic to a fixed threshold is not allowed.

{validio_sdk-0.22.0 → validio_sdk-0.22.2}/validio_sdk/resource/channels.py

@@ -1,5 +1,6 @@
 """Notification Channels."""
 
+from abc import abstractmethod
 from typing import TYPE_CHECKING, Any, cast
 
 from validio_sdk.graphql_client.input_types import ChannelDeleteInput
@@ -51,6 +52,23 @@ class Channel(Resource):
         self._resource_graph: ResourceGraph = g
         self._resource_graph._add_root(self)
 
+    @abstractmethod
+    def _secret_fields(self) -> set[str]:
+        """Set secret fields for Channels.
+
+        Channels doesn't implement secret fields like credentials in that sense
+        that we still get the values from the server when we pull resources.
+        Because of that we can easily compute diff but we need to be able to
+        mark the field as `REDACTED` in the diff.
+
+        **NOTE**: This will only work if the field is _also_ added to
+        `_mutable_fields` because the check for changes happens when comparing
+        a changed field.
+
+        This is a temporary workaround until we stop returning secrets from the
+        server.
+        """
+
     def _immutable_fields(self) -> set[str]:
         return set({})
 
@@ -150,6 +168,9 @@ class SlackChannel(Channel):
 
         self.timezone = timezone
 
+    def _secret_fields(self) -> set[str]:
+        return {"webhook_url"}
+
     def _immutable_fields(self) -> set[str]:
         return set({})
 
@@ -203,6 +224,9 @@ class MsTeamsChannel(Channel):
 
         self.timezone = timezone
 
+    def _secret_fields(self) -> set[str]:
+        return {"webhook_url"}
+
     def _immutable_fields(self) -> set[str]:
         return set({})
 
@@ -252,6 +276,9 @@ class WebhookChannel(Channel):
         self.webhook_url = webhook_url
         self.auth_header = auth_header
 
+    def _secret_fields(self) -> set[str]:
+        return {"auth_header", "webhook_url"}
+
     def _immutable_fields(self) -> set[str]:
         return set({})
 

validio_sdk-0.22.0/validio_sdk/client/__init__.py

@@ -1,3 +0,0 @@
-from .client import Client
-
-__all__ = ["Client"]