shared drives: sync deletion state, set deletion date when expiring, unset when rescuing from deletion

Author: mikeseibel

docker/settings.py

@@ -80,11 +80,14 @@
 else:
     RESTCLIENTS_PRT_HOST = 'https://depts.washington.edu'
     RESTCLIENTS_PRT_DAO_CLASS = 'Live'
-    RESTCLIENTS_MSCA_HOST = os.getenv("MSCA_HOST", '')
     RESTCLIENTS_MSCA_DAO_CLASS = 'Live'
     RESTCLIENTS_MSCA_TIMEOUT = os.getenv(
         "MSCA_TIMEOUT", RESTCLIENTS_DEFAULT_TIMEOUT)
     RESTCLIENTS_MSCA_SUBSCRIPTION_KEY = os.getenv('MSCA_SUBSCRIPTION_KEY', '')
+    if os.getenv('MSCA_ENV') == 'PROD':
+        RESTCLIENTS_MSCA_HOST = 'https://pplat-main-apim.azure-api.net'
+    else:
+        RESTCLIENTS_MSCA_HOST = 'https://pplat-apimgmt.azure-api.net'
 
     RESTCLIENTS_ITBILL_DAO_CLASS = 'Live'
     RESTCLIENTS_ITBILL_HOST=os.getenv('ITBILL_HOST')

endorsement/dao/shared_drive.py

@@ -6,11 +6,15 @@
 import re
 import logging
 
+from django.utils import timezone
+
 # methods are imported to populate namespace and be used elsewhere
 from uw_msca.shared_drive import (  # noqa: F401
     get_default_quota,
     get_google_drive_states,
     set_drive_quota,
+    mark_drive_for_deletion,
+    rescue_drive_from_deletion,
 )
 from uw_msca.models import GoogleDriveState
 
@@ -52,6 +56,7 @@
 )
 MISSING_DRIVE_THRESHOLD = 500
 MISSING_DRIVE_NOTIFICATION = 150
+PENDING_DELETE_ORG_UNIT = "deleteprt"
 
 
 def sync_quota_from_subscription(drive_id):
@@ -87,7 +92,7 @@ def expire_shared_drives(gracetime, lifetime):
         shared_drive_lifecycle_expired(drive)
 
 
-def shared_drive_lifecycle_expired(drive_record):
+def shared_drive_lifecycle_expired(shared_drive):
     """
     Set lifecycle to expired for shared drive
 
@@ -96,8 +101,20 @@ def shared_drive_lifecycle_expired(drive_record):
        - set subscription end_date to today using:
             - expire_subscription(drive_record)
     """
-    logger.error(
-        f"Shared drive {drive_record} lifecycle expired: not implemented")
+    logger.info(f"Shared drive {shared_drive.drive_id} marked for deletion")
+    mark_drive_for_deletion(shared_drive.drive_id)
+
+
+def rescue_shared_drive_from_deletion(shared_drive):
+    """
+    Restore OrgUnit for shared drive previously marked for deletion
+
+    Actions:
+       - set call msca rescue method with original drive quota
+    """
+    logger.info(f"Rescue shared drive {shared_drive} from deletion")
+    rescue_drive_from_deletion(
+        shared_drive.drive_quota.quota_limit, shared_drive.drive_id)
 
 
 def load_shared_drives(google_drive_states):
@@ -608,9 +625,21 @@ def managers_for_shared_drive(google_drive_states):
                         f"existing drive ({drive_id}) "
                         f"usage ({drive_state.drive_name}) update: {ex}")
 
-                # confirm drive and subscription match
                 sdr = SharedDriveRecord.objects.get_record_by_drive_id(
                     drive_id)
+
+                # drive reported in pending delete org unit, store deleted date if
+                # not present to help signal state in the ui
+                if (shared_drive.drive_quota.org_unit_name != drive_state.org_unit_name
+                        and drive_state.org_unit_name.lower() == PENDING_DELETE_ORG_UNIT
+                        and sdr.datetime_deleted is None):
+                    logger.info(f"drive quota org unit change: drive {drive_id} "
+                                f"org unit {shared_drive.drive_quota.org_unit_name} "
+                                f"to {drive_state.org_unit_name}")
+                    sdr.datetime_deleted = timezone.now()
+                    sdr.save()
+
+                # confirm drive and subscription match
                 reconcile_drive_quota(
                     sdr,
                     no_subscription_quota=subsidized_quota,

endorsement/fixtures/test_data/shared_drive.json

@@ -75,5 +75,16 @@
       "drive_quota": 1,
       "members": [1, 4, 5, 7, 10, 11]
     }
+  },
+  {
+    "model": "endorsement.shareddrive",
+    "pk": 8,
+    "fields": {
+      "drive_id": "ABC_0123-DF56AA1234",
+      "drive_name": "PRT_DELETE_ON_XX_Subsidized quota",
+      "drive_usage": 63,
+      "drive_quota": 1,
+      "members": [1, 4, 5]
+    }
   }
 ]

endorsement/fixtures/test_data/shared_drive_record.json

@@ -124,5 +124,23 @@
       "datetime_deleted": null,
       "is_deleted": null
     }
+  },
+  {
+    "model": "endorsement.shareddriverecord",
+    "pk": 8,
+    "fields": {
+      "shared_drive": 8,
+      "subscription": null,
+      "datetime_created": "2024-02-12T17:41:28+00:00",
+      "datetime_emailed": null,
+      "datetime_notice_1_emailed": null,
+      "datetime_notice_2_emailed": null,
+      "datetime_notice_3_emailed": null,
+      "datetime_notice_4_emailed": null,
+      "datetime_accepted": "2024-02-12T17:41:28+00:00",
+      "datetime_expired": "2026-02-12T17:41:28+00:00",
+      "datetime_deleted": "2026-02-12T17:41:28+00:00",
+      "is_deleted": null
+    }
   }
 ]

