chore: add branded model string types

Author: benfdking

vscode/bus/src/brand.ts

@@ -0,0 +1,19 @@
+declare const __brand: unique symbol
+type Brand<B> = { [__brand]: B }
+
+/**
+ * Branded is a type that adds a brand to a type. It is a type that is used to
+ * ensure that the type is unique and that it is not possible to mix up types
+ * with the same brand.
+ *
+ * @example
+ *
+ * type UserId = Branded<string, 'UserId'>
+ * type UserName = Branded<string, 'UserName'>
+ *
+ * const userId = '123' as UserId
+ * const userName = 'John Doe' as UserName
+ *
+ * userId == userName -> compile error
+ */
+export type Branded<T, B> = T & Brand<B>

vscode/react/src/components/graph/ModelColumns.tsx

@@ -46,6 +46,7 @@ import { Popover, Transition } from '@headlessui/react'
 import { useApiColumnLineage } from '@/api/index'
 import SourceList from '@/components/sourceList/SourceList'
 import type { Lineage } from '@/domain/lineage'
+import type { ModelName } from '@/domain/models'
 
 export default function ModelColumns({
   nodeId,
@@ -732,5 +733,5 @@ function getColumnFromLineage(
   nodeId: string,
   columnName: string,
 ): LineageColumn | undefined {
-  return lineage?.[nodeId]?.columns?.[encodeURI(columnName)]
+  return lineage?.[nodeId]?.columns?.[encodeURI(columnName) as ModelName]
 }

vscode/react/src/components/graph/help.ts

@@ -17,6 +17,7 @@ import {
 } from './ModelNode'
 import type { Lineage } from '@/domain/lineage'
 import type { ConnectedNode } from '@/workers/lineage'
+import type { ModelEncodedFQN, ModelName } from '@/domain/models'
 
 export interface GraphNodeData {
   label: string
@@ -108,7 +109,7 @@ function getEdges(lineage: Record<string, Lineage> = {}): Edge[] {
     })
 
     for (const targetColumnName in targetModel.columns) {
-      const sourceModel = targetModel.columns[targetColumnName]
+      const sourceModel = targetModel.columns[targetColumnName as ModelName]
 
       if (isNil(sourceModel) || isNil(sourceModel.models)) continue
 
@@ -210,7 +211,7 @@ function getNodeMap({
       node.targetPosition = Position.Left
     }
 
-    if (sources.has(node.id)) {
+    if (sources.has(node.id as ModelEncodedFQN)) {
       node.sourcePosition = Position.Right
     }
 
@@ -343,7 +344,7 @@ function mergeLineageWithColumns(
       }
 
       // New Column Lineage delivers fresh data, so we can just assign it
-      currentLineageModel.columns[targetColumnNameEncoded] = {
+      currentLineageModel.columns[targetColumnNameEncoded as ModelName] = {
         expression: newLineageModelColumn.expression,
         source: newLineageModelColumn.source,
         models: {},
@@ -353,7 +354,7 @@ function mergeLineageWithColumns(
       if (isObjectEmpty(newLineageModelColumn.models)) continue
 
       const currentLineageModelColumn =
-        currentLineageModel.columns[targetColumnNameEncoded]!
+        currentLineageModel.columns[targetColumnNameEncoded as ModelName]!
       const currentLineageModelColumnModels = currentLineageModelColumn.models
 
       for (const sourceColumnName in newLineageModelColumn.models) {
@@ -371,7 +372,7 @@ function mergeLineageWithColumns(
                   newLineageModelColumnModel,
                 ),
           ),
-        ).map(encodeURI)
+        ).map((uri: string) => encodeURI(uri))
       }
     }
   }
@@ -481,7 +482,7 @@ function getLineageIndex(lineage: Record<string, Lineage> = {}): string {
 
       if (isNotNil(columns)) {
         Object.keys(columns).forEach(columnName => {
-          const column = columns[columnName]
+          const column = columns[columnName as ModelName]
 
           if (isNotNil(column) && isNotNil(column.models)) {
             Object.keys(column.models).forEach(m => allModels.add(m))

vscode/react/src/domain/lineage.ts

@@ -1,6 +1,7 @@
 import { type LineageColumn } from '@/api/client'
+import type { ModelEncodedFQN, ModelName } from '@/domain/models'
 
 export interface Lineage {
-  models: string[]
-  columns?: Record<string, LineageColumn>
+  models: ModelEncodedFQN[]
+  columns?: Record<ModelName, LineageColumn>
 }

vscode/react/src/domain/models.ts

@@ -0,0 +1,43 @@
+import type { Branded } from '@bus/brand'
+
+/**
+ * ModelName is a type that represents the name of a model.
+ */
+export type ModelName = Branded<string, 'ModelName'>
+
+/**
+ * ModelEncodedName is a type that represents the encoded name of a model.
+ */
+export type ModelEncodedName = Branded<string, 'ModelEncodedName'>
+
+/**
+ * ModelFQN is a type that represents the fully qualified name of a model.
+ */
+export type ModelFQN = Branded<string, 'ModelFQN'>
+
+/**
+ * ModelEncodedFQN is a type that represents the encoded fully qualified name of a model.
+ */
+export type ModelEncodedFQN = Branded<string, 'ModelEncodedFQN'>
+
+/**
+ * ModelURI is a type that represents the URI of a model.
+ */
+export type ModelURI = Branded<string, 'ModelURI'>
+
+/**
+ * ModelEncodedURI is a type that represents the encoded URI of a model.
+ */
+export type ModelEncodedURI = Branded<string, 'ModelEncodedURI'>
+
+/**
+ * ModelPath is a type that represents the path of a model.
+ * A model path is relative to the project root.
+ */
+export type ModelPath = Branded<string, 'ModelPath'>
+
+/**
+ * ModelFullPath is a type that represents the full path of a model.
+ * A model full path is a fully qualified path to a model.
+ */
+export type ModelFullPath = Branded<string, 'ModelFullPath'>

vscode/react/src/domain/sqlmesh-model.ts

@@ -8,12 +8,24 @@ import {
   type ModelDefaultCatalog,
   type ModelDefinition,
 } from '@/api/client'
+import type {
+  ModelEncodedFQN,
+  ModelName,
+  ModelPath,
+  ModelEncodedName,
+  ModelFullPath,
+} from '@/domain/models'
 import { isArrayNotEmpty } from '@/utils/index'
 import { ModelInitial } from './initial'
 import type { Lineage } from './lineage'
 
-export interface InitialSQLMeshModel extends Model {
-  lineage?: Record<string, Lineage>
+export interface InitialSQLMeshModel
+  extends Omit<Model, 'name' | 'fqn' | 'path' | 'full_path'> {
+  name: ModelName
+  fqn: ModelEncodedFQN
+  path: ModelPath
+  full_path: ModelFullPath
+  lineage?: Record<ModelName, Lineage>
 }
 
 export class ModelSQLMeshModel<
@@ -22,9 +34,10 @@ export class ModelSQLMeshModel<
   _details: ModelDetails = {}
   _detailsIndex: string = ''
 
-  name: string
-  fqn: string
-  path: string
+  name: ModelEncodedName
+  fqn: ModelEncodedFQN
+  path: ModelPath
+  full_path: ModelFullPath
   dialect: string
   type: ModelType
   columns: Column[]
@@ -46,10 +59,11 @@ export class ModelSQLMeshModel<
           },
     )
 
-    this.name = encodeURI(this.initial.name)
-    this.fqn = encodeURI(this.initial.fqn)
+    this.name = encodeURI(this.initial.name) as ModelEncodedName
+    this.fqn = encodeURI(this.initial.fqn) as ModelEncodedFQN
     this.default_catalog = this.initial.default_catalog
-    this.path = this.initial.path
+    this.path = this.initial.path as ModelPath
+    this.full_path = this.initial.full_path as ModelFullPath
     this.dialect = this.initial.dialect
     this.description = this.initial.description
     this.sql = this.initial.sql
@@ -127,17 +141,21 @@ export class ModelSQLMeshModel<
       } else if (key === 'details') {
         this.details = value as ModelDetails
       } else if (key === 'name') {
-        this.name = encodeURI(value as string)
+        this.name = encodeURI(value as string) as ModelEncodedName
       } else if (key === 'fqn') {
-        this.fqn = encodeURI(value as string)
+        this.fqn = encodeURI(value as string) as ModelEncodedFQN
       } else if (key === 'type') {
         this.type = value as ModelType
       } else if (key === 'default_catalog') {
         this.default_catalog = value as ModelDefaultCatalog
       } else if (key === 'description') {
         this.description = value as ModelDescription
+      } else if (key === 'full_path') {
+        this.full_path = value as ModelFullPath
+      } else if (key === 'path') {
+        this.path = value as ModelPath
       } else if (key in this) {
-        this[key as 'path' | 'dialect' | 'sql'] = value as string
+        this[key as 'dialect' | 'sql'] = value as string
       }
     }
   }

vscode/react/src/pages/lineage.tsx

@@ -16,6 +16,12 @@ import type { VSCodeEvent } from '@bus/callbacks'
 import { URI } from 'vscode-uri'
 import type { Model } from '@/api/client'
 import { useRpc } from '@/utils/rpc'
+import type {
+  ModelEncodedFQN,
+  ModelName,
+  ModelPath,
+  ModelFullPath,
+} from '@/domain/models'
 
 export function LineagePage() {
   const { emit } = useEventBus()
@@ -198,7 +204,13 @@ export function LineageComponentFromWeb({
   }
 
   const sqlmModel = new ModelSQLMeshModel()
-  sqlmModel.update(model)
+  sqlmModel.update({
+    ...model,
+    name: model.name as ModelName,
+    fqn: model.fqn as ModelEncodedFQN,
+    path: model.path as ModelPath,
+    full_path: model.full_path as ModelFullPath,
+  })
 
   return (
     <div className="h-[100vh] w-[100vw]">

vscode/react/src/workers/lineage.ts

@@ -1,5 +1,6 @@
 import { isFalse, isNil, isStringEmptyOrNil, toID } from '@/utils/index'
 import { type Lineage } from '@/domain/lineage'
+import type { ModelEncodedFQN } from '@/domain/models'
 
 export interface ConnectedNode {
   id?: string
@@ -47,7 +48,7 @@ async function mergeLineageWithModels(
       key = encodeURI(key)
 
       acc[key] = {
-        models: models.map(encodeURI),
+        models: models.map(encodeURI) as ModelEncodedFQN[],
         columns: currentLineage?.[key]?.columns ?? undefined,
       }
 
@@ -88,7 +89,7 @@ function getConnectedNodes(
 
   if (isDownstream) {
     models = Object.keys(lineage).filter(key =>
-      lineage[key]!.models.includes(node),
+      lineage[key]!.models.includes(node as ModelEncodedFQN),
     )
   } else {
     models = lineage[node]?.models ?? []