isomorfeus-puppetmaster 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7123d1c27ed7357e7ac6fff577bb2dcd025bd7d622c2ba849d1232ab9d3086d2
-  data.tar.gz: 4020f116455824c9ff42c4dca646ef69fb252ee7113986cb3926109cb874d381
+  metadata.gz: 2d453a12b9cc8f801e1e81fdda6e615d7d256253eec19b60c7c969c8bf08bd72
+  data.tar.gz: cbef053148c753b2b03c6b15e1bb815af51dfdc7821a10d422c803862ac57dcd
 SHA512:
-  metadata.gz: c30ba060532b000fe950b6bbbd0dcde8a22f0957771368b0b4f8862839f4690102ea71b7ce8e74e1f6d1c5aaded08331cb4a387f14adde8dd3b0cd902b3484e7
-  data.tar.gz: 9418b91dd65c552b9f26fa1c92fe2eeb2e75eb5f807125a6413e1812fd58545d3c6c554474f565b43700acb54f6478add020444b9ee202978758e782ce24ab74
+  metadata.gz: 42dd469ad600d330aa8904a31d638c8915bd6f49aba4990ff76c3bc92886d662f08d483128be27ffc6fdb4cf136a552b6f9a648c4609c1f4e50a0a61fa664ca8
+  data.tar.gz: 5dc01c153258ca15823abaa9ad535869cebc5aced2b5e5af6c1346b64b73a4666b68969320e06a589ce9b0064e8b1889657da5742e3f39699d2505798a7865e3

data/README.md

@@ -19,9 +19,7 @@ In Gemfile:
 
 Also requires the following npm modules with recommended versions:
 
