[rb] Maintain methods to classes map for DevTools

p0deje · p0deje · commit e73a62bb08d7 · 2023-04-19T16:45:40.000-07:00
Fixes #11912
diff --git a/rb/BUILD.bazel b/rb/BUILD.bazel
@@ -198,6 +198,7 @@ rb_binary(
     args = [
         "-rselenium-webdriver",
         "-rselenium/devtools",
+        "-Irb/lib",
     ],
     main = "@bundle//:bin/pry",
     deps = [
diff --git a/rb/Gemfile.lock b/rb/Gemfile.lock
@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    selenium-devtools (0.111.0)
+    selenium-devtools (0.112.0)
       selenium-webdriver (~> 4.2)
     selenium-webdriver (4.8.6)
       rexml (~> 3.2, >= 3.2.5)
diff --git a/rb/lib/selenium/devtools/support/cdp/loader.rb.erb b/rb/lib/selenium/devtools/support/cdp/loader.rb.erb
@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# This file is automatically generated. Any changes will be lost!
+
+Dir.glob("#{File.dirname(File.absolute_path(__FILE__))}/<%= version.downcase %>/*", &method(:require))
+
+module Selenium
+  module DevTools
+    module <%= version %>
+      METHODS_TO_CLASSES = {
+      <% domains.each do |domain| %>
+        <%= h.snake_case(domain[:domain]) %>: '<%= domain[:domain] %>',
+      <% end %>
+      }.freeze
+    end # <%= version %>
+  end # DevTools
+end # Selenium
diff --git a/rb/lib/selenium/devtools/support/cdp_client_generator.rb b/rb/lib/selenium/devtools/support/cdp_client_generator.rb
@@ -26,12 +26,14 @@ module DevTools
     module Support
       class CDPClientGenerator
         # Input JSON files are generated from PDL tasks.
-        TEMPLATE_PATH = File.expand_path('cdp/domain.rb.erb', __dir__)
+        DOMAIN_TEMPLATE_PATH = File.expand_path('cdp/domain.rb.erb', __dir__)
+        LOADER_TEMPLATE_PATH = File.expand_path('cdp/loader.rb.erb', __dir__)
 
         RESERVED_KEYWORDS = %w[end].freeze
 
         def call(output_dir:, version:, **opts)
-          @template = ERB.new(File.read(TEMPLATE_PATH))
+          @domain_template = ERB.new(File.read(DOMAIN_TEMPLATE_PATH))
+          @loader_template = ERB.new(File.read(LOADER_TEMPLATE_PATH))
           @output_dir = output_dir
           @loader_path = opts.delete(:loader_path) || "#{@output_dir}.rb"
           @version = version
@@ -48,13 +50,13 @@ def call(output_dir:, version:, **opts)
 
           FileUtils.mkdir_p(@output_dir)
 
-          browser_protocol[:domains].each { |domain| process_domain(domain) }
-          js_protocol[:domains].each { |domain| process_domain(domain) }
-          require_file
+          all_domains = browser_protocol[:domains] + js_protocol[:domains]
+          all_domains.each { |domain| process_domain(domain) }
+          process_loader(all_domains)
         end
 
         def process_domain(domain)
-          result = @template.result_with_hash(domain: domain, version: @version.upcase, h: self)
+          result = @domain_template.result_with_hash(domain: domain, version: @version.upcase, h: self)
           filename = File.join(@output_dir, "#{snake_case(domain[:domain])}.rb")
           File.write(filename, remove_empty_lines(result))
         end
@@ -86,13 +88,9 @@ def remove_empty_lines(string)
           string.split("\n").grep_v(/^\s+$/).join("\n")
         end
 
-        def require_file
-          # rubocop:disable Lint/InterpolationCheck
-          dynamic_location = '#{File.dirname(File.absolute_path(__FILE__))}'
-          # rubocop:enable Lint/InterpolationCheck
-
-          require_all = "Dir.glob(\"#{dynamic_location}/#{@version}/*\", &method(:require))"
-          File.write(@loader_path, require_all)
+        def process_loader(domains)
+          result = @loader_template.result_with_hash(domains: domains, version: @version.upcase, h: self)
+          File.write(@loader_path, remove_empty_lines(result))
         end
       end
     end
diff --git a/rb/lib/selenium/webdriver/devtools.rb b/rb/lib/selenium/webdriver/devtools.rb
@@ -52,7 +52,17 @@ def send_cmd(method, **params)
       end
 
       def method_missing(method, *_args)
-        desired_class = "Selenium::DevTools::V#{Selenium::DevTools.version}::#{method.capitalize}"
+        namespace = "Selenium::DevTools::V#{Selenium::DevTools.version}"
+        methods_to_classes = "#{namespace}::METHODS_TO_CLASSES"
+
+        desired_class = if Object.const_defined?(methods_to_classes)
+                          # selenium-devtools 0.113 and newer
+                          "#{namespace}::#{Object.const_get(methods_to_classes)[method]}"
+                        else
+                          # selenium-devtools 0.112 and older
+                          "#{namespace}::#{method.capitalize}}"
+                        end
+
         return unless Object.const_defined?(desired_class)
 
         self.class.class_eval do
diff --git a/rb/spec/integration/selenium/webdriver/devtools_spec.rb b/rb/spec/integration/selenium/webdriver/devtools_spec.rb
@@ -29,6 +29,12 @@ module WebDriver
         expect(driver.title).to eq('XHTML Test Page')
       end
 
+      it 'maps methods to classes' do
+        expect(driver.devtools.css).not_to be_nil
+        expect(driver.devtools.dom).not_to be_nil
+        expect(driver.devtools.dom_debugger).not_to be_nil
+      end
+
       context 'when the devtools version is too high' do
         let(:existing_devtools_version) { driver.send(:devtools_version) }
         let(:imaginary_devtools_version) { existing_devtools_version + 1 }
