@finos/legend-graph 10.1.2 → 13.0.0

package/src/graph/metamodel/pure/valueSpecification/GraphFetchTree.ts

@@ -0,0 +1,81 @@
+/**
+ * Copyright (c) 2020-present, Goldman Sachs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import type { Class } from '../packageableElements/domain/Class.js';
+import type { PropertyReference } from '../packageableElements/domain/PropertyReference.js';
+import type { PackageableElementReference } from '../packageableElements/PackageableElementReference.js';
+import type {
+  ValueSpecification,
+  ValueSpecificationVisitor,
+} from './ValueSpecification.js';
+import { InstanceValue } from './InstanceValue.js';
+
+export abstract class GraphFetchTree {
+  subTrees: GraphFetchTree[] = [];
+
+  get isEmpty(): boolean {
+    return !this.subTrees.length;
+  }
+}
+
+export class RootGraphFetchTree extends GraphFetchTree {
+  class: PackageableElementReference<Class>;
+
+  constructor(_class: PackageableElementReference<Class>) {
+    super();
+    this.class = _class;
+  }
+}
+
+export class PropertyGraphFetchTree extends GraphFetchTree {
+  property: PropertyReference;
+  alias?: string | undefined;
+  parameters: ValueSpecification[] = []; //TODO
+  subType?: PackageableElementReference<Class> | undefined;
+
+  constructor(
+    property: PropertyReference,
+    subType: PackageableElementReference<Class> | undefined,
+  ) {
+    super();
+    this.property = property;
+    this.subType = subType;
+  }
+}
+
+export abstract class GraphFetchTreeInstanceValue extends InstanceValue {
+  override values: GraphFetchTree[] = [];
+}
+
+export class PropertyGraphFetchTreeInstanceValue extends GraphFetchTreeInstanceValue {
+  override values: PropertyGraphFetchTree[] = [];
+
+  override accept_ValueSpecificationVisitor<T>(
+    visitor: ValueSpecificationVisitor<T>,
+  ): T {
+    return visitor.visit_PropertyGraphFetchTreeInstanceValue(this);
+  }
+}
+
+export class RootGraphFetchTreeInstanceValue extends GraphFetchTreeInstanceValue {
+  override values: RootGraphFetchTree[] = [];
+
+  override accept_ValueSpecificationVisitor<T>(
+    visitor: ValueSpecificationVisitor<T>,
+  ): T {
+    return visitor.visit_RootGraphFetchTreeInstanceValue(this);
+  }
+}

package/src/graphManager/AbstractPureGraphManager.ts

@@ -19,59 +19,58 @@ import type {
   EXECUTION_SERIALIZATION_FORMAT,
 } from './action/execution/ExecutionResult.js';
 import type { ServiceRegistrationResult } from './action/service/ServiceRegistrationResult.js';
-import type { Service } from '../models/metamodels/pure/packageableElements/service/Service.js';
+import type { Service } from '../graph/metamodel/pure/packageableElements/service/Service.js';
 import type {
   ImportConfigurationDescription,
   ImportMode,
 } from './action/generation/ImportConfigurationDescription.js';
-import type { FileGenerationSpecification } from '../models/metamodels/pure/packageableElements/fileGeneration/FileGenerationSpecification.js';
+import type { FileGenerationSpecification } from '../graph/metamodel/pure/packageableElements/fileGeneration/FileGenerationSpecification.js';
 import type { GenerationOutput } from './action/generation/GenerationOutput.js';
-import type { PackageableElement } from '../models/metamodels/pure/packageableElements/PackageableElement.js';
-import type { PureModel, CoreModel, SystemModel } from '../graph/PureModel.js';
-import type { Mapping } from '../models/metamodels/pure/packageableElements/mapping/Mapping.js';
-import type { Runtime } from '../models/metamodels/pure/packageableElements/runtime/Runtime.js';
+import type { PackageableElement } from '../graph/metamodel/pure/packageableElements/PackageableElement.js';
+import { PureModel, CoreModel, SystemModel } from '../graph/PureModel.js';
+import type { Mapping } from '../graph/metamodel/pure/packageableElements/mapping/Mapping.js';
+import type { Runtime } from '../graph/metamodel/pure/packageableElements/runtime/Runtime.js';
 import type { DependencyManager } from '../graph/DependencyManager.js';
-import type { Class } from '../models/metamodels/pure/packageableElements/domain/Class.js';
-import type { RawLambda } from '../models/metamodels/pure/rawValueSpecification/RawLambda.js';
+import type { Class } from '../graph/metamodel/pure/packageableElements/domain/Class.js';
+import type { RawLambda } from '../graph/metamodel/pure/rawValueSpecification/RawLambda.js';
 import type {
   GenerationConfigurationDescription,
   GenerationMode,
 } from './action/generation/GenerationConfigurationDescription.js';
-import type { ValueSpecification } from '../models/metamodels/pure/valueSpecification/ValueSpecification.js';
-import type { RawValueSpecification } from '../models/metamodels/pure/rawValueSpecification/RawValueSpecification.js';
+import type { ValueSpecification } from '../graph/metamodel/pure/valueSpecification/ValueSpecification.js';
+import type { RawValueSpecification } from '../graph/metamodel/pure/rawValueSpecification/RawValueSpecification.js';
 import type { ServiceExecutionMode } from './action/service/ServiceExecutionMode.js';
 import type { TEMPORARY__AbstractEngineConfig } from './action/TEMPORARY__AbstractEngineConfig.js';
 import type { DatabaseBuilderInput } from './action/generation/DatabaseBuilderInput.js';
-import type { RawRelationalOperationElement } from '../models/metamodels/pure/packageableElements/store/relational/model/RawRelationalOperationElement.js';
+import type { RawRelationalOperationElement } from '../graph/metamodel/pure/packageableElements/store/relational/model/RawRelationalOperationElement.js';
 import type {
   ExecutionPlan,
   RawExecutionPlan,
-} from '../models/metamodels/pure/executionPlan/ExecutionPlan.js';
-import type { ExecutionNode } from '../models/metamodels/pure/executionPlan/nodes/ExecutionNode.js';
-import type {
+} from '../graph/metamodel/pure/executionPlan/ExecutionPlan.js';
+import type { ExecutionNode } from '../graph/metamodel/pure/executionPlan/nodes/ExecutionNode.js';
+import {
   ActionState,
-  Log,
-  ServerClientConfig,
-  TracerService,
+  type Log,
+  type ServerClientConfig,
+  type TracerService,
 } from '@finos/legend-shared';
 import type { LightQuery, Query } from './action/query/Query.js';
-import type { Entity } from '@finos/legend-model-storage';
+import type { Entity } from '@finos/legend-storage';
 import type { QuerySearchSpecification } from './action/query/QuerySearchSpecification.js';
 import type { ExternalFormatDescription } from './action/externalFormat/ExternalFormatDescription.js';
-import type { ConfigurationProperty } from '../models/metamodels/pure/packageableElements/fileGeneration/ConfigurationProperty.js';
+import type { ConfigurationProperty } from '../graph/metamodel/pure/packageableElements/fileGeneration/ConfigurationProperty.js';
 import type { GraphBuilderReport } from './GraphBuilderReport.js';
-import type { ModelGenerationConfiguration } from '../models/ModelGenerationConfiguration.js';
-import type { RunTestsTestableInput } from '../models/metamodels/pure/test/result/RunTestsTestableInput.js';
-import type { TestResult } from '../models/metamodels/pure/test/result/TestResult.js';
-import type { GraphPluginManager } from '../GraphPluginManager.js';
-import type { Testable } from '../models/metamodels/pure/test/Testable.js';
-import type { AtomicTest } from '../models/metamodels/pure/test/Test.js';
-import type { TestAssertion } from '../models/metamodels/pure/test/assertion/TestAssertion.js';
-import type { AssertFail } from '../models/metamodels/pure/test/assertion/status/AssertFail.js';
+import type { RunTestsTestableInput } from '../graph/metamodel/pure/test/result/RunTestsTestableInput.js';
+import type { TestResult } from '../graph/metamodel/pure/test/result/TestResult.js';
+import type { GraphManagerPluginManager } from './GraphManagerPluginManager.js';
+import type { Testable } from '../graph/metamodel/pure/test/Testable.js';
+import type { AtomicTest } from '../graph/metamodel/pure/test/Test.js';
+import type { TestAssertion } from '../graph/metamodel/pure/test/assertion/TestAssertion.js';
+import type { AssertFail } from '../graph/metamodel/pure/test/assertion/status/AssertFail.js';
 import type {
   MappingModelCoverageAnalysisResult,
   RawMappingModelCoverageAnalysisResult,
-} from './action/analytics/MappingAnalytics.js';
+} from './action/analytics/MappingModelCoverageAnalysis.js';
 
 export interface TEMPORARY__EngineSetupConfig {
   env: string;
@@ -110,10 +109,10 @@ export abstract class AbstractPureGraphManagerExtension {
 
 export abstract class AbstractPureGraphManager {
   extensions: AbstractPureGraphManagerExtension[] = [];
-  pluginManager: GraphPluginManager;
+  pluginManager: GraphManagerPluginManager;
   log: Log;
 
-  constructor(pluginManager: GraphPluginManager, log: Log) {
+  constructor(pluginManager: GraphManagerPluginManager, log: Log) {
     this.pluginManager = pluginManager;
     this.log = log;
     this.extensions = pluginManager
@@ -129,6 +128,8 @@ export abstract class AbstractPureGraphManager {
       );
   }
 
+  abstract getSupportedProtocolVersion(): string;
+
   /**
    * TODO: we should not expose a fixed config like this, we probably
    * should not mention anything about engine because it is an internal construct
@@ -146,8 +147,6 @@ export abstract class AbstractPureGraphManager {
     },
   ): Promise<void>;
 
-  abstract getSupportedProtocolVersion(): string;
-
   // --------------------------------------------- Graph Builder ---------------------------------------------
 
   /**
@@ -163,16 +162,6 @@ export abstract class AbstractPureGraphManager {
     options?: GraphBuilderOptions,
   ): Promise<GraphBuilderReport>;
 
-  /**
-   * Process entities and build the main graph.
-   */
-  abstract buildGraph(
-    graph: PureModel,
-    entities: Entity[],
-    buildState: ActionState,
-    options?: GraphBuilderOptions,
-  ): Promise<GraphBuilderReport>;
-
   /**
    * Build immutable models which holds dependencies.
    * Dependency models MUST not depend on the main model.
@@ -185,7 +174,17 @@ export abstract class AbstractPureGraphManager {
     coreModel: CoreModel,
     systemModel: SystemModel,
     dependencyManager: DependencyManager,
-    dependencyEntitiesMap: Map<string, Entity[]>,
+    dependencyEntitiesIndex: Map<string, Entity[]>,
+    buildState: ActionState,
+    options?: GraphBuilderOptions,
+  ): Promise<GraphBuilderReport>;
+
+  /**
+   * Process entities and build the main graph.
+   */
+  abstract buildGraph(
+    graph: PureModel,
+    entities: Entity[],
     buildState: ActionState,
     options?: GraphBuilderOptions,
   ): Promise<GraphBuilderReport>;
