Merge branch '0.10' into fix-multiple-h1-issue

Author: st-jay

.circleci/config_continue.yml

@@ -59,6 +59,18 @@ jobs:
       - run: make with-django
       - run: (cd .circleci/ && ./websiteDjango.sh)
       - slack/status
+  test-website-django2x:
+    docker:
+      - image: rishabhpoddar/supertokens_python_driver_testing
+    resource_class: large
+    steps:
+      - checkout
+      - run: update-alternatives --install "/usr/bin/java" "java" "/usr/java/jdk-15.0.1/bin/java" 2
+      - run: update-alternatives --install "/usr/bin/javac" "javac" "/usr/java/jdk-15.0.1/bin/javac" 2
+      - run: echo "127.0.0.1 localhost.org" >> /etc/hosts
+      - run: make with-django2x
+      - run: (cd .circleci/ && ./websiteDjango2x.sh)
+      - slack/status
   test-authreact-fastapi:
     docker:
       - image: rishabhpoddar/supertokens_python_driver_testing
@@ -206,6 +218,16 @@ workflows:
               only: /dev-v[0-9]+(\.[0-9]+)*/
             branches:
               ignore: /.*/
+      - test-website-django2x:
+          requires:
+            - test-dev-tag-as-not-passed
+          context:
+            - slack-notification
+          filters:
+            tags:
+              only: /dev-v[0-9]+(\.[0-9]+)*/
+            branches:
+              ignore: /.*/
       - test-authreact-fastapi:
           requires:
             - test-dev-tag-as-not-passed
@@ -251,6 +273,7 @@ workflows:
             - test-website-fastapi
             - test-website-flask
             - test-website-django
+            - test-website-django2x
             - test-authreact-fastapi
             - test-authreact-flask
             - test-authreact-django

.circleci/setupAndTestWithFrontendWithDjango2x.sh

@@ -0,0 +1,76 @@
+coreInfo=`curl -s -X GET \
+"https://api.supertokens.io/0/core/latest?password=$SUPERTOKENS_API_KEY&planType=FREE&mode=DEV&version=$1" \
+-H 'api-version: 0'`
+if [[ `echo $coreInfo | jq .tag` == "null" ]]
+then
+    echo "fetching latest X.Y.Z version for core, X.Y version: $1, planType: FREE gave response: $coreInfo"
+    exit 1
+fi
+coreTag=$(echo $coreInfo | jq .tag | tr -d '"')
+coreVersion=$(echo $coreInfo | jq .version | tr -d '"')
+
+pluginInterfaceVersionXY=`curl -s -X GET \
+"https://api.supertokens.io/0/core/dependency/plugin-interface/latest?password=$SUPERTOKENS_API_KEY&planType=FREE&mode=DEV&version=$1" \
+-H 'api-version: 0'`
+if [[ `echo $pluginInterfaceVersionXY | jq .pluginInterface` == "null" ]]
+then
+    echo "fetching latest X.Y version for plugin-interface, given core X.Y version: $1, planType: FREE gave response: $pluginInterfaceVersionXY"
+    exit 1
+fi
+pluginInterfaceVersionXY=$(echo $pluginInterfaceVersionXY | jq .pluginInterface | tr -d '"')
+
+pluginInterfaceInfo=`curl -s -X GET \
+"https://api.supertokens.io/0/plugin-interface/latest?password=$SUPERTOKENS_API_KEY&planType=FREE&mode=DEV&version=$pluginInterfaceVersionXY" \
+-H 'api-version: 0'`
+if [[ `echo $pluginInterfaceInfo | jq .tag` == "null" ]]
+then
+    echo "fetching latest X.Y.Z version for plugin-interface, X.Y version: $pluginInterfaceVersionXY, planType: FREE gave response: $pluginInterfaceInfo"
+    exit 1
+fi
+pluginInterfaceTag=$(echo $pluginInterfaceInfo | jq .tag | tr -d '"')
+pluginInterfaceVersion=$(echo $pluginInterfaceInfo | jq .version | tr -d '"')
+
+echo "Testing with frontend website: $2, FREE core: $coreVersion, plugin-interface: $pluginInterfaceVersion"
+
+cd ../../
+git clone git@github.com:supertokens/supertokens-root.git
+cd supertokens-root
+echo -e "core,$1\nplugin-interface,$pluginInterfaceVersionXY" > modules.txt
+./loadModules --ssh
+cd supertokens-core
+git checkout $coreTag
+cd ../supertokens-plugin-interface
+git checkout $pluginInterfaceTag
+cd ../
+echo $SUPERTOKENS_API_KEY > apiPassword
+./utils/setupTestEnvLocal
+cd ../
+git clone git@github.com:supertokens/supertokens-website.git
+cd supertokens-website
+git checkout $2
+cd ../project/tests/frontendIntegration/django2x
+export PYTHONPATH="${PYTHONPATH}:/root/project"
+python3 manage.py runserver 8080 &
+pid=$!
+python3 manage.py runserver 8082 &
+pid2=$!
+cd ../../../../supertokens-website/test/server
+npm i -d  
+npm i git+https://github.com:supertokens/supertokens-node.git#$3  
+cd ../../
+npm i -d  
+SUPERTOKENS_CORE_TAG=$coreTag NODE_PORT=8081 INSTALL_PATH=../supertokens-root npm test
+if [[ $? -ne 0 ]]
+then
+    echo "test failed... killing $pid, $pid2 and exiting!"
+    kill -9 $pid
+    kill -9 $pid2
+    rm -rf ./test/server/node_modules/supertokens-node
+    git checkout HEAD -- ./test/server/package.json
+    exit 1
+fi
+echo "all tests passed, killing processes: $pid and $pid2"
+kill -9 $pid
+kill -9 $pid2
+rm -rf ./test/server/node_modules/supertokens-node
+git checkout HEAD -- ./test/server/package.json

