Feat: Docs lineage for change categories (#817)

Author: mykalmax

web/client/openapi.json

@@ -960,18 +960,20 @@
       },
       "Model": {
         "title": "Model",
-        "required": ["name", "path", "dialect", "columns"],
+        "required": ["name", "path", "dialect", "type", "columns"],
         "type": "object",
         "properties": {
           "name": { "title": "Name", "type": "string" },
           "path": { "title": "Path", "type": "string" },
           "dialect": { "title": "Dialect", "type": "string" },
+          "type": { "title": "Type", "type": "string" },
           "columns": {
             "title": "Columns",
             "type": "array",
             "items": { "$ref": "#/components/schemas/Column" }
           },
           "description": { "title": "Description", "type": "string" },
+          "owner": { "title": "Owner", "type": "string" },
           "details": { "$ref": "#/components/schemas/ModelDetails" },
           "sql": { "title": "Sql", "type": "string" }
         }
@@ -1017,8 +1019,7 @@
           "contains_star_query": {
             "title": "Contains Star Query",
             "type": "boolean"
-          },
-          "type": { "title": "Type", "type": "string" }
+          }
         }
       },
       "ModelsDiff": {
@@ -1163,7 +1164,7 @@
         "title": "SnapshotChangeCategory",
         "enum": [1, 2, 3, 4, 5],
         "type": "integer",
-        "description": "Values are ordered by decreasing severity and that ordering is required.\n\nBREAKING: The change requires that snapshot modified and downstream dependencies be rebuilt\nNON_BREAKING: The change requires that only the snapshot modified be rebuilt\nFORWARD_ONLY: The change requires no rebuilding\nINDIRECT_BREAKING: The change was caused indirectly and is breaking.\nINDIRECT_FORWARD_ONLY: The change was caused indirectly and is forward-only."
+        "description": "Values are ordered by decreasing severity and that ordering is required.\n\nBREAKING: The change requires that snapshot modified and downstream dependencies be rebuilt\nNON_BREAKING: The change requires that only the snapshot modified be rebuilt\nFORWARD_ONLY: The change requires no rebuilding\nINDIRECT_BREAKING: The change was caused indirectly and is breaking.\nINDIRECT_NON_BREAKING: The change was caused indirectly by a non-breaking change."
       },
       "SnapshotDataVersion": {
         "title": "SnapshotDataVersion",

web/client/src/context/context.ts

@@ -1,3 +1,4 @@
+import { ModelSQLMeshModel } from '@models/sqlmesh-model'
 import { create } from 'zustand'
 import {
   type Model,
@@ -17,8 +18,9 @@ interface ContextStore {
   environments: Set<ModelEnvironment>
   initialStartDate?: ContextEnvironmentStart
   initialEndDate?: ContextEnvironmentEnd
-  models: Map<string, Model>
+  models: Map<string, ModelSQLMeshModel>
   setModels: (models?: Model[]) => void
+  refreshModels: () => void
   isExistingEnvironment: (
     environment: ModelEnvironment | EnvironmentName,
   ) => boolean
@@ -46,15 +48,30 @@ export const useStoreContext = create<ContextStore>((set, get) => ({
   initialEndDate: undefined,
   models: new Map(),
   setModels(models = []) {
+    const s = get()
+
     set(() => ({
-      models: models.reduce((acc, model) => {
-        acc.set(model.name, model)
-        acc.set(model.path, model)
+      models: models.reduce((acc: Map<string, ModelSQLMeshModel>, model) => {
+        let tempModel = s.models.get(model.path) ?? s.models.get(model.name)
+
+        if (tempModel == null) {
+          tempModel = new ModelSQLMeshModel(model)
+        } else {
+          tempModel.update(model)
+        }
+
+        acc.set(model.name, tempModel)
+        acc.set(model.path, tempModel)
 
         return acc
       }, new Map()),
     }))
   },
+  refreshModels() {
+    set(() => ({
+      models: new Map(get().models),
+    }))
+  },
   getNextEnvironment() {
     return get().environments.values().next().value
   },

web/client/src/context/editor.ts

@@ -1,8 +1,4 @@
-import {
-  type Model,
-  type ColumnLineageApiLineageModelNameColumnNameGet200,
-} from '@api/client'
-import { uid, isObjectEmpty } from '@utils/index'
+import { uid } from '@utils/index'
 import { create } from 'zustand'
 import useLocalStorage from '~/hooks/useLocalStorage'
 import { ModelFile } from '~/models'
@@ -33,7 +29,6 @@ interface EditorStore {
   previewQuery?: string
   previewTable?: any[]
   previewConsole?: string
-  previewLineage?: Record<string, Lineage>
   selectTab: (tab?: EditorTab) => void
   updateStoredTabsIds: () => void
   addTab: (tab: EditorTab) => void
@@ -44,11 +39,6 @@ interface EditorStore {
   setPreviewQuery: (previewQuery?: string) => void
   setPreviewTable: (previewTable?: any[]) => void
   setPreviewConsole: (previewConsole?: string) => void
-  setPreviewLineage: (
-    models: Map<string, Model>,
-    previewLineage?: Record<string, Lineage>,
-    columns?: ColumnLineageApiLineageModelNameColumnNameGet200,
-  ) => void
 }
 
 interface EditorPreview<TTable = any> {
@@ -86,7 +76,6 @@ export const useStoreEditor = create<EditorStore>((set, get) => ({
   previewQuery: undefined,
   previewTable: undefined,
   previewConsole: undefined,
-  previewLineage: undefined,
   updateStoredTabsIds() {
     setStoredTabs({
       ids: Array.from(get().tabs.values())
@@ -135,6 +124,10 @@ export const useStoreEditor = create<EditorStore>((set, get) => ({
 
     if (s.tabs.size === 0) {
       s.selectTab(undefined)
+    } else if (s.tabs.size === 1) {
+      const tabs = Array.from(s.tabs.values())
+
+      s.selectTab(tabs.at(0) as EditorTab)
     } else if (file.id === s.tab?.file.id) {
       const tabs = Array.from(s.tabs.values())
       const indexAt = tabs.findIndex(tab => tab.file === file)
@@ -158,15 +151,6 @@ export const useStoreEditor = create<EditorStore>((set, get) => ({
   setPreviewConsole(previewConsole) {
     set(() => ({ previewConsole }))
   },
-  setPreviewLineage(models, lineage, columns) {
-    const previewLineage = structuredClone(lineage)
-
-    if (columns != null && previewLineage != null) {
-      mergeLineageWithColumns(models, previewLineage, columns)
-    }
-
-    set(() => ({ previewLineage }))
-  },
 }))
 
 function createTab(file: ModelFile = createLocalFile()): EditorTab {
@@ -190,83 +174,3 @@ function createLocalFile(): ModelFile {
 function getStoredTabsIds(): ID[] {
   return getStoredTabs()?.ids ?? []
 }
-
-// TODO: use better merge
-function mergeLineageWithColumns(
-  models: Map<string, Model>,
-  lineage: Record<string, Lineage>,
-  columns: ColumnLineageApiLineageModelNameColumnNameGet200,
-): Record<string, Lineage> {
-  for (const model in columns) {
-    const lineageModel = lineage[model]
-    const columnsModel = columns[model]
-
-    if (lineageModel == null || columnsModel == null) continue
-
-    if (lineageModel.columns == null) {
-      lineageModel.columns = {}
-    }
-
-    for (const columnName in columnsModel) {
-      const columnsModelColumn = columnsModel[columnName]
-
-      if (columnsModelColumn == null) continue
-
-      const lineageModelColumn = lineageModel.columns[columnName] ?? {}
-
-      lineageModelColumn.source = columnsModelColumn.source
-      lineageModelColumn.models = {}
-
-      lineageModel.columns[columnName] = lineageModelColumn
-
-      if (isObjectEmpty(columnsModelColumn.models)) continue
-
-      for (const columnModel in columnsModelColumn.models) {
-        const columnsModelColumnModel = columnsModelColumn.models[columnModel]
-
-        if (columnsModelColumnModel == null) continue
-
-        const lineageModelColumnModel = lineageModelColumn.models[columnModel]
-
-        if (lineageModelColumnModel == null) {
-          lineageModelColumn.models[columnModel] = columnsModelColumnModel
-        } else {
-          lineageModelColumn.models[columnModel] = Array.from(
-            new Set(lineageModelColumnModel.concat(columnsModelColumnModel)),
-          )
-        }
-      }
-    }
-  }
-
-  for (const modelName in lineage) {
-    const model = models.get(modelName)
-    const modelLineage = lineage[modelName]
-
-    if (model == null || modelLineage == null) {
-      delete lineage[modelName]
-
-      continue
-    }
-
-    if (modelLineage.columns == null) continue
-
-    if (model.columns == null) {
-      delete modelLineage.columns
-
-      continue
-    }
-
-    for (const columnName in modelLineage.columns) {
-      const found = model.columns.find(c => c.name === columnName)
-
-      if (found == null) {
-        delete modelLineage.columns[columnName]
-
-        continue
-      }
-    }
-  }
-
-  return lineage
-}

web/client/src/context/lineage.tsx

@@ -204,8 +204,8 @@ html[mode='dark'] {
   --color-editor-text: var(--color-neutral-300);
   --color-editor-active-line-text: var(--color-neutral-100);
 
-  --color-graph-edge-main: var(--color-primary-80);
-  --color-graph-edge-secondary: var(--color-primary-40);
+  --color-graph-edge-secondary: var(--color-primary-80);
+  --color-graph-edge-main: var(--color-primary-40);
 }
 
 html[mode='light'] {
@@ -228,8 +228,8 @@ html[mode='light'] {
   --color-editor-text: var(--color-neutral-600);
   --color-editor-active-line-text: var(--color-neutral-800);
 
-  --color-graph-edge-main: var(--color-secondary-80);
-  --color-graph-edge-secondary: var(--color-secondary-40);
+  --color-graph-edge-secondary: var(--color-secondary-80);
+  --color-graph-edge-main: var(--color-secondary-40);
 }
 
 html {