isomorfeus-puppetmaster 0.6.13 → 0.6.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: daa437e0662a07334e47cb067440f006bc9fa6015b2fe4f54deb57f1e11e19ee
-  data.tar.gz: a4f75f12075a733c14d4e3a0716e4c8b7018d33de39cee4e649bc48f06e4302f
+  metadata.gz: 602d8e8f04c6eb2290b4f0bda9bf2c2db5903dfbd86bd0cae7bed3489846378b
+  data.tar.gz: ca32e34cf20340a0c2039a1b625cffa6d5261313b699dd2a2b536e9b994d2f96
 SHA512:
-  metadata.gz: 9e63d3a9f93d812958ff8897a5f56385c4ae940790a3635e1909920d9078ae69c50cb57152646fd76970a02b1c46e71238bcf50bb3b7be59e6de7c2eff3ddb0f
-  data.tar.gz: eb1c6e57fc5a4e5cc0b7bdf82a394cd14fdbdfaea540ea52be667c3c2440f0596d04bbf177b3c2eee054d32ae094ef0a3b8ccdaac225f7988e08ecb175321fb8
+  metadata.gz: 1bfc337ba3188881e904feac1ef265a72aad83dee7add3731820cdfb81a940c1b5351963a524df2164f734019ce9e7fb0dfcc6fd1c4c9a85c388add303a419bf
+  data.tar.gz: 13c2c4858f01844b7cf8bd05ba4d20a04ff25b3d9f3695d2cd8cf178b25501da42e30533df162f6cad778635692058dafc5fd4d221d6bfd32e462a54c072d821

data/README.md

@@ -52,6 +52,16 @@ A document consists of elements. Simply working with just pages, documents and e
 1. Find something
 2. Interact with it
 
+## Sessions
+Using `visit` will open a default session. However, additional browser sessions may be opened with:
+```ruby
+s = new_session() # additional args may be passed, like headless: false, devtools: true
+# now the session can be interacted with:
+s.visit('/')
+t = new_session() # multiple sessions may be active at the same time
+t.visit('/')
+```
+
 ## Pages
 A page is a Puppeteer::Page and provides its complete API plus some additional convenience methods.
 The drivers opens a empty default page, to use that and go to the apps root page:
