refactor: always return instance

Author: BryanttV

openedx_authz/engine/utils.py

@@ -503,7 +503,7 @@ def run_course_authoring_migration(
     course_id_list=None,
     org_id=None,
     delete_after_migration=True,
-) -> None:
+) -> AuthzCourseAuthoringMigrationRun:
     """
     Orchestrate a course authoring role migration with concurrency protection and lifecycle tracking.
 
@@ -538,8 +538,7 @@ def run_course_authoring_migration(
         logger.warning(
             "Skipping %s migration for %s:%s — an active run already exists.", migration_type, scope_type, scope_key
         )
-        AuthzCourseAuthoringMigrationRun.create_skipped(migration_type, scope_type, scope_key)
-        return
+        return AuthzCourseAuthoringMigrationRun.create_skipped(migration_type, scope_type, scope_key)
 
     logger.info("Started %s migration run [%s] for %s:%s", migration_type, run.id, scope_type, scope_key)
 
@@ -559,8 +558,7 @@ def run_course_authoring_migration(
         logger.exception(
             "Unexpected error in migration run [%s] for %s:%s", run.id, scope_type, scope_key, exc_info=exc
         )
-        run.mark_failed(exception=exc)
-        return
+        return run.mark_failed(exception=exc)
 
     errors_by_reason: dict = defaultdict(list)
     for entry in errors:
@@ -586,6 +584,7 @@ def run_course_authoring_migration(
             len(successes),
             len(errors),
         )
+        return run
     else:
         run.mark_completed(metadata_updates=metadata_updates)
         logger.info(
@@ -596,3 +595,4 @@ def run_course_authoring_migration(
             scope_key,
             len(successes),
         )
+        return run

openedx_authz/models/authz_migration.py

@@ -93,7 +93,7 @@ class Meta:
             models.Index(fields=["-created_at"]),
         ]
 
-    def save(self, *args, **kwargs) -> None:
+    def save(self, *args, **kwargs) -> "AuthzCourseAuthoringMigrationRun":
         """Enforce at most one RUNNING record per (scope_type, scope_key).
 
         MySQL does not support partial unique indexes, so this check is done at
@@ -112,6 +112,7 @@ def save(self, *args, **kwargs) -> None:
                         f"Duplicate RUNNING migration run for scope {self.scope_type}:{self.scope_key}"
                     )
         super().save(*args, **kwargs)
+        return self
 
     # pylint: disable=too-many-positional-arguments
     @classmethod
@@ -149,25 +150,25 @@ def create_skipped(
         extra = {**(metadata or {}), "skip_reason": "A concurrent migration run is already active for this scope."}
         return cls._create(migration_type, scope_type, scope_key, Status.SKIPPED, extra)
 
-    def _finalize(self, status: str, metadata_updates: dict | None = None) -> None:
+    def _finalize(self, status: str, metadata_updates: dict | None = None) -> "AuthzCourseAuthoringMigrationRun":
         """Finalize the migration run."""
         self.status = status
         self.completed_at = timezone.now()
         if metadata_updates:
             self.metadata = {**(self.metadata or {}), **metadata_updates}
-        self.save(update_fields=["status", "completed_at", "updated_at", "metadata"])
+        return self.save(update_fields=["status", "completed_at", "updated_at", "metadata"])
 
-    def mark_partial_success(self, *, metadata_updates=None) -> None:
+    def mark_partial_success(self, *, metadata_updates=None) -> "AuthzCourseAuthoringMigrationRun":
         """Mark the migration run as partially successful."""
-        self._finalize(Status.PARTIAL_SUCCESS, metadata_updates)
+        return self._finalize(Status.PARTIAL_SUCCESS, metadata_updates)
 
-    def mark_completed(self, *, metadata_updates=None) -> None:
+    def mark_completed(self, *, metadata_updates=None) -> "AuthzCourseAuthoringMigrationRun":
         """Mark the migration run as completed."""
-        self._finalize(Status.COMPLETED, metadata_updates)
+        return self._finalize(Status.COMPLETED, metadata_updates)
 
-    def mark_failed(self, *, exception=None) -> None:
+    def mark_failed(self, *, exception=None) -> "AuthzCourseAuthoringMigrationRun":
         """Mark the migration run as failed."""
-        self._finalize(Status.FAILED, {"error": str(exception)} if exception is not None else None)
+        return self._finalize(Status.FAILED, {"error": str(exception)} if exception is not None else None)
 
     def __str__(self) -> str:
         """Return a string representation of the migration run."""