Skip to content

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

6.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.
 */

import type { ActionTraceEvent, SerializedValue } from '@isomorphic/trace/trace';
import { clsx } from '@web/uiUtils';
import { msToString } from '@isomorphic/formatUtils';
import * as React from 'react';
import './callTab.css';
import { CopyToClipboard } from './copyToClipboard';
import { asLocator } from '@isomorphic/locatorGenerators';
import type { Language } from '@isomorphic/locatorGenerators';
import { PlaceholderPanel } from './placeholderPanel';
import type { ActionEntry } from '@isomorphic/trace/entries';
import { renderTitleForCall } from './actionList';

export const CallTab: React.FunctionComponent<{
  action: ActionEntry | undefined,
  startTimeOffset: number,
  sdkLanguage: Language | undefined,
}> = ({ action, startTimeOffset, sdkLanguage }) => {
  // We never need the waitForEventInfo (`info`).
  const paramKeys = React.useMemo(() => Object.keys(action?.params ?? {}).filter(name => name !== 'info'), [action]);

  if (!action)
    return <PlaceholderPanel text='No action selected' />;

  // Calculate execution time relative to the test runner's start time
  const startTimeMillis = action.startTime - startTimeOffset;
  const startTime = msToString(startTimeMillis);

  const { title, subtitle } = renderTitleForCall(action, sdkLanguage);

  return (
    <div className='call-tab'>
      <div className='call-line'>{subtitle ? `${title} ${subtitle}` : title}</div>
      <div className='call-section'>Time</div>
      {renderProperty({ name: 'start', type: 'literal', text: startTime })}
      {renderProperty({ name: 'duration', type: 'literal', text: renderDuration(action) })}
      {
        !!paramKeys.length && <>
          <div className='call-section'>Parameters</div>
          {paramKeys.map(name => renderProperty(propertyToString(action, name, action.params[name], sdkLanguage)))}
        </>
      }
      {
        !!action.result && <>
          <div className='call-section'>Return value</div>
          {Object.keys(action.result).map(name =>
            renderProperty(propertyToString(action, name, action.result[name], sdkLanguage))
          )}
        </>
      }
    </div>
  );
};

type Property = {
  name: string;
  type: 'literal' | 'string' | 'number' | 'object' | 'locator' | 'handle' | 'bigint' | 'boolean' | 'symbol' | 'undefined' | 'function';
  text: string;
};

function renderDuration(action: ActionEntry): string {
  if (action.endTime)
    return msToString(action.endTime - action.startTime);
  else if (!!action.error)
    return 'Timed Out';
  else
    return 'Running';
}

function renderProperty(property: Property) {
  let text = property.text;
  if (text.length > 1000)
    text = text.slice(0, 1000) + '…';
  text = text.replace(/\n/g, '↵');
  if (property.type === 'string')
    text = `"${text}"`;
  return (
    <div key={property.name} className='call-line'>
      {property.name}:<span className={clsx('call-value', property.type)} title={text}>{text}</span>
      { ['literal', 'string', 'number', 'object', 'locator'].includes(property.type) &&
        <CopyToClipboard value={property.text} />
      }
    </div>
  );
}

function propertyToString(event: ActionTraceEvent, name: string, value: any, sdkLanguage: Language | undefined): Property {
  const isEval = event.method.includes('eval') || event.method === 'waitForFunction';
  if (name === 'files')
    return { text: '<files>', type: 'string', name };
  if (name === 'eventInit' || name === 'expectedValue' || (name === 'arg' && isEval))
    value = parseSerializedValue(value.value, new Array(10).fill({ handle: '<handle>' }));
  if (name === 'value' && isEval)
    value = parseSerializedValue(value, new Array(10).fill({ handle: '<handle>' }));
  if (name === 'received' && event.method === 'expect') {
    // Older traces store received as a raw SerializedValue; newer traces wrap it
    // as { value?: SerializedValue, ariaSnapshot?: string }. Support both.
    const wrapped = value && typeof value === 'object' && ('value' in value || 'ariaSnapshot' in value);
    const serialized = wrapped ? value.value : value;
    value = serialized !== undefined
      ? parseSerializedValue(serialized, new Array(10).fill({ handle: '<handle>' }))
      : undefined;
  }
  if (name === 'selector')
    return { text: asLocator(sdkLanguage || 'javascript', event.params.selector), type: 'locator', name: 'locator' };
  const type = typeof value;
  if (type !== 'object' || value === null)
    return { text: String(value), type, name };
  if (value.guid)
    return { text: '<handle>', type: 'handle', name };
  return { text: JSON.stringify(value), type: 'object', name };
}

function parseSerializedValue(value: SerializedValue, handles: any[] | undefined): any {
  if (value.n !== undefined)
    return value.n;
  if (value.s !== undefined)
    return value.s;
  if (value.b !== undefined)
    return value.b;
  if (value.v !== undefined) {
    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;
  }
  if (value.d !== undefined)
    return new Date(value.d);
  if (value.r !== undefined)
    return new RegExp(value.r.p, value.r.f);
  if (value.a !== undefined)
    return value.a.map((a: any) => parseSerializedValue(a, handles));
  if (value.o !== undefined) {
    const result: any = {};
    for (const { k, v } of value.o)
      result[k] = parseSerializedValue(v, handles);
    return result;
  }
  if (value.h !== undefined) {
    if (handles === undefined)
      return '<object>';
    return handles[value.h];
  }
  return '<object>';
}