trmnl_preview 0.18.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53759b5b952609676a6313c40932bf0aa015ba665044fa2dae6d6dd25e96dfc1
-  data.tar.gz: 906e518e4193951665996a4ed7a49ff07e94cfec35269412f6fe2a172b1ae4c4
+  metadata.gz: 10d19ade9dca541649486f6b8d105277f15400451bbde285591815f4cdc8f9a1
+  data.tar.gz: d83fde4dc7312ec8316027b5f9f6370bca2194228e5ad55dfc92874a260c87d4
 SHA512:
-  metadata.gz: 51e39569a0ade12fc7f435176438ce3319adbaac3f613a4b36f441b3c01e7a89917f5df96395a62ad3a7a1dce3efb1e021847e1178afe84c47cdabfbec9b6f9d
-  data.tar.gz: a7b3b71f8fb839bca061a9b2083622d076f9290a6f4f128cacaea34b36cc6e0833ea3ae7876b13358dc7670c4fb71a6b973564866614474893efdd5715f898f8
+  metadata.gz: 25d1251bbb5421d2fe762d46f20ce675d59179e69e42ab44dd6b25ee05dc5bf7609aca22a71bafe77841492b10797aa93153252917078cee61a13b31a2790c59
+  data.tar.gz: 5e1dd277a7aa823e866ca8f2c674751baa04b0e4bcc00b7522064064887eb4c6f246e15f1b3884d8a64fc605005a67c7bc8274364bba7d29bf6fc7739d60def7

data/CHANGELOG.md

@@ -1,6 +1,15 @@
 
 # Changelog
 
+## 0.19.0
+
+- `it_behaves_like 'a publishable recipe'` also checks every screen for leaked values (`undefined`, `NaN`, `null`, `[object Object]`, `Liquid error`, raw `{{` or `{%`), draws the full view when the API answers with nothing, answers 500 or cannot be reached, and draws it with each option of every select field. New matchers: `have_no_leaked_text` and `have_no_transform_error`. (#181)
+
+## 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)

data/README.md

@@ -505,8 +505,8 @@ 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) 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.
+- `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. Every screen is also checked for leaked values (`undefined`, `NaN`, `null`, `[object Object]`, `Liquid error`, raw `{{`); the full view must still draw when the API answers with nothing, answers 500 or cannot be reached; and it is drawn with each option of every select field (the first and last when a field has more than 20). 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, `have_no_leaked_text` the drawn text for leaked values, and `have_no_transform_error` a render's transform.
 
 ## 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

@@ -1,26 +1,66 @@
 # frozen_string_literal: true
 
+require 'yaml'
+
+require_relative '../select_field_choices'
+
 module TRMNLP
   module Testing
-    # The screens a recipe is drawn on: TRMNL's own devices, and a portrait screen.
+    # 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: 'v2' }, { device: 'v2', orientation: :portrait }
+      { 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
+    PUBLISHABLE_RECIPE_API_FAILURES = {
+      'answers with nothing' => { json: {} }, 'answers 500' => { status: 500, body: '' },
+      'cannot be reached' => { error: :reset }
+    }.freeze
+    # A field with more options than this is drawn with its first and last.
+    PUBLISHABLE_RECIPE_MAX_OPTIONS = 20
+
+    # Each select field's keyname and the values its options save, from the plugin's settings.yml.
+    def self.select_field_values
+      path = File.join(plugin_dir, 'src', 'settings.yml')
+      fields = File.exist?(path) ? Array(YAML.safe_load_file(path, aliases: true)&.dig('custom_fields')) : []
+      fields.select { it['field_type'] == 'select' }.to_h do |field|
+        values = SelectFieldChoices.new(field).pairs.map { it.last.to_s }
+        [field['keyname'], values.size > PUBLISHABLE_RECIPE_MAX_OPTIONS ? values.values_at(0, -1) : values]
+      end
+    end
   end
 end
 
+# rubocop:disable-next Metrics/BlockLength -- one shared group, one check per example
 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
 
+  def draw_cleanly = have_no_overflow.and(have_no_problems).and(have_no_leaked_text)
+
   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
+      expect(trmnl.render(view:, **screen, **recipe_inputs)).to draw_cleanly
+    end
+  end
+
+  TRMNLP::Testing::PUBLISHABLE_RECIPE_API_FAILURES.each do |failure, answer|
+    it "draws the full view when the API #{failure}" do
+      screen = trmnl.render(**screens.first, **recipe_inputs, mocks: { '*' => answer })
+      expect(screen).to have_no_problems.and(have_no_leaked_text).and(have_no_transform_error)
+    end
+  end
+
+  TRMNLP::Testing.select_field_values.each do |keyname, values|
+    values.each do |value|
+      it "draws the full view with #{keyname} set to #{value}" do
+        custom_fields = recipe_inputs[:custom_fields].merge(keyname => value)
+        expect(trmnl.render(**screens.first, **recipe_inputs, custom_fields:)).to draw_cleanly
+      end
     end
   end
 

data/lib/trmnlp/testing/rspec.rb

@@ -18,6 +18,8 @@ require_relative 'snapshot'
 module TRMNLP
   module Testing
     PLUGIN_DIR_ENV_KEY = 'TRMNLP_PLUGIN_DIR'
+    # What a template or script draws when its data is missing.
+    LEAKED_TEXT_PATTERN = /Liquid (?:syntax )?error|\bundefined\b|\bNaN\b|\bnull\b|\[object Object\]|\{\{|\{%/
 
     def self.plugin_dir = ENV.fetch(PLUGIN_DIR_ENV_KEY, Dir.pwd)
 
@@ -53,6 +55,19 @@ RSpec::Matchers.define :stay_within_serverless_limits do
   end
 end
 
+RSpec::Matchers.define :have_no_leaked_text do
+  match { |screen| screen.text.scan(TRMNLP::Testing::LEAKED_TEXT_PATTERN).empty? }
+  failure_message do |screen|
+    leaked = screen.text.scan(TRMNLP::Testing::LEAKED_TEXT_PATTERN).uniq
+    "expected no leaked values on #{screen.inspect}, but it shows: #{leaked.join(', ')}"
+  end
+end
+
+RSpec::Matchers.define :have_no_transform_error do
+  match { |screen| screen.result.error.nil? }
+  failure_message { |screen| "expected the transform to run without error, but: #{screen.result.error}" }
+end
+
 RSpec::Matchers.define :have_no_problems do
   match { |screen| screen.problems.empty? }
   failure_message { |screen| "expected no problems on #{screen.inspect}, but: #{screen.problems.join('; ')}" }

data/lib/trmnlp/version.rb

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

data/templates/init/tests/plugin_spec.rb

@@ -10,7 +10,7 @@ RSpec.describe 'My Plugin' do
   # The values of the custom fields in src/settings.yml to test with.
   let(:custom_fields) { {} }
 
-  # Every view on TRMNL's devices without overflow or page errors, and the transform within TRMNL's limits.
+  # Every view on TRMNL's devices, a failing API and every select option, checked for overflow and errors.
   it_behaves_like 'a publishable recipe'
 
   # A picture of the full view, compared pixel for pixel on every run. Record it once with

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trmnl_preview
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.19.0
 platform: ruby
 authors:
 - Rockwell Schrock