feat: Site status message #7659

holloway · 2024-07-10T02:17:15Z

Features

show a status message on all public pages
doesn't require JavaScript
- non-JS browsers use an <iframe> pointing to a route showing the latest status message. If no site message is active it shows "No site status message.". The iframe is a <noscript><iframe src=></iframe></noscript> so only browser without JavaScript have this fallback.
- JS-enabled browsers use Vue NaiveUI: Notifications with a default design. Dismissed statuses are noted in browser localStorage (ie per device and browser) not per user, so dismissed statuses aren't remembered on a different device and will need to be dismissed again.
doesn't pollute Cloudflare cache with status messages (ie status messages aren't rendered inline in each Django page as Cloudflare would cache outdated statuses... instead the browser composes the page with JavaScript+APIs or IFrames)
Has an endpoint to redirect users to the latest status: /status
Django and Playwright tests

rjsparks · 2024-07-11T14:28:32Z

ietf/status/views.py

@@ -35,6 +35,7 @@ def status_latest_html(request):

 def status_page(request, slug):
    status = get_object_or_404(Status, slug=slug)
+    print("status", status)


debug leak?

holloway · 2024-07-15T05:40:06Z

Hey @rjsparks this is ready for another review

NGPixel · 2024-07-15T06:50:19Z

client/components/Status.vue

