/* 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 { SplitView } from '@web/components/splitView'; import * as React from 'react'; import { ActionList } from './actionList'; import { CallTab } from './callTab'; import { LogTab } from './logTab'; import { ErrorsTab, useErrorsTabModel } from './errorsTab'; import type { ErrorDescription } from './errorsTab'; import type { ConsoleEntry } from './consoleTab'; import { ConsoleTab, useConsoleTabModel } from './consoleTab'; import type * as modelUtil from './modelUtil'; import { NetworkTab, useNetworkTabModel } from './networkTab'; import { SnapshotTabsView } from './snapshotTab'; import { SourceTab } from './sourceTab'; import { TabbedPane } from '@web/components/tabbedPane'; import type { TabbedPaneTabModel } from '@web/components/tabbedPane'; import { Timeline } from './timeline'; import { MetadataView } from './metadataView'; import { AttachmentsTab } from './attachmentsTab'; import { AnnotationsTab } from './annotationsTab'; import type { Boundaries } from './geometry'; import { InspectorTab } from './inspectorTab'; import { ToolbarButton } from '@web/components/toolbarButton'; import { useSetting, msToString, clsx } from '@web/uiUtils'; import type { Entry } from '@trace/har'; import './workbench.css'; import { testStatusIcon, testStatusText } from './testUtils'; import type { UITestStatus } from './testUtils'; export const Workbench: React.FunctionComponent<{ model?: modelUtil.MultiTraceModel, showSourcesFirst?: boolean, rootDir?: string, fallbackLocation?: modelUtil.SourceLocation, isLive?: boolean, hideTimeline?: boolean, status?: UITestStatus, annotations?: { type: string; description?: string; }[]; inert?: boolean, openPage?: (url: string, target?: string) => Window | any, onOpenExternally?: (location: modelUtil.SourceLocation) => void, revealSource?: boolean, }> = ({ model, showSourcesFirst, rootDir, fallbackLocation, isLive, hideTimeline, status, annotations, inert, openPage, onOpenExternally, revealSource }) => { const [selectedCallId, setSelectedCallId] = React.useState(undefined); const [revealedError, setRevealedError] = React.useState(undefined); const [highlightedCallId, setHighlightedCallId] = React.useState(); const [highlightedEntry, setHighlightedEntry] = React.useState(); const [highlightedConsoleMessage, setHighlightedConsoleMessage] = React.useState(); const [selectedNavigatorTab, setSelectedNavigatorTab] = React.useState('actions'); const [selectedPropertiesTab, setSelectedPropertiesTab] = useSetting('propertiesTab', showSourcesFirst ? 'source' : 'call'); const [isInspecting, setIsInspectingState] = React.useState(false); const [highlightedLocator, setHighlightedLocator] = React.useState(''); const [selectedTime, setSelectedTime] = React.useState(); const [sidebarLocation, setSidebarLocation] = useSetting<'bottom' | 'right'>('propertiesSidebarLocation', 'bottom'); const setSelectedAction = React.useCallback((action: modelUtil.ActionTraceEventInContext | undefined) => { setSelectedCallId(action?.callId); setRevealedError(undefined); }, []); const highlightedAction = React.useMemo(() => { return model?.actions.find(a => a.callId === highlightedCallId); }, [model, highlightedCallId]); const setHighlightedAction = React.useCallback((highlightedAction: modelUtil.ActionTraceEventInContext | undefined) => { setHighlightedCallId(highlightedAction?.callId); }, []); const sources = React.useMemo(() => model?.sources || new Map(), [model]); React.useEffect(() => { setSelectedTime(undefined); setRevealedError(undefined); }, [model]); const selectedAction = React.useMemo(() => { if (selectedCallId) { const action = model?.actions.find(a => a.callId === selectedCallId); if (action) return action; } const failedAction = model?.failedAction(); if (failedAction) return failedAction; if (model?.actions.length) { // Select the last non-after hooks item. let index = model.actions.length - 1; for (let i = 0; i < model.actions.length; ++i) { if (model.actions[i].apiName === 'After Hooks' && i) { index = i - 1; break; } } return model.actions[index]; } }, [model, selectedCallId]); const activeAction = React.useMemo(() => { return highlightedAction || selectedAction; }, [selectedAction, highlightedAction]); const revealedStack = React.useMemo(() => { if (revealedError) return revealedError.stack; return activeAction?.stack; }, [activeAction, revealedError]); const onActionSelected = React.useCallback((action: modelUtil.ActionTraceEventInContext) => { setSelectedAction(action); setHighlightedAction(undefined); }, [setSelectedAction, setHighlightedAction]); const selectPropertiesTab = React.useCallback((tab: string) => { setSelectedPropertiesTab(tab); if (tab !== 'inspector') setIsInspectingState(false); }, [setSelectedPropertiesTab]); const setIsInspecting = React.useCallback((value: boolean) => { if (!isInspecting && value) selectPropertiesTab('inspector'); setIsInspectingState(value); }, [setIsInspectingState, selectPropertiesTab, isInspecting]); const locatorPicked = React.useCallback((locator: string) => { setHighlightedLocator(locator); selectPropertiesTab('inspector'); }, [selectPropertiesTab]); React.useEffect(() => { if (revealSource) selectPropertiesTab('source'); }, [revealSource, selectPropertiesTab]); const consoleModel = useConsoleTabModel(model, selectedTime); const networkModel = useNetworkTabModel(model, selectedTime); const errorsModel = useErrorsTabModel(model); const attachments = React.useMemo(() => { return model?.actions.map(a => a.attachments || []).flat() || []; }, [model]); const sdkLanguage = model?.sdkLanguage || 'javascript'; const inspectorTab: TabbedPaneTabModel = { id: 'inspector', title: 'Locator', render: () => , }; const callTab: TabbedPaneTabModel = { id: 'call', title: 'Call', render: () => }; const logTab: TabbedPaneTabModel = { id: 'log', title: 'Log', render: () => }; const errorsTab: TabbedPaneTabModel = { id: 'errors', title: 'Errors', errorCount: errorsModel.errors.size, render: () => { if (error.action) setSelectedAction(error.action); else setRevealedError(error); selectPropertiesTab('source'); }} /> }; // Fallback location w/o action stands for file / test. // Render error count on Source tab for that case. let fallbackSourceErrorCount: number | undefined = undefined; if (!selectedAction && fallbackLocation) fallbackSourceErrorCount = fallbackLocation.source?.errors.length; const sourceTab: TabbedPaneTabModel = { id: 'source', title: 'Source', errorCount: fallbackSourceErrorCount, render: () => }; const consoleTab: TabbedPaneTabModel = { id: 'console', title: 'Console', count: consoleModel.entries.length, render: () => setSelectedTime({ minimum: m.timestamp, maximum: m.timestamp })} onEntryHovered={setHighlightedConsoleMessage} /> }; const networkTab: TabbedPaneTabModel = { id: 'network', title: 'Network', count: networkModel.resources.length, render: () => }; const attachmentsTab: TabbedPaneTabModel = { id: 'attachments', title: 'Attachments', count: attachments.length, render: () => }; const tabs: TabbedPaneTabModel[] = [ inspectorTab, callTab, logTab, errorsTab, consoleTab, networkTab, sourceTab, attachmentsTab, ]; if (annotations !== undefined) { const annotationsTab: TabbedPaneTabModel = { id: 'annotations', title: 'Annotations', count: annotations.length, render: () => }; tabs.push(annotationsTab); } if (showSourcesFirst) { const sourceTabIndex = tabs.indexOf(sourceTab); tabs.splice(sourceTabIndex, 1); tabs.splice(1, 0, sourceTab); } const { boundaries } = React.useMemo(() => { const boundaries = { minimum: model?.startTime || 0, maximum: model?.endTime || 30000 }; if (boundaries.minimum > boundaries.maximum) { boundaries.minimum = 0; boundaries.maximum = 30000; } // Leave some nice free space on the right hand side. boundaries.maximum += (boundaries.maximum - boundaries.minimum) / 20; return { boundaries }; }, [model]); let time: number = 0; if (!isLive && model && model.endTime >= 0) time = model.endTime - model.startTime; else if (model && model.wallTime) time = Date.now() - model.wallTime; const actionsTab: TabbedPaneTabModel = { id: 'actions', title: 'Actions', component:
{status &&
{testStatusText(status)}
{time ? msToString(time) : ''}
} selectPropertiesTab('console')} isLive={isLive} />
}; const metadataTab: TabbedPaneTabModel = { id: 'metadata', title: 'Metadata', component: }; return
{!hideTimeline && } } sidebar={ } />} sidebar={ { setSidebarLocation('right'); }} /> : { setSidebarLocation('bottom'); }} /> ]} mode={sidebarLocation === 'bottom' ? 'default' : 'select'} />} />
; };