@finos/legend-graph 1.3.0 → 2.0.2

package/src/graph/PureModel.ts

@@ -136,6 +136,10 @@ export class SystemModel extends BasicModel {
 
   constructor(extensionElementClasses: Clazz<PackageableElement>[]) {
     super(ROOT_PACKAGE_NAME.SYSTEM, extensionElementClasses);
+
+    this.buildState.setMessageFormatter(
+      (message: string) => `[system] ${message}`,
+    );
   }
 
   /**
@@ -157,6 +161,10 @@ export class SystemModel extends BasicModel {
 export class GenerationModel extends BasicModel {
   constructor(extensionElementClasses: Clazz<PackageableElement>[]) {
     super(ROOT_PACKAGE_NAME.MODEL_GENERATION, extensionElementClasses);
+
+    this.buildState.setMessageFormatter(
+      (message: string) => `[generation] ${message}`,
+    );
   }
 }
 

package/src/graphManager/AbstractPureGraphManager.ts

@@ -61,6 +61,7 @@ import type { GraphPluginManager } from '../GraphPluginManager';
 import type { QuerySearchSpecification } from './action/query/QuerySearchSpecification';
 import type { ExternalFormatDescription } from './action/externalFormat/ExternalFormatDescription';
 import type { ConfigurationProperty } from '../models/metamodels/pure/packageableElements/fileGeneration/ConfigurationProperty';
+import type { GraphBuilderReport } from './GraphBuilderReport';
 
 export interface TEMPORARY__EngineSetupConfig {
   env: string;
@@ -71,7 +72,6 @@ export interface TEMPORARY__EngineSetupConfig {
 }
 
 export interface GraphBuilderOptions {
-  quiet?: boolean;
   // the `keepSectionIndex` flag is kept until we have stable support and enable usage of section index.
   TEMPORARY__keepSectionIndex?: boolean;
   // when we change our handling of section index, we should be able to get rid of this flag.
@@ -125,7 +125,7 @@ export abstract class AbstractPureGraphManager {
     coreModel: CoreModel,
     systemModel: SystemModel,
     options?: GraphBuilderOptions,
-  ): GeneratorFn<void>;
+  ): GeneratorFn<GraphBuilderReport>;
 
   /**
    * Process entities and build the main graph.
@@ -134,7 +134,7 @@ export abstract class AbstractPureGraphManager {
     graph: PureModel,
     entities: Entity[],
     options?: GraphBuilderOptions,
-  ): GeneratorFn<void>;
+  ): GeneratorFn<GraphBuilderReport>;
 
   /**
    * Build immutable models which holds dependencies.
@@ -150,13 +150,13 @@ export abstract class AbstractPureGraphManager {
     dependencyManager: DependencyManager,
     dependencyEntitiesMap: Map<string, Entity[]>,
     options?: GraphBuilderOptions,
-  ): GeneratorFn<void>;
+  ): GeneratorFn<GraphBuilderReport>;
 
   abstract buildGenerations(
     graph: PureModel,
     generationEntities: Map<string, Entity[]>,
     options?: GraphBuilderOptions,
-  ): GeneratorFn<void>;
+  ): GeneratorFn<GraphBuilderReport>;
 
   // ------------------------------------------- Grammar -------------------------------------------
 
@@ -264,7 +264,7 @@ export abstract class AbstractPureGraphManager {
   abstract getExamplePureProtocolText(): string;
   abstract getExampleExternalFormatImportText(): string;
   abstract entitiesToPureProtocolText(entities: Entity[]): Promise<string>;
-  abstract pureProtocolToEntities(protocol: string): Entity[];
+  abstract pureProtocolTextToEntities(protocol: string): Entity[];
 
   // ------------------------------------------- Execute -------------------------------------------
 
@@ -336,6 +336,19 @@ export abstract class AbstractPureGraphManager {
   abstract updateQuery(query: Query, graph: PureModel): Promise<Query>;
   abstract deleteQuery(queryId: string): Promise<void>;
 
+  // ------------------------------------------- Legend Query -------------------------------------
+  abstract buildGraphForCreateQuerySetup(
+    graph: PureModel,
+    entities: Entity[],
+    dependencyEntitiesMap: Map<string, Entity[]>,
+  ): Promise<void>;
+
+  abstract buildGraphForServiceQuerySetup(
+    graph: PureModel,
+    entities: Entity[],
+    dependencyEntitiesMap: Map<string, Entity[]>,
+  ): Promise<void>;
+
   // ------------------------------------------- Utilities -------------------------------------------
 
   abstract buildDatabase(

package/src/graphManager/GraphBuilderReport.ts

@@ -14,4 +14,18 @@
  * limitations under the License.
  */
 
-export class GraphBuilderReport {}
+import { GRAPH_MANAGER_EVENT } from './GraphManagerEvent';
+
+export class GraphBuilderReport {
+  timings: {
+    [GRAPH_MANAGER_EVENT.GRAPH_BUILDER_COMPLETED]: number;
+    [key: string]: number;
+  } = { [GRAPH_MANAGER_EVENT.GRAPH_BUILDER_COMPLETED]: 0 };
+  elementCount: {
+    total: number;
+    [key: string]: number;
+  } = {
+    total: 0,
+  };
+  otherStats: Record<PropertyKey, unknown> = {};
+}

package/src/graphManager/{GraphManagerLogEvent.ts → GraphManagerEvent.ts}

@@ -14,31 +14,21 @@
  * limitations under the License.
  */
 
-export enum GRAPH_MANAGER_LOG_EVENT {
-  GRAPH_BUILDER_FAILURE = 'GRAPH_BUILD_FAILURE',
-
-  GRAPH_BUILDER_SYSTEM_BUILT = 'GRAPH_BUILDER_SYSTEM_BUILT',
-  GRAPH_BUILDER_DEPENDENCIES_PREPROCESSED = 'GRAPH_BUILDER_DEPENDENCIES_PREPROCESSED',
-  GRAPH_BUILDER_DEPENDENCIES_ENTITIES_FETCHED = 'GRAPH_BUILDER_DEPENDENCIES_ENTITIES_FETCHED',
-  GRAPH_BUILDER_DEPENDENCIES_PROCESSED = 'GRAPH_BUILDER_DEPENDENCIES_PROCESSED',
-  GRAPH_BUILDER_DEPENDENCIES_BUILT = 'GRAPH_BUILDER_DEPENDENCIES_BUILT',
-  GRAPH_BUILDER_GENERATIONS_BUILT = 'GRAPH_BUILDER_GENERATIONS_BUILT',
-  GRAPH_BUILDER_DATA_MODEL_PARSED = 'GRAPH_BUILDER_DATA_MODEL_PARSED',
-  GRAPH_BUILDER_COMPLETED = 'GRAPH_BUILDER_COMPLETED',
-  GRAPH_BUILDER_ELEMENTS_INITIALIZED_AND_INDEXED = 'GRAPH_BUILDER_ELEMENTS_INITIALIZED_AND_INDEXED',
+export enum GRAPH_MANAGER_EVENT {
+  GRAPH_BUILDER_ELEMENTS_DESERIALIZED = 'GRAPH_BUILDER_ELEMENTS_DESERIALIZED',
+  GRAPH_BUILDER_ELEMENTS_INDEXED = 'GRAPH_BUILDER_ELEMENTS_INDEXED',
   GRAPH_BUILDER_SECTION_INDICES_BUILT = 'GRAPH_BUILDER_SECTION_INDICES_BUILT',
   GRAPH_BUILDER_DOMAIN_MODELS_BUILT = 'GRAPH_BUILDER_DOMAIN_MODELS_BUILT',
   GRAPH_BUILDER_STORES_BUILT = 'GRAPH_BUILDER_STORES_BUILT',
   GRAPH_BUILDER_MAPPINGS_BUILT = 'GRAPH_BUILDER_MAPPINGS_BUILT',
-  GRAPH_BUILDER_CONNECTIONS_BUILT = 'GRAPH_BUILDER_CONNECTIONS_BUILT',
-  GRAPH_BUILDER_RUNTIMES_BUILT = 'GRAPH_BUILDER_RUNTIMES_BUILT',
-  GRAPH_BUILDER_OTHER_ELEMENTS_BUILT = 'GRAPH_BUILDER_OTHER_ELEMENTS_BUILT',
-  // TODO: we should be able to move these out with modularization
-  GRAPH_BUILDER_FILE_GENERATIONS_BUILT = 'GRAPH_BUILDER_FILE_GENERATIONS_BUILT',
-  GRAPH_BUILDER_GENERATION_TREE_BUILT = 'GRAPH_BUILDER_GENERATION_TREE_BUILT',
+  GRAPH_BUILDER_CONNECTIONS_AND_RUNTIMES_BUILT = 'GRAPH_BUILDER_CONNECTIONS_AND_RUNTIMES_BUILT',
   GRAPH_BUILDER_SERVICES_BUILT = 'GRAPH_BUILDER_SERVICES_BUILT',
+  GRAPH_BUILDER_OTHER_ELEMENTS_BUILT = 'GRAPH_BUILDER_OTHER_ELEMENTS_BUILT',
+  GRAPH_BUILDER_POST_PROCESSED = 'GRAPH_BUILDER_POST_PROCESSED',
+  GRAPH_BUILDER_COMPLETED = 'GRAPH_BUILDER_COMPLETED',
 
   GRAPH_INITIALIZED = 'GRAPH_INITIALIZED',
+  GRAPH_DEPENDENCIES_FETCHED = 'GRAPH_DEPENDENCIES_FETCHED',
   GRAPH_ENTITIES_FETCHED = 'GRAPH_ENTITIES_FETCHED',
   GRAPH_UPDATED_AND_REBUILT = 'GRAPH_REBUILT',
   GRAPH_MODEL_TO_GRAMMAR_TRANSFORMED = 'GRAPH_MODEL_TO_GRAMMAR_TRANSFORMED',
@@ -48,9 +38,9 @@ export enum GRAPH_MANAGER_LOG_EVENT {
   GRAPH_PROTOCOL_SERIALIZED = 'GRAPH_PROTOCOL_SERIALIZED',
   GRAPH_HASHES_PRECOMPUTED = 'GRAPH_HASHES_PRECOMPUTED',
 
-  GRAPH_MANAGER_FAILURE = 'GRAPH_MANAGER_FAILURE',
-
+  GRAPH_BUILDER_FAILURE = 'GRAPH_BUILD_FAILURE',
   EXECUTION_FAILURE = 'EXECUTION_FAILURE',
   COMPILATION_FAILURE = 'COMPILATION_FAILURE',
   PARSING_FAILURE = 'PARSING_FAILURE',
+  GRAPH_MANAGER_FAILURE = 'GRAPH_MANAGER_FAILURE',
 }

package/src/graphManager/GraphManagerTelemetry.ts

@@ -0,0 +1,35 @@
+/**
+ * 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 { TelemetryService } from '@finos/legend-shared';
+import type { GraphBuilderReport } from './GraphBuilderReport';
+import { GRAPH_MANAGER_EVENT } from './GraphManagerEvent';
+
+type GraphBuilt_TelemetryData = {
+  timings: Record<string, number>;
+  dependencies: GraphBuilderReport;
+  graph: GraphBuilderReport;
+  generations?: GraphBuilderReport;
+};
+
+export class GraphManagerTelemetry {
+  static logEvent_GraphInitialized(
+    telemetryService: TelemetryService,
+    data: GraphBuilt_TelemetryData,
+  ): void {
+    telemetryService.logEvent(GRAPH_MANAGER_EVENT.GRAPH_INITIALIZED, data);
+  }
+}

package/src/index.ts

@@ -184,8 +184,10 @@ export {
   AbstractPureGraphManager,
   type GraphBuilderOptions,
 } from './graphManager/AbstractPureGraphManager';
+export { GraphBuilderReport } from './graphManager/GraphBuilderReport';
+export { GraphManagerTelemetry } from './graphManager/GraphManagerTelemetry';
 export * from './graphManager/GraphManagerUtils';
-export { GRAPH_MANAGER_LOG_EVENT } from './graphManager/GraphManagerLogEvent';
+export * from './graphManager/GraphManagerEvent';
 export * from './graphManager/DSLMapping_PureGraphManagerPlugin_Extension';
 export * from './graphManager/DSLGenerationSpecification_PureGraphManagerPlugin_Extension';
 export {
@@ -239,11 +241,9 @@ export {
   V1_serializeRawValueSpecification,
 } from './models/protocols/pure/v1/transformation/pureProtocol/serializationHelpers/V1_RawValueSpecificationSerializationHelper';
 export { V1_transformPropertyReference } from './models/protocols/pure/v1/transformation/pureGraph/from/V1_MappingTransformer';
-export {
-  V1_EngineServerClient,
-  V1_ENGINE_LOG_EVENT,
-} from './models/protocols/pure/v1/engine/V1_EngineServerClient';
+export { V1_EngineServerClient } from './models/protocols/pure/v1/engine/V1_EngineServerClient';
 export { V1_Engine } from './models/protocols/pure/v1/engine/V1_Engine';
+export * from './models/protocols/pure/v1/engine/V1_EngineEvent';
 export { V1_deserializePureModelContextData as V1_jsonToPureModelContextData } from './models/protocols/pure/v1/transformation/pureProtocol/V1_PureProtocolSerialization';
 export {
   V1_propertyPointerModelSchema,