validio-sdk 5.3.0__tar.gz → 5.3.1__tar.gz

{validio_sdk-5.3.0 → validio_sdk-5.3.1}/PKG-INFO

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

{validio_sdk-5.3.0 → validio_sdk-5.3.1}/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 = "5.3.0"
+version = "5.3.1"
 description = "SDK to interact with the Validio platform"
 authors = ["Validio <support@validio.io>"]
 license = "Apache-2.0"

{validio_sdk-5.3.0 → validio_sdk-5.3.1}/validio_sdk/_api/api.py

@@ -1194,7 +1194,6 @@ async def get_channels(
       }
       ... on SlackChannel {
         config {
-          slackWebhookUrl: webhookUrl
           applicationLinkUrl
           slackChannelId
           interactiveMessageEnabled
@@ -1207,7 +1206,6 @@ async def get_channels(
       }
       ... on MsTeamsChannel {
         config {
-          msTeamsWebhookUrl: webhookUrl
           applicationLinkUrl
           msTeamsChannelId
           msTeamsInteractiveMessageEnabled: interactiveMessageEnabled
@@ -1276,8 +1274,6 @@ async def get_channels(
         _replace_aliases(
             ftr["config"],
             [
-                ("slackWebhookUrl", "webhookUrl"),
-                ("msTeamsWebhookUrl", "webhookUrl"),
                 ("msTeamsInteractiveMessageEnabled", "interactiveMessageEnabled"),
                 ("emailInteractiveMessageEnabled", "interactiveMessageEnabled"),
             ],

{validio_sdk-5.3.0 → validio_sdk-5.3.1}/validio_sdk/code/_import.py

@@ -277,7 +277,7 @@ async def _import(
             ("tags", resource_tags(r), None),
         ]
 
-        if v._filter_resource_mode() and v.filter_name:
+        if v.filter_name:
             filter_ = import_ctx.get_variable(Filter, v.filter_name)
             inits.append(("filter", filter_, None))
 

{validio_sdk-5.3.0 → validio_sdk-5.3.1}/validio_sdk/code/plan.py

@@ -24,7 +24,7 @@ from validio_sdk.resource._resource import (
 )
 from validio_sdk.resource._server_resources import load_resources
 from validio_sdk.resource._util import SourceSchemaReinference
-from validio_sdk.resource.channels import Channel, WebhookChannel
+from validio_sdk.resource.channels import WebhookChannel
 from validio_sdk.resource.tags import Tag
 
 
@@ -286,10 +286,6 @@ def _create_resource_diff_object(
     if not show_secrets and hasattr(r, "_secret_fields"):
         secret_fields = r._secret_fields()
 
-        # Workaround for Channel having a special secret field
-        if isinstance(r, Channel):
-            secret_fields.update(r._deprecated_secret_fields())
-
         if secret_fields:
             for field in secret_fields:
                 # We want to avoid overriding webhook_url if it is None already

{validio_sdk-5.3.0 → validio_sdk-5.3.1}/validio_sdk/resource/_diff.py

@@ -26,7 +26,6 @@ from validio_sdk.resource._errors import (
 )
 from validio_sdk.resource._resource import CREATE_ONLY_RESOURCES, DiffContext, Resource
 from validio_sdk.resource._util import SourceSchemaReinference, _sanitize_error
-from validio_sdk.resource.channels import Channel
 from validio_sdk.resource.replacement import (
     CascadeReplacementReason,
     ImmutableFieldReplacementReason,
@@ -36,7 +35,6 @@ from validio_sdk.resource.replacement import (
 from validio_sdk.resource.segmentations import Segmentation
 from validio_sdk.resource.sources import Source
 from validio_sdk.resource.tags import Tag
-from validio_sdk.resource.validators import Reference, Validator
 from validio_sdk.resource.windows import TumblingWindow
 
 if TYPE_CHECKING:
@@ -254,8 +252,7 @@ def _visit_resource_to_replace(
     to_delete: dict[str, Resource] = getattr(graph_diff.to_delete, resource_type)
 
     # Remove the resource from the update list.
-    if resource_name in to_update:
-        del to_update[resource_name]
+    to_update.pop(resource_name, None)
 
     # Flag the resource to be created.
     manifest_resources: dict[str, Resource] = getattr(manifest_ctx, resource_type)
@@ -566,23 +563,6 @@ def diff(
     if isinstance(manifest_object, Resource) and manifest_object.ignore_changes:
         return None
 
-    # NOTE: Backwards compatibility while we transition to Filter resources.
-    # If we're about to diff a validator where the manifest validator still uses
-    # the JSONFilterExpression mode, then force the server object to work
-    # in the JSONFilterExpression mode so that we can compare the same fields.
-    # Same for validator reference.
-    if (
-        isinstance(manifest_object, (Reference, Validator))
-        and
-        # NOTE: the server resource is always the Validator. Even if
-        # the server object is potentially the nested 'Reference'.
-        # This is mostly for type-checking.
-        isinstance(server_resource, Validator)
-        and isinstance(manifest_resource, Validator)
-    ) and not manifest_object._filter_resource_mode():
-        manifest_resource._force_filter_expression_mode()
-        server_resource._force_filter_expression_mode()
-
     if isinstance(server_resource, Segmentation) and isinstance(
         manifest_resource, Segmentation
     ):
@@ -642,20 +622,6 @@ def diff(
         server = getattr(server_object, field)
 
         if manifest != server:
-            # This is a temporary fix to support marking deprecated secret fields as
-            # changed on a `Channel`. If the field is both in `_mutable_fields`
-            # and also in `_deprecated_secret_fields` we will flag the field in
-            # `secret_fields_changed` if there has been an update. This ensures
-            # that the value is redacted by default when displaying the config.
-            secret_fields_changed = None
-            if (
-                isinstance(manifest_object, Channel)
-                and field in manifest_object._deprecated_secret_fields()
-            ):
-                secret_fields_changed = {
-                    field: 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
@@ -664,7 +630,6 @@ def diff(
             return ResourceUpdate(
                 manifest_resource,
                 server_resource,
-                secret_fields_changed=secret_fields_changed,
             )
 
     # Some fields require the resource to be re-created if the type changes

{validio_sdk-5.3.0 → validio_sdk-5.3.1}/validio_sdk/resource/_server_resources.py

@@ -498,7 +498,6 @@ async def load_channels(
 
         cfg = ch["config"]
         application_link_url = cfg["applicationLinkUrl"]
-        unset_or_none = None if cfg.get("webhookUrl") else "UNSET"
         interactive_message_enabled = cfg.get("interactiveMessageEnabled", None)
         display_name = ch["name"]
         # The 'secret' parts of a channel are left unset since they are not
@@ -509,10 +508,9 @@ async def load_channels(
                     name=name,
                     application_link_url=application_link_url,
                     ms_teams_channel_id=cfg["msTeamsChannelId"],
-                    client_id=unset_or_none,
-                    client_secret=unset_or_none,
+                    client_id="UNSET",
+                    client_secret="UNSET",
                     interactive_message_enabled=interactive_message_enabled,
-                    webhook_url=cfg["webhookUrl"],
                     display_name=display_name,
                     __internal__=g,
                 )
@@ -521,11 +519,10 @@ async def load_channels(
                     name=name,
                     application_link_url=application_link_url,
                     slack_channel_id=cfg["slackChannelId"],
-                    token=unset_or_none,
-                    signing_secret=unset_or_none,
-                    app_token=unset_or_none,
+                    token="UNSET",
+                    signing_secret="UNSET",
+                    app_token="UNSET",
                     interactive_message_enabled=interactive_message_enabled,
-                    webhook_url=cfg["webhookUrl"],
                     display_name=display_name,
                     __internal__=g,
                 )

{validio_sdk-5.3.0 → validio_sdk-5.3.1}/validio_sdk/resource/channels.py

@@ -5,7 +5,6 @@ from typing import TYPE_CHECKING, Any, Optional, Union, cast
 
 from camel_converter import to_camel
 
-from validio_sdk.resource._errors import ManifestConfigurationError
 from validio_sdk.resource._resource import (
     ApiSecretChangeNestedResource,
     Resource,
@@ -69,13 +68,6 @@ class Channel(Resource):
         self._resource_graph: ResourceGraph = g
         self._resource_graph._add_root(self)
 
-    def _deprecated_secret_fields(self) -> set[str]:
-        """Fields that are not supported when calling the secrets changed endpoint.
-
-        :return: Set of secret fields that are deprecated
-        """
-        return set({})
-
     def _immutable_fields(self) -> set[str]:
         return set({})
 
@@ -107,7 +99,8 @@ class Channel(Resource):
             },
         }
         return _api_create_input_params(
-            resource=self, overrides=overrides, skip_fields=self._api_skip_fields()
+            resource=self,
+            overrides=overrides,
         )
 
     def _api_update_input(self, _namespace: str, _ctx: "DiffContext") -> Any:
@@ -118,16 +111,10 @@ class Channel(Resource):
             }
         }
         return _api_update_input_params(
-            resource=self, overrides=overrides, skip_fields=self._api_skip_fields()
+            resource=self,
+            overrides=overrides,
         )
 
-    def _api_skip_fields(self) -> set[str]:
-        return {
-            to_camel(f)
-            for f in self._deprecated_secret_fields()
-            if not getattr(self, f, None)
-        }
-
     @staticmethod
     def _decode(
         ctx: "DiffContext",
@@ -166,15 +153,6 @@ class Channel(Resource):
 
         return channel
 
-    def _api_secret_change_response(
-        self,
-    ) -> dict[str, None | ApiSecretChangeNestedResource]:
-        fields = super()._api_secret_change_response()
-        for secret_field in self._deprecated_secret_fields():
-            if secret_field in fields:
-                del fields[secret_field]
-        return fields
-
 
 class SlackChannel(Channel):
     """
@@ -188,12 +166,11 @@ class SlackChannel(Channel):
         *,
         name: str,
         application_link_url: str,
-        slack_channel_id: str | None = None,
-        token: str | None = None,
+        slack_channel_id: str,
+        token: str,
         signing_secret: str | None = None,
         app_token: str | None = None,
-        interactive_message_enabled: bool | None = None,
-        webhook_url: str | None = None,
+        interactive_message_enabled: bool = True,
         display_name: str | None = None,
         ignore_changes: bool = False,
         __internal__: ResourceGraph | None = None,
@@ -209,8 +186,6 @@ class SlackChannel(Channel):
         :param app_token: App level token used to retrieve user events from Slack.
         :param interactive_message_enabled: If interactive notification messages should
          be used.
-        :param webhook_url: Webhook URL provided by Slack to the
-            specified Slack channel. (deprecated)
         :param display_name: Human-readable name for the channel. This name is
           visible in the UI and does not need to be unique.
         :param ignore_changes: If set to true, changes to the resource will be ignored.
@@ -222,7 +197,6 @@ class SlackChannel(Channel):
             __internal__=__internal__,
         )
         self.application_link_url = application_link_url
-        self.webhook_url = webhook_url
         self.slack_channel_id = slack_channel_id
         self.token = token
         self.signing_secret = signing_secret
@@ -232,34 +206,12 @@ class SlackChannel(Channel):
         if self.signing_secret:
             self.add_field_deprecation("signing_secret", "app_token")
 
-        if webhook_url and (
-            slack_channel_id
-            or token
-            or signing_secret
-            or interactive_message_enabled
-            or app_token
-        ):
-            raise ManifestConfigurationError(
-                f"invalid configuration for Slack channel {self.name}: either"
-                " webhook_url or slack_channel_id, token, app_token and"
-                " interactive_message_enabled can be used."
-            )
-
-        if webhook_url:
-            self.add_field_deprecation("webhook_url")
-
     def _secret_fields(self) -> set[str]:
-        # If the webhook URL is set, we return an empty set so that the caller can
-        # avoid calling the secrets changed endpoint as it's not supported
-        return (
-            set({})
-            if self.webhook_url
-            else {
-                "app_token",
-                "signing_secret",
-                "token",
-            }
-        )
+        return {
+            "app_token",
+            "signing_secret",
+            "token",
+        }
 
     def _immutable_fields(self) -> set[str]:
         return set({})
@@ -271,13 +223,9 @@ class SlackChannel(Channel):
                 "application_link_url",
                 "slack_channel_id",
                 "interactive_message_enabled",
-                *self._deprecated_secret_fields(),
             },
         }
 
-    def _deprecated_secret_fields(self) -> set[str]:
-        return {"webhook_url"}
-
 
 class MsTeamsChannel(Channel):
     """
@@ -291,11 +239,10 @@ class MsTeamsChannel(Channel):
         *,
         name: str,
         application_link_url: str,
-        ms_teams_channel_id: str | None = None,
-        client_id: str | None = None,
-        client_secret: str | None = None,
-        interactive_message_enabled: bool | None = None,
-        webhook_url: str | None = None,
+        ms_teams_channel_id: str,
+        client_id: str,
+        client_secret: str,
+        interactive_message_enabled: bool = True,
         display_name: str | None = None,
         ignore_changes: bool = False,
         __internal__: ResourceGraph | None = None,
@@ -310,8 +257,6 @@ class MsTeamsChannel(Channel):
         :param client_secret: Client secret for authentication.
         :param interactive_message_enabled: If interactive notification messages should
          be used.
-        :param webhook_url: Webhook URL provided by Microsoft Teams to the
-            specified channel. (deprecated)
         :param display_name: Human-readable name for the channel. This name is
           visible in the UI and does not need to be unique.
         :param ignore_changes: If set to true, changes to the resource will be ignored.
@@ -323,31 +268,13 @@ class MsTeamsChannel(Channel):
             __internal__=__internal__,
         )
         self.application_link_url = application_link_url
-        self.webhook_url = webhook_url
         self.ms_teams_channel_id = ms_teams_channel_id
         self.client_id = client_id
         self.client_secret = client_secret
         self.interactive_message_enabled = interactive_message_enabled
 
-        if webhook_url and (
-            ms_teams_channel_id
-            or client_id
-            or client_secret
-            or interactive_message_enabled
-        ):
-            raise ManifestConfigurationError(
-                f"invalid configuration for MS Teams channel {self.name}: either"
-                " webhook_url or ms_teams_channel_id, client_id, client_secret,"
-                " and interactive_message_enabled can be used."
-            )
-
-        if webhook_url:
-            self.add_field_deprecation("webhook_url")
-
     def _secret_fields(self) -> set[str]:
-        # If the webhook URL is set, we return an empty set so that the caller can
-        # avoid calling the secrets changed endpoint as it's not supported
-        return set({}) if self.webhook_url else {"client_id", "client_secret"}
+        return {"client_id", "client_secret"}
 
     def _immutable_fields(self) -> set[str]:
         return set({})
@@ -359,13 +286,9 @@ class MsTeamsChannel(Channel):
                 "application_link_url",
                 "ms_teams_channel_id",
                 "interactive_message_enabled",
-                *self._deprecated_secret_fields(),
             },
         }
 
-    def _deprecated_secret_fields(self) -> set[str]:
-        return {"webhook_url"}
-
 
 class WebhookChannel(Channel):
     """

{validio_sdk-5.3.0 → validio_sdk-5.3.1}/validio_sdk/resource/filters.py

@@ -1,15 +1,12 @@
 """Filters configuration."""
 
-from abc import abstractmethod
 from enum import Enum
 from typing import TYPE_CHECKING, Any, Optional
 
 from validio_sdk.exception import ValidioBugError
 from validio_sdk.resource._diffable import Diffable
-from validio_sdk.resource._errors import ManifestConfigurationError
-from validio_sdk.resource._resource import Resource, ResourceGraph
+from validio_sdk.resource._resource import Resource
 from validio_sdk.resource._serde import (
-    CONFIG_FIELD_NAME,
     NODE_TYPE_FIELD_NAME,
     _api_create_input_params,
     _encode_resource,
@@ -21,10 +18,6 @@ if TYPE_CHECKING:
     from validio_sdk.resource.sources import Source
 
 
-# used to detect when we're in resource vs filter expression mode.
-DUMMY_NAME_PLACEHOLDER = "_validio_dummy_filter"
-
-
 class Filter(Resource):
     """
     Base class for a filter configuration.
@@ -34,8 +27,8 @@ class Filter(Resource):
 
     def __init__(
         self,
-        name: str | None = None,
-        source: Optional["Source"] = None,
+        name: str,
+        source: "Source",
         display_name: str | None = None,
         ignore_changes: bool = False,
     ):
@@ -48,28 +41,11 @@ class Filter(Resource):
           visible in the UI and does not need to be unique.
         :param ignore_changes: If set to true, changes to the resource will be ignored
         """
-        # For backwards compatibility while we transition from
-        # JSONFilterExpression to Filter resources, the Filter class
-        # is able to optionally act as a resource.
-        if (source is None) and (name is not None and name != DUMMY_NAME_PLACEHOLDER):
-            raise ManifestConfigurationError(
-                f"invalid {self.__class__.__name__}: "
-                "name and source arguments must be provided together."
-            )
-
-        # If in JSONFilterExpression mode, we initialize the base
-        # resource with an empty resource graph and a random name.
-        # Both values are simply placeholders and are ignored in this
-        # mode.
-        resource_graph = (
-            source._resource_graph if source is not None else ResourceGraph()
-        )
-
         super().__init__(
-            name=name or DUMMY_NAME_PLACEHOLDER,
+            name=name,
             display_name=display_name,
             ignore_changes=ignore_changes,
-            __internal__=resource_graph,
+            __internal__=source._resource_graph,
         )
 
         # If in Resource mode, then we add it as usual to the graph
@@ -78,21 +54,11 @@ class Filter(Resource):
             self.source_name: str = source.name
             source.add(self.name, self)
 
-    def _in_resource_mode(self) -> bool:
-        """Returns true if the filter is in resource mode."""
-        return self.name != DUMMY_NAME_PLACEHOLDER
-
     def _immutable_fields(self) -> set[str]:
-        if self._in_resource_mode():
-            return {"source_name"}
-
-        return set({})
+        return {"source_name"}
 
     def _mutable_fields(self) -> set[str]:
-        if self._in_resource_mode():
-            return super()._mutable_fields()
-
-        return set({})
+        return super()._mutable_fields()
 
     def _nested_objects(self) -> dict[str, Diffable | list[Diffable] | None]:
         return {}
@@ -101,24 +67,10 @@ class Filter(Resource):
         """Returns the base class name."""
         return "Filter"
 
-    @abstractmethod
-    def _scalar(self) -> dict[str, object]:
-        """
-        Returns the JsonFilterExpression representation of this filter.
-        For backwards compatibility while we transition to filter resources.
-        """
-
     def _encode(self) -> dict[str, object]:
-        if self._in_resource_mode():
-            # Drop fields here that are not part of the constructor for when
-            # we deserialize back. They will be reinitialized by the constructor.
-            return _encode_resource(self, skip_fields={"source_name"})
-
-        data = self._scalar()
-        data[NODE_TYPE_FIELD_NAME] = self.__class__.__name__
-        data["name"] = self.name
-
-        return data
+        # Drop fields here that are not part of the constructor for when we
+        # deserialize back. They will be reinitialized by the constructor.
+        return _encode_resource(self, skip_fields={"source_name"})
 
     @staticmethod
     def _decode(
@@ -127,17 +79,11 @@ class Filter(Resource):
     ) -> "Filter":
         cls = eval(obj[NODE_TYPE_FIELD_NAME])
 
-        in_resource_mode = CONFIG_FIELD_NAME in obj
+        if source is None:
+            raise ValidioBugError("Missing source when decoding filter")
 
-        if in_resource_mode:
-            if source is None:
-                raise ValidioBugError(
-                    "Missing source when decoding filter in resource mode"
-                )
-            args = get_config_node(obj)
-            return cls(**{**args, "source": source})
-
-        return cls(**{k: v for k, v in obj.items() if k != NODE_TYPE_FIELD_NAME})
+        args = get_config_node(obj)
+        return cls(**{**args, "source": source})
 
     def _api_create_input(self, _namespace: str, ctx: "DiffContext") -> dict[str, Any]:
         return _api_create_input_params(
@@ -145,9 +91,6 @@ class Filter(Resource):
             overrides={"sourceId": ctx.sources[self.source_name]._must_id()},
         )
 
-    def _api_json_filter_expression_create_input(self) -> dict[str, Any]:
-        return {"__typename": f"{self.__class__.__name__}Expression", **self._scalar()}
-
 
 class BooleanFilterOperator(str, Enum):
     """
@@ -172,8 +115,8 @@ class BooleanFilter(Filter):
         *,
         field: str,
         operator: BooleanFilterOperator,
-        name: str | None = None,
-        source: Optional["Source"] = None,
+        name: str,
+        source: "Source",
         display_name: str | None = None,
         ignore_changes: bool = False,
     ):
@@ -231,9 +174,9 @@ class NullFilter(Filter):
         self,
         *,
         field: str,
+        name: str,
+        source: "Source",
         operator: NullFilterOperator = NullFilterOperator.IS,
-        name: str | None = None,
-        source: Optional["Source"] = None,
         display_name: str | None = None,
         ignore_changes: bool = False,
     ):
@@ -265,9 +208,6 @@ class NullFilter(Filter):
     def _mutable_fields(self) -> set[str]:
         return {"field", "operator", *super()._mutable_fields()}
 
-    def _scalar(self) -> dict[str, object]:
-        return {"field": self.field, "operator": self.operator.value}
-
 
 class EnumFilterOperator(str, Enum):
     """
@@ -292,9 +232,9 @@ class EnumFilter(Filter):
         *,
         field: str,
         values: list[str],
+        name: str,
+        source: "Source",
         operator: EnumFilterOperator = EnumFilterOperator.ALLOW,
-        name: str | None = None,
-        source: Optional["Source"] = None,
         display_name: str | None = None,
         ignore_changes: bool = False,
     ):
@@ -375,9 +315,9 @@ class StringFilter(Filter):
         *,
         field: str,
         operator: StringFilterOperator,
+        name: str,
+        source: "Source",
         value: str | None = None,
-        name: str | None = None,
-        source: Optional["Source"] = None,
         display_name: str | None = None,
         ignore_changes: bool = False,
     ):
@@ -413,13 +353,6 @@ class StringFilter(Filter):
     def _mutable_fields(self) -> set[str]:
         return {"field", "operator", "value", *super()._mutable_fields()}
 
-    def _scalar(self) -> dict[str, object]:
-        return {
-            "field": self.field,
-            "value": self.value,
-            "operator": self.operator.value,
-        }
-
 
 class ThresholdFilterOperator(str, Enum):
     """
@@ -452,9 +385,9 @@ class ThresholdFilter(Filter):
         *,
         field: str,
         value: float,
+        name: str,
+        source: "Source",
         operator: ThresholdFilterOperator,
-        name: str | None = None,
-        source: Optional["Source"] = None,
         display_name: str | None = None,
         ignore_changes: bool = False,
     ):
@@ -489,13 +422,6 @@ class ThresholdFilter(Filter):
     def _mutable_fields(self) -> set[str]:
         return {"field", "operator", "value", *super()._mutable_fields()}
 
-    def _scalar(self) -> dict[str, object]:
-        return {
-            "field": self.field,
-            "value": self.value,
-            "operator": self.operator.value,
-        }
-
 
 class SqlFilter(Filter):
     """A SQL filter configuration.
@@ -507,8 +433,8 @@ class SqlFilter(Filter):
         self,
         *,
         query: str,
-        name: str | None = None,
-        source: Optional["Source"] = None,
+        name: str,
+        source: "Source",
         display_name: str | None = None,
         ignore_changes: bool = False,
     ):
@@ -535,6 +461,3 @@ class SqlFilter(Filter):
 
     def _mutable_fields(self) -> set[str]:
         return {"query", *super()._mutable_fields()}
-
-    def _scalar(self) -> dict[str, object]:
-        return {"query": self.query}