add redirect for user onboarding (#2612)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: CP <[email protected]>
Co-authored-by: Nathan Levesque <[email protected]>

Author: 4 people

app.json

@@ -374,6 +374,10 @@
       "description": "CyberSource security key",
       "required": false
     },
+    "MITXONLINE_NEW_USER_LOGIN_URL": {
+      "description": "URL to redirect new users to after login",
+      "required": false
+    },
     "MITX_ONLINE_ADMIN_EMAIL": {
       "description": "E-mail to send 500 reports to.",
       "required": true

authentication/new_views.py

@@ -177,11 +177,15 @@ def get(
         """
         redirect_url = get_redirect_url(request)
         if not request.user.is_anonymous:
-            profile = getattr(request.user, "user_profile", None)
-            if not profile:
-                # If user is authenticated but has no profile, redirect to create profile
+            profile = request.user.user_profile
+            if (
+                not profile.completed_onboarding
+                and request.GET.get("skip_onboarding", "0") == "0"
+            ):
                 params = urlencode({"next": redirect_url})
-                redirect_url = f"{reverse('profile-details')}?{params}"
+                redirect_url = f"{settings.MITXONLINE_NEW_USER_LOGIN_URL}?{params}"
+                profile.completed_onboarding = True
+                profile.save()
         return redirect(redirect_url)
 
 

authentication/new_views_test.py

@@ -1,8 +1,11 @@
 import pytest
+from django.test import RequestFactory
 from django.urls import reverse
 from rest_framework import status
 
+from authentication.new_views import CustomLoginView
 from users.api import User
+from users.factories import UserFactory
 from users.models import MALE, UserProfile
 
 
@@ -71,19 +74,35 @@ def test_post_user_extra_detail(mocker, client, user):
 
 
 @pytest.mark.django_db
-@pytest.mark.parametrize(
-    ("has_profile", "expected_url"),
-    [
-        (True, "/dashboard"),
-        (False, f"{reverse('profile-details')}?next=%2Fdashboard"),
-    ],
-)
-def test_login_view(client, user, has_profile, expected_url):
-    """Test that the login endpoint redirects the user properly based on profile existence"""
-    if not has_profile:
-        user.user_profile.delete()
-    client.force_login(user)
-    url = reverse("gateway-login")
-    resp = client.get(url)
-    assert resp.url == expected_url
-    assert resp.status_code == status.HTTP_302_FOUND
+def test_custom_login_view_authenticated_user_with_onboarding(mocker):
+    """Test CustomLoginView for an authenticated user with incomplete onboarding"""
+    factory = RequestFactory()
+    request = factory.get(reverse("login"), {"next": "/dashboard"})
+    user = UserFactory()
+    request.user = user
+    mocker.patch("authentication.new_views.get_redirect_url", return_value="/dashboard")
+    mocker.patch("authentication.new_views.urlencode", return_value="next=/dashboard")
+    mocker.patch(
+        "authentication.new_views.settings.MITXONLINE_NEW_USER_LOGIN_URL",
+        "/create-profile",
+    )
+
+    response = CustomLoginView().get(request)
+
+    assert response.status_code == 302
+    assert response.url == "/create-profile?next=/dashboard"
+
+
+@pytest.mark.django_db
+def test_custom_login_view_authenticated_user_with_completed_onboarding(mocker):
+    """Test that user who has completed onboarding is redirected to next url"""
+    factory = RequestFactory()
+    request = factory.get(reverse("login"), {"next": "/dashboard"})
+    user = UserFactory(user_profile__completed_onboarding=True)
+    request.user = user
+    mocker.patch("authentication.new_views.get_redirect_url", return_value="/dashboard")
+
+    response = CustomLoginView().get(request)
+
+    assert response.status_code == 302
+    assert response.url == "/dashboard"

main/settings.py

@@ -252,6 +252,11 @@
 
 SESSION_ENGINE = "django.contrib.sessions.backends.signed_cookies"
 
+MITXONLINE_NEW_USER_LOGIN_URL = get_string(
+    name="MITXONLINE_NEW_USER_LOGIN_URL",
+    default="http://mitxonline.odl.local:8013/create-profile",
+    description="URL to redirect new users to after login",
+)
 LOGIN_REDIRECT_URL = "/"
 LOGIN_URL = "/signin"
 LOGOUT_REDIRECT_URL = get_string(

users/migrations/0030_userprofile_completed_onboarding.py

@@ -0,0 +1,21 @@
+# Generated by Django 4.2.20 on 2025-04-25 02:55
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("users", "0029_add_b2b_contract_fk"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="userprofile",
+            name="completed_onboarding",
+            field=models.BooleanField(
+                blank=True,
+                default=False,
+                help_text="Flags if user has completed filling out required onboarding information",
+            ),
+        ),
+    ]

users/migrations/0031_populate_completed_onboarding.py

@@ -0,0 +1,17 @@
+# Generated by Django 4.2.20 on 2025-04-26 01:15
+
+
+from django.db import migrations
+
+
+def set_completed_onboarding(apps, schema_editor):
+    UserProfile = apps.get_model("users", "UserProfile")
+    UserProfile.objects.all().update(completed_onboarding=True)
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("users", "0030_userprofile_completed_onboarding"),
+    ]
+
+    operations = [migrations.RunPython(set_completed_onboarding)]

users/models.py

@@ -441,6 +441,11 @@ class UserProfile(TimestampedModel):
     user = models.OneToOneField(
         User, on_delete=models.CASCADE, related_name="user_profile"
     )
+    completed_onboarding = models.BooleanField(
+        default=False,
+        blank=True,
+        help_text="Flags if user has completed filling out required onboarding information",
+    )
 
     gender = models.CharField(  # noqa: DJ001
         max_length=128, blank=True, null=True, choices=GENDER_CHOICES