diff --git a/docs/architecture/decisions/0018-registry-integration.md b/docs/architecture/decisions/0018-registry-integration.md new file mode 100644 index 000000000..5bdb8ea2e --- /dev/null +++ b/docs/architecture/decisions/0018-registry-integration.md @@ -0,0 +1,37 @@ +# 18. Registry Integration + +Date: 2022-02-15 + +## Status + +Accepted + +## Context + +There are relatively few existing open source software projects which implement registry-registrar communications and even fewer of them in Python. + +This creates a twofold problem: first, there are few design patterns which we can consult to determine how to build; second, there are few libraries we can freely use. + +The incoming registry vendor has pointed to [FRED’s epplib](https://gitlab.nic.cz/fred/utils/epplib) as a newly-developed example which may suit most of our needs. This library is able to establish the TCP connection. It also contains a number of helper methods for preparing the XML requests and parsing the XML responses. + +Commands in the EPP protocol are not synchronous, meaning that the response to a command will acknowledge receipt of it, but may not indicate success or failure. + +This creates an additional challenge: we do not desire to have complex background jobs to run polling. The registrar does not anticipate having a volume of daily users to make such an investment worthwhile, nor a supply of system administrators to monitor and troubleshoot such a system. + +Beyond these mechanical requirements, we also need a firm understanding of the rules governing how and when commands can be issued to the registry. + +## Decision + +To use the open source FRED epplib developed by the .cz registry. + +To treat commands given to the registry as asynchronous from a user experience perspective. In other words, “the registry has received your request, please check back later”. + +To develop the Domain model as the interface to epplib. + +## Consequences + +Using the Domain model as an interface will funnel interactions with the registry and consolidate rules in a single location. This will be a significant benefit to future maintainers, but it does stretch the normal metaphor of a Django model as representing a database table. This may introduce some confusion or uncertainty. + +Treating commands as asynchronous will need support from content managers and user interface designers to help registrants and analysts understand the system’s behavior. Without adequate support, users will experience surprise and frustration. + +FRED epplib is in early active development. It may not contain all of the features we’d like. Limitations in what upstream maintainers are able to accept, either due to policy or due to staffing or due to lack of interest, may require CISA to fork the project. This will incur a maintenance burden on CISA. diff --git a/src/registrar/assets/sass/_theme/_uswds-theme-custom-styles.scss b/src/registrar/assets/sass/_theme/_uswds-theme-custom-styles.scss index c61e79337..896856116 100644 --- a/src/registrar/assets/sass/_theme/_uswds-theme-custom-styles.scss +++ b/src/registrar/assets/sass/_theme/_uswds-theme-custom-styles.scss @@ -105,7 +105,7 @@ $letter-space--xs: .0125em; color: color('violet-70v'); //USWDS default } } - +.register-form-step .usa-form-group:first-of-type, .register-form-step .usa-label:first-of-type { margin-top: units(1); } diff --git a/src/registrar/templates/application_form.html b/src/registrar/templates/application_form.html index 9b1240013..628916b83 100644 --- a/src/registrar/templates/application_form.html +++ b/src/registrar/templates/application_form.html @@ -18,6 +18,10 @@ {% endif %} +{% block form_messages %} + {% include "includes/form_messages.html" %} +{% endblock %} + {% block form_errors %} {% comment %} to make sense of this loop, consider that diff --git a/src/registrar/templates/application_org_federal.html b/src/registrar/templates/application_org_federal.html index f51ed7c7a..138a6c334 100644 --- a/src/registrar/templates/application_org_federal.html +++ b/src/registrar/templates/application_org_federal.html @@ -2,7 +2,7 @@ {% load field_helpers %} {% block form_instructions %} -

+

Which federal branch is your organization in?

