minibidi 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 607b907a85631222aca0cf29e33cdcc76af704464e8a64ee19b9e2da1b6c3b75
+  data.tar.gz: 527e055f3473a2c08f26157d466f2759a210476e97e63d341f90e91b7053315a
+SHA512:
+  metadata.gz: 2a470c291ead662299187dff8f4cf4b3eaffa7308ad3ad15adee38ce39fa5112d93941ceabd120a7e7d47bd2153a36d449c18935364d90f346b5fac5def8ac3f
+  data.tar.gz: 6ca0eff8038b65628ebf1e66040c5ed7d6b4ffbcd997084e018feeb8911974295e13c61d0d79652b74b20e54dd11ca60df332e992ece59c6231fe3265a4c3030

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in minibidi.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 YusukeIwaki
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# minibidi: Mini WebDriver BiDi binding for Ruby
+
+```ruby
+require 'minibidi'
+
+Minibidi::Firefox.launch do |browser|
+  context = browser.create_browsing_context
+  context.navigate("https://github.com/YusukeIwaki")
+  data = context.capture_screenshot(origin: :viewport, format: { type: :png })
+
+  open('YusukeIwaki.png', 'wb') do |f|
+    f.write(data)
+  end
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'minibidi'
+```
+
+And then execute `bundle install`
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end

data/bin/console

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "minibidi"
+require "pry"
+Pry.start

data/lib/minibidi/browser.rb

@@ -0,0 +1,131 @@
+require 'async'
+require 'async/variable'
+
+module Minibidi
+  class Browser
+    def initialize(async_websocket_connection)
+      @websocket = async_websocket_connection
+      @debug_protocol = %w[1 true].include?(ENV['DEBUG'])
+
+      Async do
+        while data = async_websocket_connection.read
+          if message = Protocol::WebSocket::JSONMessage.wrap(data)
+            handle_received_message_from_websocket(message.to_h)
+          end
+        end
+      end
+
+      bidi_call_async('session.new', {
+        capabilities: {
+          alwaysMatch: {
+            acceptInsecureCerts: false,
+            webSocketUrl:true,
+          },
+        },
+      }).wait
+    end
+
+    def create_browsing_context(&block)
+      res = bidi_call_async('browsingContext.create', { type: :tab, userContext: :default }).wait
+      browsing_context = BrowsingContext.new(self, res[:context])
+      if block
+        begin
+          block.call(browsing_context)
+        ensure
+          browsing_context.close
+        end
+      else
+        browsing_context
+      end
+    end
+
+    def close
+      bidi_call_async('browser.close').wait
+    end
+
+    def bidi_call_async(method_, params = {})
+      with_message_id do |message_id|
+        Async do
+          @message_results[message_id] = Async::Variable.new
+
+          send_message_to_websocket({
+            id: message_id,
+            method: method_,
+            params: params,
+          })
+
+          value = @message_results[message_id].value
+          if value.is_a?(ErrorData)
+            raise value.to_error
+          else
+            value
+          end
+        end
+      end
+    end
+
+    private
+
+    def with_message_id(&block)
+      unless @message_id
+        @message_id = 1
+        @message_results = {}
+      end
+
+      message_id = @message_id
+      @message_id += 1
+      block.call(message_id)
+    end
+
+    def send_message_to_websocket(payload)
+      debug_print_send(payload)
+      message = Protocol::WebSocket::JSONMessage.generate(payload)
+      message.send(@websocket)
+      @websocket.flush
+    end
+
+    def handle_received_message_from_websocket(payload)
+      debug_print_recv(payload)
+
+      if payload[:id]
+        if variable = @message_results.delete(payload[:id])
+          case payload[:type]
+          when 'success'
+            variable.resolve(payload[:result])
+          when 'error'
+            variable.resolve(ErrorData.parse(payload))
+          end
+        end
+      end
+    end
+
+    class ErrorData < Data.define(:type, :message, :stacktrace)
+      def self.parse(payload)
+        # {:type=>"error", :id=>1, :error=>"invalid argument", :message=>"method: string value expected", :stacktrace=>"RemoteError@chrome://remote/content/shared/RemoteError.sys.mjs:8:8\nWebDriverError@chrome://remote/content/shared/webdriver/Errors.sys.mjs:193:5\nInvalidArgumentError@chrome://remote/content/shared/webdriver/Errors.sys.mjs:384:5\nassert.that/<@chrome://remote/content/shared/webdriver/Assert.sys.mjs:485:13\nassert.string@chrome://remote/content/shared/webdriver/Assert.sys.mjs:385:53\nonPacket@chrome://remote/content/webdriver-bidi/WebDriverBiDiConnection.sys.mjs:172:19\nonMessage@chrome://remote/content/server/WebSocketTransport.sys.mjs:127:18\nhandleEvent@chrome://remote/content/server/WebSocketTransport.sys.mjs:109:14\n"}
+        new(
+          type: payload[:error],
+          message: payload[:message],
+          stacktrace: payload[:stacktrace].split("\n"),
+        )
+      end
+
+      def to_error
+        Error.new("#{type}: #{message}\n#{stacktrace.join("\n")}")
+      end
+    end
+
+    class Error < StandardError ; end
+
+    def debug_print_send(hash)
+      return unless @debug_protocol
+
+      puts "SEND > #{hash}"
+    end
+
+    def debug_print_recv(hash)
+      return unless @debug_protocol
+
+      puts "RECV < #{hash}"
+    end
+  end
+end

