cognite-neat 1.0.6__py3-none-any.whl → 1.0.7__py3-none-any.whl

cognite/neat/_data_model/deployer/data_classes.py

@@ -607,7 +607,7 @@ class DeploymentResult(BaseDeployObject):
 
     @property
     def is_dry_run(self) -> bool:
-        return self.status == "pending"
+        return self.responses is None
 
     @property
     def is_success(self) -> bool:

cognite/neat/_session/_html/static/deployment.css

@@ -132,6 +132,16 @@
     color: #9ca3af;
 }
 
+.change-failed {
+    background: #fee2e2;
+    color: #991b1b;
+}
+
+.dark-mode .change-failed {
+    background: #7f1d1d;
+    color: #fca5a5;
+}
+
 .severity-badge {
     padding: 4px 10px;
     border-radius: 4px;
@@ -286,6 +296,16 @@
     color: white;
 }
 
+.status-recovered {
+    background: #10b981;
+    color: white;
+}
+
+.status-recovery_failed {
+    background: #dc2626;
+    color: white;
+}
+
 .dark-mode .status-success {
     background: #059669;
 }
@@ -300,4 +320,157 @@
 
 .dark-mode .status-pending {
     background: #2563eb;
+}
+
+.dark-mode .status-recovered {
+    background: #059669;
+}
+
+.dark-mode .status-recovery_failed {
+    background: #b91c1c;
+}
+
+
+/* Error message handling */
+
+.error-message-box {
+    background: #fee2e2;
+    border: 2px solid #dc2626;
+    border-left: 6px solid #dc2626;
+    border-radius: 8px;
+    padding: 16px;
+    margin-top: 12px;
+    animation: slideIn 0.3s ease-out;
+}
+
+.dark-mode .error-message-box {
+    background: #7f1d1d;
+    border-color: #ef4444;
+}
+
+.error-message-header {
+    display: flex;
+    align-items: center;
+    gap: 10px;
+    margin-bottom: 8px;
+}
+
+.error-icon {
+    font-size: 24px;
+}
+
+.error-title {
+    font-weight: 700;
+    font-size: 14px;
+    color: #991b1b;
+}
+
+.dark-mode .error-title {
+    color: #fca5a5;
+}
+
+.error-message-content {
+    color: #7f1d1d;
+    font-size: 13px;
+    line-height: 1.6;
+    padding-left: 34px;
+    font-family: 'Monaco', 'Courier New', monospace;
+}
+
+.dark-mode .error-message-content {
+    color: #fca5a5;
+}
+
+.change-item.failed-change {
+    border-left: 4px solid #dc2626;
+    background: rgba(254, 226, 226, 0.1);
+}
+
+.dark-mode .change-item.failed-change {
+    border-left-color: #ef4444;
+    background: rgba(127, 29, 29, 0.2);
+}
+
+.info-message-box {
+    border-radius: 6px;
+    padding: 12px 16px;
+    margin-top: 12px;
+    font-size: 13px;
+    line-height: 1.6;
+}
+
+.info-message-content {
+    color: inherit;
+}
+
+.info-message-create {
+    background: #d1fae5;
+    border-left: 4px solid #065f46;
+    color: #065f46;
+}
+
+.info-message-update {
+    background: #dbeafe;
+    border-left: 4px solid #1e40af;
+    color: #1e40af;
+}
+
+.info-message-delete {
+    background: #fee2e2;
+    border-left: 4px solid #991b1b;
+    color: #991b1b;
+}
+
+.info-message-skip {
+    background: #fef3c7;
+    border-left: 4px solid #92400e;
+    color: #92400e;
+}
+
+.info-message-unchanged {
+    background: #f3f4f6;
+    border-left: 4px solid #4b5563;
+    color: #4b5563;
+}
+
+.dark-mode .info-message-create {
+    background: #064e3b;
+    border-left-color: #6ee7b7;
+    color: #6ee7b7;
+}
+
+.dark-mode .info-message-update {
+    background: #1e3a8a;
+    border-left-color: #93c5fd;
+    color: #93c5fd;
+}
+
+.dark-mode .info-message-delete {
+    background: #7f1d1d;
+    border-left-color: #fca5a5;
+    color: #fca5a5;
+}
+
+.dark-mode .info-message-skip {
+    background: #78350f;
+    border-left-color: #fde68a;
+    color: #fde68a;
+}
+
+.dark-mode .info-message-unchanged {
+    background: #374151;
+    border-left-color: #9ca3af;
+    color: #9ca3af;
+}
+
+
+@keyframes slideIn {
+    from {
+        opacity: 0;
+        transform: translateY(-10px);
+    }
+    to {
+        opacity: 1;
+        transform: translateY(0);
+    }
 }