{% endblock %} @@ -12,4 +12,4 @@ {% with add_class="usa-radio__input--tile" %} {% input_with_errors forms.0.federal_type %} {% endwith %} -{% endblock %} \ No newline at end of file +{% endblock %} diff --git a/src/registrar/templates/application_other_contacts.html b/src/registrar/templates/application_other_contacts.html index 3f982e260..fc41a8385 100644 --- a/src/registrar/templates/application_other_contacts.html +++ b/src/registrar/templates/application_other_contacts.html @@ -2,7 +2,7 @@ {% load static field_helpers %} {% block form_instructions %} -

We’d like to contact other employees with administrative or technical responsibilities in your organization. For example, they could be involved in managing your organization or its technical infrastructure. This information will help us assess your eligibility and understand the purpose of the .gov domain. These contacts should be in addition to you and your authorizing official. They should be employees of your organization.

+

We’d like to contact other employees in your organization about your domain request. For example, they could be involved in managing your organization or its technical infrastructure. This information will help us assess your eligibility for a .gov domain. These contacts should be in addition to you and your authorizing official. They should be employees of your organization.

We’ll email these contacts to let them know that you made this request.

{% endblock %} @@ -14,7 +14,7 @@ {% for form in forms.0.forms %}
-

Administrative or technical contact {{ forloop.counter }}

+

Organization contact {{ forloop.counter }}

 {% input_with_errors form.first_name %} diff --git a/src/registrar/templates/base.html b/src/registrar/templates/base.html index 2479fceea..a864ac48d 100644 --- a/src/registrar/templates/base.html +++ b/src/registrar/templates/base.html @@ -167,9 +167,11 @@ {% if messages %} {% endif %} diff --git a/src/registrar/templates/includes/form_errors.html b/src/registrar/templates/includes/form_errors.html index f5e9a8791..a5dd99efc 100644 --- a/src/registrar/templates/includes/form_errors.html +++ b/src/registrar/templates/includes/form_errors.html @@ -1,5 +1,9 @@ +{% comment %} +Commenting the code below to turn off the error because +we are showing the caution dialog instead. But saving in +case we want to revert this. {% if form.errors %} - {% for error in form.non_field_errors %} +{% for error in form.non_field_errors %}
{{ error|escape }} @@ -15,4 +19,5 @@
{% endfor %} {% endfor %} -{% endif %} \ No newline at end of file +{% endif %} +{% endcomment %} \ No newline at end of file diff --git a/src/registrar/templates/includes/form_messages.html b/src/registrar/templates/includes/form_messages.html new file mode 100644 index 000000000..c7b704f67 --- /dev/null +++ b/src/registrar/templates/includes/form_messages.html @@ -0,0 +1,10 @@ +{% if messages %} +{% for message in messages %} +
+
+ {{ message }} +
+
+ +{% endfor %} +{% endif %} \ No newline at end of file diff --git a/src/registrar/views/application.py b/src/registrar/views/application.py index f75b62970..27502a75d 100644 --- a/src/registrar/views/application.py +++ b/src/registrar/views/application.py @@ -6,6 +6,8 @@ from django.shortcuts import redirect, render from django.urls import resolve, reverse from django.utils.translation import gettext_lazy as _ from django.views.generic import TemplateView +from django.contrib import messages +from django.utils.safestring import mark_safe from registrar.forms import application_wizard as forms from registrar.models import DomainApplication @@ -324,6 +326,18 @@ class ApplicationWizard(LoginRequiredMixin, TemplateView): self.save(forms) else: # unless there are errors + # no sec because this use of mark_safe does not introduce a cross-site + # scripting vulnerability because there is no untrusted content inside. + # It is only being used to pass a specific HTML entity into a template. + messages.warning( + request, + mark_safe( # nosec + "We could not save all the fields.
The highlighted " + + "fields below could not be saved because they have " + + "missing or invalid data. All other information on this page " + + "has been saved." + ), + ) context = self.get_context_data() context["forms"] = forms return render(request, self.template_name, context) @@ -331,6 +345,7 @@ class ApplicationWizard(LoginRequiredMixin, TemplateView): # if user opted to save their progress, # return them to the page they were already on if button == "save": + messages.success(request, "Your progress has been saved!") return self.goto(self.steps.current) # otherwise, proceed as normal return self.goto_next_step()