Add customizable announcement text on home,login,logout,spawn #1913

rkdarst · 2018-05-22T18:44:42Z

Using the new template_vars setting (Allow extra variables to be passed into templates #1872), allow the variable
announcement to create a header message on all the pages in the
title, or the variables announcement_{home,login,logout,spawn} to
set variables on these single pages.
This is not the most powerful method of putting an announcement into
the templates, because it requires a server restart to change. But
the invasiveness is very low, and allows minimal message
without having to touch the templates themselves.
Closes: Add short announcement text in templates #1836

Usage:

c.JupyterHub.template_vars = {'announcement_spawn': 'this is a message',
                              'announcement': 'blah'}

This at least needs testing and documentation before it can be used. More importantly, needs consideration if it is a good idea. Also some designer could make it prettier and fit better. This idea could be in other places in the spirit of "make the default templates more customizable".

My big picture opinion is that this, or something like it, would be useful to include, but if people start going deep enough they would instead directly modify templates to do this. https://jupyterhub.readthedocs.io/en/latest/reference/templates.html#example is the alternative and I think it is clear enough now.

minrk · 2018-05-23T07:24:18Z

share/jupyterhub/templates/home.html

@@ -2,6 +2,13 @@

 {% block main %}

+{% if announcement_home or announcement %}


Since this is on every page, perhaps it should be put in the page.html template? I'm not 100% sure how to specify the extra variables, but perhaps:

{% if announcement_home %} {% set announcement = announcement_home %} {% endif %} {{ super() }}

would work

Nice idea. I was able to simplify a bit more even and it seems to work (pending tests). Another advantage is that there is now an announcement block which can be inherited separately in other templates - so that option (0) using your own templates becomes even easier. Option (0) should also allow you to easily change the message without restarting!

rkdarst · 2018-05-23T12:34:21Z

I think (untested) these latest changes should allow you to do the following, which is probably the easiest way to set a simple message using a template:

{% extends "page.html" %}
{% set announcement = "this is some custom local announcement"%}

Before I go forward too much more, does this look good?

minrk · 2018-05-25T08:10:36Z

share/jupyterhub/templates/page.html

+
+{% block announcement %}
+{% if announcement %}
+<div class="container text-center">


Can this get the class 'announcement', too, for easier CSS? Then I think this is good to go.

rkdarst · 2018-05-25T09:48:40Z

I updated the PR. I started some tests (using the framework in test_pages.py), but am having trouble making the tests actually work (the get_page() function not doing what I expect). Should I forget them, or push and you can comment on what is wrong?

rkdarst · 2018-05-25T09:50:45Z

Oh, also let me add documentation first... obviously.

minrk

Approved, pending docs. Thanks!

rkdarst · 2018-05-27T14:50:51Z

Re-pushed. The second commit adds tests, but the tests just don't work - I'm not doing the HTTP simulation correctly somehow. If you have hints, I can fix them, or I can just remove the tests.

minrk · 2018-05-29T09:24:25Z

jupyterhub/tests/test_pages.py

+    ann01 = 'ANNOUNCE01'
+    ann02 = 'ANNOUNCE02'
+    with mock.patch.dict(app.users.settings,
+                         {'template_vars': {'announcement': ann01}}):


Add the FormSpawner to the patch so that requesting spawn renders the spawn page instead of triggering an automatic launch:

with mock.patch.dict( app.users.settings, { 'template_vars': { 'announcement': ann01, }, 'spawner_class': FormSpawner, } ):

Then I think your tests will pass.

- Using the new template_vars setting (jupyterhub#1872), allow the variable `announcement` to create a header message on all the pages in the title, or the variables `announcement_{home,login,logout,spawn}` to set variables on these single pages. - This is not the most powerful method of putting an announcement into the templates, because it requires a server restart to change. But the invasiveness is very low, and allows minimal message without having to touch the templates themselves. - Closes: jupyterhub#1836

- Adds test_pages.py:test_page_contents, which currently tests just the page annoucement variables.

rkdarst · 2018-06-02T22:31:19Z

Finally got around to making the tests pass. It's a relatively large number of lines for a small change, but maybe this block can be reused for other template tests, too.

Please also see if the docs updates are good - it's late and I should check them once more...

willingc

Looks good @rkdarst. A suggestion on docs and tests. Thank you ☀️

willingc · 2018-06-03T00:14:20Z

share/jupyterhub/templates/home.html

@@ -1,4 +1,5 @@
 {% extends "page.html" %}
+{% if announcement_home %}{% set announcement = announcement_home %}{% endif %}


A bit easier to read if these are broken into 3 lines.

willingc · 2018-06-03T00:19:09Z

jupyterhub/tests/test_pages.py

+
+
+@pytest.mark.gen_test
+def test_page_contents(app):


Probably more maintainable to break this into multiple tests.

willingc · 2018-06-03T00:27:24Z

docs/source/reference/templates.md

@@ -59,3 +59,33 @@ text about the server starting up, place this content in a file named
 <p>Patience is a virtue.</p>
 {% endblock %}
 ```
+
+## Simple configuration


## Page Announcements To add announcements to be displayed on a page, you have two options: - Extend the page templates as described above - Use configuration variables ### Announcement Configuration Variables

for readability per review by willingc

per willingc review

minrk · 2018-06-12T12:14:18Z

@willingc thanks for the review! I added some changes to address it.

@rkdarst thanks! This is going to probably be the last code change for 0.9.

willingc · 2018-06-12T14:47:32Z

Thanks @rkdarst for all your work on this 🎉

rkdarst · 2018-06-12T20:56:29Z

Thanks, all! I'm sorry I didn't get back to fixing up the patch - my work took me on a different path the last weeks and I didn't have time to think much. I have another JupyterHub deployment this summer, so hopefully I can do more then... Congrats on 0.9 and thanks for all the hard work!

willingc · 2018-06-12T20:59:10Z

Thanks you @rkdarst. Your effort got us 90% there ☀️

minrk reviewed May 23, 2018

View reviewed changes

rkdarst force-pushed the announcement_text branch from aee0227 to e1579e6 Compare May 23, 2018 12:26

minrk reviewed May 25, 2018

View reviewed changes

rkdarst force-pushed the announcement_text branch from e1579e6 to aa47e13 Compare May 25, 2018 08:51

minrk approved these changes May 25, 2018

View reviewed changes

rkdarst force-pushed the announcement_text branch from aa47e13 to a2f0c6a Compare May 27, 2018 14:48

minrk reviewed May 29, 2018

View reviewed changes

rkdarst added 2 commits June 3, 2018 01:18

Add tests of page announcements

e7808b5

- Adds test_pages.py:test_page_contents, which currently tests just the page annoucement variables.

rkdarst force-pushed the announcement_text branch from a2f0c6a to e7808b5 Compare June 2, 2018 22:19

willingc reviewed Jun 3, 2018

View reviewed changes

minrk added 3 commits June 12, 2018 13:47

parametrize test_announcements

5f91ed0

multiline conditionals setting announcement variable in templates

d226269

for readability per review by willingc

announcement doc language

5e93c7d

per willingc review

minrk merged commit aa9676e into jupyterhub:master Jun 12, 2018

rkdarst deleted the announcement_text branch December 4, 2018 21:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add customizable announcement text on home,login,logout,spawn #1913

Add customizable announcement text on home,login,logout,spawn #1913

rkdarst commented May 22, 2018

minrk May 23, 2018

rkdarst May 23, 2018

rkdarst commented May 23, 2018

minrk May 25, 2018

rkdarst commented May 25, 2018

rkdarst commented May 25, 2018

minrk left a comment

rkdarst commented May 27, 2018

minrk May 29, 2018

rkdarst commented Jun 2, 2018

willingc left a comment

willingc Jun 3, 2018

willingc Jun 3, 2018

willingc Jun 3, 2018

minrk commented Jun 12, 2018

willingc commented Jun 12, 2018

rkdarst commented Jun 12, 2018 via email

willingc commented Jun 12, 2018

		@@ -2,6 +2,13 @@

		{% block main %}

		{% if announcement_home or announcement %}

		@@ -1,4 +1,5 @@
		{% extends "page.html" %}
		{% if announcement_home %}{% set announcement = announcement_home %}{% endif %}



		@pytest.mark.gen_test
		def test_page_contents(app):

Add customizable announcement text on home,login,logout,spawn #1913

Add customizable announcement text on home,login,logout,spawn #1913

Conversation

rkdarst commented May 22, 2018

minrk May 23, 2018

Choose a reason for hiding this comment

rkdarst May 23, 2018

Choose a reason for hiding this comment

rkdarst commented May 23, 2018

minrk May 25, 2018

Choose a reason for hiding this comment

rkdarst commented May 25, 2018

rkdarst commented May 25, 2018

minrk left a comment

Choose a reason for hiding this comment

rkdarst commented May 27, 2018

minrk May 29, 2018

Choose a reason for hiding this comment

rkdarst commented Jun 2, 2018

willingc left a comment

Choose a reason for hiding this comment

willingc Jun 3, 2018

Choose a reason for hiding this comment

willingc Jun 3, 2018

Choose a reason for hiding this comment

willingc Jun 3, 2018

Choose a reason for hiding this comment

minrk commented Jun 12, 2018

willingc commented Jun 12, 2018

rkdarst commented Jun 12, 2018 via email

willingc commented Jun 12, 2018