@finos/legend-application-query 5.0.0

package/src/components/QuerySetupStoreProvider.tsx

@@ -0,0 +1,65 @@
+/**
+ * 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 { createContext, useContext } from 'react';
+import { useLocalObservable } from 'mobx-react-lite';
+import { QuerySetupStore } from '../stores/QuerySetupStore.js';
+import { guaranteeNonNullable } from '@finos/legend-shared';
+import { useDepotServerClient } from '@finos/legend-server-depot';
+import {
+  useLegendQueryApplicationStore,
+  useLegendQueryBaseStore,
+} from './LegendQueryBaseStoreProvider.js';
+
+const QuerySetupStoreContext = createContext<QuerySetupStore | undefined>(
+  undefined,
+);
+
+export const QuerySetupStoreProvider: React.FC<{
+  children: React.ReactNode;
+}> = ({ children }) => {
+  const applicationStore = useLegendQueryApplicationStore();
+  const depotServerClient = useDepotServerClient();
+  const baseStore = useLegendQueryBaseStore();
+  const store = useLocalObservable(
+    () =>
+      new QuerySetupStore(
+        applicationStore,
+        depotServerClient,
+        baseStore.pluginManager,
+      ),
+  );
+  return (
+    <QuerySetupStoreContext.Provider value={store}>
+      {children}
+    </QuerySetupStoreContext.Provider>
+  );
+};
+
+export const useQuerySetupStore = (): QuerySetupStore =>
+  guaranteeNonNullable(
+    useContext(QuerySetupStoreContext),
+    `Can't find query setup store in context`,
+  );
+
+export const withQuerySetupStore = (WrappedComponent: React.FC): React.FC =>
+  function WithQuerySetupStore() {
+    return (
+      <QuerySetupStoreProvider>
+        <WrappedComponent />
+      </QuerySetupStoreProvider>
+    );
+  };

package/src/components/shared/ElementIconUtils.tsx

@@ -0,0 +1,47 @@
+/**
+ * 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 Type,
+  Class,
+  Enumeration,
+  Measure,
+  Unit,
+  PrimitiveType,
+} from '@finos/legend-graph';
+import {
+  PURE_ClassIcon,
+  PURE_PrimitiveTypeIcon,
+  PURE_EnumerationIcon,
+  PURE_MeasureIcon,
+  PURE_UnknownElementTypeIcon,
+  PURE_UnitIcon,
+} from '@finos/legend-art';
+
+export const getClassPropertyIcon = (type: Type): React.ReactNode => {
+  if (type instanceof PrimitiveType) {
+    return <PURE_PrimitiveTypeIcon />;
+  } else if (type instanceof Class) {
+    return <PURE_ClassIcon />;
+  } else if (type instanceof Enumeration) {
+    return <PURE_EnumerationIcon />;
+  } else if (type instanceof Measure) {
+    return <PURE_MeasureIcon />;
+  } else if (type instanceof Unit) {
+    return <PURE_UnitIcon />;
+  }
+  return <PURE_UnknownElementTypeIcon />;
+};

package/src/graphManager/QueryBuilder_GraphManagerPlugin.ts

@@ -0,0 +1,32 @@
+/**
+ * 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 packageJson from '../../package.json';
+import {
+  PureGraphManagerPlugin,
+  type PureGraphManagerExtensionBuilder,
+} from '@finos/legend-graph';
+import { QueryBuilder_buildGraphManagerExtension } from './protocol/pure/QueryBuilder_PureGraphManagerExtensionBuilder.js';
+
+export class QueryBuilder_PureGraphManagerPlugin extends PureGraphManagerPlugin {
+  constructor() {
+    super(packageJson.extensions.pureGraphManagerPlugin, packageJson.version);
+  }
+
+  override getExtraPureGraphManagerExtensionBuilders(): PureGraphManagerExtensionBuilder[] {
+    return [QueryBuilder_buildGraphManagerExtension];
+  }
+}

package/src/graphManager/QueryBuilder_GraphManagerPreset.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 packageJson from '../../package.json';
+import { AbstractPreset } from '@finos/legend-shared';
+import { QueryBuilder_PureProtocolProcessorPlugin } from './protocol/pure/QueryBuilder_PureProtocolProcessorPlugin.js';
+import { QueryBuilder_PureGraphManagerPlugin } from './QueryBuilder_GraphManagerPlugin.js';
+
+/**
+ * This is the core graph manager preset and should not be exported
+ * and consumed outside of this package
+ */
+export class QueryBuilder_GraphManagerPreset extends AbstractPreset {
+  constructor() {
+    super(packageJson.extensions.graphManagerPreset, packageJson.version, [
+      new QueryBuilder_PureGraphManagerPlugin(),
+      new QueryBuilder_PureProtocolProcessorPlugin(),
+    ]);
+  }
+}

