- {# messages block #}
{% if messages %}
{% for message in messages %}
+
+{% endblock content_bottom %}
diff --git a/src/registrar/templatetags/custom_filters.py b/src/registrar/templatetags/custom_filters.py
index 798558355..62afa1acb 100644
--- a/src/registrar/templatetags/custom_filters.py
+++ b/src/registrar/templatetags/custom_filters.py
@@ -2,6 +2,7 @@ import logging
from django import template
import re
from registrar.models.domain_request import DomainRequest
+from phonenumber_field.phonenumber import PhoneNumber
register = template.Library()
logger = logging.getLogger(__name__)
@@ -133,3 +134,14 @@ def get_region(state):
return regions.get(state.upper(), "N/A")
else:
return None
+
+
+@register.filter
+def format_phone(value):
+ """Converts a phonenumber to a national format"""
+ if value:
+ phone_number = value
+ if isinstance(value, str):
+ phone_number = PhoneNumber.from_string(value)
+ return phone_number.as_national
+ return value
diff --git a/src/registrar/templatetags/field_helpers.py b/src/registrar/templatetags/field_helpers.py
index 811897908..b72f77e21 100644
--- a/src/registrar/templatetags/field_helpers.py
+++ b/src/registrar/templatetags/field_helpers.py
@@ -26,6 +26,7 @@ def input_with_errors(context, field=None): # noqa: C901
add_group_class: append to input element's surrounding tag's `class` attribute
attr_* - adds or replaces any single html attribute for the input
add_error_attr_* - like `attr_*` but only if field.errors is not empty
+ show_edit_button: shows a simple edit button, and adds display-none to the input field.
Example usage:
```
@@ -91,6 +92,12 @@ def input_with_errors(context, field=None): # noqa: C901
elif key == "add_group_class":
group_classes.append(value)
+ elif key == "show_edit_button":
+ # Hide the primary input field.
+ # Used such that we can toggle it with JS
+ if "display-none" not in classes:
+ classes.append("display-none")
+
attrs["id"] = field.auto_id
# do some work for various edge cases
diff --git a/src/registrar/tests/test_views.py b/src/registrar/tests/test_views.py
index 5ee94814d..f5b055a2b 100644
--- a/src/registrar/tests/test_views.py
+++ b/src/registrar/tests/test_views.py
@@ -20,6 +20,7 @@ from django.urls import reverse
from registrar.models import (
DomainRequest,
DomainInformation,
+ Website,
)
from waffle.testutils import override_flag
import logging
@@ -54,8 +55,19 @@ class TestWithUser(MockEppLib):
first_name = "First"
last_name = "Last"
email = "info@example.com"
+ phone = "8003111234"
self.user = get_user_model().objects.create(
- username=username, first_name=first_name, last_name=last_name, email=email
+ username=username, first_name=first_name, last_name=last_name, email=email, phone=phone
+ )
+ title = "test title"
+ self.user.contact.title = title
+ self.user.contact.save()
+
+ username_incomplete = "test_user_incomplete"
+ first_name_2 = "Incomplete"
+ email_2 = "unicorn@igorville.com"
+ self.incomplete_user = get_user_model().objects.create(
+ username=username_incomplete, first_name=first_name_2, email=email_2
)
def tearDown(self):
@@ -64,6 +76,7 @@ class TestWithUser(MockEppLib):
DomainRequest.objects.all().delete()
DomainInformation.objects.all().delete()
self.user.delete()
+ self.incomplete_user.delete()
class TestEnvironmentVariablesEffects(TestCase):
@@ -474,6 +487,137 @@ class HomeTests(TestWithUser):
self.assertEqual(response.status_code, 403)
+class FinishUserProfileTests(TestWithUser, WebTest):
+ """A series of tests that target the finish setup page for user profile"""
+
+ # csrf checks do not work well with WebTest.
+ # We disable them here.
+ csrf_checks = False
+
+ def setUp(self):
+ super().setUp()
+ self.user.title = None
+ self.user.save()
+ self.client.force_login(self.user)
+ self.domain, _ = Domain.objects.get_or_create(name="sampledomain.gov", state=Domain.State.READY)
+ self.role, _ = UserDomainRole.objects.get_or_create(
+ user=self.user, domain=self.domain, role=UserDomainRole.Roles.MANAGER
+ )
+
+ def tearDown(self):
+ super().tearDown()
+ PublicContact.objects.filter(domain=self.domain).delete()
+ self.role.delete()
+ self.domain.delete()
+ Domain.objects.all().delete()
+ Website.objects.all().delete()
+ Contact.objects.all().delete()
+
+ def _set_session_cookie(self):
+ session_id = self.app.cookies[settings.SESSION_COOKIE_NAME]
+ self.app.set_cookie(settings.SESSION_COOKIE_NAME, session_id)
+
+ def _submit_form_webtest(self, form, follow=False):
+ page = form.submit()
+ self._set_session_cookie()
+ return page.follow() if follow else page
+
+ @less_console_noise_decorator
+ def test_new_user_with_profile_feature_on(self):
+ """Tests that a new user is redirected to the profile setup page when profile_feature is on"""
+ self.app.set_user(self.incomplete_user.username)
+ with override_flag("profile_feature", active=True):
+ # This will redirect the user to the setup page.
+ # Follow implicity checks if our redirect is working.
+ finish_setup_page = self.app.get(reverse("home")).follow()
+ self._set_session_cookie()
+
+ # Assert that we're on the right page
+ self.assertContains(finish_setup_page, "Finish setting up your profile")
+
+ finish_setup_page = self._submit_form_webtest(finish_setup_page.form)
+
+ self.assertEqual(finish_setup_page.status_code, 200)
+
+ # We're missing a phone number, so the page should tell us that
+ self.assertContains(finish_setup_page, "Enter your phone number.")
+
+ # Check for the name of the save button
+ self.assertContains(finish_setup_page, "contact_setup_save_button")
+
+ # Add a phone number
+ finish_setup_form = finish_setup_page.form
+ finish_setup_form["phone"] = "(201) 555-0123"
+ finish_setup_form["title"] = "CEO"
+ finish_setup_form["last_name"] = "example"
+ save_page = self._submit_form_webtest(finish_setup_form, follow=True)
+
+ self.assertEqual(save_page.status_code, 200)
+ self.assertContains(save_page, "Your profile has been updated.")
+
+ # Try to navigate back to the home page.
+ # This is the same as clicking the back button.
+ completed_setup_page = self.app.get(reverse("home"))
+ self.assertContains(completed_setup_page, "Manage your domain")
+
+ @less_console_noise_decorator
+ def test_new_user_goes_to_domain_request_with_profile_feature_on(self):
+ """Tests that a new user is redirected to the domain request page when profile_feature is on"""
+
+ self.app.set_user(self.incomplete_user.username)
+ with override_flag("profile_feature", active=True):
+ # This will redirect the user to the setup page
+ finish_setup_page = self.app.get(reverse("domain-request:")).follow()
+ self._set_session_cookie()
+
+ # Assert that we're on the right page
+ self.assertContains(finish_setup_page, "Finish setting up your profile")
+
+ finish_setup_page = self._submit_form_webtest(finish_setup_page.form)
+
+ self.assertEqual(finish_setup_page.status_code, 200)
+
+ # We're missing a phone number, so the page should tell us that
+ self.assertContains(finish_setup_page, "Enter your phone number.")
+
+ # Check for the name of the save button
+ self.assertContains(finish_setup_page, "contact_setup_save_button")
+
+ # Add a phone number
+ finish_setup_form = finish_setup_page.form
+ finish_setup_form["phone"] = "(201) 555-0123"
+ finish_setup_form["title"] = "CEO"
+ finish_setup_form["last_name"] = "example"
+ completed_setup_page = self._submit_form_webtest(finish_setup_page.form, follow=True)
+
+ self.assertEqual(completed_setup_page.status_code, 200)
+
+ # Assert that we're on the domain request page
+ self.assertNotContains(completed_setup_page, "Finish setting up your profile")
+ self.assertNotContains(completed_setup_page, "What contact information should we use to reach you?")
+
+ self.assertContains(completed_setup_page, "You’re about to start your .gov domain request")
+
+ @less_console_noise_decorator
+ def test_new_user_with_profile_feature_off(self):
+ """Tests that a new user is not redirected to the profile setup page when profile_feature is off"""
+ with override_flag("profile_feature", active=False):
+ response = self.client.get("/")
+ self.assertNotContains(response, "Finish setting up your profile")
+
+ @less_console_noise_decorator
+ def test_new_user_goes_to_domain_request_with_profile_feature_off(self):
+ """Tests that a new user is redirected to the domain request page
+ when profile_feature is off but not the setup page"""
+ with override_flag("profile_feature", active=False):
+ response = self.client.get("/request/")
+
+ self.assertNotContains(response, "Finish setting up your profile")
+ self.assertNotContains(response, "What contact information should we use to reach you?")
+
+ self.assertContains(response, "You’re about to start your .gov domain request")
+
+
class UserProfileTests(TestWithUser, WebTest):
"""A series of tests that target your profile functionality"""
@@ -502,7 +646,7 @@ class UserProfileTests(TestWithUser, WebTest):
assume that the same test results hold true for 401 and 403."""
with override_flag("profile_feature", active=True):
with self.assertRaises(Exception):
- response = self.client.get(reverse("home"))
+ response = self.client.get(reverse("home"), follow=True)
self.assertEqual(response.status_code, 500)
self.assertContains(response, "Your profile")
@@ -522,42 +666,42 @@ class UserProfileTests(TestWithUser, WebTest):
def test_home_page_main_nav_with_profile_feature_on(self):
"""test that Your profile is in main nav of home page when profile_feature is on"""
with override_flag("profile_feature", active=True):
- response = self.client.get("/")
+ response = self.client.get("/", follow=True)
self.assertContains(response, "Your profile")
@less_console_noise_decorator
def test_home_page_main_nav_with_profile_feature_off(self):
"""test that Your profile is not in main nav of home page when profile_feature is off"""
with override_flag("profile_feature", active=False):
- response = self.client.get("/")
+ response = self.client.get("/", follow=True)
self.assertNotContains(response, "Your profile")
@less_console_noise_decorator
def test_new_request_main_nav_with_profile_feature_on(self):
"""test that Your profile is in main nav of new request when profile_feature is on"""
with override_flag("profile_feature", active=True):
- response = self.client.get("/request/")
+ response = self.client.get("/request/", follow=True)
self.assertContains(response, "Your profile")
@less_console_noise_decorator
def test_new_request_main_nav_with_profile_feature_off(self):
"""test that Your profile is not in main nav of new request when profile_feature is off"""
with override_flag("profile_feature", active=False):
- response = self.client.get("/request/")
+ response = self.client.get("/request/", follow=True)
self.assertNotContains(response, "Your profile")
@less_console_noise_decorator
def test_user_profile_main_nav_with_profile_feature_on(self):
"""test that Your profile is in main nav of user profile when profile_feature is on"""
with override_flag("profile_feature", active=True):
- response = self.client.get("/user-profile")
+ response = self.client.get("/user-profile", follow=True)
self.assertContains(response, "Your profile")
@less_console_noise_decorator
def test_user_profile_returns_404_when_feature_off(self):
"""test that Your profile returns 404 when profile_feature is off"""
with override_flag("profile_feature", active=False):
- response = self.client.get("/user-profile")
+ response = self.client.get("/user-profile", follow=True)
self.assertEqual(response.status_code, 404)
@less_console_noise_decorator
@@ -582,14 +726,14 @@ class UserProfileTests(TestWithUser, WebTest):
def test_domain_your_contact_information_when_profile_feature_off(self):
"""test that Your contact information is accessible when profile_feature is off"""
with override_flag("profile_feature", active=False):
- response = self.client.get(f"/domain/{self.domain.id}/your-contact-information")
+ response = self.client.get(f"/domain/{self.domain.id}/your-contact-information", follow=True)
self.assertContains(response, "Your contact information")
@less_console_noise_decorator
def test_domain_your_contact_information_when_profile_feature_on(self):
"""test that Your contact information is not accessible when profile feature is on"""
with override_flag("profile_feature", active=True):
- response = self.client.get(f"/domain/{self.domain.id}/your-contact-information")
+ response = self.client.get(f"/domain/{self.domain.id}/your-contact-information", follow=True)
self.assertEqual(response.status_code, 404)
@less_console_noise_decorator
@@ -606,9 +750,9 @@ class UserProfileTests(TestWithUser, WebTest):
submitter=contact_user,
)
with override_flag("profile_feature", active=True):
- response = self.client.get(f"/domain-request/{domain_request.id}")
+ response = self.client.get(f"/domain-request/{domain_request.id}", follow=True)
self.assertContains(response, "Your profile")
- response = self.client.get(f"/domain-request/{domain_request.id}/withdraw")
+ response = self.client.get(f"/domain-request/{domain_request.id}/withdraw", follow=True)
self.assertContains(response, "Your profile")
@less_console_noise_decorator
@@ -625,9 +769,9 @@ class UserProfileTests(TestWithUser, WebTest):
submitter=contact_user,
)
with override_flag("profile_feature", active=False):
- response = self.client.get(f"/domain-request/{domain_request.id}")
+ response = self.client.get(f"/domain-request/{domain_request.id}", follow=True)
self.assertNotContains(response, "Your profile")
- response = self.client.get(f"/domain-request/{domain_request.id}/withdraw")
+ response = self.client.get(f"/domain-request/{domain_request.id}/withdraw", follow=True)
self.assertNotContains(response, "Your profile")
# cleanup
domain_request.delete()
@@ -642,13 +786,6 @@ class UserProfileTests(TestWithUser, WebTest):
session_id = self.app.cookies[settings.SESSION_COOKIE_NAME]
self.app.set_cookie(settings.SESSION_COOKIE_NAME, session_id)
profile_form = profile_page.form
- profile_page = profile_form.submit()
-
- self.app.set_cookie(settings.SESSION_COOKIE_NAME, session_id)
- # assert that first result contains errors
- self.assertContains(profile_page, "Enter your title")
- self.assertContains(profile_page, "Enter your phone number")
- profile_form = profile_page.form
profile_form["title"] = "sample title"
profile_form["phone"] = "(201) 555-1212"
profile_page = profile_form.submit()
diff --git a/src/registrar/views/__init__.py b/src/registrar/views/__init__.py
index 4ed5bfa75..355a8be45 100644
--- a/src/registrar/views/__init__.py
+++ b/src/registrar/views/__init__.py
@@ -14,6 +14,6 @@ from .domain import (
DomainInvitationDeleteView,
DomainDeleteUserView,
)
-from .user_profile import UserProfileView
+from .user_profile import UserProfileView, FinishProfileSetupView
from .health import *
from .index import *
diff --git a/src/registrar/views/user_profile.py b/src/registrar/views/user_profile.py
index af73fad44..47b01f7cb 100644
--- a/src/registrar/views/user_profile.py
+++ b/src/registrar/views/user_profile.py
@@ -2,13 +2,16 @@
"""
+from enum import Enum
import logging
from urllib.parse import parse_qs, unquote
+from urllib.parse import quote
+
from django.contrib import messages
from django.views.generic.edit import FormMixin
-from registrar.forms.user_profile import UserProfileForm
-from django.urls import reverse
+from registrar.forms.user_profile import UserProfileForm, FinishSetupProfileForm
+from django.urls import NoReverseMatch, reverse
from registrar.models import (
Contact,
)
@@ -16,6 +19,8 @@ from registrar.models.utility.generic_helper import replace_url_queryparams
from registrar.views.utility.permission_views import UserProfilePermissionView
from waffle.decorators import flag_is_active, waffle_flag
+from django.utils.decorators import method_decorator
+from django.views.decorators.csrf import csrf_protect
logger = logging.getLogger(__name__)
@@ -59,6 +64,11 @@ class UserProfileView(UserProfilePermissionView, FormMixin):
context = super().get_context_data(**kwargs)
# This is a django waffle flag which toggles features based off of the "flag" table
context["has_profile_feature_flag"] = flag_is_active(self.request, "profile_feature")
+
+ # The text for the back button on this page
+ context["profile_back_button_text"] = "Go to manage your domains"
+ context["show_back_button"] = True
+
return context
def get_success_url(self):
@@ -99,3 +109,145 @@ class UserProfileView(UserProfilePermissionView, FormMixin):
if hasattr(user, "contact"): # Check if the user has a contact instance
return user.contact
return None
+
+
+class FinishProfileSetupView(UserProfileView):
+ """This view forces the user into providing additional details that
+ we may have missed from Login.gov"""
+
+ class RedirectType(Enum):
+ """
+ Enums for each type of redirection. Enforces behaviour on `get_redirect_url()`.
+
+ - HOME: We want to redirect to reverse("home")
+ - BACK_TO_SELF: We want to redirect back to this page
+ - TO_SPECIFIC_PAGE: We want to redirect to the page specified in the queryparam "redirect"
+ - COMPLETE_SETUP: Indicates that we want to navigate BACK_TO_SELF, but the subsequent
+ redirect after the next POST should be either HOME or TO_SPECIFIC_PAGE
+ """
+
+ HOME = "home"
+ TO_SPECIFIC_PAGE = "domain_request"
+ BACK_TO_SELF = "back_to_self"
+ COMPLETE_SETUP = "complete_setup"
+
+ @classmethod
+ def get_all_redirect_types(cls) -> list[str]:
+ """Returns the value of every redirect type defined in this enum."""
+ return [r.value for r in cls]
+
+ template_name = "finish_profile_setup.html"
+ form_class = FinishSetupProfileForm
+ model = Contact
+
+ all_redirect_types = RedirectType.get_all_redirect_types()
+ redirect_type: RedirectType
+
+ def get_context_data(self, **kwargs):
+
+ context = super().get_context_data(**kwargs)
+
+ # Hide the back button by default
+ context["show_back_button"] = False
+
+ if self.redirect_type == self.RedirectType.COMPLETE_SETUP:
+ context["confirm_changes"] = True
+
+ if "redirect_viewname" not in self.session:
+ context["show_back_button"] = True
+ else:
+ context["going_to_specific_page"] = True
+ context["redirect_button_text"] = "Continue to your request"
+
+ return context
+
+ @method_decorator(csrf_protect)
+ def dispatch(self, request, *args, **kwargs):
+ """
+ Handles dispatching of the view, applying CSRF protection and checking the 'profile_feature' flag.
+
+ This method sets the redirect type based on the 'redirect' query parameter,
+ defaulting to BACK_TO_SELF if not provided.
+ It updates the session with the redirect view name if the redirect type is TO_SPECIFIC_PAGE.
+
+ Returns:
+ HttpResponse: The response generated by the parent class's dispatch method.
+ """
+
+ # Update redirect type based on the query parameter if present
+ default_redirect_value = self.RedirectType.BACK_TO_SELF.value
+ redirect_value = request.GET.get("redirect", default_redirect_value)
+
+ if redirect_value in self.all_redirect_types:
+ # If the redirect value is a preexisting value in our enum, set it to that.
+ self.redirect_type = self.RedirectType(redirect_value)
+ else:
+ # If the redirect type is undefined, then we assume that we are specifying a particular page to redirect to.
+ self.redirect_type = self.RedirectType.TO_SPECIFIC_PAGE
+
+ # Store the page that we want to redirect to for later use
+ request.session["redirect_viewname"] = str(redirect_value)
+
+ return super().dispatch(request, *args, **kwargs)
+
+ def post(self, request, *args, **kwargs):
+ """Form submission posts to this view."""
+ self._refresh_session_and_object(request)
+ form = self.form_class(request.POST, instance=self.object)
+
+ # Get the current form and validate it
+ if form.is_valid():
+ if "contact_setup_save_button" in request.POST:
+ # Logic for when the 'Save' button is clicked
+ self.redirect_type = self.RedirectType.COMPLETE_SETUP
+ elif "contact_setup_submit_button" in request.POST:
+ specific_redirect = "redirect_viewname" in self.session
+ self.redirect_type = self.RedirectType.TO_SPECIFIC_PAGE if specific_redirect else self.RedirectType.HOME
+ return self.form_valid(form)
+ else:
+ return self.form_invalid(form)
+
+ def get_success_url(self):
+ """Redirect to the nameservers page for the domain."""
+ return self.get_redirect_url()
+
+ def get_redirect_url(self):
+ """
+ Returns a URL string based on the current value of self.redirect_type.
+
+ Depending on self.redirect_type, constructs a base URL and appends a
+ 'redirect' query parameter. Handles different redirection types such as
+ HOME, BACK_TO_SELF, COMPLETE_SETUP, and TO_SPECIFIC_PAGE.
+
+ Returns:
+ str: The full URL with the appropriate query parameters.
+ """
+
+ # These redirect types redirect to the same page
+ self_redirect = [self.RedirectType.BACK_TO_SELF, self.RedirectType.COMPLETE_SETUP]
+
+ # Maps the redirect type to a URL
+ base_url = ""
+ try:
+ if self.redirect_type in self_redirect:
+ base_url = reverse("finish-user-profile-setup")
+ elif self.redirect_type == self.RedirectType.TO_SPECIFIC_PAGE:
+ # We only allow this session value to use viewnames,
+ # because this restricts what can be redirected to.
+ desired_view = self.session["redirect_viewname"]
+ self.session.pop("redirect_viewname")
+ base_url = reverse(desired_view)
+ else:
+ base_url = reverse("home")
+ except NoReverseMatch as err:
+ logger.error(f"get_redirect_url -> Could not find the specified page. Err: {err}")
+
+ query_params = {}
+
+ # Quote cleans up the value so that it can be used in a url
+ if self.redirect_type and self.redirect_type.value:
+ query_params["redirect"] = quote(self.redirect_type.value)
+
+ # Generate the full url from the given query params
+ full_url = replace_url_queryparams(base_url, query_params)
+ return full_url
diff --git a/src/registrar/views/utility/mixins.py b/src/registrar/views/utility/mixins.py
index 78bdf0fd7..926ee4a8c 100644
--- a/src/registrar/views/utility/mixins.py
+++ b/src/registrar/views/utility/mixins.py
@@ -296,7 +296,6 @@ class UserDeleteDomainRolePermission(PermissionsLoginMixin):
domain_pk = self.kwargs["pk"]
user_pk = self.kwargs["user_pk"]
- # Check if the user is authenticated
if not self.request.user.is_authenticated:
return False
@@ -393,6 +392,8 @@ class UserProfilePermission(PermissionsLoginMixin):
If the user is authenticated, they have access
"""
+
+ # Check if the user is authenticated
if not self.request.user.is_authenticated:
return False