Skip to content

Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.

12.2 KB
Raw Blame
/**
 * Copyright (c) Microsoft Corporation.
 *
 * 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.
 */

type TypedArrayKind = 'i8' | 'ui8' | 'ui8c' | 'i16' | 'ui16' | 'i32' | 'ui32' | 'f32' | 'f64' | 'bi64' | 'bui64';

// Name prefix of the page bindings backing the functions passed to evaluate()
// as arguments. Only functions carrying this prefix serialize as { fn },
// arbitrary functions are dropped as before.
export const kFunctionBindingPrefix = '__pw_fn_';

export const kBindingsControllerProperty = '__playwright__binding__controller__';

export type SerializedValue =
    undefined | boolean | number | string |
    { v: 'null' | 'undefined' | 'NaN' | 'Infinity' | '-Infinity' | '-0' } |
    { d: string } |
    { u: string } |
    { bi: string } |
    { e: { n: string, m: string, s: string } } |
    { r: { p: string, f: string } } |
    { a: SerializedValue[], id: number } |
    { o: { k: string, v: SerializedValue }[], id: number } |
    { m: { k: SerializedValue, v: SerializedValue }[], id: number } |
    { s: SerializedValue[], id: number } |
    { ref: number } |
    { h: number } |
    { fn: string } |
    { ta: { b: string, k: TypedArrayKind } } |
    { ab: { b: string } };

type HandleOrValue = { h: number } | { fn: string } | { fallThrough: any };

type VisitorInfo = {
  visited: Map<object, number>;
  lastId: number;
  extendedSerialization?: boolean;
};

function isRegExp(obj: any): obj is RegExp {
  try {
    return obj instanceof RegExp || Object.prototype.toString.call(obj) === '[object RegExp]';
  } catch (error) {
    return false;
  }
}

function isDate(obj: any): obj is Date {
  try {
    // eslint-disable-next-line no-restricted-globals
    return obj instanceof Date || Object.prototype.toString.call(obj) === '[object Date]';
  } catch (error) {
    return false;
  }
}

function isURL(obj: any): obj is URL {
  try {
    return obj instanceof URL || Object.prototype.toString.call(obj) === '[object URL]';
  } catch (error) {
    return false;
  }
}

function isError(obj: any): obj is Error {
  try {
    return obj instanceof Error || (obj && Object.getPrototypeOf(obj)?.name === 'Error');
  } catch (error) {
    return false;
  }
}

function isTypedArray(obj: any, constructor: Function): boolean {
  try {
    return obj instanceof constructor || Object.prototype.toString.call(obj) === `[object ${constructor.name}]`;
  } catch (error) {
    return false;
  }
}

function isArrayBuffer(obj: any): obj is ArrayBuffer {
  try {
    return obj instanceof ArrayBuffer || Object.prototype.toString.call(obj) === '[object ArrayBuffer]';
  } catch (error) {
    return false;
  }
}

function isMap(obj: any): obj is Map<unknown, unknown> {
  try {
    return obj instanceof Map || Object.prototype.toString.call(obj) === '[object Map]';
  } catch (error) {
    return false;
  }
}

function isSet(obj: any): obj is Set<unknown> {
  try {
    return obj instanceof Set || Object.prototype.toString.call(obj) === '[object Set]';
  } catch (error) {
    return false;
  }
}

const typedArrayConstructors: Record<TypedArrayKind, Function> = {
  i8: Int8Array,
  ui8: Uint8Array,
  ui8c: Uint8ClampedArray,
  i16: Int16Array,
  ui16: Uint16Array,
  i32: Int32Array,
  ui32: Uint32Array,
  // TODO: add Float16Array once it's in baseline
  f32: Float32Array,
  f64: Float64Array,
  bi64: BigInt64Array,
  bui64: BigUint64Array,
};

export function typedArrayToBase64(array: any) {
  /**
   * Firefox does not support iterating over typed arrays, so we use `.toBase64`.
   * Error: 'Accessing TypedArray data over Xrays is slow, and forbidden in order to encourage performant code. To copy TypedArrays across origin boundaries, consider using Components.utils.cloneInto().'
   */
  if ('toBase64' in array)
    return array.toBase64();
  const binary = Array.from(new Uint8Array(array.buffer, array.byteOffset, array.byteLength)).map(b => String.fromCharCode(b)).join('');
  return btoa(binary);
}

