task/FP-391: Notifications

[rstijerina]

Overview:

Enables Django Channels on the backend, running as a daphne server for websocket events.

Creates a ReconnectingWebSocket connection on client instantiation. The channels ws connection is added to two groups:

• the user's username group, for messages to the user
• the portal_events group, for messages to all users

Credit to @jarosenb for laying the groundwork.

PR Status:

• Ready.
• Work in Progress.
• Hold.

Related Jira tickets:

• FP-391
• FP-81
• FP-27

Summary of Changes:

Testing Steps:

1. Install updated requirements.txt by rebuilding image:

make build

2. Install updated packages.json:

cd client && npm ci
npm run dev

3. Run an ngrok session to route webhooks to frontera_prtl_nginx:

ngrok http 443

4. Take url generated by ngrok and paste it into the _WH_BASE_URL setting in settings_secret.py
5. Launch a job and see the History notifications badge increment as the job status changes.

UI Photos:

Notes:

• Notification toasts and tables will be coming in a separate PR.
• There is a companion PR for the camino side changes to the websocket docker container at task/FP-391: Notifications - update ws docker container to daphne asgi server Camino#3

Todo:

• If 3 job status updates come through for one job, that increments the badge counter by 1, not 3

[codecov]

Codecov Report

Merging #77 into master will decrease coverage by 0.11%.
The diff coverage is 50.00%.

@@            Coverage Diff             @@
##           master      #77      +/-   ##
==========================================
- Coverage   54.08%   53.96%   -0.12%     
==========================================
  Files         211      216       +5     
  Lines        7585     7686     +101     
  Branches     1028     1065      +37     
==========================================
+ Hits         4102     4148      +46     
- Misses       3287     3332      +45     
- Partials      196      206      +10     

Flag	Coverage Δ
#javascript	50.62% <48.48%> (-0.52%)	⬇️
#unittests	55.22% <51.25%> (+0.06%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
client/src/components/Workbench/Workbench.js	0.00% <0.00%> (ø)
client/src/utils/notifications.js	0.00% <0.00%> (ø)
server/portal/apps/datafiles/views.py	35.89% <ø> (ø)
server/portal/apps/notifications/routing.py	0.00% <0.00%> (ø)
server/portal/apps/signals/signals.py	100.00% <ø> (ø)
server/portal/apps/workspace/tasks.py	0.00% <ø> (ø)
server/portal/asgi.py	0.00% <0.00%> (ø)
server/portal/settings/settings.py	0.00% <0.00%> (ø)
...lient/src/redux/reducers/notifications.reducers.js	7.14% <7.14%> (ø)
server/portal/apps/notifications/views.py	20.83% <11.11%> (-3.66%)	⬇️
... and 21 more

[wesleyboar]

This is a UI approval.

[nathanfranklin]

Besides #77 (comment) thread, looks good to merge 👍

In the future, would it be useful to change the backend response so that the list contains the total unread count but instead of a single list it contains a separate list (with their unread count) for each of the event types.

[wesleyboar]

Two suggestions (fixes based on incorrect padding that I believe came from me).

Also, there's a merge conflict to resolve. Probably related to icons. I'll look. Update: PR author is looking.

[wesleyboar]

Re-approving, after testing changes, and reviewing last minute commits.

Update: Assuming client-side test failure will be fixed. The client-side test failure is fixed.