Skip to content

AutoGPT is the vision of accessible AI for everyone, to use and to build on. Our mission is to provide the tools, so that you can focus on what matters.

refactor(blocks): share the video blocks' media-storing methods through one mixin (#15915)

Reinier van der Leer46262d316789
diff --git a/autogpt_platform/backend/backend/blocks/video/_utils.py b/autogpt_platform/backend/backend/blocks/video/_utils.py
index 9ebf195078..4ed880d6b5 100644
--- a/autogpt_platform/backend/backend/blocks/video/_utils.py
+++ b/autogpt_platform/backend/backend/blocks/video/_utils.py
@@ -8,6 +8,9 @@ import re
import subprocess
from pathlib import Path
+from backend.data.execution import ExecutionContext
+from backend.util.file import MediaFileType, store_media_file
+
logger = logging.getLogger(__name__)
# Known operation tags added by video blocks
@@ -129,3 +132,25 @@ def strip_chapters_inplace(video_path: str) -> None:
finally:
if os.path.exists(tmp_path):
os.unlink(tmp_path)
+
+
+class VideoMediaStorage:
+ """Storage steps shared by the video blocks, as methods so `test_mock` can replace them."""
+
+ async def _store_input_video(
+ self, execution_context: ExecutionContext, file: MediaFileType
+ ) -> MediaFileType:
+ return await store_media_file(
+ file=file,
+ execution_context=execution_context,
+ return_format="for_local_processing",
+ )
+
+ async def _store_output_video(
+ self, execution_context: ExecutionContext, file: MediaFileType
+ ) -> MediaFileType:
+ return await store_media_file(
+ file=file,
+ execution_context=execution_context,
+ return_format="for_block_output",
+ )
diff --git a/autogpt_platform/backend/backend/blocks/video/_utils_test.py b/autogpt_platform/backend/backend/blocks/video/_utils_test.py
new file mode 100644
index 0000000000..c0b1a0c937
--- /dev/null
+++ b/autogpt_platform/backend/backend/blocks/video/_utils_test.py
@@ -0,0 +1,31 @@
+from unittest.mock import AsyncMock, patch
+
+import pytest
+
+from backend.blocks.video._utils import VideoMediaStorage
+from backend.data.execution import ExecutionContext
+from backend.util.file import MediaFileType
+
+
+ "method, return_format",
+ [
+ ("_store_input_video", "for_local_processing"),
+ ("_store_output_video", "for_block_output"),
+ ],
+)
+async def test_storage_step_stores_in_its_return_format(method, return_format):
+ exec_ctx = ExecutionContext(user_id="test-user", graph_exec_id="test-graph-exec")
+ with patch(
+ "backend.blocks.video._utils.store_media_file",
+ new_callable=AsyncMock,
+ return_value=MediaFileType("stored.mp4"),
+ ) as store:
+ stored = await getattr(VideoMediaStorage(), method)(
+ exec_ctx, MediaFileType("video.mp4")
+ )
+
+ assert stored == "stored.mp4"
+ store.assert_awaited_once_with(
+ file="video.mp4", execution_context=exec_ctx, return_format=return_format
+ )
diff --git a/autogpt_platform/backend/backend/blocks/video/clip.py b/autogpt_platform/backend/backend/blocks/video/clip.py
index 19a232de83..4092de5319 100644
--- a/autogpt_platform/backend/backend/blocks/video/clip.py
+++ b/autogpt_platform/backend/backend/blocks/video/clip.py
@@ -13,6 +13,7 @@ from backend.blocks._base import (
BlockSchemaOutput,
)
from backend.blocks.video._utils import (
+ VideoMediaStorage,
extract_source_name,
get_video_codecs,
strip_chapters_inplace,
@@ -20,10 +21,10 @@ from backend.blocks.video._utils import (
from backend.data.execution import ExecutionContext
from backend.data.model import SchemaField
from backend.util.exceptions import BlockExecutionError
-from backend.util.file import MediaFileType, get_exec_file_path, store_media_file
+from backend.util.file import MediaFileType, get_exec_file_path
-class VideoClipBlock(Block):
+class VideoClipBlock(VideoMediaStorage, Block):
"""Extract a time segment from a video."""
class Input(BlockSchemaInput):
@@ -63,26 +64,6 @@ class VideoClipBlock(Block):
effect=BlockEffect.WORKSPACE,
)
- async def _store_input_video(
- self, execution_context: ExecutionContext, file: MediaFileType
- ) -> MediaFileType:
- """Store input video. Extracted for testability."""
- return await store_media_file(
- file=file,
- execution_context=execution_context,
- return_format="for_local_processing",
- )
-
- async def _store_output_video(
- self, execution_context: ExecutionContext, file: MediaFileType
- ) -> MediaFileType:
- """Store output video. Extracted for testability."""
- return await store_media_file(
- file=file,
- execution_context=execution_context,
- return_format="for_block_output",
- )
-
def _clip_video(
self,
video_abspath: str,
diff --git a/autogpt_platform/backend/backend/blocks/video/concat.py b/autogpt_platform/backend/backend/blocks/video/concat.py
index 64ffcdbf11..502a72b27c 100644
--- a/autogpt_platform/backend/backend/blocks/video/concat.py
+++ b/autogpt_platform/backend/backend/blocks/video/concat.py
@@ -15,6 +15,7 @@ from backend.blocks._base import (
BlockSchemaOutput,
)
from backend.blocks.video._utils import (
+ VideoMediaStorage,
extract_source_name,
get_video_codecs,
strip_chapters_inplace,
@@ -22,10 +23,10 @@ from backend.blocks.video._utils import (
from backend.data.execution import ExecutionContext
from backend.data.model import SchemaField
from backend.util.exceptions import BlockExecutionError
-from backend.util.file import MediaFileType, get_exec_file_path, store_media_file
+from backend.util.file import MediaFileType, get_exec_file_path
-class VideoConcatBlock(Block):
+class VideoConcatBlock(VideoMediaStorage, Block):
"""Merge multiple video clips into one continuous video."""
class Input(BlockSchemaInput):
@@ -73,26 +74,6 @@ class VideoConcatBlock(Block):
effect=BlockEffect.WORKSPACE,
)
- async def _store_input_video(
- self, execution_context: ExecutionContext, file: MediaFileType
- ) -> MediaFileType:
- """Store input video. Extracted for testability."""
- return await store_media_file(
- file=file,
- execution_context=execution_context,
- return_format="for_local_processing",
- )
-
- async def _store_output_video(
- self, execution_context: ExecutionContext, file: MediaFileType
- ) -> MediaFileType:
- """Store output video. Extracted for testability."""
- return await store_media_file(
- file=file,
- execution_context=execution_context,
- return_format="for_block_output",
- )
-
def _concat_videos(
self,
video_abspaths: list[str],
diff --git a/autogpt_platform/backend/backend/blocks/video/download.py b/autogpt_platform/backend/backend/blocks/video/download.py
index 3125b3a552..7d326338ac 100644
--- a/autogpt_platform/backend/backend/blocks/video/download.py
+++ b/autogpt_platform/backend/backend/blocks/video/download.py
@@ -17,19 +17,15 @@ from backend.blocks._base import (
BlockSchemaInput,
BlockSchemaOutput,
)
+from backend.blocks.video._utils import VideoMediaStorage
from backend.data.execution import ExecutionContext
from backend.data.model import SchemaField
from backend.util.exceptions import BlockExecutionError
-from backend.util.file import (
- MAX_FILE_SIZE_BYTES,
- MediaFileType,
- get_exec_file_path,
- store_media_file,
-)
+from backend.util.file import MAX_FILE_SIZE_BYTES, MediaFileType, get_exec_file_path
from backend.util.request import validate_url_host
-class VideoDownloadBlock(Block):
+class VideoDownloadBlock(VideoMediaStorage, Block):
"""Download video from URL using yt-dlp."""
class Input(BlockSchemaInput):
@@ -93,16 +89,6 @@ class VideoDownloadBlock(Block):
"""
await validate_url_host(url)
- async def _store_output_video(
- self, execution_context: ExecutionContext, file: MediaFileType
- ) -> MediaFileType:
- """Store output video. Extracted for testability."""
- return await store_media_file(
- file=file,
- execution_context=execution_context,
- return_format="for_block_output",
- )
-
def _get_format_string(self, quality: str) -> str:
formats = {
"best": "bestvideo+bestaudio/best",
diff --git a/autogpt_platform/backend/backend/blocks/video/narration.py b/autogpt_platform/backend/backend/blocks/video/narration.py
index 4c60e8e934..438d964703 100644
--- a/autogpt_platform/backend/backend/blocks/video/narration.py
+++ b/autogpt_platform/backend/backend/blocks/video/narration.py
@@ -23,6 +23,7 @@ from backend.blocks.elevenlabs._auth import (
ElevenLabsCredentialsInput,
)
from backend.blocks.video._utils import (
+ VideoMediaStorage,
extract_source_name,
get_video_codecs,
strip_chapters_inplace,
@@ -30,10 +31,10 @@ from backend.blocks.video._utils import (
from backend.data.execution import ExecutionContext
from backend.data.model import CredentialsField, NodeExecutionStats, SchemaField
from backend.util.exceptions import BlockExecutionError
-from backend.util.file import MediaFileType, get_exec_file_path, store_media_file
+from backend.util.file import MediaFileType, get_exec_file_path
-class VideoNarrationBlock(Block):
+class VideoNarrationBlock(VideoMediaStorage, Block):
"""Generate AI narration and add to video."""
class Input(BlockSchemaInput):
@@ -107,26 +108,6 @@ class VideoNarrationBlock(Block):
effect=BlockEffect.WORKSPACE,
)
- async def _store_input_video(
- self, execution_context: ExecutionContext, file: MediaFileType
- ) -> MediaFileType:
- """Store input video. Extracted for testability."""
- return await store_media_file(
- file=file,
- execution_context=execution_context,
- return_format="for_local_processing",
- )
-
- async def _store_output_video(
- self, execution_context: ExecutionContext, file: MediaFileType
- ) -> MediaFileType:
- """Store output video. Extracted for testability."""
- return await store_media_file(
- file=file,
- execution_context=execution_context,
- return_format="for_block_output",
- )
-
# Models that consume 0.5 credits per character (v2.5 tier). All other
# models default to 1.0 credit per character.
_HALF_RATE_MODELS = {"eleven_flash_v2_5", "eleven_turbo_v2_5"}
diff --git a/autogpt_platform/backend/backend/blocks/video/text_overlay.py b/autogpt_platform/backend/backend/blocks/video/text_overlay.py
index 43adc6bfd8..55c48b42ea 100644
--- a/autogpt_platform/backend/backend/blocks/video/text_overlay.py
+++ b/autogpt_platform/backend/backend/blocks/video/text_overlay.py
@@ -14,6 +14,7 @@ from backend.blocks._base import (
BlockSchemaOutput,
)
from backend.blocks.video._utils import (
+ VideoMediaStorage,
extract_source_name,
get_video_codecs,
strip_chapters_inplace,
@@ -21,10 +22,10 @@ from backend.blocks.video._utils import (
from backend.data.execution import ExecutionContext
from backend.data.model import SchemaField
from backend.util.exceptions import BlockExecutionError
-from backend.util.file import MediaFileType, get_exec_file_path, store_media_file
+from backend.util.file import MediaFileType, get_exec_file_path
-class VideoTextOverlayBlock(Block):
+class VideoTextOverlayBlock(VideoMediaStorage, Block):
"""Add text overlay/caption to video."""
class Input(BlockSchemaInput):
@@ -86,26 +87,6 @@ class VideoTextOverlayBlock(Block):
effect=BlockEffect.WORKSPACE,
)
- async def _store_input_video(
- self, execution_context: ExecutionContext, file: MediaFileType
- ) -> MediaFileType:
- """Store input video. Extracted for testability."""
- return await store_media_file(
- file=file,
- execution_context=execution_context,
- return_format="for_local_processing",
- )
-
- async def _store_output_video(
- self, execution_context: ExecutionContext, file: MediaFileType
- ) -> MediaFileType:
- """Store output video. Extracted for testability."""
- return await store_media_file(
- file=file,
- execution_context=execution_context,
- return_format="for_block_output",
- )
-
def _add_text_overlay(
self,
video_abspath: str,