cognite/neat/_session/_html/static/deployment.js

@@ -17,7 +17,9 @@ const STATUS_CONFIG = {
     success: { icon: '✅', text: 'Success' },
     failure: { icon: '❌', text: 'Failure' },
     partial: { icon: '⚠️', text: 'Partial Success' },
-    pending: { icon: '⏳', text: 'Pending (Dry Run)' }
+    pending: { icon: '⏳', text: 'Pending (Dry Run)' },
+    recovered: { icon: '🔄', text: 'Recovered' },
+    recovery_failed: { icon: '💔', text: 'Recovery Failed' }
 };
 
 // Initialize status badge
@@ -26,7 +28,7 @@ function initializeStatus() {
     const statusIcon = document.getElementById('statusIcon-' + uniqueId);
     const statusText = document.getElementById('statusText-' + uniqueId);
 
-    const statusConfig = STATUS_CONFIG[stats.status] || STATUS_CONFIG.pending;
+    const statusConfig = STATUS_CONFIG[deploymentStatus] || STATUS_CONFIG.pending;
     statusIcon.textContent = statusConfig.icon;
     statusText.textContent = statusConfig.text;
 }
@@ -43,6 +45,31 @@ function updateTheme() {
     }
 }
 
+function renderChangeMessage(change) {
+    if (!change.message) return '';
+
+    // Using textContent to set the message prevents XSS vulnerabilities
+    // by automatically escaping HTML characters.
+    const messageHolder = document.createElement('div');
+    messageHolder.textContent = change.message;
+    const escapedMessage = messageHolder.innerHTML;
+
+    if (change.change_type === 'failed') {
+        return `
+            <div class="error-message-box">
+                <div class="error-message-header">
+                    <span class="error-icon">❌</span>
+                    <span class="error-title">Deployment Failed</span>
+                </div>
+                <div class="error-message-content">${escapedMessage}</div>
+            </div>`;
+    }
+    return `
+        <div class="info-message-box info-message-${change.change_type}">
+            <div class="info-message-content">${escapedMessage}</div>
+        </div>`;
+}
+
 updateTheme();
 initializeStatus();
 
@@ -76,13 +103,14 @@ function renderChanges() {
     }
 
     listContainer.innerHTML = filtered.map(change => `
-        <div class="change-item">
+        <div class="change-item ${change.change_type === 'failed' ? 'failed-change' : ''}">
             <div class="change-header">
                 <span class="endpoint-badge endpoint-${change.endpoint}">${change.endpoint}</span>
                 <span class="change-type-badge change-${change.change_type}">${change.change_type}</span>
                 <span class="severity-badge severity-${change.severity}">${change.severity}</span>
             </div>
             <div class="resource-id">${change.resource_id}</div>
+
             ${change.changes.length > 0 ? `
                 <div class="field-changes">
                     ${change.changes.map(fc => `
@@ -93,6 +121,9 @@ function renderChanges() {
                     `).join('')}
                 </div>
             ` : ''}
+
+            ${renderChangeMessage(change)}
+
         </div>
     `).join('');
 }
