File size: 7,498 Bytes
9c6594c |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 |
"""Actions that are triggered by W&B Automations."""
# ruff: noqa: UP007 # Avoid using `X | Y` for union fields, as this can cause issues with pydantic < 2.6
from __future__ import annotations
from typing import Any, Literal, Optional, Union
from pydantic import BeforeValidator, Field
from typing_extensions import Annotated, Self, get_args
from wandb._pydantic import GQLBase, GQLId, SerializedToJson, Typename
from ._generated import (
AlertSeverity,
GenericWebhookActionFields,
GenericWebhookActionInput,
NoOpActionFields,
NoOpTriggeredActionInput,
NotificationActionFields,
NotificationActionInput,
QueueJobActionFields,
)
from ._validators import (
LenientStrEnum,
default_if_none,
to_input_action,
to_saved_action,
upper_if_str,
)
from .integrations import SlackIntegration, WebhookIntegration
# NOTE: Name shortened for readability and defined publicly for easier access
class ActionType(LenientStrEnum):
"""The type of action triggered by an automation."""
QUEUE_JOB = "QUEUE_JOB" # NOTE: Deprecated for creation
NOTIFICATION = "NOTIFICATION"
GENERIC_WEBHOOK = "GENERIC_WEBHOOK"
NO_OP = "NO_OP"
# ------------------------------------------------------------------------------
# Saved types: for parsing response data from saved automations
# NOTE: `QueueJobActionInput` for defining a Launch job is deprecated,
# so while we allow parsing it from previously saved Automations, we deliberately
# don't currently expose it in the API for creating automations.
class SavedLaunchJobAction(QueueJobActionFields):
action_type: Literal[ActionType.QUEUE_JOB] = ActionType.QUEUE_JOB
# FIXME: Find a better place to put these OR a better way to handle the
# conversion from `InputAction` -> `SavedAction`.
#
# Necessary placeholder class defs for converting:
# - `SendNotification -> SavedNotificationAction`
# - `SendWebhook -> SavedWebhookAction`
#
# The "input" types (`Send{Notification,Webhook}`) will only have an `integration_id`,
# and we don't want/need to fetch the other `{Slack,Webhook}Integration` fields if
# we can avoid it.
class _SavedActionSlackIntegration(GQLBase, extra="allow"):
typename__: Typename[Literal["SlackIntegration"]] = "SlackIntegration"
id: GQLId
class _SavedActionWebhookIntegration(GQLBase, extra="allow"):
typename__: Typename[Literal["GenericWebhookIntegration"]] = (
"GenericWebhookIntegration"
)
id: GQLId
class SavedNotificationAction(NotificationActionFields):
action_type: Literal[ActionType.NOTIFICATION] = ActionType.NOTIFICATION
integration: _SavedActionSlackIntegration
class SavedWebhookAction(GenericWebhookActionFields):
action_type: Literal[ActionType.GENERIC_WEBHOOK] = ActionType.GENERIC_WEBHOOK
integration: _SavedActionWebhookIntegration
# We override the type of the `requestPayload` field since the original GraphQL
# schema (and generated class) effectively defines it as a string, when we know
# and need to anticipate the expected structure of the JSON-serialized data.
request_payload: Annotated[
Optional[SerializedToJson[dict[str, Any]]],
Field(alias="requestPayload"),
] = None # type: ignore[assignment]
class SavedNoOpAction(NoOpActionFields, frozen=True):
action_type: Literal[ActionType.NO_OP] = ActionType.NO_OP
no_op: Annotated[bool, BeforeValidator(default_if_none)] = True
"""Placeholder field, only needed to conform to schema requirements.
There should never be a need to set this field explicitly, as its value is ignored.
"""
# for type annotations
SavedAction = Annotated[
Union[
SavedLaunchJobAction,
SavedNotificationAction,
SavedWebhookAction,
SavedNoOpAction,
],
BeforeValidator(to_saved_action),
Field(discriminator="typename__"),
]
# for runtime type checks
SavedActionTypes: tuple[type, ...] = get_args(SavedAction.__origin__) # type: ignore[attr-defined]
# ------------------------------------------------------------------------------
# Input types: for creating or updating automations
class _BaseActionInput(GQLBase):
action_type: Annotated[ActionType, Field(frozen=True)]
"""The kind of action to be triggered."""
class SendNotification(_BaseActionInput, NotificationActionInput):
"""Defines an automation action that sends a (Slack) notification."""
action_type: Literal[ActionType.NOTIFICATION] = ActionType.NOTIFICATION
integration_id: GQLId
"""The ID of the Slack integration that will be used to send the notification."""
# Note: Validation aliases are meant to provide continuity with prior `wandb.alert()` API.
title: str = ""
"""The title of the sent notification."""
message: Annotated[str, Field(validation_alias="text")] = ""
"""The message body of the sent notification."""
severity: Annotated[
AlertSeverity,
BeforeValidator(upper_if_str), # Be helpful by ensuring uppercase strings
Field(validation_alias="level"),
] = AlertSeverity.INFO
"""The severity (`INFO`, `WARN`, `ERROR`) of the sent notification."""
@classmethod
def from_integration(
cls,
integration: SlackIntegration,
*,
title: str = "",
text: str = "",
level: AlertSeverity = AlertSeverity.INFO,
) -> Self:
"""Define a notification action that sends to the given (Slack) integration."""
return cls(
integration_id=integration.id,
title=title,
message=text,
severity=level,
)
class SendWebhook(_BaseActionInput, GenericWebhookActionInput):
"""Defines an automation action that sends a webhook request."""
action_type: Literal[ActionType.GENERIC_WEBHOOK] = ActionType.GENERIC_WEBHOOK
integration_id: GQLId
"""The ID of the webhook integration that will be used to send the request."""
# overrides the generated field type to parse/serialize JSON strings
request_payload: Optional[SerializedToJson[dict[str, Any]]] = Field( # type: ignore[assignment]
default=None, alias="requestPayload"
)
"""The payload, possibly with template variables, to send in the webhook request."""
@classmethod
def from_integration(
cls,
integration: WebhookIntegration,
*,
payload: Optional[SerializedToJson[dict[str, Any]]] = None,
) -> Self:
"""Define a webhook action that sends to the given (webhook) integration."""
return cls(integration_id=integration.id, request_payload=payload)
class DoNothing(_BaseActionInput, NoOpTriggeredActionInput, frozen=True):
"""Defines an automation action that intentionally does nothing."""
action_type: Literal[ActionType.NO_OP] = ActionType.NO_OP
no_op: Annotated[bool, BeforeValidator(default_if_none)] = True
"""Placeholder field which exists only to satisfy backend schema requirements.
There should never be a need to set this field explicitly, as its value is ignored.
"""
# for type annotations
InputAction = Annotated[
Union[
SendNotification,
SendWebhook,
DoNothing,
],
BeforeValidator(to_input_action),
Field(discriminator="action_type"),
]
# for runtime type checks
InputActionTypes: tuple[type, ...] = get_args(InputAction.__origin__) # type: ignore[attr-defined]
__all__ = [
"ActionType",
*(cls.__name__ for cls in InputActionTypes),
]
|