[Issue #7071] Filter out select application forms from XML generation (#7085)

## Summary

<!-- Use "Fixes" to automatically close issue upon PR merge. Use "Work
for" when UAT is required. -->
Fixes #7071 

## Changes proposed

<!-- What was added, updated, or removed in this PR. -->
Update XML assembler to apply the same rules as we do for application
submission for form inclusion.

## Context for reviewers

<!-- Technical or background context, more in-depth details of the
implementation, and anything else you'd like reviewers to know about
that will help them understand the changes in the PR. -->
Similar to application submission, confirm only required and forms
included in the submission are part of the XML generation process.

## Validation steps

<!-- Manual testing instructions, as well as any helpful references
(screenshots, GIF demos, code examples or output). -->
See new unit tests.

Author: mikehgrantsgov

api/src/services/xml_generation/submission_xml_assembler.py

@@ -6,6 +6,7 @@
 from lxml import etree as lxml_etree
 
 from src.db.models.competition_models import Application, ApplicationForm, ApplicationSubmission
+from src.services.applications.application_validation import is_form_required
 from src.services.xml_generation.header_generator import (
     generate_application_footer_xml,
     generate_application_header_xml,
@@ -33,13 +34,22 @@ def __init__(
     def get_supported_forms(self) -> list[ApplicationForm]:
         """Get list of application forms that are supported for XML generation.
 
+        Filters out forms that are:
+        - Not required AND not included in submission
+        - Don't have XML transform config
+
         Returns:
             List of ApplicationForm objects for supported forms only
         """
         supported_forms = []
 
         for app_form in self.application.application_forms:
             form_name = app_form.form.short_form_name
+
+            # Skip forms that are not required and not included in submission
+            if not is_form_required(app_form) and not app_form.is_included_in_submission:
+                continue
+
             if app_form.form.json_to_xml_schema is not None:
                 supported_forms.append(app_form)
             else:

api/tests/src/services/xml_generation/test_submission_xml_assembler.py

@@ -468,3 +468,123 @@ def test_generate_complete_submission_xml_namespace_handling(
         assert "http://apply.grants.gov/system/Header-V1.0" in root.nsmap.values()
         assert "http://apply.grants.gov/system/Footer-V1.0" in root.nsmap.values()
         assert "http://apply.grants.gov/system/Global-V1.0" in root.nsmap.values()
+
+    def test_get_supported_forms_filters_non_required_not_included(
+        self, sample_application, sample_application_submission, enable_factory_create
+    ):
+        """Test that non-required forms with is_included_in_submission=False are filtered out."""
+        # Create a non-required form with XML support
+        optional_form = FormFactory.create(
+            form_name="Optional Form",
+            short_form_name="OPTIONAL_1_0",
+            form_version="1.0",
+            json_to_xml_schema=FORM_XML_TRANSFORM_RULES,  # Has XML support
+        )
+
+        # Create competition form marked as NOT required
+        competition_form = CompetitionFormFactory.create(
+            competition=sample_application.competition,
+            form=optional_form,
+            is_required=False,  # NOT required
+        )
+
+        # Create application form with is_included_in_submission=False
+        ApplicationFormFactory.create(
+            application=sample_application,
+            competition_form=competition_form,
+            application_response={"some_field": "some_value"},
+            is_included_in_submission=False,  # NOT included
+        )
+
+        assembler = SubmissionXMLAssembler(sample_application, sample_application_submission)
+        supported_forms = assembler.get_supported_forms()
+
+        # Should only return SF424_4_0 (required), not the optional form
+        assert len(supported_forms) == 1
+        assert supported_forms[0].form.short_form_name == "SF424_4_0"
+
+    def test_get_supported_forms_includes_non_required_when_included(
+        self, sample_application, sample_application_submission, enable_factory_create
+    ):
+        """Test that non-required forms with is_included_in_submission=True are included."""
+        # Create a non-required form with XML support
+        optional_form = FormFactory.create(
+            form_name="Optional Form",
+            short_form_name="OPTIONAL_1_0",
+            form_version="1.0",
+            json_to_xml_schema=FORM_XML_TRANSFORM_RULES,  # Has XML support
+        )
+
+        # Create competition form marked as NOT required
+        competition_form = CompetitionFormFactory.create(
+            competition=sample_application.competition,
+            form=optional_form,
+            is_required=False,  # NOT required
+        )
+
+        # Create application form with is_included_in_submission=True
+        ApplicationFormFactory.create(
+            application=sample_application,
+            competition_form=competition_form,
+            application_response={"some_field": "some_value"},
+            is_included_in_submission=True,  # IS included
+        )
+
+        assembler = SubmissionXMLAssembler(sample_application, sample_application_submission)
+        supported_forms = assembler.get_supported_forms()
+
+        # Should return both SF424_4_0 and the optional form
+        assert len(supported_forms) == 2
+        form_names = {form.form.short_form_name for form in supported_forms}
+        assert "SF424_4_0" in form_names
+        assert "OPTIONAL_1_0" in form_names
+
+    def test_get_supported_forms_includes_required_regardless_of_is_included(
+        self, sample_application, sample_application_submission, enable_factory_create, db_session
+    ):
+        """Test that required forms are included regardless of is_included_in_submission value."""
+        # Update the existing SF424 form to have is_included_in_submission=False
+        # (should still be included because it's required)
+        sample_application.application_forms[0].is_included_in_submission = False
+        db_session.flush()
+
+        assembler = SubmissionXMLAssembler(sample_application, sample_application_submission)
+        supported_forms = assembler.get_supported_forms()
+
+        # Should still return SF424_4_0 because it's required
+        assert len(supported_forms) == 1
+        assert supported_forms[0].form.short_form_name == "SF424_4_0"
+
+    def test_get_supported_forms_filters_non_required_null_is_included(
+        self, sample_application, sample_application_submission, enable_factory_create
+    ):
+        """Test that non-required forms with is_included_in_submission=None are filtered out."""
+        # Create a non-required form with XML support
+        optional_form = FormFactory.create(
+            form_name="Optional Form",
+            short_form_name="OPTIONAL_1_0",
+            form_version="1.0",
+            json_to_xml_schema=FORM_XML_TRANSFORM_RULES,  # Has XML support
+        )
+
+        # Create competition form marked as NOT required
+        competition_form = CompetitionFormFactory.create(
+            competition=sample_application.competition,
+            form=optional_form,
+            is_required=False,  # NOT required
+        )
+
+        # Create application form with is_included_in_submission=None
+        ApplicationFormFactory.create(
+            application=sample_application,
+            competition_form=competition_form,
+            application_response={"some_field": "some_value"},
+            is_included_in_submission=None,  # NULL/None
+        )
+
+        assembler = SubmissionXMLAssembler(sample_application, sample_application_submission)
+        supported_forms = assembler.get_supported_forms()
+
+        # Should only return SF424_4_0 (required), not the optional form
+        assert len(supported_forms) == 1
+        assert supported_forms[0].form.short_form_name == "SF424_4_0"