43662 - Added error handling hook to StopAreaDetailsEdit #931

villepynttari · 2024-10-17T11:26:51Z

Testing:

Go to: //stop-registry/stop-areas/HSL:GroupOfStopPlaces:2?observationDate=2024-10-16
Change label and name values to existing values ( for example these - Go to: //stop-registry/stop-areas/HSL:GroupOfStopPlaces:1?observationDate=2024-10-16)
Should print errors with correct texts

This change is

Huulivoide

Reviewed 6 of 7 files at r1.
Reviewable status: 6 of 7 files reviewed, 6 unresolved discussions (waiting on @villepynttari)

ui/src/components/forms/stop-area/util/stopAreaDetailsErrorHandler.ts line 7 at r1 (raw file):

import { StopAreaFormState } from '../stopAreaFormSchema';

const ERRORS: Readonly<Map<string, string>> = new Map([

Map luokan sijaan vois käyttää ihan vaan objektia. Ja en oo nyt vielä koko tietostoa lukenut, mutta oletan että tässä on Virhekoodi⋄käännösavain mäppäys → Käännös avain pitäs tyypittää oleen semmonen.
tyyppi TranslationKey ui/src/i18n.ts tiedostosta

ui/src/components/forms/stop-area/util/stopAreaDetailsErrorHandler.ts line 24 at r1 (raw file):

  const tryHandle = useCallback(
    (error: ApolloError, details?: StopAreaFormState): boolean => {
      const errorNames = Array.from(ERRORS.keys());

Tässä on mun mielestä tarpeettomasti looppausta, kun tän sais tehtyy myös toisinkin päin. Et etitään virheen potentiaalistta errorCodea tunnettujen listasta, sen sijaan että katotaan onko virheessä yhtään tunnettia koodia asetettuna.

ui/src/components/forms/stop-area/util/stopAreaDetailsErrorHandler.ts line 33 at r1 (raw file):

        const knownErrorKey = ERRORS.get(knownError);
        if (knownErrorKey) {
          if (details) {

Tää on tarpeeton. Koska toi on TFunktiolla optionaalinen argumentti, niin siellä on jo sisällä käsittely tilanteellee että toka argumentti on undefined.

ui/src/components/forms/stop-area/util/stopAreaDetailsErrorHandler.ts line 45 at r1 (raw file):

    [t],
  );
  return { tryHandle };

Tarpeeton objekti wräppäys. Suoraan vaan funktio ulos.

ui/src/components/forms/stop-area/util/stopAreaDetailsErrorHandler.ts line 46 at r1 (raw file):

  );
  return { tryHandle };
}

Ite sain muodon:

import { ApolloError } from '@apollo/client';
import get from 'lodash/get';
import { useCallback } from 'react';
import { useTranslation } from 'react-i18next';
import { TranslationKey } from '../../../../i18n';
import { showDangerToast } from '../../../../utils';
import { StopAreaFormState } from '../stopAreaFormSchema';

const ERRORS: Readonly<Record<string, TranslationKey>> = {
  GROUP_OF_STOP_PLACES_UNIQUE_NAME:
    'stopAreaDetails.errors.groupOfStopPlacesUniqueName',

  GROUP_OF_STOP_PLACES_UNIQUE_DESCRIPTION:
    'stopAreaDetails.errors.groupOfStopPlacesUniqueDescription',
};

function mapApolloErrorToTranslationKey(
  error: ApolloError,
): TranslationKey | null {
  const errorCode: unknown = get(error, ['cause', 'extensions', 'errorCode']);
  if (typeof errorCode === 'string' && errorCode in ERRORS) {
    return ERRORS[errorCode];
  }

  return null;
}

export function useStopAreaDetailsApolloErrorHandler() {
  const { t } = useTranslation();

  return useCallback(
    (error: ApolloError, details?: StopAreaFormState): boolean => {
      const translationKey = mapApolloErrorToTranslationKey(error);

      if (translationKey) {
        showDangerToast(t(translationKey, details));
        return true;
      }

      return false;
    },
    [t],
  );
}

ui/src/components/forms/stop-area/util/stopAreaDetailsErrorHandler.spec.ts line 1 at r1 (raw file):

import { ApolloError } from '@apollo/client';

Tälle pitäs olla olemassa oikee E2E testi, ja sen jälkeen tää yksikkö testi jää tarpeettomaks.
Koska Tiamatin pään muutoksetkin voi tän toiminnalisuuden rikkoa, ku sieltä ne virheet loppupeleissä tulee.

villepynttari · 2024-10-18T04:12:20Z

ui/src/components/forms/stop-area/util/stopAreaDetailsErrorHandler.ts line 46 at r1 (raw file):