-- [puppeteer 2.0.0](https://github.com/GoogleChrome/puppeteer#readme) - for the chromium driver
-- [jsdom 15.2.1](https://github.com/jsdom/jsdom#readme) - for the jsdom driver
-- [canvas 2.6.0](https://github.com/Automattic/node-canvas) - for the jsdom driver (optional)
+- [puppeteer 9.1.x](https://github.com/GoogleChrome/puppeteer#readme) - for the chromium driver
 
 Simply install them in your projects root. Puppetmaster also depends on isomorfeus-speednode, which will be installed automatically.
 Speednode will pickup the node modules then from the projects root node_modules directory.
@@ -30,15 +28,11 @@ Speednode will pickup the node modules then from the projects root node_modules
 
 Puppetmaster provides these drivers:
 - chromium - a real browser, headless, fast
-- chromium_wsl - as above but with options so it can execute within the Windows Linux WSL
 - chromium_debug - opens a chromium browser window with devtools enabled, useful for debugging tests
-- jsdom - provides a dom implementation in javascript, can execute javascript in the document, super fast, headless, has certain limitations,
-  especially because its not rendering anything (no element bounding box, etc.)
-- jsdom_canvas - jsdom driver with additional support for 'canvas', requires certain libraries to be installed, see: [canvas at github](https://github.com/Automattic/node-canvas)
 
-Chromium is the default driver. Selecting another driver, for example jsdom:
+Chromium is the default driver. Selecting another driver, for example firefox:
 ```ruby
-Isomorfeus::Puppetmaster.driver = :jsdom
+Isomorfeus::Puppetmaster.driver = :chromium_debug
 ```
 
 Puppetmaster provides support for these rack servers:

data/lib/isomorfeus-puppetmaster.rb

@@ -36,9 +36,6 @@ require 'isomorfeus/puppetmaster/iframe'
 require 'isomorfeus/puppetmaster/driver/puppeteer_document'
 require 'isomorfeus/puppetmaster/driver/puppeteer_node'
 require 'isomorfeus/puppetmaster/driver/puppeteer'
-require 'isomorfeus/puppetmaster/driver/jsdom_document'
-require 'isomorfeus/puppetmaster/driver/jsdom_node'
-require 'isomorfeus/puppetmaster/driver/jsdom'
 require 'isomorfeus/puppetmaster/driver_registration'
 require 'isomorfeus/puppetmaster/server/executor_middleware'
 require 'isomorfeus/puppetmaster/server/middleware'
@@ -46,4 +43,4 @@ require 'isomorfeus/puppetmaster/server/checker'
 require 'isomorfeus/puppetmaster/server'
 require 'isomorfeus/puppetmaster/server_registration'
 
-require 'isomorfeus/puppetmaster/dsl'
+require 'isomorfeus/puppetmaster/dsl'

data/lib/isomorfeus/puppetmaster/document.rb

@@ -15,7 +15,6 @@ module Isomorfeus
         clear_cookies
         clear_extra_headers
         clear_url_blacklist
-        click
         close
         cookies
         console
@@ -34,15 +33,11 @@ module Isomorfeus
         html
         open_new_document
         remove_cookie
-        render_base64
         reset_user_agent
         right_click
-        save_pdf
-        save_screenshot
         scroll_by
         scroll_to
         set_authentication_credentials
-        set_cookie
         set_extra_headers
         set_url_blacklist
         set_user_agent
@@ -56,6 +51,14 @@ module Isomorfeus
         wait_for_xpath
       ]
 
+      document_forward_kwargs %i[
+        click
+        render_base64
+        save_pdf
+        save_screenshot
+        set_cookie
+      ]
+
       attr_reader :handle, :response
 
       def initialize(driver, handle, response)
@@ -79,21 +82,28 @@ module Isomorfeus
         end
         evaluate_script <<~JAVASCRIPT
           (function(){
-            Opal.gvars.promise_resolved = false;
-            Opal.await_ruby_exception = null;
-            try {
-              return #{compiled_ruby}
-            } catch (e) {
-              Opal.await_ruby_exception = e;
-              Opal.gvars.promise_resolved = true;
+            fun = function() {
+              if (Opal) {
+                Opal.gvars.promise_resolved = false;
+                Opal.await_ruby_exception = null;
+                try {
+                  return #{compiled_ruby}
+                } catch (e) {
+                  Opal.await_ruby_exception = e;
+                  Opal.gvars.promise_resolved = true;
+                }
+              } else {
+                setTimeout(fun, 100);
+              }
             }
+            fun();
           })()
         JAVASCRIPT
         have_result = false
         start = Time.now
         until have_result do
-          break if (Time.now - start) > 30
-          have_result = evaluate_script 'Opal.gvars.promise_resolved'
+          raise "await_ruby: execution timed out! Is Opal available?" if (Time.now - start) > 30
+          have_result = evaluate_script 'Opal ? Opal.gvars.promise_resolved : null'
           sleep 0.1 unless have_result
         end
         result, exception = execute_script <<~JAVASCRIPT
@@ -102,10 +112,12 @@ module Isomorfeus
           if (Opal.await_ruby_exception) {
             var e = Opal.await_ruby_exception;
             exception = { message: e.message, name: e.name, stack: e.stack }
-          } else if (typeof Opal.gvars.promise_result.$to_n === 'function') { 
-            result = Opal.gvars.promise_result.$to_n(); 
-          }
-          else { result = Opal.gvars.promise_result };
+          } else if (Opal.gvars.promise_result['$respond_to?']('is_a?') && Opal.gvars.promise_result['$is_a?'](Opal.Exception)) {
+            let r = Opal.gvars.promise_result;
+            exception = { message: r.$message(), name: r.$class().$name(), stack: r.$backtrace() }
+          } else if (Opal.gvars.promise_result['$respond_to?']('to_n')) { 
+            result = Opal.gvars.promise_result.$to_n()
+          } else { result = Opal.gvars.promise_result };
           delete Opal.gvars.promise_result;
           delete Opal.gvars.promise_resolved;
           return [result, exception];
@@ -166,11 +178,11 @@ module Isomorfeus
       alias_method :visit, :goto
 
       def has_content?(content, **options)
-        body.has_content?(content, options)
+        body.has_content?(content, **options)
       end
 
       def has_css?(selector, **options)
-        body.has_css?(selector, options)
+        body.has_css?(selector, **options)
       end
 
       def has_current_path?(other_path)
@@ -178,11 +190,11 @@ module Isomorfeus
       end
 
       def has_text?(text, **options)
-        body.has_text?(text, options)
+        body.has_text?(text, **options)
       end
 
       def has_xpath?(query, **options)
-        body.has_xpath?(query, options)
+        body.has_xpath?(query, **options)
       end
 
       def isomorphic(ruby_source = '', &block)
@@ -251,7 +263,7 @@ module Isomorfeus
       protected
 
       def compile_ruby_source(source_code)
-        # TODO maybe use compile server
+        # TODO maybe use compile server, which can cache code
         Opal.compile(source_code, parse_comments: false)
       end
     end

data/lib/isomorfeus/puppetmaster/driver/puppeteer.rb

@@ -36,10 +36,11 @@ module Isomorfeus
 
         def initialize(options = {})
           # https://pptr.dev/#?product=Puppeteer&version=v1.12.2&show=api-puppeteerlaunchoptions
-          # init ExecJs context
+          # init ExecJS context
           @app = options.delete(:app)
           @options = options.dup
           @browser_type = @options.delete(:browser_type) { :chromium }
+          @options[:product] = "'#{@browser_type}'" unless @options.key?(:product)
           @max_width = @options.delete(:max_width) { VIEWPORT_MAX_WIDTH }
           @max_height = @options.delete(:max_height) { VIEWPORT_MAX_HEIGHT }
           @width = @options.delete(:width) { VIEWPORT_DEFAULT_WIDTH > @max_width ? @max_width : VIEWPORT_DEFAULT_WIDTH }
@@ -196,18 +197,16 @@ module Isomorfeus
         def await(script)
           @context.eval <<~JAVASCRIPT
             (async () => {
-              try {
-                LastExecutionFinished = false;
-                LastResult = null;
-                LastErr = null;
-                #{script}
-                LastExecutionFinished = true;
-              } catch(err) {
-                LastResult = null;
-                LastErr = err;
-                LastExecutionFinished = true;
-              }
-            })()
+              LastExecutionFinished = false;
+              LastResult = null;
+              LastErr = null;
+              #{script}
+              LastExecutionFinished = true;
+            })().catch(function(err) {
+              LastResult = null;
+              LastErr = err;
+              LastExecutionFinished = true;
+            })
           JAVASCRIPT
           await_result
         end
@@ -220,26 +219,29 @@ module Isomorfeus
           get_result
         end
 
-        def chromium_require
+        def default_require
           <<~JAVASCRIPT
             const MasterPuppeteer = require('puppeteer');
           JAVASCRIPT
         end
 
-        def determine_error(message)
-          if message.include?('net::ERR_CERT_') || message.include?('SEC_ERROR_EXPIRED_CERTIFICATE')
-            Isomorfeus::Puppetmaster::CertificateError.new(message)
-          elsif message.include?('net::ERR_NAME_') || message.include?('NS_ERROR_UNKNOWN_HOST')
-            Isomorfeus::Puppetmaster::DNSError.new(message)
-          elsif message.include?('Unknown key: ')
-            Isomorfeus::Puppetmaster::KeyError.new(message)
-          elsif message.include?('Execution context was destroyed, most likely because of a navigation.')
-            Isomorfeus::Puppetmaster::ExecutionContextError.new(message)
-          elsif message.include?('Evaluation failed: DOMException:') || (message.include?('Evaluation failed:') && (message.include?('is not a valid selector') || message.include?('is not a legal expression')))
-            Isomorfeus::Puppetmaster::DOMException.new(message)
-          else
-            Isomorfeus::Puppetmaster::JavaScriptError.new(message)
-          end
+        def determine_error(error)
+          message = "#{error['name']}: #{error['message']}"
+          exception = if message.include?('net::ERR_CERT_') || message.include?('SEC_ERROR_EXPIRED_CERTIFICATE')
+                        Isomorfeus::Puppetmaster::CertificateError.new(message)
+                      elsif message.include?('net::ERR_NAME_') || message.include?('NS_ERROR_UNKNOWN_HOST')
+                        Isomorfeus::Puppetmaster::DNSError.new(message)
+                      elsif message.include?('Unknown key: ')
+                        Isomorfeus::Puppetmaster::KeyError.new(message)
+                      elsif message.include?('Execution context was destroyed, most likely because of a navigation.')
+                        Isomorfeus::Puppetmaster::ExecutionContextError.new(message)
+                      elsif message.include?('Evaluation failed: DOMException:') || (message.include?('Evaluation failed:') && (message.include?('is not a valid selector') || message.include?('is not a legal expression')))
+                        Isomorfeus::Puppetmaster::DOMException.new(message)
+                      else
+                        Isomorfeus::Puppetmaster::JavaScriptError.new(message)
+                      end
+          exception.set_backtrace(error['stack'])
+          exception
         end
 
         def execution_finished?
@@ -247,8 +249,8 @@ module Isomorfeus
         end
 
         def get_result
-          res, err_msg = @context.eval 'GetLastResult()'
-          raise determine_error(err_msg) if err_msg
+          res, error = @context.eval 'GetLastResult()'
+          raise determine_error(error) if error && !error.empty?
           res
         end
 
@@ -276,8 +278,8 @@ module Isomorfeus
         def puppeteer_launch
           # todo target_handle, puppeteer save path
           puppeteer_require = case @browser_type
-                              when :chrome then chromium_require
-                              when :chromium then chromium_require
+                              when :chrome then default_require
+                              when :chromium then default_require
                               else
                                 raise "Browser type #{@browser_type} not supported!"
                               end
@@ -307,11 +309,12 @@ module Isomorfeus
                 LastRes = null;
                 LastExecutionFinished = false;
     
-                if (err) { return [null, err.toString() + "\\n" + err.stack]; }
+                if (err) { return [null, {name: err.name, message: err.message, stack: err.stack}]; }
                 else { return [res, null]; }
     
               } else {
-                return [null, (new Error('Last command did not yet finish execution!')).message];
+                var new_err = new Error('Last command did not yet finish execution!');
+                return [null, {name: new_err.name, message: new_err.message, stack: new_err.stack}];
               }
             };
     
