Prevent ftl errors in Keycloak log

[garronej]

Follow-up of #63

This PR publishes beta releases.

It won't make it into main until this is achieved.

If you want to contribute, thank you and submit your PRs to the branch doge_ftl_errors rather than to main.

[marziman]

Thanks @garronej you are awesome mate!
In case someone tries to avoid the error logs in Keycloackify v2, he shall follow the guide below from @garronej .

[garronej]

Hi @marziman,

There is almost no breaking changes between v2 and v4.

You need to install the peer dependencies required: yarn add keycloakify @emotion/react tss-react powerhooks
Install powerhooks and update tss-react to the current version. You are locked on v0.X.X.

There is also useKcMessages that is a bit different.

And finally if you have some missing pages in your KcApp.tsx that are new and you don't have, add them.

If you want up to date examples you have the two template repos and the code of the login of our platform.

[Ann2827]

@garronej Hi! In the meantime, I tried to sort through the object only by known keys. It works. But it looks like over engineering. ftl template Some types are missing in the search. But I'll probably stop developing this idea.

[garronej]

Hello @Ann2827 thanks for your effort.
I rewrote the whole thing yesterday. It now works fast and without logging errors, it prints out well-formatted JS and it's much better FreeMarker code overall🍾

The big breakthrough was the realization that using foo.bar?? we can test if a property is dereferencable without throwing if it isn't.
I only tested with login.ftl but there are still some properties that throw when dereferenced.
Namely url. loginUpdatePasswordUrl, url. loginUpdateProfileUrl, url.loginUsernameReminderUrl and url.loginUpdateTotpUrl.
I did what I suggested about them, I implemented a blacklist so that these properties can be skipped. I allowed myself to do that because it's never used in the base theme but I suspect it won’t throw in all conditions, sometimes these value might be needed.
I would like to avoid logging error as much as possible but I'd rather log inconsequential error that potentially preventing some use case from being implemented. I am going to see with the Keycloak team about that.

[garronej]

@Ann2827 A new beta have been released if you want to try it out.

[Ann2827]

@garronej

I will definitely try the new version tomorrow.
On register.ftl template, you may encounter a problem with auth.attemptedUsername . And this is already bad. If keys: loginUpdatePasswordUrl , loginUpdateProfileUrl , loginUsernameReminderUrl and loginUpdateTotpUrl are not used anywhere, then key attemptedUsername is used on login-reset-password.ftl template. But if you try to get the value by key auth.attemptedUsername on login.ftl and login-reset-password.ftl templates (I didn't check the other templates), then you won't get an error.

On login-update-profile template, you may encounter a problem with updateProfileCtx object. And for saml-post-form.ftl template it will be an error to get the value by key url.loginAction.

Perhaps Keycloak will be able to return only those values that Freemarker templates will be able to read without errors? For example null. FreeMarker can check foo.bar?? or foo.bar!"" if the value cannot be obtained. But FreeMarker can't read extended_hash+string.

[garronej]

@Ann2827 Thank you for your investigation! I added special cases for the cases you mentioned.
I will create special cases like this whenever a new ftl error is reported to me.

I will merge this now a publish a new release.

I have updated the readme to encourage users to report errors that they would spot:

[garronej]

4.2.14 is out.