Make user fields optional in OAuth, set up tests

Author: davegaeddert

.github/workflows/test.yml

@@ -9,7 +9,7 @@ jobs:
     strategy:
       matrix:
         python-version: ["3.11", "3.12"]
-        package: ["plain", "plain-worker", "plain-flags", "plain-sessions", "plain-staff"]
+        package: ["plain", "plain-worker", "plain-flags", "plain-sessions", "plain-staff", "plain-oauth"]
 
     steps:
     - uses: actions/checkout@v3

plain-oauth/README.md

@@ -91,9 +91,11 @@ class ExampleOAuthProvider(OAuthProvider):
         response.raise_for_status()
         data = response.json()
         return OAuthUser(
+            # The provider ID is required
             id=data["id"],
-            username=data["username"],
+            # And you can populate any of your User model fields with additional kwargs
             email=data["email"],
+            username=data["username"],
         )
 ```
 
@@ -206,13 +208,11 @@ Hello {{ request.user }}!
     {% for connection in request.user.oauth_connections.all %}
     <li>
         {{ connection.provider_key }} [ID: {{ connection.provider_user_id }}]
-        {% if connection.can_be_disconnected %}
         <form action="{% url 'oauth:disconnect' connection.provider_key %}" method="post">
             {{ csrf_input }}
             <input type="hidden" name="provider_user_id" value="{{ connection.provider_user_id }}">
             <button type="submit">Disconnect</button>
         </form>
-        {% endif %}
     </li>
     {% endfor %}
 </ul>

plain-oauth/plain/oauth/README.md

@@ -89,9 +89,11 @@ class ExampleOAuthProvider(OAuthProvider):
         response.raise_for_status()
         data = response.json()
         return OAuthUser(
+            # The provider ID is required
             id=data["id"],
-            username=data["username"],
+            # And you can populate any of your User model fields with additional kwargs
             email=data["email"],
+            username=data["username"],
         )
 ```
 
@@ -204,13 +206,11 @@ Hello {{ request.user }}!
     {% for connection in request.user.oauth_connections.all %}
     <li>
         {{ connection.provider_key }} [ID: {{ connection.provider_user_id }}]
-        {% if connection.can_be_disconnected %}
         <form action="{% url 'oauth:disconnect' connection.provider_key %}" method="post">
             {{ csrf_input }}
             <input type="hidden" name="provider_user_id" value="{{ connection.provider_user_id }}">
             <button type="submit">Disconnect</button>
         </form>
-        {% endif %}
     </li>
     {% endfor %}
 </ul>

plain-oauth/plain/oauth/models.py

@@ -2,6 +2,7 @@
 
 from plain import models
 from plain.auth import get_user_model
+from plain.exceptions import ValidationError
 from plain.models import transaction
 from plain.models.db import IntegrityError, OperationalError, ProgrammingError
 from plain.preflight import Error
@@ -14,7 +15,7 @@
     from .providers import OAuthToken, OAuthUser
 
 
-# django check for deploy that ensures all provider keys in db are also in settings?
+# TODO preflight check for deploy that ensures all provider keys in db are also in settings?
 
 
 class OAuthConnection(models.Model):
@@ -84,7 +85,7 @@ def refresh_token_expired(self) -> bool:
         )
 
     @classmethod
-    def get_or_createuser(
+    def get_or_create_user(
         cls, *, provider_key: str, oauth_token: "OAuthToken", oauth_user: "OAuthUser"
     ) -> "OAuthConnection":
         try:
@@ -101,12 +102,11 @@ def get_or_createuser(
                 # that to be taken care of on the user model itself
                 try:
                     user = get_user_model()(
-                        username=oauth_user.username,
-                        email=oauth_user.email,
+                        **oauth_user.user_model_fields,
                     )
                     user.full_clean()
                     user.save()
-                except IntegrityError:
+                except (IntegrityError, ValidationError):
                     raise OAuthUserAlreadyExistsError()
 
                 return cls.connect(

plain-oauth/plain/oauth/providers.py

@@ -33,13 +33,16 @@ def __init__(
 
 
 class OAuthUser:
-    def __init__(self, *, id: str, email: str, username: str = ""):
-        self.id = id
-        self.username = username
-        self.email = email
+    def __init__(self, *, id: str, **user_model_fields: dict):
+        self.id = id  # ID on the provider's system
+        self.user_model_fields = user_model_fields
 
     def __str__(self):
-        return self.email
+        if "email" in self.user_model_fields:
+            return self.user_model_fields["email"]
+        if "username" in self.user_model_fields:
+            return self.user_model_fields["username"]
+        return str(self.id)
 
 
 class OAuthProvider:
@@ -157,7 +160,7 @@ def handle_callback_request(self, *, request: HttpRequest) -> Response:
             )
             user = connection.user
         else:
-            connection = OAuthConnection.get_or_createuser(
+            connection = OAuthConnection.get_or_create_user(
                 provider_key=self.provider_key,
                 oauth_token=oauth_token,
                 oauth_user=oauth_user,