Skip to content

Fixes integration with django rest framework where session token modifications were being missed out. #486

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Apr 26, 2024

Conversation

rishabhpoddar
Copy link
Contributor

@rishabhpoddar rishabhpoddar commented Apr 25, 2024

Summary of change

In Django rest framework, the request object given to the API is a wrapper around the actual request object. This in turn causes an issue wherein if the session tokens are modified in the API, they do not get set in the response since the SuperTokens middleware reads from the orignal request, and not the wrapped around request.

To fix this, we set the session object not just in the wrapper request, but also in the original request, which we can fetch from the wrapped request.

Test Plan

Added integration tests with Django rest framework similar to how there exists for just Django (without rest framework)

Checklist for important updates

  • Changelog has been updated
  • coreDriverInterfaceSupported.json file has been updated (if needed)
    • Along with the associated array in supertokens_python/constants.py
  • frontendDriverInterfaceSupported.json file has been updated (if needed)
  • Changes to the version if needed
    • In setup.py
    • In supertokens_python/constants.py
  • Had installed and ran the pre-commit hook
  • Issue this PR against the latest non released version branch.
    • To know which one it is, run find the latest released tag (git tag) in the format vX.Y.Z, and then find the latest branch (git branch --all) whose X.Y is greater than the latest released tag.
    • If no such branch exists, then create one from the latest released branch.
  • If have added a new web framework, update the supertokens_python/utils.py file to include that in the FRAMEWORKS variable
  • If added a new recipe that has a User type with extra info, then be sure to change the User type in supertokens_python/types.py
  • Make sure that syncio / asyncio functions are consistent.
  • If access token structure has changed
    • Modified test in tests/sessions/test_access_token_version.py to account for any new claims that are optional or omitted by the core

Remaining TODOs for this PR

  • Add new integration test and modify CICD to make it run.
  • Make sure that the integration test fails if the fix is not done in the code.
  • Make sure that the example app (my-app) works now and calling sessionInfo endpoint sends back new tokens
    • cookie based auth
    • header based auth

@rishabhpoddar rishabhpoddar marked this pull request as draft April 25, 2024 21:03
@sattvikc sattvikc self-assigned this Apr 26, 2024
@rishabhpoddar rishabhpoddar marked this pull request as ready for review April 26, 2024 17:15
@rishabhpoddar rishabhpoddar merged commit f2eeaa5 into 0.18 Apr 26, 2024
@rishabhpoddar rishabhpoddar deleted the django-rest-framework-fix-for-middleware branch April 26, 2024 17:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants