hudson-newey commented 7 months ago

Display warning message for "bad" website status

At the moment, when the server is down / has partial services, the only way users can diagnose the issue as a server side issue is by going to https://www.ecosounds.org/status.

Because this is unintuitive to some users, we should surface the issue sooner as a server issue by adding warnings showing that the service the user is trying to use is non-functional.

Important note: I am not displaying an error indicator in the navbar for a timeout error.

This is because:

We are already displaying a toast message that covers timeout messages
If the user doesn't have internet, it tells them that they do not have internet and to check their internet / VPN connection
The warning indicator is supposed portray the message "we are not fully functional right now, and it is not a problem with your internet / client. Try again later". Adding a timeout error case to this icon will change the semantic meaning of this icon to "something failed. It might be you; it might be us."

Changes

Add website status indicator to the navigational bar (that only shows when the website status is "bad" / unhealthy)
Add warning banner to the harvest list & detail pages if the api sftp server is down
Add warning banner to the audio recording list & download pages if the api storage is down
Add tests for all the above
Menu links now always emit a <hr> at the base of the menu links container (even when there are no widgets)

Problems

None

Issues

Fixes: #2102

Visual Changes

API Status indicator icon and tooltip (will only be shown if the server status is "bad")

Warning widget on the harvest list page

Warning widget on the harvest page

Warning widget on the recording list page

Warning widget on the batch download page

Warning widget on the audio recording details page

New <hr> element at the bottom of menu links without widgets

Final Checklist

[x] Assign reviewers if you have permission
[x] Assign labels if you have permission
[x] Link issues related to PR
[x] Ensure project linter is not producing any warnings (npm run lint)
[x] Ensure build is passing on all browsers (npm run test:all)
[x] Ensure CI build is passing
[ ] Ensure docker container is passing (docs)

github-actions[bot] commented 7 months ago

Size Change: +2.23 kB (0%)

Total Size: 2.91 MB

Filename	Size	Change
`dist/workbench-client/browser/index.html`	4.1 kB	-1 B (0%)
`dist/workbench-client/browser/main.********.js`	1.07 MB	+955 B (0%)
`dist/workbench-client/server/main.js`	1.79 MB	+1.27 kB (0%)

ℹ️ View Unchanged

| Filename | Size | | :--- | :---: | | `dist/workbench-client/browser/assets/environment.json` | 555 B | | `dist/workbench-client/browser/chunk-7SGCG2G3.js` | 1.08 kB | | `dist/workbench-client/browser/manifest.json` | 150 B | | `dist/workbench-client/browser/polyfills.********.js` | 12.2 kB | | `dist/workbench-client/browser/styles.********.css` | 32.3 kB | | `dist/workbench-client/server/776.js` | 4.2 kB |

_{compressed-size-action}

github-actions[bot] commented 7 months ago

Unit Test Results

        6 files         6 suites 9m 19s :stopwatch: 23 274 tests 22 650 :heavy_check_mark: 624 :zzz: 0 :x: 23 496 runs 22 872 :heavy_check_mark: 624 :zzz: 0 :x:

Results for commit 69d41092.

:recycle: This comment has been updated with latest results.

hudson-newey commented 7 months ago

Noticing lots of line break churn. Did our line length settings change?

Our line length settings have not changed. My best guess is that the formatter hasn't run on these files before

QutEcoacoustics / workbench-client