wizata-dsapi 2.1.0.dev12__tar.gz → 2.1.0.dev14__tar.gz

{wizata_dsapi-2.1.0.dev12 → wizata_dsapi-2.1.0.dev14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wizata_dsapi
-Version: 2.1.0.dev12
+Version: 2.1.0.dev14
 Summary: Wizata Data Science Toolkit
 Author: Wizata S.A.
 Author-email: info@wizata.com

{wizata_dsapi-2.1.0.dev12 → wizata_dsapi-2.1.0.dev14}/wizata_dsapi/__init__.py

@@ -15,6 +15,12 @@ from .solution_component import SolutionComponent, SolutionType
 from .business_label import BusinessLabel
 from .twinregistration import TwinRegistration, TwinRegistrationProperty
 from .trigger import Trigger, validate_trigger_branch
+from .deployment import (
+    Deployment,
+    DeploymentStatus,
+    DeploymentStep,
+    StepStatus,
+)
 from .group_system import GroupSystem
 from .bucket import Bucket
 

{wizata_dsapi-2.1.0.dev12 → wizata_dsapi-2.1.0.dev14}/wizata_dsapi/context.py

@@ -43,7 +43,9 @@ class Context(ILogger):
     :ivar dict dataframes: dict of all dataframes parameters and generated by previously executed steps.
     :ivar dict datapoints: wizata_dsapi.Datapoint for each name (key) used in queries.
     :ivar uuid.UUID execution_id: Execution ID currently processed.
-    :ivar grafana_client.GrafanaApi grafana_api: instance of grafana api.
+    :ivar grafana_client.GrafanaApi grafana_api: instance of grafana api - set only when the
+        OPTIONAL grafana-client library (>=3.5.0) is installed alongside the platform,
+        None otherwise (DEV-5972).
     :ivar dict models: dict of all models generated by previously executed steps.
     :ivar datetime now: Now timestamp as used by the pipeline.
     :ivar uuid.UUID pipeline_id: Pipeline ID associated with the ongoing execution.

wizata_dsapi-2.1.0.dev14/wizata_dsapi/deployment.py

@@ -0,0 +1,237 @@
+"""
+Deployment — one attempt at putting a pipeline version into production (DEV-5960).
+
+The front-end fires a single call and polls; the DS API owns the whole sequence
+(merge, release cut, image build, trigger). That sequence cannot be synchronous — an
+image build can outlast the gateway timeout — so it needs somewhere to record what
+was asked for, how far it got, and why it stopped. This is that record.
+
+Design notes:
+
+* Steps are explicit rather than inferred from a status enum. A deployment that
+  merged and cut a release but failed to build an image is a very different thing to
+  recover from than one that never started, and an operator should be able to see
+  which without reading logs.
+* The manifest is stored as executed, so the record answers "what did this deployment
+  actually do" later, when the plan that produced it is long gone.
+* Nothing here decides policy. Validation lives in the planner; this only carries
+  state.
+* It doubles as the pause switch for a schedule. Since the DS API owns the trigger's
+  lifecycle, pausing a deployment deletes its trigger and resuming recreates it from
+  the stored manifest — which is why the record keeps release, sha, image and
+  manifest even after it has completed. The trigger has no enabled flag of its own
+  (deferred on the backend, DEV-5962), so without this a schedule could only be
+  stopped by deleting it and rebuilding it from memory later.
+"""
+import json
+import uuid
+from datetime import datetime
+from enum import Enum
+
+from .api_dto import ApiDto
+
+
+def _epoch_ms(value):
+    """
+    Timestamps go out as epoch milliseconds, like every other DTO here.
+
+    Postgres hands back a ``datetime`` (the table stamps createdDate/updatedDate
+    server-side), so a record read from the database would otherwise serialize a
+    datetime the API cannot marshal. Ints pass through unchanged, which keeps a
+    JSON round-trip stable.
+    """
+    if isinstance(value, datetime):
+        return int(value.timestamp() * 1000)
+    return value
+
+
+class DeploymentStatus(Enum):
+    """
+    Lifecycle of a deployment attempt.
+
+    PAUSED is what makes a schedule stoppable at all. The trigger itself has no
+    enabled flag — that was deferred on the backend (DEV-5962) — but the DS API
+    creates and deletes the trigger as part of a deployment, so pausing can be
+    expressed here instead: pause DELETES the trigger and keeps this record, which
+    still holds the release, sha, image and manifest, so resuming recreates the same
+    schedule rather than asking the user to rebuild it from memory. Before this, the
+    only way to stop a schedule was to delete it and remember what it was.
+    """
+    PENDING = "pending"        # accepted, nothing done yet
+    DEPLOYING = "deploying"    # steps in progress — the DEPLOYMENT is working, which
+                               # says nothing about whether a pipeline is executing
+    DEPLOYED = "deployed"      # every planned step done, schedule live
+    PAUSED = "paused"          # deployed, trigger removed on purpose; resumable
+    FAILED = "failed"          # a step failed; `error` says which and why
+
+
+class DeploymentStep(Enum):
+    """The ordered steps a deployment may perform. Not all apply to every plan."""
+    MERGE = "merge"            # feature branch -> default branch
+    RELEASE = "release"        # cut/advance release/<name>
+    IMAGE = "image"            # build an image pinned to the release sha
+    TRIGGER = "trigger"        # create or update the schedule
+
+
+class StepStatus(Enum):
+    SKIPPED = "skipped"        # not part of this plan (e.g. no merge when deploying master)
+    PENDING = "pending"
+    COMPLETED = "completed"
+    FAILED = "failed"
+
+
+class Deployment(ApiDto):
+    """
+    A deployment attempt and its progress.
+
+    :ivar uuid.UUID deployment_id: technical id, what the front-end polls on.
+    :ivar str pipeline_key: pipeline being deployed.
+    :ivar uuid.UUID pipeline_id: its technical id.
+    :ivar str source: ref the user deployed FROM (feature/..., master, release/...).
+    :ivar str release: the release ref this deployment produces or reuses.
+    :ivar str sha: commit the release resolves to — what actually runs.
+    :ivar str packaging: 'image' (frozen artifact) or 'release' (run from the branch).
+    :ivar str image_id: built image, when packaging='image'.
+    :ivar uuid.UUID trigger_id: schedule created or updated at the end.
+    :ivar DeploymentStatus status: overall state — pending / deploying / deployed /
+        paused / failed. Deliberately not "running" or "completed": a user reads those
+        as "is my pipeline executing", which is a different question entirely.
+    :ivar list steps: [{'step','status','detail'}] in execution order.
+    :ivar str error: failure reason when status is FAILED.
+    :ivar dict manifest: the deploy request as executed.
+    :ivar str created_by: email of the user who launched it.
+    :ivar int createdDate: timestamp ms.
+    :ivar int updatedDate: timestamp ms.
+    """
+
+    @classmethod
+    def route(cls):
+        return "deployments"
+
+    @classmethod
+    def from_dict(cls, data):
+        obj = Deployment()
+        obj.from_json(data)
+        return obj
+
+    def __init__(self,
+                 deployment_id: uuid.UUID = None,
+                 pipeline_key: str = None,
+                 pipeline_id: uuid.UUID = None,
+                 source: str = None,
+                 release: str = None,
+                 sha: str = None,
+                 packaging: str = None,
+                 image_id: str = None,
+                 trigger_id: uuid.UUID = None,
+                 status: DeploymentStatus = None,
+                 steps: list = None,
+                 error: str = None,
+                 manifest: dict = None,
+                 created_by: str = None):
+        if deployment_id is None:
+            deployment_id = uuid.uuid4()
+        self.deployment_id = deployment_id
+        self.pipeline_key = pipeline_key
+        self.pipeline_id = pipeline_id
+        self.source = source
+        self.release = release
+        self.sha = sha
+        self.packaging = packaging
+        self.image_id = image_id
+        self.trigger_id = trigger_id
+        self.status = status or DeploymentStatus.PENDING
+        self.steps = steps if steps is not None else []
+        self.error = error
+        self.manifest = manifest
+        self.created_by = created_by
+        self.createdDate = None
+        self.updatedDate = None
+
+    def api_id(self) -> str:
+        return str(self.deployment_id).upper()
+
+    def endpoint(self) -> str:
+        return "Deployments"
+
+    # ------------------------------------------------------------------ steps
+
+    def set_step(self, step: DeploymentStep, status: StepStatus, detail=None) -> None:
+        """
+        Record a step's outcome, replacing any previous entry for it so a retry
+        does not append duplicates.
+        """
+        entry = {"step": step.value, "status": status.value}
+        if detail is not None:
+            entry["detail"] = detail
+        for index, existing in enumerate(self.steps):
+            if existing.get("step") == step.value:
+                self.steps[index] = entry
+                return
+        self.steps.append(entry)
+
+    def step_status(self, step: DeploymentStep) -> StepStatus | None:
+        for existing in self.steps:
+            if existing.get("step") == step.value:
+                return StepStatus(existing["status"])
+        return None
+
+    def is_done(self, step: DeploymentStep) -> bool:
+        """True when a step needs no further work — completed or not planned."""
+        return self.step_status(step) in (StepStatus.COMPLETED, StepStatus.SKIPPED)
+
+    # ------------------------------------------------------------------ serialization
+
+    def from_json(self, obj):
+        if "id" in obj.keys() and obj["id"] is not None:
+            self.deployment_id = uuid.UUID(str(obj["id"]))
+        if "pipelineKey" in obj.keys():
+            self.pipeline_key = obj["pipelineKey"]
+        if "pipelineId" in obj.keys() and obj["pipelineId"] is not None:
+            self.pipeline_id = uuid.UUID(str(obj["pipelineId"]))
+        for field, attribute in (("source", "source"), ("release", "release"),
+                                 ("sha", "sha"), ("packaging", "packaging"),
+                                 ("imageId", "image_id"), ("error", "error"),
+                                 ("createdBy", "created_by")):
+            if field in obj.keys() and obj[field] is not None:
+                setattr(self, attribute, obj[field])
+        if "triggerId" in obj.keys() and obj["triggerId"] is not None:
+            self.trigger_id = uuid.UUID(str(obj["triggerId"]))
+        if "status" in obj.keys() and obj["status"] is not None:
+            self.status = DeploymentStatus(obj["status"])
+        if "steps" in obj.keys() and obj["steps"] is not None:
+            steps = obj["steps"]
+            self.steps = json.loads(steps) if isinstance(steps, str) else steps
+        if "manifest" in obj.keys() and obj["manifest"] is not None:
+            manifest = obj["manifest"]
+            self.manifest = json.loads(manifest) if isinstance(manifest, str) else manifest
+        if "createdDate" in obj.keys() and obj["createdDate"] is not None:
+            self.createdDate = obj["createdDate"]
+        if "updatedDate" in obj.keys() and obj["updatedDate"] is not None:
+            self.updatedDate = obj["updatedDate"]
+
+    def to_json(self, target: str = None):
+        obj = {
+            "id": str(self.deployment_id),
+            "status": self.status.value if self.status else None,
+            "steps": self.steps,
+        }
+        if self.pipeline_key is not None:
+            obj["pipelineKey"] = self.pipeline_key
+        if self.pipeline_id is not None:
+            obj["pipelineId"] = str(self.pipeline_id)
+        for field, value in (("source", self.source), ("release", self.release),
+                             ("sha", self.sha), ("packaging", self.packaging),
+                             ("imageId", self.image_id), ("error", self.error),
+                             ("createdBy", self.created_by)):
+            if value is not None:
+                obj[field] = value
+        if self.trigger_id is not None:
+            obj["triggerId"] = str(self.trigger_id)
+        if self.manifest is not None:
+            obj["manifest"] = self.manifest
+        if self.createdDate is not None:
+            obj["createdDate"] = _epoch_ms(self.createdDate)
+        if self.updatedDate is not None:
+            obj["updatedDate"] = _epoch_ms(self.updatedDate)
+        return obj

wizata_dsapi-2.1.0.dev14/wizata_dsapi/version.py

@@ -0,0 +1 @@
+__version__ = "2.1.0.dev14"

{wizata_dsapi-2.1.0.dev12 → wizata_dsapi-2.1.0.dev14}/wizata_dsapi.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wizata_dsapi
-Version: 2.1.0.dev12
+Version: 2.1.0.dev14
 Summary: Wizata Data Science Toolkit
 Author: Wizata S.A.
 Author-email: info@wizata.com

{wizata_dsapi-2.1.0.dev12 → wizata_dsapi-2.1.0.dev14}/wizata_dsapi.egg-info/SOURCES.txt

@@ -12,6 +12,7 @@ wizata_dsapi/dashboard.py
 wizata_dsapi/dataframe_toolkit.py
 wizata_dsapi/datapoint.py
 wizata_dsapi/datastore.py
+wizata_dsapi/deployment.py
 wizata_dsapi/ds_dataframe.py
 wizata_dsapi/dsapi_json_encoder.py
 wizata_dsapi/edge_config.py

wizata_dsapi-2.1.0.dev12/wizata_dsapi/version.py

@@ -1 +0,0 @@
-__version__ = "2.1.0.dev12"