playwright/packages/playwright-core/src/client/clientHelper.ts

/**
 * Copyright 2017 Google Inc. All rights reserved.
 * Modifications 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.
 */

import type * as types from './types';
import fs from 'fs';
import { isString } from '../utils';

export function envObjectToArray(env: types.Env): { name: string, value: string }[] {
  const result: { name: string, value: string }[] = [];
  for (const name in env) {
    if (!Object.is(env[name], undefined))
      result.push({ name, value: String(env[name]) });
  }
  return result;
}

export async function evaluationScript(fun: Function | string | { path?: string, content?: string }, arg: any, hasArg: boolean, addSourceUrl: boolean = true): Promise<string> {
  if (typeof fun === 'function') {
    const source = fun.toString();
    const argString = Object.is(arg, undefined) ? 'undefined' : JSON.stringify(arg);
    return `(${source})(${argString})`;
  }
  if (isString(fun)) {
    if (arg !== undefined)
      throw new Error('Cannot evaluate a string with arguments');
    return fun;
  }
  if (fun.content !== undefined) {
    if (arg !== undefined)
      throw new Error('Cannot evaluate a string with arguments');
    return fun.content;
  }
  if (fun.path !== undefined) {
    let source = await fs.promises.readFile(fun.path, 'utf8');
    if (hasArg) {
      // Assume a CJS module that has a function default export.
      source = `(() => {
        var exports = {}; var module = { exports };
        ${source}
        let __pw_result__ = module.exports;
        if (__pw_result__ && typeof __pw_result__ === 'object' && ('default' in __pw_result__))
          __pw_result__ = __pw_result__['default'];
        if (typeof __pw_result__ !== 'function')
          return __pw_result__;
        return __pw_result__(${JSON.stringify(arg)});
      })()`;
    }
    if (addSourceUrl)
      source = addSourceUrlToScript(source, fun.path);
    return source;
  }
  throw new Error('Either path or content property must be present');
}

export function addSourceUrlToScript(source: string, path: string): string {
  return `${source}\n//# sourceURL=${path.replace(/\n/g, '')}`;
}