29852 - Adding FF to Filings (bcgov#3715)

Rajandeep98 · web-flow · commit c5a49b898679 · 2025-08-22T09:19:51.000-07:00
* 29852 - Adding FF to Filings

* updated message

* updated linting

* added business summary flag

* updated condition

* only summary doc

* updated http code

* added agm extension

* local file update

* updated all types for local

* updated

* updated mocked flags

* updated flags

* flags mock update

* testing update
diff --git a/legal-api/src/legal_api/services/business/validations/validator.py b/legal-api/src/legal_api/services/business/validations/validator.py
@@ -18,6 +18,7 @@
 
 from legal_api.errors import Error
 from legal_api.models import Business
+from legal_api.services import flags
 
 
 document_rule_set = {
@@ -40,7 +41,10 @@ def validate_document_request(document_type, business: Business):
     """Validate the business document request."""
     errors = []
     # basic checks
-
+    enabled_filings = flags.value('enabled-business-summary-entities').split()
+    if enabled_filings and document_type == 'summary' and business.legal_type not in enabled_filings:
+        return Error(HTTPStatus.FORBIDDEN,
+                     [{'error': babel(f'{business.legal_type} is not enabled business summary.')}])
     if document_rules := document_rule_set.get(document_type, None):
         excluded_legal_types = document_rules.get('excluded_types', None)
         if excluded_legal_types and business.legal_type in excluded_legal_types:
diff --git a/legal-api/src/legal_api/services/filings/validations/agm_extension.py b/legal-api/src/legal_api/services/filings/validations/agm_extension.py
@@ -20,6 +20,7 @@
 # noqa: I003
 from legal_api.errors import Error
 from legal_api.models import Business
+from legal_api.services import flags
 from legal_api.utils.legislation_datetime import LegislationDatetime
 from ...utils import get_bool, get_int, get_str  # noqa: I003
 # noqa: I003
@@ -34,6 +35,10 @@ def validate(business: Business, filing: Dict) -> Optional[Error]:
     if not business or not filing:
         return Error(HTTPStatus.BAD_REQUEST, [{'error': babel('A valid business and filing are required.')}])
 
+    enabled_filings = flags.value('support-agm-extension-entities').split()
+    if enabled_filings and business.legal_type not in enabled_filings:
+        return Error(HTTPStatus.FORBIDDEN,
+                     [{'error': babel(f'{business.legal_type} does not support agm extension filing.')}])
     msg = []
 
     is_first_agm = get_bool(filing, f'{AGM_EXTENSION_PATH}/isFirstAgm')
diff --git a/legal-api/src/legal_api/services/filings/validations/agm_location_change.py b/legal-api/src/legal_api/services/filings/validations/agm_location_change.py
@@ -19,6 +19,7 @@
 # noqa: I003
 from legal_api.errors import Error
 from legal_api.models import Business
+from legal_api.services import flags
 from legal_api.services.utils import get_int
 from legal_api.utils.legislation_datetime import LegislationDatetime
 # noqa: I003
@@ -29,6 +30,11 @@ def validate(business: Business, filing: Dict) -> Optional[Error]:
     if not business or not filing:
         return Error(HTTPStatus.BAD_REQUEST, [{'error': babel('A valid business and filing are required.')}])
 
+    enabled_filings = flags.value('supported-agm-location-change-entities').split()
+    if enabled_filings and business.legal_type not in enabled_filings:
+        return Error(HTTPStatus.FORBIDDEN,
+                     [{'error': babel(f'{business.legal_type} does not support agm location change filing.')}])
+
     msg = []
 
     agm_year_path: Final = '/filing/agmLocationChange/year'
diff --git a/legal-api/src/legal_api/services/filings/validations/amalgamation_out.py b/legal-api/src/legal_api/services/filings/validations/amalgamation_out.py
@@ -19,6 +19,7 @@
 # noqa: I003
 from legal_api.errors import Error
 from legal_api.models import Business, ConsentContinuationOut
+from legal_api.services import flags
 from legal_api.services.filings.validations.common_validations import (
     validate_court_order,
     validate_foreign_jurisdiction,
@@ -33,6 +34,11 @@ def validate(business: Business, filing: Dict) -> Optional[Error]:
     if not business or not filing:
         return Error(HTTPStatus.BAD_REQUEST, [{'error': babel('A valid business and filing are required.')}])
 
+    enabled_filings = flags.value('supported-amalgamation-out-entities').split()
+    if enabled_filings and business.legal_type not in enabled_filings:
+        return Error(HTTPStatus.FORBIDDEN,
+                     [{'error': babel(f'{business.legal_type} does not support amalgamation out filing.')}])
+
     msg = []
     filing_type = 'amalgamationOut'
 
diff --git a/legal-api/src/legal_api/services/filings/validations/consent_amalgamation_out.py b/legal-api/src/legal_api/services/filings/validations/consent_amalgamation_out.py
@@ -20,6 +20,7 @@
 # noqa: I004
 from legal_api.errors import Error
 from legal_api.models import Business, ConsentContinuationOut
+from legal_api.services import flags
 from legal_api.services.filings.validations.common_validations import (
     validate_court_order,
     validate_foreign_jurisdiction,
@@ -37,6 +38,11 @@ def validate(business: Business, filing: Dict) -> Optional[Error]:
             'error': babel('Business should be Active and in Good Standing to file Consent Amalgamation Out.')
         }])
 
+    enabled_filings = flags.value('supported-consent-amalgamation-out-entities').split()
+    if enabled_filings and business.legal_type not in enabled_filings:
+        return Error(HTTPStatus.FORBIDDEN,
+                     [{'error': babel(f'{business.legal_type} does not support consent amalgamation out filing.')}])
+
     msg = []
     filing_type = 'consentAmalgamationOut'
 
diff --git a/legal-api/src/legal_api/services/filings/validations/consent_continuation_out.py b/legal-api/src/legal_api/services/filings/validations/consent_continuation_out.py
@@ -20,6 +20,7 @@
 # noqa: I004
 from legal_api.errors import Error
 from legal_api.models import Business, ConsentContinuationOut
+from legal_api.services import flags
 from legal_api.services.filings.validations.common_validations import (
     validate_court_order,
     validate_foreign_jurisdiction,
@@ -37,6 +38,11 @@ def validate(business: Business, filing: Dict) -> Optional[Error]:
             'error': babel('Business should be Active and in Good Standing to file Consent Continuation Out.')
         }])
 
