Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve UI when user tries to open missing file #961

Open
2 tasks
lidel opened this issue Feb 14, 2019 · 15 comments
Open
2 tasks

Improve UI when user tries to open missing file #961

lidel opened this issue Feb 14, 2019 · 15 comments
Labels
area/screen/files Issues related to Files screen effort/days Estimated to take multiple days, but less than a week exp/novice Someone with a little familiarity can pick up good first issue Good issue for new contributors help wanted Seeking public contribution on this issue kind/bug A bug in existing code (including security flaws) P1 High: Likely tackled by core team if no one steps up status/ready Ready to be worked topic/design-front-end Front-end implementation of UX/UI work topic/design-ux UX strategy, research, not solely visual design
Milestone

Comments

@lidel
Copy link
Member

lidel commented Feb 14, 2019

(found this while working on unbundling webui from companion)

"Not Found" error for Files tab could be better :-)

  1. Open http://127.0.0.1:8080/ipfs/QmXc9raDM1M5G5fpBnVyQ71vR4gbnskwnB9iMEzBuLgvoZ/#/files/I_AM_NOT_HERE.jpg (or any other filename that is not present in your MFS)

  2. See this odd state with no buttons and bogus error about adding:
    image

This may happen if someone bookmarks or copies URL to another machine without pointing webui at the same IPFS node.

We should either display a meaningful message or just silently redirect to the nearest MFS root.

Tasks

@olizilla olizilla added kind/bug A bug in existing code (including security flaws) exp/novice Someone with a little familiarity can pick up P2 Medium: Good to have, but can wait until someone steps up status/ready Ready to be worked labels Feb 18, 2019
@olizilla
Copy link
Member

I think a 404-like page, tailoured for the files page would be useful. An individual user may bookmark a location and then move things around.

TODO:

  • Catch ipfs error where mfs file path is missing
  • Offer an action to navigate back to the MFS root.
  • Show a helpful message that explains what happened.

The path /example/cats.png doesn't exist in your local IPFS repository.
Did you bookmark it or follow a link that someone else sent you?

Bonus points

