Configuration error

[AlexMorra]

According to the introduction section, an error occurs when launching the application (make run):

But if you import BackendAuthentication, RefreshAuthentication directly into the simple_jwt method, it will start.

dependencies:
python=3.11
uvicorn=0.30.6
esmerald=3.4.1
esmerald-simple-jwt=0.2.0

[tarsil]

@AlexMorra thank you for reporting this. I find this odd. In your make run, are you exposing the ESMERALD_MODULE_SETTINGS to the Dev one?

[tarsil]

Can you provide more details how you setup your configs here, please? Just to replicate and address this.

[AlexMorra]

Yes, of course. The default configuration from directives

esmerald createproject esmerald_auth
esmerald createapp accounts

then everything is according to the section Introduction.

I can share an example project if it would be an easier way to show it.

[tarsil]

Yes, of course. The default configuration from directives

esmerald createproject esmerald_auth esmerald createapp accounts

then everything is according to the section Introduction.

I can share an example project if it would be an easier way to show it.

That would be great. This way I can debug it and find the root cause

[AlexMorra]

here is an example, I used make run
https://github.com/AlexMorra/esmerald_auth_example

[tarsil]

Thank you, allow us some time to investigate and come back to you

[AlexMorra]

@tarsil
hi, is there any news or is the library not relevant?

[tarsil]

@AlexMorra apologies as I got stuck in a few things in the last couple of months. The library is pretty much relevant as I'm actively using it as well. I will come back to you as soon as possible. Apologies for taking so long

[tarsil]

@AlexMorra after checking and testing your code, you actually did everything correctly and there is something I need to update in the library (also needs some internal updates anyway, but more requirements). This is due to the esmerald_simple_jwt imports that you had commented there were correct in the AppSettings. So basically that bit I need to update and the docs as well.

In the configs/settings.py

@property
    def simple_jwt(self) -> SimpleJWT:

        from esmerald_auth.apps.accounts.backends import (
            BackendAuthentication,
            RefreshAuthentication,
        )

        return SimpleJWT(
            signing_key=self.secret_key,
            backend_authentication=BackendAuthentication,
            backend_refresh=RefreshAuthentication,
        )

This shouldn't impact anything anyway and the reason for it its because its only done once on the up running. Hence also not updating this bit (not sure if the docs actually mention this but I assume not or else this wouldn't be an issue).

If you import like you were doing before, that will work. I will try to rework the internals for the future releases but again, this is not performance issue by doing like this.

Another thing I noticed. In the Makefile you can change the run to:

.PHONY: run
run: ## Starts the local server with production settings
	ESMERALD_SETTINGS_MODULE=esmerald_auth.configs.development.settings.DevelopmentAppSettings esmerald runserver -p 8009

I would also strongly advise you to use the latest Esmerald as well. There was a lot of cleaning and nice features that came out. For instance the auto generated Makefile is no longer supported but instead its the taskfile along other new things that came out in the meantime.

Apologies for taking so long but you can do as we discussed here and I will also update the next release and docs as it can be misleading.

Thank you for reporting this.

[AlexMorra]

@tarsil Thanks a lot, I got it!
It would be nice to have an authentication section in emerald docs in the future.