feat: [PROD-14182] get all runners after workspace selection and update runner parameters

esasova · esasova · commit 96a9c2fecbfb · 2025-02-28T17:07:07.000+01:00
diff --git a/public/locales/en/translation.json b/public/locales/en/translation.json
@@ -532,9 +532,11 @@
       "datasetNotUpdated": "Dataset hasn't been updated",
       "datasetNotRefreshed": "A problem occurred during dataset refresh",
       "datasetRefreshError": "A problem occurred during refresh of the dataset {{datasetId}}",
+      "getAllRunnersError": "Unexpected error while loading runners",
       "runnerNotCreated": "Runner hasn't been created",
       "runnerFileNotUploaded": "Runner file {runnerFile} hasn't been uploaded",
       "runnerStopError": "Could not stop runner {{runnerId}}",
+      "runnerUpdateError": "Runner hasn't been updated",
       "datasetSecurityNotUpdated": "Dataset {{datasetId}} permissions have not been updated",
       "runnerNotUpdated": "Runner hasn't been updated",
       "twingraphNotCreated": "A problem occurred during twingraph creation",
diff --git a/public/locales/fr/translation.json b/public/locales/fr/translation.json
@@ -532,9 +532,11 @@
       "datasetNotUpdated": "Le dataset n'a pas pu être mis à jour",
       "datasetNotRefreshed": "Une erreur est survenue pendant la mise à jour du dataset",
       "datasetRefreshError": "Une erreur est survenue pendant la mise à jour du dataset {{datasetId}}",
+      "getAllRunnersError": "Une erreur est survenue lors de la récupération des runners.",
       "runnerNotCreated": "Le runner n'a pas pu être crée",
       "runnerFileNotUploaded": "Echec de l'envoi du fichier de runner {{runnerFile}}",
       "runnerStopError": "Impossible d'arrêter le runner {{runnerId}}",
+      "runnerUpdateError": "Les paramètres du runner n'ont pas pu être mis à jour",
       "datasetSecurityNotUpdated": "Les permissions du dataset {{datasetId}} n'ont pas pu être modifiées",
       "runnerNotUpdated": "Le runner n'a pas pu être mis à jour",
       "twingraphNotCreated": "Une erreur est survenue pendant la creation du twingraph",
diff --git a/src/services/config/FunctionalConstants.js b/src/services/config/FunctionalConstants.js
@@ -20,3 +20,6 @@ export const TWINGRAPH_QUERY_RETRY_DELAY = 500; // Delay between retrying when a
 
 // Type of logs to download for a scenario run (SIMPLE_LOGS or CUMULATED_LOGS)
 export const SCENARIO_RUN_LOG_TYPE = 'CUMULATED_LOGS';
+
+// Size of a page of runners returned by back-end
+export const RUNNERS_PAGE_COUNT = 5000;
diff --git a/src/state/commons/RunnerConstants.js b/src/state/commons/RunnerConstants.js
@@ -4,4 +4,9 @@
 export const RUNNER_ACTIONS_KEY = {
   TRIGGER_SAGA_CREATE_RUNNER: 'TRIGGER_SAGA_CREATE_RUNNER',
   TRIGGER_SAGA_STOP_RUNNER: 'TRIGGER_SAGA_STOP_RUNNER',
+  TRIGGER_SAGA_GET_RUNNERS: 'TRIGGER_SAGA_GET_RUNNERS',
+  SET_ETL_RUNNERS: 'SET_ETL_RUNNERS',
+  TRIGGER_SAGA_UPDATE_RUNNER: 'TRIGGER_SAGA_UPDATE_RUNNER',
+  ADD_ETL_RUNNER: 'ADD_ETL_RUNNER',
+  UPDATE_ETL_RUNNER: 'UPDATE_ETL_RUNNER',
 };
diff --git a/src/state/dispatchers/runner/RunnerDispatcher.js b/src/state/dispatchers/runner/RunnerDispatcher.js
@@ -15,3 +15,12 @@ export const dispatchStopRunner = (organizationId, workspaceId, datasetId) => ({
   workspaceId,
   datasetId,
 });
