@finos/legend-graph 4.0.3 → 6.0.1

package/src/graph/BasicModel.ts

@@ -17,18 +17,16 @@
 import {
   type Clazz,
   ActionState,
-  assertNonEmptyString,
   UnsupportedOperationError,
   getClass,
-  guaranteeNonNullable,
   IllegalStateError,
   returnUndefOnError,
   promisify,
+  filterByType,
+  guaranteeNonNullable,
+  guaranteeType,
 } from '@finos/legend-shared';
-import {
-  type ROOT_PACKAGE_NAME,
-  ELEMENT_PATH_DELIMITER,
-} from '../MetaModelConst';
+import type { ROOT_PACKAGE_NAME } from '../MetaModelConst';
 import { Package } from '../models/metamodels/pure/packageableElements/domain/Package';
 import { Type } from '../models/metamodels/pure/packageableElements/domain/Type';
 import { Association } from '../models/metamodels/pure/packageableElements/domain/Association';
@@ -61,9 +59,12 @@ import {
   resolvePackagePathAndElementName,
 } from '../MetaModelUtils';
 import {
-  _package_addElement,
-  _package_deleteElement,
+  addElementToPackage,
+  deleteElementFromPackage,
+  getOrCreateGraphPackage,
+  getOrCreatePackage,
 } from '../helpers/DomainHelper';