function base64ToTypedArray(base64: string, TypedArrayConstructor: any) {
  const binary = atob(base64);
  const bytes = new Uint8Array(binary.length);
  for (let i = 0; i < binary.length; i++)
    bytes[i] = binary.charCodeAt(i);
  return new TypedArrayConstructor(bytes.buffer);
}

export function parseEvaluationResultValue(value: SerializedValue, handles: any[] = [], refs: Map<number, object> = new Map()): any {
  if (Object.is(value, undefined))
    return undefined;
  if (typeof value === 'object' && value) {
    if ('ref' in value)
      return refs.get(value.ref);
    if ('v' in value) {
      if (value.v === 'undefined')
        return undefined;
      if (value.v === 'null')
        return null;
      if (value.v === 'NaN')
        return NaN;
      if (value.v === 'Infinity')
        return Infinity;
      if (value.v === '-Infinity')
        return -Infinity;
      if (value.v === '-0')
        return -0;
      return undefined;
    }
    if ('d' in value) {
      // eslint-disable-next-line no-restricted-globals
      return new Date(value.d);
    }
    if ('u' in value)
      return new URL(value.u);
    if ('bi' in value)
      return BigInt(value.bi);
    if ('e' in value) {
      const error = new Error(value.e.m);
      error.name = value.e.n;
      error.stack = value.e.s;
      return error;
    }
    if ('r' in value)
      return new RegExp(value.r.p, value.r.f);
    if ('a' in value) {
      const result: any[] = [];
      refs.set(value.id, result);
      for (const a of value.a)
        result.push(parseEvaluationResultValue(a, handles, refs));
      return result;
    }
    if ('o' in value) {
      const result: any = {};
      refs.set(value.id, result);
      for (const { k, v } of value.o) {
        if (k === '__proto__')
          continue;
        result[k] = parseEvaluationResultValue(v, handles, refs);
      }
      return result;
    }
    if ('m' in value) {
      const result = new Map();
      refs.set(value.id, result);
      for (const { k, v } of value.m)
        result.set(parseEvaluationResultValue(k, handles, refs), parseEvaluationResultValue(v, handles, refs));
      return result;
    }
    if ('s' in value) {
      const result = new Set();
      refs.set(value.id, result);
      for (const item of value.s)
        result.add(parseEvaluationResultValue(item, handles, refs));
      return result;
    }
    if ('h' in value)
      return handles[value.h];
    if ('fn' in value) {
      const name = value.fn;
      // eslint-disable-next-line no-restricted-globals
      return (...args: any[]) => (globalThis as any)[kBindingsControllerProperty].callBinding(name, ...args);
    }
    if ('ta' in value)
      return base64ToTypedArray(value.ta.b, typedArrayConstructors[value.ta.k]);
    if ('ab' in value)
      return base64ToTypedArray(value.ab.b, Uint8Array).buffer;
  }
  return value;
}

export function serializeAsCallArgument(value: any, handleSerializer: (value: any) => HandleOrValue, options: { extendedSerialization?: boolean } = {}): SerializedValue {
  return serialize(value, handleSerializer, { visited: new Map(), lastId: 0, extendedSerialization: options.extendedSerialization });
}

function serialize(value: any, handleSerializer: (value: any) => HandleOrValue, visitorInfo: VisitorInfo): SerializedValue {
  if (value && typeof value === 'object') {
    // eslint-disable-next-line no-restricted-globals
    if (typeof globalThis.Window === 'function' && value instanceof globalThis.Window)
      return 'ref: <Window>';
    // eslint-disable-next-line no-restricted-globals
    if (typeof globalThis.Document === 'function' && value instanceof globalThis.Document)
      return 'ref: <Document>';
    // eslint-disable-next-line no-restricted-globals
    if (typeof globalThis.Node === 'function' && value instanceof globalThis.Node)
      return 'ref: <Node>';
  }
  return innerSerialize(value, handleSerializer, visitorInfo);
}

