content: #  Copyright (c) ZenML GmbH 2024. All Rights Reserved.
  #
  #  Licensed under the Apache License, Version 2.0 (the "License");
  #  you may not use this file except in compliance with the License.
  #  You may obtain a copy of the License at:
  #
  #       https://www.apache.org/licenses/LICENSE-2.0
  #
  #  Unless required by applicable law or agreed to in writing, software
  #  distributed under the License is distributed on an "AS IS" BASIS,
  #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
  #  or implied. See the License for the specific language governing
  #  permissions and limitations under the License.
  """SQL Model Implementations for Triggers."""
  
  import base64
  import json
  from typing import Any, List, Optional, Sequence, cast
  from uuid import UUID
  
  from sqlalchemy import TEXT, Column, UniqueConstraint
  from sqlalchemy.orm import joinedload
  from sqlalchemy.sql.base import ExecutableOption
  from sqlmodel import Field, Relationship
  
  from zenml.config.schedule import Schedule
  from zenml.models import (
      Page,
      TriggerExecutionRequest,
      TriggerExecutionResponse,
      TriggerExecutionResponseBody,
      TriggerExecutionResponseMetadata,
      TriggerExecutionResponseResources,
      TriggerRequest,
      TriggerResponse,
      TriggerResponseBody,
      TriggerResponseMetadata,
      TriggerResponseResources,
      TriggerUpdate,
  )
  from zenml.utils.json_utils import pydantic_encoder
  from zenml.utils.time_utils import utc_now
  from zenml.zen_stores.schemas.action_schemas import ActionSchema
  from zenml.zen_stores.schemas.base_schemas import BaseSchema, NamedSchema
  from zenml.zen_stores.schemas.event_source_schemas import EventSourceSchema
  from zenml.zen_stores.schemas.project_schemas import ProjectSchema
  from zenml.zen_stores.schemas.schema_utils import build_foreign_key_field
  from zenml.zen_stores.schemas.user_schemas import UserSchema
  from zenml.zen_stores.schemas.utils import (
      get_page_from_list,
      jl_arg,
  )
  
  
  class TriggerSchema(NamedSchema, table=True):
      """SQL Model for triggers."""
  
      __tablename__ = "trigger"
      __table_args__ = (
          UniqueConstraint(
              "name",
              "project_id",
              name="unique_trigger_name_in_project",
          ),
      )
  
      project_id: UUID = build_foreign_key_field(
          source=__tablename__,
          target=ProjectSchema.__tablename__,
          source_column="project_id",
          target_column="id",
          ondelete="CASCADE",
          nullable=False,
      )
      project: "ProjectSchema" = Relationship(back_populates="triggers")
  
      user_id: Optional[UUID] = build_foreign_key_field(
          source=__tablename__,
          target=UserSchema.__tablename__,
          source_column="user_id",
          target_column="id",
          ondelete="SET NULL",
          nullable=True,
      )
      user: Optional["UserSchema"] = Relationship(
          back_populates="triggers",
          sa_relationship_kwargs={"foreign_keys": "[TriggerSchema.user_id]"},
      )
  
      event_source_id: Optional[UUID] = build_foreign_key_field(
          source=__tablename__,
          target=EventSourceSchema.__tablename__,
          source_column="event_source_id",
          target_column="id",
          # This won't happen because the SQL zen store prevents an event source
          # from being deleted if it has associated triggers
          ondelete="SET NULL",
          nullable=True,
      )
      event_source: Optional["EventSourceSchema"] = Relationship(
          back_populates="triggers"
      )
  
      action_id: UUID = build_foreign_key_field(
          source=__tablename__,
          target=ActionSchema.__tablename__,
          source_column="action_id",
          target_column="id",
          # This won't happen because the SQL zen store prevents an action
          # from being deleted if it has associated triggers
          ondelete="CASCADE",
          nullable=False,
      )
      action: "ActionSchema" = Relationship(back_populates="triggers")
  
      executions: List["TriggerExecutionSchema"] = Relationship(
          back_populates="trigger"
      )
  
      event_filter: bytes
      schedule: Optional[bytes] = Field(nullable=True)
  
      description: str = Field(sa_column=Column(TEXT, nullable=True))
      is_active: bool = Field(nullable=False)
  
      @classmethod
      def get_query_options(
          cls,
          include_metadata: bool = False,
          include_resources: bool = False,
          **kwargs: Any,
      ) -> Sequence[ExecutableOption]:
          """Get the query options for the schema.
  
          Args:
              include_metadata: Whether metadata will be included when converting
                  the schema to a model.
              include_resources: Whether resources will be included when
                  converting the schema to a model.
              **kwargs: Keyword arguments to allow schema specific logic
  
          Returns:
              A list of query options.
          """
          options = [
              joinedload(jl_arg(TriggerSchema.action), innerjoin=True),
              joinedload(jl_arg(TriggerSchema.event_source), innerjoin=True),
          ]
  
          if include_resources:
              options.extend(
                  [
                      joinedload(jl_arg(TriggerSchema.user)),
                      # joinedload(jl_arg(TriggerSchema.executions)),
                  ]
              )
  
          return options
  
      def update(self, trigger_update: "TriggerUpdate") -> "TriggerSchema":
          """Updates a trigger schema with a trigger update model.
  
          Args:
              trigger_update: `TriggerUpdate` to update the trigger with.
  
          Returns:
              The updated TriggerSchema.
          """
          for field, value in trigger_update.model_dump(
              exclude_unset=True,
              exclude_none=True,
          ).items():
              if field == "event_filter":
                  self.event_filter = base64.b64encode(
                      json.dumps(
                          trigger_update.event_filter, default=pydantic_encoder
                      ).encode("utf-8")
                  )
              else:
                  setattr(self, field, value)
  
          self.updated = utc_now()
          return self
  
      @classmethod
      def from_request(cls, request: "TriggerRequest") -> "TriggerSchema":
          """Convert a `TriggerRequest` to a `TriggerSchema`.
  
          Args:
              request: The request model to convert.
  
          Returns:
              The converted schema.
          """
          return cls(
              name=request.name,
              project_id=request.project,
              user_id=request.user,
              action_id=request.action_id,
              event_source_id=request.event_source_id,
              event_filter=base64.b64encode(
                  json.dumps(
                      request.event_filter, default=pydantic_encoder
                  ).encode("utf-8")
              ),
              schedule=base64.b64encode(request.schedule.json().encode("utf-8"))
              if request.schedule
              else None,
              description=request.description,
              is_active=True,  # Makes no sense for it to be created inactive
          )
  
      def to_model(
          self,
          include_metadata: bool = False,
          include_resources: bool = False,
          **kwargs: Any,
      ) -> "TriggerResponse":
          """Converts the schema to a model.
  
          Args:
              include_metadata: Flag deciding whether to include the output model(s)
                  metadata fields in the response.
              include_resources: Flag deciding whether to include the output model(s)
                  metadata fields in the response.
              **kwargs: Keyword arguments to allow schema specific logic
  
          Returns:
              The converted model.
          """
          from zenml.models import TriggerExecutionResponse
  
          body = TriggerResponseBody(
              user_id=self.user_id,
              project_id=self.project_id,
              created=self.created,
              updated=self.updated,
              action_flavor=self.action.flavor,
              action_subtype=self.action.plugin_subtype,
              event_source_flavor=self.event_source.flavor
              if self.event_source
              else None,
              event_source_subtype=self.event_source.plugin_subtype
              if self.event_source
              else None,
              is_active=self.is_active,
          )
          metadata = None
          if include_metadata:
              metadata = TriggerResponseMetadata(
                  event_filter=json.loads(
                      base64.b64decode(self.event_filter).decode()
                  ),
                  schedule=Schedule.parse_raw(
                      base64.b64decode(self.schedule).decode()
                  )
                  if self.schedule
                  else None,
                  description=self.description,
              )
          resources = None
          if include_resources:
              executions = cast(
                  Page[TriggerExecutionResponse],
                  get_page_from_list(
                      items_list=self.executions,
                      response_model=TriggerExecutionResponse,
                      include_resources=False,
                      include_metadata=False,
                  ),
              )
              resources = TriggerResponseResources(
                  user=self.user.to_model() if self.user else None,
                  action=self.action.to_model(),
                  event_source=self.event_source.to_model()
                  if self.event_source
                  else None,
                  executions=executions,
              )
          return TriggerResponse(
              id=self.id,
              name=self.name,
              body=body,
              metadata=metadata,
              resources=resources,
          )
  
  
  class TriggerExecutionSchema(BaseSchema, table=True):
      """SQL Model for trigger executions."""
  
      __tablename__ = "trigger_execution"
  
      trigger_id: UUID = build_foreign_key_field(
          source=__tablename__,
          target=TriggerSchema.__tablename__,
          source_column="trigger_id",
          target_column="id",
          ondelete="CASCADE",
          nullable=False,
      )
      trigger: TriggerSchema = Relationship(back_populates="executions")
  
      event_metadata: Optional[bytes] = None
  
      @classmethod
      def from_request(
          cls, request: "TriggerExecutionRequest"
      ) -> "TriggerExecutionSchema":
          """Convert a `TriggerExecutionRequest` to a `TriggerExecutionSchema`.
  
          Args:
              request: The request model to convert.
  
          Returns:
              The converted schema.
          """
          return cls(
              trigger_id=request.trigger,
              event_metadata=base64.b64encode(
                  json.dumps(request.event_metadata).encode("utf-8")
              ),
          )
  
      def to_model(
          self,
          include_metadata: bool = False,
          include_resources: bool = False,
          **kwargs: Any,
      ) -> "TriggerExecutionResponse":
          """Converts the schema to a model.
  
          Args:
              include_metadata: Whether the metadata will be filled.
              include_resources: Whether the resources will be filled.
              **kwargs: Keyword arguments to allow schema specific logic
  
  
          Returns:
              The converted model.
          """
          body = TriggerExecutionResponseBody(
              created=self.created,
              updated=self.updated,
          )
          metadata = None
          if include_metadata:
              metadata = TriggerExecutionResponseMetadata(
                  event_metadata=json.loads(
                      base64.b64decode(self.event_metadata).decode()
                  )
                  if self.event_metadata
                  else {},
              )
          resources = None
          if include_resources:
              resources = TriggerExecutionResponseResources(
                  trigger=self.trigger.to_model(),
              )
  
          return TriggerExecutionResponse(
              id=self.id, body=body, metadata=metadata, resources=resources
          )
  