+    enabled_filings = flags.value('supported-consent-continuation-out-entities').split()
+    if enabled_filings and business.legal_type not in enabled_filings:
+        return Error(HTTPStatus.FORBIDDEN,
+                     [{'error': babel(f'{business.legal_type} does not support consent continuation out filing.')}])
+
     msg = []
     filing_type = 'consentContinuationOut'
 
diff --git a/legal-api/src/legal_api/services/filings/validations/continuation_in.py b/legal-api/src/legal_api/services/filings/validations/continuation_in.py
@@ -19,7 +19,7 @@
 
 from legal_api.errors import Error
 from legal_api.models import Business, PartyRole
-from legal_api.services import colin
+from legal_api.services import colin, flags
 from legal_api.services.filings.validations.common_validations import (
     validate_court_order,
     validate_foreign_jurisdiction,
@@ -54,6 +54,11 @@ def validate(filing_json: dict) -> Optional[Error]:  # pylint: disable=too-many-
         msg.append({'error': babel('Legal type is required.'), 'path': legal_type_path})
         return msg  # Cannot continue validation without legal_type
 
+    enabled_filings = flags.value('supported-continuation-in-entities').split()
+    if enabled_filings and legal_type not in enabled_filings:
+        return Error(HTTPStatus.FORBIDDEN,
+                     [{'error': babel(f'{legal_type} does not support continuation in filing.')}])
+
     msg.extend(validate_business_in_colin(filing_json, filing_type))
     msg.extend(validate_continuation_in_authorization(filing_json, filing_type, legal_type))
     msg.extend(_validate_foreign_jurisdiction(filing_json, filing_type, legal_type))
diff --git a/legal-api/src/legal_api/services/filings/validations/continuation_out.py b/legal-api/src/legal_api/services/filings/validations/continuation_out.py
@@ -19,6 +19,7 @@
 # noqa: I003
 from legal_api.errors import Error
 from legal_api.models import Business, ConsentContinuationOut
+from legal_api.services import flags
 from legal_api.services.filings.validations.common_validations import (
     validate_court_order,
     validate_foreign_jurisdiction,
@@ -33,6 +34,11 @@ def validate(business: Business, filing: Dict) -> Optional[Error]:
     if not business or not filing:
         return Error(HTTPStatus.BAD_REQUEST, [{'error': babel('A valid business and filing are required.')}])
 
+    enabled_filings = flags.value('supported-continuation-out-entities').split()
+    if enabled_filings and business.legal_type not in enabled_filings:
+        return Error(HTTPStatus.FORBIDDEN,
+                     [{'error': babel(f'{business.legal_type} does not support continuation out filing.')}])
+
     msg = []
     filing_type = 'continuationOut'
 
diff --git a/legal-api/src/legal_api/services/filings/validations/put_back_on.py b/legal-api/src/legal_api/services/filings/validations/put_back_on.py
@@ -19,6 +19,7 @@
 # noqa: I004
 from legal_api.errors import Error
 from legal_api.models import Business
+from legal_api.services import flags
 from legal_api.services.filings.validations.common_validations import validate_court_order
 from legal_api.services.utils import get_str  # noqa: I003; needed as the linter gets confused from the babel override.
 
@@ -27,6 +28,11 @@ def validate(business: Business, put_back_on: Dict) -> Optional[Error]:
     """Validate the Court Order filing."""
     if not business or not put_back_on:
         return Error(HTTPStatus.BAD_REQUEST, [{'error': babel('A valid business and filing are required.')}])
+
+    enabled_filings = flags.value('supported-put-back-on-entities').split()
+    if enabled_filings and business.legal_type not in enabled_filings:
+        return Error(HTTPStatus.FORBIDDEN,
+                     [{'error': babel(f'{business.legal_type} does not support put back on filing.')}])
     msg = []
 
     if not get_str(put_back_on, '/filing/putBackOn/details'):
diff --git a/legal-api/tests/unit/resources/v2/test_business_documents.py b/legal-api/tests/unit/resources/v2/test_business_documents.py
@@ -251,7 +251,7 @@ def test_get_coop_documents_with_correction_and_special_resolution(session, clie
     assert info_mem.get('includedInResolutionDate') == '2021-01-01T00:00:00+00:00'
 
 
-def test_get_business_summary_involuntary_dissolution(requests_mock, session, client, jwt):
+def test_get_business_summary_involuntary_dissolution(requests_mock, session, client, jwt, monkeypatch):
     """Assert that business summary returns correct information for Involuntary Dissolution."""
     # setup
     identifier = 'CP7654321'
@@ -282,6 +282,10 @@ def test_get_business_summary_involuntary_dissolution(requests_mock, session, cl
     # create and save the filing
     factory_completed_filing(business, INVOLUNTARY_DISSOLUTION, filing_type='dissolution',
                                       filing_sub_type='involuntary')
+    monkeypatch.setattr(
+        'legal_api.services.flags.value',
+        lambda flag: "CP BEN SP GP CBEN BC CC ULC C CCC CUL"  if flag == 'enabled-business-summary-entities' else {}
+    )
     # mock the meta_data property
     with patch('legal_api.models.Filing.meta_data', new_callable=PropertyMock) as mock_meta_data:
         mock_meta_data.return_value = {
diff --git a/legal-api/tests/unit/resources/v2/test_business_filings/test_filings.py b/legal-api/tests/unit/resources/v2/test_business_filings/test_filings.py
@@ -1611,8 +1611,12 @@ def test_rules_memorandum_in_sr(session, mocker, requests_mock, client, jwt, ):
         (Filing.Status.APPROVED.value, ReviewStatus.APPROVED),
     ]
 )
-def test_submit_or_resubmit_filing(session, client, jwt, mocker, requests_mock, filing_status, review_status):
+def test_submit_or_resubmit_filing(session, client, jwt, mocker, requests_mock, filing_status, review_status, monkeypatch):
     """Assert that the a filing can be submitted/resubmitted."""
+    monkeypatch.setattr(
+        'legal_api.services.flags.value',
+        lambda flag: "C CBEN CCC CUL"  if flag == 'supported-continuation-in-entities' else {}
+    )
     identifier = 'Tb31yQIuBw'
     temp_reg = RegistrationBootstrap()
     temp_reg._identifier = identifier
diff --git a/legal-api/tests/unit/services/business/validations/test_validator.py b/legal-api/tests/unit/services/business/validations/test_validator.py
@@ -50,8 +50,12 @@
         ('FAIL', 'cogs', 'GP', 'FM1234567', 'Specified document type is not valid for the entity.'),
     ]
 )
-def test_document_legal_type(session, test_status, document_type, legal_type, identifier, expected_msg):
+def test_document_legal_type(session, test_status, document_type, legal_type, identifier, expected_msg, monkeypatch):
     """Assert valid document legal type."""
+    monkeypatch.setattr(
+        'legal_api.services.flags.value',
+        lambda flag: "CP BEN SP GP CBEN BC CC ULC C CCC CUL"  if flag == 'enabled-business-summary-entities' else {}
+    )
     business = factory_business(identifier,
                                 founding_date=(datetime.now(timezone.utc) - datedelta.YEAR),
                                 last_ar_date=datetime.now(timezone.utc),
diff --git a/legal-api/tests/unit/services/filings/validations/test_agm_extension.py b/legal-api/tests/unit/services/filings/validations/test_agm_extension.py
@@ -58,15 +58,18 @@
           HTTPStatus.BAD_REQUEST, 'Company has received the maximum 12 months of allowable extensions.')
     ]
 )