package/src/graphManager/action/analytics/MappingRuntimeCompatibilityAnalysis.ts

@@ -0,0 +1,22 @@
+/**
+ * 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 { Mapping, PackageableRuntime } from '@finos/legend-graph';
+
+export class MappingRuntimeCompatibilityAnalysisResult {
+  mapping!: Mapping;
+  runtimes: PackageableRuntime[] = [];
+}

package/src/graphManager/action/analytics/ServiceExecutionAnalysis.ts

@@ -0,0 +1,22 @@
+/**
+ * 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 { Service } from '@finos/legend-graph';
+
+export class ServiceExecutionAnalysisResult {
+  service!: Service;
+  executionKeys?: string[] | undefined;
+}

package/src/graphManager/protocol/pure/QueryBuilder_PureGraphManagerExtension.ts

@@ -0,0 +1,47 @@
+/**
+ * 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 { Entity } from '@finos/legend-storage';
+import {
+  type AbstractPureGraphManager,
+  AbstractPureGraphManagerExtension,
+} from '@finos/legend-graph';
+import { guaranteeNonNullable } from '@finos/legend-shared';
+import type { MappingRuntimeCompatibilityAnalysisResult } from '../../action/analytics/MappingRuntimeCompatibilityAnalysis.js';
+import type { ServiceExecutionAnalysisResult } from '../../action/analytics/ServiceExecutionAnalysis.js';
+
+export abstract class QueryBuilder_PureGraphManagerExtension extends AbstractPureGraphManagerExtension {
+  abstract surveyMappingRuntimeCompatibility(
+    entities: Entity[],
+    dependencyEntitiesIndex: Map<string, Entity[]>,
+  ): Promise<MappingRuntimeCompatibilityAnalysisResult[]>;
+
+  abstract surveyServiceExecution(
+    entities: Entity[],
+    dependencyEntitiesIndex: Map<string, Entity[]>,
+  ): Promise<ServiceExecutionAnalysisResult[]>;
+}
+
+export const getQueryBuilderGraphManagerExtension = (
+  graphManager: AbstractPureGraphManager,
+): QueryBuilder_PureGraphManagerExtension =>
+  guaranteeNonNullable(
+    graphManager.extensions.find(
+      (extension) =>
+        extension instanceof QueryBuilder_PureGraphManagerExtension,
+    ),
+    `Can't find query builder Pure graph manager extension`,
+  ) as QueryBuilder_PureGraphManagerExtension;

package/src/graphManager/protocol/pure/QueryBuilder_PureGraphManagerExtensionBuilder.ts

@@ -0,0 +1,27 @@
+/**
+ * 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 {
+  AbstractPureGraphManager,
+  AbstractPureGraphManagerExtension,
+} from '@finos/legend-graph';
+import { V1_QueryBuilder_PureGraphManagerExtension } from './v1/V1_QueryBuilder_PureGraphManagerExtension.js';
+
+export const QueryBuilder_buildGraphManagerExtension = (
+  graphManager: AbstractPureGraphManager,
+): AbstractPureGraphManagerExtension =>
+  // NOTE: until we support more client versions, we always default to return V1
+  new V1_QueryBuilder_PureGraphManagerExtension(graphManager);

package/src/graphManager/protocol/pure/QueryBuilder_PureProtocolProcessorPlugin.ts

@@ -0,0 +1,170 @@
+/**
+ * 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 packageJson from '../../../../package.json';
+import {
+  V1_buildExistsFunctionExpression,
+  V1_buildFilterFunctionExpression,
+  V1_buildGetAllFunctionExpression,
+  V1_buildGroupByFunctionExpression,
+  V1_buildProjectFunctionExpression,
+} from './v1/V1_QueryBuilder_FunctionExpressionBuilder.js';
+import {
+  type V1_GraphBuilderContext,
+  type V1_ProcessingContext,
+  type V1_FunctionExpressionBuilder,
+  type V1_ValueSpecification,
+  type ValueSpecification,
+  type Type,
+  type V1_PropertyExpressionTypeInferrer,
+  PureProtocolProcessorPlugin,
+  matchFunctionName,
+  SimpleFunctionExpression,
+  extractElementNameFromPath,
+  V1_buildGenericFunctionExpression,
+} from '@finos/legend-graph';
+import { V1_buildSubTypePropertyExpressionTypeInference } from './v1/V1_QueryBuilder_PropertyExpressionTypeInferenceBuilder.js';
+import { QUERY_BUILDER_SUPPORTED_FUNCTIONS } from '../../../QueryBuilder_Const.js';
+
+export class QueryBuilder_PureProtocolProcessorPlugin extends PureProtocolProcessorPlugin {
+  constructor() {
+    super(
+      packageJson.extensions.pureProtocolProcessorPlugin,
+      packageJson.version,
+    );
+  }
+
+  override V1_getExtraFunctionExpressionBuilders(): V1_FunctionExpressionBuilder[] {
+    return [
+      (
+        functionName: string,
+        parameters: V1_ValueSpecification[],
+        openVariables: string[],
+        compileContext: V1_GraphBuilderContext,
+        processingContext: V1_ProcessingContext,
+      ): [SimpleFunctionExpression, ValueSpecification[]] | undefined => {
+        if (
+          matchFunctionName(
+            functionName,
+            QUERY_BUILDER_SUPPORTED_FUNCTIONS.GET_ALL,
+          )
+        ) {
+          return V1_buildGetAllFunctionExpression(
+            functionName,
+            parameters,
+            openVariables,
+            compileContext,
+            processingContext,
+          );
+        } else if (
+          matchFunctionName(
+            functionName,
+            QUERY_BUILDER_SUPPORTED_FUNCTIONS.FILTER,
+          ) ||
+          matchFunctionName(
+            functionName,
+            QUERY_BUILDER_SUPPORTED_FUNCTIONS.TDS_FILTER,
+          )
+        ) {
+          return V1_buildFilterFunctionExpression(
+            functionName,
+            parameters,
+            openVariables,
+            compileContext,
+            processingContext,
+          );
+        } else if (
+          matchFunctionName(
+            functionName,
+            QUERY_BUILDER_SUPPORTED_FUNCTIONS.EXISTS,
+          )
+        ) {
+          return V1_buildExistsFunctionExpression(
+            functionName,
+            parameters,
+            openVariables,
+            compileContext,
+            processingContext,
+          );
+        } else if (
+          matchFunctionName(
+            functionName,
+            QUERY_BUILDER_SUPPORTED_FUNCTIONS.TDS_PROJECT,
+          )
+        ) {
+          return V1_buildProjectFunctionExpression(
+            functionName,
+            parameters,
+            openVariables,
+            compileContext,
+            processingContext,
+          );
+        } else if (
+          matchFunctionName(
+            functionName,
+            QUERY_BUILDER_SUPPORTED_FUNCTIONS.TDS_GROUP_BY,
+          )
+        ) {
+          return V1_buildGroupByFunctionExpression(
+            functionName,
+            parameters,
+            openVariables,
+            compileContext,
+            processingContext,
+          );
+        } else if (
+          Object.values(QUERY_BUILDER_SUPPORTED_FUNCTIONS).some((fn) =>
+            matchFunctionName(functionName, fn),
+          )
+        ) {
+          // NOTE: this is a catch-all builder that is only meant for basic function expression
+          // such as and(), or(), etc. It will fail when type-inferencing/function-matching is required
+          // such as for project(), filter(), getAll(), etc.
+          return V1_buildGenericFunctionExpression(
+            functionName,
+            parameters,
+            openVariables,
+            compileContext,
+            processingContext,
+          );
+        }
+        return undefined;
+      },
+    ];
+  }
+
+  override V1_getExtraPropertyExpressionTypeInferrers(): V1_PropertyExpressionTypeInferrer[] {
+    return [
+      (inferredVariable: ValueSpecification | undefined): Type | undefined => {
+        let inferredType: Type | undefined =
+          inferredVariable?.genericType?.value.rawType;
+        if (
+          inferredVariable instanceof SimpleFunctionExpression &&
+          matchFunctionName(
+            inferredVariable.functionName,
+            extractElementNameFromPath(
+              QUERY_BUILDER_SUPPORTED_FUNCTIONS.SUBTYPE,
+            ),
+          )
+        ) {
+          inferredType =
+            V1_buildSubTypePropertyExpressionTypeInference(inferredVariable);
+        }
+        return inferredType;
+      },
+    ];
+  }
+}