merge: merge branch 'THU/fix_dataset_wizard_form_state_PROD-14393'

csm-thu · csm-thu · commit fc90098102c3 · 2025-05-06T16:25:24.000+02:00
diff --git a/cypress/e2e/brewery/DatasetManager.cy.js b/cypress/e2e/brewery/DatasetManager.cy.js
@@ -44,6 +44,7 @@ describe('Dataset manager can be empty on start', () => {
 describe('Data edition in dataset manager', () => {
   before(() => {
     stub.start();
+    stub.setOrganizations([ORGANIZATION_WITH_DEFAULT_ROLE_USER]);
     stub.setWorkspaces(WORKSPACES);
     stub.setSolutions([SOLUTION_WITH_TRANSLATED_RUN_TEMPLATES]);
     // we use the copy of DATASETS array to be able to reuse the same fixture
@@ -116,6 +117,48 @@ describe('Data edition in dataset manager', () => {
     DatasetManager.getDatasetMetadataDescription().should('contain', newDescription);
     DatasetManager.getDatasetMetadataTag(1).should('contain', newTag);
   });
+
+  it('correctly handles the form state even after closing and reopening the dataset creation dialog', () => {
+    DatasetManager.ignoreDatasetTwingraphQueries();
+    DatasetManager.switchToDatasetManagerView();
+
+    const stepsToCheckTwice = () => {
+      DatasetManager.startDatasetCreation();
+      DatasetManager.setNewDatasetName('canceledDataset');
+      DatasetManager.getDatasetCreationNextStep().click();
+      DatasetManager.selectNewDatasetSourceType('partially_prefilled_datasource');
+      DatasetManager.getConfirmDatasetCreation().should('be.disabled');
+      cy.get('[data-cy=text-input-etl_string_parameter]').type('{selectAll}{backspace}' + 'foo');
+      DatasetManager.getConfirmDatasetCreation().should('not.be.disabled');
+
+      DatasetManager.getNewDatasetSourceTypeSelect().click();
+      DatasetManager.getNewDatasetSourceTypeOptionFile().click();
+      DatasetManager.getConfirmDatasetCreation().should('be.disabled');
+
+      DatasetManager.selectNewDatasetSourceType('partially_prefilled_datasource');
+      DatasetManager.getConfirmDatasetCreation().should('not.be.disabled');
+
+      DatasetManager.getCancelDatasetCreation().click();
+      DatasetManager.getDatasetCreationDialog().should('not.exist');
+    };
+
+    stepsToCheckTwice();
+    stepsToCheckTwice();
+  });
+
+  it('correctly handles the form state even after closing and reopening the sub-dataset creation dialog', () => {
+    DatasetManager.ignoreDatasetTwingraphQueries();
+    DatasetManager.switchToDatasetManagerView();
+
+    const stepsToCheckTwice = () => {
+      DatasetManager.startSubdatasetCreation();
+      DatasetManager.getDatasetCreationNextStep().should('not.be.disabled');
+      DatasetManager.getCancelDatasetCreation().click();
+    };
+
+    stepsToCheckTwice();
+    stepsToCheckTwice();
+  });
 });
 
 describe('Dataset creation', () => {
@@ -296,7 +339,7 @@ describe('Refresh dataset', () => {
   after(stub.stop);
 
   it(
-    'can refresh ADT and AzureStorage datasets and display en empty dataset placeholder ' +
+    'can refresh ADT and AzureStorage datasets and display an empty dataset placeholder ' +
       'for the one created from scratch',
     () => {
       const refreshSuccessOptions = {
diff --git a/cypress/fixtures/stubbing/DatasetManager/solutions.js b/cypress/fixtures/stubbing/DatasetManager/solutions.js
@@ -17,20 +17,25 @@ export const SOLUTION = {
     {
       id: 'etl_enum_parameter',
       varType: 'enum',
-      enumValues: [
-        { key: 'option1', value: 'Option 1' },
-        { key: 'option2', value: 'Option 2' },
-      ],
+      options: {
+        enumValues: [
+          { key: 'option1', value: 'Option 1' },
+          { key: 'option2', value: 'Option 2' },
+        ],
+      },
     },
     {
       id: 'etl_list_parameter',
       varType: 'list',
-      enumValues: [
-        { key: 'option1', value: 'Option 1' },
-        { key: 'option2', value: 'Option 2' },
-      ],
+      options: {
+        enumValues: [
+          { key: 'option1', value: 'Option 1' },
+          { key: 'option2', value: 'Option 2' },
+        ],
+      },
     },
     { id: 'etl_string_parameter', varType: 'string' },
+    { id: 'etl_string_parameter_with_default_value', varType: 'string', defaultValue: 'is prefilled' },
     { id: 'etl_date_parameter', varType: 'date' },
   ],
   parameterGroups: [
@@ -39,6 +44,7 @@ export const SOLUTION = {
     { id: 'listGroup', parameters: ['etl_list_parameter'] },
     { id: 'stringGroup', parameters: ['etl_string_parameter'] },
     { id: 'dateGroup', parameters: ['etl_date_parameter'] },
+    { id: 'partiallyPrefilledGroup', parameters: ['etl_string_parameter', 'etl_string_parameter_with_default_value'] },
   ],
   runTemplates: [...DEFAULT_SOLUTION.runTemplates, ...CUSTOM_SUBDATASOURCES],
 };
@@ -70,14 +76,15 @@ export const SOLUTION_WITH_DYNAMIC_VALUES = {
 };
 
 export const SOLUTION_WITH_TRANSLATED_RUN_TEMPLATES = {
-  ...DEFAULT_SOLUTION,
+  ...SOLUTION,
   runTemplates: [
     ...DEFAULT_SOLUTION.runTemplates,
     {
       id: 'etl_run_template',
       labels: { en: 'ETL run template with dynamic filter', fr: 'Run template avec un filtre dynamique' },
       tags: ['datasource'],
     },
+    { id: 'partially_prefilled_datasource', parameterGroups: ['partiallyPrefilledGroup'], tags: ['datasource'] },
     {
       id: 'subdataset_run_template',
       labels: {
diff --git a/src/views/DatasetManager/components/CreateDatasetButton/components/DatasetCreationParameters/DatasetCreationParameters.js b/src/views/DatasetManager/components/CreateDatasetButton/components/DatasetCreationParameters/DatasetCreationParameters.js
@@ -1,6 +1,6 @@
 // Copyright (c) Cosmo Tech.
 // Licensed under the MIT license.
-import React, { useEffect, useMemo, useState } from 'react';
+import React, { useEffect, useMemo, useRef, useState } from 'react';
 import { Controller, useFormContext } from 'react-hook-form';
 import { useTranslation } from 'react-i18next';
 import PropTypes from 'prop-types';
@@ -18,7 +18,7 @@ const clone = rfdc();
 
 export const DatasetCreationParameters = ({ dataSourceRunTemplates, parentDataset, selectedRunner }) => {
   const { t } = useTranslation();
-  const { resetField } = useFormContext();
+  const { getValues, resetField } = useFormContext();
   const organizationId = useOrganizationId();
   const workspaceId = useWorkspaceId();
   const { datasourceParameterHelpers, getDataSourceTypeEnumValues, getUploadFileLabels, getDefaultFileTypeFilter } =
@@ -40,6 +40,7 @@ export const DatasetCreationParameters = ({ dataSourceRunTemplates, parentDatase
     if (dataSourceType == null) setDataSourceType(defaultDataSourceTypeKey);
   }, [dataSourceType, setDataSourceType, defaultDataSourceTypeKey]);
 
+  const defaultFormState = useRef({});
   const sourceParameters = useMemo(() => {
     const forgeParameterInput = (originalParameter) => {
       const parameterId = originalParameter.id;
@@ -70,6 +71,7 @@ export const DatasetCreationParameters = ({ dataSourceRunTemplates, parentDatase
         console.error(`VarType "${inputType}" is not supported for ETL runner parameters.`);
         return null;
       }
+      defaultFormState.current[fieldPath] = defaultValue;
 
       return (
         <Controller
@@ -155,6 +157,7 @@ export const DatasetCreationParameters = ({ dataSourceRunTemplates, parentDatase
     };
 
     const runTemplate = dataSourceRunTemplates[dataSourceType];
+    defaultFormState.current = {};
     return runTemplate?.parameters?.map((parameter) => forgeParameterInput(parameter));
   }, [
     organizationId,
@@ -169,6 +172,25 @@ export const DatasetCreationParameters = ({ dataSourceRunTemplates, parentDatase
     getDefaultFileTypeFilter,
   ]);
 
+  useEffect(() => {
+    // Do not reset form when updating an existing dataset (already done in a useEffect in UpdateDatasetDialog)
+    if (isDatasetParametersEditionDialog) return;
+
+    const formValues = getValues();
+    for (const [sourceType, parameters] of Object.entries(formValues)) {
+      // Ignore fields that are not source types
+      if (['name', 'tags', 'description', 'sourceType'].includes(sourceType)) continue;
+      for (const [parameterId, parameterValue] of Object.entries(parameters)) {
+        const escapedSourceType = SolutionsUtils.escapeRunTemplateId(sourceType);
+        const fieldPath = `${escapedSourceType}.${parameterId}`;
+        defaultFormState.current[fieldPath] = parameterValue;
+      }
+    }
+    for (const [key, defaultValue] of Object.entries(defaultFormState.current)) {
+      resetField(key, { defaultValue });
+    }
+  }, [getValues, isDatasetParametersEditionDialog, resetField, sourceParameters]);
+
   const labels = useMemo(() => {
     return isSubDatasetCreationWizard
       ? {
diff --git a/src/views/DatasetManager/components/CreateDatasetButton/components/DatasetWizard/DatasetWizard.js b/src/views/DatasetManager/components/CreateDatasetButton/components/DatasetWizard/DatasetWizard.js
@@ -28,13 +28,6 @@ export const DatasetWizard = ({ open, closeDialog, onConfirm, dataSourceRunTempl
   const { formState } = methods;
   const [activeStep, setActiveStep] = useState(0);
 
-  useEffect(() => {
-    if (open) {
-      methods.reset();
-      setActiveStep(0);
-    }
-  }, [open, methods, setActiveStep]);
-
   const confirm = (event) => {
     const values = methods.getValues();
     onConfirm(values);
@@ -62,6 +55,13 @@ export const DatasetWizard = ({ open, closeDialog, onConfirm, dataSourceRunTempl
     return `${parentDataset?.name} (subdataset)`;
   }, [parentDataset?.name, isSubDatasetCreationWizard]);
 
+  useEffect(() => {
+    if (open) {
+      methods.reset({ name: defaultName });
+      setActiveStep(0);
+    }
+  }, [defaultName, open, methods, setActiveStep]);
+
   const firstStep = (
     <>
       <Grid item xs={12}>