data/lib/minibidi/browser_process.rb

@@ -0,0 +1,24 @@
+module Minibidi
+  class BrowserProcess
+    def initialize(*command)
+      stdin, @stdout, @stderr, @thread = Open3.popen3(*command, { pgroup: true })
+      stdin.close
+      @pid = @thread.pid
+    rescue Errno::ENOENT => err
+      raise LaunchError.new("Failed to launch browser process: #{err}")
+    end
+
+    def kill
+      Process.kill(:KILL, @pid)
+    rescue Errno::ESRCH
+      # already killed
+    end
+
+    def dispose
+      [@stdout, @stderr].each { |io| io.close unless io.closed? }
+      @thread.terminate
+    end
+
+    attr_reader :stdout, :stderr
+  end
+end

data/lib/minibidi/browsing_context.rb

@@ -0,0 +1,29 @@
+require 'base64'
+
+module Minibidi
+  class BrowsingContext
+    def initialize(browser, context_id)
+      @browser = browser
+      @context_id = context_id
+    end
+
+    def navigate(url)
+      bidi_call_async('browsingContext.navigate', { url: url, wait: :interactive }).wait
+    end
+
+    def capture_screenshot(origin:, format:)
+      result = bidi_call_async('browsingContext.captureScreenshot', {
+        origin: origin,
+        format: format,
+      }).wait
+
+      Base64.strict_decode64(result[:data])
+    end
+
+    private
+
+    def bidi_call_async(method_, params = {})
+      @browser.bidi_call_async(method_, params.merge({ context: @context_id }))
+    end
+  end
+end

data/lib/minibidi/firefox.rb

@@ -0,0 +1,7 @@
+module Minibidi
+  class Firefox
+    def self.launch(&block)
+      FirefoxLauncher.new.launch(&block)
+    end
+  end
+end

data/lib/minibidi/firefox_launcher.rb

