Fix register fails on channles requests. #137

[shmoon-kr]

Fixed register mutation not working in channels environment. Instead of the get_current_site() function, we implemented it by getting the required values from the request.headers object and the request.consumer.scope object and returning them. There are a few things that need to be reviewed.

1. the content of the request object has changed - this is included in the context used when rendering html mail. If they want to include the contents of the request in the email, they will need to customize it.
2. I've tested and found that the site_name and domain returned by get_mail_context() actually contain the same values, so it should work the same in a channels environment. However, if your site_name and domain are different, you may run into issues.
3. I used the port number by parsing request.header["host"]. if the request.header contains anything other than a valid "host:port" form of the value, an error may occur.

[gqlauth]

Release Notes

Just wanted to say

Release type: patch

Fix register fails on channels requests. #137
Do not call get_current_site() from get_email_context()
Extract values from channels context.

[codecov]

Codecov Report

Attention: Patch coverage is 66.66667% with 4 lines in your changes are missing coverage. Please review.

Project coverage is 92.93%. Comparing base (9c760b6) to head (7f26b06).
Report is 24 commits behind head on main.

Files	Patch %	Lines
gqlauth/models.py	66.66%	4 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #519      +/-   ##
==========================================
+ Coverage   92.82%   92.93%   +0.10%     
==========================================
  Files          33       33              
  Lines        1478     1501      +23     
==========================================
+ Hits         1372     1395      +23     
  Misses        106      106              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[nrbnlulu]

Thanks for the PR, left some notes...

Also please add tests

[nrbnlulu]

try to do something like

is_channels = isinstance(info.context, dict)

if is_channels:
	domain, port =  request.headers["host"].split(":")
else:
	domain = site.domain
	# yada yada
return {
	"domain" domain,
	# yada yada

[shmoon-kr]

I've been trying to write test code, but I'm not sure how to do it. I've thought of two ways to do it

1. run the schema.execute() function in the channels context: I haven't seen this done, if you know how, please let me know.

2. create a UserStatus object and then call the get_mail_context() function: I think it would be something similar to the code below, but I'm not sure how to make the parameter, do you have any ideas?

from strawberry.types.info import Info
from gqlauth.models import UserStatus
from where import User

info = Info(_raw_info="How can I make this?", _field="Is there any example?")

user = User.objects.create(blahblah)
user_status = UserStatus.objects.create(blahblah)
context = user_status.get_email_context(info=info, path=path, action=what)

assert context['domain'] == 'test.com' and context['port'] == '8000'

[nrbnlulu]

that's a tuple 🙃

[shmoon-kr]

I don't think protocol was originally a tuple, is it really a tuple? It's confusing.

[nrbnlulu]

No it wasn't. but you what you wrote is a tuple
("https" if request.is_secure() else "http",)
`

Suggested change

	protocol = ("https" if request.is_secure() else "http",)
	protocol = "https" if request.is_secure() else "http"

[shmoon-kr]

It seems to have been automatically fixed by [pre-commit-ci[bot]. I'd like you to take a look at this bot.

[nrbnlulu]

run the schema.execute() function in the channels context: I haven't seen this done, if you know how, please let me know.

You can try to use the tests consumer

strawberry-django-auth/tests/test_middlewares.py

Line 13 in 7100175

db_verified_user_status, verified_channels_app_communicator

BTW TBH I am not sure that you should use channels for mutation / queries... Do you have any reason to do so?

[shmoon-kr]

Following your suggestion, I wrote a test code to call register mutation in channels context using verified_user_status_type and verified_channels_app_communicator. However, it seems to fail to run. The strange thing is that result.data["register"]["success"] is False, but result.errors is None when I print it out. When I ran the same code in sync context, it worked fine, but this doesn't cover the newly added code. Do you have any ideas on how to fix this?

[nrbnlulu]

I'll try to run it myself later 🤞

[shmoon-kr]

The problem is that it's trying to register a new user, and the username and phone_number already exist. So I fixed it, however, it doesn't seem to cover the newly added code still. I've republished the PR, so please review it.

[nrbnlulu]

Generally I accept the changes though I want to test this manually because the consumer is having problems ATM.

[nrbnlulu]

You don't need a verified consumer here I think

[shmoon-kr]

You're right, I replaced it with unverified_channels_app_communicator, as it doesn't require authentication when registering.