test-recorder 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ce916b59fcd166bdcafb222263423739c9c8fe58e53a50f5895c95485145522
-  data.tar.gz: 71fd0cb14988364e06d7977c38815a6656522c2acb79180ec06e5889b5eab155
+  metadata.gz: f76a3cec00d302949375e3ad8d9c4c566f8c52cac703db8384b36505d2be47bb
+  data.tar.gz: 109b533201bcde42f210224cf1a01f5b0b795cb1dc5c737d83a80a0b232d67b3
 SHA512:
-  metadata.gz: 3caaba9397db23c5c2bdb215812345af54f04a21e25c56ae6c83209c45f42a2bfd1891a587e7c58682ee85bd07b806d077adb7f7e780e2cd1c202fa2a38e5b64
-  data.tar.gz: 50f45dfc872ff6cc60a997f842bff3ba95d225cd88621879d2a07c0119c577376528ac3cedf306322c9c7efe1e18a1be63d232109c4d3ac29f3689d22aed27b9
+  metadata.gz: 5b4ca4f5087cc0d32cb335f79fdface896ae918493958ff753f36207f93e44b80a0d1af11f9486c8a6cdcad9d2dd2974599cabfac1afaf158e85d51842d5f71c
+  data.tar.gz: 52a41a7cc4a35ee019892cea4c67f467bb0e7a9e7f391bba7bfca52a596bda057b2fb92f72c9dc20ef85e700b52985dd049a2bfed6baac874cb3bad8479eb19d

data/.github/workflows/ci.yml

@@ -3,32 +3,45 @@ name: CI
 on:
   push:
     branches:
-      - master
+      - main
 
   pull_request:
 
+env:
+  FFMPEG_BUILD: ffmpeg-n8.1-latest-linux64-gpl-8.1
+
 jobs:
   build:
     runs-on: ubuntu-latest
+    timeout-minutes: 10
 
-    concurrency:
-      group: ${{ github.ref }}
-      cancel-in-progress: true
+    strategy:
+      matrix:
+        ruby: [ '4.0', '3.4', '3.3' ]
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
       with:
-        ruby-version: '3.2'
-    - uses: actions/setup-node@v2
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Cache ffmpeg
+      id: cache-ffmpeg
+      uses: actions/cache@v4
       with:
-        node-version: '18'
+        path: ~/.local/bin/ffmpeg
+        key: ffmpeg-${{ runner.os }}-${{ env.FFMPEG_BUILD }}
     - name: Install ffmpeg
+      if: steps.cache-ffmpeg.outputs.cache-hit != 'true'
       run: |
-        sudo apt update && sudo apt install ffmpeg
-    - name: Install dependencies
+        mkdir -p "$HOME/.local/bin"
+        curl -fsSL -o "$RUNNER_TEMP/ffmpeg.tar.xz" \
+          "https://github.com/BtbN/FFmpeg-Builds/releases/download/latest/${FFMPEG_BUILD}.tar.xz"
+        tar -xJf "$RUNNER_TEMP/ffmpeg.tar.xz" -C "$RUNNER_TEMP" "${FFMPEG_BUILD}/bin/ffmpeg"
+        mv "$RUNNER_TEMP/${FFMPEG_BUILD}/bin/ffmpeg" "$HOME/.local/bin/ffmpeg"
+    - name: Set up ffmpeg
       run: |
-        gem install bundler --no-document
-        bundle install
+        chmod +x "$HOME/.local/bin/ffmpeg"
+        echo "$HOME/.local/bin" >> "$GITHUB_PATH"
     - name: Run test
       run: bundle exec rake

data/.github/workflows/push_gem.yml

@@ -0,0 +1,33 @@
+name: Push Gem
+
+on:
+  push:
+    tags:
+      - v*
+
+permissions:
+  contents: read
+
+jobs:
+  push:
+    if: github.repository == 'y-yagi/test-recorder'
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write
+      id-token: write
+
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
+        with:
+          egress-policy: audit
+
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@2e007403fc1ec238429ecaa57af6f22f019cc135 # v1.234.0
+        with:
+          bundler-cache: true
+          ruby-version: ruby
+
+      - uses: rubygems/release-gem@9e85cb11501bebc2ae661c1500176316d3987059 # v1.1.0