@@ -374,7 +377,10 @@ module Isomorfeus
                 LastErr = err;
                 LastExecutionFinished = true;
               }
-            })();
+            })().catch(function(err) {
+                LastErr = err;
+                LastExecutionFinished = true;
+            });
           JAVASCRIPT
         end
 

data/lib/isomorfeus/puppetmaster/driver/puppeteer_document.rb

@@ -310,17 +310,39 @@ module Isomorfeus
 
         def document_evaluate_script(document, script, *args)
           await <<~JAVASCRIPT
-            LastResult = await AllPageHandles[#{document.handle}].evaluate((arguments) => {
-              return #{script.strip} 
+            var result = await AllPageHandles[#{document.handle}].evaluate((arguments) => {
+              try {
+                var res = (function(arguments) {
+                  return #{script.strip};
+                })(arguments);
+                return [res, null];
+              } catch (err) {
+                return [null, {name: err.name, message: err.message, stack: err.stack}]; 
+              }
             }, #{args});
+            if (result) {
+              LastResult = result[0];
+              LastErr = result[1];
+            }
           JAVASCRIPT
         end
 
         def document_execute_script(document, script, *args)
           await <<~JAVASCRIPT
-            LastResult = await AllPageHandles[#{document.handle}].evaluate((arguments) => {
-              #{script.strip} 
+            var result = await AllPageHandles[#{document.handle}].evaluate((arguments) => {
+              try {
+                var res = (function(arguments) {
+                  #{script.strip};
+                })(arguments);
+                return [res, null];
+              } catch (err) {
+                return [null, {name: err.name, message: err.message, stack: err.stack}]; 
+              } 
             }, #{args});
+            if (result) {
+              LastResult = result[0];
+              LastErr = result[1];
+            }
           JAVASCRIPT
         end
 
@@ -454,7 +476,7 @@ module Isomorfeus
             }
           JAVASCRIPT
           con_messages = messages.map {|m| Isomorfeus::Puppetmaster::ConsoleMessage.new(m)}
-          con_messages.each { |m| raise determine_error(m.text) if m.level == 'error' && !m.text.start_with?('Failed to load resource:') }
+          con_messages.each { |m| raise determine_error({ 'message' => m.text }) if m.level == 'error' && !m.text.start_with?('Failed to load resource:') }
           if response_hash
             response = Isomorfeus::Puppetmaster::Response.new(response_hash)
             document.instance_variable_set(:@response, response)
@@ -491,7 +513,7 @@ module Isomorfeus
             }
           JAVASCRIPT
           con_messages = messages.map {|m| Isomorfeus::Puppetmaster::ConsoleMessage.new(m)}
