@finos/legend-graph 24.1.0 → 25.0.1

package/src/graphManager/protocol/pure/v1/engine/execution/V1_ExecutionResult.ts

@@ -48,14 +48,20 @@ export class V1_JsonExecutionResult extends V1_ExecutionResult {
   );
 }
 
-export class V1_TDSColumn {
+/**
+ * TODO?: maybe we converge to use V1_TDSColumn
+ *
+ * Since here, we're building out the result builder config, we don't need
+ * to fully resolve all the references, hence we have this simplified version of V1_TDSColumn
+ */
+export class V1_INTERNAL__TDSColumn {
   name!: string;
   doc?: string | undefined;
   type?: string | undefined;
   relationalType?: string | undefined;
 
   static readonly serialization = new SerializationFactory(
-    createModelSchema(V1_TDSColumn, {
+    createModelSchema(V1_INTERNAL__TDSColumn, {
       name: primitive(),
       doc: optional(primitive()),
       type: optional(primitive()),
@@ -65,12 +71,14 @@ export class V1_TDSColumn {
 }
 
 export class V1_TDSBuilder extends V1_ResultBuilder {
-  columns: V1_TDSColumn[] = [];
+  columns: V1_INTERNAL__TDSColumn[] = [];
 
   static readonly serialization = new SerializationFactory(
     createModelSchema(V1_TDSBuilder, {
       _type: primitive(),
-      columns: list(usingModelSchema(V1_TDSColumn.serialization.schema)),
+      columns: list(
+        usingModelSchema(V1_INTERNAL__TDSColumn.serialization.schema),
+      ),
     }),
   );
 }

package/src/graphManager/protocol/pure/v1/model/packageableElements/V1_PackageableElement.ts

@@ -84,10 +84,10 @@ export abstract class V1_PackageableElement implements Hashable {
 }
 
 export class V1_PackageableElementPointer implements Hashable {
-  type!: string;
+  type?: string | undefined;
   path!: string;
 
-  constructor(type: string, path: string) {
+  constructor(type: string | undefined, path: string) {
     this.type = type;
     this.path = path;
   }
@@ -95,7 +95,7 @@ export class V1_PackageableElementPointer implements Hashable {
   get hashCode(): string {
     return hashArray([
       CORE_HASH_STRUCTURE.PACKAGEABLE_ELEMENT_POINTER,
-      this.type,
+      this.type ?? '',
       this.path,
     ]);
   }

package/src/graphManager/protocol/pure/v1/transformation/pureGraph/to/helpers/V1_ValueSpecificationBuilderHelper.ts

@@ -215,7 +215,8 @@ export class V1_ValueSpecificationBuilder
       this.processingContext,
     );
     this.processingContext.pop();
-    return func[0];
+
+    return func;
   }
 
   visit_AppliedProperty(
@@ -553,25 +554,20 @@ export const V1_buildGenericFunctionExpression = (
   openVariables: string[],
   compileContext: V1_GraphBuilderContext,
   processingContext: V1_ProcessingContext,
-): [SimpleFunctionExpression, ValueSpecification[]] => {
-  const processedParams = parameters.map((parameter) =>
-    parameter.accept_ValueSpecificationVisitor(
-      new V1_ValueSpecificationBuilder(
-        compileContext,
-        processingContext,
-        openVariables,
+): SimpleFunctionExpression =>
+  V1_buildBaseSimpleFunctionExpression(
+    parameters.map((parameter) =>
+      parameter.accept_ValueSpecificationVisitor(
+        new V1_ValueSpecificationBuilder(
+          compileContext,
+          processingContext,
+          openVariables,
+        ),
       ),
     ),
+    functionName,
+    compileContext,
   );
-  return [
-    V1_buildBaseSimpleFunctionExpression(
-      processedParams,
-      functionName,
-      compileContext,
-    ),
-    processedParams,
-  ];
-};
 /**
  * This is fairly similar to how engine does function matching in a way.
  * Notice that Studio core should not attempt to do any function inferencing/matching
@@ -586,7 +582,7 @@ export function V1_buildFunctionExpression(
   openVariables: string[],
   compileContext: V1_GraphBuilderContext,
   processingContext: V1_ProcessingContext,
-): [SimpleFunctionExpression, ValueSpecification[]] {
+): SimpleFunctionExpression {
   if (
     matchFunctionName(functionName, [
       SUPPORTED_FUNCTIONS.TODAY,
@@ -600,7 +596,7 @@ export function V1_buildFunctionExpression(
       compileContext,
       processingContext,
     );
-    expression[0].genericType = GenericTypeExplicitReference.create(
+    expression.genericType = GenericTypeExplicitReference.create(
       new GenericType(PrimitiveType.STRICTDATE),
     );
     return expression;
@@ -612,7 +608,7 @@ export function V1_buildFunctionExpression(
       compileContext,
       processingContext,
     );
-    expression[0].genericType = GenericTypeExplicitReference.create(
+    expression.genericType = GenericTypeExplicitReference.create(
       new GenericType(PrimitiveType.DATETIME),
     );
     return expression;
@@ -632,7 +628,7 @@ export function V1_buildFunctionExpression(
       compileContext,
       processingContext,
     );
-    expression[0].genericType = GenericTypeExplicitReference.create(
+    expression.genericType = GenericTypeExplicitReference.create(
       new GenericType(PrimitiveType.DATE),
     );
     return expression;

package/src/graphManager/protocol/pure/v1/transformation/pureProtocol/serializationHelpers/V1_CoreSerializationHelper.ts

@@ -34,7 +34,7 @@ export const V1_packageableElementPointerDeserializerSchema = createModelSchema(
   V1_PackageableElementPointer,
   {
     path: primitive(),
-    type: primitive(),
+    type: optional(primitive()),
   },
 );
 

package/src/graphManager/protocol/pure/v1/transformation/pureProtocol/serializationHelpers/V1_ExecutionEnvironmentSerializationHelper.ts

@@ -34,8 +34,10 @@ import {
   V1_SingleExecutionParameters,
   type V1_ExecutionParameters,
 } from '../../../model/packageableElements/service/V1_ExecutionEnvironmentInstance.js';
-import { V1_serializeRuntime } from './V1_RuntimeSerializationHelper.js';
-import { V1_deserializeRuntime } from './V1_ServiceSerializationHelper.js';
+import {
+  V1_deserializeRuntime,
+  V1_serializeRuntime,
+} from './V1_RuntimeSerializationHelper.js';
 
 export const V1_EXECUTION_ENVIRONMENT_ELEMENT_PROTOCOL_TYPE =
   'executionEnvironmentInstance';

package/src/graphManager/protocol/pure/v1/transformation/pureProtocol/serializationHelpers/V1_RuntimeSerializationHelper.ts

@@ -109,9 +109,28 @@ export const V1_serializeRuntime = (
   } else if (protocol instanceof V1_RuntimePointer) {
     return serialize(V1_runtimePointerModelSchema, protocol);
   }
+  // NOTE: we don't want to serialize legacy runtime as we no longer want to circulate it any further
   throw new UnsupportedOperationError(`Can't serialize runtime`, protocol);
 };
 
+export const V1_deserializeRuntime = (
+  json: PlainObject<V1_Runtime>,
+): V1_Runtime => {
+  switch (json._type) {
+    case V1_RuntimeType.RUNTIME_POINTER:
+      return deserialize(V1_runtimePointerModelSchema, json);
+    case V1_RuntimeType.ENGINE_RUNTIME:
+      return deserialize(V1_EngineRuntime, json);
+    case V1_RuntimeType.LEGACY_RUNTIME:
+    case undefined:
+      return deserialize(V1_LegacyRuntime, json);
+    default:
+      throw new UnsupportedOperationError(
+        `Can't deeserialize runtime of type '${json._type}'`,
+      );
+  }
+};
+
 export const V1_packageableRuntimeModelSchema = createModelSchema(
   V1_PackageableRuntime,
   {

package/src/graphManager/protocol/pure/v1/transformation/pureProtocol/serializationHelpers/V1_ServiceSerializationHelper.ts

@@ -44,13 +44,7 @@ import {
 import { V1_Service } from '../../../model/packageableElements/service/V1_Service.js';
 import { V1_rawLambdaModelSchema } from './V1_RawValueSpecificationSerializationHelper.js';
 import {
-  type V1_Runtime,
-  V1_EngineRuntime,
-  V1_LegacyRuntime,
-} from '../../../model/packageableElements/runtime/V1_Runtime.js';
-import {
-  V1_runtimePointerModelSchema,
-  V1_RuntimeType,
+  V1_deserializeRuntime,
   V1_serializeRuntime,
 } from './V1_RuntimeSerializationHelper.js';
 import { V1_ServiceTest } from '../../../model/packageableElements/service/V1_ServiceTest.js';
@@ -179,24 +173,6 @@ export const V1_serviceTestSuiteModelSchema = (
     ),
   });
 
-export const V1_deserializeRuntime = (
-  json: PlainObject<V1_Runtime>,
-): V1_Runtime => {
-  switch (json._type) {
-    case V1_RuntimeType.RUNTIME_POINTER:
-      return deserialize(V1_runtimePointerModelSchema, json);
-    case V1_RuntimeType.ENGINE_RUNTIME:
-      return deserialize(V1_EngineRuntime, json);
-    case V1_RuntimeType.LEGACY_RUNTIME:
-    case undefined:
-      return deserialize(V1_LegacyRuntime, json);
-    default:
-      throw new UnsupportedOperationError(
-        `Can't deeserialize runtime value of type '${json._type}'`,
-      );
-  }
-};
-
 const pureSingleExecutionModelSchema = createModelSchema(
   V1_PureSingleExecution,
   {
@@ -205,10 +181,7 @@ const pureSingleExecutionModelSchema = createModelSchema(
     ),
     func: usingModelSchema(V1_rawLambdaModelSchema),
     mapping: optional(primitive()),
-    runtime: optionalCustom(
-      (val) => V1_serializeRuntime(val),
-      (val) => V1_deserializeRuntime(val),
-    ),
+    runtime: optionalCustom(V1_serializeRuntime, V1_deserializeRuntime),
   },
 );
 
@@ -217,10 +190,7 @@ const keyedExecutionParamaterModelSchema = createModelSchema(
   {
     key: primitive(),
     mapping: primitive(),
-    runtime: custom(
-      (val) => V1_serializeRuntime(val),
-      (val) => V1_deserializeRuntime(val),
-    ),
+    runtime: optionalCustom(V1_serializeRuntime, V1_deserializeRuntime),
   },
 );
 

package/src/graphManager/protocol/pure/v1/transformation/pureProtocol/serializationHelpers/executionPlan/V1_ExecutionPlanSerializationHelper.ts

@@ -77,7 +77,7 @@ const TDSResultTypeModelSchema = createModelSchema(V1_TDSResultType, {
   tdsColumns: list(usingModelSchema(TDSColumnModelSchema)),
 });
 
-const V1_serializeExecutionResultType = (
+const V1_serializeResultType = (
   protocol: V1_ResultType,
 ): PlainObject<V1_ResultType> => {
   if (protocol instanceof V1_DataTypeResultType) {
@@ -91,7 +91,7 @@ const V1_serializeExecutionResultType = (
   );
 };
 
-const V1_deserializeExecutionResultType = (
+const V1_deserializeResultType = (
   json: PlainObject<V1_ResultType>,
 ): V1_ResultType => {
   switch (json._type) {
@@ -120,16 +120,10 @@ const relationalTDSInstantationExecutionNodeModelSchema = createModelSchema(
       V1_ExecutionNodeType.RELATIONAL_TDS_INSTANTIATION,
     ),
     executionNodes: list(
-      custom(
-        (val) => V1_serializeExecutionNode(val),
-        (val) => V1_deserializeExecutionNode(val),
-      ),
+      custom(V1_serializeExecutionNode, V1_deserializeExecutionNode),
     ),
     resultSizeRange: usingModelSchema(V1_multiplicitySchema),
-    resultType: custom(
-      (val) => V1_serializeExecutionResultType(val),
-      (val) => V1_deserializeExecutionResultType(val),
-    ),
+    resultType: custom(V1_serializeResultType, V1_deserializeResultType),
   },
 );
 
@@ -141,8 +135,8 @@ const SQLResultColumnModelSchema = createModelSchema(V1_SQLResultColumn, {
 const SQLExecutionNodeModelSchema = createModelSchema(V1_SQLExecutionNode, {
   _type: usingConstantValueSchema(V1_ExecutionNodeType.SQL),
   connection: custom(
-    (val) => V1_serializeDatabaseConnectionValue(val),
-    (val) => V1_deserializeDatabaseConnectionValue(val),
+    V1_serializeDatabaseConnectionValue,
+    V1_deserializeDatabaseConnectionValue,
   ),
   executionNodes: customList(
     V1_serializeExecutionNode,
@@ -152,10 +146,7 @@ const SQLExecutionNodeModelSchema = createModelSchema(V1_SQLExecutionNode, {
   onConnectionCloseRollbackQuery: optional(primitive()),
   resultColumns: list(usingModelSchema(SQLResultColumnModelSchema)),
   resultSizeRange: usingModelSchema(V1_multiplicitySchema),
-  resultType: custom(
-    (val) => V1_serializeExecutionResultType(val),
-    (val) => V1_deserializeExecutionResultType(val),
-  ),
+  resultType: custom(V1_serializeResultType, V1_deserializeResultType),
   sqlQuery: primitive(),
 });
 
@@ -209,8 +200,8 @@ const SimpleExecutionPlanModelSchema = createModelSchema(
     authDependent: primitive(),
     kerberos: optional(primitive()),
     rootExecutionNode: custom(
-      (val) => V1_serializeExecutionNode(val),
-      (val) => V1_deserializeExecutionNode(val),
+      V1_serializeExecutionNode,
+      V1_deserializeExecutionNode,
     ),
     serializer: usingModelSchema(V1_Protocol.serialization.schema),
     templateFunctions: list(primitive()),

package/src/index.ts

@@ -203,12 +203,11 @@ export * from './graphManager/action/generation/DatabaseBuilderInput.js';
 export * from './graphManager/action/generation/GenerationConfigurationDescription.js';
 export { GenerationOutput } from './graphManager/action/generation/GenerationOutput.js';
 export { ServiceExecutionMode } from './graphManager/action/service/ServiceExecutionMode.js';
-export { ServiceRegistrationResult } from './graphManager/action/service/ServiceRegistrationResult.js';
 export {
-  BulkServiceRegistrationResult,
-  BulkRegistrationResultFail,
-  BulkRegistrationResultSuccess,
-} from './graphManager/action/service/BulkServiceRegistrationResult.js';
+  ServiceRegistrationResult,
+  ServiceRegistrationFail,
+  ServiceRegistrationSuccess,
+} from './graphManager/action/service/ServiceRegistrationResult.js';
 export { DEPRECATED__ServiceTestResult } from './graphManager/action/service/DEPRECATED__ServiceTestResult.js';
 export { SourceInformation } from './graphManager/action/SourceInformation.js';
 export * from './graphManager/protocol/pure/PureProtocolProcessorPlugin.js';

package/tsconfig.json

@@ -295,7 +295,6 @@
     "./src/graphManager/action/generation/GenerationOutput.ts",
     "./src/graphManager/action/query/Query.ts",
     "./src/graphManager/action/query/QuerySearchSpecification.ts",
-    "./src/graphManager/action/service/BulkServiceRegistrationResult.ts",
     "./src/graphManager/action/service/DEPRECATED__ServiceTestResult.ts",
     "./src/graphManager/action/service/ServiceExecutionMode.ts",
     "./src/graphManager/action/service/ServiceRegistrationResult.ts",

package/lib/graphManager/action/service/BulkServiceRegistrationResult.d.ts

@@ -1,29 +0,0 @@
-/**
- * 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.
- */
-export declare class BulkServiceRegistrationResult {
-    servicePath: string | undefined;
-}
-export declare class BulkRegistrationResultSuccess extends BulkServiceRegistrationResult {
-    serverURL: string;
-    pattern: string;
-    serviceInstanceId: string;
-    constructor(serverURL: string, pattern: string, serviceInstanceId: string);
-}
-export declare class BulkRegistrationResultFail extends BulkServiceRegistrationResult {
-    errorMessage: string;
-    constructor(errorMessage: string);
-}
-//# sourceMappingURL=BulkServiceRegistrationResult.d.ts.map

package/lib/graphManager/action/service/BulkServiceRegistrationResult.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"BulkServiceRegistrationResult.d.ts","sourceRoot":"","sources":["../../../../src/graphManager/action/service/BulkServiceRegistrationResult.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,qBAAa,6BAA6B;IACxC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;CACjC;AAED,qBAAa,6BAA8B,SAAQ,6BAA6B;IAC9E,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,iBAAiB,EAAE,MAAM,CAAC;gBAEd,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM;CAM1E;AAED,qBAAa,0BAA2B,SAAQ,6BAA6B;IAC3E,YAAY,EAAE,MAAM,CAAC;gBAET,YAAY,EAAE,MAAM;CAIjC"}

package/lib/graphManager/action/service/BulkServiceRegistrationResult.js

@@ -1,37 +0,0 @@
-/**
- * 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.
- */
-export class BulkServiceRegistrationResult {
-    servicePath;
-}
-export class BulkRegistrationResultSuccess extends BulkServiceRegistrationResult {
-    serverURL;
-    pattern;
-    serviceInstanceId;
-    constructor(serverURL, pattern, serviceInstanceId) {
-        super();
-        this.serverURL = serverURL;
-        this.pattern = pattern;
-        this.serviceInstanceId = serviceInstanceId;
-    }
-}
-export class BulkRegistrationResultFail extends BulkServiceRegistrationResult {
-    errorMessage;
-    constructor(errorMessage) {
-        super();
-        this.errorMessage = errorMessage;
-    }
-}
-//# sourceMappingURL=BulkServiceRegistrationResult.js.map

package/lib/graphManager/action/service/BulkServiceRegistrationResult.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"BulkServiceRegistrationResult.js","sourceRoot":"","sources":["../../../../src/graphManager/action/service/BulkServiceRegistrationResult.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,MAAM,OAAO,6BAA6B;IACxC,WAAW,CAAqB;CACjC;AAED,MAAM,OAAO,6BAA8B,SAAQ,6BAA6B;IAC9E,SAAS,CAAS;IAClB,OAAO,CAAS;IAChB,iBAAiB,CAAS;IAE1B,YAAY,SAAiB,EAAE,OAAe,EAAE,iBAAyB;QACvE,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;IAC7C,CAAC;CACF;AAED,MAAM,OAAO,0BAA2B,SAAQ,6BAA6B;IAC3E,YAAY,CAAS;IAErB,YAAY,YAAoB;QAC9B,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;IACnC,CAAC;CACF"}

package/src/graphManager/action/service/BulkServiceRegistrationResult.ts

@@ -1,41 +0,0 @@
-/**
- * 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.
- */
-
-export class BulkServiceRegistrationResult {
-  servicePath: string | undefined;
-}
-
-export class BulkRegistrationResultSuccess extends BulkServiceRegistrationResult {
-  serverURL: string;
-  pattern: string;
-  serviceInstanceId: string;
-
-  constructor(serverURL: string, pattern: string, serviceInstanceId: string) {
-    super();
-    this.serverURL = serverURL;
-    this.pattern = pattern;
-    this.serviceInstanceId = serviceInstanceId;
-  }
-}
-
-export class BulkRegistrationResultFail extends BulkServiceRegistrationResult {
-  errorMessage: string;
-
-  constructor(errorMessage: string) {
-    super();
-    this.errorMessage = errorMessage;
-  }
-}