Temporary page while tljh is building

[GeorgianaElena]

This shows a temporary page while tljh is building, that looks like this:

A few things to consider:

• There will be a "down" period between when this page stops showing and JupyterHub starts, because we have to free up the port for traefik.
• The /logs page has to be manually refreshed to update the logs
• The main page gets refreshed every 30s so that when JH starts, the login page will be shown instead

TODO

• Add / update documentation
• Add / update tests

Closes #70

[yuvipanda]

This is amazing work, @GeorgianaElena! \o/ Absolutely awesome, thank you for picking this up.

The pid file is mostly used to just pass the pid of the running server from the bootstrapper to the installer, right? If so, can you pass it as a parameter to the installer, via https://github.com/jupyterhub/the-littlest-jupyterhub/pull/605/files#diff-3246cd4be92bfdc6105293969b81c0d9L177 or similar, instead of using a file to communicate? Probably simpler.

I also wonder if this should be behind password protection, in case the logs have sensitive information?

We should also put this behind a flag, so we can turn it on / off as we wish.

Either way, amazing work. Look forward to merging this :)

[GeorgianaElena]

Thanks for the feedback @yuvipanda :)
I addressed all of the suggestions, except for the password one.

I also wonder if this should be behind password protection, in case the logs have sensitive information?

There shouldn't be anything sensitive in the logs, sice we're only logging generic messages at each step. I think there might be some in case errors occur, but those go only to stderr and are not stored into installer.log.

But if we decide to password protect the temporary page, maybe one way would be to use the user and password of the first tljh admin user, that are passed to the bootstrap script.

What do you think?

[yuvipanda]

A bunch more comments! This is looking good :)

In general, I think calling this 'install progress page' or some such might be more descriptive than 'temporary page'. What do you think?

Excited to get this going :)

[yuvipanda]

But if we decide to password protect the temporary page, maybe one way would be to use the user and password of the first tljh admin user, that are passed to the bootstrap script.

Yep, that's the way to do it I think! But we can add that as a separate PR, not necessarily part of this one.

[yuvipanda]

what kinda tests do you think we should add to this?

[GeorgianaElena]

I added a test in test_bootrap.py that checks if there is something at /index.html while tljh is building and that the same path returns a 404 once jupyterhub starts.

Do you think this is a good enough test @yuvipanda?

[yuvipanda]

Things look good to me, @GeorgianaElena! I left some minor questions. Once we get the tests to pass this can be merged! \o/

[GeorgianaElena]

Tests are now passing @yuvipanda, if you want to take another look 🎉

[yuvipanda]

The upgrade test is failing thanks to jupyterlab again, so I'm just going to merge this.

AWESOME WORK, @GeorgianaElena! \o/