remotion-lambda 4.0.514__tar.gz → 4.0.515__tar.gz

{remotion_lambda-4.0.514 → remotion_lambda-4.0.515}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: remotion_lambda
-Version: 4.0.514
+Version: 4.0.515
 Summary: Remotion Lambda client
 Home-page: https://github.com/remotion-dev/remotion/tree/main/packages/lambda-python
 Author: Jonny Burger

{remotion_lambda-4.0.514 → remotion_lambda-4.0.515}/remotion_lambda/models.py

@@ -282,6 +282,7 @@ class RenderMediaParams:
     region: Optional[str] = None
     out_name: Optional[Union[str, OutNameInputObject]] = None
     prefer_lossless: Optional[bool] = False
+    enable_cancellation: bool = False
     composition: str = ""
     serve_url: str = ""
     frames_per_lambda: Optional[int] = None
@@ -342,6 +343,7 @@ class RenderMediaParams:
         Convert instance attributes to a dictionary for serialization.
         """
         parameters = {
+            'enableCancellation': self.enable_cancellation,
             'rendererFunctionName': self.renderer_function_name,
             'framesPerLambda': self.frames_per_lambda,
             'concurrency': self.concurrency,

{remotion_lambda-4.0.514 → remotion_lambda-4.0.515}/remotion_lambda/remotionclient.py

@@ -4,6 +4,7 @@ from dataclasses import asdict
 import random
 import json
 import hashlib
+import time
 from math import ceil
 from typing import Optional, Union, List, Dict, Any
 from enum import Enum
@@ -626,6 +627,38 @@ class RemotionClient:
 
         return None
 
+    def cancel_render_on_lambda(self, render_id: str, bucket_name: str) -> None:
+        """Cancel a render started with ``enable_cancellation=True``."""
+        s3_client = self._create_s3_client()
+        try:
+            progress_object = s3_client.get_object(
+                Bucket=bucket_name,
+                Key=f"renders/{render_id}/progress.json",
+            )
+            progress = json.loads(progress_object['Body'].read())
+        except (ClientError, KeyError, TypeError, json.JSONDecodeError) as error:
+            raise RemotionException(
+                f"Could not read progress for render {render_id}: {error}"
+            ) from error
+
+        if progress.get('cancellationEnabled') is not True:
+            raise RemotionInvalidArgumentException(
+                f"Cannot cancel render {render_id}: The render was not started "
+                "with enableCancellation: true."
+            )
+
+        try:
+            s3_client.put_object(
+                Bucket=bucket_name,
+                Key=f"renders/{render_id}/cancel.json",
+                Body=json.dumps({'cancelledAt': int(time.time() * 1000)}),
+                ContentType='application/json',
+            )
+        except ClientError as error:
+            raise RemotionException(
+                f"Could not cancel render {render_id}: {error}"
+            ) from error
+
     def render_still_on_lambda(
         self, render_params: RenderStillParams
     ) -> Optional[RenderStillResponse]:

{remotion_lambda-4.0.514 → remotion_lambda-4.0.515}/remotion_lambda/version.py

@@ -1,2 +1,2 @@
 # pylint: disable=missing-module-docstring, missing-final-newline
-VERSION = "4.0.514"
+VERSION = "4.0.515"

{remotion_lambda-4.0.514 → remotion_lambda-4.0.515}/remotion_lambda.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: remotion-lambda
-Version: 4.0.514
+Version: 4.0.515
 Summary: Remotion Lambda client
 Home-page: https://github.com/remotion-dev/remotion/tree/main/packages/lambda-python
 Author: Jonny Burger

{remotion_lambda-4.0.514 → remotion_lambda-4.0.515}/tests/test_render_client_render_media.py

@@ -1,5 +1,6 @@
+import json
 from unittest import TestCase
-from unittest.mock import patch
+from unittest.mock import Mock, patch
 
 from remotion_lambda.models import RenderMediaParams, ShouldDownload, Webhook
 from remotion_lambda.remotionclient import RemotionClient
@@ -11,6 +12,46 @@ class TestRemotionClient(TestCase):
         render_params = RenderMediaParams()
 
         self.assertFalse(render_params.serialize_params()['overwrite'])
+        self.assertFalse(render_params.serialize_params()['enableCancellation'])
+
+    def test_enable_cancellation_is_serialized(self):
+        render_params = RenderMediaParams(enable_cancellation=True)
+
+        self.assertTrue(render_params.serialize_params()['enableCancellation'])
+
+    def test_cancel_render_on_lambda(self):
+        client = RemotionClient(
+            region="us-east-1", serve_url="testbed", function_name="remotion-render"
+        )
+        s3_client = Mock()
+        s3_client.get_object.return_value = {
+            'Body': Mock(read=Mock(return_value=b'{"cancellationEnabled": true}'))
+        }
+        client._create_s3_client = Mock(return_value=s3_client)
+
+        client.cancel_render_on_lambda('render-id', 'remotionlambda-test')
+
+        s3_client.get_object.assert_called_once_with(
+            Bucket='remotionlambda-test', Key='renders/render-id/progress.json'
+        )
+        put_input = s3_client.put_object.call_args.kwargs
+        self.assertEqual(put_input['Key'], 'renders/render-id/cancel.json')
+        self.assertGreater(json.loads(put_input['Body'])['cancelledAt'], 0)
+
+    def test_cancel_render_requires_opt_in(self):
+        client = RemotionClient(
+            region="us-east-1", serve_url="testbed", function_name="remotion-render"
+        )
+        s3_client = Mock()
+        s3_client.get_object.return_value = {'Body': Mock(read=Mock(return_value=b'{}'))}
+        client._create_s3_client = Mock(return_value=s3_client)
+
+        with self.assertRaisesRegex(
+            RemotionInvalidArgumentException, 'enableCancellation: true'
+        ):
+            client.cancel_render_on_lambda('render-id', 'remotionlambda-test')
+
+        s3_client.put_object.assert_not_called()
 
     @patch('remotion_lambda.models.VERSION', '5.0.0')
     def test_overwrite_defaults_to_true_in_v5(self):