upgrade to Keycloakify 11

[fhennig]

resolves #3264

preview URL: http://keycloakify-upgrade-try-a.loculus.org

Summary

The old keycloakify 9 theme was replaced by a rewrite based on keycloakify 11 (this was the recommended upgrade path). All features of the old theme were copied over. Also, the new theme uses an env var to set the project name, replacing the old email texts that simply omitted the realm name.

Screenshot

PR Checklist

• All necessary documentation has been adapted.
• The implemented feature is covered by an appropriate test.

[fhennig]

In 5e0c509 I'm applying the fix from @theosanderson from this PR: #3271

Weird that this just happens 'out-of-the-box' with the starter. Thanks again to @theosanderson for finding this!

[fhennig]

It's working in the preview! 🥳

[corneliusroemer]

After I found the root cause of the CI failure (wrong casing of kcContext that didn't show on macOS due to file system casing insensitivity) I wanted to report the issue to keycloakify but it turns out that the casing isn't in the starter: https://github.com/keycloakify/keycloakify-starter/blob/main/src/login/KcContext.ts

@fhennig how did you create the starter? Did you maybe not copy it over manually somehow rather than a complete removal over folder and replacement with current starter?

As a result, the fix is easier than Theo's which just happened to fix casing as well but the types extension was unnecessary.

[fhennig]

What I did before was clone into keycloakify-starter, mv keycloakify keycloakify9 and mv keycloakify-starter keycloakify. I have no idea why the file was lowercase :O Well spotted! I thought I actually checked that as well, oh well.

I pushed the change now! It's actually good, because there is kc.gen.tsx which gets regenerated if the theme name changes and it contains a reference to KcContext, so it's nice that the file will be generated with the correct name.

Wow I feel stupid now 🤦 😅

[theosanderson]

The file was named wrongly on main by me in the old version – now that it occurs to me I think I have dim memories of that. Some original eslint thing was giving me warnings and I briefly tried to fix them and then gave up or something

[corneliusroemer]

You weren't stupid at all @fhennig - you actually did everything right and macOS (and git) played a trick on us! This is just something we need to remember can happen 🤷

[corneliusroemer]

I've now added the keycloak update to 26, might as well test it with that.

[corneliusroemer]

It's super confusing that version 26 is more like version 21 than 22-25 here: keycloakify/keycloakify#731

[fhennig]

Still WIP:

• The "Update user profile" page that you get to after signup with ORCID doesn't have the tickbox yet.
• use the env var again for the Text for the checkbox
• optional: add an env var where a "realm name" can be set, so we can display something that makes it clear we're still on loculus/pathoplexus

[fhennig]

I think some docs might be missing still, but I think the new theme is feature-complete now! (oh and I didn't delete the kc9 theme yet)

[fhennig]

I tried registering with KC in the preview and get an email, but I think no email arrived.

[theosanderson]

I tried registering with KC in the preview and get an email, but I think no email arrived.

I just tried and seemed to see the same. I tried an unrelated preview (https://profile-get-seqs.loculus.org/) and registration was fine, so that seems like a problem

[fhennig]

Alright so I just removed the e-mail theme and then I got an email when registering. (EDIT: I have removed the commit now that did this)

[fhennig]

Maybe I shouldn't have deleted the theme.properties 😆 I'll see if that maybe was the issue.

When initializing the theme it says:

The src/email directory have been created.
You can delete any file you don't modify.

But in the docs it says that the theme.properties are needed to specify the base theme:

You can remove all the template and resource file you aren't going to customize (it will fallback to the default email theme as long as you keep a theme.properties with parent=base). [source]

[theosanderson]

I changed something (elsewhere) so the ORCiD flows now work - and they lgtm

[fhennig]

Found what I did wrong, I'll have a fix in a bit.

[fhennig]

I got an email now!

[theosanderson]

Thanks this looks nice! It's the sort of thing that is pretty hard to review confidently for code, but I've tested the functionality in various ways and things seem good!

[fhennig]

great! I have also updated the kc26 branch here: #3299 and it also looked good there! 🥳

[corneliusroemer]

I also tested stuff yesterday, got an email and looked good, with my Keycloak 26 changes on top (before they were added).

Deploying KC26 together with keycloakify 11 is a bit of a risk as we can't roll back keycloakify anymore. So prudently we'd deploy keycloakify first but considering it's unlikely we need to roll back keycloakify 11 this is ok.

Just pointing out the tradeoff.

[corneliusroemer]

If we use storybook we should test it in CI so we can upgrade without surprises. I.e. don't revert this

[fhennig]

build-storybook doesn't exist anymore, and there isn't a replacement AFAIK