@finos/legend-application-repl 0.0.2

package/src/stores/LegendREPLGridClientBaseStore.ts

@@ -0,0 +1,34 @@
+/**
+ * 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 { ApplicationStore } from '@finos/legend-application';
+import type { LegendREPLGridClientApplicationConfig } from '../application/LegendREPLGridClientApplicationConfig.js';
+import type { LegendREPLGridClientPluginManager } from '../application/LegendREPLGridClientPluginManager.js';
+
+export type LegendREPLGridClientApplicationStore = ApplicationStore<
+  LegendREPLGridClientApplicationConfig,
+  LegendREPLGridClientPluginManager
+>;
+
+export class LegendREPLGridClientBaseStore {
+  readonly applicationStore: LegendREPLGridClientApplicationStore;
+  readonly pluginManager: LegendREPLGridClientPluginManager;
+
+  constructor(applicationStore: LegendREPLGridClientApplicationStore) {
+    this.applicationStore = applicationStore;
+    this.pluginManager = applicationStore.pluginManager;
+  }
+}

package/src/stores/REPLGridClientStore.ts

@@ -0,0 +1,153 @@
+/**
+ * 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 { LegendREPLGridClientApplicationStore } from './LegendREPLGridClientBaseStore.js';
+import { REPLServerClient } from '../server/REPLServerClient.js';
+import {
+  NetworkClient,
+  type GeneratorFn,
+  type PlainObject,
+  assertErrorThrown,
+  LogEvent,
+  guaranteeNonNullable,
+  guaranteeType,
+} from '@finos/legend-shared';
+import type { TDSRequest } from '../components/grid/TDSRequest.js';
+import { flow, flowResult, makeObservable, observable } from 'mobx';
+import { REPLGridServerResult } from '../components/grid/REPLGridServerResult.js';
+import { LEGEND_REPL_EVENT } from '../Const.js';
+import { REPLGridState } from './REPLGridState.js';
+import { buildLambdaExpressions } from '../components/grid/TDSLambdaBuilder.js';
+import {
+  type V1_TDSExecutionResult,
+  TDSExecutionResult,
+  V1_Lambda,
+  V1_buildExecutionResult,
+  V1_deserializeValueSpecification,
+  V1_serializeExecutionResult,
+  V1_serializeValueSpecification,
+} from '@finos/legend-graph';
+
+export class REPLGridClientStore {
+  readonly applicationStore: LegendREPLGridClientApplicationStore;
+  readonly client: REPLServerClient;
+  replGridState!: REPLGridState;
+
+  constructor(applicationStore: LegendREPLGridClientApplicationStore) {
+    makeObservable(this, {
+      replGridState: observable,
+      getREPLGridServerResult: flow,
+      getInitialQueryLambda: flow,
+      getInitialREPLGridServerResult: flow,
+      getLicenseKey: flow,
+    });
+    this.applicationStore = applicationStore;
+    this.client = new REPLServerClient(
+      new NetworkClient({
+        baseUrl: this.applicationStore.config.useDynamicREPLServer
+          ? window.location.origin
+          : this.applicationStore.config.replUrl,
+      }),
+    );
+    this.replGridState = new REPLGridState();
+  }
+
+  *getREPLGridServerResult(tdsRequest: TDSRequest): GeneratorFn<void> {
+    try {
+      const isSubQuery = tdsRequest.groupBy.groupKeys.length !== 0;
+      const lambda = buildLambdaExpressions(
+        guaranteeNonNullable(this.replGridState.initialQueryLambda?.body[0]),
+        tdsRequest,
+      );
+      const resultObj = (yield flowResult(
+        this.client.getREPLGridServerResult(
+          V1_serializeValueSpecification(lambda, []),
+        ),
+      )) as PlainObject<REPLGridServerResult>;
+      const replGridResult =
+        REPLGridServerResult.serialization.fromJson(resultObj);
+      const tdsResult = JSON.parse(
+        replGridResult.result,
+      ) as PlainObject<V1_TDSExecutionResult>;
+      this.replGridState.setCurrentResult(
+        guaranteeType(
+          V1_buildExecutionResult(V1_serializeExecutionResult(tdsResult)),
+          TDSExecutionResult,
+        ),
+      );
+      if (isSubQuery) {
+        this.replGridState.setCurrentSubQuery(replGridResult.currentQuery);
+      } else {
+        this.replGridState.setCurrentQuery(replGridResult.currentQuery);
+        this.replGridState.setCurrentSubQuery(undefined);
+      }
+    } catch (error) {
+      assertErrorThrown(error);
+      this.applicationStore.notificationService.notifyError(error);
+      this.applicationStore.logService.error(
+        LogEvent.create(LEGEND_REPL_EVENT.FETCH_TDS_FAILURE),
+        error,
+      );
+    }
+  }
+
+  *getInitialQueryLambda(): GeneratorFn<void> {
+    const lambdaObj =
+      (yield this.client.getIntialQueryLambda()) as PlainObject<V1_Lambda>;
+    const lambda = V1_deserializeValueSpecification(lambdaObj, []);
+    if (lambda instanceof V1_Lambda) {
+      this.replGridState.setInitialQueryLambda(lambda);
+    }
+  }
+
+  *getInitialREPLGridServerResult(): GeneratorFn<void> {
+    try {
+      if (!this.replGridState.licenseKey) {
+        yield flowResult(this.getLicenseKey());
+      }
+      if (!this.replGridState.initialQueryLambda) {
+        yield flowResult(this.getInitialQueryLambda());
+      }
+      const resultObj =
+        (yield this.client.getInitialREPLGridServerResult()) as PlainObject<REPLGridServerResult>;
+      const replGridResult =
+        REPLGridServerResult.serialization.fromJson(resultObj);
+      const tdsResultObj = JSON.parse(
+        replGridResult.result,
+      ) as PlainObject<V1_TDSExecutionResult>;
+      const tdsResult = guaranteeType(
+        V1_buildExecutionResult(V1_serializeExecutionResult(tdsResultObj)),
+        TDSExecutionResult,
+      );
+      this.replGridState.setInitialResult(tdsResult);
+      this.replGridState.setCurrentQuery(replGridResult.currentQuery);
+      this.replGridState.setCurrentSubQuery(undefined);
+      this.replGridState.setColumns(tdsResult.result.columns);
+    } catch (error) {
+      assertErrorThrown(error);
+      this.applicationStore.notificationService.notifyError(error);
+      this.applicationStore.logService.error(
+        LogEvent.create(LEGEND_REPL_EVENT.FETCH_TDS_FAILURE),
+        error,
+      );
+    }
+  }
+
+  *getLicenseKey(): GeneratorFn<void> {
+    const licenseKey = (yield this.client.getLicenseKey()) as string;
+    this.replGridState.setLicenseKey(licenseKey);
+  }
+}

package/src/stores/REPLGridState.ts

@@ -0,0 +1,102 @@
+/**
+ * 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 { guaranteeNonNullable } from '@finos/legend-shared';
+import {
+  getAggregationTDSColumnCustomizations,
+  getTDSRowData,
+  type TDSRowDataType,
+} from '../components/grid/GridUtils.js';
+import { action, computed, makeObservable, observable } from 'mobx';
+import type { ColDef } from '@ag-grid-community/core';
+import type { V1_Lambda, TDSExecutionResult } from '@finos/legend-graph';
+
+export class REPLGridState {
+  initialResult?: TDSExecutionResult | undefined;
+  currentResult?: TDSExecutionResult | undefined;
+  columns?: string[] | undefined;
+  currentQuery?: string | undefined;
+  currentSubQuery?: string | undefined;
+  licenseKey?: string | undefined;
+  initialQueryLambda?: V1_Lambda | undefined;
+
+  constructor() {
+    makeObservable(this, {
+      initialResult: observable,
+      initialQueryLambda: observable,
+      currentResult: observable,
+      currentQuery: observable,
+      currentSubQuery: observable,
+      licenseKey: observable,
+      columns: observable,
+      setInitialResult: action,
+      setCurrentQuery: action,
+      setCurrentSubQuery: action,
+      setColumns: action,
+      setInitialQueryLambda: action,
+      setCurrentResult: action,
+      setLicenseKey: action,
+      rowData: computed,
+      columnDefs: computed,
+    });
+  }
+
+  setInitialQueryLambda(val: V1_Lambda | undefined): void {
+    this.initialQueryLambda = val;
+  }
+
+  setCurrentQuery(val: string | undefined): void {
+    this.currentQuery = val;
+  }
+
+  setCurrentSubQuery(val: string | undefined): void {
+    this.currentSubQuery = val;
+  }
+
+  setInitialResult(val: TDSExecutionResult | undefined): void {
+    this.initialResult = val;
+  }
+
+  setCurrentResult(val: TDSExecutionResult | undefined): void {
+    this.currentResult = val;
+  }
+
+  setColumns(val: string[]): void {
+    this.columns = val;
+  }
+
+  setLicenseKey(val: string | undefined): void {
+    this.licenseKey = val;
+  }
+
+  get rowData(): TDSRowDataType[] {
+    return this.initialResult ? getTDSRowData(this.initialResult.result) : [];
+  }
+
+  get columnDefs(): ColDef[] {
+    return this.columns
+      ? this.columns.map((c) => ({
+          field: c,
+          headerName: c,
+          ...getAggregationTDSColumnCustomizations(
+            this.licenseKey ? true : false,
+            guaranteeNonNullable(this.initialResult),
+            c,
+          ),
+        }))
+      : [];
+  }
+}

package/tsconfig.json

@@ -0,0 +1,66 @@
+{
+  "compilerOptions": {
+    "lib": [
+      "dom",
+      "dom.iterable",
+      "esnext",
+      "webworker",
+      "scripthost"
+    ],
+    "composite": true,
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "target": "esnext",
+    "module": "nodenext",
+    "skipLibCheck": true,
+    "resolveJsonModule": true,
+    "verbatimModuleSyntax": true,
+    "strict": true,
+    "noImplicitOverride": true,
+    "noUncheckedIndexedAccess": true,
+    "exactOptionalPropertyTypes": true,
+    "forceConsistentCasingInFileNames": true,
+    "outDir": "./lib",
+    "tsBuildInfoFile": "./build/prod.tsbuildinfo",
+    "rootDir": "./src",
+    "jsx": "react-jsx"
+  },
+  "references": [
+    {
+      "path": "./tsconfig.package.json"
+    }
+  ],
+  "files": [
+    "./src/Const.ts",
+    "./src/application/LegendREPLGridClientApplicationConfig.ts",
+    "./src/application/LegendREPLGridClientPluginManager.ts",
+    "./src/components/grid/GridUtils.ts",
+    "./src/components/grid/REPLGridServerResult.ts",
+    "./src/components/grid/ServerSideDataSource.ts",
+    "./src/components/grid/TDSLambdaBuilder.ts",
+    "./src/components/grid/TDSRequest.ts",
+    "./src/server/REPLServerClient.ts",
+    "./src/stores/LegendREPLGridClientApplicationPlugin.ts",
+    "./src/stores/LegendREPLGridClientBaseStore.ts",
+    "./src/stores/REPLGridClientStore.ts",
+    "./src/stores/REPLGridState.ts",
+    "./src/index.tsx",
+    "./src/application/LegendREPLGridClient.tsx",
+    "./src/components/AgGrid.tsx",
+    "./src/components/Core_LegendREPLGridClientApplicationPlugin.tsx",
+    "./src/components/LegendREPLGridClientApplication.tsx",
+    "./src/components/LegendREPLGridClientFrameworkProvider.tsx",
+    "./src/components/REPLGridClient.tsx",
+    "./src/components/REPLGridClientStoreProvider.tsx"
+  ],
+  "include": [
+    "src/**/*.ts",
+    "src/**/*.tsx",
+    "src/**/*.json"
+  ],
+  "exclude": [
+    "src/**/__tests__/**/*.*",
+    "src/**/__mocks__/**/*.*"
+  ]
+}