mirror of
https://github.com/microsoft/playwright.git
synced 2025-06-26 21:40:17 +00:00
297 lines
12 KiB
TypeScript
297 lines
12 KiB
TypeScript
/**
|
|
* 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 highlightCSS from './highlight.css?inline';
|
|
import { asLocator } from '../../utils/isomorphic/locatorGenerators';
|
|
import { stringifySelector } from '../../utils/isomorphic/selectorParser';
|
|
|
|
import type { InjectedScript } from './injectedScript';
|
|
import type { Language } from '../../utils/isomorphic/locatorGenerators';
|
|
import type { ParsedSelector } from '../../utils/isomorphic/selectorParser';
|
|
|
|
|
|
type HighlightEntry = {
|
|
targetElement: Element,
|
|
highlightElement: HTMLElement,
|
|
tooltipElement?: HTMLElement,
|
|
box?: DOMRect,
|
|
tooltipTop?: number,
|
|
tooltipLeft?: number,
|
|
tooltipText?: string,
|
|
};
|
|
|
|
export type HighlightOptions = {
|
|
tooltipText?: string;
|
|
tooltipList?: string[];
|
|
tooltipFooter?: string;
|
|
tooltipListItemSelected?: (index: number | undefined) => void;
|
|
color?: string;
|
|
};
|
|
|
|
export class Highlight {
|
|
private _glassPaneElement: HTMLElement;
|
|
private _glassPaneShadow: ShadowRoot;
|
|
private _highlightEntries: HighlightEntry[] = [];
|
|
private _highlightOptions: HighlightOptions = {};
|
|
private _actionPointElement: HTMLElement;
|
|
private _isUnderTest: boolean;
|
|
private _injectedScript: InjectedScript;
|
|
private _rafRequest: number | undefined;
|
|
private _language: Language = 'javascript';
|
|
|
|
constructor(injectedScript: InjectedScript) {
|
|
this._injectedScript = injectedScript;
|
|
const document = injectedScript.document;
|
|
this._isUnderTest = injectedScript.isUnderTest;
|
|
this._glassPaneElement = document.createElement('x-pw-glass');
|
|
this._glassPaneElement.style.position = 'fixed';
|
|
this._glassPaneElement.style.top = '0';
|
|
this._glassPaneElement.style.right = '0';
|
|
this._glassPaneElement.style.bottom = '0';
|
|
this._glassPaneElement.style.left = '0';
|
|
this._glassPaneElement.style.zIndex = '2147483646';
|
|
this._glassPaneElement.style.pointerEvents = 'none';
|
|
this._glassPaneElement.style.display = 'flex';
|
|
this._glassPaneElement.style.backgroundColor = 'transparent';
|
|
for (const eventName of ['click', 'auxclick', 'dragstart', 'input', 'keydown', 'keyup', 'pointerdown', 'pointerup', 'mousedown', 'mouseup', 'mouseleave', 'focus', 'scroll']) {
|
|
this._glassPaneElement.addEventListener(eventName, e => {
|
|
e.stopPropagation();
|
|
e.stopImmediatePropagation();
|
|
if (e.type === 'click' && (e as MouseEvent).button === 0 && this._highlightOptions.tooltipListItemSelected)
|
|
this._highlightOptions.tooltipListItemSelected(undefined);
|
|
});
|
|
}
|
|
this._actionPointElement = document.createElement('x-pw-action-point');
|
|
this._actionPointElement.setAttribute('hidden', 'true');
|
|
this._glassPaneShadow = this._glassPaneElement.attachShadow({ mode: this._isUnderTest ? 'open' : 'closed' });
|
|
// workaround for firefox: when taking screenshots, it complains adoptedStyleSheets.push
|
|
// is not a function, so we fallback to style injection
|
|
if (typeof this._glassPaneShadow.adoptedStyleSheets.push === 'function') {
|
|
const sheet = new this._injectedScript.window.CSSStyleSheet();
|
|
sheet.replaceSync(highlightCSS);
|
|
this._glassPaneShadow.adoptedStyleSheets.push(sheet);
|
|
} else {
|
|
const styleElement = this._injectedScript.document.createElement('style');
|
|
styleElement.textContent = highlightCSS;
|
|
this._glassPaneShadow.appendChild(styleElement);
|
|
}
|
|
this._glassPaneShadow.appendChild(this._actionPointElement);
|
|
}
|
|
|
|
install() {
|
|
// NOTE: document.documentElement can be null: https://github.com/microsoft/TypeScript/issues/50078
|
|
if (this._injectedScript.document.documentElement && !this._injectedScript.document.documentElement.contains(this._glassPaneElement))
|
|
this._injectedScript.document.documentElement.appendChild(this._glassPaneElement);
|
|
}
|
|
|
|
setLanguage(language: Language) {
|
|
this._language = language;
|
|
}
|
|
|
|
runHighlightOnRaf(selector: ParsedSelector) {
|
|
if (this._rafRequest)
|
|
cancelAnimationFrame(this._rafRequest);
|
|
this.updateHighlight(this._injectedScript.querySelectorAll(selector, this._injectedScript.document.documentElement), { tooltipText: asLocator(this._language, stringifySelector(selector)) });
|
|
this._rafRequest = this._injectedScript.builtinRequestAnimationFrame(() => this.runHighlightOnRaf(selector));
|
|
}
|
|
|
|
uninstall() {
|
|
if (this._rafRequest)
|
|
cancelAnimationFrame(this._rafRequest);
|
|
this._glassPaneElement.remove();
|
|
}
|
|
|
|
showActionPoint(x: number, y: number) {
|
|
this._actionPointElement.style.top = y + 'px';
|
|
this._actionPointElement.style.left = x + 'px';
|
|
this._actionPointElement.hidden = false;
|
|
}
|
|
|
|
hideActionPoint() {
|
|
this._actionPointElement.hidden = true;
|
|
}
|
|
|
|
clearHighlight() {
|
|
for (const entry of this._highlightEntries) {
|
|
entry.highlightElement?.remove();
|
|
entry.tooltipElement?.remove();
|
|
}
|
|
this._highlightEntries = [];
|
|
this._highlightOptions = {};
|
|
this._glassPaneElement.style.pointerEvents = 'none';
|
|
}
|
|
|
|
updateHighlight(elements: Element[], options: HighlightOptions) {
|
|
this._innerUpdateHighlight(elements, options);
|
|
}
|
|
|
|
maskElements(elements: Element[], color: string) {
|
|
this._innerUpdateHighlight(elements, { color: color });
|
|
}
|
|
|
|
private _innerUpdateHighlight(elements: Element[], options: HighlightOptions) {
|
|
let color = options.color;
|
|
if (!color)
|
|
color = elements.length > 1 ? '#f6b26b7f' : '#6fa8dc7f';
|
|
|
|
// Code below should trigger one layout and leave with the
|
|
// destroyed layout.
|
|
|
|
if (this._highlightIsUpToDate(elements, options))
|
|
return;
|
|
|
|
// 1. Destroy the layout
|
|
this.clearHighlight();
|
|
this._highlightOptions = options;
|
|
this._glassPaneElement.style.pointerEvents = options.tooltipListItemSelected ? 'initial' : 'none';
|
|
|
|
for (let i = 0; i < elements.length; ++i) {
|
|
const highlightElement = this._createHighlightElement();
|
|
this._glassPaneShadow.appendChild(highlightElement);
|
|
|
|
let tooltipElement;
|
|
if (options.tooltipList || options.tooltipText || options.tooltipFooter) {
|
|
tooltipElement = this._injectedScript.document.createElement('x-pw-tooltip');
|
|
this._glassPaneShadow.appendChild(tooltipElement);
|
|
tooltipElement.style.top = '0';
|
|
tooltipElement.style.left = '0';
|
|
tooltipElement.style.display = 'flex';
|
|
let lines: string[] = [];
|
|
if (options.tooltipList) {
|
|
lines = options.tooltipList;
|
|
} else if (options.tooltipText) {
|
|
const suffix = elements.length > 1 ? ` [${i + 1} of ${elements.length}]` : '';
|
|
lines = [options.tooltipText + suffix];
|
|
}
|
|
for (let index = 0; index < lines.length; index++) {
|
|
const element = this._injectedScript.document.createElement('x-pw-tooltip-line');
|
|
element.textContent = lines[index];
|
|
tooltipElement.appendChild(element);
|
|
if (options.tooltipListItemSelected) {
|
|
element.classList.add('selectable');
|
|
element.addEventListener('click', () => options.tooltipListItemSelected?.(index));
|
|
}
|
|
}
|
|
if (options.tooltipFooter) {
|
|
const footer = this._injectedScript.document.createElement('x-pw-tooltip-footer');
|
|
footer.textContent = options.tooltipFooter;
|
|
tooltipElement.appendChild(footer);
|
|
}
|
|
}
|
|
this._highlightEntries.push({ targetElement: elements[i], tooltipElement, highlightElement });
|
|
}
|
|
|
|
// 2. Trigger layout while positioning tooltips and computing bounding boxes.
|
|
for (const entry of this._highlightEntries) {
|
|
entry.box = entry.targetElement.getBoundingClientRect();
|
|
if (!entry.tooltipElement)
|
|
continue;
|
|
|
|
// Position tooltip, if any.
|
|
const { anchorLeft, anchorTop } = this.tooltipPosition(entry.box, entry.tooltipElement);
|
|
entry.tooltipTop = anchorTop;
|
|
entry.tooltipLeft = anchorLeft;
|
|
}
|
|
|
|
// 3. Destroy the layout again.
|
|
|
|
// If there are more than 1 box - we are evaluating a non-unique (potentially bad) selector.
|
|
for (const entry of this._highlightEntries) {
|
|
if (entry.tooltipElement) {
|
|
entry.tooltipElement.style.top = entry.tooltipTop + 'px';
|
|
entry.tooltipElement.style.left = entry.tooltipLeft + 'px';
|
|
}
|
|
const box = entry.box!;
|
|
entry.highlightElement.style.backgroundColor = color;
|
|
entry.highlightElement.style.left = box.x + 'px';
|
|
entry.highlightElement.style.top = box.y + 'px';
|
|
entry.highlightElement.style.width = box.width + 'px';
|
|
entry.highlightElement.style.height = box.height + 'px';
|
|
entry.highlightElement.style.display = 'block';
|
|
|
|
if (this._isUnderTest)
|
|
console.error('Highlight box for test: ' + JSON.stringify({ x: box.x, y: box.y, width: box.width, height: box.height })); // eslint-disable-line no-console
|
|
}
|
|
}
|
|
|
|
firstBox(): DOMRect | undefined {
|
|
return this._highlightEntries[0]?.box;
|
|
}
|
|
|
|
tooltipPosition(box: DOMRect, tooltipElement: HTMLElement) {
|
|
const tooltipWidth = tooltipElement.offsetWidth;
|
|
const tooltipHeight = tooltipElement.offsetHeight;
|
|
const totalWidth = this._glassPaneElement.offsetWidth;
|
|
const totalHeight = this._glassPaneElement.offsetHeight;
|
|
|
|
let anchorLeft = box.left;
|
|
if (anchorLeft + tooltipWidth > totalWidth - 5)
|
|
anchorLeft = totalWidth - tooltipWidth - 5;
|
|
let anchorTop = box.bottom + 5;
|
|
if (anchorTop + tooltipHeight > totalHeight - 5) {
|
|
// If can't fit below, either position above...
|
|
if (box.top > tooltipHeight + 5) {
|
|
anchorTop = box.top - tooltipHeight - 5;
|
|
} else {
|
|
// Or on top in case of large element
|
|
anchorTop = totalHeight - 5 - tooltipHeight;
|
|
}
|
|
}
|
|
return { anchorLeft, anchorTop };
|
|
}
|
|
|
|
private _highlightIsUpToDate(elements: Element[], options: HighlightOptions): boolean {
|
|
if (options.tooltipText !== this._highlightOptions.tooltipText)
|
|
return false;
|
|
if (options.tooltipListItemSelected !== this._highlightOptions.tooltipListItemSelected)
|
|
return false;
|
|
if (options.tooltipFooter !== this._highlightOptions.tooltipFooter)
|
|
return false;
|
|
|
|
if (options.tooltipList?.length !== this._highlightOptions.tooltipList?.length)
|
|
return false;
|
|
if (options.tooltipList && this._highlightOptions.tooltipList) {
|
|
for (let i = 0; i < options.tooltipList.length; i++) {
|
|
if (options.tooltipList[i] !== this._highlightOptions.tooltipList[i])
|
|
return false;
|
|
}
|
|
}
|
|
|
|
if (elements.length !== this._highlightEntries.length)
|
|
return false;
|
|
for (let i = 0; i < this._highlightEntries.length; ++i) {
|
|
if (elements[i] !== this._highlightEntries[i].targetElement)
|
|
return false;
|
|
const oldBox = this._highlightEntries[i].box;
|
|
if (!oldBox)
|
|
return false;
|
|
const box = elements[i].getBoundingClientRect();
|
|
if (box.top !== oldBox.top || box.right !== oldBox.right || box.bottom !== oldBox.bottom || box.left !== oldBox.left)
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
private _createHighlightElement(): HTMLElement {
|
|
return this._injectedScript.document.createElement('x-pw-highlight');
|
|
}
|
|
|
|
appendChild(element: Element) {
|
|
this._glassPaneShadow.appendChild(element);
|
|
}
|
|
}
|