booth 0.1.7 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 117283879ce936895cf4def7b4d6e7780af5739434078bc91f7c462c6145526a
-  data.tar.gz: ad8f7c4d0fcdeba1987d965eb503f68ccf0daac32328c8a1332977191bbc289c
+  metadata.gz: db40cf227698f8a64fdb6f1071dd3ee00a1b5183dfc75d93ea240aeaee342ce6
+  data.tar.gz: 8bd55ef8c5f2c6f19fa37f8208a49cb8892e15b1e89c9198a9ca9c017e74287a
 SHA512:
-  metadata.gz: b35328cca811b4a19136a819ab05c0e894cd4fa65d1a6195c8abd96fc49d0fa14894aed1bb746293034728e48ae421a07f758f2734fb9d2b19c13f0ebb1e1c7f
-  data.tar.gz: 6a15f32a17273e19164f108ce483a0eea5ebfe5a516a12218a3877c2170b32d2ad6dd4efe73a5988218f48b33b52d8e795dcd7f1a726f629a389dc5539424ee5
+  metadata.gz: ae2923901eb6bfad19ba323d1e1196e681fc13844bbed95df090a82a1ee328ef682a770e57aff8837a0376ee425a4079193240f3fcf8b804d8f4a61b55645865
+  data.tar.gz: ffbdf991361b877d58cca3499e1b6b1d61927bb942e2159cc676f7d1eb892a7cc85f63b71ba7667113e69c523dbd779d146299996615755cf1d637c9b96689a1

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # main
 
+# 0.1.9
+
+* Test support: `AssertLoggedIn` now also waits for the page navigation that `booth/verification.js` triggers after a passkey ceremony, so the next `visit` of a scenario no longer races with it ("Navigation to ... is interrupted by another navigation")
+* Test support: `Support::Visit` (used by `visit_namespaced`) and the new shortcut `visit_url` survive a navigation that collides with the self-reload of a polling page such as `remote_session_available` (`net::ERR_ABORTED`). The userland scenarios `LoginRemotely` and `RegistrationWithoutPasskey` use it
+
+# 0.1.8
+
+* Add Credential block and unblock to Adminland
+
 # 0.1.7
 
 * Fix time travel actually returning in test suite

data/lib/booth/adminland/credentials/block.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Booth
+  module Adminland
+    module Credentials
+      # Blocks a credential from authenticating.
+      class Block
+        include Calls
+
+        option :credential_id
+
+        def call
+          return Tron.failure(:credential_not_found) unless credential
+
+          if credential.blocked?
+            return Tron.success(:already_blocked,
+                                id: credential.id,
+                                blocked_at: credential.blocked_at)
+          end
+
+          blocked_at = Time.current
+          credential.update!(blocked_at:)
+
+          Tron.success(:credential_blocked, id: credential.id, blocked_at:)
+        end
+
+        private
+
+        def credential
+          return @credential if defined?(@credential)
+
+          uuid = ::Booth::Syntaxes::Uuid.call(credential_id, raise_if_invalid: false).uuid
+          @credential = ::Booth::Models::Credential.find_by(id: uuid) if uuid
+        end
+      end
+    end
+  end
+end

data/lib/booth/adminland/credentials/unblock.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Booth
+  module Adminland
+    module Credentials
+      # Allows a credential to authenticate again.
+      class Unblock
+        include Calls
+
+        option :credential_id
+
+        def call
+          return Tron.failure(:credential_not_found) unless credential
+
+          unless credential.blocked?
+            return Tron.success(:already_unblocked,
+                                id: credential.id,
+                                blocked_at: credential.blocked_at)
+          end
+
+          credential.update!(blocked_at: nil)
+
+          Tron.success(:credential_unblocked, id: credential.id, blocked_at: nil)
+        end
+
+        private
+
+        def credential
+          return @credential if defined?(@credential)
+
+          uuid = ::Booth::Syntaxes::Uuid.call(credential_id, raise_if_invalid: false).uuid
+          @credential = ::Booth::Models::Credential.find_by(id: uuid) if uuid
+        end
+      end
+    end
+  end
+end

