@finos/legend-application-studio 28.13.12 → 28.13.13

package/src/components/editor/editor-group/mapping-editor/MappingTestsExplorer.tsx

@@ -21,7 +21,7 @@ import {
   type DEPRECATED__MappingTestState,
   MAPPING_TEST_EDITOR_TAB_TYPE,
   TEST_RESULT,
-} from '../../../../stores/editor/editor-state/element-editor-state/mapping/DEPRECATED__MappingTestState.js';
+} from '../../../../stores/editor/editor-state/element-editor-state/mapping/legacy/DEPRECATED__MappingTestState.js';
 import {
   clsx,
   ContextMenu,
@@ -36,10 +36,10 @@ import {
   ExclamationCircleIcon,
   PauseCircleIcon,
   PanelDropZone,
-  BlankPanelPlaceholder,
   MenuContent,
   MenuContentItem,
   Panel,
+  WarningIcon,
 } from '@finos/legend-art';
 import {
   type MappingElementDragSource,
@@ -47,17 +47,11 @@ import {
 } from '../../../../stores/editor/utils/DnDUtils.js';
 import { ClassMappingSelectorModal } from './MappingExecutionBuilder.js';
 import { flowResult } from 'mobx';
-import { Randomizer } from '@finos/legend-shared';
 import { useEditorStore } from '../../EditorStoreProvider.js';
 import { useApplicationStore } from '@finos/legend-application';
 import { SetImplementation } from '@finos/legend-graph';
 import { MappingEditorState } from '../../../../stores/editor/editor-state/element-editor-state/mapping/MappingEditorState.js';
 
-const addTestPromps = [
-  `Let's add some tests!`,
-  `"A test a day keeps the QA away"`,
-];
-
 export const MappingTestExplorerContextMenu = observer(
   forwardRef<
     HTMLDivElement,
@@ -370,6 +364,9 @@ export const MappingTestsExplorer = observer(
     // Class mapping selector
     const [openClassMappingSelectorModal, setOpenClassMappingSelectorModal] =
       useState(false);
+
+    const openMigrationtool = (): void =>
+      mappingEditorState.openMigrationTool();
     const showClassMappingSelectorModal = (): void =>
       setOpenClassMappingSelectorModal(true);
     const hideClassMappingSelectorModal = (): void =>
@@ -416,6 +413,17 @@ export const MappingTestsExplorer = observer(
               </div>
             </div>
             <div className="panel__header__actions">
+              {Boolean(mappingEditorState.mapping.test.length) && (
+                <button
+                  className="panel__header__action"
+                  onClick={openMigrationtool}
+                  disabled={isReadOnly}
+                  tabIndex={-1}
+                  title="Please migrate to new mapping test framework"
+                >
+                  <WarningIcon />
+                </button>
+              )}
               <button
                 className="panel__header__action"
                 onClick={showClassMappingSelectorModal}
@@ -478,24 +486,6 @@ export const MappingTestsExplorer = observer(
                     />
                   ),
                 )}
-              {!isReadOnly &&
-                !mappingEditorState.DEPRECATED_mappingTestStates.length && (
-                  <BlankPanelPlaceholder
-                    text={
-                      new Randomizer().getRandomItemInCollection(
-                        addTestPromps,
-                      ) ??
-                      addTestPromps[0] ??
-                      'Add a mapping test'
-                    }
-                    onClick={showClassMappingSelectorModal}
-                    clickActionType="add"
-                    tooltipText="Drop a mapping element to start testing"
-                    isDropZoneActive={isDragOver && !isReadOnly}
-                    disabled={isReadOnly}
-                    previewText="No test"
-                  />
-                )}
             </div>
           </PanelDropZone>
         </ContextMenu>

package/src/components/editor/editor-group/mapping-editor/{DEPRECATED__MappingTestEditor.tsx → legacy/DEPRECATED__MappingTestEditor.tsx}

@@ -24,7 +24,7 @@ import {
   MappingTestFlatDataInputDataState,
   MappingTestExpectedOutputAssertionState,
   MappingTestRelationalInputDataState,
-} from '../../../../stores/editor/editor-state/element-editor-state/mapping/DEPRECATED__MappingTestState.js';
+} from '../../../../../stores/editor/editor-state/element-editor-state/mapping/legacy/DEPRECATED__MappingTestState.js';
 import {
   clsx,
   PanelLoadingIndicator,
@@ -50,7 +50,7 @@ import { useDrop } from 'react-dnd';
 import {
   type MappingElementDragSource,
   CORE_DND_TYPE,
-} from '../../../../stores/editor/utils/DnDUtils.js';
+} from '../../../../../stores/editor/utils/DnDUtils.js';
 import {
   IllegalStateError,
   guaranteeType,
@@ -65,14 +65,14 @@ import {
 import {
   ClassMappingSelectorModal,
   getRelationalInputTestDataEditorLanguage,
-} from './MappingExecutionBuilder.js';
+} from '../MappingExecutionBuilder.js';
 import { flowResult } from 'mobx';
-import { MappingTestStatusIndicator } from './MappingTestsExplorer.js';
+import { MappingTestStatusIndicator } from '../MappingTestsExplorer.js';
 import {
   getMappingElementSource,
   getMappingElementTarget,
-} from '../../../../stores/editor/editor-state/element-editor-state/mapping/MappingEditorState.js';
-import { useEditorStore } from '../../EditorStoreProvider.js';
+} from '../../../../../stores/editor/editor-state/element-editor-state/mapping/MappingEditorState.js';
+import { useEditorStore } from '../../../EditorStoreProvider.js';
 import {
   Class,
   SetImplementation,
@@ -82,17 +82,17 @@ import {
   isStubbed_RawLambda,
   DEPRECATED__validate_MappingTestAssert,
 } from '@finos/legend-graph';
-import { flatData_setData } from '../../../../stores/graph-modifier/STO_FlatData_GraphModifierHelper.js';
+import { flatData_setData } from '../../../../../stores/graph-modifier/STO_FlatData_GraphModifierHelper.js';
 import {
   relationalInputData_setData,
   relationalInputData_setInputType,
-} from '../../../../stores/graph-modifier/STO_Relational_GraphModifierHelper.js';
+} from '../../../../../stores/graph-modifier/STO_Relational_GraphModifierHelper.js';
 import {
   type QueryBuilderState,
   QueryBuilderTextEditorMode,
   ExecutionPlanViewer,
 } from '@finos/legend-query-builder';
-import { MappingExecutionQueryBuilderState } from '../../../../stores/editor/editor-state/element-editor-state/mapping/MappingExecutionQueryBuilderState.js';
+import { MappingExecutionQueryBuilderState } from '../../../../../stores/editor/editor-state/element-editor-state/mapping/MappingExecutionQueryBuilderState.js';
 import {
   CODE_EDITOR_LANGUAGE,
   CodeEditor,

package/src/components/editor/editor-group/mapping-editor/legacy/MappingTestMigrationTool.tsx

@@ -0,0 +1,156 @@
+/**
+ * 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 {
+  BaseStepper,
+  BlankPanelContent,
+  Dialog,
+  Modal,
+  ModalBody,
+  ModalFooter,
+  ModalFooterButton,
+  ModalHeader,
+  PanelFormListItems,
+  PanelLoadingIndicator,
+  clsx,
+} from '@finos/legend-art';
+import { observer } from 'mobx-react-lite';
+import type { MappingEditorState } from '../../../../../stores/editor/editor-state/element-editor-state/mapping/MappingEditorState.js';
+import {
+  MIGRATE_PHASE,
+  type MappingTestMigrationState,
+} from '../../../../../stores/editor/editor-state/element-editor-state/mapping/legacy/MappingTestMigrationState.js';
+import {
+  CODE_EDITOR_LANGUAGE,
+  CodeDiffView,
+} from '@finos/legend-lego/code-editor';
+
+export const MappingTestMigrationTool = observer(
+  (props: {
+    mappingEditorState: MappingEditorState;
+    migrationState: MappingTestMigrationState;
+  }) => {
+    const { mappingEditorState, migrationState } = props;
+    const isLoading =
+      migrationState.confirmationState?.calculatingDiffs.isInProgress;
+    const close = (): void => {
+      mappingEditorState.closeMigrationTool();
+    };
+    const handleBack = (): void => {
+      migrationState.handleBack();
+    };
+    const handleNext = (): void => {
+      migrationState.handleNext();
+    };
+    const disabled =
+      !migrationState.migrateableTests.length &&
+      !migrationState.unSupportedTestsToMigrate.length;
+    return (
+      <Dialog
+        open={true}
+        onClose={close}
+        classes={{
+          root: 'editor-modal__root-container',
+          container: 'editor-modal__container',
+          paper: 'editor-modal__content',
+        }}
+      >
+        <Modal
+          darkMode={true}
+          className={clsx('editor-modal query-builder-text-mode__modal')}
+        >
+          <ModalHeader title="Migrate Legacy Tests"></ModalHeader>
+          <ModalBody>
+            <PanelLoadingIndicator isLoading={Boolean(isLoading)} />
+            <BaseStepper
+              steps={migrationState.steps}
+              activeStep={migrationState.activeStep}
+            />
+            {!disabled ? (
+              <div className="mapping-migration-tool">
+                {migrationState.currentStep === MIGRATE_PHASE.OVERVIEW && (
+                  <>
+                    <PanelFormListItems
+                      title="Migrable Tests"
+                      prompt="tests that can be migrated via migration tool"
+                    >
+                      {migrationState.migrateableTests.map((test) => (
+                        <div
+                          className="panel__content__form__section__list__item"
+                          key={test.name}
+                        >
+                          <div className="panel__content__form__section__list__item__value">
+                            {test.name}
+                          </div>
+                        </div>
+                      ))}
+                    </PanelFormListItems>
+                    <PanelFormListItems
+                      title="Unsupported Tests"
+                      prompt="tests unable to be migrated"
+                    >
+                      {migrationState.unSupportedTestsToMigrate.map((test) => (
+                        <div
+                          className="panel__content__form__section__list__item"
+                          key={test.name}
+                        >
+                          <div className="panel__content__form__section__list__item__value">
+                            {test.name}
+                          </div>
+                        </div>
+                      ))}
+                    </PanelFormListItems>
+                  </>
+                )}
+                {migrationState.currentStep === MIGRATE_PHASE.CONFIRM &&
+                  migrationState.confirmationState && (
+                    <div className="query-builder__diff-panel__content">
+                      <CodeDiffView
+                        language={CODE_EDITOR_LANGUAGE.PURE}
+                        from={migrationState.confirmationState.before ?? ''}
+                        to={migrationState.confirmationState.after ?? ''}
+                      />
+                    </div>
+                  )}
+              </div>
+            ) : (
+              <div className="mapping-migration-tool">
+                <BlankPanelContent>No Migrateable Tests</BlankPanelContent>
+              </div>
+            )}
+          </ModalBody>
+          <ModalFooter>
+            <ModalFooterButton
+              className="query-connection-workflow__actions__action-btn"
+              disabled={migrationState.disableBack || disabled}
+              onClick={handleBack}
+              title="Go to previous step..."
+            >
+              Back
+            </ModalFooterButton>
+            <ModalFooterButton
+              className="query-connection-workflow__actions__action-btn query-connection-workflow__actions__action-btn--primary"
+              disabled={migrationState.disableNext || disabled}
+              onClick={handleNext}
+            >
+              {migrationState.nextText}
+            </ModalFooterButton>
+          </ModalFooter>
+        </Modal>
+      </Dialog>
+    );
+  },
+);

package/src/index.ts

@@ -74,7 +74,7 @@ export * from './stores/editor/sidebar-state/testable/GlobalTestRunnerState.js';
 
 export { PostProcessorEditorState } from './stores/editor/editor-state/element-editor-state/connection/PostProcessorEditorState.js';
 export { MappingExecutionState } from './stores/editor/editor-state/element-editor-state/mapping/MappingExecutionState.js';
-export { DEPRECATED__MappingTestState } from './stores/editor/editor-state/element-editor-state/mapping/DEPRECATED__MappingTestState.js';
+export { DEPRECATED__MappingTestState } from './stores/editor/editor-state/element-editor-state/mapping/legacy/DEPRECATED__MappingTestState.js';
 export {
   ConnectionValueState,
   RelationalDatabaseConnectionValueState,

package/src/stores/editor/editor-state/element-editor-state/mapping/MappingEditorState.ts

@@ -33,7 +33,7 @@ import {
   MAPPING_TEST_EDITOR_TAB_TYPE,
   DEPRECATED__MappingTestState,
   TEST_RESULT,
-} from './DEPRECATED__MappingTestState.js';
+} from './legacy/DEPRECATED__MappingTestState.js';
 import { createMockDataForMappingElementSource } from '../../../utils/MockDataUtils.js';
 import {
   type GeneratorFn,
@@ -59,7 +59,7 @@ import { RootRelationalInstanceSetImplementationState } from './relational/Relat
 import {
   type CompilationError,
   type PackageableElement,
-  type InputData,
+  type DEPRECATED__InputData,
   Type,
   type EmbeddedSetImplementation,
   type ExecutionResult,
@@ -74,8 +74,8 @@ import {
   EnumerationMapping,
   SetImplementation,
   PureInstanceSetImplementation,
-  ExpectedOutputMappingTestAssert,
-  ObjectInputData,
+  DEPRECATED__ExpectedOutputMappingTestAssert,
+  DEPRECATED__ObjectInputData,
   ObjectInputType,
   FlatDataInstanceSetImplementation,
   InstanceSetImplementation,
@@ -125,6 +125,7 @@ import { rootRelationalSetImp_setMainTableAlias } from '../../../../graph-modifi
 import { LambdaEditorState } from '@finos/legend-query-builder';
 import type { MappingEditorTabState } from './MappingTabManagerState.js';
 import { MappingTestableState } from './testable/MappingTestableState.js';
+import { MappingTestMigrationState } from './legacy/MappingTestMigrationState.js';
 
 export interface MappingExplorerTreeNodeData extends TreeNodeData {
   mappingElement: MappingElement;
@@ -626,6 +627,7 @@ export class MappingEditorState extends ElementEditorState {
 
   // DEPREACTED legacy tests: TO REMOVE once mapping testable dev work is complete
   DEPRECATED_mappingTestStates: DEPRECATED__MappingTestState[] = [];
+  migrationState: MappingTestMigrationState | undefined;
   isRunningAllTests = false;
   allTestRunTime = 0;
 
@@ -640,11 +642,15 @@ export class MappingEditorState extends ElementEditorState {
       isRunningAllTests: observable,
       allTestRunTime: observable,
       selectedTab: observable,
+      migrationState: observable,
       mappingExplorerTreeData: observable.ref,
       mapping: computed,
       testSuiteResult: computed,
       setNewMappingElementSpec: action,
+      openMigrationTool: action,
+      closeMigrationTool: action,
       setMappingExplorerTreeNodeData: action,
+      buildLegacyTestsStates: action,
       openMappingElement: action,
       closeAllTabs: action,
       createMappingElement: action,
@@ -666,9 +672,7 @@ export class MappingEditorState extends ElementEditorState {
       deleteMappingElement: flow,
     });
 
-    this.DEPRECATED_mappingTestStates = this.mapping.test.map(
-      (t) => new DEPRECATED__MappingTestState(editorStore, t, this),
-    );
+    this.DEPRECATED_mappingTestStates = this.buildLegacyTestsStates();
     this.mappingExplorerTreeData = getMappingElementTreeData(
       this.mapping,
       editorStore,
@@ -684,6 +688,12 @@ export class MappingEditorState extends ElementEditorState {
     );
   }
 
+  buildLegacyTestsStates(): DEPRECATED__MappingTestState[] {
+    return this.mapping.test.map(
+      (t) => new DEPRECATED__MappingTestState(this.editorStore, t, this),
+    );
+  }
+
   /**
    * This method is used to check if a target is being mapped multiple times, so we can make
    * decision on things like whether we enforce the user to provide an ID for those mapping elements.
@@ -1393,6 +1403,23 @@ export class MappingEditorState extends ElementEditorState {
 
   // -------------------------------------- Test ---------------------------------------
 
+  openMigrationTool(): void {
+    if (!this.mapping.test.length) {
+      this.editorStore.applicationStore.notificationService.notifyError(
+        'No legacy tests to migrate',
+      );
+      return;
+    }
+    this.migrationState = MappingTestMigrationState.build(
+      this.editorStore,
+      this,
+    );
+  }
+
+  closeMigrationTool(): void {
+    this.migrationState = undefined;
+  }
+
   *openTest(
     test: DEPRECATED__MappingTest,
     openTab?: MAPPING_TEST_EDITOR_TAB_TYPE,
@@ -1546,9 +1573,9 @@ export class MappingEditorState extends ElementEditorState {
         `Can't auto-generate input data for operation class mapping. Please pick a concrete class mapping instead`,
       );
     }
-    let inputData: InputData;
+    let inputData: DEPRECATED__InputData;
     if (source === undefined || source instanceof Class) {
-      inputData = new ObjectInputData(
+      inputData = new DEPRECATED__ObjectInputData(
         PackageableElementExplicitReference.create(source ?? stub_Class()),
         ObjectInputType.JSON,
         source
@@ -1578,7 +1605,7 @@ export class MappingEditorState extends ElementEditorState {
       generateMappingTestName(this.mapping),
       query,
       [inputData],
-      new ExpectedOutputMappingTestAssert('{}'),
+      new DEPRECATED__ExpectedOutputMappingTestAssert('{}'),
     );
     mapping_addDEPRECATEDTest(
       this.mapping,

package/src/stores/editor/editor-state/element-editor-state/mapping/MappingExecutionState.ts

@@ -51,7 +51,7 @@ import {
 } from '@finos/legend-shared';
 import { createMockDataForMappingElementSource } from '../../../utils/MockDataUtils.js';
 import {
-  type InputData,
+  type DEPRECATED__InputData,
   type Mapping,
   type Connection,
   type ExecutionResult,
@@ -69,9 +69,9 @@ import {
   LAMBDA_PIPE,
   GRAPH_MANAGER_EVENT,
   Class,
-  ObjectInputData,
+  DEPRECATED__ObjectInputData,
   ObjectInputType,
-  ExpectedOutputMappingTestAssert,
+  DEPRECATED__ExpectedOutputMappingTestAssert,
   IdentifiedConnection,
   EngineRuntime,
   JsonModelConnection,
@@ -209,12 +209,12 @@ abstract class MappingExecutionInputDataState {
   readonly uuid = uuid();
   editorStore: EditorStore;
   mapping: Mapping;
-  inputData?: InputData | undefined;
+  inputData?: DEPRECATED__InputData | undefined;
 
   constructor(
     editorStore: EditorStore,
     mapping: Mapping,
-    inputData: InputData | undefined,
+    inputData: DEPRECATED__InputData | undefined,
   ) {
     this.editorStore = editorStore;
     this.mapping = mapping;
@@ -232,7 +232,7 @@ abstract class MappingExecutionInputDataState {
     return undefined;
   }
 
-  abstract buildInputDataForTest(): InputData;
+  abstract buildInputDataForTest(): DEPRECATED__InputData;
 }
 
 export const createRuntimeForExecution = (
@@ -267,7 +267,7 @@ export class MappingExecutionEmptyInputDataState extends MappingExecutionInputDa
     );
   }
 
-  buildInputDataForTest(): InputData {
+  buildInputDataForTest(): DEPRECATED__InputData {
     throw new IllegalStateError(
       'Mapping execution runtime information is not specified',
     );
@@ -276,13 +276,13 @@ export class MappingExecutionEmptyInputDataState extends MappingExecutionInputDa
 
 // TODO?: handle XML
 export class MappingExecutionObjectInputDataState extends MappingExecutionInputDataState {
-  declare inputData: ObjectInputData;
+  declare inputData: DEPRECATED__ObjectInputData;
 
   constructor(editorStore: EditorStore, mapping: Mapping, _class: Class) {
     super(
       editorStore,
       mapping,
-      new ObjectInputData(
+      new DEPRECATED__ObjectInputData(
         PackageableElementExplicitReference.create(
           guaranteeNonNullable(_class),
         ),
@@ -344,8 +344,8 @@ export class MappingExecutionObjectInputDataState extends MappingExecutionInputD
     return jsonAssertion;
   }
 
-  buildInputDataForTest(): InputData {
-    return new ObjectInputData(
+  buildInputDataForTest(): DEPRECATED__InputData {
+    return new DEPRECATED__ObjectInputData(
       PackageableElementExplicitReference.create(
         guaranteeNonNullable(this.inputData.sourceClass.value),
       ),
@@ -402,7 +402,7 @@ export class MappingExecutionFlatDataInputDataState extends MappingExecutionInpu
     );
   }
 
-  buildInputDataForTest(): InputData {
+  buildInputDataForTest(): DEPRECATED__InputData {
     return new FlatDataInputData(
       PackageableElementExplicitReference.create(
         guaranteeNonNullable(this.inputData.sourceFlatData.value),
@@ -474,7 +474,7 @@ export class MappingExecutionRelationalInputDataState extends MappingExecutionIn
     );
   }
 
-  buildInputDataForTest(): InputData {
+  buildInputDataForTest(): DEPRECATED__InputData {
     return new RelationalInputData(
       PackageableElementExplicitReference.create(
         guaranteeNonNullable(this.inputData.database.value),
@@ -664,7 +664,7 @@ export class MappingExecutionState extends MappingEditorTabState {
         this.executionResultText
       ) {
         const inputData = this.inputDataState.buildInputDataForTest();
-        const assert = new ExpectedOutputMappingTestAssert(
+        const assert = new DEPRECATED__ExpectedOutputMappingTestAssert(
           toGrammarString(this.executionResultText),
         );
         const mappingTest = new DEPRECATED__MappingTest(