trmnl_preview 0.17.2 → 0.18.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 835368508a529b50bb30de82e6a0170a9d5c14f6edebeb4ffdd2afc774273e58
-  data.tar.gz: 7cf9003dde78b9688674ff48fe0e0fa7decd50ee36204de9196078141ae3defa
+  metadata.gz: 32924757751f8d15ad7979409c03f18906506af03558a90d27bfd122f0a44d0c
+  data.tar.gz: 5cba7d9f2cbd67868316826218a1237efafafdc0f9967b3670ef538859c11f56
 SHA512:
-  metadata.gz: 339f9c574ee307ebc59ed949d6b12bcdb7c58aaa6191564f0b8b6d5b91c675322e2f329055b2630f6d29db3ca341386e09aded2f02e928c129f297890584fbb4
-  data.tar.gz: 3d5c286313c7a75f2b6beaba417917fdc932a51dd8e4e9f3953065111f1accec23d3480164f47588547b6bcc2b482abbe534368328c8107e034308f354197dfd
+  metadata.gz: b9b8692c362797cd9df4ee23cf7a081051ec9f6ea18b28c721426fc58860231a5b02541c0a6823a8a940a33eb1a9e81f8fdcba9f3d43ad43f6871a880706fb58
+  data.tar.gz: 1351106bc604919f20f0067a558eab0da46c1f08bf1cf7fd3ccce69db42dcac81136499d295629cfc64777b3f40586332701c312707b22348f56927611232fe0

data/CHANGELOG.md

@@ -1,6 +1,15 @@
 
 # Changelog
 
