Warden

Tak jsme cele vcerejsi odpoledne stravili s Kubou dumanim, jak vyresit jiz od zacatku se tahnouci problem s navratovymi hodnotami a chybovymi hlaskami od serveru ke klientovi (ticket 534). Po dlouhe diskuzi, zkouseni a premysleni, nam pripadne jako nejlepsi to cele predelat nasledujicim zpusobem, ktery je velice jednoduchy a primocary:

• funkce budou vracet pomoci return dva prvky
  • 1. navratovou hodnotu 0 (false - nekde se stala chyba) nebo 1 (true - vse dopadlo uspesne)
  • 2. popis chyby pokud navratova hodnota je 0 a SOAP objekt nebo pole SOAP objektu nebo undef pokud navratova hodnota funkce je 1

Na serveru by to pak vypadalo nasledovne:

return (0, "Error message");

nebo

return (1, undef);
return (1, $soap_object);
return (1, @soap_object_array);

V klientovy by se pak toto zpracovavalo pomoci:

• ziskani navratove hodnoty 0 nebo 1:

my $ret_val = $response->result;

• ziskani chybove zpravy, undef nebo dat:

my $params = $response->paramsout;

Dle naseho nazoru nam zavedeni tohoto pristupu zajisti pouzitelnost i pri vyhozeni SOAPu, vyresi ticket 519, zjednodusi praci s chybami a daty, usnadni testovani a vse celkove sjednoti. Pri aktualni implementaci totiz sice vime, ze se volani nepovedlo, ale pouze tise doufame, ze se povedlo, protoze pro to nemame kontrolu.

U Kubovych Unit testu zase pomuze s jejich zjednodusenim, ktere je take dulezite, protoze pak staci testovat navratovou hodnotu fce 1/0 pomoci "ok()". Neni potreba resit toto slozite pres "is()" a pripravovat si dummy data a vypisy z certifikatu pro porovnani vystupu testovane fce.

Pavle, muzes nam k tomu dat nejaky komentar, nez se pustim do prepsani?

Diky a s pozdravem,

Tom a Kuba

Takže: * write2log, getAltNames, authorizeClient - chyby logovat, return 1/0 * SOAP funkce - die nahradit pomocnou funkcí, která zaloguje a vyhodí SOAP::Fault s hláškou

• bylo by dobré zvážit chytání chyb, které jsem v předchozím textu označil 'neřeší'
• zvážit u interních chyb jinou hlášku (ukecanější) do logu a jinou ("server error") klientovi

Jen doformatuji a doplnim:

Zmeny ve funkcich:

• write2log, getAltNames, authorizeClient - chyby logovat do syslogu, return 1/0
• SOAP funkce - die nahradit pomocnou funkcí (errSoapMsg), která zaloguje a vyhodí SOAP::Fault s hláškou
• vypustit errMsg a trim (trim stejne pouziva pouze errMsg)

• bylo by dobré zvážit chytání chyb, které jsem v předchozím textu označil 'neřeší'
• zvážit u interních chyb jinou hlášku (ukecanější) do logu a jinou ("server error") klientovi

Tomáš Plesník wrote:

Jen doformatuji a doplnim:

Zmeny ve funkcich:

• write2log, getAltNames, authorizeClient - chyby logovat do syslogu, return 1/0
• SOAP funkce - die nahradit pomocnou funkcí (errSoapMsg), která zaloguje a vyhodí SOAP::Fault s hláškou

Tady bych prave rozdeloval hlaseni do logu (ukacenejsi pomoci write2log) a klientovi (mene ukecane pomoci errSoapMsg)

• vypustit errMsg a trim (trim stejne pouziva pouze errMsg)

• bylo by dobré zvážit chytání chyb, které jsem v předchozím textu označil 'neřeší'
• zvážit u interních chyb jinou hlášku (ukecanější) do logu a jinou ("server error") klientovi

Viz komentar u odrazky SOAP funkce.