+
+export const dispatchUpdateRunner = (organizationId, workspaceId, runnerId, datasetId, runnerPatch) => ({
+  type: RUNNER_ACTIONS_KEY.TRIGGER_SAGA_UPDATE_RUNNER,
+  organizationId,
+  workspaceId,
+  runnerId,
+  datasetId,
+  runnerPatch,
+});
diff --git a/src/state/hooks/RunnerHooks.js b/src/state/hooks/RunnerHooks.js
@@ -1,8 +1,8 @@
 // Copyright (c) Cosmo Tech.
 // Licensed under the MIT license.
 import { useCallback } from 'react';
-import { useDispatch } from 'react-redux';
-import { dispatchCreateRunner, dispatchStopRunner } from '../dispatchers/runner/RunnerDispatcher';
+import { useDispatch, useSelector } from 'react-redux';
+import { dispatchCreateRunner, dispatchStopRunner, dispatchUpdateRunner } from '../dispatchers/runner/RunnerDispatcher';
 import { useOrganizationId } from './OrganizationHooks';
 import { useWorkspaceId } from './WorkspaceHooks';
 
@@ -25,3 +25,18 @@ export const useStopRunner = () => {
     [dispatch, organizationId, workspaceId]
   );
 };
+
+export const useGetETLRunners = () => {
+  return useSelector((state) => state.runner.etlRunners);
+};
+
+export const useUpdateRunner = () => {
+  const organizationId = useOrganizationId();
+  const workspaceId = useWorkspaceId();
+  const dispatch = useDispatch();
+  return useCallback(
+    (runnerId, datasetId, runnerPatch) =>
+      dispatch(dispatchUpdateRunner(organizationId, workspaceId, runnerId, datasetId, runnerPatch)),
+    [dispatch, organizationId, workspaceId]
+  );
+};
diff --git a/src/state/reducers/rootReducer.js b/src/state/reducers/rootReducer.js
@@ -8,6 +8,7 @@ import { datasetsReducer } from './dataset/DatasetsReducer';
 import { datasetTwingraphQueriesResultsReducer } from './datasetTwingraphQueriesResults/DatasetTwingraphQueriesResultsReducer';
 import { organizationReducer } from './organization/OrganizationReducer';
 import { powerBiReducer } from './powerbi/PowerBIReducer';
+import { runnerReducer } from './runner/RunnerReducer';
 import { scenarioReducer } from './scenario/ScenarioReducer';
 import { scenarioRunReducer } from './scenariorun/ScenarioRunReducer';
 import { solutionReducer } from './solution/SolutionReducer';
@@ -24,6 +25,7 @@ const rootReducer = combineReducers({
   organization: organizationReducer,
   solution: solutionReducer,
   powerBI: powerBiReducer,
+  runner: runnerReducer,
 });
 
 export default rootReducer;