what if we include the CID info in the url? This would allow us to:

  • navigate the user to the new path if it exists in the repo (we'd have to walk all of MFS to figure out the new path, if it exists, but we could show the content straight away)
  • Try and fetch the content where a user shares the location from the url bar.

@jessicaschilling jessicaschilling changed the title Files: confusing state when opening missing file Improve UI when user tries to open missing file Apr 7, 2020
@jessicaschilling jessicaschilling added effort/days Estimated to take multiple days, but less than a week good first issue Good issue for new contributors help wanted Seeking public contribution on this issue P1 High: Likely tackled by core team if no one steps up topic/design-front-end Front-end implementation of UX/UI work topic/design-ux UX strategy, research, not solely visual design and removed P2 Medium: Good to have, but can wait until someone steps up labels Apr 7, 2020
@lidel
Copy link
Member Author

lidel commented Sep 4, 2020

@hklcf those errors are not related to this issue: those are just missing translation for zh-TW locale. If you want to contribute translations, join project at https://www.transifex.com/ipfs/public/


@jessicaschilling thoughts on improving the 404 "Not found" state of Files screen?

It should be more prominent, and also more explicit:

  • should not look like "ok" state, should be red and error-ish
  • should show what resource was not found (with full content path)

As a data point, currentversion of "404" screen from a user report copied from ipfs/kubo#7604:

Hello, at first my ipfs can import, but after some uploads it turns to /404 and no import button anymore, anyone experiencing the problem?
ScreenShot_20200818210837

Right now user is unable to tell what went wrong and why "404" is displayed.
If a full content path (either MFS, /ipfs/ or /ipns that was not found was displayed, then it would be much easier to self-service.

@jessicaschilling
Copy link
Contributor

For reference, current state of 404 on master branch (updated first comment in this issue with this, too):
image

@jessicaschilling
Copy link
Contributor

@lidel Rough first pass at what this might look like if we used the same visual language as the "not connected" errors that will ship in 2.11. Suggesting we use those visuals for consistency, but would appreciate advice for improving the text.
image

@jessicaschilling jessicaschilling added this to the v2.12 milestone Sep 8, 2020
@lidel lidel added the area/screen/files Issues related to Files screen label Sep 15, 2020
@lidel
Copy link
Member Author

lidel commented Sep 18, 2020

@rafaelramalho19 raised the problem of having two types of "not found" errors:

  1. opening /files/not/in/mfs or /ipfs/<cid>/nope (a path that does not exist in parent directory)
  2. opening /invalid-route that is not supported by webui

I believe if we implement separate screens for each, then (1) should have super breadcrumbs, so it's easy for user to go up in MFS until an existing item works. For additional ✨ each "missing" crumb would be in red.

This may be additional work, so if its easier to do a quick fix by showing the same page for (1) and (2), I would do that (just a plain error without Files-specific UI).

@jessicaschilling
Copy link
Contributor

@lidel That all makes sense - are you OK with the proposed text in the mockup? If so I think this is ready to build.

@rafaelramalho19
Copy link
Contributor

Having a separate page handler for both the errors is the simplest and cleanest solution, here's my points:

Pros:

  • 💚 We don't need to hack the files state (FILES_FINISHED, FILES_STARTED actions + adding flags that show/hide errors)
  • 💚 The error handling is separated from the normal flow, not polluting the main workflow

Cons:

  • 💔 Breadcrumbs needs to be replicated in the error page and could lead to desync between features/bug fixing in breadcrumbs

@jessicaschilling
Copy link
Contributor

If we remove the Files-specific UI elements per #961 (comment) (image), then we don't include breadcrumbs at all.

@lidel
Copy link
Member Author

lidel commented Sep 18, 2020

If breadcrumbs can't be reused easily, then I'd go with Jessica's sugegstion from the comment above and remove files-specific UI.

@jessicaschilling
Copy link
Contributor

jessicaschilling commented Sep 18, 2020

@rafaelramalho19 Text follows, including edits discussed out-of-band:

IPFS can't find this item

These common troubleshooting steps might help:

  • Are there typos in the path you entered?
  • Was the file move, renamed, or deleted?
  • Did you copy a URL or bookmark from another computer? If so, you'll need to {link to Peers screen}connect to that computer's node{/link>}.

{button}Back to Files{/button}

@jessicaschilling jessicaschilling modified the milestones: v2.13, v2.12 Jan 25, 2021
@lidel lidel removed this from the v2.12 milestone Apr 5, 2021
@lidel lidel added this to the v2.13 milestone Apr 5, 2021
@lidel lidel modified the milestones: v2.13, v2.14 Apr 13, 2021
@wuniversales
Copy link

I do not know if it is related to this but on my website I have a problem of that style.
https://buscatope.eu.org/
My website works with ipfs, but if I load an address that doesn't exist it returns this ...
https://buscatope.eu.org/invented
Shouldn't it load the 404 file?
https://buscatope.eu.org/404.html

@lidel
Copy link
Member Author

lidel commented May 27, 2021

@wuniversales this is unrelated, but you should use ipfs-404.html for IPFS gateway to pick it up as your 404 page, as noted in release notes

@SgtPooki
Copy link
Member

Test dir CID with 10k images: bafybeiggvykl7skb2ndlmacg2k5modvudocffxjesexlod2pfvg5yhwrqm
fast dir listing (skips size resolution: ipfs ls -s --size=false --resolve-type=false $CID

@ef3n9r98
Copy link

@lidel @olizilla same for this one - would you pay a dev to fix it?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/screen/files Issues related to Files screen effort/days Estimated to take multiple days, but less than a week exp/novice Someone with a little familiarity can pick up good first issue Good issue for new contributors help wanted Seeking public contribution on this issue kind/bug A bug in existing code (including security flaws) P1 High: Likely tackled by core team if no one steps up status/ready Ready to be worked topic/design-front-end Front-end implementation of UX/UI work topic/design-ux UX strategy, research, not solely visual design
Projects
No open projects
Status: Good First Issue
Status: Planned / Backlog
Development

No branches or pull requests

8 participants