-def test_validate_agm_extension(session, mocker, test_name, founding_date, agm_ext_json, expected_code, message):
+def test_validate_agm_extension(session, mocker, test_name, founding_date, agm_ext_json, expected_code, message, monkeypatch):
     """Assert validate AGM extension."""
     business = factory_business(
         identifier='BC1234567', entity_type='BC', founding_date=LegislationDatetime.as_legislation_timezone_from_date_str(founding_date)
     )
     filing = copy.deepcopy(FILING_HEADER)
     filing['filing']['agmExtension'] = agm_ext_json
     filing['filing']['header']['name'] = 'agmExtension'
-
+    monkeypatch.setattr(
+        'legal_api.services.flags.value',
+        lambda flag: "BC BEN CC ULC C CBEN CCC CUL"  if flag == 'support-agm-extension-entities' else {}
+    )
     with patch.object(LegislationDatetime, 'now', return_value=LegislationDatetime.as_legislation_timezone_from_date_str('2024-01-01')):
         err = validate(business, filing)
         
diff --git a/legal-api/tests/unit/services/filings/validations/test_agm_location_change.py b/legal-api/tests/unit/services/filings/validations/test_agm_location_change.py
@@ -36,8 +36,12 @@
         ('SUCCESS', None, None)
     ]
 )
