Include Compiled Node Attributes in run_results.json

.changes/unreleased/Features-20230821-103357.yaml

@@ -0,0 +1,6 @@
+kind: Features
+body: Add node attributes related to compilation to run_results.json
+time: 2023-08-21T10:33:57.200883-04:00
+custom:
+  Author: peterallenwebb
+  Issue: "7519"

core/dbt/contracts/results.py

@@ -1,7 +1,7 @@
 import threading
 
 from dbt.contracts.graph.unparsed import FreshnessThreshold
-from dbt.contracts.graph.nodes import SourceDefinition, ResultNode
+from dbt.contracts.graph.nodes import CompiledNode, SourceDefinition, ResultNode
 from dbt.contracts.util import (
     BaseArtifactMetadata,
     ArtifactMixin,
@@ -203,9 +203,15 @@ class RunResultsMetadata(BaseArtifactMetadata):
 @dataclass
 class RunResultOutput(BaseResult):
     unique_id: str
+    compiled: Optional[bool]
+    compiled_code: Optional[str]
+    relation_name: Optional[str]
 
 
 def process_run_result(result: RunResult) -> RunResultOutput:
+
+    compiled = isinstance(result.node, CompiledNode)
+
     return RunResultOutput(
         unique_id=result.node.unique_id,
         status=result.status,
@@ -215,6 +221,9 @@ def process_run_result(result: RunResult) -> RunResultOutput:
         message=result.message,
         adapter_response=result.adapter_response,
         failures=result.failures,
+        compiled=result.node.compiled if compiled else None,  # type:ignore
+        compiled_code=result.node.compiled_code if compiled else None,  # type:ignore
+        relation_name=result.node.relation_name if compiled else None,  # type:ignore
     )
 
 
@@ -237,7 +246,7 @@ def write(self, path: str):
 
 
 @dataclass
-@schema_version("run-results", 4)
+@schema_version("run-results", 5)
 class RunResultsArtifact(ExecutionResult, ArtifactMixin):
     results: Sequence[RunResultOutput]
     args: Dict[str, Any] = field(default_factory=dict)

core/dbt/tests/util.py

@@ -5,7 +5,7 @@
 import json
 import warnings
 from datetime import datetime
-from typing import Dict, List, Optional
+from typing import Any, Dict, List, Optional
 from contextlib import contextmanager
 from dbt.adapters.factory import Adapter
 
@@ -160,6 +160,16 @@ def get_manifest(project_root) -> Optional[Manifest]:
         return None
 
 
+# Used in test cases to get the run_results.json file.
+def get_run_results(project_root) -> Any:
+    path = os.path.join(project_root, "target", "run_results.json")
+    if os.path.exists(path):
+        with open(path) as run_result_text:
+            return json.load(run_result_text)
+    else:
+        return None
+
+
 # Used in tests to copy a file, usually from a data directory to the project directory
 def copy_file(src_path, src, dest_path, dest) -> None:
     # dest is a list, so that we can provide nested directories, like 'models' etc.

schemas/dbt/run-results/v5.json

@@ -0,0 +1,229 @@
+{
+  "$ref": "#/$defs/RunResultsArtifact",
+  "$defs": {
+    "BaseArtifactMetadata": {
+      "type": "object",
+      "title": "BaseArtifactMetadata",
+      "properties": {
+        "dbt_schema_version": {
+          "type": "string"
+        },
+        "dbt_version": {
+          "type": "string",
+          "default": "1.7.0b1"
+        },
+        "generated_at": {
+          "type": "string"
+        },
+        "invocation_id": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "env": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          },
+          "propertyNames": {
+            "type": "string"
+          }
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "dbt_schema_version"
+      ]
+    },
+    "TimingInfo": {
+      "type": "object",
+      "title": "TimingInfo",
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "started_at": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "default": null
+        },
+        "completed_at": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "default": null
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "name"
+      ]
+    },
+    "RunResultOutput": {
+      "type": "object",
+      "title": "RunResultOutput",
+      "properties": {
+        "status": {
+          "anyOf": [
+            {
+              "enum": [
+                "success",
+                "error",
+                "skipped"
+              ]
+            },
+            {
+              "enum": [
+                "pass",
+                "error",
+                "fail",
+                "warn",
+                "skipped"
+              ]
+            },
+            {
+              "enum": [
+                "pass",
+                "warn",
+                "error",
+                "runtime error"
+              ]
+            }
+          ]
+        },
+        "timing": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/TimingInfo"
+          }
+        },
+        "thread_id": {
+          "type": "string"
+        },
+        "execution_time": {
+          "type": "number"
+        },
+        "adapter_response": {
+          "type": "object",
+          "propertyNames": {
+            "type": "string"
+          }
+        },
+        "message": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "failures": {
+          "anyOf": [
+            {
+              "type": "integer"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "unique_id": {
+          "type": "string"
+        },
+        "compiled": {
+          "anyOf": [
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "compiled_code": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "relation_name": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "status",
+        "timing",
+        "thread_id",
+        "execution_time",
+        "adapter_response",
+        "message",
+        "failures",
+        "unique_id",
+        "compiled",
+        "compiled_code",
+        "relation_name"
+      ]
+    },
+    "RunResultsArtifact": {
+      "type": "object",
+      "title": "RunResultsArtifact",
+      "properties": {
+        "metadata": {
+          "$ref": "#/$defs/BaseArtifactMetadata"
+        },
+        "results": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/RunResultOutput"
+          }
+        },
+        "elapsed_time": {
+          "type": "number"
+        },
+        "args": {
+          "type": "object",
+          "propertyNames": {
+            "type": "string"
+          }
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "metadata",
+        "results",
+        "elapsed_time"
+      ]
+    }
+  },
+  "$id": "https://schemas.getdbt.com/dbt/run-results/v5.json"
+}