function innerSerialize(value: any, handleSerializer: (value: any) => HandleOrValue, visitorInfo: VisitorInfo): SerializedValue {
  const result = handleSerializer(value);
  if ('fallThrough' in result)
    value = result.fallThrough;
  else
    return result;

  if (typeof value === 'symbol')
    return { v: 'undefined' };
  if (Object.is(value, undefined))
    return { v: 'undefined' };
  if (Object.is(value, null))
    return { v: 'null' };
  if (Object.is(value, NaN))
    return { v: 'NaN' };
  if (Object.is(value, Infinity))
    return { v: 'Infinity' };
  if (Object.is(value, -Infinity))
    return { v: '-Infinity' };
  if (Object.is(value, -0))
    return { v: '-0' };

  if (typeof value === 'boolean')
    return value;
  if (typeof value === 'number')
    return value;
  if (typeof value === 'string')
    return value;
  if (typeof value === 'bigint')
    return { bi: value.toString() };

  if (isError(value)) {
    let stack;
    if (value.stack?.startsWith(value.name + ': ' + value.message)) {
      // v8
      stack = value.stack;
    } else {
      stack = `${value.name}: ${value.message}\n${value.stack}`;
    }
    return { e: { n: value.name, m: value.message, s: stack } };
  }
  if (isDate(value))
    return { d: value.toJSON() };
  if (isURL(value))
    return { u: value.toJSON() };
  if (isRegExp(value))
    return { r: { p: value.source, f: value.flags } };
  for (const [k, ctor] of Object.entries(typedArrayConstructors) as [TypedArrayKind, Function][]) {
    if (isTypedArray(value, ctor))
      return { ta: { b: typedArrayToBase64(value), k } };
  }
  if (isArrayBuffer(value))
    return { ab: { b: typedArrayToBase64(new Uint8Array(value)) } };

  const id = visitorInfo.visited.get(value);
  if (id)
    return { ref: id };

  if (visitorInfo.extendedSerialization) {
    if (isMap(value)) {
      const m: { k: SerializedValue, v: SerializedValue }[] = [];
      const id = ++visitorInfo.lastId;
      visitorInfo.visited.set(value, id);
      const iterator = value.entries();
      const next = new Map().entries().next;
      while (true) {
        const entry = next.call(iterator);
        if (entry.done)
          break;
        m.push({ k: serialize(entry.value[0], handleSerializer, visitorInfo), v: serialize(entry.value[1], handleSerializer, visitorInfo) });
      }
      return { m, id };
    }
    if (isSet(value)) {
      const s: SerializedValue[] = [];
      const id = ++visitorInfo.lastId;
      visitorInfo.visited.set(value, id);
      const iterator = value.values();
      const next = new Set().values().next;
      while (true) {
        const entry = next.call(iterator);
        if (entry.done)
          break;
        s.push(serialize(entry.value, handleSerializer, visitorInfo));
      }
      return { s, id };
    }
  }

  if (Array.isArray(value)) {
    const a = [];
    const id = ++visitorInfo.lastId;
    visitorInfo.visited.set(value, id);
    for (let i = 0; i < value.length; ++i)
      a.push(serialize(value[i], handleSerializer, visitorInfo));
    return { a, id };
  }

  if (typeof value === 'object') {
    const o: { k: string, v: SerializedValue }[] = [];
    const id = ++visitorInfo.lastId;
    visitorInfo.visited.set(value, id);
    for (const name of Object.keys(value)) {
      let item;
      try {
        item = value[name];
      } catch (e) {
        continue;  // native bindings will throw sometimes
      }
      if (name === 'toJSON' && typeof item === 'function')
        o.push({ k: name, v: { o: [], id: 0 } });
      else
        o.push({ k: name, v: serialize(item, handleSerializer, visitorInfo) });
    }

    let jsonWrapper;
    try {
      // If Object.keys().length === 0 we fall back to toJSON if it exists
      if (o.length === 0 && value.toJSON && typeof value.toJSON === 'function')
        jsonWrapper = { value: value.toJSON() };
    } catch (e) {
    }
    if (jsonWrapper)
      return innerSerialize(jsonWrapper.value, handleSerializer, visitorInfo);

    return { o, id };
  }

  if (typeof value === 'function' && value.name.startsWith(kFunctionBindingPrefix))
    return { fn: value.name };
}