syncAssignmentsOnAdministrationUpdate()

syncAssignmentsOnAdministrationUpdate, syncAdministrationsAssignments

#TODO: Document helper functions within this cloud function.

Function Name

syncAssignmentsOnAdministrationUpdate

Trigger

This Cloud Function is triggered by any write event (creation, update, or deletion) on documents within the administrations/{administrationId} path in Firestore.

Configuration

• Document Path: administrations/{administrationId}
  • This specifies the Firestore path that triggers the function.
• Memory Allocation: 2 GiB
  • The function is configured with a high memory allocation to handle potentially large data operations involved in processing administration documents.

Operation

The function executes different operations based on the nature of the document event:

1. Document Deletion:

   • Handles the removal of administration-related data from organizational documents and user profiles.
   • Updates the creator's document to remove the administration from their list of created administrations.
   • Processes additional clean-up operations through processRemovedAdministration.

2. Document Creation:

   • Assigns all relevant organizational users to the new administration.
   • This operation is managed by the processNewAdministration function which takes the new administration data and applies necessary updates.

3. Document Modification:

   • Adjusts assignments and other related data based on changes in the administration document.
   • This is handled by processModifiedAdministration, which compares previous and current data to determine necessary updates.

Detailed Workflow

• Document Deletion:

  • Fetches previous data from the administration document.
  • Removes references to the deleted administration from associated organizational documents.
  • Optionally, updates the creator's document to reflect the removal of the administration.

• Document Creation:

  • Directly processes the new administration data to associate it with relevant organizational units and users.

• Document Modification:

  • Compares previous and current data to identify changes.
  • Updates organizational assignments and other related metrics as needed based on the changes detected.

Error Handling and Security Considerations

• Error Handling:

  • Includes error checks and logging at each step to ensure that failures in database operations are caught and handled gracefully.
  • Uses transactions and batch operations to ensure data integrity across multiple document updates.

• Security:

  • Ensures that the function operates under authenticated conditions and that operations are authorized based on user roles and permissions.
  • Validates all incoming data for consistency and to prevent unauthorized data manipulation.

Deployment and Maintenance

This function is deployed automatically using GitHub actions, whenever changes are merged into the main branch.

This function plays a critical role in maintaining the integrity and consistency of administration-related data. It ensures that user assignments reflect the most current state of administration documents.