Hibajelentések
A iWiW Fejlesztői Wiki wikiből
Azt szeretnénk kérni, hogy a hatékonyabb hibavadászatot elősegítendő, a gadgetekkel, REST APIval, OAuth autentikációval kapcsolatos hibák jelentésekor az alábbi információkat a lehető legkiterjedtebben gyűjtsétek össze, és küldjétek el nekünk. (Semmiképpen ne küldjetek viszont: jelszavakat, titkos/privát kulcsokat.)
Gadgetekkel kapcsolatos problémák
- A probléma rövid leírása. (Rossz példa: "no data error hibát kapok". Jó példa: "Tetszőleges felhasználó ismerőseinek lekérdezése nem működik, ha több, mint 10 ismerősét próbálom lekérdezni").
- Melyik alkalmazásról van szó? (alkalmazás url élesen vagy sandboxon/alkalmazás id/gadget xml url)
- Melyik környezetben jön elő? (sandbox/éles/mindkettő)
- Milyen böngészővel jön elő? (böngésző típusa - oprendszer, pontos verzió / böngészőfüggetlen)
- Milyen felhasználókkal jön elő? (viewer és owner id/felhasználó független)
- Mi volt az elvárt (hibamentes) működés? (pl: "A hívás visszaadja a VIEWER első 10 ismerősét").
- Mi volt a valós (hibás) működés? (pl: "A hívás nem ad vissza egyetlen ismerőst sem").
- Ha a problémával kapcsolatban a gadget és az iWiW API között történik kommunikáció (azaz opesocial.DataRequest, osapi.*, vagy gadgets.io.makeRequest érintett), szükségünk van az érintett HTTP request(ek) dumpjára:
- a. a HTTP method (pl: GET)
- b. a HTTP request URL-je (pl: http://1949716038.app.sandbox.iwiw.hu/social/rpc?st=1949...)
- c. a HTTP request tartalmára (pl: [{"method":"people.get","params":{"userId":["@viewer"],"groupId":....)
- d. a HTTP response tartalmára (pl: [{"data":{"profileUrl":"http://sandbox.iwiw.hu/rest/person/m8VhWkh2.html","id":"sandbox.iwiw.hu:m8VhWkh2"...)
- e. a HTTP request fejlécekre, pl:
Server Apache-Coyote/1.1
X-ServerID api2
Content-Type application/json;charset=UTF-8
... - f. a HTTP response fejlécekre, pl:
Host 1449716038.app.sandbox.iwiw.hu
User-Agent Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9.2.2) Gecko/20100316 Firefox/3.6.2
Accept text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
- Keletkezik-e JavaScript exception a hibával kapcsolatban, ha igen, mi? (exception típusa, szövege, stacktrace, ha rendelkezésre áll)
- Példakód, ami az OpenSocial Dev App-ba (http://sandbox.iwiw.hu/app/1949716038 vagy http://iwiw.hu/app/1949716038) bemásolva előhozza a hibát.
- Bármi más fontos információ, vagy útmutatás a hibajelenség reprodukálásához.
- Fájlmelléklet (pl. screenshot).
REST APIval (Connect, Social API) és OAuth autentikációval (Kapu) kapcsolatos problémák
- A probléma rövid leírása. (Rossz példa: "no data error hibát kapok". Jó példa: "Tetszőleges felhasználó ismerőseinek lekérdezése nem működik, ha több, mint 10 ismerősét próbálom lekérdezni").
- Melyik alkalmazásról van szó? (név vagy devportál url)
- Melyik környezetben jön elő? (sandbox/éles/mindkettő)
- Milyen felhasználókkal jön elő?
- Mi volt az elvárt (hibamentes) működés? (pl: "A hívás visszaadja az autentikált felhasználó első 10 ismerősét").
- Mi volt a valós (hibás) működés? (pl: "A hívás nem ad vissza egyetlen ismerőst sem").
- Az érintett HTTP request(ek) dumpja (segítség a dumpoláshoz):
- a. a HTTP method (pl: GET)
- b. a HTTP request URL-je (pl: http://1949716038.app.sandbox.iwiw.hu/social/rpc?st=1949...)
- c. a HTTP request tartalmára (pl: [{"method":"people.get","params":{"userId":["@viewer"],"groupId":....)
- d. a HTTP response tartalmára (pl: [{"data":{"profileUrl":"http://sandbox.iwiw.hu/rest/person/m8VhWkh2.html","id":"sandbox.iwiw.hu:m8VhWkh2"...)
- e. a HTTP request fejlécekre, pl:
Server Apache-Coyote/1.1
X-ServerID api2
Content-Type application/json;charset=UTF-8
... - f. a HTTP response fejlécekre, pl:
Host 1449716038.app.sandbox.iwiw.hu
User-Agent Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9.2.2) Gecko/20100316 Firefox/3.6.2
Accept text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
- Az esetlegesen használt OpenSocial, REST, OAuth vagy egyéb library pontos verziója.
- Bármi más fontos információ, vagy útmutatás a hibajelenség reprodukálásához.
