redirect new users to onboarding (#2204)

* adding initial changes for redirect on backend

* check for next url post-onboarding

* adding settings and field changes

* adding test and redirect post onboarding

* set onboarding flag to true for existing users

* removing log

* switching conditional

* fixing redirect logic

* fixing testcase

Author: shanbady

authentication/views.py

@@ -4,7 +4,7 @@
 
 from django.contrib.auth import logout
 from django.shortcuts import redirect
-from django.utils.http import url_has_allowed_host_and_scheme
+from django.utils.http import url_has_allowed_host_and_scheme, urlencode
 from django.views import View
 
 from main import settings
@@ -73,4 +73,15 @@ def get(
         """
         GET endpoint for logging a user in.
         """
-        return redirect(get_redirect_url(request))
+        redirect_url = get_redirect_url(request)
+        if not request.user.is_anonymous:
+            profile = request.user.profile
+            if (
+                not profile.completed_onboarding
+                and request.GET.get("skip_onboarding", "0") == "0"
+            ):
+                params = urlencode({"next": redirect_url})
+                redirect_url = f"{settings.MITOL_NEW_USER_LOGIN_URL}?{params}"
+                profile.completed_onboarding = True
+                profile.save()
+        return redirect(redirect_url)

authentication/views_test.py

@@ -2,11 +2,14 @@
 
 import json
 from base64 import b64encode
+from unittest.mock import MagicMock
 
 import pytest
 from django.conf import settings
+from django.test import RequestFactory
+from django.urls import reverse
 
-from authentication.views import get_redirect_url
+from authentication.views import CustomLoginView, get_redirect_url
 
 
 @pytest.mark.parametrize(
@@ -108,3 +111,67 @@ def test_custom_logout_view(mocker, client, user, is_authenticated, has_next):
         client.force_login(user)
     resp = client.get(f"/logout/?next={next_url}", request=mock_request)
     assert resp.url == (next_url if has_next else "/app")
+
+
+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"})
+    request.user = MagicMock(is_anonymous=False)
+    request.user.profile = MagicMock(completed_onboarding=False)
+    mocker.patch("authentication.views.get_redirect_url", return_value="/dashboard")
+    mocker.patch("authentication.views.urlencode", return_value="next=/dashboard")
+    mocker.patch(
+        "authentication.views.settings.MITOL_NEW_USER_LOGIN_URL", "/onboarding"
+    )
+
+    response = CustomLoginView().get(request)
+
+    assert response.status_code == 302
+    assert response.url == "/onboarding?next=/dashboard"
+
+
+def test_custom_login_view_authenticated_user_skip_onboarding(mocker):
+    """Test skip_onboarding flag skips redirect to onboarding and sets completed_onboarding"""
+    factory = RequestFactory()
+    request = factory.get(
+        reverse("login"), {"next": "/dashboard", "skip_onboarding": "1"}
+    )
+    request.user = MagicMock(is_anonymous=False)
+    request.user.profile = MagicMock(completed_onboarding=False)
+    mocker.patch("authentication.views.get_redirect_url", return_value="/dashboard")
+
+    response = CustomLoginView().get(request)
+    request.user.profile.refresh_from_db()
+    # user should not be marked as completed onboarding
+    assert request.user.profile.completed_onboarding is False
+
+    assert response.status_code == 302
+    assert response.url == "/dashboard"
+
+
+def test_custom_login_view_authenticated_user_with_completed_onboarding(mocker):
+    """Test test that user who has completed onboarding is redirected to next url"""
+    factory = RequestFactory()
+    request = factory.get(reverse("login"), {"next": "/dashboard"})
+    request.user = MagicMock(is_anonymous=False)
+    request.user.profile = MagicMock(completed_onboarding=True)
+    mocker.patch("authentication.views.get_redirect_url", return_value="/dashboard")
+
+    response = CustomLoginView().get(request)
+
+    assert response.status_code == 302
+    assert response.url == "/dashboard"
+
+
+def test_custom_login_view_anonymous_user(mocker):
+    """Test redirect for anonymous user"""
+    factory = RequestFactory()
+    request = factory.get(reverse("login"), {"next": "/dashboard"})
+    request.user = MagicMock(is_anonymous=True)
+    mocker.patch("authentication.views.get_redirect_url", return_value="/dashboard")
+
+    response = CustomLoginView().get(request)
+
+    assert response.status_code == 302
+    assert response.url == "/dashboard"

frontends/main/src/app-pages/OnboardingPage/OnboardingPage.test.tsx

@@ -4,7 +4,6 @@ import { merge, times } from "lodash"
 import {
   renderWithProviders,
   screen,
-  waitFor,
   setMockResponse,
   user,
 } from "../../test-utils"
@@ -19,8 +18,32 @@ import {
   type Profile,
 } from "api/v0"
 
+import { waitFor } from "@testing-library/react"
+
 import OnboardingPage from "./OnboardingPage"
 
+const oldWindowLocation = window.location
+
+beforeAll(() => {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  delete (window as any).location
+
+  window.location = Object.defineProperties(
+    {} as unknown as string & Location,
+    {
+      ...Object.getOwnPropertyDescriptors(oldWindowLocation),
+      assign: {
+        configurable: true,
+        value: jest.fn(),
+      },
+    },
+  )
+})
+
+afterAll(() => {
+  window.location = oldWindowLocation as unknown as string & Location
+})
+
 const STEPS_DATA: Partial<Profile>[] = [
   {
     topic_interests: [factories.learningResources.topic()],
@@ -68,7 +91,9 @@ const setup = async (profile: Profile) => {
     ...req,
   }))
 
-  renderWithProviders(<OnboardingPage />)
+  renderWithProviders(<OnboardingPage />, {
+    url: "/onboarding?next=http%3A%2F%2Flearn.mit.edu",
+  })
 }
 
 // this function sets up the test and progresses the UI to the designated step
@@ -107,8 +132,15 @@ describe("OnboardingPage", () => {
       const nextStep = step + 1
       await setupAndProgressToStep(step)
       if (step === STEP_TITLES.length - 1) {
-        await findFinishButton()
+        const finishButton = await findFinishButton()
+
         expect(queryBackButton()).not.toBeNil()
+
+        await user.click(finishButton)
+        await waitFor(() => {
+          expect(window.location).toBe("http://learn.mit.edu")
+        })
+
         return
       }
 

frontends/main/src/app-pages/OnboardingPage/OnboardingPage.tsx

@@ -27,6 +27,8 @@ import { DASHBOARD_HOME } from "@/common/urls"
 import { useFormik } from "formik"
 import { useLearningResourceTopics } from "api/hooks/learningResources"
 import { useUserMe } from "api/hooks/user"
+
+import { useSearchParams } from "next/navigation"
 import {
   CERTIFICATE_CHOICES,
   EDUCATION_LEVEL_OPTIONS,
@@ -156,6 +158,8 @@ const OnboardingPage: React.FC = () => {
   const { isLoading: userLoading, data: user } = useUserMe()
   const [activeStep, setActiveStep] = React.useState<number>(0)
   const router = useRouter()
+  const searchParams = useSearchParams()
+  const nextUrl = searchParams.get("next")
 
   const formik = useFormik({
     enableReinitialize: true,
@@ -171,6 +175,10 @@ const OnboardingPage: React.FC = () => {
       if (activeStep < NUM_STEPS - 1) {
         setActiveStep((prevActiveStep) => prevActiveStep + 1)
       } else {
+        if (nextUrl) {
+          ;(window as Window).location = nextUrl
+          return null
+        }
         router.push(DASHBOARD_HOME)
       }
     },

main/settings.py

@@ -196,7 +196,9 @@
     MIDDLEWARE += ("nplusone.ext.django.NPlusOneMiddleware",)
 
 SESSION_ENGINE = "django.contrib.sessions.backends.signed_cookies"
-
+MITOL_NEW_USER_LOGIN_URL = get_string(
+    "MITOL_NEW_USER_LOGIN_URL", "http://open.odl.local:8062/onboarding"
+)
 LOGIN_REDIRECT_URL = "/app"
 LOGIN_URL = "/login"
 LOGIN_ERROR_URL = "/login"

profiles/migrations/0035_profile_completed_onboarding.py

@@ -0,0 +1,17 @@
+# Generated by Django 4.2.20 on 2025-04-15 14:14
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("profiles", "0034_remove_profile_scim_fields"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="profile",
+            name="completed_onboarding",
+            field=models.BooleanField(default=False),
+        ),
+    ]

profiles/migrations/0036_set_onboarding_complete_for_existing_users.py

@@ -0,0 +1,16 @@
+# Generated by Django 4.2.20 on 2025-04-07 19:05
+
+from django.db import migrations
+
+
+def set_completed_onboarding(apps, schema_editor):
+    Profile = apps.get_model("profiles", "Profile")
+    Profile.objects.all().update(completed_onboarding=True)
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("profiles", "0035_profile_completed_onboarding"),
+    ]
+
+    operations = [migrations.RunPython(set_completed_onboarding)]

profiles/models.py

@@ -148,6 +148,8 @@ class LearningResourceDelivery(models.TextChoices):
     email_optin = models.BooleanField(null=True)
     toc_optin = models.BooleanField(null=True)
 
+    completed_onboarding = models.BooleanField(default=False)
+
     headline = models.CharField(blank=True, null=True, max_length=60)  # noqa: DJ001
     bio = models.TextField(blank=True, null=True)  # noqa: DJ001
     location = JSONField(null=True, blank=True)