Provide better feedback when a file cannot be loaded

[r03ert0]

There are common reasons for failure, for example, trying to use private data from google, or a file that's too large (and google will not serve), etc.

[adityaofficial10]

Hey @r03ert0 @katjaq ! Can I work on this issue?

[katjaq]

Hello @adityaofficial10 ! How nice that you would love to work on that issue! :D

I will write some info here, and we just thought it could be nice to point people to an FAQ page (as part of the error feedback?) I will paste link to that sort of wiki here in short. (We'll use github wiki :)

so here some info for you that should help implement better feedback:

• if it is a file from google drive:

  • the file needs to be smaller than 30MB, otherwise google will block download
  • the link obtained from g-drive needs to be modified :
    replace "file/d/" by "uc?id=" and delete "/view?usp=sharing" at the end of the url
    You can check that if you paste your url in a private window, you should be able to download the file

• if it is a dropbox link, users need to take the original share link and

  • replace "www" by "dl" and
  • delete everything after "nii.gz"
  • You can check that if you paste your url in a private window, you should be able to download the file, then it means it should work in BrainBox :)

and so on, we will add more detailed info on more sources in the FAQ

Thank you so much for your help!! :)

[katjaq]

We filled some info in the wiki https://github.com/neuroanatomy/BrainBox/wiki/Frequently-Asked-Questions Hope this helps ! :D Thank so much!

[adityaofficial10]

@katjaq Sorry for the late reply.. Thanks a lot for your help and the resources. So I think we can provide a link to the wiki and also giving out some feedback like 'Check out the FAQs to find out the possible reasons.', etc. Does this look good?

[r03ert0]

thank you for your help @adityaofficial10 ! maybe you can try a couple of things:

• try to open in brainbox a file that doesn't exist
• try to open a file from gdrive that is not publicly available
• try to open a file from gdrive that's >30MB.

These should all lead to errors. The aim will be to catch those errors and report them in a way that could be useful for the different cases.

Finally, I don't know what would be the best way of reporting the errors because there are 2 different places where they can emerge. First, if you enter the URL of your file in the home page, that will open the brainbox.pasteur.fr/mri/ route. Second, if your URL is part of a project, then the error-triggering file could be opened through the brainbox.pasteur.fr/project/ route. Ideally, we would like to have the code giving feedback on the error in a single place, and not repeated for the /mri and /project routes.

[adityaofficial10]

Thanks a lot for this @r03ert0 . I'll quickly devise a plan and comment here. We can move forward with that..

[r03ert0]

super cool! Actually, we just saw a case of a person that was entering the url for a directory (https://thing.com/directory/) instead of pointing to a file, which made BrainBox crash without any grace :-/

[adityaofficial10]

Hey @r03ert0 @katjaq ! I have attached a screenshot.

Is this the screen when file upload fails?

[r03ert0]

yup... at some point there was an error message, but it's not showing up anymore. You should get an error message displayed in the Web console. It shouldn't be hard to add a test to check that the error message actually displays (to prevent it from disappearing again in the future...)

[adityaofficial10]

@r03ert0 Yeah sure. I have examined the message in the console. I'll try to compile a good feedback and come back shortly.

[adityaofficial10]

@r03ert0 @katjaq The plan is to create a new category of routes namely ' error '. This will be useful in the future as well if we discover some other errors. So I've added 'error/loadingFile' currently. We'll collect the error from the route and redirect the response to the error route. And we can then render the error feedback page using that route. Does it look good?

[katjaq]

Hey @adityaofficial10 – sounds great!! 👍 Green light from @r03ert0 and me to go ahead! 🎉 Thank you 😊

[adityaofficial10]

@r03ert0 @katjaq It seems the issue is far deeper. Actually I tried many things but there is something which stops the route to render the error page. Something like this:

First I need to examine in detail about what happens here. So I might need some time for this. Thanks & Regards.

[adityaofficial10]

Hey @katjaq ! Can you please create a project board for this repo? I am not an internal member.😅 I have decided to start with basic cleaning up tasks like fixing small bugs and completing todo tasks. I am still working on the error feedback and hopefully I'll crack it in some days. Regards & Thanks again..

[katjaq]

Yeyy! thanks for asking! I created a project – but let me know how i could make it better (eg smaller cards instead of one big one?) also, are you able to add tasks yourself ? like you mentioned these little bugs you found along the way, that you may want to add there?

[adityaofficial10]

@katjaq @r03ert0 Thanks a lot for that. Its pretty great and I'd say the cards are pretty good to start with. Unfortunately, I can't add tasks there. Maybe you can try assigning me a card there and we'd see then. Regards..

[r03ert0]

You can add issues, and then we can put them as cards : )

[adityaofficial10]

You can add issues, and then we can put them as cards : )

Sure, we'd work this way. Thanks & Regards...