add purge to canceled and failed enrollment

enrollments-events/app/enrollment.py

@@ -61,6 +61,8 @@ Org = TypedDict('Org', {'org_id': str, 'name': str})
 
 CreatedBy = TypedDict('CreatedBy', {'id': str, 'name': str})
 
+Seat = TypedDict('Seat', {'id': str, 'sk': str})
+
 DeduplicationWindow = TypedDict('DeduplicationWindow', {'offset_days': int})
 
 Subscription = TypedDict(
@@ -100,6 +102,11 @@ class SubscriptionFrozenError(Exception):
         super().__init__('Subscription is frozen')
 
 
+class SeatNotFoundError(Exception):
+    def __init__(self, msg: str | dict):
+        super().__init__('Seat required')
+
+
 def enroll(
     enrollment: Enrollment,
     *,
@@ -108,6 +115,7 @@ def enroll(
     subscription: Subscription | None = None,
     created_by: CreatedBy | None = None,
     scheduled_at: datetime | None = None,
+    seat: Seat | None = None,
     linked_entities: frozenset[LinkedEntity] = frozenset(),
     deduplication_window: DeduplicationWindow | None = None,
     persistence_layer: DynamoDBPersistenceLayer,
@@ -138,6 +146,8 @@ def enroll(
                     'sk': 'CANCEL_POLICY',
                     'created_at': now_,
                 }
+                #
+                | ({'seat': seat} if seat else {})
             )
 
         # Relationships between this enrollment and its related entities

enrollments-events/app/events/enroll_scheduled.py

@@ -30,6 +30,7 @@ def lambda_handler(event: EventBridgeEvent, context: LambdaContext) -> bool:
     offset_days = old_image.get('dedup_window_offset_days')
     billing_day = old_image.get('subscription_billing_day')
     created_by = old_image.get('created_by')
+    seat = old_image.get('seat')
     enrollment = Enrollment(
         course=old_image['course'],
         user=old_image['user'],
@@ -53,6 +54,7 @@ def lambda_handler(event: EventBridgeEvent, context: LambdaContext) -> bool:
             subscription=subscription,
             cancel_policy=bool(subscription),
             created_by=created_by,
+            seat=seat,
             scheduled_at=datetime.fromisoformat(old_image['scheduled_at']),
             # Transfer the deduplication window if it exists
             deduplication_window={'offset_days': offset_days} if offset_days else None,

enrollments-events/app/events/purge_reminders.py

@@ -0,0 +1,41 @@
+from aws_lambda_powertools import Logger
+from aws_lambda_powertools.utilities.data_classes import (
+    EventBridgeEvent,
+    event_source,
+)
+from aws_lambda_powertools.utilities.typing import LambdaContext
+from layercake.dynamodb import DynamoDBPersistenceLayer, KeyPair
+from layercake.strutils import md5_hash
+
+from boto3clients import dynamodb_client
+from config import ENROLLMENT_TABLE
+
+logger = Logger(__name__)
+dyn = DynamoDBPersistenceLayer(ENROLLMENT_TABLE, dynamodb_client)
+
+
+@event_source(data_class=EventBridgeEvent)
+@logger.inject_lambda_context
+def lambda_handler(event: EventBridgeEvent, context: LambdaContext) -> bool:
+    new_image = event.detail['new_image']
+    enrollment_id = new_image['id']
+    user_id = new_image['user']['id']
+    course_id = new_image['course']['id']
+    lock_hash = md5_hash(f'{user_id}{course_id}')
+
+    with dyn.transact_writer() as transact:
+        transact.delete(
+            key=KeyPair(enrollment_id, 'SCHEDULE#REMINDER_NO_ACCESS_AFTER_3_DAYS')
+        )
+        transact.delete(
+            key=KeyPair(enrollment_id, 'SCHEDULE#REMINDER_NO_ACTIVITY_AFTER_7_DAYS')
+        )
+        transact.delete(
+            key=KeyPair(enrollment_id, 'SCHEDULE#REMINDER_ACCESS_PERIOD_BEFORE_30_DAYS')
+        )
+        transact.delete(key=KeyPair(enrollment_id, 'CANCEL_POLICY'))
+        # Remove locks related to this enrollment
+        transact.delete(key=KeyPair(enrollment_id, 'LOCK'))
+        transact.delete(key=KeyPair('LOCK', lock_hash))
+
+    return True

enrollments-events/template.yaml

@@ -326,6 +326,27 @@ Resources:
                   sk: ['0']
                   status: [PENDING]
 
+  EventPurgeRemindersFunction:
+    Type: AWS::Serverless::Function
+    Properties:
+      Handler: events.purge_reminders.lambda_handler
+      LoggingConfig:
+        LogGroup: !Ref EventLog
+      Policies:
+        - DynamoDBCrudPolicy:
+            TableName: !Ref EnrollmentTable
+      Events:
+        DynamoDBEvent:
+          Type: EventBridgeRule
+          Properties:
+            Pattern:
+              resources: [!Ref EnrollmentTable]
+              detail-type: [MODIFY]
+              detail:
+                new_image:
+                  sk: ['0']
+                  status: [CANCELED, FAILED]
+
   # Deprecated
   EventSetAccessExpiredFunction:
     Type: AWS::Serverless::Function

enrollments-events/tests/events/test_purge_reminders.py

@@ -0,0 +1,29 @@
+from aws_lambda_powertools.utilities.typing import LambdaContext
+from layercake.dynamodb import DynamoDBPersistenceLayer
+
+import events.purge_reminders as app
+
+
+def test_purge_reminders(
+    dynamodb_seeds,
+    dynamodb_persistence_layer: DynamoDBPersistenceLayer,
+    lambda_context: LambdaContext,
+):
+    event = {
+        'detail': {
+            'new_image': {
+                'id': '14682b79-3df2-4351-9229-8b558af046a0',
+                'sk': '0',
+                'user': {
+                    'id': '1234',
+                    'name': 'Ozzy Osbourne',
+                    'email': 'ozzy@osbourne.com',
+                },
+                'course': {
+                    'id': '12334',
+                    'name': 'pytest',
+                },
+            }
+        }
+    }
+    assert app.lambda_handler(event, lambda_context)  # type: ignore