-def test_validate_agm_year(session, mocker, test_name, expected_code, message):
+def test_validate_agm_year(session, mocker, test_name, expected_code, message, monkeypatch):
     """Assert validate agm year."""
+    monkeypatch.setattr(
+        'legal_api.services.flags.value',
+        lambda flag: "BC BEN CC ULC C CBEN CCC CUL"  if flag == 'supported-agm-location-change-entities' else {}
+    )
     business = factory_business(identifier='BC1234567', entity_type='BC', founding_date=datetime.utcnow())
     filing = copy.deepcopy(FILING_HEADER)
     filing['filing']['agmLocationChange'] = copy.deepcopy(AGM_LOCATION_CHANGE)
diff --git a/legal-api/tests/unit/services/filings/validations/test_amalgamation_out.py b/legal-api/tests/unit/services/filings/validations/test_amalgamation_out.py
@@ -61,8 +61,12 @@ def _create_consent_amalgamation_out(business, foreign_jurisdiction, effective_d
         ('SUCCESS', None, None)
     ]
 )
-def test_validate_amalgamation_out_date(session, test_name, expected_code, message):
+def test_validate_amalgamation_out_date(session, test_name, expected_code, message, monkeypatch):
     """Assert validate amalgamation_out_date."""
+    monkeypatch.setattr(
+        'legal_api.services.flags.value',
+        lambda flag: "BC BEN CC ULC C CBEN CCC CUL"  if flag == 'supported-amalgamation-out-entities' else {}
+    )
     business = factory_business(identifier='BC1234567', entity_type='BC', founding_date=datetime.utcnow())
     filing = copy.deepcopy(FILING_HEADER)
     filing['filing']['amalgamationOut'] = copy.deepcopy(AMALGAMATION_OUT)