-          con_messages.each { |m| raise determine_error(m.text) if m.level == 'error' && !m.text.start_with?('Failed to load resource:') }
+          con_messages.each { |m| raise determine_error({ 'message' => m.text }) if m.level == 'error' && !m.text.start_with?('Failed to load resource:') }
           if response_hash
             response = Isomorfeus::Puppetmaster::Response.new(response_hash)
             document.instance_variable_set(:@response, response)
@@ -532,7 +554,7 @@ module Isomorfeus
             }
           JAVASCRIPT
           con_messages = messages.map {|m| Isomorfeus::Puppetmaster::ConsoleMessage.new(m)}
-          con_messages.each { |m| raise determine_error(m.text) if m.level == 'error' && !m.text.start_with?('Failed to load resource:') }
+          con_messages.each { |m| raise determine_error({ 'message' => m.text }) if m.level == 'error' && !m.text.start_with?('Failed to load resource:') }
           if response_hash
             response = Isomorfeus::Puppetmaster::Response.new(response_hash)
             document.instance_variable_set(:@response, response)
@@ -610,7 +632,7 @@ module Isomorfeus
             LastResult = [page_handle, result_response, ConsoleMessages[page_handle]];
           JAVASCRIPT
           con_messages = messages.map {|m| Isomorfeus::Puppetmaster::ConsoleMessage.new(m)}