+## 0.18.1
+
+- Pages narrower than a Firefox window render, such as a 480x800 TRMNL OG in portrait, in `serve`, `build` and `test`. trmnlp sets the page's viewport with WebDriver BiDi, as TRMNL does, instead of resizing the window, which Firefox will not size under about 500px. (#178)
+- `it_behaves_like 'a publishable recipe'` also draws every view on the TRMNL OG (2-bit) in portrait. (#179)
+
+## 0.18.0
+
+- `it_behaves_like 'a publishable recipe'` checks what a recipe should hold before it is published: every view draws without overflow or page errors on the TRMNL OG (1-bit and 2-bit) and the TRMNL X (landscape and portrait), and the transform runs without error within TRMNL's limits. `trmnlp init`'s starter spec uses it. (#176)
+
 ## 0.17.2
 
 - `trmnlp test` no longer inlines a stylesheet link inside a script's string, such as a CDN fallback written with `document.write`. It broke the script, and every render came out blank. (#174)

data/README.md

@@ -473,7 +473,7 @@ See [TRMNL documentation](https://help.trmnl.com/en/articles/10542599-importing-
 
 ## Testing Plugins
 
-`trmnlp init` starts a plugin with `tests/plugin_spec.rb` (each view draws without overflow or page errors, and the transform stays within TRMNL's limits) and a GitHub workflow that runs it in the `trmnl/trmnlp` image, uploads the report, can rewrite the snapshots on a manual run, and pushes to TRMNL only once lint and tests pass. `trmnlp test` runs the RSpec files in your plugin's `tests/` folder, through the same pipeline `serve` and `build` use, with fake APIs and a fixed clock:
+`trmnlp init` starts a plugin with `tests/plugin_spec.rb` (`it_behaves_like 'a publishable recipe'`, below) and a GitHub workflow that runs it in the `trmnl/trmnlp` image, uploads the report, can rewrite the snapshots on a manual run, and pushes to TRMNL only once lint and tests pass. `trmnlp test` runs the RSpec files in your plugin's `tests/` folder, through the same pipeline `serve` and `build` use, with fake APIs and a fixed clock:
 
 ```ruby
 # tests/weather_spec.rb
@@ -505,6 +505,7 @@ end
 - `mocks:` answer every request the run makes: polling urls, and the transform's own requests in any language, HTTPS included. Keys are urls, with `*` wildcards, a Regexp, or a method first (`'POST https://...'`). Values are `{ json:, body:, status:, headers:, delay:, body_delay:, advance_clock:, error: :reset }` (times in seconds: `body_delay:` sends the headers first and the body later, `advance_clock:` moves the transform's clock on when it answers), a string body, a lambda that takes the request, or an array of answers used in order. An unmocked request gets a 599. `requests` lists every request with its `status`, and `aborted: true` for one the transform gave up on before its answer arrived; `duration_ms` is how long the transform ran.
 - `now:` starts every clock: Liquid's, the markup's scripts', and the transform's, through libfaketime (`brew install libfaketime` or `apt-get install libfaketime`; already in the Docker image). On macOS the interpreter must come from brew, mise or similar, since macOS will not hand libfaketime to its own `/usr/bin` binaries.
 - `trmnlp test --report report` also writes `report/index.html` and `report/report.json`: every example with each screen it rendered (with a switch that outlines every drawn box, and the page's problems) and each transform it ran (time, memory, requests). Under GitHub Actions the counts and failures go to the run's summary too.
+- `it_behaves_like 'a publishable recipe'` is what a recipe should hold before it is published: every view draws without overflow or page errors on the TRMNL OG (1-bit, and 2-bit in landscape and portrait) and the TRMNL X (landscape and portrait), and the transform runs without error within TRMNL's limits. It uses the group's `mocks` and `custom_fields` when the group defines them; `screens: [{ device: 'kobo_libra_2' }, ...]` draws on other devices.
 - `match_snapshot` stores a missing snapshot under `tests/snapshots/<os>/` and fails one on CI; `trmnlp test --update` rewrites them. Fonts render differently per operating system, so run tests in the Docker image when CI should share your snapshots. `fit_image_size_limit` checks the PNG against the model's limit.
 
 ## Development

data/lib/trmnlp/firefox_driver.rb

@@ -15,7 +15,7 @@ module TRMNLP
     end
 
     def options
-      Selenium::WebDriver::Firefox::Options.new.tap do |opts|
+      Selenium::WebDriver::Firefox::Options.new(web_socket_url: true).tap do |opts|
         opts.add_argument('--headless')
         opts.add_argument('--disable-web-security')
       end

data/lib/trmnlp/screenshot.rb

@@ -68,44 +68,29 @@ module TRMNLP
     end
 
     def resize(driver, width, height)
-      apply_window_size(driver, width, height)
+      set_viewport(driver, width, height)
       wait_for_viewport(driver, width, height)
     end
 
-    def apply_window_size(driver, width, height)
-      borders = driver.execute_script(<<~JS)
-        return {
-          width: window.outerWidth - window.innerWidth,
-          height: window.outerHeight - window.innerHeight
-        }
-      JS
-
-      dim = Selenium::WebDriver::Dimension.new(width + borders['width'], height + borders['height'])
-      driver.manage.window.size = dim
+    # The page's viewport, not the window: Firefox will not size a window under about 500px, as an OG in portrait.
+    def set_viewport(driver, width, height)
+      driver.bidi.send_cmd('browsingContext.setViewport', context: driver.window_handle, viewport: { width:, height: })
     end
 
     # NOTE: A cold Firefox — e.g. the first render after the container boots —
-    # applies a window resize lazily. The old fixed sleep raced that reflow and
+    # applies a resize lazily. The old fixed sleep raced that reflow and
     # clipped the first screenshot short (800x433 instead of 800x480). Poll the
-    # real viewport instead, re-applying the size until it lands. A width the
-    # browser refuses to honour (below its ~500px window minimum) never settles;
-    # that surfaces as a clear RenderError rather than an opaque, retried timeout.
+    # real viewport instead, re-applying the size until it lands.
     def wait_for_viewport(driver, width, height)
       Selenium::WebDriver::Wait.new(timeout: @viewport_timeout, interval: 0.1).until do
         next true if viewport(driver) == [width, height]
 
-        apply_window_size(driver, width, height)
+        set_viewport(driver, width, height)
         false
       end
     rescue Selenium::WebDriver::Error::TimeoutError
-      raise RenderError, viewport_clamp_message(driver, width, height)
-    end
-
-    def viewport_clamp_message(driver, width, height)
       actual_width, actual_height = viewport(driver)
-      "Could not render at #{width}x#{height}: the browser clamped the viewport " \
-        "to #{actual_width}x#{actual_height}. PNG rendering needs a width of " \
-        'roughly 500px or more — headless Firefox will not size its window narrower.'
+      raise RenderError, "Could not render at #{width}x#{height}: the viewport stayed #{actual_width}x#{actual_height}"
     end
 
     def viewport(driver)

data/lib/trmnlp/testing/publishable_recipe.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module TRMNLP
+  module Testing
+    # The screens a recipe is drawn on: TRMNL's own devices, in landscape and portrait.
+    PUBLISHABLE_RECIPE_SCREENS = [
+      { device: 'og_png' }, { device: 'og_plus' }, { device: 'og_plus', orientation: :portrait },
+      { device: 'v2' }, { device: 'v2', orientation: :portrait }
+    ].freeze
+    PUBLISHABLE_RECIPE_VIEWS = %w[full half_horizontal half_vertical quadrant].freeze
+  end
+end
+
+RSpec.shared_examples 'a publishable recipe' do |screens: TRMNLP::Testing::PUBLISHABLE_RECIPE_SCREENS|
+  let(:recipe_inputs) do
+    { mocks: respond_to?(:mocks) ? mocks : {}, custom_fields: respond_to?(:custom_fields) ? custom_fields : {} }
+  end
+
+  TRMNLP::Testing::PUBLISHABLE_RECIPE_VIEWS.product(screens).each do |view, screen|
+    device = screen[:device].is_a?(Hash) ? screen[:device][:model] : screen[:device]
+    screen_name = [device, screen[:orientation]].compact.join(' ')
+
+    it "draws the #{view} view on #{screen_name} without overflow or page errors" do
+      expect(trmnl.render(view:, **screen, **recipe_inputs)).to have_no_overflow.and have_no_problems
+    end
+  end
+
+  it 'runs its transform without error' do
+    expect(trmnl.transform(device: screens.first[:device], **recipe_inputs).error).to be_nil
+  end
+
+  it "stays within TRMNL's serverless limits" do
+    expect(trmnl.transform(device: screens.first[:device], **recipe_inputs)).to stay_within_serverless_limits
+  end
+end

data/lib/trmnlp/testing/rspec.rb

@@ -12,6 +12,7 @@ require_relative 'browser'
 require_relative 'certificate_authority'
 require_relative 'plugin'
 require_relative 'report'
+require_relative 'publishable_recipe'
 require_relative 'snapshot'
 
 module TRMNLP

data/lib/trmnlp/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TRMNLP
-  VERSION = '0.17.2'
+  VERSION = '0.18.1'
 end

data/templates/init/tests/plugin_spec.rb

@@ -10,18 +10,8 @@ RSpec.describe 'My Plugin' do
   # The values of the custom fields in src/settings.yml to test with.
   let(:custom_fields) { {} }
 
-  %w[full half_horizontal half_vertical quadrant].each do |view|
-    it "draws the #{view} view without overflow or page errors" do
-      screen = trmnl.render(view:, mocks:, custom_fields:)
-
-      expect(screen).to have_no_overflow
-      expect(screen).to have_no_problems
-    end
-  end
-
-  it "stays within TRMNL's serverless limits" do
-    expect(trmnl.transform(mocks:, custom_fields:)).to stay_within_serverless_limits
-  end
+  # Every view on TRMNL's devices without overflow or page errors, and the transform within TRMNL's limits.
+  it_behaves_like 'a publishable recipe'
 
   # A picture of the full view, compared pixel for pixel on every run. Record it once with
   # `trmnlp test --update` (or the workflow's update_snapshots run) and commit tests/snapshots.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trmnl_preview
 version: !ruby/object:Gem::Version
-  version: 0.17.2
+  version: 0.18.1
 platform: ruby
 authors:
 - Rockwell Schrock
@@ -468,6 +468,7 @@ files:
 - lib/trmnlp/testing/mock_table.rb
 - lib/trmnlp/testing/node_version.rb
 - lib/trmnlp/testing/plugin.rb
+- lib/trmnlp/testing/publishable_recipe.rb
 - lib/trmnlp/testing/report.html.erb
 - lib/trmnlp/testing/report.rb
 - lib/trmnlp/testing/rspec.rb