zydronium/manage.get.gov
1
0
Fork 0
mirror of https://github.com/cisagov/manage.get.gov.git synced 2025-07-02 01:03:28 +02:00
Code Issues Projects Releases Packages Wiki Activity

Address feedback - use form pattern and update error messaging

Browse source
This commit is contained in:
Rebecca Hsieh 2025-01-07 17:24:13 -08:00
parent 26fcf6c5ec
commit b077f81409
No known key found for this signature in database
7 changed files with 93 additions and 96 deletions
Download patch file Download diff file Expand all files Collapse all files

19
docs/developer/registry-access.md
View file

@ -131,22 +131,3 @@ domain = Domain.objects.get_or_create(name="<that-domain-here>")
11. Go to the Registrar page and you should now see the expiring domain
If you want to be in the org model mode, turn the `organization_feature` waffle flag on, and add that domain via Django Admin to a portfolio to be able to view it.

1
src/registrar/forms/__init__.py
View file

@ -10,6 +10,7 @@ from .domain import (
DomainDsdataFormset,
DomainDsdataForm,
DomainSuborganizationForm,
DomainRenewalForm,
)
from .portfolio import (
PortfolioOrgAddressForm,

12
src/registrar/forms/domain.py
View file

@ -661,3 +661,15 @@ DomainDsdataFormset = formset_factory(
extra=0,
can_delete=True,
)
class DomainRenewalForm(forms.Form):
"""Form making sure domain renewal ack is checked"""
is_policy_acknowledged = forms.BooleanField(
required=True,
label="I have read and agree to the requirements for operating a .gov domain.",
error_messages={
"required": "Check the box if you read and agree to the requirements for operating a .gov domain."
},
)

5
src/registrar/models/domain.py
View file

@ -337,13 +337,14 @@ class Domain(TimeStampedModel, DomainHelper):
self._cache["ex_date"] = registry.send(request, cleaned=True).res_data[0].ex_date
self.expiration_date = self._cache["ex_date"]
self.save()
except RegistryError as err:
# if registry error occurs, log the error, and raise it as well
logger.error(f"registry error renewing domain: {err}")
logger.error(f"Registry error renewing domain '{self.name}': {err}")
raise (err)
except Exception as e:
# exception raised during the save to registrar
logger.error(f"error updating expiration date in registrar: {e}")
logger.error(f"Error updating expiration date for domain '{self.name}' in registrar: {e}")
raise (e)
@Cache

48
src/registrar/templates/domain_renewal.html
View file

@ -4,6 +4,18 @@
{% block domain_content %}
{% block breadcrumb %}
<!-- Banner for if_policy_acknowledged -->
{% if form.is_policy_acknowledged.errors %}
<div class="usa-alert usa-alert--error usa-alert--slim margin-bottom-2">
<div class="usa-alert__body">
{% for error in form.is_policy_acknowledged.errors %}
<p class="usa-alert__text">{{ error }}</p>
{% endfor %}
</div>
</div>
{% endif %}
{% if portfolio %}
<!-- Navigation breadcrumbs -->
<nav class="usa-breadcrumb padding-top-0" aria-label="Domain breadcrumb">
@ -28,7 +40,7 @@
<h2 class="text-bold text-primary-dark domain-name-wrap">Confirm the following information for accuracy</h2>
<p>Review these details below. We <a href="https://get.gov/domains/requirements/#what-.gov-domain-registrants-must-do" class="usa-link">
require</a> that you maintain accurate information for the domain.
The details you provide will only be used to support eh administration of .gov and won't be made public.
The details you provide will only be used to support the administration of .gov and won't be made public.
</p>
<p>If you would like to retire your domain instead, please <a href="https://get.gov/contact/" class="usa-link">
contact us</a>. </p>
@ -78,31 +90,20 @@
margin-top-0
margin-bottom-05
padding-right-1">
Acknowledgement of .gov domain requirements
</h3>
Acknowledgement of .gov domain requirements </h3>
</legend>
{% if messages %}
<ul class="messages"></ul>
{% for message in messages %}
<p class="usa-error-message">{{ message }}</p>
{% endfor %}
</ul>
{% endif %}
<form method="post" action="{% url 'domain-renewal' pk=domain.id %}">
{% csrf_token %}
<label>
<div class="usa-checkbox">
{% if form.is_policy_acknowledged.errors %}
<p class="usa-error-message">{{ form.is_policy_acknowledged.errors|join:" " }}</p>
{% endif %}
<input
class="usa-checkbox__input"
id="renewal-checkbox"
type="checkbox"
name="is_policy_acknowledged"
value="on"
{% if request.POST.is_policy_acknowledged %} checked {% endif %}
>
name="{{ form.is_policy_acknowledged.name }}">
<label class="usa-checkbox__label" for="renewal-checkbox">
I read and agree to the
<a href="https://get.gov/domains/requirements/" class="usa-link">
@ -111,17 +112,16 @@
<abbr class="usa-hint usa-hint--required" title="required">*</abbr>
</label>
</div>
</fieldset>
</div>
<button
type="submit"
name="submit_button"
value="next"
class="usa-button"
method="post"
>Submit</button>
class="usa-button margin-top-3"
> Submit
</button>
</form>
</fieldset>
</div> <!-- End of the acknowledgement section div -->
</div>
{% endblock %} {# domain_content #}

6
src/registrar/tests/test_views_domain.py
View file

@ -454,7 +454,7 @@ class TestDomainDetailDomainRenewal(TestDomainOverview):
self.user.save()
def todays_expiration_date(self):
def expiration_date_one_year_out(self):
todays_date = datetime.today()
new_expiration_date = todays_date.replace(year=todays_date.year + 1)
return new_expiration_date
@ -466,7 +466,7 @@ class TestDomainDetailDomainRenewal(TestDomainOverview):
return True
def custom_renew_domain(self):
self.domain_with_ip.expiration_date = self.todays_expiration_date()
self.domain_with_ip.expiration_date = self.expiration_date_one_year_out()
self.domain_with_ip.save()
@override_flag("domain_renewal", active=True)
@ -659,7 +659,7 @@ class TestDomainDetailDomainRenewal(TestDomainOverview):
self.assertRedirects(response, reverse("domain", kwargs={"pk": self.domain_with_ip.id}))
# Check for the updated expiration
formatted_new_expiration_date = self.todays_expiration_date().strftime("%b. %-d, %Y")
formatted_new_expiration_date = self.expiration_date_one_year_out().strftime("%b. %-d, %Y")
redirect_response = self.client.get(reverse("domain", kwargs={"pk": self.domain_with_ip.id}), follow=True)
self.assertContains(redirect_response, formatted_new_expiration_date)

38
src/registrar/views/domain.py
View file

@ -12,11 +12,11 @@ from django.contrib import messages
from django.contrib.messages.views import SuccessMessageMixin
from django.db import IntegrityError
from django.http import HttpResponseRedirect
from django.shortcuts import redirect, render
from django.shortcuts import redirect, render, get_object_or_404
from django.urls import reverse
from django.views.generic.edit import FormMixin
from django.conf import settings
from registrar.forms.domain import DomainSuborganizationForm
from registrar.forms.domain import DomainSuborganizationForm, DomainRenewalForm
from registrar.models import (
Domain,
DomainRequest,
@ -364,31 +364,33 @@ class DomainRenewalView(DomainBaseView):
self._update_session_with_domain()
def post(self, request, pk):
domain = Domain.objects.filter(id=pk).first()
domain = get_object_or_404(Domain, id=pk)
# Check if the checkbox is checked
is_policy_acknowledged = request.POST.get("is_policy_acknowledged", None)
if is_policy_acknowledged != "on":
messages.error(
request, "Check the box if you read and agree to the requirements for operating a .gov domain."
)
return render(
request,
"domain_renewal.html",
{
"domain": domain,
"form": request.POST,
},
)
form = DomainRenewalForm(request.POST)
if form.is_valid():
# check for key in the post request data
if "submit_button" in request.POST:
try:
domain.renew_domain()
messages.success(request, "This domain has been renewed for one year.")
except Exception as e:
messages.error(request, "This domain has not been renewed for one year, error was %s" % e)
messages.error(
request,
"This domain has not been renewed for one year, please email help@get.gov if this problem persists.",
)
return HttpResponseRedirect(reverse("domain", kwargs={"pk": pk}))
# if not valid, render the template with error messages
return render(
request,
"domain_renewal.html",
{
"domain": domain,
"form": form,
},
)
class DomainOrgNameAddressView(DomainFormBaseView):
"""Organization view"""