@@ -0,0 +1,162 @@
+require 'async'
+require 'async/http/endpoint'
+require 'async/websocket'
+require 'open3'
+require 'protocol/websocket/json_message'
+require 'timeout'
+require 'tmpdir'
+
+module Minibidi
+  class FirefoxLauncher
+    def launch(&block)
+      raise ArgumentError, "block is required" unless block
+
+      Dir.mktmpdir('minibidi') do |tmp|
+        create_user_profile(tmp)
+
+        proc = BrowserProcess.new(
+          "/Applications/Firefox Developer Edition.app/Contents/MacOS/firefox",
+          "--remote-debugging-port=0",
+          "--profile #{tmp}",
+          "--no-remote",
+          "--foreground",
+          "about:blank",
+        )
+        at_exit { proc.kill }
+        trap(:INT) { proc.kill ; exit 130 }
+        trap(:TERM) { proc.kill ; proc.dispose }
+        trap(:HUP) { proc.kill ; proc.dispose }
+
+        endpoint = wait_for_ws_endpoint(proc)
+
+        Async::Reactor.run do
+          Async::WebSocket::Client.connect(Async::HTTP::Endpoint.parse("#{endpoint}/session")) do |async_websocket_connection|
+            browser = Browser.new(async_websocket_connection)
+            begin
+              block.call(browser)
+            ensure
+              browser.close
+            end
+          end
+        end
+      end
+    end
+
+    private
+
+    def create_user_profile(profile_dir)
+      open(File.join(profile_dir, 'user.js'), 'w') do |f|
+        f.write(template_for_user_profile)
+      end
+    end
+
+    def template_for_user_profile
+      # execute the code below to create a template of user profile for Firefox.
+      # -----------
+      # import { createProfile } from '@puppeteer/browsers';
+      #
+      # await createProfile('firefox', {
+      #   path: './my_prefs',
+      #   preferences: {
+      #     'remote.active-protocols': 1,
+      #     'fission.webContentIsolationStrategy': 0,
+      #   }
+      # })
+      <<~JS
+      user_pref("app.normandy.api_url", "");
+      user_pref("app.update.checkInstallTime", false);
+      user_pref("app.update.disabledForTesting", true);
+      user_pref("apz.content_response_timeout", 60000);
+      user_pref("browser.contentblocking.features.standard", "-tp,tpPrivate,cookieBehavior0,-cm,-fp");
+      user_pref("browser.dom.window.dump.enabled", true);
+      user_pref("browser.newtabpage.activity-stream.feeds.system.topstories", false);
+      user_pref("browser.newtabpage.enabled", false);
+      user_pref("browser.pagethumbnails.capturing_disabled", true);
+      user_pref("browser.safebrowsing.blockedURIs.enabled", false);
+      user_pref("browser.safebrowsing.downloads.enabled", false);
+      user_pref("browser.safebrowsing.malware.enabled", false);
+      user_pref("browser.safebrowsing.phishing.enabled", false);
+      user_pref("browser.search.update", false);
+      user_pref("browser.sessionstore.resume_from_crash", false);
+      user_pref("browser.shell.checkDefaultBrowser", false);
+      user_pref("browser.startup.homepage", "about:blank");
+      user_pref("browser.startup.homepage_override.mstone", "ignore");
+      user_pref("browser.startup.page", 0);
+      user_pref("browser.tabs.disableBackgroundZombification", false);
+      user_pref("browser.tabs.warnOnCloseOtherTabs", false);
+      user_pref("browser.tabs.warnOnOpen", false);
+      user_pref("browser.translations.automaticallyPopup", false);
+      user_pref("browser.uitour.enabled", false);
+      user_pref("browser.urlbar.suggest.searches", false);
+      user_pref("browser.usedOnWindows10.introURL", "");
+      user_pref("browser.warnOnQuit", false);
+      user_pref("datareporting.healthreport.documentServerURI", "http://dummy.test/dummy/healthreport/");
+      user_pref("datareporting.healthreport.logging.consoleEnabled", false);
+      user_pref("datareporting.healthreport.service.enabled", false);
+      user_pref("datareporting.healthreport.service.firstRun", false);
+      user_pref("datareporting.healthreport.uploadEnabled", false);
+      user_pref("datareporting.policy.dataSubmissionEnabled", false);
+      user_pref("datareporting.policy.dataSubmissionPolicyBypassNotification", true);
+      user_pref("devtools.jsonview.enabled", false);
+      user_pref("dom.disable_open_during_load", false);
+      user_pref("dom.file.createInChild", true);
+      user_pref("dom.ipc.reportProcessHangs", false);
+      user_pref("dom.max_chrome_script_run_time", 0);
+      user_pref("dom.max_script_run_time", 0);
+      user_pref("extensions.autoDisableScopes", 0);
+      user_pref("extensions.enabledScopes", 5);
+      user_pref("extensions.getAddons.cache.enabled", false);
+      user_pref("extensions.installDistroAddons", false);
+      user_pref("extensions.screenshots.disabled", true);
+      user_pref("extensions.update.enabled", false);
+      user_pref("extensions.update.notifyUser", false);
+      user_pref("extensions.webservice.discoverURL", "http://dummy.test/dummy/discoveryURL");
+      user_pref("focusmanager.testmode", true);
+      user_pref("general.useragent.updates.enabled", false);
+      user_pref("geo.provider.testing", true);
+      user_pref("geo.wifi.scan", false);
+      user_pref("hangmonitor.timeout", 0);
+      user_pref("javascript.options.showInConsole", true);
+      user_pref("media.gmp-manager.updateEnabled", false);
+      user_pref("media.sanity-test.disabled", true);
+      user_pref("network.cookie.sameSite.laxByDefault", false);
+      user_pref("network.http.prompt-temp-redirect", false);
+      user_pref("network.http.speculative-parallel-limit", 0);
+      user_pref("network.manage-offline-status", false);
+      user_pref("network.sntp.pools", "dummy.test");
+      user_pref("plugin.state.flash", 0);
+      user_pref("privacy.trackingprotection.enabled", false);
+      user_pref("remote.enabled", true);
+      user_pref("security.certerrors.mitm.priming.enabled", false);
+      user_pref("security.fileuri.strict_origin_policy", false);
+      user_pref("security.notification_enable_delay", 0);
+      user_pref("services.settings.server", "http://dummy.test/dummy/blocklist/");
+      user_pref("signon.autofillForms", false);
+      user_pref("signon.rememberSignons", false);
+      user_pref("startup.homepage_welcome_url", "about:blank");
+      user_pref("startup.homepage_welcome_url.additional", "");
+      user_pref("toolkit.cosmeticAnimations.enabled", false);
+      user_pref("toolkit.startup.max_resumed_crashes", -1);
+      user_pref("remote.active-protocols", 1);
+      user_pref("fission.webContentIsolationStrategy", 0);
+      JS
+    end
+
+    def wait_for_ws_endpoint(browser_process)
+      lines = []
+      Timeout.timeout(30) do
+        loop do
+          line = browser_process.stderr.readline
+          /^WebDriver BiDi listening on (ws:\/\/.*)$/.match(line) do |m|
+            return m[1].gsub(/\r/, '')
+          end
+          lines << line
+        end
+      end
+    rescue EOFError
+      raise LaunchError.new(lines.join("\n"))
+    rescue Timeout::Error
+      raise LaunchError.new("Timed out after 30 seconds while trying to connect to the browser.")
+    end
+  end
+end

