@finos/legend-application-studio 28.18.124 → 28.18.126

package/src/stores/ingestion/IngestionDeploymentResponse.ts

@@ -0,0 +1,73 @@
+/**
+ * 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 { SerializationFactory, type PlainObject } from '@finos/legend-shared';
+import { createModelSchema, primitive } from 'serializr';
+
+export enum IngestDefinitionValidationResponseStatus {
+  NOT_CHECKED = 'NOT_CHECKED',
+  SUCCESS = 'SUCCESS',
+  FAILURE = 'FAILURE',
+}
+
+export class IngestDefinitionValidationOutput {
+  status!: IngestDefinitionValidationResponseStatus;
+}
+
+export class IngestDefinitionValidationResponse {
+  status!: IngestDefinitionValidationResponseStatus;
+  content!: PlainObject;
+
+  static readonly serialization = new SerializationFactory(
+    createModelSchema(IngestDefinitionValidationResponse, {
+      status: primitive(),
+    }),
+  );
+}
+
+export const createIngestDefinitionValidationResponse = (
+  json: PlainObject<IngestDefinitionValidationResponse>,
+): IngestDefinitionValidationResponse => {
+  const ingestDefinitionValidationResponse =
+    new IngestDefinitionValidationResponse();
+  ingestDefinitionValidationResponse.status =
+    json.status as IngestDefinitionValidationResponseStatus;
+  ingestDefinitionValidationResponse.content = json;
+  return ingestDefinitionValidationResponse;
+};
+
+export class IngestDefinitionDeploymentResponse {
+  ingestDefinitionUrn!: string;
+
+  static readonly serialization = new SerializationFactory(
+    createModelSchema(IngestDefinitionDeploymentResponse, {
+      ingestDefinitionUrn: primitive(),
+    }),
+  );
+}
+
+export class ValidateAndDeploymentResponse {
+  validationResponse: IngestDefinitionValidationResponse;
+  deploymentResponse: IngestDefinitionDeploymentResponse | undefined;
+
+  constructor(
+    validationResponse: IngestDefinitionValidationResponse,
+    deploymentResponse: IngestDefinitionDeploymentResponse | undefined,
+  ) {
+    this.validationResponse = validationResponse;
+    this.deploymentResponse = deploymentResponse;
+  }
+}

package/src/stores/ingestion/IngestionManager.ts

@@ -0,0 +1,163 @@
+/**
+ * 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 { AppDirNode } from '@finos/legend-graph';
+import { IngestDeploymentServerClient } from './IngestDeploymentServerClient.js';
+import { IngestDiscoveryServerClient } from './IngestDiscoveryServerClient.js';
+import type { GenericLegendApplicationStore } from '@finos/legend-application';
+import { type ActionState, type PlainObject } from '@finos/legend-shared';
+import {
+  type IngestDefinitionValidationResponse,
+  IngestDefinitionDeploymentResponse,
+  IngestDefinitionValidationResponseStatus,
+  ValidateAndDeploymentResponse,
+  createIngestDefinitionValidationResponse,
+} from './IngestionDeploymentResponse.js';
+import {
+  IngestDeploymentServerConfig,
+  type LegendIngestionConfiguration,
+} from '../../application/LegendIngestionConfiguration.js';
+
+export class IngestionManager {
+  private ingestDiscoveryServerClient: IngestDiscoveryServerClient;
+  private ingestDeploymentServerClient: IngestDeploymentServerClient;
+  private _currentAppID: number | undefined;
+  private _currentLevel: string | undefined;
+  private readonly applicationStore: GenericLegendApplicationStore;
+
+  constructor(
+    config: LegendIngestionConfiguration,
+    applicationStore: GenericLegendApplicationStore,
+  ) {
+    this.ingestDiscoveryServerClient = new IngestDiscoveryServerClient(
+      config.discoveryUrl,
+    );
+    this.ingestDiscoveryServerClient.setTracerService(
+      applicationStore.tracerService,
+    );
+    this.ingestDeploymentServerClient = new IngestDeploymentServerClient(
+      config.deployment.defaultServer,
+    );
+    this.ingestDeploymentServerClient.setTracerService(
+      applicationStore.tracerService,
+    );
+    this.applicationStore = applicationStore;
+  }
+
+  isCurrentAppDirNode(appDirNode: AppDirNode): boolean {
+    return (
+      this._currentAppID === appDirNode.appDirId &&
+      this._currentLevel === appDirNode.level
+    );
+  }
+
+  setCurrentAppDirNode(appDirNode: AppDirNode): void {
+    this._currentAppID = appDirNode.appDirId;
+    this._currentLevel = appDirNode.level;
+  }
+
+  async deploy(
+    ingestDefinition: string,
+    appDirNode: AppDirNode,
+    actionState: ActionState | undefined,
+    token: string | undefined,
+  ): Promise<ValidateAndDeploymentResponse> {
+    actionState?.setMessage(
+      `Discovering associated ingest environment for DID ${appDirNode.appDirId}...`,
+    );
+    await this.identifyIngestDeploymentServer(appDirNode, token);
+    actionState?.setMessage(
+      `Validating ingest with server ${this.ingestDeploymentServerClient.baseUrl ?? ''} for realm ${this.ingestDeploymentServerClient.environmentClassification}...`,
+    );
+    const validateResonse = await this._validate(
+      ingestDefinition,
+      undefined,
+      token,
+    );
+    const fullResponse = new ValidateAndDeploymentResponse(
+      validateResonse,
+      undefined,
+    );
+    if (
+      validateResonse.status !==
+      IngestDefinitionValidationResponseStatus.SUCCESS
+    ) {
+      return fullResponse;
+    }
+    actionState?.setMessage(
+      `Validation Success. Deploying ingest with server ${this.ingestDeploymentServerClient.baseUrl ?? ''} for realm ${this.ingestDeploymentServerClient.environmentClassification}...`,
+    );
+    const deployResponse = await this._deploy(
+      ingestDefinition,
+      undefined,
+      token,
+    );
+    fullResponse.deploymentResponse = deployResponse;
+    return fullResponse;
+  }
+
+  private async _validate(
+    ingestDefinition: string,
+    appDirNode: AppDirNode | undefined,
+    token: string | undefined,
+  ): Promise<IngestDefinitionValidationResponse> {
+    if (appDirNode) {
+      await this.identifyIngestDeploymentServer(appDirNode, token);
+    }
+    // validate
+    const response = await this.ingestDeploymentServerClient.validate(
+      ingestDefinition,
+      token,
+    );
+    return createIngestDefinitionValidationResponse(response);
+  }
+
+  private async _deploy(
+    ingestDefinition: string,
+    appDirNode: AppDirNode | undefined,
+    token: string | undefined,
+  ): Promise<IngestDefinitionDeploymentResponse> {
+    if (appDirNode) {
+      await this.identifyIngestDeploymentServer(appDirNode, token);
+    }
+    // validate
+    const response = (await this.ingestDeploymentServerClient.deploy(
+      ingestDefinition,
+      token,
+    )) as unknown as PlainObject<IngestDefinitionDeploymentResponse>;
+    return IngestDefinitionDeploymentResponse.serialization.fromJson(response);
+  }
+
+  private async identifyIngestDeploymentServer(
+    appDirNode: AppDirNode,
+    token: string | undefined,
+  ): Promise<void> {
+    // we do not change if current appDirNode is the same as the one we are trying to set
+    if (this.isCurrentAppDirNode(appDirNode)) {
+      return;
+    }
+    const serverConfig = IngestDeploymentServerConfig.serialization.fromJson(
+      await this.ingestDiscoveryServerClient.findProducerServer(
+        appDirNode.appDirId,
+        appDirNode.level,
+        token,
+      ),
+    );
+
+    this.ingestDeploymentServerClient.changeServer(serverConfig);
+    this.setCurrentAppDirNode(appDirNode);
+  }
+}

package/tsconfig.json

@@ -67,6 +67,7 @@
     "./src/__lib__/LegendStudioTesting.ts",
     "./src/__lib__/LegendStudioUserDataHelper.ts",
     "./src/__lib__/STO_Relational_LegendStudioCommand.ts",
+    "./src/application/LegendIngestionConfiguration.ts",
     "./src/application/LegendStudioApplicationConfig.ts",
     "./src/application/LegendStudioPluginManager.ts",
     "./src/components/__test-utils__/EmbeddedQueryBuilderTestUtils.ts",
@@ -108,6 +109,7 @@
     "./src/stores/editor/editor-state/diff-viewer-state/ProjectConfigurationDiffEditorState.ts",
     "./src/stores/editor/editor-state/element-editor-state/ClassEditorState.ts",
     "./src/stores/editor/editor-state/element-editor-state/ClassState.ts",
+    "./src/stores/editor/editor-state/element-editor-state/ElementEditorInitialConfiguration.ts",
     "./src/stores/editor/editor-state/element-editor-state/ElementEditorState.ts",
     "./src/stores/editor/editor-state/element-editor-state/ElementExternalFormatGenerationState.ts",
     "./src/stores/editor/editor-state/element-editor-state/ElementFileGenerationState.ts",
@@ -134,6 +136,7 @@
     "./src/stores/editor/editor-state/element-editor-state/function-activator/PostDeploymentActionEditorState.ts",
     "./src/stores/editor/editor-state/element-editor-state/function-activator/SnowflakeAppFunctionActivatorEditorState.ts",
     "./src/stores/editor/editor-state/element-editor-state/function-activator/testable/FunctionTestableState.ts",
+    "./src/stores/editor/editor-state/element-editor-state/ingest/IngestDefinitionEditorState.ts",
     "./src/stores/editor/editor-state/element-editor-state/mapping/FlatDataInstanceSetImplementationState.ts",
     "./src/stores/editor/editor-state/element-editor-state/mapping/MappingEditorState.ts",
     "./src/stores/editor/editor-state/element-editor-state/mapping/MappingElementDecorator.ts",
@@ -202,6 +205,10 @@
     "./src/stores/graph-modifier/STO_FlatData_GraphModifierHelper.ts",
     "./src/stores/graph-modifier/STO_Relational_GraphModifierHelper.ts",
     "./src/stores/graph-modifier/Testable_GraphModifierHelper.ts",
+    "./src/stores/ingestion/IngestDeploymentServerClient.ts",
+    "./src/stores/ingestion/IngestDiscoveryServerClient.ts",
+    "./src/stores/ingestion/IngestionDeploymentResponse.ts",
+    "./src/stores/ingestion/IngestionManager.ts",
     "./src/stores/lazy-text-editor/LazyTextEditorStore.ts",
     "./src/stores/project-reviewer/ProjectReviewerStore.ts",
     "./src/stores/project-view/ProjectViewerEditorMode.ts",
@@ -267,6 +274,7 @@
     "./src/components/editor/editor-group/function-activator/INTERNAL__UnknownFunctionActivatorEdtior.tsx",
     "./src/components/editor/editor-group/function-activator/SnowflakeAppFunctionActivatorEditor.tsx",
     "./src/components/editor/editor-group/function-activator/testable/FunctionTestableEditor.tsx",
+    "./src/components/editor/editor-group/ingest-editor/IngestDefinitionEditor.tsx",
     "./src/components/editor/editor-group/mapping-editor/ClassMappingEditor.tsx",
     "./src/components/editor/editor-group/mapping-editor/EnumerationMappingEditor.tsx",
     "./src/components/editor/editor-group/mapping-editor/FlatDataPropertyMappingEditor.tsx",