khashashin / django-appwrite

A Django middleware to authenticate users with Appwrite.

Hi 👋, I'm Yusuf

Tech enthusiast and problem solver

• 🔭 I’m currently working at geoimpact AG

Blogs posts

• WAN Interface Monitoring
• New JetBrains IDE UI
• Warum ich PyCharm liebe

Connect with me

Languages and Tools

django-appwrite's Issues

`log_error(e)` Logging Implementation Causes Secondary Exception

Content:

Problem Description:

When using the log_error(e) function, an incorrect logging format is causing another exception instead of logging the intended error message.

Current Implementation:

def log_error(e):
    import logging
    logger = logging.getLogger('django')
    logger.error('Error: ', e)

Issue:

The current logging implementation does not correctly format the error message with the exception e. This results in a secondary exception being raised during the logging process.

Proposed Solution:

To address this issue, the error logging string should be formatted with a placeholder (%s) to include the exception message.

def log_error(e):
    import logging
    logger = logging.getLogger('django')
    logger.error('Error: %s', e)

Retrieving information about user teams and creating groups in Django

1. Retrieve the information about the teams of the user. This involves accessing data from the Appwrite Server and retrieving information about the teams to which the user belongs.
2. Check if the groups with the same name already exist in Django. This step involves searching the Django database for groups with the same name as the teams retrieved from the Appwrite Server.
3. Create the group if it does not exist. If a group with the same name as the team does not exist in the Django database, a new group should be created with that name.
4. Assign the user to the group accordingly. Based on the information retrieved about the teams, the user should be assigned to the corresponding group in Django. This step involves linking the user's information to the group in the Django database.

Before starting the process of retrieving the information about user teams, checking if the groups with the same name exist, and assigning users to those groups, it's important to make sure that this task is necessary by checking property in the APPWRITE object in the Django settings.

Handle the cases where email field is used instead of username

Cannot resolve keyword 'username' into field. Choices are: date_joined, email, first_name, groups, id, is_active, is_staff, is_superuser, last_login, last_name, logentry, middle_name, password, user_permissions, userprofile

Optimize User Retrieval Logic in middleware.py and authentication.py

Currently, the logic to retrieve or create a user relies on the filter method followed by first. This approach might not be as performant as using the get method directly, especially since this logic is executed frequently.

Recommendation

Consider using the get method, which is typically more efficient for retrieving single records, and handle the User.DoesNotExist exception for cases where the user is not present in the database. This will likely improve the performance of the user retrieval process.

Current Implementation

# middleware.py
# Get the Django user by its email
user = User.objects.filter(username=email).first()

# If the user doesn't exist, create it
if not user:
    User.objects.create_user(
        username=email,
        password=password,
        email=email)

# authentication.py
# Get or create a corresponding Django user
django_user = User.objects.filter(username=email).first()
if not django_user:
    User.objects.create_user(username=email, password=password, email=email)

Possible Solution

# middleware.py
try:
    # Try to get the Django user by its email
    user = User.objects.get(username=email)
except User.DoesNotExist:
    # If the user doesn't exist, create it
    User.objects.create_user(
        username=email,
        password=password,
        email=email)

# authentication.py
try:
    # Try to get the corresponding Django user
    django_user = User.objects.get(username=email)
except User.DoesNotExist:
    # If the user doesn't exist, create it
    User.objects.create_user(username=email, password=password, email=email)

No needed to use user_id

Since we use JWT to authorise the user, we don't need user_id.

django-appwrite/django_appwrite/middleware.py

Line 44 in 0a22350

user_id = request.META.get(self.user_id_header, '')

After successful authorisation with JWT, we can access the ID from the account itself to generate the password

• - Update the Readme after removing it

The docs doesn't specify which values are required

So I have been checking the code of this plugin.
And it looks like the PROJECT_API_KEY is not begin used at all.
So you could just provide empty string and it will be still running.

So maybe it's worth to mention in the docs that this particular setting is there only for future
usecases like the groups/memberships check for permission or something?.

Fix UnitTests

Test does not work currently

Don't use password from appwrite payload

Reusing the password from an appwrite payload in Django by creating a user can lead to several security problems, including that any admin user in Appwrite will be able to login as any user in Django. This was noticed by @stnguyen90

django-appwrite/django_appwrite/middleware.py

Line 62 in 7752ae0

user = User.objects.create_user(username=user_info['email'], password=user_info['password'], email=user_info['email'])