+                console.info("No status message")
+                return
+            }
+            const dismissedStatuses = getDismissedStatuses()
+            if(dismissedStatuses.includes(status.id)) {
+              console.info(`Not showing site status ${status.id} because it was already dismissed. Dismissed Ids:`, dismissedStatuses)
+              return
+            }
+
+            const isSameStatusPage = Boolean(document.querySelector(`[data-status-id="${status.id}"]`))
+
+            if(isSameStatusPage) {
+              console.info(`Not showing site status ${status.id} because we're on the target page`)
+              return
+            }
+
+            if(notificationInstances[status.id]) {
+              console.info(`Not showing site status ${status.id} because it's already been displayed`)


Change to console.debug?

NGPixel · 2024-07-15T06:52:04Z

client/components/Status.vue

@@ -0,0 +1,83 @@
+<script>


Use <script setup> instead of manually defining the component further down.

NGPixel · 2024-07-15T06:53:38Z

client/components/Status.vue

Various uses of semi-colons. Remove all.

NGPixel · 2024-07-15T06:56:47Z

client/Embedded.vue

@@ -15,6 +16,7 @@ import NTheme from './components/n-theme.vue'
 const availableComponents = {
  ChatLog: defineAsyncComponent(() => import('./components/ChatLog.vue')),
  Polls: defineAsyncComponent(() => import('./components/Polls.vue')),
+  Status: defineAsyncComponent(() => import('./components/Status.vue')),


No dangling comma

NGPixel · 2024-07-15T07:00:19Z

client/shared/json-wrapper.js

@@ -0,0 +1,18 @@
+export const JSONWrapper = {
+  parse(jsonString, defaultValue) {
+    if(typeof jsonString !== "string") return defaultValue


Avoid single line if / return

rjsparks · 2024-07-15T14:54:21Z

ietf/status/models.py

@@ -0,0 +1,22 @@
+# Copyright The IETF Trust 2017-2020, All Rights Reserved


this is a new model copyright should be 2024 - same with all other new files. Modified files should have the date range extended to 2024

rjsparks · 2024-07-15T14:54:59Z

ietf/status/migrations/0001_initial.py

@@ -0,0 +1,48 @@
+# Generated by Django 4.2.13 on 2024-06-24 04:24


Replace the Generated by with the trust copyright line

Also, since this is a new app coming in, delete the migrations and regenerate them so that there's only a 0001_initial.

richsalz · 2024-07-15T15:52:16Z

I wrote a tool for OpenSSL to do it automatically. Do you want me to open an issue to add something like that to the release process? https://github.com/openssl/tools/blob/master/release-tools/do-copyright-year

rjsparks · 2024-07-15T16:33:05Z

Sure - split that into a separate issue so we don't distract from this PR too much.

rjsparks

Very close, but I've marked a few things I think need to change.

rjsparks · 2024-07-15T16:39:32Z

ietf/status/views.py

+    status = Status.objects.order_by("-date").first()
+    if status is None or status.active == False:
+        return { "hasMessage": False }


This prevents us from staging the next message.
Consider instead:

status = Status.objects.filter(active=True).order_by("-date").first()

Changed. This was intentional (ie only the latest status which must also be active is used) but happy to change it.

rjsparks · 2024-07-15T16:50:39Z

ietf/status/views.py

+    if status.slug is None:
+        raise FieldError("No slug generated. This shouldn't happen.")


Not sure this is a valid use of FieldError. In any case there's nothing to catch this, so it would result in a 500 being served.

It would be better to make the slug a required and unique field in the model with null=False, blank-False, unique=True, with and let the ORM ensure it will never be empty,

rjsparks · 2024-07-15T16:51:46Z

ietf/status/views.py

+        "body": status.body,
+        "url": f"/status/{status.slug}",
+        "date": status.date.isoformat(),
+        "by": status.by.name,


by seems to be inconsistently used? The admin could default it to the logged in user, but maybe we should remove it from the model?

I've removed it from the templates / API response, but kept it in the model for auditing purposes. Happy to remove it if you'd prefer though.

rjsparks · 2024-07-15T16:59:08Z

ietf/templates/status/status.html

+    <h1 data-status-id="{{ status.id }}">
+        {% block title %} {{ status.title }} {% endblock %}
+    </h1>
+    <div>


Since the view that uses this will let you look at inactive slugs, it would be good to put something in the template that warns if the status is no longer active.

Good idea. I've added a Bootstrap 'badge' to the <h1> saying "inactive"... thoughts?

holloway · 2024-07-17T20:18:11Z

@rjsparks @NGPixel ready for review again

jennifer-richards · 2024-07-24T02:12:50Z

I think the failing URL test is caused by not covering the api/v1/(?P<api_name>status)/ endpoint

jennifer-richards

This is looking good. I have a few minor comments / change requests.

jennifer-richards · 2024-07-24T17:06:49Z

ietf/status/views.py

+    })
+
+def status_latest_json(request):
+    return HttpResponse(json.dumps(get_context_data()), status=200, content_type='application/json')


There's a JsonResponse that might be more appropriate here

ietf/status/tests.py

ietf/status/views.py

ietf/utils/test_runner.py

jennifer-richards

lgtm. Only nit I'm noticing (which I should have noticed before) is that we have copyright year ranges going back to 2016 or 2017 on newly added files. In some cases maybe this is appropriate if it's copied code, but I have generally started with only the current year in a new file if it's only standard boilerplate carried over from other places.

Don't know if we're consistent enough about this for it to be worthwhile to change (or if it's even appropriate).

…into feat/status-message

holloway · 2024-07-30T02:28:37Z

@jennifer-richards i've updated the ©

Noting change was made on Nick's behalf

Matthew Holloway added 5 commits June 21, 2024 10:30

Status WIP

d03fd2e

feat: Status

933f0be

Merge branch 'main' into status-message

04ab0ba

fix: Status tests

175aea5

feat: status redirect

6408b65

holloway temporarily deployed to sandbox July 10, 2024 05:56 — with GitHub Actions Inactive

Matthew Holloway added 2 commits July 11, 2024 10:05

chore: Status tests

4f47554

chore: Status tests

cd5f9ae

holloway requested a review from rjsparks July 11, 2024 07:04

rjsparks reviewed Jul 11, 2024

View reviewed changes

Matthew Holloway added 2 commits July 12, 2024 09:17

feat: Status tests

1a338bb

chore: Status playwright tests

d6b2eee

NGPixel reviewed Jul 15, 2024

View reviewed changes

client/components/Status.vue

Copy link

Member

NGPixel Jul 15, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Various uses of semi-colons. Remove all.

holloway reacted with thumbs up emoji

NGPixel previously requested changes Jul 15, 2024

View reviewed changes

rjsparks reviewed Jul 15, 2024

View reviewed changes

rjsparks requested changes Jul 15, 2024

View reviewed changes

Matthew Holloway added 3 commits July 16, 2024 05:26

fix: PR feedback, mostly Vue and copyright dates

7e98341

fix: Status model migration tidy up

5c10968

chore: Status - one migration

42ed840

holloway marked this pull request as ready for review July 17, 2024 20:19

Matthew Holloway added 3 commits July 22, 2024 10:19

feat: status on doc/html pages

5bc8145

chore: merging main. Resolving conflict in ietf.scss

174fdd8

chore: Resetting Status migration

7a0c02b

rjsparks requested a review from jennifer-richards July 23, 2024 16:50

jennifer-richards requested changes Jul 24, 2024

View reviewed changes

feat: Site Status PR feedback. URL coverage debugging

93c986e

jennifer-richards reviewed Jul 25, 2024

View reviewed changes

ietf/status/views.py Outdated Show resolved Hide resolved

jennifer-richards reviewed Jul 25, 2024

View reviewed changes

ietf/utils/test_runner.py Outdated Show resolved Hide resolved

holloway added 3 commits July 26, 2024 10:46

Adding ietf.status to Tastypie omitted apps

7368ae1

feat: Site Status PR feedback

09c87c0

Merge branch 'main' into feat/status-message

9db7147

holloway requested a review from jennifer-richards July 26, 2024 03:00

jennifer-richards previously approved these changes Jul 26, 2024

View reviewed changes

holloway added 2 commits July 30, 2024 14:26

chore: correct copyright year on newly created files

93eb0f0

Merge branch 'feat/status-message' of gh-ietf:ietf-tools/datatracker …

2c9c897

…into feat/status-message

holloway dismissed jennifer-richards’s stale review via 2c9c897 July 30, 2024 02:28

jennifer-richards previously approved these changes Jul 30, 2024

View reviewed changes

rjsparks previously approved these changes Aug 1, 2024

View reviewed changes

Merge branch 'main' into feat/status-message

dfa3732

Merge remote-tracking branch 'ietf-tools/main' into feat/status-message

b21661c

rjsparks dismissed stale reviews from jennifer-richards and themself via b21661c August 7, 2024 15:47

rjsparks added 4 commits August 7, 2024 10:58

chore: repair merge damage

04cef0f

Merge branch 'main' into feat/status-message

a7e627f

chore: repair more merge damage

de8a991

fix: reconcile the api init refactor with ignoring apps

e7ef7f2

rjsparks approved these changes Aug 7, 2024

View reviewed changes

rjsparks merged commit e5e6c9b into main Aug 7, 2024
7 checks passed

rjsparks deleted the feat/status-message branch August 9, 2024 14:19

github-actions bot locked as resolved and limited conversation to collaborators Aug 13, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Site status message #7659

feat: Site status message #7659

holloway commented Jul 10, 2024 •

edited

Loading

rjsparks Jul 11, 2024

holloway commented Jul 15, 2024

NGPixel Jul 15, 2024

NGPixel Jul 15, 2024

NGPixel Jul 15, 2024

NGPixel Jul 15, 2024

NGPixel Jul 15, 2024

rjsparks Jul 15, 2024

rjsparks Jul 15, 2024

rjsparks Jul 15, 2024

richsalz commented Jul 15, 2024

rjsparks commented Jul 15, 2024

rjsparks left a comment

rjsparks Jul 15, 2024

holloway Jul 16, 2024

rjsparks Jul 15, 2024

rjsparks Jul 15, 2024

holloway Jul 16, 2024

rjsparks Jul 15, 2024

holloway Jul 16, 2024 •

edited

Loading

rjsparks Jul 16, 2024

holloway commented Jul 17, 2024

jennifer-richards commented Jul 24, 2024

jennifer-richards left a comment

jennifer-richards Jul 24, 2024

jennifer-richards left a comment

holloway commented Jul 30, 2024

		@@ -0,0 +1,22 @@
		# Copyright The IETF Trust 2017-2020, All Rights Reserved

		@@ -0,0 +1,48 @@
		# Generated by Django 4.2.13 on 2024-06-24 04:24

		if status.slug is None:
		raise FieldError("No slug generated. This shouldn't happen.")

feat: Site status message #7659

feat: Site status message #7659

Conversation

holloway commented Jul 10, 2024 • edited Loading

Choose a reason for hiding this comment

holloway commented Jul 15, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

richsalz commented Jul 15, 2024

rjsparks commented Jul 15, 2024

rjsparks left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

holloway Jul 16, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

holloway commented Jul 17, 2024

jennifer-richards commented Jul 24, 2024

jennifer-richards left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jennifer-richards left a comment

Choose a reason for hiding this comment

holloway commented Jul 30, 2024

holloway commented Jul 10, 2024 •

edited

Loading

holloway Jul 16, 2024 •

edited

Loading