Messaggi di errore non definiti

ncarandini commented 5 years ago

Implementando la soluzione della issue #33 mi sono accorto che la gestione degli errori è frammentata in più parti:

Gli errori che possono capitare nelle chiamate ai servizi necessarie per le operazioni di Registrazione e Login.
Gli errori che possono essere restituiti direttamente dai servizi che restituiscono un errorcode (come ad esempio .../aggiornaBeneficiarioBySPID o \beneficiario) per i quali mi sono già stati dati i messaggi di errore, peraltro legati alla specifica annualità per la quale l'app viene attualmente creata.
L'errore che può essere restituito direttamente da un servizio che restituisce un valore booleano (come nel caso del flagOperativo restituito dalla chiamata al servizio /beneficiarioOperativo).
Gli errori che possono capitare nelle chiamate ai servizi nelle situazioni che non rientrano tra quelle descritte nei precedenti punti.

Quindi abbiamo due criticità: 1) Testo che va modificato di anno in anno. 2) Testo contenuto nel codice.

Il punto 1 non preoccupa, poiché in più occasioni (FAQ, Testo HTML relativo all'accettazione della privacy, ecc.) abbiamo deciso che è possibile utilizzare informazioni hard-coded sempreché siano immutabili per l'anno d'uso dell'app, il che corrisponde al fatto che l'app deve necessariamente essere modificata e ripubblicata per ogni nuovo anno di validità del bonus 18App. La soluzione è quella di centralizzare (ove possibile) tutte le info che potrebbero richiedere un aggiornamento di anno in anno nella cartella Data, e comunque di documentare in modo esaustivo tutti i punti dell'app che richiedono tale manutenzione annua.

Il punto 2 invece è essenziale e si risolve estrapolando tutte le informazioni in un file a parte che ho chiamato ErrorMessages.cs e che per quanto detto relativamente al punto precedente ho inserito nella cartella Data.

Ciò ci porta al nocciolo di questa issue, ovvero la necessità di definire i testi degli errori. Per quanto riguarda gli errori di login, la realizzazione della funzionalità ha portato ad identificare i seguenti possibili errori:

Errori generici di chiamata al servizio:

public enum ServiceFailureReason
{
    Unknown,
    Forbidden,
    JsonConvertionError,
    InternalServerError
}

Da notare che è stato inserito anche un errore di frontend relativo alla mancata conversione Json --> DTO (Data Transfer Object) della risposta fornita dal servizio.

Errori relativi all'ErrorCode restituito dalla chiamata al servizio che ne fanno uso:

Per questi errori non è stato creato alcun enumeratore visto che sono già definiti dal valore intero riportato dall'error code.

Errori relativi alle chiamate che fanno uso di un valore booleano per comunicare l'eventuale insuccesso della chiamata

Anche per questo caso, non è stato creato alcun enumeratore visto che vi è un solo possibile caso di insuccesso.

Errori relativi alle operazioni di Registrazione / Login

public enum LoginFailureReason
{
    UnsuccessfulHttpStatusCode,
    RegistrationTimeEnded,
    NonOperatingBeneficiary,
    RegistrationCheckFailed,
    UnavailableBeneficiary,
    UnavailableWallet,
    Unknown
}

Sulla scorta di questa casistica, ho provveduto a definire una serie di costanti nel suddetto file ErroMessages.cs:

Messaggi generici di chiamata al servizio:

UNKNOWN: "Si è verificato un errore: il servizio non è disponibile."
FORBIDDEN: "Si è verificato un errore di accesso: il servizio non è disponibile."
JSON_CONVERTION_ERROR: "Si è verificato un errore di conversione dati: il servizio non è disponibile."
INTERNAL_SERVER_ERROR: "Si è verificato un errore sul server: il servizio non è disponibile."

Messaggi relativi all'ErrorCode

ERROR_CODE_0: "Operazione andata a buon fine.";
ERROR_CODE_1: "Ci dispiace ma quest'anno il bonus per i diciottenni è riservato solo ai nati nel 2000. Se pensi di averne diritto, e pensi ci sia stato un errore relativo ai tuoi dati anagrafici, puoi rivolgerti al tuo Comune di residenza.";
ERROR_CODE_2: "Ci dispiace, ma è esaurito il Plafond a disposizione.";
ERROR_CODE_3: "Attenzione, il tuo borsellino non è ancora attivo.";
ERROR_CODE_4: "Attenzione, se sei del 1998, il periodo per registrarti a 18app è scaduto il 30 giugno 2017. Se sei del 1999, il periodo per registrarti è terminato il 30 giugno 2018. Se sei del 2001, la procedura di registrazione non è ancora attiva.";
ERROR_CODE_5: "Ci dispiace, ma il periodo per poter accedere a 18app è terminato il 31 marzo 2018.";

Messaggi relativi alle chiamate che fanno uso di un valore booleano (escluse quelle relative alle operazioni di Registrazone / Login)

SET_PRIVACY_FAILURE: "Siamo spiacenti ma non è stato possibile registrare l'accettazione delle condizioni di privacy dell'app."

Messaggi relativi alle operazioni di Registrazione / Login

UNSUCCESSFUL_HTTP_STATUS_CODE: "Si è verificato un errore: il servizio non è disponibile."
REGISTRATION_TIME_ENDED: "Ci dispiace, ma il periodo per poter accedere a 18app è terminato il 31 marzo 2018."
NON_OPERATING_BENEFICIARY: testo da definire
REGISTRATION_CHECK_FAILED: testo da definire
UNAVAILABLE_BENEFICIARY: testo da definire
UNAVAILABLE_WALLET: testo da definire
UNKNOWN: "Si è verificato un errore: il servizio non è disponibile.";

Testi da definire per completare l'issue:

NON_OPERATING_BENEFICIARY

Questa costante di testo viene utilizzata quando la chiamata a /beneficiarioOperativo restituisce false e il risultato dell'operazione viene impostato a NonOperatingBeneficiary.

REGISTRATION_CHECK_FAILED

Questa costante di testo viene utilizzata quando la chiamata a /verificaPeriodoRegistrazioneBeneficiario restituisce false e il risultato dell'operazione viene impostato a RegistrationCheckFailed.

UNAVAILABLE_BENEFICIARY

Questa costante di testo viene utilizzata quando la chiamata a /beneficiario restituisce un beneficiarioBean con la proprietà idBeneficiario pari a null e il risultato dell'operazione viene impostato a UnavailableBeneficiary.

UNAVAILABLE_WALLET

Questa costante di testo viene utilizzata quando la chiamata a /borsellino restituisce un borsellinoBean pari a null e il risultato dell'operazione viene impostato a UnavailableWallet.

ncarandini commented 5 years ago

Per la soluzione dell'issue, come prima cosa ho creato il file ErrorsMessages.cs nel folder Data e ho revisionato tutto il codice in modo da utilizzare le costanti ivi riportate. Non appena mi comunicherete i testi da inserire per i quattro casi mancanti, potrò chiudere l'issue.

ncarandini commented 5 years ago

Al momento imposto: NON_OPERATING_BENEFICIARY: "Utente non abilitato all'operazione richiesta." REGISTRATION_CHECK_FAILED: "Si è verificato un errore: il servizio non è disponibile." UNAVAILABLE_BENEFICIARY: "Si è verificato un errore: il servizio non è disponibile." UNAVAILABLE_WALLET: "Si è verificato un errore in fase di registrazione."

Issue chiusa con il commit 9c867c7

italia / 18app