diff --git a/src/state/reducers/runner/RunnerReducer.js b/src/state/reducers/runner/RunnerReducer.js
@@ -0,0 +1,30 @@
+// Copyright (c) Cosmo Tech.
+// Licensed under the MIT license.
+import { createReducer } from '@reduxjs/toolkit';
+import { RUNNER_ACTIONS_KEY } from '../../commons/RunnerConstants';
+
+const initialState = {
+  etlRunners: [],
+};
+
+export const runnerReducer = createReducer(initialState, (builder) => {
+  builder
+    .addCase(RUNNER_ACTIONS_KEY.SET_ETL_RUNNERS, (state, action) => {
+      state.etlRunners = action.data;
+    })
+    .addCase(RUNNER_ACTIONS_KEY.UPDATE_ETL_RUNNER, (state, action) => {
+      const runnerId = action.runnerId;
+      const runner = action.runner;
+      if (runner)
+        state.etlRunners = state.etlRunners?.map((runnerData) => {
+          if (runnerData.id === runnerId) {
+            return { ...runnerData, ...runner };
+          }
+          return runnerData;
+        });
+    })
+    .addCase(RUNNER_ACTIONS_KEY.ADD_ETL_RUNNER, (state, action) => {
+      const runner = action.runner;
+      state.etlRunners.push(runner);
+    });
+});
diff --git a/src/state/sagas/runner/CreateRunner/CreateRunner.js b/src/state/sagas/runner/CreateRunner/CreateRunner.js
@@ -35,9 +35,17 @@ function* uploadFileParameter(parameter, organizationId, workspaceId) {
     const newConnector = DatasetsUtils.buildAzureStorageConnector(connectorId, storageFilePath);
 
     const updatedDatasetPart = { ...datasetPart, connector: newConnector };
-    yield call(Api.Datasets.updateDataset, organizationId, datasetId, updatedDatasetPart);
+    const { data: updatedDataset } = yield call(
+      Api.Datasets.updateDataset,
+      organizationId,
+      datasetId,
+      updatedDatasetPart
+    );
     yield call(Api.Workspaces.uploadWorkspaceFile, organizationId, workspaceId, file, true, storageFilePath);
-
+    yield put({
+      type: DATASET_ACTIONS_KEY.ADD_DATASET,
+      ...updatedDataset,
+    });
     return datasetId;
   } catch (error) {
     console.error(error);
@@ -94,8 +102,17 @@ export function* createRunner(action) {
     if (runner.datasetList != null) datasetList = datasetList.concat(runner.datasetList);
 
     const patchedRunner = { runTemplateId: runner.runTemplateId, datasetList };
-    yield call(Api.Runners.updateRunner, organizationId, workspaceId, runnerId, patchedRunner);
-
+    const { data: updatedRunner } = yield call(
+      Api.Runners.updateRunner,
+      organizationId,
+      workspaceId,
+      runnerId,
+      patchedRunner
+    );
+    yield put({
+      type: RUNNER_ACTIONS_KEY.ADD_ETL_RUNNER,
+      runner: { ...updatedRunner, parametersValues: ApiUtils.formatParametersFromApi(updatedRunner.parametersValues) },
+    });
     yield put({ type: DATASET_ACTIONS_KEY.TRIGGER_SAGA_REFRESH_DATASET, organizationId, datasetId });
   } catch (error) {
     console.error(error);
diff --git a/src/state/sagas/runner/GetAllRunners/GetAllRunners.js b/src/state/sagas/runner/GetAllRunners/GetAllRunners.js
@@ -0,0 +1,57 @@
+// Copyright (c) Cosmo Tech.
+// Licensed under the MIT license.
+import { t } from 'i18next';
+import { takeEvery, call, put, select } from 'redux-saga/effects';
+import { Api } from '../../../../services/config/Api';
+import { RUNNERS_PAGE_COUNT } from '../../../../services/config/FunctionalConstants';
+import { ApiUtils } from '../../../../utils';
+import { RUNNER_ACTIONS_KEY } from '../../../commons/RunnerConstants';
+import { dispatchSetApplicationErrorMessage } from '../../../dispatchers/app/ApplicationDispatcher';
+
+const getDatasets = (state) => state?.dataset.list?.data;
+const getCurrentWorkspace = (state) => state?.workspace?.current?.data;
+
+export function* getAllRunners(organizationId) {
+  const datasets = yield select(getDatasets);
+  const selectedWorkspace = yield select(getCurrentWorkspace);
+
+  try {
+    const { data: runnersList } = yield call(
+      Api.Runners.listRunners,
+      organizationId,
+      selectedWorkspace?.id,
+      0,
+      RUNNERS_PAGE_COUNT
+    );
+    const etlAssociatedRunnersIds = datasets
+      .filter(
+        (dataset) =>
+          dataset.main === true &&
+          dataset.sourceType === 'ETL' &&
+          selectedWorkspace?.linkedDatasetIdList?.includes(dataset.id)
+      )
+      .map((dataset) => dataset.source?.name);
+
+    const etlAssociatedRunners = runnersList.filter((runner) => etlAssociatedRunnersIds.includes(runner.id));
+    etlAssociatedRunners.forEach((runner) => {
+      runner.parametersValues = ApiUtils.formatParametersFromApi(runner.parametersValues);
+    });
+    yield put({
+      type: RUNNER_ACTIONS_KEY.SET_ETL_RUNNERS,
+      data: etlAssociatedRunners,
+    });
+  } catch (error) {
+    console.error(error);
+    yield put(
+      dispatchSetApplicationErrorMessage(
+        error,
+        t('commoncomponents.banner.getAllRunnersError', 'Unexpected error while loading runners')
+      )
+    );
+  }
+}
+
+function* getAllRunnersData() {
+  yield takeEvery(RUNNER_ACTIONS_KEY.TRIGGER_SAGA_GET_RUNNERS, getAllRunners);
+}
+export default getAllRunnersData;
diff --git a/src/state/sagas/runner/GetAllRunners/index.js b/src/state/sagas/runner/GetAllRunners/index.js
@@ -0,0 +1,4 @@
+// Copyright (c) Cosmo Tech.
+// Licensed under the MIT license.
+
+export { default as getAllRunnersSaga } from './GetAllRunners';
diff --git a/src/state/sagas/runner/UpdateRunner/UpdateRunner.js b/src/state/sagas/runner/UpdateRunner/UpdateRunner.js
@@ -0,0 +1,101 @@
+// Copyright (c) Cosmo Tech.
+// Licensed under the MIT license.
+import { t } from 'i18next';
+import { call, put, takeEvery } from 'redux-saga/effects';
+import { UPLOAD_FILE_STATUS_KEY } from '@cosmotech/ui';
+import { Api } from '../../../../services/config/Api';
+import { ApiUtils, DatasetsUtils } from '../../../../utils';
+import { DATASET_ACTIONS_KEY } from '../../../commons/DatasetConstants';
+import { RUNNER_ACTIONS_KEY } from '../../../commons/RunnerConstants';
+import { dispatchSetApplicationErrorMessage } from '../../../dispatchers/app/ApplicationDispatcher';
+
+function* uploadFileParameter(parameter, organizationId, workspaceId) {
+  try {
+    const connectorId = parameter.connectorId;
+    const file = parameter.value.file;
+    const parameterId = parameter.parameterId;
+
+    if (!connectorId) {
+      throw new Error(`Missing connector id in configuration file for scenario parameter ${parameterId}`);
+    }
+    const datasetPart = {
+      name: parameterId,
+      description: parameter.description,
+      connector: { id: connectorId },
+      tags: ['dataset_part'],
+      main: false,
+    };
+    const { data } = yield call(Api.Datasets.createDataset, organizationId, datasetPart);
+
+    const datasetId = data.id;
+
+    const storageFilePath = DatasetsUtils.buildStorageFilePath(datasetId, file.name);
+    const newConnector = DatasetsUtils.buildAzureStorageConnector(connectorId, storageFilePath);
+
+    const updatedDatasetPart = { ...datasetPart, connector: newConnector };
+    const { data: updatedDataset } = yield call(
+      Api.Datasets.updateDataset,
+      organizationId,
+      datasetId,
+      updatedDatasetPart
+    );
+    yield call(Api.Workspaces.uploadWorkspaceFile, organizationId, workspaceId, file, true, storageFilePath);
+    yield put({
+      type: DATASET_ACTIONS_KEY.ADD_DATASET,
+      ...updatedDataset,
+    });
+
+    return datasetId;
+  } catch (error) {
+    console.error(error);
+    yield put(
+      dispatchSetApplicationErrorMessage(
+        error,
+        t('commoncomponents.banner.runnerFileNotUploaded', `Runner file {runnerFile} hasn't been uploaded`, {
+          runnerFile: parameter.value.file,
+        })
+      )
+    );
+    throw new Error(error);
+  }
+}
+
+export function* updateRunner(action) {
+  try {
+    const runnerPatch = action.runnerPatch;
+    const organizationId = action.organizationId;
+    const workspaceId = action.workspaceId;
+    const runnerId = action.runnerId;
+    const datasetId = action.datasetId;
+    for (const parameter of runnerPatch.parametersValues) {
+      if (parameter.varType === '%DATASETID%') {
+        if (parameter.value.status === UPLOAD_FILE_STATUS_KEY.READY_TO_UPLOAD)
+          parameter.value = yield call(uploadFileParameter, parameter, organizationId, workspaceId);
+        else if (parameter.value.status === UPLOAD_FILE_STATUS_KEY.READY_TO_DOWNLOAD)
+          parameter.value = parameter.value.id;
+      }
+    }
+    const runnerDataToUpdate = runnerPatch.parametersValues
+      ? { ...runnerPatch, ...ApiUtils.formatParametersForApi(runnerPatch.parametersValues) }
+      : runnerPatch;
+    const { data } = yield call(Api.Runners.updateRunner, organizationId, workspaceId, runnerId, runnerDataToUpdate);
+    yield put({
+      type: RUNNER_ACTIONS_KEY.UPDATE_ETL_RUNNER,
+      runnerId,
+      runner: { ...data, parametersValues: ApiUtils.formatParametersFromApi(data.parametersValues) },
+    });
+    yield put({ type: DATASET_ACTIONS_KEY.TRIGGER_SAGA_REFRESH_DATASET, organizationId, datasetId });
+  } catch (error) {
+    console.error(error);
+    yield put(
+      dispatchSetApplicationErrorMessage(
+        error,
+        t('commoncomponents.banner.runnerUpdateError', "Runner hasn't been updated")
+      )
+    );
+  }
+}
+function* updateRunnerData() {
+  yield takeEvery(RUNNER_ACTIONS_KEY.TRIGGER_SAGA_UPDATE_RUNNER, updateRunner);
+}
+export default updateRunnerData;
diff --git a/src/state/sagas/runner/UpdateRunner/index.js b/src/state/sagas/runner/UpdateRunner/index.js
@@ -0,0 +1,4 @@
+// Copyright (c) Cosmo Tech.
+// Licensed under the MIT license.
+
+export { default as updateRunnerSaga } from './UpdateRunner';
diff --git a/src/state/sagas/runner/index.js b/src/state/sagas/runner/index.js
@@ -1,7 +1,9 @@
 import { all, fork } from 'redux-saga/effects';
 import { createRunnerSaga } from './CreateRunner';
+import { getAllRunnersSaga } from './GetAllRunners';
 import { stopRunnerSaga } from './StopRunner';
+import { updateRunnerSaga } from './UpdateRunner';
 
 export default function* runnerSaga() {
-  yield all([fork(createRunnerSaga), fork(stopRunnerSaga)]);
+  yield all([fork(createRunnerSaga), fork(stopRunnerSaga), fork(getAllRunnersSaga), fork(updateRunnerSaga)]);
 }
diff --git a/src/state/sagas/workspace/SelectWorkspace/SelectWorkspace.js b/src/state/sagas/workspace/SelectWorkspace/SelectWorkspace.js
@@ -13,6 +13,7 @@ import { SCENARIO_ACTIONS_KEY } from '../../../commons/ScenarioConstants';
 import { WORKSPACE_ACTIONS_KEY } from '../../../commons/WorkspaceConstants';
 import { dispatchSetApplicationErrorMessage } from '../../../dispatchers/app/ApplicationDispatcher';
 import { dispatchGetPowerBIEmbedInfo } from '../../../dispatchers/powerbi/PowerBIDispatcher';
+import { getAllRunners } from '../../runner/GetAllRunners/GetAllRunners';
 import { getAllScenariosData } from '../../scenario/FindAllScenarios/FindAllScenariosData';
 import { fetchSolutionByIdData } from '../../solution/FindSolutionById/FindSolutionByIdData';
 
@@ -81,6 +82,8 @@ export function* selectWorkspace(action) {
   const solutionId = yield select(selectSolutionIdFromCurrentWorkspace);
   yield call(fetchSolutionByIdData, organizationId, solutionId);
 
+  yield call(getAllRunners, organizationId);
+
   yield call(getAllScenariosData, organizationId, selectedWorkspaceId);
   const scenarioList = yield select(selectScenarioList);
 
