Error handling on shared links

androidkotlindev commented 2 years ago

In some cases, there is no error handling for Sanuli game links.

This also shows if this issue is fixed in my fork.

Failed game: RIHLA|OIKEAPITSAMIINALUUTARUUSURALLIRALLI; completely working

Succeeded game: TUNKU|OIKEAKUULUTUKKUTUNKU; completely working

Over 6 guesses: RIHLA|OIKEAPITSAMIINALUUTARUUSURALLIRALLI; a black screen and 2 error messages in the console [1, 2]. Not fixed.

No quesses: RIHLA|; a black screen and 2 error messages in the console [3, 2]. Not fixed.

Forbidden characters in quesses: RIHLA|ÅÅÅÅÅ55555+++++ÂÂÂÂÂ😀😀😀😀😀ЙЙЙЙЙ; a black screen and 2 error messages in the console [3, 2] (after testing I could find that the characters causing the problems were the 😀 and the Й; the game was completely working when they were removed). Not fixed.

Forbidden characters on the right word: Å5+Â😀|OIKEAPITSAMIINALUUTARUUSURALLIRALLI; weird rendering at the "viewing screen, shows the correct word as "Ã5+ÃÐ" and on the guessing screen there is also weird rendering, and the word requires 10 characters (and is impossible to quess). Fixed as a by-product of quotient checking, this probably should be investigated further if it causes any problems within normal gameplay which it causes if the shared link is invalid (a crash).

4-char words: RIHL|OIKEPITSMIINLUUTRUUSRALLRALL; a black screen and 2 error messages in the console [1, 2]

6-char words (not in word lists): RIHLAA|OIKEAAPITSAAMIINAALUUTAARUUSUARALLIARALLIA; a black screen and 2 error messages in the console [1, 2]

Random text: (not encoded in base64) RANDOMTEXT; Redirects to the last played gamemode

(this list is not complete (yet); I will add more game links later)

Console error messages: 1: panicked at 'index out of bounds: the len is 6 but the index is 6', src/sanuli.rs:697:22

Stack:

imports.wbg.__wbg_error_09919627ac0992f5 @ index-fb0d4eb7f7e0dd71.js:422

2: Uncaught (in promise) RuntimeError: unreachable at index-fb0d4eb7f7e0dd71_bg.wasm:0x3b9a1 at index-fb0d4eb7f7e0dd71_bg.wasm:0x4c962 at index-fb0d4eb7f7e0dd71_bg.wasm:0x4201e at index-fb0d4eb7f7e0dd71_bg.wasm:0x4d053 at index-fb0d4eb7f7e0dd71_bg.wasm:0x36ab5 at index-fb0d4eb7f7e0dd71_bg.wasm:0x6008 at index-fb0d4eb7f7e0dd71_bg.wasm:0x1eda5 at index-fb0d4eb7f7e0dd71_bg.wasm:0x17e48 at index-fb0d4eb7f7e0dd71_bg.wasm:0x197a5 at index-fb0d4eb7f7e0dd71_bg.wasm:0x4eef9

3: index-fb0d4eb7f7e0dd71.js:422 panicked at 'index out of bounds: the len is 6 but the index is 6', src/sanuli.rs:685:22

Stack:

imports.wbg.__wbg_error_09919627ac0992f5 @ index-fb0d4eb7f7e0dd71.js:422

Cadiac commented 2 years ago

Improving the error handling at the shared game links would definitely be nice, now there's hardly any handling and the cases highlighted by you indeed all fail. The reason for the format to be as it is was to get easily fairly short URLs containing all the required data, but that are not human readable.

Opening the shared game can fail on multiple levels: 1) At javascript land while trying to read the query parameter + converting the base64 to string using window.atob: https://github.com/Cadiac/sanuli/blob/master/src/manager.rs#L329 2) At rust land while for instance splitting the string at "|" or while splitting the guesses back to chunks of n character words: https://github.com/Cadiac/sanuli/blob/master/src/sanuli.rs#L138 3) At game logic level, for instance by having a word that can't be solved.

If support for generating links to arbitrary custom games etc is desired then the validation should be improved on all those levels.

androidkotlindev commented 2 years ago

I can fully understand your reasonings about this; but I'll probably make a pull request about this soon. ~~(can't get Rust working)~~

androidkotlindev commented 2 years ago

Some checks that could be done: Divide the char count in the guess section by the char count of the answer word and check if the answer is whole

Cadiac / sanuli

Error handling on shared links #21