+import { DataElement } from '../models/metamodels/pure/packageableElements/data/DataElement';
 
 const FORBIDDEN_EXTENSION_ELEMENT_CLASS = new Set([
   PackageableElement,
@@ -85,6 +86,7 @@ const FORBIDDEN_EXTENSION_ELEMENT_CLASS = new Set([
   Service,
   GenerationSpecification,
   FileGenerationSpecification,
+  DataElement,
 ]);
 
 /**
@@ -125,6 +127,7 @@ export abstract class BasicModel {
     string,
     FileGenerationSpecification
   >();
+  private readonly dataElementsIndex = new Map<string, DataElement>();
 
   constructor(
     rootPackageName: ROOT_PACKAGE_NAME,
@@ -155,23 +158,14 @@ export abstract class BasicModel {
   }
   get ownEnumerations(): Enumeration[] {
     return Array.from(this.typesIndex.values()).filter(
-      (type: Type): type is Enumeration => type instanceof Enumeration,
+      filterByType(Enumeration),
     );
   }
   get ownMeasures(): Measure[] {
-    return Array.from(this.typesIndex.values()).filter(
-      (type: Type): type is Measure => type instanceof Measure,
-    );
-  }
-  get ownUnits(): Unit[] {
-    return Array.from(this.typesIndex.values()).filter(
-      (type: Type): type is Unit => type instanceof Unit,
-    );
+    return Array.from(this.typesIndex.values()).filter(filterByType(Measure));
   }
   get ownClasses(): Class[] {
-    return Array.from(this.typesIndex.values()).filter(
-      (type: Type): type is Class => type instanceof Class,
-    );
+    return Array.from(this.typesIndex.values()).filter(filterByType(Class));
   }
   get ownTypes(): Type[] {
     return Array.from(this.typesIndex.values());
@@ -186,14 +180,10 @@ export abstract class BasicModel {
     return Array.from(this.storesIndex.values());
   }
   get ownFlatDatas(): FlatData[] {
-    return Array.from(this.storesIndex.values()).filter(
-      (store: Store): store is FlatData => store instanceof FlatData,
-    );
+    return Array.from(this.storesIndex.values()).filter(filterByType(FlatData));
   }
   get ownDatabases(): Database[] {
-    return Array.from(this.storesIndex.values()).filter(
-      (store: Store): store is Database => store instanceof Database,
-    );
+    return Array.from(this.storesIndex.values()).filter(filterByType(Database));
   }
   get ownMappings(): Mapping[] {
     return Array.from(this.mappingsIndex.values());
@@ -210,6 +200,9 @@ export abstract class BasicModel {
   get ownFileGenerations(): FileGenerationSpecification[] {
     return Array.from(this.fileGenerationsIndex.values());
   }
+  get ownDataElements(): DataElement[] {
+    return Array.from(this.dataElementsIndex.values());
+  }
   get ownGenerationSpecifications(): GenerationSpecification[] {
     return Array.from(this.generationSpecificationsIndex.values());
   }
@@ -238,52 +231,147 @@ export abstract class BasicModel {
     return extensions[0] as PureGraphExtension<T>;
   }
 
-  getOwnSection = (path: string): Section | undefined =>
+  getOwnNullableSection = (path: string): Section | undefined =>
     this.elementSectionMap.get(path);
-  getOwnSectionIndex = (path: string): SectionIndex | undefined =>
+
+  getOwnNullableSectionIndex = (path: string): SectionIndex | undefined =>
     this.sectionIndicesIndex.get(path);
-  getOwnProfile = (path: string): Profile | undefined =>
+  getOwnNullableProfile = (path: string): Profile | undefined =>
     this.profilesIndex.get(path);
-  getOwnType = (path: string): Type | undefined => this.typesIndex.get(path);
-  getOwnClass = (path: string): Class | undefined => {
-    const el = this.getOwnType(path);
+  getOwnNullableType = (path: string): Type | undefined =>
+    this.typesIndex.get(path);
+  getOwnNullableClass = (path: string): Class | undefined => {
+    const el = this.getOwnNullableType(path);
     return el instanceof Class ? el : undefined;
   };
-  getOwnEnumeration = (path: string): Enumeration | undefined => {
-    const el = this.getOwnType(path);
+  getOwnNullableEnumeration = (path: string): Enumeration | undefined => {
+    const el = this.getOwnNullableType(path);
     return el instanceof Enumeration ? el : undefined;
   };
-  getOwnMeasure = (path: string): Measure | undefined => {
-    const el = this.getOwnType(path);
+  getOwnNullableMeasure = (path: string): Measure | undefined => {
+    const el = this.getOwnNullableType(path);
     return el instanceof Measure ? el : undefined;
   };
-  getOwnUnit = (path: string): Unit | undefined => {
-    const el = this.getOwnType(path);
-    return el instanceof Unit ? el : undefined;
-  };
-  getOwnAssociation = (path: string): Association | undefined =>
+  getOwnNullableAssociation = (path: string): Association | undefined =>
     this.associationsIndex.get(path);
-  getOwnFunction = (path: string): ConcreteFunctionDefinition | undefined =>
-    this.functionsIndex.get(path);
-  getOwnStore = (path: string): Store | undefined => this.storesIndex.get(path);
-  getOwnMapping = (path: string): Mapping | undefined =>
+  getOwnNullableFunction = (
+    path: string,
+  ): ConcreteFunctionDefinition | undefined => this.functionsIndex.get(path);
+  getOwnNullableStore = (path: string): Store | undefined =>
+    this.storesIndex.get(path);
+  getOwnNullableMapping = (path: string): Mapping | undefined =>
     this.mappingsIndex.get(path);
-  getOwnConnection = (path: string): PackageableConnection | undefined =>
-    this.connectionsIndex.get(path);
-  getOwnRuntime = (path: string): PackageableRuntime | undefined =>
+  getOwnNullableConnection = (
+    path: string,
+  ): PackageableConnection | undefined => this.connectionsIndex.get(path);
+  getOwnNullableRuntime = (path: string): PackageableRuntime | undefined =>
     this.runtimesIndex.get(path);
-  getOwnService = (path: string): Service | undefined =>
+  getOwnNullableService = (path: string): Service | undefined =>
     this.servicesIndex.get(path);
-  getOwnGenerationSpecification = (
+  getOwnNullableGenerationSpecification = (
     path: string,
   ): GenerationSpecification | undefined =>
     this.generationSpecificationsIndex.get(path);
-  getOwnFileGeneration = (
+  getOwnNullableFileGeneration = (
     path: string,
   ): FileGenerationSpecification | undefined =>
     this.fileGenerationsIndex.get(path);
+  getOwnNullableDataElement = (path: string): DataElement | undefined =>
+    this.dataElementsIndex.get(path);
+  getOwnSectionIndex = (path: string): SectionIndex =>
+    guaranteeNonNullable(
+      this.getOwnNullableSectionIndex(path),
+      `Can't find section index '${path}'`,
+    );
+  getOwnProfile = (path: string): Profile =>
+    guaranteeNonNullable(
+      this.getOwnNullableProfile(path),
+      `Can't find profile '${path}'`,
+    );
+  getOwnType = (path: string): Type =>
+    guaranteeNonNullable(
+      this.getOwnNullableType(path),
+      `Can't find type '${path}'`,
+    );
+  getOwnClass = (path: string): Class =>
+    guaranteeNonNullable(
+      this.getOwnNullableClass(path),
+      `Can't find class '${path}'`,
+    );
+  getOwnEnumeration = (path: string): Enumeration =>
+    guaranteeNonNullable(
+      this.getOwnNullableEnumeration(path),
+      `Can't find enumeration '${path}'`,
+    );
+  getOwnMeasure = (path: string): Measure =>
+    guaranteeNonNullable(
+      this.getOwnNullableMeasure(path),
+      `Can't find measure '${path}'`,
+    );
+  getOwnAssociation = (path: string): Association =>
+    guaranteeNonNullable(
+      this.getOwnNullableAssociation(path),
+      `Can't find association '${path}'`,
+    );
+  getOwnFunction = (path: string): ConcreteFunctionDefinition =>
+    guaranteeNonNullable(
+      this.getOwnNullableFunction(path),
+      `Can't find function '${path}'`,
+    );
+  getOwnStore = (path: string): Store =>
+    guaranteeNonNullable(
+      this.getOwnNullableStore(path),
+      `Can't find store '${path}'`,
+    );
+  getOwnDatabase = (path: string): Database =>
+    guaranteeType(
+      this.getOwnNullableStore(path),
+      Database,
+      `Can't find database '${path}'`,
+    );
+  getOwnFlatDataStore = (path: string): FlatData =>
+    guaranteeType(
+      this.getOwnNullableStore(path),
+      FlatData,
+      `Can't find flat-data store '${path}'`,
+    );
+  getOwnMapping = (path: string): Mapping =>
+    guaranteeNonNullable(
+      this.getOwnNullableMapping(path),
+      `Can't find mapping '${path}'`,
+    );
+  getOwnConnection = (path: string): PackageableConnection =>
+    guaranteeNonNullable(
+      this.getOwnNullableConnection(path),
+      `Can't find connection '${path}'`,
+    );
+  getOwnRuntime = (path: string): PackageableRuntime =>
+    guaranteeNonNullable(
+      this.getOwnNullableRuntime(path),
+      `Can't find runtime '${path}'`,
+    );
+  getOwnService = (path: string): Service =>
+    guaranteeNonNullable(
+      this.getOwnNullableService(path),
+      `Can't find service '${path}'`,
+    );
+  getOwnGenerationSpecification = (path: string): GenerationSpecification =>
+    guaranteeNonNullable(
+      this.getOwnNullableGenerationSpecification(path),
+      `Can't find generation specification '${path}'`,
+    );
+  getOwnFileGeneration = (path: string): FileGenerationSpecification =>
+    guaranteeNonNullable(
+      this.getOwnNullableFileGeneration(path),
+      `Can't find file generation '${path}'`,
+    );
+  getOwnDataElement = (path: string): DataElement =>
+    guaranteeNonNullable(
+      this.getOwnNullableDataElement(path),
+      `Can't find data element '${path}'`,
+    );
 
-  getOwnExtensionElement<T extends PackageableElement>(
+  getOwnNullableExtensionElement<T extends PackageableElement>(
     path: string,
     extensionElementClass: Clazz<T>,
   ): T | undefined {
@@ -334,6 +422,10 @@ export abstract class BasicModel {
     this.fileGenerationsIndex.set(path, val);
   }
 
+  setOwnDataElement(path: string, val: DataElement): void {
+    this.dataElementsIndex.set(path, val);
+  }
+
   setOwnElementInExtension<T extends PackageableElement>(
     path: string,
     val: T,
@@ -344,7 +436,6 @@ export abstract class BasicModel {
   }
 
   get allOwnElements(): PackageableElement[] {
-    this.extensions.flatMap((extension) => extension.elements);
     return [
       ...this.ownProfiles,
       ...this.ownEnumerations,
@@ -359,6 +450,7 @@ export abstract class BasicModel {
       ...this.ownConnections,
       ...this.ownGenerationSpecifications,
       ...this.ownFileGenerations,
+      ...this.ownDataElements,
       ...this.extensions.flatMap((extension) => extension.elements),
     ];
   }
@@ -380,29 +472,11 @@ export abstract class BasicModel {
     }
   }
 
-  // TODO
-  buildPath = (
-    packagePath: string | undefined,
-    name: string | undefined,
-  ): string =>
-    `${guaranteeNonNullable(
-      packagePath,
-      'Package path is required',
-    )}${ELEMENT_PATH_DELIMITER}${guaranteeNonNullable(
-      name,
-      'Name is required',
-    )}`;
-
-  getOrCreatePackage = (packagePath: string | undefined): Package => {
-    assertNonEmptyString(packagePath, 'Package path is required');
-    return Package.getOrCreatePackage(this.root, packagePath, true);
-  };
-
   getNullablePackage = (path: string): Package | undefined =>
     !path
       ? this.root
       : returnUndefOnError(() =>
-          Package.getOrCreatePackage(this.root, path, false),
+          getOrCreatePackage(this.root, path, false, undefined),
         );
 
   getOwnNullableElement(
@@ -421,6 +495,7 @@ export abstract class BasicModel {
       this.runtimesIndex.get(path) ??
       this.connectionsIndex.get(path) ??
       this.fileGenerationsIndex.get(path) ??
+      this.dataElementsIndex.get(path) ??
       this.generationSpecificationsIndex.get(path);
     if (!element) {
       for (const extension of this.extensions) {
@@ -437,9 +512,53 @@ export abstract class BasicModel {
     return element;
   }
 
+  protected addOwnElement(
+    element: PackageableElement,
+    packagePath: string | undefined,
+  ): void {
+    addElementToPackage(
+      packagePath
+        ? getOrCreateGraphPackage(this, packagePath, undefined)
+        : this.root,
+      element,
+    );
+    if (element instanceof Mapping) {
+      this.setOwnMapping(element.path, element);
+    } else if (element instanceof Store) {
+      this.setOwnStore(element.path, element);
+    } else if (element instanceof Type) {
+      this.setOwnType(element.path, element);
+    } else if (element instanceof Association) {
+      this.setOwnAssociation(element.path, element);
+    } else if (element instanceof Profile) {
+      this.setOwnProfile(element.path, element);
+    } else if (element instanceof ConcreteFunctionDefinition) {
+      this.setOwnFunction(element.path, element);
+    } else if (element instanceof Service) {
+      this.setOwnService(element.path, element);
+    } else if (element instanceof PackageableConnection) {
+      this.setOwnConnection(element.path, element);
+    } else if (element instanceof PackageableRuntime) {
+      this.setOwnRuntime(element.path, element);
+    } else if (element instanceof FileGenerationSpecification) {
+      this.setOwnFileGeneration(element.path, element);
+    } else if (element instanceof GenerationSpecification) {
+      this.setOwnGenerationSpecification(element.path, element);
+    } else if (element instanceof DataElement) {
+      this.setOwnDataElement(element.path, element);
+    } else if (element instanceof Package) {
+      // do nothing
+    } else {
+      const extension = this.getExtensionForElementClass(
+        getClass<PackageableElement>(element),
+      );
+      extension.setElement(element.path, element);
+    }
+  }
+
   deleteOwnElement(element: PackageableElement): void {
     if (element.package) {
-      _package_deleteElement(element.package, element);
+      deleteElementFromPackage(element.package, element);
     }
     if (element instanceof Mapping) {
       this.mappingsIndex.delete(element.path);
@@ -471,8 +590,10 @@ export abstract class BasicModel {
       this.fileGenerationsIndex.delete(element.path);
     } else if (element instanceof GenerationSpecification) {
       this.generationSpecificationsIndex.delete(element.path);
+    } else if (element instanceof DataElement) {
+      this.dataElementsIndex.delete(element.path);
     } else if (element instanceof Package) {
-      element.children.forEach(this.deleteOwnElement);
+      element.children.forEach((child) => this.deleteOwnElement(child));
     } else {
       const extension = this.getExtensionForElementClass(
         getClass<PackageableElement>(element),
@@ -526,15 +647,17 @@ export abstract class BasicModel {
     if (!(element instanceof Package)) {
       const parentPackage =
         this.getNullablePackage(packagePath) ??
-        (packagePath !== '' ? this.getOrCreatePackage(packagePath) : this.root);
+        (packagePath !== ''
+          ? getOrCreateGraphPackage(this, packagePath, undefined)
+          : this.root);
       // update element name
       element.name = elementName;
       // update element package if needed
       if (element.package !== parentPackage) {
         if (element.package) {
-          _package_deleteElement(element.package, element);
+          deleteElementFromPackage(element.package, element);
         }
-        _package_addElement(parentPackage, element);
+        addElementToPackage(parentPackage, element);
       }
     }
 
@@ -585,6 +708,9 @@ export abstract class BasicModel {
     } else if (element instanceof FileGenerationSpecification) {
       this.fileGenerationsIndex.delete(elementCurrentPath);
       this.fileGenerationsIndex.set(newPath, element);
+    } else if (element instanceof DataElement) {
+      this.dataElementsIndex.delete(elementCurrentPath);
+      this.dataElementsIndex.set(newPath, element);
     } else if (element instanceof GenerationSpecification) {
       this.generationSpecificationsIndex.delete(elementCurrentPath);
       this.generationSpecificationsIndex.set(newPath, element);
@@ -611,10 +737,12 @@ export abstract class BasicModel {
        */
       const currentParentPackage = element.package;
       if (currentParentPackage !== this.getNullablePackage(packagePath)) {
-        _package_deleteElement(currentParentPackage, element);
+        deleteElementFromPackage(currentParentPackage, element);
         const newParentPackage =
-          packagePath !== '' ? this.getOrCreatePackage(packagePath) : this.root;
-        _package_addElement(newParentPackage, element);
+          packagePath !== ''
+            ? getOrCreateGraphPackage(this, packagePath, undefined)
+            : this.root;
+        addElementToPackage(newParentPackage, element);
       }
       childElements.forEach((childElement, childElementOriginalPath) => {
         this.renameOwnElement(
@@ -631,7 +759,8 @@ export abstract class BasicModel {
   }
 
   /**
-   * TODO: this will be removed once we fully support section index in SDLC flow
+   * TODO: this will be removed once we have full support for section index
+   * See https://github.com/finos/legend-studio/issues/1067
    */
   TEMPORARY__deleteOwnSectionIndex(): void {
     this.sectionIndicesIndex.forEach((sectionIndex) => {
@@ -639,7 +768,8 @@ export abstract class BasicModel {
       this.sectionIndicesIndex.delete(sectionIndex.path);
     });
     // NOTE: we have to do this because right now we don't add section index to the package tree
-    // as such `this.sectionIndicesIndex.delete(sectionIndex.path)` won't work because the path is without the package
+    // as such `this.sectionIndicesIndex.delete(sectionIndex.path)` won't work because the path
+    // is without the package
     this.sectionIndicesIndex = new Map<string, SectionIndex>();
     this.elementSectionMap = new Map<string, Section>();
   }