@@ -75,6 +85,13 @@ Both open pages can then be independently interacted with:
 page.visit('/go')
 page2.goto('/location')
 ```
+
+For debugging:
+```ruby
+page.visit('/', headless: false, devtools: true)
+```
+This will close the current browser if the options for headless and devtools dont match, and open a new one with the supplied headless and devtools options.
+
 ### Pages and Ruby
 
 Ruby can be executed within pages by simply providing a block or a string:

data/lib/isomorfeus/puppetmaster/dsl.rb

@@ -3,7 +3,7 @@ module Isomorfeus
     module DSL
       @@launch_options = nil
 
-      def set_launch_options(app: nil, args: nil, channel: nil, default_viewport: nil, devtools: nil, dumpio: nil,
+      def set_launch_options(app: nil, args: nil, channel: nil, default_viewport: nil, devtools: false, dumpio: nil,
                              env: nil, executable_path: nil, handle_SIGINT: nil, handle_SIGTERM: nil, handle_SIGHUP: nil,
                              headless: true, ignore_default_args: nil, ignore_https_errors: nil, pipe: nil,
                              product: :chrome, slow_mo: nil, timeout: nil, user_data_dir: nil)
@@ -34,11 +34,11 @@ module Isomorfeus
         session.default_page
       end
 
-      def goto(uri, referer: nil, timeout: nil, wait_until: 'networkidle0')
-        session.goto(uri, referer: referer, timeout: timeout, wait_until: wait_until)
+      def visit(uri, referer: nil, timeout: nil, wait_until: 'networkidle0', headless: true, devtools: false)
+        session(headless: headless, devtools: devtools).visit(uri, referer: referer, timeout: timeout, wait_until: wait_until, headless: headless, devtools: devtools)
         session.default_page
       end
-      alias_method :visit, :goto
+      alias_method :goto, :visit
 
       def isomorphic(ruby_source = '', &block)
         ruby_source = Isomorfeus::Puppetmaster.block_source_code(&block) if block_given?
@@ -56,7 +56,7 @@ module Isomorfeus
         Isomorfeus::Puppetmaster.served_app.on_server(ruby_source, &block)
       end
 
-      def new_session(app: nil, args: nil, channel: nil, default_viewport: nil, devtools: nil, dumpio: nil,
+      def new_session(app: nil, args: nil, channel: nil, default_viewport: nil, devtools: false, dumpio: nil,
                       env: nil, executable_path: nil, handle_SIGINT: nil, handle_SIGTERM: nil, handle_SIGHUP: nil,
                       headless: true, ignore_default_args: nil, ignore_https_errors: nil, pipe: nil,
                       product: :chrome, slow_mo: nil, timeout: nil, user_data_dir: nil)
@@ -109,8 +109,8 @@ module Isomorfeus
         Isomorfeus::Puppetmaster.served_app.on_server(ruby_source)
       end
 
-      def session
-        @@puppetmaster_session ||= new_session(app: Isomorfeus::Puppetmaster.served_app)
+      def session(headless: true, devtools: false)
+        @@puppetmaster_session ||= new_session(app: Isomorfeus::Puppetmaster.served_app, headless: headless, devtools: devtools)
       end
     end
   end

data/lib/isomorfeus/puppetmaster/session.rb

@@ -4,23 +4,24 @@ module Isomorfeus
       TIMEOUT = 30000 # milliseconds
 
       attr_accessor :app, :browser, :default_page, :product, :response
+      attr_reader :headless, :devtools
 
-      def initialize(app:, args: nil, channel: nil, default_viewport: nil, devtools: nil, dumpio: nil,
+      def initialize(app:, args: nil, channel: nil, default_viewport: nil, devtools: false, dumpio: nil,
                      env: nil, executable_path: nil, handle_SIGINT: nil, handle_SIGTERM: nil, handle_SIGHUP: nil,
                      headless: true, ignore_default_args: nil, ignore_https_errors: nil, pipe: nil,
                      product: :chrome, slow_mo: nil, timeout: nil, user_data_dir: nil)
-        @app = app
+        @parameters = binding.local_variables.map { |v| [v, binding.local_variable_get(v)] }.to_h
+        @parameters[:channel] = @parameters[:channel].to_s if channel
+        @parameters[:timeout] = TIMEOUT unless timeout
+        @app = @parameters.delete(:app)
+        @headless = headless
+        @devtools = devtools
+        @channel = channel
+        default_viewport
         product = product.to_s
-        @product = %w[chrome firefox].include?(product) ? product : 'chrome'
-        @browser = ::Puppeteer.launch(args: args, channel: channel&.to_s, devtools: devtools, default_viewport: default_viewport,
-                                      dumpio: dumpio, env: env, executable_path: executable_path, handle_SIGINT: handle_SIGINT,
-                                      handle_SIGTERM: handle_SIGTERM, handle_SIGHUP: handle_SIGHUP, headless: headless,
-                                      ignore_default_args: ignore_default_args, ignore_https_errors: ignore_https_errors,
-                                      pipe: pipe, product: product, slow_mo: slow_mo, timeout: timeout ? timeout : TIMEOUT,
-                                      user_data_dir: user_data_dir)
-        @original_user_agent = @browser.user_agent
-        @default_page = @browser.new_page
-        @default_page.puppetmaster_session = self
+        @parameters[:product] = %w[chrome firefox].include?(product) ? product : 'chrome'
+        @product = @parameters[:product]
+        launch_browser
         ObjectSpace.define_finalizer(self, self.class.close_browser(self))
       end
 
@@ -40,12 +41,18 @@ module Isomorfeus
         @browser.pages
       end
 
-      def goto(uri, referer: nil, timeout: nil, wait_until: 'networkidle0')
+      def visit(uri, referer: nil, timeout: nil, wait_until: 'networkidle0', headless: true, devtools: false)
+        if @headless != headless || @devtools != devtools
+          @browser.close
+          @headless = headless
+          @devtools = devtools
+          launch_browser
+        end
         parsed_uri = parse_uri(uri)
         @response = @default_page.goto(parsed_uri.to_s, referer: referer, timeout: timeout, wait_until: wait_until)
         @default_page
       end
-      alias_method :visit, :goto
+      alias_method :goto, :visit
 
       def network_conditions
         ::Puppeteer::NETWORK_CONDITIONS
@@ -144,6 +151,15 @@ module Isomorfeus
           instance.browser.close if instance.browser
         end
       end
+
+      def launch_browser
+        @parameters[:headless] = @headless
+        @parameters[:devtools] = @devtools
+        @browser = ::Puppeteer.launch(**@parameters)
+        @original_user_agent = @browser.user_agent
+        @default_page = @browser.new_page
+        @default_page.puppetmaster_session = self
+      end
     end
   end
 end

data/lib/isomorfeus/puppetmaster/version.rb

@@ -1,3 +1,3 @@
 module Isomorfeus
-  PUPPETMASTER_VERSION = '0.6.13'
+  PUPPETMASTER_VERSION = '0.6.14'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: isomorfeus-puppetmaster
 version: !ruby/object:Gem::Version
-  version: 0.6.13
+  version: 0.6.14
 platform: ruby
 authors:
 - Jan Biedermann
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-09 00:00:00.000000000 Z
+date: 2022-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport