playwright-on-rails 0.7.1

data/lib/playwright-on-rails/server.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require "uri"
+require "net/http"
+require "rack"
+require_relative "initializer_hooks"
+require_relative "server/middleware"
+require_relative "server/checker"
+require_relative "server/timer"
+require_relative "server/puma"
+
+module PlaywrightOnRails
+  class Server
+    class << self
+      def ports
+        @ports ||= {}
+      end
+    end
+
+    attr_reader :app, :host, :port
+
+    def initialize(app,
+      host:,
+      port:,
+      reportable_errors: [Exception],
+      extra_middleware: [])
+      @app = app
+      @extra_middleware = extra_middleware
+      @server_thread = nil # suppress warnings
+      @host = host
+      @reportable_errors = reportable_errors
+      @port = port
+      @port ||= Server.ports[port_key]
+      @port ||= find_available_port(host)
+      @checker = Checker.new(@host, @port)
+      @initializer_hooks = InitializerHooks.instance
+    end
+
+    def reset_error!
+      middleware.clear_error
+    end
+
+    def error
+      middleware.error
+    end
+
+    def using_ssl?
+      @checker.ssl?
+    end
+
+    def responsive?
+      return false if @server_thread&.join(0)
+
+      res = @checker.request { |http| http.get("/__identify__") }
+
+      res.body == app.object_id.to_s if res.is_a?(Net::HTTPSuccess) || res.is_a?(Net::HTTPRedirection)
+    rescue SystemCallError, Net::ReadTimeout, OpenSSL::SSL::SSLError
+      false
+    end
+
+    def wait_for_pending_requests
+      timer = Timer.new(60)
+      while pending_requests?
+        raise "Requests did not finish in 60 seconds: #{middleware.pending_requests}" if timer.expired?
+
+        sleep 0.01
+      end
+    end
+
+    def boot
+      unless responsive?
+        Server.ports[port_key] = port
+
+        @server_thread = Thread.new {
+          Puma.create(middleware, port, host)
+        }
+
+        timer = Timer.new(60)
+        until responsive?
+          raise "Rack application timed out during boot" if timer.expired?
+
+          @server_thread.join(0.1)
+          @initializer_hooks.run(:after_server_start)
+        end
+      end
+
+      self
+    end
+
+    private
+
+    def middleware
+      @middleware ||= Middleware.new(app, @reportable_errors, @extra_middleware)
+    end
+
+    def port_key
+      app.object_id # as opposed to middleware.object_id if multiple instances
+    end
+
+    def pending_requests?
+      middleware.pending_requests?
+    end
+
+    def find_available_port(host)
+      server = TCPServer.new(host, 0)
+      port = server.addr[1]
+      server.close
+
+      # Workaround issue where some platforms (mac, ???) when passed a host
+      # of '0.0.0.0' will return a port that is only available on one of the
+      # ip addresses that resolves to, but the next binding to that port requires
+      # that port to be available on all ips
+      server = TCPServer.new(host, port)
+      port
+    rescue Errno::EADDRINUSE
+      retry
+    ensure
+      server&.close
+    end
+  end
+end

data/lib/playwright-on-rails/starts_rails_server.rb

@@ -0,0 +1,34 @@
+require_relative "tracks_resets"
+require_relative "server"
+
+module PlaywrightOnRails
+  class StartsRailsServer
+    def call(host:, port:, transactional_server:)
+      configure_rails_to_run_our_state_reset_on_every_request!(transactional_server)
+      app = create_rack_app
+      Server.new(app, host: host, port: port).tap do |server|
+        server.boot
+      end
+    end
+
+    def configure_rails_to_run_our_state_reset_on_every_request!(transactional_server)
+      Rails.application.executor.to_run do
+        TracksResets.instance.reset_state_if_needed(transactional_server)
+      end
+    end
+
+    def create_rack_app
+      Rack::Builder.new do
+        map "/playwright-on-rails_reset_state" do
+          run lambda { |env|
+            TracksResets.instance.reset_needed!
+            [202, {"Content-Type" => "text/plain"}, ["Accepted"]]
+          }
+        end
+        map "/" do
+          run Rails.application
+        end
+      end
+    end
+  end
+end

data/lib/playwright-on-rails/tracks_resets.rb

