Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

front: rename and refacto StdcmInputVia #10218

Open
wants to merge 3 commits into
base: dev
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view

This file was deleted.

20 changes: 4 additions & 16 deletions front/src/applications/stdcm/components/StdcmForm/StdcmVias.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ import { useAppDispatch } from 'store';

import StdcmCard from './StdcmCard';
import StdcmDefaultCard from './StdcmDefaultCard';
import StdcmInputVia from './StdcmInputVia';
import StdcmOperationalPoint from './StdcmOperationalPoint';
import StdcmStopType from './StdcmStopType';
import StopDurationInput from './StopDurationInput';
import { StdcmStopTypes } from '../../types';
import type { StdcmConfigCardProps } from '../../types';

Expand Down Expand Up @@ -84,16 +84,6 @@ const StdcmVias = ({ disabled = false }: StdcmConfigCardProps) => {
};
}, [newIntermediateOpIndex]);

const updateStopDuration = (stopTime: string, pathStep: StdcmPathStep) => {
const stopFor = stopTime ? Number(stopTime) : undefined;
dispatch(
updateStdcmPathStep({
id: pathStep.id,
updates: { stopFor },
})
);
};

const deleteViaOnClick = (pathStepId: string) => {
dispatch(deleteStdcmVia(pathStepId));
};
Expand Down Expand Up @@ -147,11 +137,9 @@ const StdcmVias = ({ disabled = false }: StdcmConfigCardProps) => {
stopTypes={pathStep.stopType}
updatePathStepStopType={(newStopType) => updateStopType(newStopType, pathStep)}
/>
<StdcmInputVia
stopType={pathStep.stopType}
stopDuration={pathStep.stopFor}
updatePathStepStopTime={(e) => updateStopDuration(e, pathStep)}
/>
{pathStep.stopType !== StdcmStopTypes.PASSAGE_TIME && (
<StopDurationInput pathStep={pathStep} />
)}
</StdcmCard>
</div>
);
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
import { useMemo, useEffect, useState } from 'react';

import { Input } from '@osrd-project/ui-core';
import type { Status } from '@osrd-project/ui-core/dist/components/inputs/StatusMessage';
import { useTranslation } from 'react-i18next';

import { useOsrdConfActions } from 'common/osrdContext';
import type { StdcmConfSliceActions } from 'reducers/osrdconf/stdcmConf';
import type { StdcmPathStep } from 'reducers/osrdconf/types';
import { useAppDispatch } from 'store';
import { useDebounce } from 'utils/helpers';

import { StdcmStopTypes } from '../../types';

type StopDurationInputProps = {
pathStep: Extract<StdcmPathStep, { isVia: true }>;
};

const StopDurationInput = ({ pathStep }: StopDurationInputProps) => {
const dispatch = useAppDispatch();
const { t } = useTranslation('stdcm');

const { updateStdcmPathStep } = useOsrdConfActions() as StdcmConfSliceActions;

const [stopDuration, setStopDuration] = useState('');
const debouncedStopDuration = useDebounce(stopDuration, 300);

const stopWarning = useMemo(
() =>
pathStep.stopType === StdcmStopTypes.DRIVER_SWITCH &&
pathStep.stopFor !== undefined &&
pathStep.stopFor < 3
? {
status: 'warning' as Status,
message: t('trainPath.warningMinStopTime'),
}
: undefined,
[pathStep.stopType, pathStep.stopFor]
);
useEffect(() => {
setStopDuration(pathStep.stopFor !== undefined ? `${pathStep.stopFor}` : '');
}, [pathStep.stopFor]);

useEffect(() => {
const newStopDuration = debouncedStopDuration ? Number(debouncedStopDuration) : undefined;
if (newStopDuration !== pathStep.stopFor) {
dispatch(
updateStdcmPathStep({
id: pathStep.id,
updates: { stopFor: newStopDuration },
})
);
}
}, [debouncedStopDuration]);

return (
<div className="stop-time">
<Input
id="stdcm-via-stop-time"
type="text"
label={t('trainPath.stopFor')}
onChange={(e) => {
// TODO: Find a better way to prevent user from entering decimal values
const value = e.target.value.replace(/[\D.,]/g, '');
setStopDuration(value);
}}
Comment on lines +62 to +66
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe it would be better to don't automatically replace value with a regex and warn the user that the value can't be used.
Because if I put 3.5, it compute 35 and if i don't pay attention, i will launch the simulation using a 35 minutes stop

Copy link
Contributor

@Math-R Math-R Jan 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So you can make a handleChange function, that will turn a flag and display a warning if the value don't respect the expexted value

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another solution would be to round up or down the value to keep minutes only, but this need to be discuss

Copy link
Contributor Author

@clarani clarani Jan 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This portion of code is not related to my PR, can we discuss this later ? :/
We won't forget it since there is already a TODO comment above the problematic lines

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Following Mathieu's invitation, here is my user experience comment. This behaviour is problematic as the change is difficult to spot (a little larger letter spacing and a dot) and could affect results.
That said, we haven't witnessed users entering decimal values during our tests.
As there would be no way for us to know if users get this problem or not, I'm inviting POs to prioritize the issue as high, especially since we currently don't have the possibility to cancel computations.

value={stopDuration}
trailingContent="minutes"
statusWithMessage={stopWarning}
/>
</div>
);
};

export default StopDurationInput;
Loading