remotion_lambda 4.0.514 → 4.0.515

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d30f8bc694c6a16af40dbf07a092f6da3cbb77addb18ae170218d5bb2de92313
-  data.tar.gz: b0cf0cdb92b0fd757db004ad04b22059f38236f56af31d09e41813548922c17b
+  metadata.gz: f6a5a86dcbdddef690c8693744bb36805fe170c46658f24d74d91cdcdd50c888
+  data.tar.gz: 1d747a9c80d9833175f919e99dd3c608471fa8aa16d9ed71ef99e596d4bf9ba8
 SHA512:
-  metadata.gz: 66ecb29f67327e799e9c113d062fb531bfd40fdbab05472f86020a16e7198483caf474d0e421b9ede6967a7059a14a451bad04eb83f36a61e854b493feae7f7d
-  data.tar.gz: fb8284f60392dee8cb26e3a2c1e93ab24a5fffe504ec743fb148fcfda7fe4683d7e72bd0a8bd38ecc9395cf28b07882e6c563f3756f5d7114d73c3386eb900b1
+  metadata.gz: e7b518d39f04b05cb46dfd6ae5eba3e5c5245ec6c9597227ee4f03f9ed6bef568f8613ee97ce1242a3ffe502e1d47c35f04f67ebf2814892962c4d49ec02ae9d
+  data.tar.gz: 953a26eb07db694f9b8383bc8c1c04b0471bba058b979d22b52e3bfb67377ed6a98d6f3024155ad13a5c2db2d7e7ef5fb54422f6cfab5f66f1fb3f5e411204eb

data/lib/remotion_lambda/cancel_render_on_lambda_spec.rb

@@ -0,0 +1,26 @@
+require_relative 'sdk'
+require 'aws-sdk-s3'
+require 'json'
+
+s3_client = Aws::S3::Client.new(stub_responses: true)
+s3_client.stub_responses(:get_object, body: JSON.generate(cancellationEnabled: true))
+client = RemotionLambda::Client.new(s3_client: s3_client)
+
+client.cancel_render_on_lambda('remotionlambda-test', 'render-id')
+
+requests = s3_client.api_requests
+raise 'Expected progress to be read' unless requests[0][:params][:key] == 'renders/render-id/progress.json'
+raise 'Expected cancellation signal to be written' unless requests[1][:params][:key] == 'renders/render-id/cancel.json'
+cancellation_body = JSON.parse(requests[1][:params][:body])
+raise 'Expected cancelledAt timestamp' unless cancellation_body['cancelledAt'] > 0
+
+disabled_s3_client = Aws::S3::Client.new(stub_responses: true)
+disabled_s3_client.stub_responses(:get_object, body: '{}')
+disabled_client = RemotionLambda::Client.new(s3_client: disabled_s3_client)
+
+begin
+  disabled_client.cancel_render_on_lambda('remotionlambda-test', 'render-id')
+  raise 'Expected cancellation to fail without opt-in'
+rescue => error
+  raise error unless error.message.include?('enableCancellation: true')
+end

data/lib/remotion_lambda/render_media_on_lambda_payload.rb

@@ -19,6 +19,7 @@ def get_render_media_on_lambda_payload(
   crf: nil,
   delete_after: nil,
   download_behavior: nil,
+  enable_cancellation: false,
   encoding_buffer_size: nil,
   encoding_max_rate: nil,
   env_variables: {},
@@ -79,6 +80,7 @@ payload = {
     crf: crf,
     deleteAfter: delete_after,
     downloadBehavior: download_behavior,
+    enableCancellation: enable_cancellation,
     encodingBufferSize: encoding_buffer_size,
     encodingMaxRate: encoding_max_rate,
     envVariables: env_variables,

data/lib/remotion_lambda/render_media_on_lambda_payload_spec.rb

@@ -30,6 +30,10 @@ payload = get_render_media_on_lambda_payload(
 )
 
 raise "Expected the current SDK to default overwrite to false" unless payload[:overwrite] == false
+raise "Expected cancellation to default to false" unless payload[:enableCancellation] == false
+
+cancellable_payload = get_render_media_on_lambda_payload(codec: "h264", enable_cancellation: true)
+raise "Expected cancellation to be enabled" unless cancellable_payload[:enableCancellation] == true
 
 # Print as JSON
 puts JSON.generate(payload)

data/lib/remotion_lambda/sdk.rb

@@ -1,4 +1,5 @@
 require 'aws-sdk-lambda'
+require 'aws-sdk-s3'
 require 'json'
 require 'logger'
 require_relative 'version'
@@ -9,11 +10,13 @@ module RemotionLambda
 
     def initialize(
       region: ENV.fetch('AWS_REGION', 'us-east-1'),
-      aws_profile: nil
+      aws_profile: nil,
+      s3_client: nil
     )
       @region = region
       @aws_profile = aws_profile
       @lambda_client = create_lambda_client
+      @s3_client = s3_client
     end
 
     def get_render_progress(function_name, payload)
@@ -34,6 +37,26 @@ module RemotionLambda
       body
     end
 
+    def cancel_render_on_lambda(bucket_name, render_id)
+      progress_response = s3_client.get_object(
+        bucket: bucket_name,
+        key: "renders/#{render_id}/progress.json"
+      )
+      progress = JSON.parse(progress_response.body.read)
+
+      unless progress['cancellationEnabled'] == true
+        raise "Cannot cancel render #{render_id}: The render was not started with enableCancellation: true."
+      end
+
+      s3_client.put_object(
+        bucket: bucket_name,
+        key: "renders/#{render_id}/cancel.json",
+        body: JSON.generate(cancelledAt: (Time.now.to_f * 1000).floor),
+        content_type: 'application/json'
+      )
+      nil
+    end
+
     private
 
     # Lambda methods
@@ -50,6 +73,10 @@ module RemotionLambda
       Aws::Lambda::Client.new(region: @region, credentials: aws_credentials)
     end
 
+    def s3_client
+      @s3_client ||= Aws::S3::Client.new(region: @region, credentials: aws_credentials)
+    end
+
     def aws_credentials
       if @aws_profile
         Aws::SharedCredentials.new(profile_name: @aws_profile)

data/lib/remotion_lambda/version.rb

@@ -1 +1 @@
-VERSION = "4.0.514"
+VERSION = "4.0.515"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: remotion_lambda
 version: !ruby/object:Gem::Version
-  version: 4.0.514
+  version: 4.0.515
 platform: ruby
 authors:
 - Jonny Burger
@@ -23,6 +23,20 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-s3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -51,6 +65,20 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 description: A Ruby SDK for Remotion Lambda
 email: jonny@remotion.dev
 executables: []
@@ -59,6 +87,7 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/remotion_lambda.rb
+- lib/remotion_lambda/cancel_render_on_lambda_spec.rb
 - lib/remotion_lambda/render_media_on_lambda_payload.rb
 - lib/remotion_lambda/render_media_on_lambda_payload_spec.rb
 - lib/remotion_lambda/render_progress_payload.rb