Skip to content

Commit

Permalink
fix(trace viewer): follow up with recent instrumentation changes (#5488)
Browse files Browse the repository at this point in the history
- List all actions we are interested in
- Fix timeline hover flicker
- Extract tabbed pane component
- Preview snapshots without clicking on the action
  • Loading branch information
dgozman committed Feb 18, 2021
1 parent 3248c24 commit da135c2
Show file tree
Hide file tree
Showing 8 changed files with 252 additions and 226 deletions.
4 changes: 4 additions & 0 deletions src/cli/traceViewer/traceModel.ts
Expand Up @@ -64,6 +64,8 @@ export type VideoMetaInfo = {
endTime: number;
};

const kInterestingActions = ['click', 'dblclick', 'hover', 'check', 'uncheck', 'tap', 'fill', 'press', 'type', 'selectOption', 'setInputFiles', 'goto', 'setContent', 'goBack', 'goForward', 'reload'];

export function readTraceFile(events: trace.TraceEvent[], traceModel: TraceModel, filePath: string) {
const contextEntries = new Map<string, ContextEntry>();
const pageEntries = new Map<string, PageEntry>();
Expand Down Expand Up @@ -108,6 +110,8 @@ export function readTraceFile(events: trace.TraceEvent[], traceModel: TraceModel
break;
}
case 'action': {
if (!kInterestingActions.includes(event.method))
break;
const pageEntry = pageEntries.get(event.pageId!)!;
const actionId = event.contextId + '/' + event.pageId + '/' + pageEntry.actions.length;
const action: ActionEntry = {
Expand Down
135 changes: 0 additions & 135 deletions src/web/traceViewer/ui/propertiesTabbedPane.tsx

This file was deleted.

54 changes: 54 additions & 0 deletions src/web/traceViewer/ui/snapshotTab.css
@@ -0,0 +1,54 @@
/*
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.
*/

.snapshot-tab {
display: flex;
flex-direction: column;
align-items: stretch;
}

.snapshot-controls {
flex: 0 0 24px;
display: flex;
flex-direction: row;
align-items: center;
}

.snapshot-toggle {
padding: 5px 10px;
cursor: pointer;
}

.snapshot-toggle.toggled {
background: var(--inactive-focus-ring);
}

.snapshot-wrapper {
flex: auto;
margin: 1px;
}

.snapshot-container {
display: block;
background: white;
outline: 1px solid #aaa;
}

iframe#snapshot {
width: 100%;
height: 100%;
border: none;
}
90 changes: 90 additions & 0 deletions src/web/traceViewer/ui/snapshotTab.tsx
@@ -0,0 +1,90 @@
/**
* 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 { ActionEntry } from '../../../cli/traceViewer/traceModel';
import { Boundaries, Size } from '../geometry';
import './snapshotTab.css';
import * as React from 'react';
import { msToString, useMeasure } from './helpers';

export const SnapshotTab: React.FunctionComponent<{
actionEntry: ActionEntry | undefined,
snapshotSize: Size,
selection: { pageId: string, time: number } | undefined,
boundaries: Boundaries,
}> = ({ actionEntry, snapshotSize, selection, boundaries }) => {
const [measure, ref] = useMeasure<HTMLDivElement>();
const [snapshotIndex, setSnapshotIndex] = React.useState(0);

let snapshots: { name: string, snapshotId?: string, snapshotTime?: number }[] = [];
snapshots = (actionEntry ? (actionEntry.action.snapshots || []) : []).slice();
if (actionEntry) {
if (!snapshots.length || snapshots[0].name !== 'before')
snapshots.unshift({ name: 'before', snapshotTime: actionEntry ? actionEntry.action.startTime : 0 });
if (snapshots[snapshots.length - 1].name !== 'after')
snapshots.push({ name: 'after', snapshotTime: actionEntry ? actionEntry.action.endTime : 0 });
}
const { pageId, time } = selection || { pageId: undefined, time: 0 };

const iframeRef = React.createRef<HTMLIFrameElement>();
React.useEffect(() => {
if (!iframeRef.current)
return;

// TODO: this logic is copied from SnapshotServer. Find a way to share.
let snapshotUrl = 'data:text/html,Snapshot is not available';
if (pageId) {
snapshotUrl = `/snapshot/pageId/${pageId}/timestamp/${time}/main`;
} else if (actionEntry) {
const snapshot = snapshots[snapshotIndex];
if (snapshot && snapshot.snapshotTime)
snapshotUrl = `/snapshot/pageId/${actionEntry.action.pageId!}/timestamp/${snapshot.snapshotTime}/main`;
else if (snapshot && snapshot.snapshotId)
snapshotUrl = `/snapshot/pageId/${actionEntry.action.pageId!}/snapshotId/${snapshot.snapshotId}/main`;
}

try {
(iframeRef.current.contentWindow as any).showSnapshot(snapshotUrl);
} catch (e) {
}
}, [actionEntry, snapshotIndex, pageId, time]);

const scale = Math.min(measure.width / snapshotSize.width, measure.height / snapshotSize.height);
return <div className='snapshot-tab'>
<div className='snapshot-controls'>{
selection && <div key='selectedTime' className='snapshot-toggle'>
{msToString(selection.time - boundaries.minimum)}
</div>
}{!selection && snapshots.map((snapshot, index) => {
return <div
key={snapshot.name}
className={'snapshot-toggle' + (snapshotIndex === index ? ' toggled' : '')}
onClick={() => setSnapshotIndex(index)}>
{snapshot.name}
</div>
})
}</div>
<div ref={ref} className='snapshot-wrapper'>
<div className='snapshot-container' style={{
width: snapshotSize.width + 'px',
height: snapshotSize.height + 'px',
transform: `translate(${-snapshotSize.width * (1 - scale) / 2}px, ${-snapshotSize.height * (1 - scale) / 2}px) scale(${scale})`,
}}>
<iframe ref={iframeRef} id='snapshot' name='snapshot' src='/snapshot/'></iframe>
</div>
</div>
</div>;
};
Expand Up @@ -14,31 +14,31 @@
limitations under the License.
*/

.properties-tabbed-pane {
.tabbed-pane {
display: flex;
flex: auto;
overflow: hidden;
}

.properties-tab-content {
.tab-content {
display: flex;
flex: auto;
overflow: hidden;
}

.properties-tab-strip {
.tab-strip {
flex: auto;
display: flex;
flex-direction: row;
align-items: center;
height: 34px;
}

.properties-tab-strip:focus {
.tab-strip:focus {
outline: none;
}

.properties-tab-element {
.tab-element {
padding: 2px 6px 0 6px;
margin-right: 4px;
cursor: pointer;
Expand All @@ -52,57 +52,18 @@
outline: none;
}

.properties-tab-label {
.tab-label {
max-width: 250px;
white-space: pre;
overflow: hidden;
text-overflow: ellipsis;
display: inline-block;
}

.properties-tab-element.selected {
.tab-element.selected {
border-bottom-color: var(--color);
}

.properties-tab-element:hover {
.tab-element:hover {
font-weight: 600;
}

.snapshot-tab {
display: flex;
flex-direction: column;
align-items: stretch;
}

.snapshot-controls {
flex: 0 0 24px;
display: flex;
flex-direction: row;
align-items: center;
}

.snapshot-toggle {
padding: 5px 10px;
cursor: pointer;
}

.snapshot-toggle.toggled {
background: var(--inactive-focus-ring);
}

.snapshot-wrapper {
flex: auto;
margin: 1px;
}

.snapshot-container {
display: block;
background: white;
outline: 1px solid #aaa;
}

iframe#snapshot {
width: 100%;
height: 100%;
border: none;
}

0 comments on commit da135c2

Please sign in to comment.