Adding initial SocialWork compact codebase

[landonshumway-ia]

This change includes the initial addition of the Social Work Compact to the CompactConnect codebase.

The codebase from the Cosmetology compact was replicated into the social-work-app directory as a starting point to build off of, since both the Social Work and Cosmetology compacts follow the multi-state licensing model. The compact abbreviation has been updated across the configuration and tests, but the license types are still to be determined, so the tests still show references to the cosmetology license types in some areas. These will be updated once the license types are finalized in a future PR.

As we are adding more compacts to the project, it is necessary for us to consolidate most of our common CDK code that will be referenced across the various compact CDK apps into a common location. We initially set up the common-cdk for this purpose, and this PR includes pulling in all the common CDK constructs that we have found to be used consistently across both the JCC and Cosmetology projects. Test coverage has also been added for these constructs to bring our overall coverage to 90%

Requirements List

• The AWS accounts for this new compact have been provisioned and bootstrapped for CDK deployments. This PR is ready to be merged once approved.

Closes #1573

[coderabbitai]

Important

Review skipped

Too many files!

This PR contains 284 files, which is 134 over the limit of 150.

To get a review, narrow the scope:
• coderabbit review --type committed # exclude uncommitted changes
• coderabbit review --dir # limit to a subdirectory
• coderabbit review --base # compare against a closer base

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: cbd696ee-aed2-44ae-a40d-44374c626637

📥 Commits

Reviewing files that changed from the base of the PR and between 25d54ed and 84dd5ad.

⛔ Files ignored due to path filters (16)