.circleci/websiteDjango2x.sh

@@ -0,0 +1,117 @@
+coreDriverJson=`cat ../coreDriverInterfaceSupported.json`
+coreDriverLength=`echo $coreDriverJson | jq ".versions | length"`
+coreDriverArray=`echo $coreDriverJson | jq ".versions"`
+echo "got core driver relations"
+
+frontendDriverJson=`cat ../frontendDriverInterfaceSupported.json`
+frontendDriverLength=`echo $frontendDriverJson | jq ".versions | length"`
+frontendDriverArray=`echo $frontendDriverJson | jq ".versions"`
+echo "got frontend driver relations"
+
+# get driver version
+version=`cat ../setup.py | grep -e 'version='`
+while IFS='"' read -ra ADDR; do
+    counter=0
+    for i in "${ADDR[@]}"; do
+        if [ $counter == 1 ]
+        then
+            version=$i
+        fi
+        counter=$(($counter+1))
+    done
+done <<< "$version"
+
+someFrontendTestsRan=false
+i=0
+coreDriverVersion=`echo $coreDriverArray | jq ". | last"`
+coreDriverVersion=`echo $coreDriverVersion | tr -d '"'`
+coreFree=`curl -s -X GET \
+"https://api.supertokens.io/0/core-driver-interface/dependency/core/latest?password=$SUPERTOKENS_API_KEY&planType=FREE&mode=DEV&version=$coreDriverVersion" \
+-H 'api-version: 0'`
+if [[ `echo $coreFree | jq .core` == "null" ]]
+then
+    echo "fetching latest X.Y version for core given core-driver-interface X.Y version: $coreDriverVersion, planType: FREE gave response: $coreFree. Please make sure all relevant cores have been pushed."
+    exit 1
+fi
+coreFree=$(echo $coreFree | jq .core | tr -d '"')
+while [ $i -lt $frontendDriverLength ]; do
+    frontendDriverVersion=`echo $frontendDriverArray | jq ".[$i]"`
+    frontendDriverVersion=`echo $frontendDriverVersion | tr -d '"'`
+    i=$((i+1))
+
+    if [[ $frontendDriverVersion == '1.0' ]]; then
+        continue
+    fi
+
+    frontendVersionXY=`curl -s -X GET \
+    "https://api.supertokens.io/0/frontend-driver-interface/dependency/frontend/latest?password=$SUPERTOKENS_API_KEY&frontendName=website&mode=DEV&version=$frontendDriverVersion" \
+    -H 'api-version: 0'`
+    if [[ `echo $frontendVersionXY | jq .frontend` == "null" ]]
+    then
+        echo "fetching latest X.Y version for frontend given frontend-driver-interface X.Y version: $frontendDriverVersion, name: webiste gave response: $frontend. Please make sure all relevant versions have been pushed."
+        exit 1
+    fi
+    frontendVersionXY=$(echo $frontendVersionXY | jq .frontend | tr -d '"')
+
+    frontendInfo=`curl -s -X GET \
+    "https://api.supertokens.io/0/driver/latest?password=$SUPERTOKENS_API_KEY&mode=DEV&version=$frontendVersionXY&name=website" \
+    -H 'api-version: 0'`
+    if [[ `echo $frontendInfo | jq .tag` == "null" ]]
+    then
+        echo "fetching latest X.Y.Z version for frontend, X.Y version: $frontendVersionXY gave response: $frontendInfo"
+        exit 1
+    fi
+    frontendTag=$(echo $frontendInfo | jq .tag | tr -d '"')
+    frontendVersion=$(echo $frontendInfo | jq .version | tr -d '"')
+
+    nodeVersionXY=`curl -s -X GET \
+    "https://api.supertokens.io/0/frontend-driver-interface/dependency/driver/latest?password=$SUPERTOKENS_API_KEY&mode=DEV&version=$frontendDriverVersion&driverName=node" \
+    -H 'api-version: 0'`
+    if [[ `echo $nodeVersionXY | jq .driver` == "null" ]]
+    then
+        echo "fetching latest X.Y version for driver given frontend-driver-interface X.Y version: $frontendDriverVersion gave response: $nodeVersionXY. Please make sure all relevant drivers have been pushed."
+        exit 1
+    fi
+    nodeVersionXY=$(echo $nodeVersionXY | jq .driver | tr -d '"')
+
+    nodeInfo=`curl -s -X GET \
+    "https://api.supertokens.io/0/driver/latest?password=$SUPERTOKENS_API_KEY&mode=DEV&version=$nodeVersionXY&name=node" \
+    -H 'api-version: 0'`
+    if [[ `echo $nodeInfo | jq .tag` == "null" ]]
+    then
+        echo "fetching latest X.Y.Z version for driver, X.Y version: $nodeVersionXY gave response: $nodeInfo"
+        exit 1
+    fi
+    nodeTag=$(echo $nodeInfo | jq .tag | tr -d '"')
+
+    someFrontendTestsRan=true
+
+    tries=1
+    while [ $tries -le 3 ]
+    do
+        tries=$(( $tries + 1 ))
+        ./setupAndTestWithFrontendWithDjango2x.sh $coreFree $frontendTag $nodeTag
+        if [[ $? -ne 0 ]]
+        then
+            if [[ $tries -le 3 ]]
+            then
+                rm -rf ../../supertokens-root
+                rm -rf ../../supertokens-website
+                echo "failed test.. retrying!"
+            else
+                echo "test failed for website tests... exiting!"
+                exit 1
+            fi
+        else
+            rm -rf ../../supertokens-root
+            rm -rf ../../supertokens-website
+            break
+        fi
+    done
+done
+
+if [[ $someFrontendTestsRan = "false" ]]
+then
+    echo "no tests ran... failing!"
+    exit 1
+fi