@@ -210,6 +209,9 @@ export abstract class AbstractPureGraphManager {
   abstract pureCodeToLambda(
     lambda: string,
     lambdaId?: string,
+    options?: {
+      pruneSourceInformation?: boolean;
+    },
   ): Promise<RawLambda>;
   abstract lambdaToPureCode(
     lambda: RawLambda,
@@ -291,10 +293,6 @@ export abstract class AbstractPureGraphManager {
     generationElement: PackageableElement,
     graph: PureModel,
   ): Promise<Entity[]>;
-  abstract generateModelFromConfiguration(
-    config: ModelGenerationConfiguration,
-    graph: PureModel,
-  ): Promise<Entity[]>;
 
   // ------------------------------------------- External Format ----------------------------------
 
@@ -325,25 +323,25 @@ export abstract class AbstractPureGraphManager {
   // ------------------------------------------- Execute -------------------------------------------
 
   abstract executeMapping(
-    graph: PureModel,
-    mapping: Mapping,
     lambda: RawLambda,
+    mapping: Mapping,
     runtime: Runtime,
+    graph: PureModel,
     options?: ExecutionOptions,
   ): Promise<ExecutionResult>;
 
   abstract generateExecutionPlan(
-    graph: PureModel,
-    mapping: Mapping,
     lambda: RawLambda,
+    mapping: Mapping,
     runtime: Runtime,
+    graph: PureModel,
   ): Promise<RawExecutionPlan>;
 
   abstract debugExecutionPlanGeneration(
-    graph: PureModel,
-    mapping: Mapping,
     lambda: RawLambda,
+    mapping: Mapping,
     runtime: Runtime,
+    graph: PureModel,
   ): Promise<{ plan: RawExecutionPlan; debug: string }>;
 
   abstract buildExecutionPlan(
@@ -358,11 +356,11 @@ export abstract class AbstractPureGraphManager {
   abstract serializeExecutionNode(executionNode: ExecutionNode): object;
 
   abstract generateExecuteTestData(
-    graph: PureModel,
-    mapping: Mapping,
     lambda: RawLambda,
-    runtime: Runtime,
     parameters: (string | number | boolean)[],
+    mapping: Mapping,
+    runtime: Runtime,
+    graph: PureModel,
     options?: {
       // Anonymizes data by hashing any string values in the generated data
       anonymizeGeneratedData?: boolean;
@@ -376,13 +374,13 @@ export abstract class AbstractPureGraphManager {
    */
 
   abstract registerService(
-    graph: PureModel,
     service: Service,
+    graph: PureModel,
     groupId: string,
     artifactId: string,
+    version: string | undefined,
     server: string,
     executionMode: ServiceExecutionMode,
-    version: string | undefined,
   ): Promise<ServiceRegistrationResult>;
   abstract activateService(
     serviceUrl: string,
@@ -414,8 +412,8 @@ export abstract class AbstractPureGraphManager {
   // -------------------------------------- Analysis --------------------------------------
 
   abstract analyzeMappingModelCoverage(
-    graph: PureModel,
     mapping: Mapping,
+    graph: PureModel,
   ): Promise<MappingModelCoverageAnalysisResult>;
 
   abstract buildMappingModelCoverageAnalysisResult(
@@ -431,6 +429,26 @@ export abstract class AbstractPureGraphManager {
     },
   ): Entity;
 
+  async createEmptyGraph(options?: {
+    initializeSystem?: boolean;
+  }): Promise<PureModel> {
+    const extensionElementClasses = this.pluginManager
+      .getPureGraphPlugins()
+      .flatMap((plugin) => plugin.getExtraPureGraphExtensionClasses?.() ?? []);
+    const coreModel = new CoreModel(extensionElementClasses);
+    const systemModel = new SystemModel(extensionElementClasses);
+    if (options?.initializeSystem) {
+      await this.buildSystem(coreModel, systemModel, ActionState.create());
+      systemModel.initializeAutoImports();
+    }
+    const graph = new PureModel(
+      coreModel,
+      systemModel,
+      this.pluginManager.getPureGraphPlugins(),
+    );
+    return graph;
+  }
+
   // ------------------------------------------- Change detection -------------------------------------------
 
   abstract buildHashesIndex(entities: Entity[]): Promise<Map<string, string>>;

package/src/graphManager/CorePureGraphManagerPlugin.ts

@@ -16,7 +16,7 @@
 
 import packageJson from '../../package.json';
 import { PureGraphManagerPlugin } from './PureGraphManagerPlugin.js';
-import { CORE_PURE_PATH } from '../MetaModelConst.js';
+import { CORE_PURE_PATH } from '../graph/MetaModelConst.js';
 
 export class CorePureGraphManagerPlugin extends PureGraphManagerPlugin {
   static NAME = packageJson.extensions.pureGraphManagerPlugin;

package/src/graphManager/DSLExternalFormat_GraphManagerHelper.ts

@@ -17,8 +17,8 @@
 import { guaranteeNonNullable, guaranteeType } from '@finos/legend-shared';
 import type { BasicModel } from '../graph/BasicModel.js';
 import type { PureModel } from '../graph/PureModel.js';
-import { SchemaSet } from '../models/metamodels/pure/packageableElements/externalFormat/schemaSet/DSLExternalFormat_SchemaSet.js';
-import { Binding } from '../models/metamodels/pure/packageableElements/externalFormat/store/DSLExternalFormat_Binding.js';
+import { SchemaSet } from '../graph/metamodel/pure/packageableElements/externalFormat/schemaSet/DSLExternalFormat_SchemaSet.js';
+import { Binding } from '../graph/metamodel/pure/packageableElements/externalFormat/store/DSLExternalFormat_Binding.js';
 
 export const getSchemaSet = (path: string, graph: PureModel): SchemaSet =>
   graph.getExtensionElement(path, SchemaSet, `Can't find schema set '${path}'`);

package/src/graphManager/DSLExternalFormat_PureGraphManagerPlugin.ts

@@ -16,10 +16,10 @@
 
 import packageJson from '../../package.json';
 import type { Connection } from '../DSLMapping_Exports.js';
-import { ExternalFormatConnection } from '../models/metamodels/pure/packageableElements/externalFormat/connection/DSLExternalFormat_ExternalFormatConnection.js';
-import { SchemaSet } from '../models/metamodels/pure/packageableElements/externalFormat/schemaSet/DSLExternalFormat_SchemaSet.js';
-import { Binding } from '../models/metamodels/pure/packageableElements/externalFormat/store/DSLExternalFormat_Binding.js';
-import type { PackageableElement } from '../models/metamodels/pure/packageableElements/PackageableElement.js';
+import { ExternalFormatConnection } from '../graph/metamodel/pure/packageableElements/externalFormat/connection/DSLExternalFormat_ExternalFormatConnection.js';
+import { SchemaSet } from '../graph/metamodel/pure/packageableElements/externalFormat/schemaSet/DSLExternalFormat_SchemaSet.js';
+import { Binding } from '../graph/metamodel/pure/packageableElements/externalFormat/store/DSLExternalFormat_Binding.js';
+import type { PackageableElement } from '../graph/metamodel/pure/packageableElements/PackageableElement.js';
 import type { ObserverContext } from './action/changeDetection/CoreObserverHelper.js';
 import {
   observe_Binding,

package/src/graphManager/DSLGenerationSpecification_PureGraphManagerPlugin_Extension.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import type { ModelGenerationSpecification } from '../models/metamodels/pure/packageableElements/generationSpecification/ModelGenerationSpecification.js';
+import type { ModelGenerationSpecification } from '../graph/metamodel/pure/packageableElements/generationSpecification/ModelGenerationSpecification.js';
 import type { PureGraphManagerPlugin } from './PureGraphManagerPlugin.js';
 import type { PureModel } from '../graph/PureModel.js';
 

package/src/graphManager/DSLMapping_PureGraphManagerPlugin_Extension.ts

@@ -14,10 +14,10 @@
  * limitations under the License.
  */
 
-import type { Connection } from '../models/metamodels/pure/packageableElements/connection/Connection.js';
-import type { InputData } from '../models/metamodels/pure/packageableElements/mapping/InputData.js';
-import type { PropertyMapping } from '../models/metamodels/pure/packageableElements/mapping/PropertyMapping.js';
-import type { SetImplementation } from '../models/metamodels/pure/packageableElements/mapping/SetImplementation.js';
+import type { Connection } from '../graph/metamodel/pure/packageableElements/connection/Connection.js';
+import type { InputData } from '../graph/metamodel/pure/packageableElements/mapping/InputData.js';
+import type { PropertyMapping } from '../graph/metamodel/pure/packageableElements/mapping/PropertyMapping.js';
+import type { SetImplementation } from '../graph/metamodel/pure/packageableElements/mapping/SetImplementation.js';
 import type { ObserverContext } from './action/changeDetection/CoreObserverHelper.js';
 import type { PureGraphManagerPlugin } from './PureGraphManagerPlugin.js';
 

package/src/graphManager/EmbeddedData_PureGraphManagerPlugin_Extension.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import type { EmbeddedData } from '../models/metamodels/pure/data/EmbeddedData.js';
+import type { EmbeddedData } from '../graph/metamodel/pure/data/EmbeddedData.js';
 import type { ObserverContext } from './action/changeDetection/CoreObserverHelper.js';
 import type { PureGraphManagerPlugin } from './PureGraphManagerPlugin.js';
 

package/src/graphManager/GraphManagerEvent.ts

@@ -27,6 +27,7 @@ export enum GRAPH_MANAGER_EVENT {
   GRAPH_BUILDER_OTHER_ELEMENTS_BUILT = 'graph-manager.graph-builder.build-other-elements.success',
   GRAPH_BUILDER_COMPLETED = 'graph-manager.graph-builder.success',
 
+  GRAPH_SYSTEM_INITIALIZED = 'graph-manager.system-initialization.success',
   GRAPH_INITIALIZED = 'graph-manager.graph-initialization.success',
   GRAPH_DEPENDENCIES_FETCHED = 'graph-manager.fetch-dependencies.success',
   GRAPH_ENTITIES_FETCHED = 'graph-manager.entities-dependencies.success',

package/src/graphManager/GraphManagerPluginManager.ts

@@ -0,0 +1,33 @@
+/**
+ * Copyright (c) 2020-present, Goldman Sachs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import type { PureGraphPlugin } from '../graph/PureGraphPlugin.js';
+import type { PureGraphManagerPlugin } from './PureGraphManagerPlugin.js';
+import type { PureProtocolProcessorPlugin } from '../graphManager/protocol/pure/PureProtocolProcessorPlugin.js';
+import type { GraphPluginManager } from '../graph/GraphPluginManager.js';
+
+export interface GraphManagerPluginManager extends GraphPluginManager {
+  getPureGraphPlugins(): PureGraphPlugin[];
+  registerPureGraphPlugin(plugin: PureGraphPlugin): void;
+
+  getPureGraphManagerPlugins(): PureGraphManagerPlugin[];
+  registerPureGraphManagerPlugin(plugin: PureGraphManagerPlugin): void;
+
+  getPureProtocolProcessorPlugins(): PureProtocolProcessorPlugin[];
+  registerPureProtocolProcessorPlugin(
+    plugin: PureProtocolProcessorPlugin,
+  ): void;
+}