Project

General

Profile

Actions

Feature #18368

closed

Notification banner

Added by Peter Amstutz about 3 years ago. Updated 8 months ago.

Status:
Resolved
Priority:
Normal
Assigned To:
Category:
-
Story points:
-
Release relationship:
Auto

Description

Ability to tell the user about system maintenance. Want a banner on workbench2.

A very simple implementation could be a public config item exported by Controller where an admin can populate a message to be shown to user, e.g. "we are aware of performance issues and are investigating a fix" or "scheduled maintenance on Saturday November 29th 21:00-23:00, Arvados will be unavailable".

Display of the banner could be one of (TBD):

  • Box at the top of the screen, which pushes the content down until it is dismissed this is going to difficult with the existing layout, some things are fixed number of pixels from the top
  • Dialog overlay that pops up when the app is loaded, which must be dismissed

Could add a menu item to the "notification" menu which brings the message back after being dismissed.

Assume data will come from a URL which will be part of the public config.

The URL body will have HTML which should be rendered inside the banner box.


Files

clipboard-202211091731-wte8s.png (320 KB) clipboard-202211091731-wte8s.png Daniel Kutyła, 11/09/2022 04:31 PM

Subtasks 2 (0 open2 closed)

Task #19392: Add exported config for banner URLResolvedPeter Amstutz10/12/2022Actions
Task #19399: Review 18368-workbench-banner-configResolvedLucas Di Pentima10/13/2022Actions

Related issues 2 (1 open1 closed)

Related to Arvados Workbench 2 - Bug #18371: Handle unreachable API server better on startupNewActions
Related to Arvados - Idea #7468: [Workbench] Displays content at the top of the dashboard, set by the sysadminClosed10/07/2015Actions
Actions #1

Updated by Peter Amstutz about 3 years ago

  • Category changed from Workbench to Workbench2
  • Subject changed from Notification banner to Notification banner
Actions #2

Updated by Peter Amstutz about 3 years ago

  • Description updated (diff)
Actions #3

Updated by Ward Vandewege about 3 years ago

  • Related to Bug #18371: Handle unreachable API server better on startup added
Actions #4

Updated by Ward Vandewege about 3 years ago

  • Description updated (diff)
Actions #5

Updated by Moritz Gilsdorf over 2 years ago

Another use case similar to this would be to permanently display a disclaimer on specific environments. E.g. some users are not able to distinguish between our dev/test environment and upload production data. The banner could inform them permanently that this is a dev/test environment.

Actions #7

Updated by Peter Amstutz over 2 years ago

  • Target version set to 2022-07-20
Actions #8

Updated by Peter Amstutz over 2 years ago

  • Related to Idea #7469: [Workbench] Provide an interface for the sysadmin to set Dashboard banner content added
Actions #9

Updated by Peter Amstutz over 2 years ago

  • Related to Idea #7468: [Workbench] Displays content at the top of the dashboard, set by the sysadmin added
Actions #10

Updated by Peter Amstutz over 2 years ago

  • Related to deleted (Idea #7469: [Workbench] Provide an interface for the sysadmin to set Dashboard banner content)
Actions #11

Updated by Peter Amstutz over 2 years ago

  • Description updated (diff)
Actions #12

Updated by Peter Amstutz over 2 years ago

  • Description updated (diff)
Actions #13

Updated by Peter Amstutz over 2 years ago

  • Target version changed from 2022-07-20 to 2022-08-03 Sprint
Actions #14

Updated by Peter Amstutz over 2 years ago

  • Target version changed from 2022-08-03 Sprint to 2022-08-31 sprint
Actions #15

Updated by Peter Amstutz over 2 years ago

  • Target version changed from 2022-08-31 sprint to 2022-09-14 sprint
Actions #16

Updated by Peter Amstutz over 2 years ago

  • Target version changed from 2022-09-14 sprint to 2022-08-31 sprint
Actions #17

Updated by Peter Amstutz over 2 years ago

  • Assigned To set to Daniel Kutyła
Actions #18

Updated by Peter Amstutz over 2 years ago

  • Description updated (diff)
Actions #19

Updated by Peter Amstutz over 2 years ago

  • Target version changed from 2022-08-31 sprint to 2022-09-14 sprint
Actions #20

Updated by Peter Amstutz over 2 years ago

  • Description updated (diff)
Actions #21

Updated by Peter Amstutz over 2 years ago

  • Description updated (diff)
Actions #22

Updated by Peter Amstutz over 2 years ago

  • Target version changed from 2022-09-14 sprint to 2022-09-28 sprint
Actions #23

Updated by Peter Amstutz about 2 years ago

  • Target version changed from 2022-09-28 sprint to 2022-10-12 sprint
Actions #24

Updated by Peter Amstutz about 2 years ago

  • Target version changed from 2022-10-12 sprint to 2022-10-26 sprint
Actions #25

Updated by Peter Amstutz about 2 years ago

18368-workbench-banner-config @ 3a21e39416ea3fadc795f52b77e68b36d55436ed

  • Add Workbench.BannerURL config option

developer-run-tests: #3315

Actions #26

Updated by Lucas Di Pentima about 2 years ago

18368-workbench-banner-config LGTM, thanks.

Actions #27

Updated by Peter Amstutz about 2 years ago

  • Status changed from New to In Progress
Actions #28

Updated by Peter Amstutz about 2 years ago

  • Target version changed from 2022-10-26 sprint to 2022-11-09 sprint
Actions #29

Updated by Peter Amstutz about 2 years ago

  • Target version changed from 2022-11-09 sprint to 2022-11-23 sprint
Actions #30

Updated by Peter Amstutz about 2 years ago

Danny will add a screenshot, need to iterate on the design.

Actions #32

Updated by Peter Amstutz about 2 years ago

Add an explicit close button [x]

slight transparency: 90% or 80% opacity

Different background color.

Consider using dialog box control, or integrating better into layout so it doesn't cover anything up.

Actions #33

Updated by Peter Amstutz about 2 years ago

From discussion with Moritz:

  • For now, use the plain dialog box control for the overlay.
  • Load HTML from the config URL and injects it as raw HTML into the content of the box (it is the responsibility of the user for it to be well formed, we're assuming only admins are allowed to set the contents.)
  • When dialog box is dismissed, record in local storage that the dialog box was displayed.
    • It should record the URL, the date, and the ETag from the request headers
    • On reloading the app: If the local storage says the dialog box was previously shown, check the URL and headers in local storage. If the URL, date or ETag has changed, redisplay the dialog. If not, suppress it.
  • There should be a menu item (perhaps under the bell "notify" menu) which redisplays the dialog.
Actions #34

Updated by Peter Amstutz about 2 years ago

  • Target version changed from 2022-11-23 sprint to 2022-12-07 Sprint
Actions #35

Updated by Daniel Kutyła about 2 years ago

  • Parent task set to #19841
Actions #36

Updated by Peter Amstutz about 2 years ago

  • Estimated time set to 0.00 h
Actions #38

Updated by Peter Amstutz almost 2 years ago

ok, I finally updated the Arvados config to use BannerUUID instead of BannerURL, I took another look at the banner branch, it looks good, please merge

Actions #39

Updated by Daniel Kutyła almost 2 years ago

  • Status changed from In Progress to Resolved
Actions #40

Updated by Peter Amstutz 8 months ago

  • Release set to 57
Actions #41

Updated by Peter Amstutz 8 months ago

  • Parent task deleted (#19841)
Actions #42

Updated by Peter Amstutz 8 months ago

  • Tracker changed from Task to Feature
Actions

Also available in: Atom PDF