endorsement/management/commands/expire_shared_drives.py

@@ -0,0 +1,70 @@
+# Copyright 2026 UW-IT, University of Washington
+# SPDX-License-Identifier: Apache-2.0
+
+from django.core.management.base import BaseCommand
+from django.utils import timezone
+from restclients_core.exceptions import DataFailureException
+from endorsement.policy.shared_drive import SharedDrivePolicy
+from endorsement.dao.shared_drive import shared_drive_lifecycle_expired
+import csv
+import logging
+
+
+logger = logging.getLogger(__name__)
+
+
+class Command(BaseCommand):
+    help = 'mark shared drives past their renewal date for deletion'
+
+    def add_arguments(self, parser):
+        parser.add_argument(
+            '-c',
+            '--commit',
+            action='store_true',
+            dest='actually_mark_for_deletion',
+            default=False,
+            help='Commit marking shared drive for deletion (default: log only)',
+        )
+        parser.add_argument(
+            '-d',
+            '--dump_drive_csv',
+            action='store_true',
+            dest='dump_drive_csv',
+            default=False,
+            help='Dump CSV of shared drives that would be marked for deletion',
+        )
+
+    def handle(self, *args, **options):
+        actually_mark_for_deletion = options['actually_mark_for_deletion']
+        dump_drive_csv = options['dump_drive_csv']
+
+        if dump_drive_csv:
+            self.drive_writer = csv.writer(self.stdout)
+            self.drive_writer.writerow(["Drive ID", "Drive Name", "Manager NetIDs"])
+
+        for record in SharedDrivePolicy().records_to_expire():
+            if dump_drive_csv:
+                self._record_csv(record)
+                continue
+
+            logger.info(f'Expiring: {record.shared_drive.drive_id} '
+                        f'"{record.shared_drive.drive_name}"')
+
+            if actually_mark_for_deletion:
+                self.expire_drive(record)
+
+    def expire_drive(self, record):
+        try:
+            shared_drive_lifecycle_expired(record.shared_drive)
+            record.datetime_deleted = timezone.now()
+            record.save()
+        except DataFailureException as ex:
+            logger.error(
+                "Cannot expire drive {record.shared_drive.drive_id} : {ex}")
+
+    def _record_csv(self, record):
+        self.drive_writer.writerow([
+            record.shared_drive.drive_id,
+            record.shared_drive.drive_name,
+            ",".join([n.member.netid for (
+                n) in record.shared_drive.get_members()])])

endorsement/models/shared_drive.py

@@ -267,16 +267,16 @@ def set_acceptance(self, member_netid, accept=True, acted_as=None):
         if accept:
             self.datetime_accepted = acceptance.datetime_created
             self.datetime_expired = None
+            self.datetime_deleted = None
         else:
             self.datetime_expired = acceptance.datetime_accepted
 
-        # clear notification schedule
+        # clear lifecycle state
         self.datetime_emailed = None
         self.datetime_notice_1_emailed = None
         self.datetime_notice_2_emailed = None
         self.datetime_notice_3_emailed = None
         self.datetime_notice_4_emailed = None
-
         self.save()
 
     def update_subscription(self, itbill):

endorsement/policy/shared_drive.py

@@ -21,3 +21,6 @@ def record_model(self):
     @property
     def datetime_provisioned_key(self):
         return "datetime_accepted"
+
+    def additional_warning_terms(self):
+        return {"datetime_deleted__isnull": True}

endorsement/resources/msca/file/google/v1/drive/ABC_0123-DE45FF5789/markdelete

@@ -0,0 +1 @@
+{"message": "Drive 'ABC_0123-DE45FF5789' successfully deleted"}

endorsement/resources/msca/file/google/v1/drive/ABC_0123-DF56AA1234/rescue

@@ -0,0 +1 @@
+{"message": "Drive 'ABC_0123-DF56AA1234' successfully moved 100GB OU"}

endorsement/static/endorsement/js/tab/google.js

@@ -83,7 +83,8 @@ var ManageSharedDrives = (function () {
                 _updateSharedDrivesDisplay(drive);
                 Notify.success('Shared drive "' + drive.drive.drive_name + '" provision renewed.', 10000);
             }).on('endorse:SharedDriveResponsibilityAcceptedError', function (e, error) {
-                Notify.error('Sorry, but we cannot accept responsibility at this time: ' + error);
+                _modalHide();
+                Notify.error('Sorry, but we cannot Renew shared drive at this time: ' + error);
             }).on('change', '#shared_drive_modal input', function () {
                 var $modal = $(this).closest('#shared_drive_modal'),
                     $accept_button = $('button.accept-button', $modal),
@@ -188,6 +189,7 @@ var ManageSharedDrives = (function () {
         },
         _prepSharedDriveContext = function (drive) {
             var expiration = moment(drive.datetime_expiration),
+                deletion = drive.datetime_deleted ? moment(drive.datetime_deleted) : null,
                 deadline = moment(drive.datetime_subscription_deadline),
                 now = moment.utc(),
                 billing_period_start = moment(((now.month() == 11) ? now.year() : now.year() - 1) + '-12-01'),
@@ -197,6 +199,8 @@ var ManageSharedDrives = (function () {
             drive.expiration_days = expiration.diff(now, 'days');
             drive.expiration_from_now = expiration.from(now);
 
+            drive.deletion_date = deletion ? deletion.format('M/D/YYYY') : null;
+
             drive.subscription_deadline_date = deadline.format('M/D/YYYY');
             drive.subscription_deadline_from_now = deadline.from(now);