@@ -101,8 +105,12 @@ def test_validate_amalgamation_out_date(session, test_name, expected_code, messa
         ('SUCCESS', None, None)
     ]
 )
-def test_validate_foreign_jurisdiction(session, mocker, test_name, expected_code, message):
+def test_validate_foreign_jurisdiction(session, mocker, test_name, expected_code, message, monkeypatch):
     """Assert validate foreign jurisdiction."""
+    monkeypatch.setattr(
+        'legal_api.services.flags.value',
+        lambda flag: "BC BEN CC ULC C CBEN CCC CUL"  if flag == 'supported-amalgamation-out-entities' else {}
+    )
     business = factory_business(identifier='BC1234567', entity_type='BC', founding_date=datetime.utcnow())
     filing = copy.deepcopy(FILING_HEADER)
     filing['filing']['amalgamationOut'] = copy.deepcopy(AMALGAMATION_OUT)
@@ -132,8 +140,12 @@ def test_validate_foreign_jurisdiction(session, mocker, test_name, expected_code
         assert not err
 
 
-def test_valid_foreign_jurisdiction(session, mocker):
+def test_valid_foreign_jurisdiction(session, mocker, monkeypatch):
     """Assert valid foreign jurisdiction."""
+    monkeypatch.setattr(
+        'legal_api.services.flags.value',
+        lambda flag: "BC BEN CC ULC C CBEN CCC CUL"  if flag == 'supported-amalgamation-out-entities' else {}
+    )
     business = factory_business(identifier='BC1234567', entity_type='BC', founding_date=datetime.utcnow())
     filing = copy.deepcopy(FILING_HEADER)
     filing['filing']['header']['name'] = 'amalgamationOut'
@@ -163,8 +175,12 @@ def test_valid_foreign_jurisdiction(session, mocker):
         ('SUCCESS', '12345678901234567890', None)
     ]
 )
-def test_amalgamation_out_court_order(session, mocker, test_status, file_number, expected_code):
+def test_amalgamation_out_court_order(session, mocker, test_status, file_number, expected_code, monkeypatch):
     """Assert valid court order."""
+    monkeypatch.setattr(
+        'legal_api.services.flags.value',
+        lambda flag: "BC BEN CC ULC C CBEN CCC CUL"  if flag == 'supported-amalgamation-out-entities' else {}
+    )
     business = factory_business(identifier='BC1234567', entity_type='BC', founding_date=datetime.utcnow())
     filing = copy.deepcopy(FILING_HEADER)
     filing['filing']['amalgamationOut'] = copy.deepcopy(AMALGAMATION_OUT)
diff --git a/legal-api/tests/unit/services/filings/validations/test_consent_amalgamation_out.py b/legal-api/tests/unit/services/filings/validations/test_consent_amalgamation_out.py
@@ -37,8 +37,12 @@
         ('SUCCESS', None)
     ]
 )