• backend/common-cdk/tests/fixtures/branding/background.png is excluded by !**/*.png
• backend/common-cdk/tests/fixtures/branding/favicon.ico is excluded by !**/*.ico
• backend/common-cdk/tests/fixtures/branding/logo.png is excluded by !**/*.png
• backend/common-cdk/tests/fixtures/lambdas/nodejs/yarn.lock is excluded by !**/yarn.lock, !**/*.lock
• backend/social-work-app/docs/design/advanced-provider-search.pdf is excluded by !**/*.pdf
• backend/social-work-app/docs/design/cognito-user-states.pdf is excluded by !**/*.pdf
• backend/social-work-app/docs/design/high-level-arch-diagram.pdf is excluded by !**/*.pdf
• backend/social-work-app/docs/design/license-events-diagram.pdf is excluded by !**/*.pdf
• backend/social-work-app/docs/design/license-ingest-diagram.pdf is excluded by !**/*.pdf
• backend/social-work-app/docs/design/multi-account-arch-diagram.pdf is excluded by !**/*.pdf
• backend/social-work-app/docs/design/pipeline-architecture.pdf is excluded by !**/*.pdf
• backend/social-work-app/docs/design/practitioner-home-state-license-assignment.pdf is excluded by !**/*.pdf
• backend/social-work-app/docs/design/users-arch-diagram.pdf is excluded by !**/*.pdf
• backend/social-work-app/lambdas/nodejs/cognito-emails/handler.js.map is excluded by !**/*.map
• backend/social-work-app/lambdas/nodejs/cognito-emails/lambda.js.map is excluded by !**/*.map
• backend/social-work-app/lambdas/nodejs/yarn.lock is excluded by !**/yarn.lock, !**/*.lock

📒 Files selected for processing (284)

• .github/workflows/check-common-cdk.yml
• .github/workflows/check-social-work-app.yml
• backend/common-cdk/common_constructs/backup_plan.py
• backend/common-cdk/common_constructs/base_pipeline_stack.py
• backend/common-cdk/common_constructs/compact_connect_api.py
• backend/common-cdk/common_constructs/constants.py
• backend/common-cdk/common_constructs/frontend_app_config_utility.py
• backend/common-cdk/common_constructs/nodejs_function.py
• backend/common-cdk/common_constructs/python_common_layer_versions.py
• backend/common-cdk/common_constructs/python_function.py
• backend/common-cdk/common_constructs/queue_event_listener.py
• backend/common-cdk/common_constructs/queued_lambda_processor.py
• backend/common-cdk/common_constructs/ssm_parameter_utility.py
• backend/common-cdk/common_constructs/ssn_table.py
• backend/common-cdk/common_constructs/user_pool.py
• backend/common-cdk/common_constructs/webacl.py
• backend/common-cdk/common_stacks/README.md
• backend/common-cdk/common_stacks/backup_infrastructure_stack.py
• backend/common-cdk/tests/__init__.py
• backend/common-cdk/tests/fixtures/lambdas/nodejs/dummy/handler.ts
• backend/common-cdk/tests/fixtures/lambdas/python/common/requirements.txt
• backend/common-cdk/tests/fixtures/lambdas/python/provider-data-v1/handlers/ingest.py
• backend/common-cdk/tests/fixtures/resources/cognito-blocked-notification.txt
• backend/common-cdk/tests/fixtures/resources/cognito-no-action-notification.txt
• backend/common-cdk/tests/test_access_logs_bucket.py
• backend/common-cdk/tests/test_backup_plan.py
• backend/common-cdk/tests/test_bucket.py
• backend/common-cdk/tests/test_compact_connect_api.py
• backend/common-cdk/tests/test_constants.py
• backend/common-cdk/tests/test_nodejs_function.py
• backend/common-cdk/tests/test_queue_event_listener.py
• backend/common-cdk/tests/test_queued_lambda_processor.py
• backend/common-cdk/tests/test_security_profile.py
• backend/common-cdk/tests/test_service_principal_name.py
• backend/common-cdk/tests/test_ssm_parameter_utility.py
• backend/common-cdk/tests/test_ssn_table.py
• backend/common-cdk/tests/test_stack.py
• backend/common-cdk/tests/test_user_pool.py
• backend/common-cdk/tests/test_webacl.py
• backend/compact-connect/common_constructs/cognito_user_backup.py
• backend/compact-connect/common_constructs/data_migration.py
• backend/compact-connect/common_constructs/user_pool.py
• backend/compact-connect/lambdas/python/cognito-backup/requirements-dev.txt
• backend/compact-connect/lambdas/python/common/requirements-dev.in
• backend/compact-connect/lambdas/python/common/requirements-dev.txt
• backend/compact-connect/lambdas/python/common/requirements.in
• backend/compact-connect/lambdas/python/common/requirements.txt
• backend/compact-connect/lambdas/python/compact-configuration/requirements-dev.txt
• backend/compact-connect/lambdas/python/custom-resources/requirements-dev.txt
• backend/compact-connect/lambdas/python/data-events/requirements-dev.txt
• backend/compact-connect/lambdas/python/disaster-recovery/requirements-dev.txt
• backend/compact-connect/lambdas/python/provider-data-v1/requirements-dev.txt
• backend/compact-connect/lambdas/python/purchases/requirements-dev.in
• backend/compact-connect/lambdas/python/purchases/requirements-dev.txt
• backend/compact-connect/lambdas/python/purchases/requirements.txt
• backend/compact-connect/lambdas/python/search/requirements-dev.txt
• backend/compact-connect/lambdas/python/search/requirements.txt
• backend/compact-connect/lambdas/python/staff-user-pre-token/requirements-dev.txt
• backend/compact-connect/lambdas/python/staff-users/requirements-dev.txt
• backend/compact-connect/requirements-dev.txt
• backend/compact-connect/requirements.txt
• backend/compact-connect/stacks/api_lambda_stack/__init__.py
• backend/compact-connect/stacks/api_lambda_stack/attestations.py
• backend/compact-connect/stacks/api_lambda_stack/bulk_upload_url.py
• backend/compact-connect/stacks/api_lambda_stack/compact_configuration_api.py
• backend/compact-connect/stacks/api_lambda_stack/credentials.py
• backend/compact-connect/stacks/api_lambda_stack/feature_flags.py
• backend/compact-connect/stacks/api_lambda_stack/post_licenses.py
• backend/compact-connect/stacks/api_lambda_stack/provider_management.py
• backend/compact-connect/stacks/api_lambda_stack/provider_users.py
• backend/compact-connect/stacks/api_lambda_stack/public_lookup_api.py
• backend/compact-connect/stacks/api_lambda_stack/purchases.py
• backend/compact-connect/stacks/api_lambda_stack/staff_users.py
• backend/compact-connect/stacks/api_stack/v1_api/compact_configuration_api.py
• backend/compact-connect/stacks/api_stack/v1_api/provider_management.py
• backend/compact-connect/stacks/api_stack/v1_api/provider_users.py
• backend/compact-connect/stacks/disaster_recovery_stack/license_upload_rollback_step_function.py
• backend/compact-connect/stacks/disaster_recovery_stack/sync_table_step_function.py
• backend/compact-connect/stacks/event_listener_stack/__init__.py
• backend/compact-connect/stacks/expiration_reminder_stack/__init__.py
• backend/compact-connect/stacks/feature_flag_stack/__init__.py
• backend/compact-connect/stacks/ingest_stack.py
• backend/compact-connect/stacks/notification_stack.py
• backend/compact-connect/stacks/persistent_stack/__init__.py
• backend/compact-connect/stacks/persistent_stack/bulk_uploads_bucket.py
• backend/compact-connect/stacks/persistent_stack/compact_configuration_table.py
• backend/compact-connect/stacks/persistent_stack/compact_configuration_upload.py
• backend/compact-connect/stacks/persistent_stack/data_event_table.py
• backend/compact-connect/stacks/persistent_stack/provider_table.py
• backend/compact-connect/stacks/persistent_stack/provider_users_bucket.py
• backend/compact-connect/stacks/persistent_stack/ssn_table.py
• backend/compact-connect/stacks/persistent_stack/staff_users.py
• backend/compact-connect/stacks/persistent_stack/transaction_history_table.py
• backend/compact-connect/stacks/persistent_stack/user_email_notifications.py
• backend/compact-connect/stacks/persistent_stack/users_table.py
• backend/compact-connect/stacks/provider_users/provider_users.py
• backend/compact-connect/stacks/reporting_stack.py
• backend/compact-connect/stacks/search_persistent_stack/index_manager.py
• backend/compact-connect/stacks/search_persistent_stack/populate_provider_documents_handler.py
• backend/compact-connect/stacks/search_persistent_stack/provider_search_domain.py
• backend/compact-connect/stacks/search_persistent_stack/provider_update_ingest_handler.py
• backend/compact-connect/stacks/search_persistent_stack/search_handler.py
• backend/compact-connect/stacks/state_api_stack/v1_api/bulk_upload_url.py
• backend/compact-connect/stacks/state_api_stack/v1_api/post_licenses.py
• backend/compact-connect/stacks/state_api_stack/v1_api/provider_management.py
• backend/compact-connect/stacks/state_auth/state_auth_users.py
• backend/compact-connect/stacks/transaction_monitoring_stack/transaction_history_processing_workflow.py
• backend/compact-connect/tests/app/base.py
• backend/compact-connect/tests/common_constructs/test_cognito_user_backup.py
• backend/compact-connect/tests/common_constructs/test_data_migration.py
• backend/cosmetology-app/README.md
• backend/cosmetology-app/bin/compile_requirements.sh
• backend/cosmetology-app/common_constructs/backup_plan.py
• backend/cosmetology-app/common_constructs/cognito_user_backup.py
• backend/cosmetology-app/common_constructs/constants.py
• backend/cosmetology-app/common_constructs/data_migration.py
• backend/cosmetology-app/common_constructs/nodejs_function.py
• backend/cosmetology-app/common_constructs/python_common_layer_versions.py
• backend/cosmetology-app/common_constructs/python_function.py
• backend/cosmetology-app/common_constructs/queue_event_listener.py
• backend/cosmetology-app/common_constructs/queued_lambda_processor.py
• backend/cosmetology-app/common_constructs/ssm_parameter_utility.py
• backend/cosmetology-app/stacks/api_lambda_stack/__init__.py
• backend/cosmetology-app/stacks/api_lambda_stack/bulk_upload_url.py
• backend/cosmetology-app/stacks/api_lambda_stack/compact_configuration_api.py
• backend/cosmetology-app/stacks/api_lambda_stack/feature_flags.py
• backend/cosmetology-app/stacks/api_lambda_stack/post_licenses.py
• backend/cosmetology-app/stacks/api_lambda_stack/provider_management.py
• backend/cosmetology-app/stacks/api_lambda_stack/public_lookup_api.py
• backend/cosmetology-app/stacks/api_lambda_stack/staff_users.py
• backend/cosmetology-app/stacks/api_stack/v1_api/compact_configuration_api.py
• backend/cosmetology-app/stacks/api_stack/v1_api/provider_management.py
• backend/cosmetology-app/stacks/disaster_recovery_stack/license_upload_rollback_step_function.py
• backend/cosmetology-app/stacks/disaster_recovery_stack/sync_table_step_function.py
• backend/cosmetology-app/stacks/feature_flag_stack/__init__.py
• backend/cosmetology-app/stacks/ingest_stack.py
• backend/cosmetology-app/stacks/notification_stack.py
• backend/cosmetology-app/stacks/persistent_stack/__init__.py
• backend/cosmetology-app/stacks/persistent_stack/bulk_uploads_bucket.py
• backend/cosmetology-app/stacks/persistent_stack/compact_configuration_table.py
• backend/cosmetology-app/stacks/persistent_stack/compact_configuration_upload.py
• backend/cosmetology-app/stacks/persistent_stack/data_event_table.py
• backend/cosmetology-app/stacks/persistent_stack/provider_table.py
• backend/cosmetology-app/stacks/persistent_stack/ssn_table.py
• backend/cosmetology-app/stacks/persistent_stack/staff_users.py
• backend/cosmetology-app/stacks/persistent_stack/user_email_notifications.py
• backend/cosmetology-app/stacks/persistent_stack/users_table.py
• backend/cosmetology-app/stacks/reporting_stack.py
• backend/cosmetology-app/stacks/search_persistent_stack/index_manager.py
• backend/cosmetology-app/stacks/search_persistent_stack/populate_provider_documents_handler.py
• backend/cosmetology-app/stacks/search_persistent_stack/provider_search_domain.py
• backend/cosmetology-app/stacks/search_persistent_stack/provider_update_ingest_handler.py
• backend/cosmetology-app/stacks/search_persistent_stack/search_handler.py
• backend/cosmetology-app/stacks/state_api_stack/v1_api/bulk_upload_url.py
• backend/cosmetology-app/stacks/state_api_stack/v1_api/post_licenses.py
• backend/cosmetology-app/tests/app/base.py
• backend/cosmetology-app/tests/common_constructs/test_cognito_user_backup.py
• backend/cosmetology-app/tests/common_constructs/test_data_migration.py
• backend/cosmetology-app/tests/common_constructs/test_queue_event_listener.py
• backend/cosmetology-app/tests/common_constructs/test_queued_lambda_processor.py
• backend/multi-account/README.md
• backend/multi-account/backups/requirements-dev.txt
• backend/multi-account/backups/requirements.txt
• backend/multi-account/control-tower/requirements-dev.txt
• backend/multi-account/control-tower/requirements.txt
• backend/multi-account/log-aggregation/requirements-dev.txt
• backend/multi-account/log-aggregation/requirements.txt
• backend/social-work-app/.coveragerc
• backend/social-work-app/README.md
• backend/social-work-app/app.py
• backend/social-work-app/app_clients/.gitignore
• backend/social-work-app/app_clients/README.md
• backend/social-work-app/app_clients/bin/create_app_client.py
• backend/social-work-app/app_clients/bin/manage_signature_keys.py
• backend/social-work-app/app_clients/it_staff_onboarding_instructions/README.md
• backend/social-work-app/bin/compile_requirements.sh
• backend/social-work-app/bin/count_providers.py
• backend/social-work-app/bin/create_staff_user.py
• backend/social-work-app/bin/download_oas30.py
• backend/social-work-app/bin/generate_mock_license_csv_upload_file.py
• backend/social-work-app/bin/purge_provider_table.py
• backend/social-work-app/bin/put_ssm_context.sh
• backend/social-work-app/bin/run_python_tests.py
• backend/social-work-app/bin/run_tests.sh
• backend/social-work-app/bin/sandbox_bootstrap_staff_users.py
• backend/social-work-app/bin/sandbox_fetch_aws_resources.py
• backend/social-work-app/bin/sync_deps.sh
• backend/social-work-app/bin/trim_oas30.py
• backend/social-work-app/bin/update_api_docs.sh
• backend/social-work-app/bin/update_postman_collection.py
• backend/social-work-app/cdk.context.beta-example.json
• backend/social-work-app/cdk.context.deploy-example.json
• backend/social-work-app/cdk.context.prod-example.json
• backend/social-work-app/cdk.context.sandbox-example.json
• backend/social-work-app/cdk.context.test-example.json
• backend/social-work-app/cdk.json
• backend/social-work-app/common_constructs/README.md
• backend/social-work-app/common_constructs/cognito_user_backup.py
• backend/social-work-app/common_constructs/resource_scope_mixin.py
• backend/social-work-app/disaster_recovery/FULL_TABLE_RECOVERY.md
• backend/social-work-app/disaster_recovery/LICENSE_UPLOAD_ROLLBACK.md
• backend/social-work-app/disaster_recovery/README.md
• backend/social-work-app/disaster_recovery/end_recovery_mode.py
• backend/social-work-app/disaster_recovery/start_recovery_mode.py
• backend/social-work-app/docs/README.md
• backend/social-work-app/docs/api-specification/latest-oas30.json
• backend/social-work-app/docs/api-specification/swagger.html
• backend/social-work-app/docs/design/README.md
• backend/social-work-app/docs/design/pipeline-architecture.md
• backend/social-work-app/docs/devops/README.md
• backend/social-work-app/docs/devops/STAFF_USER_MFA_RECOVERY.md
• backend/social-work-app/docs/internal/api-specification/latest-oas30.json
• backend/social-work-app/docs/internal/api-specification/swagger.html
• backend/social-work-app/docs/internal/postman/postman-collection.json
• backend/social-work-app/docs/internal/postman/postman-environment.json
• backend/social-work-app/docs/it_staff_onboarding_instructions.md
• backend/social-work-app/docs/postman/postman-collection.json
• backend/social-work-app/docs/postman/postman-environment.json
• backend/social-work-app/docs/search-internal/api-specification/latest-oas30.json
• backend/social-work-app/docs/search-internal/api-specification/swagger.html
• backend/social-work-app/docs/search-internal/postman/postman-collection.json
• backend/social-work-app/lambdas/nodejs/.gitignore
• backend/social-work-app/lambdas/nodejs/README.md
• backend/social-work-app/lambdas/nodejs/cognito-emails/handler.js
• backend/social-work-app/lambdas/nodejs/cognito-emails/handler.ts
• backend/social-work-app/lambdas/nodejs/cognito-emails/lambda.js
• backend/social-work-app/lambdas/nodejs/cognito-emails/lambda.ts
• backend/social-work-app/lambdas/nodejs/email-notification-service/.gitignore
• backend/social-work-app/lambdas/nodejs/email-notification-service/README.md
• backend/social-work-app/lambdas/nodejs/email-notification-service/handler.ts
• backend/social-work-app/lambdas/nodejs/email-notification-service/lambda.ts
• backend/social-work-app/lambdas/nodejs/eslint.config.mjs
• backend/social-work-app/lambdas/nodejs/generated-email-templates/.gitignore
• backend/social-work-app/lambdas/nodejs/ingest-event-reporter/.gitignore
• backend/social-work-app/lambdas/nodejs/ingest-event-reporter/README.md
• backend/social-work-app/lambdas/nodejs/ingest-event-reporter/handler.ts
• backend/social-work-app/lambdas/nodejs/ingest-event-reporter/lambda.ts
• backend/social-work-app/lambdas/nodejs/jest.config.mjs
• backend/social-work-app/lambdas/nodejs/lib/compact-configuration-client.ts
• backend/social-work-app/lambdas/nodejs/lib/email/base-email-service.ts
• backend/social-work-app/lambdas/nodejs/lib/email/cognito-email-service.ts
• backend/social-work-app/lambdas/nodejs/lib/email/email-notification-service.ts
• backend/social-work-app/lambdas/nodejs/lib/email/encumbrance-notification-service.ts
• backend/social-work-app/lambdas/nodejs/lib/email/environment-banner-service.ts
• backend/social-work-app/lambdas/nodejs/lib/email/index.ts
• backend/social-work-app/lambdas/nodejs/lib/email/ingest-event-email-service.ts
• backend/social-work-app/lambdas/nodejs/lib/email/investigation-notification-service.ts
• backend/social-work-app/lambdas/nodejs/lib/environment-variables-service.ts
• backend/social-work-app/lambdas/nodejs/lib/event-client.ts
• backend/social-work-app/lambdas/nodejs/lib/jurisdiction-client.ts
• backend/social-work-app/lambdas/nodejs/lib/models/compact.ts
• backend/social-work-app/lambdas/nodejs/lib/models/email-notification-service-event.ts
• backend/social-work-app/lambdas/nodejs/lib/models/event-bridge-event-detail.ts
• backend/social-work-app/lambdas/nodejs/lib/models/event-records.ts
• backend/social-work-app/lambdas/nodejs/lib/models/index.ts
• backend/social-work-app/lambdas/nodejs/lib/models/jurisdiction.ts
• backend/social-work-app/lambdas/nodejs/package.json
• backend/social-work-app/lambdas/nodejs/tests/cognito-emails.test.ts
• backend/social-work-app/lambdas/nodejs/tests/email-notification-service.test.ts
• backend/social-work-app/lambdas/nodejs/tests/ingest-event-reporter.test.ts
• backend/social-work-app/lambdas/nodejs/tests/jest.setup.ts
• backend/social-work-app/lambdas/nodejs/tests/lib/compact-configuration-client.test.ts
• backend/social-work-app/lambdas/nodejs/tests/lib/email/base-email-service.test.ts
• backend/social-work-app/lambdas/nodejs/tests/lib/email/cognito-email-service.test.ts
• backend/social-work-app/lambdas/nodejs/tests/lib/email/email-notification-service.test.ts
• backend/social-work-app/lambdas/nodejs/tests/lib/email/encumbrance-notification-service.test.ts
• backend/social-work-app/lambdas/nodejs/tests/lib/email/ingest-event-email-service.test.ts
• backend/social-work-app/lambdas/nodejs/tests/lib/email/investigation-notification-service.test.ts
• backend/social-work-app/lambdas/nodejs/tests/lib/environment-variables-service.test.ts
• backend/social-work-app/lambdas/nodejs/tests/lib/event-client.test.ts
• backend/social-work-app/lambdas/nodejs/tests/lib/jurisdiction-client.test.ts
• backend/social-work-app/lambdas/nodejs/tests/sample-records.ts
• backend/social-work-app/lambdas/nodejs/tests/utils/email-template-capture.ts
• backend/social-work-app/lambdas/nodejs/tsconfig.json
• backend/social-work-app/lambdas/python/cognito-backup/handlers/cognito_backup.py
• backend/social-work-app/lambdas/python/cognito-backup/requirements-dev.in
• backend/social-work-app/lambdas/python/cognito-backup/requirements-dev.txt
• backend/social-work-app/lambdas/python/cognito-backup/requirements.in
• backend/social-work-app/lambdas/python/cognito-backup/requirements.txt
• backend/social-work-app/lambdas/python/cognito-backup/tests/__init__.py
• backend/social-work-app/lambdas/python/cognito-backup/tests/function/__init__.py
• backend/social-work-app/lambdas/python/cognito-backup/tests/function/test_cognito_backup.py
• backend/social-work-app/lambdas/python/common/cc_common/__init__.py
• backend/social-work-app/lambdas/python/common/cc_common/config.py

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}