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

Display site sync error status and error message #1216

Open
1 task
olayway opened this issue Jul 3, 2024 · 1 comment
Open
1 task

Display site sync error status and error message #1216

olayway opened this issue Jul 3, 2024 · 1 comment

Comments

@olayway
Copy link
Member

olayway commented Jul 3, 2024

Currently it's not possible for the user to tell if the sync failed or succeeded. The UI only shows "Syncing..." or "Synced".
When the sync fails, the status in the UI just jumps back from "Syncing..." to "Success" and the only indicator that it failed is that the last sync date doesn't update.

Instead we could at least display the "❌ Failed" status. And ideally also display an error message.

Acceptance

  • sync status and potential error message are communicated well in the UI

Shaping

Situation

Currently we only display two sync status information:

  1. "Syncing..."/"Success"
  2. Last synced timestamp
image

Appetite

0.5-1 day

Problem

When the site sync fails, the sync status shown in the UI is very misleading. It says that the site is "Synced", and the only indicator that it's actually not, is that the "Last synced" timestamp hasn't updated with the new date-time.

image

Solution

Option 1: Display error message on hover over "Failed status"

image

Option 2: Display error message in a separate "Logs" page

image image
  • actual error displayed in the tab

Although this second might be an overkill if we only want to display the last error message, and nothing if the sync was successful.

Rabbit-holes

...

No-goes

  • Gathering and displaying historical logs Let's just display the only message that actually matters for the user who's trying to get their content up-to-date. Any other logs e.g. of any past syncs would be nice, but do not add real value for the user. Though might be cool to see past syncs that were e.g. auto-triggered.
@olayway
Copy link
Member Author

olayway commented Jul 3, 2024

@rufuspollock Let me know what you think. I'd personally go with the 1 option.

@olayway olayway removed their assignment Jul 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: ✅ Done
Development

No branches or pull requests

1 participant