Adding upstream version 86.0.1.upstream/86.0.1upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 389 insertions, 0 deletions

diff --git a/remote/test/puppeteer/src/common/helper.ts b/remote/test/puppeteer/src/common/helper.ts
new file mode 100644
index 0000000000..d8ca9b4ef4
--- /dev/null
+++ b/remote/test/puppeteer/src/common/helper.ts
@@ -0,0 +1,389 @@
+/**
+ * Copyright 2017 Google Inc. All rights reserved.
+ *
+ * Licensed 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.
+ */
+import { TimeoutError } from './Errors.js';
+import { debug } from './Debug.js';
+import { CDPSession } from './Connection.js';
+import { Protocol } from 'devtools-protocol';
+import { CommonEventEmitter } from './EventEmitter.js';
+import { assert } from './assert.js';
+import { isNode } from '../environment.js';
+
+export const debugError = debug('puppeteer:error');
+
+function getExceptionMessage(
+  exceptionDetails: Protocol.Runtime.ExceptionDetails
+): string {
+  if (exceptionDetails.exception)
+    return (
+      exceptionDetails.exception.description || exceptionDetails.exception.value
+    );
+  let message = exceptionDetails.text;
+  if (exceptionDetails.stackTrace) {
+    for (const callframe of exceptionDetails.stackTrace.callFrames) {
+      const location =
+        callframe.url +
+        ':' +
+        callframe.lineNumber +
+        ':' +
+        callframe.columnNumber;
+      const functionName = callframe.functionName || '<anonymous>';
+      message += `\n    at ${functionName} (${location})`;
+    }
+  }
+  return message;
+}
+
+function valueFromRemoteObject(
+  remoteObject: Protocol.Runtime.RemoteObject
+): any {
+  assert(!remoteObject.objectId, 'Cannot extract value when objectId is given');
+  if (remoteObject.unserializableValue) {
+    if (remoteObject.type === 'bigint' && typeof BigInt !== 'undefined')
+      return BigInt(remoteObject.unserializableValue.replace('n', ''));
+    switch (remoteObject.unserializableValue) {
+      case '-0':
+        return -0;
+      case 'NaN':
+        return NaN;
+      case 'Infinity':
+        return Infinity;
+      case '-Infinity':
+        return -Infinity;
+      default:
+        throw new Error(
+          'Unsupported unserializable value: ' +
+            remoteObject.unserializableValue
+        );
+    }
+  }
+  return remoteObject.value;
+}
+
+async function releaseObject(
+  client: CDPSession,
+  remoteObject: Protocol.Runtime.RemoteObject
+): Promise<void> {
+  if (!remoteObject.objectId) return;
+  await client
+    .send('Runtime.releaseObject', { objectId: remoteObject.objectId })
+    .catch((error) => {
+      // Exceptions might happen in case of a page been navigated or closed.
+      // Swallow these since they are harmless and we don't leak anything in this case.
+      debugError(error);
+    });
+}
+
+export interface PuppeteerEventListener {
+  emitter: CommonEventEmitter;
+  eventName: string | symbol;
+  handler: (...args: any[]) => void;
+}
+
+function addEventListener(
+  emitter: CommonEventEmitter,
+  eventName: string | symbol,
+  handler: (...args: any[]) => void
+): PuppeteerEventListener {
+  emitter.on(eventName, handler);
+  return { emitter, eventName, handler };
+}
+
+function removeEventListeners(
+  listeners: Array<{
+    emitter: CommonEventEmitter;
+    eventName: string | symbol;
+    handler: (...args: any[]) => void;
+  }>
+): void {
+  for (const listener of listeners)
+    listener.emitter.removeListener(listener.eventName, listener.handler);
+  listeners.length = 0;
+}
+
+function isString(obj: unknown): obj is string {
+  return typeof obj === 'string' || obj instanceof String;
+}
+
+function isNumber(obj: unknown): obj is number {
+  return typeof obj === 'number' || obj instanceof Number;
+}
+
+async function waitForEvent<T extends any>(
+  emitter: CommonEventEmitter,
+  eventName: string | symbol,
+  predicate: (event: T) => boolean,
+  timeout: number,
+  abortPromise: Promise<Error>
+): Promise<T> {
+  let eventTimeout, resolveCallback, rejectCallback;
+  const promise = new Promise<T>((resolve, reject) => {
+    resolveCallback = resolve;
+    rejectCallback = reject;
+  });
+  const listener = addEventListener(emitter, eventName, (event) => {
+    if (!predicate(event)) return;
+    resolveCallback(event);
+  });
+  if (timeout) {
+    eventTimeout = setTimeout(() => {
+      rejectCallback(
+        new TimeoutError('Timeout exceeded while waiting for event')
+      );
+    }, timeout);
+  }
+  function cleanup(): void {
+    removeEventListeners([listener]);
+    clearTimeout(eventTimeout);
+  }
+  const result = await Promise.race([promise, abortPromise]).then(
+    (r) => {
+      cleanup();
+      return r;
+    },
+    (error) => {
+      cleanup();
+      throw error;
+    }
+  );
+  if (result instanceof Error) throw result;
+
+  return result;
+}
+
+function evaluationString(fun: Function | string, ...args: unknown[]): string {
+  if (isString(fun)) {
+    assert(args.length === 0, 'Cannot evaluate a string with arguments');
+    return fun;
+  }
+
+  function serializeArgument(arg: unknown): string {
+    if (Object.is(arg, undefined)) return 'undefined';
+    return JSON.stringify(arg);
+  }
+
+  return `(${fun})(${args.map(serializeArgument).join(',')})`;
+}
+
+function pageBindingInitString(type: string, name: string): string {
+  function addPageBinding(type: string, bindingName: string): void {
+    /* Cast window to any here as we're about to add properties to it
+     * via win[bindingName] which TypeScript doesn't like.
+     */
+    const win = window as any;
+    const binding = win[bindingName];
+
+    win[bindingName] = (...args: unknown[]): Promise<unknown> => {
+      const me = window[bindingName];
+      let callbacks = me.callbacks;
+      if (!callbacks) {
+        callbacks = new Map();
+        me.callbacks = callbacks;
+      }
+      const seq = (me.lastSeq || 0) + 1;
+      me.lastSeq = seq;
+      const promise = new Promise((resolve, reject) =>
+        callbacks.set(seq, { resolve, reject })
+      );
+      binding(JSON.stringify({ type, name: bindingName, seq, args }));
+      return promise;
+    };
+  }
+  return evaluationString(addPageBinding, type, name);
+}
+
+function pageBindingDeliverResultString(
+  name: string,
+  seq: number,
+  result: unknown
+): string {
+  function deliverResult(name: string, seq: number, result: unknown): void {
+    window[name].callbacks.get(seq).resolve(result);
+    window[name].callbacks.delete(seq);
+  }
+  return evaluationString(deliverResult, name, seq, result);
+}
+
+function pageBindingDeliverErrorString(
+  name: string,
+  seq: number,
+  message: string,
+  stack: string
+): string {
+  function deliverError(
+    name: string,
+    seq: number,
+    message: string,
+    stack: string
+  ): void {
+    const error = new Error(message);
+    error.stack = stack;
+    window[name].callbacks.get(seq).reject(error);
+    window[name].callbacks.delete(seq);
+  }
+  return evaluationString(deliverError, name, seq, message, stack);
+}
+
+function pageBindingDeliverErrorValueString(
+  name: string,
+  seq: number,
+  value: unknown
+): string {
+  function deliverErrorValue(name: string, seq: number, value: unknown): void {
+    window[name].callbacks.get(seq).reject(value);
+    window[name].callbacks.delete(seq);
+  }
+  return evaluationString(deliverErrorValue, name, seq, value);
+}
+
+function makePredicateString(
+  predicate: Function,
+  predicateQueryHandler?: Function
+): string {
+  function checkWaitForOptions(
+    node: Node,
+    waitForVisible: boolean,
+    waitForHidden: boolean
+  ): Node | null | boolean {
+    if (!node) return waitForHidden;
+    if (!waitForVisible && !waitForHidden) return node;
+    const element =
+      node.nodeType === Node.TEXT_NODE ? node.parentElement : (node as Element);
+
+    const style = window.getComputedStyle(element);
+    const isVisible =
+      style && style.visibility !== 'hidden' && hasVisibleBoundingBox();
+    const success =
+      waitForVisible === isVisible || waitForHidden === !isVisible;
+    return success ? node : null;
+
+    function hasVisibleBoundingBox(): boolean {
+      const rect = element.getBoundingClientRect();
+      return !!(rect.top || rect.bottom || rect.width || rect.height);
+    }
+  }
+  const predicateQueryHandlerDef = predicateQueryHandler
+    ? `const predicateQueryHandler = ${predicateQueryHandler};`
+    : '';
+  return `
+    (() => {
+      ${predicateQueryHandlerDef}
+      const checkWaitForOptions = ${checkWaitForOptions};
+      return (${predicate})(...args)
+    })() `;
+}
+
+async function waitWithTimeout<T extends any>(
+  promise: Promise<T>,
+  taskName: string,
+  timeout: number
+): Promise<T> {
+  let reject;
+  const timeoutError = new TimeoutError(
+    `waiting for ${taskName} failed: timeout ${timeout}ms exceeded`
+  );
+  const timeoutPromise = new Promise<T>((resolve, x) => (reject = x));
+  let timeoutTimer = null;
+  if (timeout) timeoutTimer = setTimeout(() => reject(timeoutError), timeout);
+  try {
+    return await Promise.race([promise, timeoutPromise]);
+  } finally {
+    if (timeoutTimer) clearTimeout(timeoutTimer);
+  }
+}
+
+async function readProtocolStream(
+  client: CDPSession,
+  handle: string,
+  path?: string
+): Promise<Buffer> {
+  if (!isNode && path) {
+    throw new Error('Cannot write to a path outside of Node.js environment.');
+  }
+
+  const fs = isNode ? await importFSModule() : null;
+
+  let eof = false;
+  let fileHandle: import('fs').promises.FileHandle;
+
+  if (path && fs) {
+    fileHandle = await fs.promises.open(path, 'w');
+  }
+  const bufs = [];
+  while (!eof) {
+    const response = await client.send('IO.read', { handle });
+    eof = response.eof;
+    const buf = Buffer.from(
+      response.data,
+      response.base64Encoded ? 'base64' : undefined
+    );
+    bufs.push(buf);
+    if (path && fs) {
+      await fs.promises.writeFile(fileHandle, buf);
+    }
+  }
+  if (path) await fileHandle.close();
+  await client.send('IO.close', { handle });
+  let resultBuffer = null;
+  try {
+    resultBuffer = Buffer.concat(bufs);
+  } finally {
+    return resultBuffer;
+  }
+}
+
+/**
+ * Loads the Node fs promises API. Needed because on Node 10.17 and below,
+ * fs.promises is experimental, and therefore not marked as enumerable. That
+ * means when TypeScript compiles an `import('fs')`, its helper doesn't spot the
+ * promises declaration and therefore on Node <10.17 you get an error as
+ * fs.promises is undefined in compiled TypeScript land.
+ *
+ * See https://github.com/puppeteer/puppeteer/issues/6548 for more details.
+ *
+ * Once Node 10 is no longer supported (April 2021) we can remove this and use
+ * `(await import('fs')).promises`.
+ */
+async function importFSModule(): Promise<typeof import('fs')> {
+  if (!isNode) {
+    throw new Error('Cannot load the fs module API outside of Node.');
+  }
+
+  const fs = await import('fs');
+  if (fs.promises) {
+    return fs;
+  }
+  return fs.default;
+}
+
+export const helper = {
+  evaluationString,
+  pageBindingInitString,
+  pageBindingDeliverResultString,
+  pageBindingDeliverErrorString,
+  pageBindingDeliverErrorValueString,
+  makePredicateString,
+  readProtocolStream,
+  waitWithTimeout,
+  waitForEvent,
+  isString,
+  isNumber,
+  importFSModule,
+  addEventListener,
+  removeEventListeners,
+  valueFromRemoteObject,
+  getExceptionMessage,
+  releaseObject,
+};