-          con_messages.each { |m| raise determine_error(m.text) if m.level == 'error' && !m.text.start_with?('Failed to load resource:') }
+          con_messages.each { |m| raise determine_error({ 'message' => m.text }) if m.level == 'error' && !m.text.start_with?('Failed to load resource:') }
           Isomorfeus::Puppetmaster::Document.new(self, handle, Isomorfeus::Puppetmaster::Response.new(response_hash))
         end
 

data/lib/isomorfeus/puppetmaster/driver_registration.rb

@@ -1,19 +1,9 @@
+require 'tty-which'
+
 Isomorfeus::Puppetmaster.register_driver(:chromium) do |app|
   Isomorfeus::Puppetmaster::Driver::Puppeteer.new(browser_type: :chromium, headless: true, app: app)
 end
 
-Isomorfeus::Puppetmaster.register_driver(:chromium_wsl) do |app|
-  Isomorfeus::Puppetmaster::Driver::Puppeteer.new(browser_type: :chromium, headless: true, app: app, args: ['--no-sandbox'])
-end
-
 Isomorfeus::Puppetmaster.register_driver(:chromium_debug) do |app|
   Isomorfeus::Puppetmaster::Driver::Puppeteer.new(browser_type: :chromium, headless: false, devtools: true, app: app)
 end
-
-Isomorfeus::Puppetmaster.register_driver(:jsdom) do |app|
-  Isomorfeus::Puppetmaster::Driver::Jsdom.new(app: app)
-end
-
-Isomorfeus::Puppetmaster.register_driver(:jsdom_canvas) do |app|
-  Isomorfeus::Puppetmaster::Driver::Jsdom.new(app: app, canvas: true)
-end

data/lib/isomorfeus/puppetmaster/self_forwardable.rb

@@ -10,6 +10,14 @@ module Isomorfeus
             end
           end
 
+          base.define_singleton_method(:document_forward_kwargs) do |methods|
+            methods.each do |method|
+              define_method(method) do |*args, **kwargs, &block|
+                @driver.send("document_#{method}", self, *args, **kwargs, &block)
+              end
+            end
+          end
+
           base.define_singleton_method(:frame_forward) do |methods|
             methods.each do |method|
               define_method(method) do |*args|

data/lib/isomorfeus/puppetmaster/server.rb

@@ -66,18 +66,22 @@ module Isomorfeus
         ruby_source = Isomorfeus::Puppetmaster.block_source_code(&block) if block_given?
         request_hash = { 'key' => @request_key, 'code' => ruby_source }
         response = if using_ssl?
-          http = Net::HTTP.start(@host, @port, { use_ssl: true, verify_mode: OpenSSL::SSL::VERIFY_NONE })
-          http.post('/__executor__', Oj.dump(request_hash, {}))
-        else
-          http = Net::HTTP.start(@host, @port)
-          http.post('/__executor__', Oj.dump(request_hash, {}))
-        end
+                     http = Net::HTTP.start(@host, @port, { use_ssl: true, verify_mode: OpenSSL::SSL::VERIFY_NONE })
+                     http.post('/__executor__', Oj.dump(request_hash, mode: :strict))
+                   else
+                     http = Net::HTTP.start(@host, @port)
+                     http.post('/__executor__', Oj.dump(request_hash, mode: :strict))
+                   end
         if response.code == '200'
-          result_hash = Oj.load(response.body, {})
-          raise result_hash['error'] if result_hash.has_key?('error')
+          result_hash = Oj.load(response.body)
+          if result_hash.has_key?('error')
+            error = RuntimeError.new(result_hash['error'])
+            error.set_backtrace(result_hash['backtrace'])
+            raise error
+          end
           result_hash['result']
         else
-          raise 'A error occured.'
+          raise 'A error occurred.'
         end
       end