@@ -0,0 +1,26 @@
+require_relative "resets_state"
+
+module PlaywrightOnRails
+  class TracksResets
+    def self.instance
+      @instance ||= new
+    end
+
+    def reset_needed!
+      @reset_needed = true
+    end
+
+    def reset_state_if_needed(transactional_server)
+      if @reset_needed
+        ResetsState.new.call(transactional_server: transactional_server)
+        @reset_needed = false
+      end
+    end
+
+    private
+
+    def initialize
+      @reset_needed = false
+    end
+  end
+end

data/lib/playwright-on-rails/version.rb

@@ -0,0 +1,3 @@
+module PlaywrightOnRails
+  VERSION = "0.7.1"
+end

data/lib/playwright-on-rails.rb

@@ -0,0 +1,11 @@
+require "playwright-on-rails/version"
+
+module PlaywrightOnRails
+end
+
+require "playwright-on-rails/init"
+require "playwright-on-rails/open"
+require "playwright-on-rails/run"
+require "playwright-on-rails/resets_state"
+require "playwright-on-rails/initializer_hooks"
+require "playwright-on-rails/railtie" if defined?(Rails)

data/playwright_rails.gemspec

@@ -0,0 +1,32 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "playwright-on-rails/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "playwright-on-rails"
+  spec.version = PlaywrightOnRails::VERSION
+  spec.authors = ["Arthur Hess"]
+  spec.email = ["arthess@gmail.com"]
+
+  spec.summary = "Helps you write Playwright tests of your Rails app"
+  spec.homepage = "https://github.com/arthurhess/playwright-on-rails"
+  spec.license = "MIT"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|example)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "railties", ">= 5.2.0"
+  spec.add_dependency "puma", ">= 3.8.0"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "standard", ">= 0.2.0"
+end

data/script/test

@@ -0,0 +1,21 @@
+#!/usr/bin/env bash
+
+PS4='[script/test:${LINENO}] $ '
+set -euo pipefail
+set -x
+
+echo "---> Installing dependencies"
+bundle
+cd example
+bundle
+yarn
+cd ..
+
+echo "---> Running tests"
+bundle exec rake
+./script/test_example_app
+
+bundle exec rake test
+
+echo "---> Job's done!"
+

data/script/test_example_app

@@ -0,0 +1,21 @@
+#!/usr/bin/env bash
+
+set -e
+
+directory=$1
+
+cd example
+bundle
+yarn install
+
+# test a normal test run
+bundle exec rake db:test:prepare
+NODE_OPTIONS=--openssl-legacy-provider RAILS_ENV=test bundle exec rake assets:precompile
+bundle exec rake playwright:run
+
+# test that passing options works (by printing help)
+if ! bundle exec rake playwright:run PLAYWRIGHT_RAILS_PLAYWRIGHT_OPTS="-h" | grep -q "Usage: playwright run \[options\]"; then
+  echo "Failed to pass options to playwright run"
+  exit 1
+fi
+

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: playwright-on-rails
+version: !ruby/object:Gem::Version
+  version: 0.7.1
+platform: ruby
+authors:
+- Arthur Hess
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+description:
+email:
+- arthess@gmail.com
+executables:
+- playwright-on-rails
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".standard.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/playwright-on-rails
+- lib/playwright-on-rails.rb
+- lib/playwright-on-rails/config.rb
+- lib/playwright-on-rails/env.rb
+- lib/playwright-on-rails/finds_bin.rb
+- lib/playwright-on-rails/init.rb
+- lib/playwright-on-rails/initializer_hooks.rb
+- lib/playwright-on-rails/launches_playwright.rb
+- lib/playwright-on-rails/manages_transactions.rb
+- lib/playwright-on-rails/open.rb
+- lib/playwright-on-rails/railtie.rb
+- lib/playwright-on-rails/rake.rb
+- lib/playwright-on-rails/resets_state.rb
+- lib/playwright-on-rails/run.rb
+- lib/playwright-on-rails/server.rb
+- lib/playwright-on-rails/server/checker.rb
+- lib/playwright-on-rails/server/middleware.rb
+- lib/playwright-on-rails/server/puma.rb
+- lib/playwright-on-rails/server/timer.rb
+- lib/playwright-on-rails/starts_rails_server.rb
+- lib/playwright-on-rails/tracks_resets.rb
+- lib/playwright-on-rails/version.rb
+- playwright_rails.gemspec
+- script/test
+- script/test_example_app
+homepage: https://github.com/arthurhess/playwright-on-rails
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key:
+specification_version: 4
+summary: Helps you write Playwright tests of your Rails app
+test_files: []