Introduce performing? check (#81)

Author: hopsoft

.github/workflows/prettier-standard.yml

@@ -15,7 +15,7 @@ jobs:
     steps:
     - uses: actions/checkout@v3
     - name: Setup Node
-      uses: actions/setup-node@v1
+      uses: actions/setup-node@v3
       with:
         version: '16.x'
     - run: yarn

.github/workflows/tests.yml

@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.7', '3.0', '3.1']
+        ruby-version: ['2.7', '3.0', '3.1', '3.2']
     steps:
     - uses: actions/checkout@v3
     - name: Set up Ruby ${{ matrix.ruby-version }}
@@ -27,6 +27,12 @@ jobs:
         key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
         restore-keys: |
           ${{ runner.os }}-gems-
+    - name: Setup Node
+      uses: actions/setup-node@v3
+      with:
+        version: '16.x'
+    - run: yarn
+      working-directory: .
     - name: Bundle install
       run: |
         gem install bundler

lib/turbo_boost/commands/command_callbacks.rb

@@ -92,6 +92,10 @@ def errored?
     !!@errored
   end
 
+  def performing?
+    !!@performing_method_name
+  end
+
   def performed?
     !!@performed
   end

lib/turbo_boost/commands/controller_pack.rb

@@ -12,6 +12,7 @@ class TurboBoost::Commands::ControllerPack
   delegate(
     :command_aborted?,
     :command_errored?,
+    :command_performing?,
     :command_performed?,
     :command_requested?,
     :command_succeeded?,

lib/turbo_boost/commands/runner.rb

@@ -93,6 +93,10 @@ def command_errored?
     !!command_instance&.errored?
   end
 
+  def command_performing?
+    !!command_instance&.performing?
+  end
+
   def command_performed?
     !!command_instance&.performed?
   end
@@ -114,6 +118,7 @@ def run
     return unless command_valid?
     return if command_aborted?
     return if command_errored?
+    return if command_performing?
     return if command_performed?
     command_instance.perform_with_callbacks command_method_name
   rescue => error

package.json

@@ -26,6 +26,7 @@
     "esbuild": "^0.17.2",
     "eslint": "^8.19.0",
     "flowbite": "^1.5.3",
+    "playwright": "^1.29.2",
     "prettier-standard": "^16.4.1",
     "rustywind": "^0.15.1"
   },

test/application_system_test_case.rb

@@ -1,19 +1,48 @@
 # frozen_string_literal: true
 
 require "test_helper"
-require "capybara/cuprite"
+require "capybara-playwright-driver"
 
-# Capybara setup fom Evil Martians
-# SEE: https://evilmartians.com/chronicles/system-of-a-test-setting-up-end-to-end-rails-testing
-# NOTE: Will need to set this up for multiple sessions
-Capybara.default_max_wait_time = 2
-Capybara.default_normalize_ws = true
-# Capybara.save_path = ENV.fetch("CAPYBARA_ARTIFACTS", "./tmp/capybara")
-
-class ApplicationSystemTestCase < ActionDispatch::SystemTestCase
-  driven_by :cuprite, using: :headless_chrome, screen_size: [1400, 1400]
+class CapybaraNullDriver < Capybara::Driver::Base
+  def needs_server?
+    true
+  end
 end
 
+Capybara.register_driver(:null) { CapybaraNullDriver.new }
+Capybara.default_driver = :null
+Capybara.default_max_wait_time = 12
+Capybara.default_normalize_ws = true
+Capybara.save_path = "tmp/capybara"
 Capybara.configure do |config|
   config.server = :puma, {Silent: true}
 end
+
+class ApplicationSystemTestCase < ActionDispatch::SystemTestCase
+  driven_by :null
+
+  def self.playwright
+    @playwright ||= Playwright.create(playwright_cli_executable_path: Rails.root.join("../../node_modules/.bin/playwright"))
+  end
+
+  alias_method :orig_page, :page
+  attr_reader :playwright_browser, :playwright_page
+  alias_method :page, :playwright_page
+
+  def js(...)
+    page.evaluate(...)
+  end
+
+  def before_setup
+    super
+    base_url = Capybara.current_session.server.base_url
+    @playwright_browser = self.class.playwright.playwright.chromium.launch(headless: true)
+    @playwright_page = @playwright_browser.new_page(baseURL: base_url)
+    playwright_page.set_default_timeout Capybara.default_max_wait_time * 1_000
+  end
+
+  def after_teardown
+    super
+    playwright_browser&.close
+  end
+end

test/dummy/app/views/demos/increment/_rpc.html.erb

@@ -1,7 +1,7 @@
 <%= cache session[:rpc_count].to_i do %>
   <div id="rpc">
     <%= render "stats/stats", id: "rpc-stats" do %>
-      <%= render "stats/stat", label: "Counter", value: session[:rpc_count].to_i, class: "!bg-indigo-600 dark:!bg-indigo-900",
+      <%= render "stats/stat", label: "Counter", role: "counter", value: session[:rpc_count].to_i, class: "!bg-indigo-600 dark:!bg-indigo-900",
         value_class: ["!text-indigo-200 dark:!text-indigo-300"], label_class: ["!text-indigo-400 dark:!text-indigo-500"] %>
     <% end %>
 

test/dummy/app/views/stats/_stats.html.erb

@@ -1,4 +1,5 @@
 <%= tag.dl id: local_assigns.fetch(:id, "stats-#{SecureRandom.alphanumeric(12)}"),
+  data: { command_requested: turbo_boost.command_requested?, command_performing: turbo_boost.command_performing?, command_performed: turbo_boost.command_performed? },
   class: "grid gap-6 text-gray-900 sm:grid-cols-3 lg:grid-cols-5 dark:text-white" do %>
   <%= yield %>
   <%= render "stats/stat", label: "HTTP Fingerprint", role: "http-fingerprint", value: turbo_boost.command_requested? ? SecureRandom.alphanumeric(6).upcase : "N/A",
@@ -11,6 +12,6 @@
     class: token_list("!opacity-60": !turbo_boost.command_requested?),
     value: turbo_boost.command_requested? ? render(heroicon(:check_circle), solid: true, class: "-mt-2 text-emerald-500 h-10 w-auto inline") : render(heroicon(:x_circle), class: "-mt-2 text-red-500 h-10 w-auto inline") %>
   <%= render "stats/stat", label: "Command Performed",
-    class: token_list("!opacity-60": !turbo_boost.command_performed?),
-    value: turbo_boost.command_performed? ? render(heroicon(:check_circle), solid: true, class: "-mt-2 text-emerald-500 h-10 w-auto inline") : render(heroicon(:x_circle), class: "-mt-2 text-red-500 h-10 w-auto inline") %>
+    class: token_list("!opacity-60": !turbo_boost.command_performing? && !turbo_boost.command_performed?),
+    value: turbo_boost.command_performing? || turbo_boost.command_performed? ? render(heroicon(:check_circle), solid: true, class: "-mt-2 text-emerald-500 h-10 w-auto inline") : render(heroicon(:x_circle), class: "-mt-2 text-red-500 h-10 w-auto inline") %>
 <% end %>

test/system/demos/increment/button_in_frame_test.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "application_system_test_case"
+
+class IncrementButtonInFrameTest < ApplicationSystemTestCase
+  test "button-in-frame basic" do
+    name = "button-in-frame"
+    page.goto demo_url("increment")
+
+    # before demo
+    meta_element = page.wait_for_selector("meta#turbo-boost", state: "attached")
+    assert_equal "e30", meta_element["data-state"]
+    assert_nil js("TurboBoost.state.active_demo")
+
+    # open demo
+    demo_element = page.wait_for_selector("##{name}-demo")
+    demo_element.wait_for_selector("[data-turbo-command='DemosCommand#toggle']").click
+    sleep 0.1
+    assert js("document.cookie").include?("turbo_boost.state")
+    assert_equal 0, demo_element.wait_for_selector("[data-role='counter']").inner_text.to_i
+    assert_equal "N/A", demo_element.wait_for_selector("[data-role='http-fingerprint']").inner_text
+    assert_equal "N/A", demo_element.wait_for_selector("[data-role='http-method']").inner_text
+
+    # execute demo
+    demo_element.wait_for_selector("[data-turbo-command='CounterCommand#increment']").click
+    sleep 0.1
+    assert_equal 1, demo_element.wait_for_selector("[data-role='counter']").inner_text.to_i
+    assert_not_equal "N/A", demo_element.wait_for_selector("[data-role='http-fingerprint']").inner_text
+    assert_equal "GET", demo_element.wait_for_selector("[data-role='http-method']").inner_text
+    assert demo_element.wait_for_selector("[data-command-requested='true'][data-command-performing='false'][data-command-performed='true']")
+
+    # close demo
+    demo_element.wait_for_selector("[data-turbo-command='DemosCommand#toggle']").click
+    sleep 0.1
+    assert js("document.cookie").include?("turbo_boost.state")
+    assert_equal "e30", meta_element["data-state"]
+    assert_nil js("TurboBoost.state.active_demo")
+  end
+end