CHANGELOG.md

@@ -6,8 +6,78 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [unreleased]
 
-### Documentation
+## [0.10.0] - 2022-07-04
+
+- Update tests to cover `resend_code` feature in `passwordless` and `thirdpartypasswordless` recipe.
+- Update usermetadata tests to ensure that utf8 chars are supported.
+- Mark tests as skipped if core version requirements are not met.
+- Use [black](https://github.com/psf/black) instead of `autopep8` to format code.
+- Add frontend integration tests for `django2x`
+
+### Bug fix:
+
+- Clears cookies when `revoke_session` is called using the session container, even if the session did not exist from before: https://github.com/supertokens/supertokens-node/issues/343
+
+### Breaking changes:
+- Change request arg type in session recipe functions from Any to BaseRequest.
+- Changes session function recipe interfaces to not throw an `UNAUTHORISED` error when the input is a session_handle: https://github.com/supertokens/backend/issues/83
+  - `get_session_information` now returns `None` if the session does not exist.
+  - `update_session_data` now returns `False` if the input `session_handle` does not exist.
+  - `update_access_token_payload` now returns `False` if the input `session_handle` does not exist.
+  - `regenerate_access_token` now returns `None` if the input access token's `session_handle` does not exist.
+  - The `session_class` functions have not changed in behaviour and still throw `UNAUTHORISED` error. This works cause the `session_class` works on the current session and not some other session.
+
+
+### Features:
+- Adds default `user_context` for API calls that contains the request object. It can be used in APIs / functions override like this:
+
+```python
+def apis_override_email_password(param: APIInterface):
+    og_sign_in_post = param.sign_in_post
+
+    async def sign_in_post(
+        form_fields: List[FormField],
+        api_options: APIOptions,
+        user_context: Dict[str, Any],
+    ):
+        req = user_context.get("_default", {}).get("request")
+        if req:
+            # do something with the request
+
+        return await og_sign_in_post(form_fields, api_options, user_context)
 
+    param.sign_in_post = sign_in_post
+    return param
+
+def functions_override_email_password(param: RecipeInterface):
+    og_sign_in = param.sign_in
+
+    async def sign_in(email: str, password: str, user_context: Dict[str, Any]):
+        req = user_context.get("_default", {}).get("request")
+        if req:
+            # do something with the request
+
+        return await og_sign_in(email, password, user_context)
+
+    param.sign_in = sign_in
+    return param
+
+init(
+    ...,
+    recipe_list=[
+        emailpassword.init(
+            override=emailpassword.InputOverrideConfig(
+                apis=apis_override_email_password,
+                functions=functions_override_email_password,
+            )
+        ),
+        session.init(),
+    ],
+)
+```
+
+
+### Documentation
 - Add more details in the `CONTRIBUTING.md` to make it beginner friendly.
 
 

Makefile

@@ -1,13 +1,13 @@
 help:
 	@echo "  \x1b[33;1mcheck-lint: \x1b[0mtest styling of code for the library using flak8"
 	@echo "        \x1b[33;1mtest: \x1b[0mruns pytest"
-	@echo "        \x1b[33;1mlint: \x1b[0mformat code using autopep8"
+	@echo "        \x1b[33;1mlint: \x1b[0mformat code using black"
 	@echo "\x1b[33;1mset-up-hooks: \x1b[0mset up various git hooks"
 	@echo " \x1b[33;1mdev-install: \x1b[0minstall all packages required for development"
 	@echo "        \x1b[33;1mhelp: \x1b[0mprints this"
 
 format:
-	autopep8 -r -i -a supertokens_python tests examples
+	black .
 
 check-lint:
 	pyright supertokens_python tests examples && pylint supertokens_python tests examples
@@ -34,6 +34,9 @@ with-fastapi:
 with-django:
 	pip3 install -e .[django]
 
+with-django2x:
+	pip3 install -e .[django2x]
+
 with-flask:
 	pip3 install -e .[flask]
 

dev-requirements.txt

@@ -2,12 +2,12 @@ anyio==3.5.0
 asgiref==3.4.1
 astroid==2.9.3
 attrs==21.4.0
-autopep8==1.5.6
+black==22.3.0
 certifi==2021.10.8
 cffi==1.15.0
 chardet==4.0.0
 charset-normalizer==2.0.12
-click==7.1.2
+click==8.1.3
 cryptography==35.0.0
 Deprecated==1.2.13
 Django==3.2.12
@@ -76,7 +76,7 @@ types-PyYAML==6.0.5
 typing_extensions==4.1.1
 tzdata==2021.5
 urllib3==1.26.9
-uvicorn==0.13.4
+uvicorn==0.18.2
 Werkzeug==2.0.3
 wrapt==1.13.3
 zipp==3.7.0

examples/with-django/with-thirdpartyemailpassword/manage.py

@@ -6,7 +6,7 @@
 
 def main():
     """Run administrative tasks."""
-    os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'project.settings')
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "project.settings")
     try:
         from django.core.management import execute_from_command_line
     except ImportError as exc:
@@ -18,5 +18,5 @@ def main():
     execute_from_command_line(sys.argv)
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     main()

examples/with-django/with-thirdpartyemailpassword/project/asgi.py

@@ -11,6 +11,6 @@
 
 from django.core.asgi import get_asgi_application
 
-os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'project.settings')
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "project.settings")
 
 application = get_asgi_application()