Skip to content

Conversation

noomorph
Copy link
Collaborator

@noomorph noomorph commented Aug 12, 2025

This PR introduces video recording capabilities to the detox-allure2-adapter, enabling "on-demand" video recording for Detox tests.

Key Features Added:

  1. New deviceVideos Configuration Option

    • Enables video recording for tests using the videokitten library
    • Recording starts automatically on first device interaction and stops when tests complete
    • Supports both iOS and Android platforms
  2. Video Recording Options

    • saveAll: Controls whether to save videos for all tests (default: only failed tests)
    • lazyStart: Controls whether to start recording only when something interesting happens like device or app interaction (default: true if useSteps is true, otherwise false)
    • Platform-specific options for iOS and Android (codec, bitrate, etc.)
    • Integration with Allure reporting system
  3. Implementation Details

    • New VideoManager class to handle video recording lifecycle
    • Automatic recording start/stop based on test execution
    • Video files attached to Allure reports for failed tests
    • Proper cleanup and resource management

Configuration Example:

deviceVideos: {
  saveAll: true,
  ios: { codec: 'hevc' },
  android: { bitRate: 4_000_000 }
}

Dependencies Added:

  • videokitten package for cross-platform video recording

This enhancement provides developers with visual debugging capabilities by automatically capturing test execution videos, making it easier to diagnose test failures and understand test behavior.

@noomorph noomorph force-pushed the feat/video-artifacts branch 2 times, most recently from 76262e7 to 201a1bb Compare August 12, 2025 21:11
@noomorph noomorph force-pushed the feat/video-artifacts branch from 201a1bb to 74d6e8a Compare August 13, 2025 10:24
@noomorph noomorph marked this pull request as ready for review August 13, 2025 10:25
@noomorph noomorph merged commit f1f5b32 into alpha Aug 13, 2025
2 checks passed
@noomorph noomorph deleted the feat/video-artifacts branch August 13, 2025 10:26
Copy link

🎉 This PR is included in version 1.0.0-alpha.27 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Video artifacts support
1 participant