-def test_consent_amalgamation_out_active_and_good_standing(session, test_name, expected_code):
+def test_consent_amalgamation_out_active_and_good_standing(session, test_name, expected_code, monkeypatch):
     """Assert Consent Amalgamation Out can be filed."""
+    monkeypatch.setattr(
+        'legal_api.services.flags.value',
+        lambda flag: "BC BEN CC ULC C CBEN CCC CUL"  if flag == 'supported-consent-amalgamation-out-entities' else {}
+    )
     business = Business(
         identifier='BC1234567',
         legal_type='BC',
@@ -75,8 +79,12 @@ def test_consent_amalgamation_out_active_and_good_standing(session, test_name, e
         ('SUCCESS', None, None)
     ]
 )
-def test_validate_foreign_jurisdiction(session, test_name, expected_code, message):
+def test_validate_foreign_jurisdiction(session, test_name, expected_code, message, monkeypatch):
     """Assert validate foreign jurisdiction."""
+    monkeypatch.setattr(
+        'legal_api.services.flags.value',
+        lambda flag: "BC BEN CC ULC C CBEN CCC CUL"  if flag == 'supported-consent-amalgamation-out-entities' else {}
+    )
     business = Business(
         identifier='BC1234567',
         legal_type='BC',
@@ -110,8 +118,12 @@ def test_validate_foreign_jurisdiction(session, test_name, expected_code, messag
         assert not err
 
 
-def test_valid_foreign_jurisdiction(session):
+def test_valid_foreign_jurisdiction(session, monkeypatch):
     """Assert valid foreign jurisdiction."""
+    monkeypatch.setattr(
+            'legal_api.services.flags.value',
+            lambda flag: "BC BEN CC ULC C CBEN CCC CUL"  if flag == 'supported-consent-amalgamation-out-entities' else {}
+        )
     business = Business(
         identifier='BC1234567',
         legal_type='BC',
@@ -146,8 +158,12 @@ def test_valid_foreign_jurisdiction(session):
         ('SUCCESS', None, None)
     ]
 )
-def test_validate_existing_cco(session, test_name, expected_code, message):
+def test_validate_existing_cco(session, test_name, expected_code, message, monkeypatch):
     """Assert validate foreign jurisdiction exist."""
+    monkeypatch.setattr(
+            'legal_api.services.flags.value',
+            lambda flag: "BC BEN CC ULC C CBEN CCC CUL"  if flag == 'supported-consent-amalgamation-out-entities' else {}
+        )
     business = factory_business(identifier='BC1234567', entity_type='BC', founding_date=datetime.utcnow())
     filing = copy.deepcopy(FILING_HEADER)
     filing['filing']['consentAmalgamationOut'] = copy.deepcopy(CONSENT_AMALGAMATION_OUT)
@@ -189,8 +205,12 @@ def test_validate_existing_cco(session, test_name, expected_code, message):
         ('SUCCESS', '12345678901234567890', None)
     ]
 )
-def test_consent_amalgamation_out_court_order(session, test_status, file_number, expected_code):
+def test_consent_amalgamation_out_court_order(session, test_status, file_number, expected_code, monkeypatch):
     """Assert valid court order."""
+    monkeypatch.setattr(
+            'legal_api.services.flags.value',
+            lambda flag: "BC BEN CC ULC C CBEN CCC CUL"  if flag == 'supported-consent-amalgamation-out-entities' else {}
+        )
     business = Business(
         identifier='BC1234567',
         legal_type='BC',
diff --git a/legal-api/tests/unit/services/filings/validations/test_consent_continuation_out.py b/legal-api/tests/unit/services/filings/validations/test_consent_continuation_out.py
diff --git a/legal-api/tests/unit/services/filings/validations/test_continuation_in.py b/legal-api/tests/unit/services/filings/validations/test_continuation_in.py
diff --git a/legal-api/tests/unit/services/filings/validations/test_continuation_out.py b/legal-api/tests/unit/services/filings/validations/test_continuation_out.py
diff --git a/legal-api/tests/unit/services/filings/validations/test_put_back_off.py b/legal-api/tests/unit/services/filings/validations/test_put_back_off.py