No, já to myslel tak, že ukecanější půjde pomocí write2log (třeba včetně Carp::longmess), méně ukecané pomocí SOAP::Fault, a to celé zabalí errSoapMsg, která obojí zavolá se správnými parametry... třeba:

  # stejná hláška na obě strany
  # dobře, možná do logu s longmess a klientovi bez
  errSoapMsg("Unauthorized access to '$function_name' from: '$ip' etc. etc."); 

  # hláška do logu, klientovi půjde jenom "Internal server error" 
  errSoapMsg("Cannot prepare authorization statement in $function_name: $DBI::errstr", 1);

Pavel Kácha wrote:

No, já to myslel tak, že ukecanější půjde pomocí write2log (třeba včetně Carp::longmess), méně ukecané pomocí SOAP::Fault, a to celé zabalí errSoapMsg, která obojí zavolá se správnými parametry... třeba:

[...]

Dobre tim padem bych to videl na jednoduchou variantu. Vytvorit novou funkci errMsg, ktera v sobe bude mit obsazenu puvodni write2log pro logovani do Syslogu a navic jeste SOAP::Fault pro zasilani zprav klientovi. Tato funkce by pak byla volana se dva parametry: 1. chybova hlaska do syslogu, 2. chybova hlaska pro klienta:

errMsg("Cannot prepare authorization statement in $function_name: $DBI::errstr", "Internal server error.");

A původní errMsg vystřelit a na správných místech nahradit die nebo exitem (týká se asi jen čtení konfiguráku). Ok, varianta s dvěmi stringy může být užitečnější v tom, že i hláška pro uživatele může být informativnější pro správce, až ji od uživatele nafasuje, ve stylu "Internal 'prepare' server error".

Pavel Kácha wrote:

A původní errMsg vystřelit a na správných místech nahradit die nebo exitem (týká se asi jen čtení konfiguráku).

Toto uz je hotove. Tykalo se pouze cteni konfiguracniho souboru.

Ok, varianta s dvěmi stringy může být užitečnější v tom, že i hláška pro uživatele může být informativnější pro správce, až ji od uživatele nafasuje, ve stylu "Internal 'prepare' server error".

Ano, presne tak. Naprosto souhlasim.

Modul SOAP::Fault umoznuje nastavit objektu celkem 4 parametry:

• faultcode(optional value)
  

  $fault->faultcode('MethodUnknown');
  
  Returns the current fault code or sets it if a value is given. 
  

• faultstring(optional value)
  

  $fault->faultstring("There is no $method here");
  
  Returns or sets the fault string.
  

• faultactor(optional value)
  

  $fault->faultcode($header->actor);
  
  Returns or sets the fault-actor element. Note that the actor isn't always required in a SOAP fault.
  

• faultdetail(optional value)
  

  $fault->faultcode(bless { proxy => $ip }, 'Err');
  
  Returns or sets the fault's detail element. Like the actor, this isn't always a required element. 
  Note that fault detail content in a message is represented as tag blocks.
  Thus, the values passed to this accessor when setting the value are either SOAP::Data objects, or more general blessed hash references.
  

Ja osobne jsem toho nazoru, ze by nam melo stacit plnit pouze faultstring a pokud bychom chteli do Wardenu zatahnout i cisla chyb, tak potom i faultcode, zde si ale nejsem jisty. Pavle, ses stejneho nazoru?

Taky si myslím. Stačí faultstring.

Napadlo mě - až si s tím budeš hrát, zkus jestli se SOAP::Fault nedá vrátit i returnem, nejen diem - mohli bychom se pak výjimek kompletně zbavit, a hlavně bychom mohli (podobně jako v klientovi) chytat ostatní výjimky, neočekávané, nebo ty z volaného kódu, a slušně se k nim zachovat.

Na serveru vznikla nova funkce sendMsg, ktera do sebe spojuje puvodni write2log pro zalogani zpravy do Syslogu a die pro ukonceni zpracovani funkce a poslani hlasky klientovi v pripade chyby. Vse je nakomitovane do GITu, viz 697a22dd.

Ve funkci sendMsg jsem zkousel namisto doporucovaneho die pouzit i return a s nejvetsi pravdepodobnosti se to chova stejne jako puvodni die, ktery ukoncil volanou SOAP funkci a poslal chybovou hlasku klientovi.

Pokud nema nikod vyhrady, tak ticket muze byt uzavren.