@@ -130,8 +161,8 @@ document.getElementById('searchInput-' + uniqueId).addEventListener('input', fun
 window['exportDeployment_' + uniqueId] = function() {
     const timestamp = new Date().toISOString().replace(/[:.]/g, '-');
     const report = {
-        status: stats.status,
-        is_dry_run: stats.is_dry_run,
+        status: deploymentStatus,
+        is_dry_run: is_dry_run === 'True',
         timestamp: timestamp,
         statistics: stats,
         changes: changes,

cognite/neat/_session/_html/templates/deployment.html

@@ -20,6 +20,9 @@
             <div class="stat-item active" data-filter="all">
                 <span class="stat-number">{{total_changes}}</span> Total Changes
             </div>
+            <div class="stat-item" data-filter="failed">
+                <span class="stat-number">{{failed}}</span> Failed
+            </div>
             <div class="stat-item" data-filter="create">
                 <span class="stat-number">{{created}}</span> Created
             </div>
@@ -29,12 +32,12 @@
             <div class="stat-item" data-filter="delete">
                 <span class="stat-number">{{deleted}}</span> Deleted
             </div>
-            <div class="stat-item" data-filter="skip">
-                <span class="stat-number">{{skipped}}</span> Skipped
-            </div>
             <div class="stat-item" data-filter="unchanged">
                 <span class="stat-number">{{unchanged}}</span> Unchanged
             </div>
+            <div class="stat-item" data-filter="skip">
+                <span class="stat-number">{{skipped}}</span> Skipped
+            </div>
             <button class="export-btn" onclick="exportDeployment_{{unique_id}}()">Export Report</button>
         </div>
     </div>
@@ -70,6 +73,8 @@
     const changes = {{CHANGES_JSON}};
     const stats = {{STATS_JSON}};
     const uniqueId = '{{unique_id}}';
+    const is_dry_run = '{{is_dry_run}}';
+    const deploymentStatus = '{{status}}';
     {{SCRIPTS}}
 })();
 </script>

cognite/neat/_session/_result/__init__.py

@@ -0,0 +1,3 @@
+from ._result import Result
+
+__all__ = ["Result"]

cognite/neat/_session/_result/_deployment/_physical/_changes.py

@@ -0,0 +1,195 @@
+import itertools
+from typing import Any
+
+from pydantic import BaseModel, Field
+
+from cognite.neat._data_model.deployer.data_classes import (
+    AddedField,
+    AppliedChanges,
+    ChangedField,
+    ChangeResult,
+    DeploymentResult,
+    FieldChange,
+    FieldChanges,
+    RemovedField,
+    ResourceChange,
+)
+
+
+class SerializedFieldChange(BaseModel):
+    """Serialized field change for JSON output."""
+
+    field_path: str
+    severity: str
+    description: str
+
+    @classmethod
+    def from_field_change(cls, field_change: FieldChange) -> list["SerializedFieldChange"]:
+        """Serialize a field change, handling nested FieldChanges recursively.
+
+        Args:
+            field_change: The field change to serialize.
+
+        Returns:
+            List of serialized field changes (may be multiple if nested).
+        """
+        serialized_changes: list[SerializedFieldChange] = []
+
+        if isinstance(field_change, FieldChanges):
+            # Recursively handle nested changes
+            for change in field_change.changes:
+                serialized_changes.extend(cls.from_field_change(change))
+        else:
+            # Base case: single field change
+            serialized_changes.append(cls._from_single_field_change(field_change))
+
+        return serialized_changes
+
+    @classmethod
+    def _from_single_field_change(cls, field_change: FieldChange) -> "SerializedFieldChange":
+        """Serialize a single non-nested field change.
+
+        Args:
+            field_change: The single field change to serialize.
+
+        Returns:
+            Serialized field change.
+        """
+        return cls(
+            field_path=field_change.field_path,
+            severity=field_change.severity.name,
+            description=field_change.description
+            if isinstance(field_change, AddedField | RemovedField | ChangedField)
+            else "Field changed",
+        )
+
+
+class SerializedResourceChange(BaseModel):
+    """Serialized resource change for JSON output."""
+
+    id: int
+    endpoint: str
+    change_type: str
+    severity: str
+    resource_id: str
+    message: str | None = None
+    changes: list[SerializedFieldChange] = Field(default_factory=list)
+
+    @classmethod
+    def from_resource_change(
+        cls, resource: ResourceChange, endpoint: str, change_id: int
+    ) -> "SerializedResourceChange":
+        """Serialize a single resource change.
+
+        Args:
+            resource: The resource change to serialize.
+            endpoint: The endpoint type.
+            change_id: Unique ID for this change.
+
+        Returns:
+            Serialized resource change.
+        """
+        changes: list[SerializedFieldChange] = []
+
+        for change in resource.changes:
+            changes.extend(SerializedFieldChange.from_field_change(change))
+
+        return cls(
+            id=change_id,
+            endpoint=endpoint,
+            change_type=resource.change_type,
+            severity=resource.severity.name,
+            resource_id=str(resource.resource_id),
+            changes=changes,
+        )
+
+    @classmethod
+    def from_change_result(cls, change_id: int, response: ChangeResult) -> "SerializedResourceChange":
+        """Serialize from a change result (actual deployment).
+
+        Args:
+            change_id: Unique ID for this change.
+            response: The change result from deployment.
+
+        Returns:
+            Serialized resource change with deployment status.
+        """
+        serialized_resource_change = cls.from_resource_change(
+            resource=response.change,
+            endpoint=response.endpoint,
+            change_id=change_id,
+        )
+
+        serialized_resource_change.message = response.message
+        if not response.is_success:
+            serialized_resource_change.change_type = "failed"
+
+        return serialized_resource_change
+
+
+class SerializedChanges(BaseModel):
+    """Container for all serialized changes."""
+
+    changes: list[SerializedResourceChange] = Field(default_factory=list)
+
+    @classmethod
+    def from_deployment_result(cls, result: DeploymentResult) -> "SerializedChanges":
+        """Create SerializedChanges from a DeploymentResult.
+
+        Args:
+            result: The deployment result to serialize changes from.
+
+        Returns:
+            SerializedChanges instance with all changes.
+        """
+        serialized = cls()
+
+        if not result.responses:
+            serialized._add_from_dry_run(result)
+        else:
+            serialized._add_from_applied_changes(result.responses)
+
+        return serialized
+
+    def _add_from_dry_run(self, result: DeploymentResult) -> None:
+        """Add changes from dry run deployment.
+
+        Args:
+            result: The deployment result in dry run mode.
+        """
+        # Iterate over each endpoint plan
+        for endpoint_plan in result.plan:
+            # Then per resource in the endpoint
+            for resource in endpoint_plan.resources:
+                # Then serialize individual resource change
+                serialized_resource_change = SerializedResourceChange.from_resource_change(
+                    resource=resource,
+                    endpoint=endpoint_plan.endpoint,
+                    change_id=len(self.changes),
+                )
+                self.changes.append(serialized_resource_change)
+
+    def _add_from_applied_changes(self, applied_changes: AppliedChanges) -> None:
+        """Add changes from actual deployment.
+        Args:
+            result: The deployment result from actual deployment.
+        """
+        for response in itertools.chain(
+            applied_changes.created,
+            applied_changes.merged_updated,
+            applied_changes.deletions,
+            applied_changes.unchanged,
+            applied_changes.skipped,
+        ):
+            self.changes.append(SerializedResourceChange.from_change_result(len(self.changes), response))
+
+    def model_dump_json_flat(self, **kwargs: Any) -> str:
+        """Dump changes as JSON array without the wrapper key.
+        Returns:
+            JSON string of the changes array.
+        """
+        if not self.changes:
+            return "[]"
+
+        iterator = (change.model_dump_json(**kwargs) for change in self.changes)
+        return f"[{','.join(iterator)}]"