data/lib/booth/adminland.rb

@@ -7,6 +7,14 @@ module Booth
     # Credential Helpers
     # ------------------
 
+    def self.block_credential(...)
+      ::Booth::Adminland::Credentials::Block.call(...)
+    end
+
+    def self.unblock_credential(...)
+      ::Booth::Adminland::Credentials::Unblock.call(...)
+    end
+
     def self.create_credential(...)
       ::Booth::Adminland::Credentials::Create.call(...)
     end

data/lib/booth/testing/shortcuts.rb

@@ -14,6 +14,11 @@ module Booth
         ::Booth::Testing::Support::Visit.call(routing_namespace:, controller:, action:, params:)
       end
 
+      # Like Capybara's `visit`, but survives a page that reloads itself at the same moment.
+      def visit_url(url)
+        ::Booth::Testing::Support::VisitUrl.call(url:)
+      end
+
       def create_and_onboard(username:)
         ::Booth::Testing::Support::Shortcuts::CreateAndOnboard.call(routing_namespace:,
                                                                     scope:,

data/lib/booth/testing/support/assert_logged_in.rb

@@ -13,7 +13,26 @@ module Booth
         option :credential, as: :manual_credential, optional: true
         option :username, optional: true
 
+        # The Session cookie arrives with the 201 response of the passkey verification.
+        # Only afterwards does `booth/verification.js` navigate the page itself
+        # (`window.location.href = window.location.href`). Without waiting for that, the next
+        # `visit` of a scenario races with it and Playwright raises
+        # "Navigation to ... is interrupted by another navigation".
+        PASSKEY_FORM = '.js-booth-webauth-authentication, .js-booth-webauth-registration'
+        SETTLE_TIMEOUT = 5 # seconds; the wait ends silently when no navigation follows
+
         def call
+          # Only a page that still shows a passkey form is about to navigate by itself.
+          document_before = document_started_at if passkey_form_present?
+
+          wait_for_session_cookie.tap do
+            wait_until_page_was_replaced(document_before) if document_before
+          end
+        end
+
+        private
+
+        def wait_for_session_cookie
           browser_session_id = nil
 
           begin
@@ -37,7 +56,29 @@ module Booth
                                       "but the Browser Cookie has #{browser_session_id} "
         end
 
-        private
+        def passkey_form_present?
+          page.evaluate_script("document.querySelector(#{PASSKEY_FORM.to_json}) !== null")
+        rescue ::Playwright::Error
+          true # Mid-navigation: the page is replacing itself, so wait for the new document.
+        end
+
+        # Millisecond timestamp at which the current document started loading
+        # (nil while navigating).
+        def document_started_at
+          page.evaluate_script("document.readyState === 'complete' ? performance.timeOrigin : null")
+        rescue ::Playwright::Error
+          nil # The execution context was destroyed by a navigation: a new document is on its way.
+        end
+
+        def wait_until_page_was_replaced(document_before)
+          deadline = Process.clock_gettime(Process::CLOCK_MONOTONIC) + SETTLE_TIMEOUT
+          while Process.clock_gettime(Process::CLOCK_MONOTONIC) < deadline
+            current = document_started_at
+            return if current && current != document_before
+
+            sleep 0.05
+          end
+        end
 
         # Playwright session handling causes ActiveRecord to aggressively cache queries.
         # Randomizing the query seems to be the only reliable way to avoid this.

data/lib/booth/testing/support/visit.rb

@@ -15,7 +15,7 @@ module Booth
 
         def call
           log { "-----> Visiting #{controller}/#{action} #{params.presence} on #{subdomain}.localhost" }
-          visit ::Rails.application.routes.url_helpers.url_for(options)
+          ::Booth::Testing::Support::VisitUrl.call(url: ::Rails.application.routes.url_helpers.url_for(options))
         end
 
         private

data/lib/booth/testing/support/visit_url.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Booth
+  module Testing
+    module Support
+      # Visits a URL, surviving a navigation the page started by itself.
+      #
+      # Booth pages that wait for something on another device (e.g. `remote_session_available`)
+      # reload themselves every 5-7 seconds (`Gui.reloadSoon` in `booth/gui.js`).
+      # When such a page lives in another browser session while a scenario does other things,
+      # the scenario's next `visit` can collide with that reload. Playwright then raises
+      # `net::ERR_ABORTED` or "Navigation to ... is interrupted by another navigation".
+      # The reloaded page is stable for several seconds, so navigating again is safe.
+      # Any other error is raised as usual.
+      class VisitUrl
+        include ::Calls
+        include ::Capybara::DSL
+        include ::Booth::Logging
+
+        MAX_ATTEMPTS = 3
+        OVERTAKEN = /ERR_ABORTED|interrupted by another navigation/
+
+        option :url
+
+        def call
+          attempts = 0
+
+          begin
+            attempts += 1
+            visit url
+          rescue ::Playwright::Error => e
+            raise unless e.message.match?(OVERTAKEN) && attempts < MAX_ATTEMPTS
+
+            log { "Navigation to #{url} was overtaken by the page itself, retrying..." }
+            wait_until_page_is_loaded
+            retry
+          end
+        end
+
+        private
+
+        def wait_until_page_is_loaded
+          deadline = Process.clock_gettime(Process::CLOCK_MONOTONIC) +
+                     Capybara.default_max_wait_time
+          while Process.clock_gettime(Process::CLOCK_MONOTONIC) < deadline
+            return if page.evaluate_script('document.readyState') == 'complete'
+
+            sleep 0.05
+          end
+        rescue ::Playwright::Error
+          sleep 0.1 # Still navigating, the retry itself will wait for the page.
+        end
+      end
+    end
+  end
+end

data/lib/booth/testing/userland/login_remotely.rb

@@ -49,7 +49,8 @@ module Booth
           assert_userland_view controller: :remote_logins, step: :remote_solved
 
           using_session(:other_device) do
-            visit current_path
+            # This page polls (reloads itself every 5-7s), which may overtake our navigation.
+            visit_url current_path
 
             # ------------ SIGNIFICANT TEST --------------
             # Webauth sudo is required after remote login.

data/lib/booth/testing/userland/registration_without_passkey.rb

@@ -57,7 +57,8 @@ module Booth
           assert_userland_view controller: :remote_logins, step: :remote_solved
 
           using_session(:other_device) do
-            visit current_path
+            # This page polls (reloads itself every 5-7s), which may overtake our navigation.
+            visit_url current_path
 
             # -------------------------- SIGNIFICANT TEST ---------------------------
             # You can remote-login even though you don't have any Authenticators yet.

data/lib/booth/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Booth
-  VERSION = '0.1.7'
+  VERSION = '0.1.9'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: booth
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.9
 platform: ruby
 authors:
 - halo
@@ -228,8 +228,10 @@ files:
 - lib/booth.rb
 - lib/booth/adminland.rb
 - lib/booth/adminland/authenticators/exist.rb
+- lib/booth/adminland/credentials/block.rb
 - lib/booth/adminland/credentials/create.rb
 - lib/booth/adminland/credentials/index.rb
+- lib/booth/adminland/credentials/unblock.rb
 - lib/booth/adminland/incognitos/consume_token.rb
 - lib/booth/adminland/incognitos/generate_secret_key.rb
 - lib/booth/adminland/incognitos/stop_incognito.rb
@@ -339,6 +341,7 @@ files:
 - lib/booth/testing/support/virtual_authenticators/enable.rb
 - lib/booth/testing/support/virtual_authenticators/load.rb
 - lib/booth/testing/support/visit.rb
+- lib/booth/testing/support/visit_url.rb
 - lib/booth/testing/userland.rb
 - lib/booth/testing/userland/login_remotely.rb
 - lib/booth/testing/userland/onboarding_first_time.rb
@@ -417,7 +420,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Opinionated authentication framework for Rails
 test_files: []