Merge pull request #2973 from cisagov/za/2771-create-requesting-entit…

…y-page

#2771 + #3015: Create requesting entity page - [MEOWARD]

src/.pa11yci

@@ -20,6 +20,7 @@
         "http://localhost:8080/request/anything_else/",
         "http://localhost:8080/request/requirements/",
         "http://localhost:8080/request/finished/",
+        "http://localhost:8080/request/requesting_entity/",
         "http://localhost:8080/user-profile/",
         "http://localhost:8080/members/",
         "http://localhost:8080/members/new-member"

src/registrar/admin.py

@@ -28,6 +28,7 @@
 from registrar.models import Contact, Domain, DomainRequest, DraftDomain, User, Website, SeniorOfficial
 from registrar.utility.constants import BranchChoices
 from registrar.utility.errors import FSMDomainRequestError, FSMErrorCodes
+from registrar.utility.waffle import flag_is_active_for_user
 from registrar.views.utility.mixins import OrderableFieldsMixin
 from django.contrib.admin.views.main import ORDER_VAR
 from registrar.widgets import NoAutocompleteFilteredSelectMultiple
@@ -1478,7 +1479,18 @@ class DomainInformationAdmin(ListHeaderAdmin, ImportExportModelAdmin):
     search_help_text = "Search by domain."
 
     fieldsets = [
-        (None, {"fields": ["portfolio", "sub_organization", "creator", "domain_request", "notes"]}),
+        (
+            None,
+            {
+                "fields": [
+                    "portfolio",
+                    "sub_organization",
+                    "creator",
+                    "domain_request",
+                    "notes",
+                ]
+            },
+        ),
         (".gov domain", {"fields": ["domain"]}),
         ("Contacts", {"fields": ["senior_official", "other_contacts", "no_other_contacts_rationale"]}),
         ("Background info", {"fields": ["anything_else"]}),
@@ -1748,6 +1760,9 @@ def status_history(self, obj):
                 "fields": [
                     "portfolio",
                     "sub_organization",
+                    "requested_suborganization",
+                    "suborganization_city",
+                    "suborganization_state_territory",
                     "status_history",
                     "status",
                     "rejection_reason",
@@ -1849,6 +1864,9 @@ def status_history(self, obj):
         "cisa_representative_first_name",
         "cisa_representative_last_name",
         "cisa_representative_email",
+        "requested_suborganization",
+        "suborganization_city",
+        "suborganization_state_territory",
     ]
     autocomplete_fields = [
         "approved_domain",
@@ -1868,6 +1886,25 @@ def status_history(self, obj):
 
     change_form_template = "django/admin/domain_request_change_form.html"
 
+    def get_fieldsets(self, request, obj=None):
+        fieldsets = super().get_fieldsets(request, obj)
+
+        # Hide certain suborg fields behind the organization feature flag
+        # if it is not enabled
+        if not flag_is_active_for_user(request.user, "organization_feature"):
+            excluded_fields = [
+                "requested_suborganization",
+                "suborganization_city",
+                "suborganization_state_territory",
+            ]
+            modified_fieldsets = []
+            for name, data in fieldsets:
+                fields = data.get("fields", [])
+                fields = tuple(field for field in fields if field not in excluded_fields)
+                modified_fieldsets.append((name, {**data, "fields": fields}))
+            return modified_fieldsets
+        return fieldsets
+
     # Trigger action when a fieldset is changed
     def save_model(self, request, obj, form, change):
         """Custom save_model definition that handles edge cases"""

src/registrar/assets/js/get-gov-admin.js

@@ -47,10 +47,49 @@ function addOrRemoveSessionBoolean(name, add){
 
 // <<>><<>><<>><<>><<>><<>><<>><<>><<>><<>><<>><<>><<>><<>><<>>
 // Event handlers.
+/** Helper function that handles business logic for the suborganization field.
+ * Can be used anywhere the suborganization dropdown exists
+*/
+function handleSuborganizationFields(
+    portfolioDropdownSelector="#id_portfolio",
+    suborgDropdownSelector="#id_sub_organization", 
+    requestedSuborgFieldSelector=".field-requested_suborganization", 
+    suborgCitySelector=".field-suborganization_city", 
+    suborgStateTerritorySelector=".field-suborganization_state_territory"
+) {
+    // These dropdown are select2 fields so they must be interacted with via jquery
+    const portfolioDropdown = django.jQuery(portfolioDropdownSelector)
+    const suborganizationDropdown = django.jQuery(suborgDropdownSelector)
+    const requestedSuborgField = document.querySelector(requestedSuborgFieldSelector);
+    const suborgCity = document.querySelector(suborgCitySelector);
+    const suborgStateTerritory = document.querySelector(suborgStateTerritorySelector);
+    if (!suborganizationDropdown || !requestedSuborgField || !suborgCity || !suborgStateTerritory) {
+        console.error("Requested suborg fields not found.");
+        return;
+    }
+
+    function toggleSuborganizationFields() {
+        if (portfolioDropdown.val() && !suborganizationDropdown.val()) {
+            showElement(requestedSuborgField);
+            showElement(suborgCity);
+            showElement(suborgStateTerritory);
+        }else {
+            hideElement(requestedSuborgField);
+            hideElement(suborgCity);
+            hideElement(suborgStateTerritory);
+        }
+    }
+
+    // Run the function once on page startup, then attach an event listener
+    toggleSuborganizationFields();
+    suborganizationDropdown.on("change", toggleSuborganizationFields);
+    portfolioDropdown.on("change", toggleSuborganizationFields);
+}
 
 // <<>><<>><<>><<>><<>><<>><<>><<>><<>><<>><<>><<>><<>><<>><<>>
 // Initialization code.
 
+
 /** An IIFE for pages in DjangoAdmin that use modals.
  * Dja strips out form elements, and modals generate their content outside
  * of the current form scope, so we need to "inject" these inputs.
@@ -1170,3 +1209,28 @@ document.addEventListener('DOMContentLoaded', function() {
         };
     }
 })();
+
+/** An IIFE for dynamic DomainRequest fields
+*/
+(function dynamicDomainRequestFields(){
+    const domainRequestPage = document.getElementById("domainrequest_form");
+    if (domainRequestPage) {
+        handleSuborganizationFields();
+    }
+})();
+
+
+/** An IIFE for dynamic DomainInformation fields
+*/
+(function dynamicDomainInformationFields(){
+    const domainInformationPage = document.getElementById("domaininformation_form");
+    // DomainInformation is embedded inside domain so this should fire there too
+    const domainPage = document.getElementById("domain_form");
+    if (domainInformationPage) {
+        handleSuborganizationFields();
+    }
+
+    if (domainPage) {
+        handleSuborganizationFields(portfolioDropdownSelector="#id_domain_info-0-portfolio", suborgDropdownSelector="#id_domain_info-0-sub_organization");
+    }
+})();

src/registrar/assets/js/get-gov.js

@@ -26,8 +26,8 @@ const hideElement = (element) => {
 };
 
 /**
- * Show element
- *
+* Show element
+*
 */
 const showElement = (element) => {
   element.classList.remove('display-none');
@@ -2775,3 +2775,48 @@ document.addEventListener('DOMContentLoaded', function() {
     }
   }
 })();
+
+/** An IIFE that intializes the requesting entity page.
+ * This page has a radio button that dynamically toggles some fields
+ * Within that, the dropdown also toggles some additional form elements.
+*/
+(function handleRequestingEntityFieldset() { 
+  // Sadly, these ugly ids are the auto generated with this prefix
+  const formPrefix = "portfolio_requesting_entity"
+  const radioFieldset = document.getElementById(`id_${formPrefix}-requesting_entity_is_suborganization__fieldset`);
+  const radios = radioFieldset?.querySelectorAll(`input[name="${formPrefix}-requesting_entity_is_suborganization"]`);
+  const select = document.getElementById(`id_${formPrefix}-sub_organization`);
+  const suborgContainer = document.getElementById("suborganization-container");
+  const suborgDetailsContainer = document.getElementById("suborganization-container__details");
+  if (!radios || !select || !suborgContainer || !suborgDetailsContainer) return;
+
+  // requestingSuborganization: This just broadly determines if they're requesting a suborg at all
+  // requestingNewSuborganization: This variable determines if the user is trying to *create* a new suborganization or not.
+  var requestingSuborganization = Array.from(radios).find(radio => radio.checked)?.value === "True";
+  var requestingNewSuborganization = document.getElementById(`id_${formPrefix}-is_requesting_new_suborganization`);
+
+  function toggleSuborganization(radio=null) {
+    if (radio != null) requestingSuborganization = radio?.checked && radio.value === "True";
+    requestingSuborganization ? showElement(suborgContainer) : hideElement(suborgContainer);
+    requestingNewSuborganization.value = requestingSuborganization && select.value === "other" ? "True" : "False";
+    requestingNewSuborganization.value === "True" ? showElement(suborgDetailsContainer) : hideElement(suborgDetailsContainer);
+  }
+
+  // Add fake "other" option to sub_organization select
+  if (select && !Array.from(select.options).some(option => option.value === "other")) {
+    select.add(new Option("Other (enter your organization manually)", "other"));
+  }
+
+  if (requestingNewSuborganization.value === "True") {
+    select.value = "other";
+  }
+
+  // Add event listener to is_suborganization radio buttons, and run for initial display
+  toggleSuborganization();
+  radios.forEach(radio => {
+    radio.addEventListener("click", () => toggleSuborganization(radio));
+  });
+
+  // Add event listener to the suborg dropdown to show/hide the suborg details section
+  select.addEventListener("change", () => toggleSuborganization());
+})();

src/registrar/forms/domain_request_wizard.py

@@ -13,7 +13,7 @@
     BaseYesNoForm,
     BaseDeletableRegistrarForm,
 )
-from registrar.models import Contact, DomainRequest, DraftDomain, Domain, FederalAgency
+from registrar.models import Contact, DomainRequest, DraftDomain, Domain, FederalAgency, Suborganization
 from registrar.templatetags.url_helpers import public_site_url
 from registrar.utility.enums import ValidationReturnType
 from registrar.utility.constants import BranchChoices
@@ -22,11 +22,147 @@
 
 
 class RequestingEntityForm(RegistrarForm):
-    organization_name = forms.CharField(
-        label="Organization name",
-        error_messages={"required": "Enter the name of your organization."},
+    """The requesting entity form contains a dropdown for suborganizations,
+    and some (hidden by default) input fields that allow the user to request for a suborganization.
+    All of these fields are not required by default, but as we use javascript to conditionally show
+    and hide some of these, they then become required in certain circumstances."""
+
+    # IMPORTANT: This is tied to DomainRequest.is_requesting_new_suborganization().
+    # This is due to the from_database method on DomainRequestWizard.
+    # Add a hidden field to store if the user is requesting a new suborganization.
+    # This hidden boolean is used for our javascript to communicate to us and to it.
+    # If true, the suborganization form will auto select a js value "Other".
+    # If this selection is made on the form (tracked by js), then it will toggle the form value of this.
+    # In other words, this essentially tracks if the suborganization field == "Other".
+    # "Other" is just an imaginary value that is otherwise invalid.
+    # Note the logic in `def clean` and `handleRequestingEntityFieldset` in get-gov.js
+    is_requesting_new_suborganization = forms.BooleanField(required=False, widget=forms.HiddenInput())
+
+    sub_organization = forms.ModelChoiceField(
+        label="Suborganization name",
+        required=False,
+        queryset=Suborganization.objects.none(),
+        empty_label="--Select--",
+    )
+    requested_suborganization = forms.CharField(
+        label="Requested suborganization",
+        required=False,
+    )
+    suborganization_city = forms.CharField(
+        label="City",
+        required=False,
+    )
+    suborganization_state_territory = forms.ChoiceField(
+        label="State, territory, or military post",
+        required=False,
+        choices=[("", "--Select--")] + DomainRequest.StateTerritoryChoices.choices,
     )
 
+    def __init__(self, *args, **kwargs):
+        """Override of init to add the suborganization queryset"""
+        super().__init__(*args, **kwargs)
+
+        if self.domain_request.portfolio:
+            self.fields["sub_organization"].queryset = Suborganization.objects.filter(
+                portfolio=self.domain_request.portfolio
+            )
+
+    def clean_sub_organization(self):
+        """On suborganization clean, set the suborganization value to None if the user is requesting
+        a custom suborganization (as it doesn't exist yet)"""
+
+        # If it's a new suborganization, return None (equivalent to selecting nothing)
+        if self.cleaned_data.get("is_requesting_new_suborganization"):
+            return None
+
+        # Otherwise just return the suborg as normal
+        return self.cleaned_data.get("sub_organization")
+
+    def full_clean(self):
+        """Validation logic to remove the custom suborganization value before clean is triggered.
+        Without this override, the form will throw an 'invalid option' error."""
+        # Remove the custom other field before cleaning
+        data = self.data.copy() if self.data else None
+
+        # Remove the 'other' value from suborganization if it exists.
+        # This is a special value that tracks if the user is requesting a new suborg.
+        suborganization = self.data.get("portfolio_requesting_entity-sub_organization")
+        if suborganization and "other" in suborganization:
+            data["portfolio_requesting_entity-sub_organization"] = ""
+
+        # Set the modified data back to the form
+        self.data = data
+
+        # Call the parent's full_clean method
+        super().full_clean()
+
+    def clean(self):
+        """Custom clean implementation to handle our desired logic flow for suborganization.
+        Given that these fields often rely on eachother, we need to do this in the parent function."""
+        cleaned_data = super().clean()
+
+        # Do some custom error validation if the requesting entity is a suborg.
+        # Otherwise, just validate as normal.
+        suborganization = self.cleaned_data.get("sub_organization")
+        is_requesting_new_suborganization = self.cleaned_data.get("is_requesting_new_suborganization")
+
+        # Get the value of the yes/no checkbox from RequestingEntityYesNoForm.
+        # Since self.data stores this as a string, we need to convert "True" => True.
+        requesting_entity_is_suborganization = self.data.get(
+            "portfolio_requesting_entity-requesting_entity_is_suborganization"
+        )
+        if requesting_entity_is_suborganization == "True":
+            if is_requesting_new_suborganization:
+                # Validate custom suborganization fields
+                if not cleaned_data.get("requested_suborganization"):
+                    self.add_error("requested_suborganization", "Requested suborganization is required.")
+                if not cleaned_data.get("suborganization_city"):
+                    self.add_error("suborganization_city", "City is required.")
+                if not cleaned_data.get("suborganization_state_territory"):
+                    self.add_error("suborganization_state_territory", "State, territory, or military post is required.")
+            elif not suborganization:
+                self.add_error("sub_organization", "Suborganization is required.")
+
+        return cleaned_data
+
+
+class RequestingEntityYesNoForm(BaseYesNoForm):
+    """The yes/no field for the RequestingEntity form."""
+
+    # This first option will change dynamically
+    form_choices = ((False, "Current Organization"), (True, "A suborganization. (choose from list)"))
+
+    # IMPORTANT: This is tied to DomainRequest.is_requesting_new_suborganization().
+    # This is due to the from_database method on DomainRequestWizard.
+    field_name = "requesting_entity_is_suborganization"
+    required_error_message = "Requesting entity is required."
+
+    def __init__(self, *args, **kwargs):
+        """Extend the initialization of the form from RegistrarForm __init__"""
+        super().__init__(*args, **kwargs)
+        if self.domain_request.portfolio:
+            self.form_choices = (
+                (False, self.domain_request.portfolio),
+                (True, "A suborganization (choose from list)"),
+            )
+        self.fields[self.field_name] = self.get_typed_choice_field()
+
+    @property
+    def form_is_checked(self):
+        """
+        Determines the initial checked state of the form.
+        Returns True (checked) if the requesting entity is a suborganization,
+        and False if it is a portfolio. Returns None if neither condition is met.
+        """
+        # True means that the requesting entity is a suborganization,
+        # whereas False means that the requesting entity is a portfolio.
+        if self.domain_request.requesting_entity_is_suborganization():
+            return True
+        elif self.domain_request.requesting_entity_is_portfolio():
+            return False
+        else:
+            return None
+
 
 class OrganizationTypeForm(RegistrarForm):
     generic_org_type = forms.ChoiceField(