data/lib/minibidi/version.rb

@@ -0,0 +1,3 @@
+module Minibidi
+  VERSION = '0.0.0'
+end

data/lib/minibidi.rb

@@ -0,0 +1,11 @@
+require "minibidi/version"
+
+require 'minibidi/browser'
+require 'minibidi/browsing_context'
+require 'minibidi/browser_process'
+require 'minibidi/firefox'
+require 'minibidi/firefox_launcher'
+
+module Minibidi
+  class LaunchError < StandardError ; end
+end

data/minibidi.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "minibidi/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "minibidi"
+  spec.version       = Minibidi::VERSION
+  spec.authors       = ["YusukeIwaki"]
+  spec.email         = ["q7w8e9w8q7w8e9@yahoo.co.jp"]
+
+  spec.summary       = "Mini WebDriver BiDi binding for Ruby"
+  spec.homepage      = 'https://github.com/YusukeIwaki/minibidi'
+  spec.license       = "MIT"
+
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/}) || f.include?(".git")
+    end
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = ">= 3.2" # Dependency for socketry/async and Data.define
+  spec.add_dependency "async"
+  spec.add_dependency "async-websocket"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: minibidi
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- YusukeIwaki
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: async
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: async-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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: minitest
+  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: pry
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- q7w8e9w8q7w8e9@yahoo.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- lib/minibidi.rb
+- lib/minibidi/browser.rb
+- lib/minibidi/browser_process.rb
+- lib/minibidi/browsing_context.rb
+- lib/minibidi/firefox.rb
+- lib/minibidi/firefox_launcher.rb
+- lib/minibidi/version.rb
+- minibidi.gemspec
+homepage: https://github.com/YusukeIwaki/minibidi
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key: 
+specification_version: 4
+summary: Mini WebDriver BiDi binding for Ruby
+test_files: []