|
| 1 | +// Copyright 2024 The Chromium Authors. All rights reserved. |
| 2 | +// Use of this source code is governed by a BSD-style license that can be |
| 3 | +// found in the LICENSE file. |
| 4 | + |
| 5 | +import {assert} from 'chai'; |
| 6 | + |
| 7 | +import {getBrowserAndPages} from '../../conductor/puppeteer-state.js'; |
| 8 | + |
| 9 | +// Corresponds to the type in front_end/ui/visual_logging/Debugging.ts |
| 10 | +type TestLogEntry = { |
| 11 | + impressions: string[], |
| 12 | +}|{ |
| 13 | + interaction: string, |
| 14 | +}; |
| 15 | + |
| 16 | +function formatImpressions(impressions: string[]) { |
| 17 | + const result: string[] = []; |
| 18 | + let lastImpression = ''; |
| 19 | + for (const impression of impressions.sort()) { |
| 20 | + while (!impression.startsWith(lastImpression)) { |
| 21 | + lastImpression = lastImpression.substr(0, lastImpression.lastIndexOf(' > ')); |
| 22 | + } |
| 23 | + result.push(' '.repeat(lastImpression.length) + impression.substr(lastImpression.length)); |
| 24 | + lastImpression = impression; |
| 25 | + } |
| 26 | + return result.join('\n'); |
| 27 | +} |
| 28 | + |
| 29 | +function compareVeImpressions(actual: string[], expected: string[]): {match: boolean, description?: string} { |
| 30 | + const actualSet = new Set(actual); |
| 31 | + const expectedSet = new Set(expected); |
| 32 | + const missing = [...expectedSet].filter(k => !actualSet.has(k)); |
| 33 | + |
| 34 | + if (missing.length) { |
| 35 | + return { |
| 36 | + match: false, |
| 37 | + description: |
| 38 | + 'Missing VE events:\n' + formatImpressions(missing) + '\nActual impressions:\n' + formatImpressions(actual), |
| 39 | + }; |
| 40 | + } |
| 41 | + return {match: true}; |
| 42 | +} |
| 43 | + |
| 44 | +export function veImpression(ve: string, context?: string, children?: string[][]) { |
| 45 | + let key = ve; |
| 46 | + if (context) { |
| 47 | + key += ': ' + context; |
| 48 | + } |
| 49 | + const result = [key]; |
| 50 | + for (const child of children || []) { |
| 51 | + for (const impression of child) { |
| 52 | + result.push(key + ' > ' + impression); |
| 53 | + } |
| 54 | + } |
| 55 | + return result; |
| 56 | +} |
| 57 | + |
| 58 | +function veImpressionForTabHeader(panel: string, options?: {closable: boolean}) { |
| 59 | + if (options?.closable) { |
| 60 | + return veImpression('PanelTabHeader', panel, [veImpression('Close')]); |
| 61 | + } |
| 62 | + return veImpression('PanelTabHeader', panel); |
| 63 | +} |
| 64 | + |
| 65 | +export function veImpressionForMainToolbar(options?: { |
| 66 | + selectedPanel?: string, |
| 67 | + expectClosedPanels?: string[], |
| 68 | + dockable?: boolean, |
| 69 | +}) { |
| 70 | + const regularPanels = ['elements', 'console', 'sources', 'network']; |
| 71 | + if (!options?.dockable) { |
| 72 | + regularPanels.push('timeline', 'heap-profiler', 'resources', 'lighthouse'); |
| 73 | + } |
| 74 | + |
| 75 | + const closablePanels = |
| 76 | + options?.dockable ? [] : ['security', 'chrome-recorder'].filter(p => !options?.expectClosedPanels?.includes(p)); |
| 77 | + if (options?.selectedPanel && !regularPanels.includes(options?.selectedPanel)) { |
| 78 | + closablePanels.push(options.selectedPanel); |
| 79 | + } |
| 80 | + |
| 81 | + const dockableItems = options?.dockable ? |
| 82 | + [ |
| 83 | + veImpression('DropDown', 'more-tabs'), |
| 84 | + veImpression('Toggle', 'emulation.toggle-device-mode'), |
| 85 | + veImpression('Close'), |
| 86 | + ] : |
| 87 | + []; |
| 88 | + |
| 89 | + return veImpression('Toolbar', 'main', [ |
| 90 | + ...regularPanels.map(panel => veImpressionForTabHeader(panel)), |
| 91 | + ...closablePanels.map(panel => veImpressionForTabHeader(panel, {closable: true})), |
| 92 | + veImpression('Toggle', 'elements.toggle-element-search'), |
| 93 | + veImpression('Action', 'settings.show'), |
| 94 | + veImpression('DropDown', 'main-menu'), |
| 95 | + ...dockableItems, |
| 96 | + ]); |
| 97 | +} |
| 98 | + |
| 99 | +export function veImpressionForElementsPanel(options?: {dockable?: boolean}) { |
| 100 | + return veImpression('Panel', 'elements', [ |
| 101 | + veImpression('Toolbar', 'sidebar', [ |
| 102 | + veImpressionForTabHeader('styles'), |
| 103 | + veImpressionForTabHeader('computed'), |
| 104 | + veImpressionForTabHeader('elements.layout'), |
| 105 | + ...(options?.dockable ? ['elements.event-listeners', 'elements.dom-breakpoints', 'elements.dom-properties'] : []).map(panel => veImpressionForTabHeader(panel)), |
| 106 | + ]), |
| 107 | + veImpression('ElementsBreadcrumbs', undefined, [veImpression('Item'), veImpression('Item')]), |
| 108 | + veImpression('Tree', 'elements', [ |
| 109 | + veImpression('TreeItem'), |
| 110 | + veImpression('TreeItem', undefined, [veImpression('Value', 'tag-name'), veImpression('Expand')]), |
| 111 | + veImpression('TreeItem', undefined, [veImpression('Value', 'tag-name')]), |
| 112 | + veImpression('TreeItem', undefined, [veImpression('Value', 'tag-name')]), |
| 113 | + veImpression('TreeItem'), |
| 114 | + ]), |
| 115 | + veImpression('Pane', 'styles', [ |
| 116 | + veImpression('Section', 'style-properties', [veImpression('CSSRuleHeader', 'selector')]), |
| 117 | + veImpression('Section', 'style-properties', [ |
| 118 | + veImpression('Action', 'elements.new-style-rule'), |
| 119 | + veImpression('CSSRuleHeader', 'selector'), |
| 120 | + veImpression('Tree', undefined, [ |
| 121 | + veImpression('TreeItem', 'display', [veImpression('Toggle'), veImpression('Key'), veImpression('Value')]), |
| 122 | + veImpression('TreeItem', 'margin', [ |
| 123 | + veImpression('Toggle'), |
| 124 | + veImpression('Key'), |
| 125 | + veImpression('Expand'), |
| 126 | + veImpression('Value'), |
| 127 | + veImpression('Expand'), |
| 128 | + ]), |
| 129 | + ]), |
| 130 | + ]), |
| 131 | + veImpression('ToggleSubpane', 'element-states'), |
| 132 | + veImpression('ToggleSubpane', 'elements-classes'), |
| 133 | + veImpression('Action', 'elements.new-style-rule'), |
| 134 | + veImpression('DropDown', 'rendering-emulations'), |
| 135 | + veImpression('ToggleSubpane', 'computed-styles'), |
| 136 | + veImpression('TextField'), |
| 137 | + ]), |
| 138 | + ]); |
| 139 | +} |
| 140 | + |
| 141 | +export function veImpressionForDrawerToolbar(options?: { |
| 142 | + selectedPanel?: string, |
| 143 | +}) { |
| 144 | + const closeablePanels = options?.selectedPanel ? [options?.selectedPanel] : []; |
| 145 | + return veImpression('Toolbar', 'drawer', [ |
| 146 | + veImpressionForTabHeader('console'), |
| 147 | + ...closeablePanels.map(panel => veImpressionForTabHeader(panel, {closable: true})), |
| 148 | + veImpression('DropDown', 'more-tabs'), |
| 149 | + veImpression('Close'), |
| 150 | + ]); |
| 151 | +} |
| 152 | + |
| 153 | +export async function expectVeImpressions(expectedImpressions: string[]) { |
| 154 | + const startTime = performance.now(); |
| 155 | + const {frontend} = getBrowserAndPages(); |
| 156 | + const actualEvents = |
| 157 | + // @ts-ignore |
| 158 | + await frontend.evaluate(async () => (await globalThis.getVeDebugEventsLog()) as unknown as TestLogEntry[]); |
| 159 | + const actualImpressionEvent = actualEvents.findLast(event => 'impressions' in event); |
| 160 | + const actualImpressions = |
| 161 | + actualImpressionEvent && 'impressions' in actualImpressionEvent ? actualImpressionEvent.impressions : null; |
| 162 | + if (!actualImpressions) { |
| 163 | + assert.fail('Missing VE impressions:\n' + formatImpressions(expectedImpressions)); |
| 164 | + } |
| 165 | + |
| 166 | + const {match, description} = compareVeImpressions(actualImpressions, expectedImpressions); |
| 167 | + console.error('expectVeImpressions took', performance.now() - startTime); |
| 168 | + assert.isTrue( |
| 169 | + match, |
| 170 | + description + '\nAll VE Events:\n' + |
| 171 | + actualEvents.map(e => 'impressions' in e ? formatImpressions(e.impressions) : e.interaction).join('\n\n')); |
| 172 | +} |
0 commit comments