Class: Puppeteer::PQueryHandler

Inherits:
Object
  • Object
show all
Defined in:
lib/puppeteer/p_query_handler.rb

Overview

rbs_inline: enabled

Constant Summary collapse

POLLING_DEFAULT_SECONDS = 
0.1
CSS_QUERY_SELECTOR_JS = 
<<~'JAVASCRIPT'
  (element, selector) => {
    const results = [];
    const isQueryableNode = node => {
      return node && typeof node.querySelectorAll === 'function';
    };
    if (!isQueryableNode(element)) {
      return results;
    }
    const trimmed = selector.trimStart();
    if (!trimmed) {
      return results;
    }
    const IDENT_TOKEN_START = /[-\w\P{ASCII}*]/u;
    if (IDENT_TOKEN_START.test(trimmed[0])) {
      results.push(...element.querySelectorAll(selector));
      return results;
    }
    if (!element.parentElement) {
      results.push(...element.querySelectorAll(selector));
      return results;
    }
    let index = 0;
    for (const child of element.parentElement.children) {
      ++index;
      if (child === element) {
        break;
      }
    }
    results.push(
      ...element.parentElement.querySelectorAll(
        `:scope>:nth-child(${index})${selector}`
      )
    );
    return results;
  }
JAVASCRIPT
PIERCE_JS = 
<<~JAVASCRIPT
  node => {
    if (!node) {
      return [];
    }
    if (node.shadowRoot) {
      return [node.shadowRoot];
    }
    return [node];
  }
JAVASCRIPT
PIERCE_ALL_JS = 
<<~JAVASCRIPT
  root => {
    if (!root) {
      return [];
    }
    const results = [];
    const rootNode = root.shadowRoot ? root.shadowRoot : root;
    results.push(rootNode);
    const walkers = [document.createTreeWalker(rootNode, NodeFilter.SHOW_ELEMENT)];
    for (const walker of walkers) {
      let node;
      while ((node = walker.nextNode())) {
        if (!node.shadowRoot) {
          continue;
        }
        results.push(node.shadowRoot);
        walkers.push(document.createTreeWalker(node.shadowRoot, NodeFilter.SHOW_ELEMENT));
      }
    }
    return results;
  }
JAVASCRIPT
DOM_SORT_JS = 
<<~JAVASCRIPT
  (...elements) => {
    const results = new Set(elements);
    class DepthCalculator {
      constructor() {
        this.cache = new WeakMap();
      }
      calculate(node, depth = []) {
        if (node === null) {
          return depth;
        }
        if (node instanceof ShadowRoot) {
          node = node.host;
        }
        const cached = this.cache.get(node);
        if (cached) {
          return [...cached, ...depth];
        }
        let index = 0;
        for (let prev = node.previousSibling; prev; prev = prev.previousSibling) {
          ++index;
        }
        const value = this.calculate(node.parentNode, [index]);
        this.cache.set(node, value);
        return [...value, ...depth];
      }
    }
    const compareDepths = (a, b) => {
      if (a.length + b.length === 0) {
        return 0;
      }
      const [i = -1, ...restA] = a;
      const [j = -1, ...restB] = b;
      if (i === j) {
        return compareDepths(restA, restB);
      }
      return i < j ? -1 : 1;
    };
    const calculator = new DepthCalculator();
    return [...results]
      .map(result => [result, calculator.calculate(result)])
      .sort(([, a], [, b]) => compareDepths(a, b))
      .map(([result]) => result);
  }
JAVASCRIPT

Instance Method Summary collapse

Constructor Details

#initialize(query_handler_manager: Puppeteer::QueryHandlerManager.instance) ⇒ PQueryHandler

Returns a new instance of PQueryHandler.



127
128
129
 
# File 'lib/puppeteer/p_query_handler.rb', line 127

def initialize(query_handler_manager: Puppeteer::QueryHandlerManager.instance)
  @query_handler_manager = query_handler_manager
end

Instance Method Details

#query_all(element, selector) ⇒ Object 



144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/puppeteer/p_query_handler.rb', line 144

def query_all(element, selector)
  selectors, = Puppeteer::PSelectorParser.parse(selector)
  return [] if selectors.empty?

  results = selectors.flat_map do |complex|
    run_complex_selector(element, complex)
  end

  return [] if results.empty?

  dom_sort(results)
end

#query_all_array(element, selector) ⇒ Object 



160
161
162
163
164
165
166
167
 
# File 'lib/puppeteer/p_query_handler.rb', line 160

def query_all_array(element, selector)
  elements = query_all(element, selector)
  return element.execution_context.evaluate_handle('() => []') if elements.empty?

  element.execution_context.evaluate_handle('(...elements) => elements', *elements)
ensure
  elements&.each(&:dispose)
end

#query_one(element, selector) ⇒ Object 



134
135
136
137
138
139
 
# File 'lib/puppeteer/p_query_handler.rb', line 134

def query_one(element, selector)
  matches = query_all(element, selector)
  return nil if matches.empty?

  matches.first
end

#wait_for(element_or_frame, selector, visible:, hidden:, timeout:, polling: nil) ⇒ Object 



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/puppeteer/p_query_handler.rb', line 176

def wait_for(element_or_frame, selector, visible:, hidden:, timeout:, polling: nil)
  case element_or_frame
  when Puppeteer::Frame
    frame = element_or_frame
    root = nil
  when Puppeteer::ElementHandle
    frame = element_or_frame.frame
    root = frame.puppeteer_world.adopt_handle(element_or_frame)
  else
    raise ArgumentError.new("element_or_frame must be a Frame or ElementHandle. #{element_or_frame.inspect}")
  end

  timeout_ms = timeout.nil? ? frame.default_timeout : timeout
  deadline = timeout_ms && timeout_ms > 0 ? monotonic_time + (timeout_ms / 1000.0) : nil
  polling_interval = polling_interval_seconds(polling, visible: visible, hidden: hidden)

  begin
    loop do
      resolved_root = root || frame.puppeteer_world.document
      handle = query_one(resolved_root, selector)

      if handle
        if visible
          return transfer_handle(frame, handle) if handle.visible?
        elsif hidden
          return transfer_handle(frame, handle) if handle.hidden?
        else
          return transfer_handle(frame, handle)
        end
        handle.dispose
      elsif hidden
        return nil
      end

      raise_timeout(selector) if deadline && monotonic_time >= deadline
      Puppeteer::AsyncUtils.sleep_seconds(polling_interval)
    end
  rescue => err
    if err.is_a?(Puppeteer::TimeoutError)
      raise
    end

    wait_for_selector_error =
      if err.is_a?(Puppeteer::TimeoutError)
        Puppeteer::TimeoutError.new("Waiting for selector `#{selector}` failed")
      else
        Puppeteer::Error.new("Waiting for selector `#{selector}` failed")
      end
    wait_for_selector_error.cause = err
    raise wait_for_selector_error
  ensure
    root&.dispose
  end
end