data/.gitignore

@@ -6,3 +6,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+Gemfile.lock

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## Unreleased
+
+## 0.3.0 - 2026-08-23
+
+* Reduce recording overhead
+* Make recording JPEG quality, max dimension and screencast frame interval configurable
+* Explicitly encode videos with VP8 to avoid relying on ffmpeg's default codec
+* Sanitize characters that can't use for video file names
+* Stop recording a video for a skipped Rails system test
+
 ## 0.2.0 - 2023-08-23
 
 * Add support for aggregate_failures #21 (@willnet)

data/Gemfile

@@ -3,6 +3,6 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in test-recorder.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
+gem "rake"
 gem "minitest", "~> 5.0"
 gem "debug"

data/README.md

@@ -94,4 +94,21 @@ TestRecorder.disable!
 it "test to something", test_recorder: true do
   # ...
 end
+```
+
+### Configuration
+
+You can change the recording quality and the max width/height (in pixels).
+
+```ruby
+TestRecorder.jpeg_quality = 80    # default: 60
+TestRecorder.max_dimension = 1280 # default: 1000
+```
+
+You can also record only every Nth frame. This lowers the recording overhead
+at the cost of a choppier video. The playback duration stays the same.
+
+```ruby
+TestRecorder.every_nth_frame = 3 # default: 1
+```
 

data/Rakefile

@@ -6,7 +6,7 @@ Rake::TestTask.new(:test) do |t|
   t.libs << "lib"
   t.verbose = true
   t.warning = true
-  t.test_files = ["test/integration_test.rb"]
+  t.test_files = ["test/integration_test.rb", "test/test_recorder_config_test.rb"]
 end
 
 task :default => :test

data/lib/test_recorder/cdp_recorder.rb

@@ -1,19 +1,49 @@
-require "open3"
+require "base64"
 require "fileutils"
 require "tempfile"
 
 module TestRecorder
   class CdpRecorder
+    FFMPEG_ENCODE_OPTIONS = %w[-y -an -r 25 -c:v vp8 -qmin 0 -qmax 50 -crf 8 -deadline realtime -speed 8 -b:v 1M -threads 1].freeze
+
+    Record = Struct.new(:page, :io, :frame_count)
+
+    class << self
+      def record(devtools)
+        records[devtools] ||= begin
+          page = devtools.page
+          page.enable
+
+          record = Record.new(page, nil, 0)
+          page.on(:screencast_frame) do |event|
+            write_frame(record, event["data"])
+            record.page.screencast_frame_ack(session_id: event["sessionId"])
+          end
+          record
+        end
+      end
+
+      private
+
+      def write_frame(record, data)
+        return if record.io.nil?
+
+        record.io.write(Base64.decode64(data))
+        record.frame_count += 1
+      rescue IOError
+        # A frame can still arrive after the recording was stopped and the file was closed.
+      rescue => e
+        warn "[TestRecorder] Failed to write a screencast frame: #{e.class}: #{e.message}"
+      end
+
+      def records
+        @records ||= {}.compare_by_identity
+      end
+    end
+
     def initialize(enabled:)
       @enabled = enabled
       @started = nil
-      @page = nil
-      setup
-    end
-
-    def setup
-      @video_dir = ::Rails.root.join("tmp", "videos")
-      FileUtils.mkdir_p(@video_dir)
     end
 
     def start(page:, enabled: nil)
@@ -21,40 +51,60 @@ module TestRecorder
       @started = enabled
       return unless @started
 
-      @tmp_video = Tempfile.open(["testrecorder", ".webm"])
-      cmd = "ffmpeg -loglevel quiet -f image2pipe -avioflags direct -fpsprobesize 0 -probesize 32 -analyzeduration 0 -c:v mjpeg -i - -y -an -r 25 -qmin 0 -qmax 50 -crf 8 -deadline realtime -speed 8 -b:v 1M -threads 1 #{@tmp_video.path}"
-      @stdin, @wait_thrs = *Open3.pipeline_w(cmd)
-      @stdin.set_encoding("ASCII-8BIT")
+      @tmp_video = Tempfile.new(["testrecorder", ".mjpeg"])
+      @tmp_video.binmode
 
-      @page = page
-      @page.driver.browser.devtools.page.enable
+      @record = self.class.record(page.driver.browser.devtools)
+      @record.io = @tmp_video
+      @record.frame_count = 0
 
-      @page.driver.browser.devtools.page.on(:screencast_frame) do |event|
-        decoded_data = Base64.decode64(event["data"])
-        @stdin.print(decoded_data) rescue nil
-        @page.driver.browser.devtools.page.screencast_frame_ack(session_id: event["sessionId"])
-      end
+      @every_nth_frame = TestRecorder.every_nth_frame
 
-      @page.driver.browser.devtools.page.start_screencast(format: "jpeg", quality: 90)
+      @record.page.start_screencast(format: "jpeg", quality: TestRecorder.jpeg_quality, max_width: TestRecorder.max_dimension, max_height: TestRecorder.max_dimension, every_nth_frame: @every_nth_frame)
     end
 
     def stop_and_discard
-      if @started
-        @page.driver.browser.devtools.page.stop_screencast
-        @stdin.close
-      end
+      return unless @started
+
+      @record.io = nil
+      @record.page.stop_screencast
+      @tmp_video.close!
     end
 
     def stop_and_save(filename)
       return "" unless @started
 
-      @page.driver.browser.devtools.page.stop_screencast
-      @stdin.close
-      @wait_thrs.each(&:join)
+      @record.io = nil
+      @record.page.stop_screencast
+      @tmp_video.flush
 
-      video_path = File.join(@video_dir, filename)
-      FileUtils.copy(@tmp_video.path, video_path)
-      @tmp_video.close(true)
+      # Chrome sends a frame as soon as the screencast starts, so a test that fails
+      # before it draws anything still leaves behind the one frame of the blank page
+      # it started on.
+      if @record.frame_count < 2
+        @tmp_video.close!
+        return ""
+      end
+
+      video_dir = ::Rails.root.join("tmp", "videos")
+      FileUtils.mkdir_p(video_dir)
+      video_path = video_dir.join(filename).to_s
+
+      # Chrome captures at about 25 fps, but `every_nth_frame` makes it deliver only
+      # one out of every N frames. So the captured file holds 25 / N frames per second.
+      # Tell ffmpeg that input rate, otherwise it assumes 25 fps and the video plays
+      # N times faster than the actual test.
+      result = system("ffmpeg", "-loglevel", "error", "-f", "image2pipe", "-c:v", "mjpeg", "-framerate", "25/#{@every_nth_frame}", "-i", @tmp_video.path, *FFMPEG_ENCODE_OPTIONS, video_path)
+
+      @tmp_video.close!
+
+      if result.nil?
+        warn "[TestRecorder] Failed to execute ffmpeg. Please make sure that FFmpeg is installed."
+        return ""
+      elsif !result
+        warn "[TestRecorder] ffmpeg failed to encode #{video_path}."
+        return ""
+      end
 
       video_path
     end

data/lib/test_recorder/rails/setup_and_teardown.rb

@@ -10,11 +10,11 @@ module TestRecorder
       end
 
       def before_teardown
-        if failures.empty?
-          @cdp_recorder.stop_and_discard
-        else
-          video_path = @cdp_recorder.stop_and_save("failures_#{self.name}.webm")
+        if failures.any? { |failure| !failure.is_a?(Minitest::Skip) }
+          video_path = @cdp_recorder.stop_and_save("failures_#{TestRecorder.sanitize_filename(self.name)}.webm")
           puts "[Video]: #{video_path}" if File.exist?(video_path)
+        else
+          @cdp_recorder.stop_and_discard
         end
       ensure
         super

data/lib/test_recorder/rails.rb

@@ -1,3 +1,4 @@
+require "test_recorder"
 require "test_recorder/cdp_recorder"
 require "test_recorder/rails/setup_and_teardown"
 

data/lib/test_recorder/rspec.rb

@@ -1,10 +1,9 @@
+require "test_recorder"
 require "test_recorder/cdp_recorder"
 require "test_recorder/rspec/example_wrapper"
 
 module TestRecorder
   module RSpec
-    CHARS_TO_TRANSLATE = ['/', '.', ':', ',', "'", '"', " "].freeze
-
     class << self
       attr_accessor :cdp_recorder
 
@@ -20,7 +19,7 @@ module TestRecorder
       end
 
       def method_name(example)
-        example.description.underscore.tr(CHARS_TO_TRANSLATE.join, "_")[0...200] + "_#{rand(1000)}"
+        TestRecorder.sanitize_filename(example.description.underscore)[0...200] + "_#{rand(1000)}"
       end
 
       def passed?(example)

data/lib/test_recorder/version.rb

@@ -1,3 +1,3 @@
 module TestRecorder
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/test_recorder.rb

@@ -1,7 +1,15 @@
 require "test_recorder/version"
 
 module TestRecorder
+  DEFAULT_JPEG_QUALITY = 60
+  DEFAULT_MAX_DIMENSION = 1000
+  DEFAULT_EVERY_NTH_FRAME = 1
+
+  CHARS_TO_TRANSLATE = ['/', '.', ':', ',', "'", '"', " "].freeze
+
   class << self
+    attr_writer :jpeg_quality, :max_dimension, :every_nth_frame
+
     def enable!
       @enable = true
     end
@@ -13,5 +21,21 @@ module TestRecorder
     def enabled?
       defined?(@enable) ? @enable : true
     end
+
+    def jpeg_quality
+      defined?(@jpeg_quality) ? @jpeg_quality : DEFAULT_JPEG_QUALITY
+    end
+
+    def max_dimension
+      defined?(@max_dimension) ? @max_dimension : DEFAULT_MAX_DIMENSION
+    end
+
+    def every_nth_frame
+      defined?(@every_nth_frame) ? @every_nth_frame : DEFAULT_EVERY_NTH_FRAME
+    end
+
+    def sanitize_filename(name)
+      name.tr(CHARS_TO_TRANSLATE.join, "_")
+    end
   end
 end

data/test-recorder.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.summary       = %q{Automatically record videos when tests failed.}
   spec.homepage      = "http://github.com/y-yagi/test-recorder"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: test-recorder
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Yuji Yaginuma
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-08-22 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -66,7 +65,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
 email:
 - yuuji.yaginuma@gmail.com
 executables: []
@@ -74,10 +72,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/ci.yml"
+- ".github/workflows/push_gem.yml"
 - ".gitignore"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -97,7 +95,6 @@ licenses:
 - MIT
 metadata:
   homepage_uri: http://github.com/y-yagi/test-recorder
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -105,15 +102,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key: 
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Automatically record videos when tests failed.
 test_files: []

data/Gemfile.lock

@@ -1,55 +0,0 @@
-PATH
-  remote: .
-  specs:
-    test-recorder (0.2.0)
-      activesupport
-      selenium-devtools
-      selenium-webdriver (>= 4.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (7.0.7)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-    activesupport-testing-metadata (0.1.0)
-      activesupport (>= 4.0)
-    concurrent-ruby (1.2.2)
-    debug (1.8.0)
-      irb (>= 1.5.0)
-      reline (>= 0.3.1)
-    i18n (1.14.1)
-      concurrent-ruby (~> 1.0)
-    io-console (0.6.0)
-    irb (1.7.4)
-      reline (>= 0.3.6)
-    minitest (5.19.0)
-    rake (12.3.3)
-    reline (0.3.8)
-      io-console (~> 0.5)
-    rexml (3.2.6)
-    rubyzip (2.3.2)
-    selenium-devtools (0.115.0)
-      selenium-webdriver (~> 4.2)
-    selenium-webdriver (4.11.0)
-      rexml (~> 3.2, >= 3.2.5)
-      rubyzip (>= 1.2.2, < 3.0)
-      websocket (~> 1.0)
-    tzinfo (2.0.6)
-      concurrent-ruby (~> 1.0)
-    websocket (1.2.9)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activesupport-testing-metadata
-  debug
-  minitest (~> 5.0)
-  rake (~> 12.0)
-  test-recorder!
-
-BUNDLED WITH
-   2.4.3