diff --git a/tools/winscope-ng/src/app/components/app.component.ts b/tools/winscope-ng/src/app/components/app.component.ts index 1189dc4aa..826f12106 100644 --- a/tools/winscope-ng/src/app/components/app.component.ts +++ b/tools/winscope-ng/src/app/components/app.component.ts @@ -14,12 +14,22 @@ * limitations under the License. */ -import {Component, Injector, Inject, ViewEncapsulation, ChangeDetectorRef} from "@angular/core"; +import { + ChangeDetectorRef, + Component, + Injector, + Inject, + ViewChild, + ViewEncapsulation +} from "@angular/core"; import { createCustomElement } from "@angular/elements"; -import { TraceCoordinator } from "app/trace_coordinator"; +import { TimelineComponent} from "./timeline/timeline.component"; +import { Mediator } from "app/mediator"; +import { TraceData } from "app/trace_data"; import { PersistentStore } from "common/utils/persistent_store"; import { Timestamp } from "common/trace/timestamp"; import { FileUtils } from "common/utils/file_utils"; +import { FunctionUtils } from "common/utils/function_utils"; import { proxyClient, ProxyState } from "trace_collection/proxy_client"; import { ViewerInputMethodComponent } from "viewers/components/viewer_input_method.component"; import { View, Viewer } from "viewers/viewer"; @@ -29,12 +39,12 @@ import { ViewerWindowManagerComponent } from "viewers/viewer_window_manager/view import { ViewerTransactionsComponent } from "viewers/viewer_transactions/viewer_transactions.component"; import { ViewerScreenRecordingComponent } from "viewers/viewer_screen_recording/viewer_screen_recording.component"; import { TraceType } from "common/trace/trace_type"; -import { TimelineCoordinator } from "app/timeline_coordinator"; +import { TimelineData } from "app/timeline_data"; import { TracingConfig } from "trace_collection/tracing_config"; +import {TRACE_INFO} from "app/trace_info"; @Component({ selector: "app-root", - providers: [TimelineCoordinator, TraceCoordinator], template: ` Winscope @@ -76,7 +86,7 @@ import { TracingConfig } from "trace_collection/tracing_config"; + @@ -111,15 +123,15 @@ import { TracingConfig } from "trace_collection/tracing_config";
@@ -179,34 +191,24 @@ import { TracingConfig } from "trace_collection/tracing_config"; export class AppComponent { title = "winscope-ng"; changeDetectorRef: ChangeDetectorRef; - traceCoordinator: TraceCoordinator; - timelineCoordinator: TimelineCoordinator; + traceData = new TraceData(); + timelineData = new TimelineData(); + mediator = new Mediator(this.traceData, this.timelineData); states = ProxyState; store: PersistentStore = new PersistentStore(); currentTimestamp?: Timestamp; - currentTimestampIndex = 0; - allViewers: Viewer[] = []; + viewers: Viewer[] = []; isDarkModeOn!: boolean; dataLoaded = false; activeView: View|undefined; - collapsedTimelineHeight = 0; - - public onCollapsedTimelineSizeChanged(height: number) { - this.collapsedTimelineHeight = height; - this.changeDetectorRef.detectChanges(); - } + @ViewChild(TimelineComponent) timelineComponent?: TimelineComponent; constructor( @Inject(Injector) injector: Injector, - @Inject(ChangeDetectorRef) changeDetectorRef: ChangeDetectorRef, - @Inject(TimelineCoordinator) timelineCoordinator: TimelineCoordinator, - @Inject(TraceCoordinator) traceCoordinator: TraceCoordinator, + @Inject(ChangeDetectorRef) changeDetectorRef: ChangeDetectorRef ) { this.changeDetectorRef = changeDetectorRef; - this.timelineCoordinator = timelineCoordinator; - this.traceCoordinator = traceCoordinator; - this.timelineCoordinator.registerObserver(this.traceCoordinator); const storeDarkMode = this.store.get("dark-mode"); const prefersDarkQuery = window.matchMedia?.("(prefers-color-scheme: dark)"); @@ -240,17 +242,22 @@ export class AppComponent { TracingConfig.getInstance().initialize(localStorage); } - get availableTraces(): TraceType[] { - return this.traceCoordinator.getLoadedTraces().map((trace) => trace.type); + onCollapsedTimelineSizeChanged(height: number) { + this.collapsedTimelineHeight = height; + this.changeDetectorRef.detectChanges(); } - get videoData(): Blob|undefined { - return this.timelineCoordinator.getVideoData(); + getLoadedTraceTypes(): TraceType[] { + return this.traceData.getLoadedTraces().map((trace) => trace.type); + } + + getVideoData(): Blob|undefined { + return this.timelineData.getScreenRecordingVideo(); } public onUploadNewClick() { this.dataLoaded = false; - this.traceCoordinator.clearData(); + this.mediator.clearData(); proxyClient.adbData = []; this.changeDetectorRef.detectChanges(); } @@ -261,24 +268,18 @@ export class AppComponent { this.isDarkModeOn = enabled; } - public onDataLoadedChange(dataLoaded: boolean) { - if (dataLoaded && !(this.traceCoordinator.getViewers().length > 0)) { - this.traceCoordinator.createViewers(localStorage); - this.allViewers = this.traceCoordinator.getViewers(); - // TODO: Update to handle viewers with more than one dependency - if (this.allViewers[0].getDependencies().length !== 1) { - throw Error("Viewers with more than 1 dependency not yet handled."); - } - this.currentTimestampIndex = 0; - this.dataLoaded = dataLoaded; - this.changeDetectorRef.detectChanges(); - } + public onTraceDataLoaded() { + this.mediator.onTraceDataLoaded(localStorage); + this.viewers = this.mediator.getViewers(); + this.dataLoaded = true; + this.changeDetectorRef.detectChanges(); } async onDownloadTracesButtonClick() { - const traces = await this.traceCoordinator.getAllTracesForDownload(); - const zipFileBlob = await FileUtils.createZipArchive(traces); + const traceFiles = await this.makeTraceFilesForDownload(); + const zipFileBlob = await FileUtils.createZipArchive(traceFiles); const zipFileName = "winscope.zip"; + const a = document.createElement("a"); document.body.appendChild(a); const url = window.URL.createObjectURL(zipFileBlob); @@ -289,9 +290,17 @@ export class AppComponent { document.body.removeChild(a); } + private async makeTraceFilesForDownload(): Promise { + return this.traceData.getLoadedTraces().map(trace => { + const traceType = TRACE_INFO[trace.type].name; + const newName = traceType + "/" + FileUtils.removeDirFromFileName(trace.file.name); + return new File([trace.file], newName); + }); + } + handleActiveViewChanged(view: View) { this.activeView = view; - this.timelineCoordinator.setActiveTraceTypes(view.dependencies); + this.timelineData.setActiveViewTraceTypes(view.dependencies); } getActiveTraceType(): TraceType|undefined { diff --git a/tools/winscope-ng/src/app/components/collect_traces.component.ts b/tools/winscope-ng/src/app/components/collect_traces.component.ts index 547ac0140..37b29d384 100644 --- a/tools/winscope-ng/src/app/components/collect_traces.component.ts +++ b/tools/winscope-ng/src/app/components/collect_traces.component.ts @@ -14,11 +14,11 @@ * limitations under the License. */ import { Component, Input, Inject, Output, EventEmitter, OnInit, OnDestroy, ViewEncapsulation, ChangeDetectorRef } from "@angular/core"; +import { TraceData} from "app/trace_data"; import { ProxyConnection } from "trace_collection/proxy_connection"; import { Connection } from "trace_collection/connection"; import { ProxyState } from "trace_collection/proxy_client"; import { traceConfigurations, configMap, SelectionConfiguration, EnableConfiguration } from "trace_collection/trace_collection_utils"; -import { TraceCoordinator } from "app/trace_coordinator"; import { PersistentStore } from "common/utils/persistent_store"; import { MatSnackBar } from "@angular/material/snack-bar"; import { ParserError } from "parsers/parser_factory"; @@ -58,7 +58,7 @@ import { TracingConfig } from "trace_collection/tracing_config"; {{ connect.devices()[deviceId].authorised ? "smartphone" : "screen_lock_portrait" }}

- {{ connect.devices()[deviceId].authorised ? connect.devices()[deviceId].model : "unauthorised" }} ({{ deviceId }}) + {{ connect.devices()[deviceId].authorised ? connect.devices()[deviceId]?.model : "unauthorised" }} ({{ deviceId }})

@@ -70,7 +70,7 @@ import { TracingConfig } from "trace_collection/tracing_config"; smartphone

- {{ connect.selectedDevice().model }} ({{ connect.selectedDeviceId() }}) + {{ connect.selectedDevice()?.model }} ({{ connect.selectedDeviceId() }})

@@ -303,13 +303,12 @@ export class CollectTracesComponent implements OnInit, OnDestroy { traceConfigurations = traceConfigurations; connect: Connection; tracingConfig = TracingConfig.getInstance(); - dataLoaded = false; loadProgress = 0; @Input() store!: PersistentStore; - @Input() traceCoordinator!: TraceCoordinator; + @Input() traceData!: TraceData; - @Output() dataLoadedChange = new EventEmitter(); + @Output() traceDataLoaded = new EventEmitter(); constructor( @Inject(MatSnackBar) private snackBar: MatSnackBar, @@ -388,7 +387,7 @@ export class CollectTracesComponent implements OnInit, OnDestroy { if (dumpSuccessful) { await this.loadFiles(); } else { - this.traceCoordinator.clearData(); + this.traceData.clear(); } } @@ -478,14 +477,13 @@ export class CollectTracesComponent implements OnInit, OnDestroy { private async loadFiles() { console.log("loading files", this.connect.adbData()); - this.traceCoordinator.clearData(); + this.traceData.clear(); - const parserErrors = await this.traceCoordinator.setTraces(this.connect.adbData()); + const parserErrors = await this.traceData.loadTraces(this.connect.adbData()); if (parserErrors.length > 0) { this.openTempSnackBar(parserErrors); } - this.dataLoaded = true; - this.dataLoadedChange.emit(this.dataLoaded); + this.traceDataLoaded.emit(); console.log("finished loading data!"); } diff --git a/tools/winscope-ng/src/app/components/timeline/expanded_timeline.component.ts b/tools/winscope-ng/src/app/components/timeline/expanded_timeline.component.ts index 78b5fd4b4..432b06eb4 100644 --- a/tools/winscope-ng/src/app/components/timeline/expanded_timeline.component.ts +++ b/tools/winscope-ng/src/app/components/timeline/expanded_timeline.component.ts @@ -14,8 +14,8 @@ * limitations under the License. */ -import { Component, ElementRef, EventEmitter, HostListener, Inject, Input, Output, QueryList, ViewChild, ViewChildren } from "@angular/core"; -import { TimelineCoordinator } from "app/timeline_coordinator"; +import { Component, ElementRef, EventEmitter, HostListener, Input, Output, QueryList, ViewChild, ViewChildren } from "@angular/core"; +import { TimelineData } from "app/timeline_data"; import { TRACE_INFO } from "app/trace_info"; import { Timestamp } from "common/trace/timestamp"; import { SingleTimelineComponent } from "./single_timeline.component"; @@ -26,18 +26,20 @@ import { SingleTimelineComponent } from "./single_timeline.component";
- + {{ TRACE_INFO[timeline.key].icon }}
+
@@ -122,6 +124,7 @@ import { SingleTimelineComponent } from "./single_timeline.component"; `] }) export class ExpandedTimelineComponent { + @Input() timelineData!: TimelineData; @Input() currentTimestamp!: Timestamp; @Output() onTimestampChanged = new EventEmitter(); @@ -132,14 +135,12 @@ export class ExpandedTimelineComponent { TRACE_INFO = TRACE_INFO; - constructor(@Inject(TimelineCoordinator) public timelineCoordinator: TimelineCoordinator) {} - get canvas(): HTMLCanvasElement { return this.canvasRef.nativeElement; } get data() { - return this.timelineCoordinator.getTimelines(); + return this.timelineData.getTimelines(); } get sortedMergedTimestamps() { @@ -147,11 +148,11 @@ export class ExpandedTimelineComponent { } get start() { - return this.timelineCoordinator.selection.from; + return this.timelineData.getSelectionRange().from; } get end() { - return this.timelineCoordinator.selection.to; + return this.timelineData.getSelectionRange().to; } @HostListener("window:resize", ["$event"]) diff --git a/tools/winscope-ng/src/app/components/timeline/mini_timeline.component.ts b/tools/winscope-ng/src/app/components/timeline/mini_timeline.component.ts index 5066a06d8..d5ae0cdd2 100644 --- a/tools/winscope-ng/src/app/components/timeline/mini_timeline.component.ts +++ b/tools/winscope-ng/src/app/components/timeline/mini_timeline.component.ts @@ -14,8 +14,8 @@ * limitations under the License. */ -import { Component, ElementRef, EventEmitter, HostListener, Inject, Input, Output, SimpleChanges, ViewChild } from "@angular/core"; -import { TimelineCoordinator } from "app/timeline_coordinator"; +import { Component, ElementRef, EventEmitter, HostListener, Input, Output, SimpleChanges, ViewChild } from "@angular/core"; +import { TimelineData } from "app/timeline_data"; import { Timestamp } from "common/trace/timestamp"; import { TraceType } from "common/trace/trace_type"; import { MiniCanvasDrawer, MiniCanvasDrawerInput } from "./mini_canvas_drawer"; @@ -36,7 +36,7 @@ import { MiniCanvasDrawer, MiniCanvasDrawerInput } from "./mini_canvas_drawer"; `] }) export class MiniTimelineComponent { - + @Input() timelineData!: TimelineData; @Input() currentTimestamp!: Timestamp; @Input() selectedTraces!: TraceType[]; @@ -49,15 +49,13 @@ export class MiniTimelineComponent { return this.canvasRef.nativeElement; } - constructor(@Inject(TimelineCoordinator) private timelineCoordinator: TimelineCoordinator) {} - private drawer: MiniCanvasDrawer|undefined = undefined; ngAfterViewInit(): void { this.makeHiPPICanvas(); const updateTimestampCallback = (position: bigint) => { - const timestampType = this.timelineCoordinator.getTimestampType()!; + const timestampType = this.timelineData.getTimestampType()!; this.changeSeekTimestamp.emit(undefined); this.changeTimestamp.emit(new Timestamp(timestampType, position)); }; @@ -66,13 +64,13 @@ export class MiniTimelineComponent { this.canvas, () => this.getMiniCanvasDrawerInput(), (position) => { - const timestampType = this.timelineCoordinator.getTimestampType()!; + const timestampType = this.timelineData.getTimestampType()!; this.changeSeekTimestamp.emit(new Timestamp(timestampType, position)); }, updateTimestampCallback, (selection) => { - const timestampType = this.timelineCoordinator.getTimestampType()!; - this.timelineCoordinator.setSelection({ + const timestampType = this.timelineData.getTimestampType()!; + this.timelineData.setSelectionRange({ from: new Timestamp(timestampType, selection.from), to: new Timestamp(timestampType, selection.to) }); @@ -91,13 +89,13 @@ export class MiniTimelineComponent { private getMiniCanvasDrawerInput() { return new MiniCanvasDrawerInput( { - from: this.timelineCoordinator.fullRange.from.getValueNs(), - to: this.timelineCoordinator.fullRange.to.getValueNs() + from: this.timelineData.getFullRange().from.getValueNs(), + to: this.timelineData.getFullRange().to.getValueNs() }, this.currentTimestamp.getValueNs(), { - from: this.timelineCoordinator.selection.from.getValueNs(), - to: this.timelineCoordinator.selection.to.getValueNs() + from: this.timelineData.getSelectionRange().from.getValueNs(), + to: this.timelineData.getSelectionRange().to.getValueNs() }, this.getTimelinesToShow() ); @@ -106,7 +104,7 @@ export class MiniTimelineComponent { private getTimelinesToShow() { const timelines = new Map(); for (const type of this.selectedTraces) { - timelines.set(type, this.timelineCoordinator.getTimelines().get(type)!.map(it => it.getValueNs())); + timelines.set(type, this.timelineData.getTimelines().get(type)!.map(it => it.getValueNs())); } return timelines; } diff --git a/tools/winscope-ng/src/app/components/timeline/timeline.component.spec.ts b/tools/winscope-ng/src/app/components/timeline/timeline.component.spec.ts index 5821bb7c3..5c2804fba 100644 --- a/tools/winscope-ng/src/app/components/timeline/timeline.component.spec.ts +++ b/tools/winscope-ng/src/app/components/timeline/timeline.component.spec.ts @@ -25,13 +25,15 @@ import {MatDrawer, MatDrawerContainer, MatDrawerContent} from "app/components/bo import {TimelineComponent} from "./timeline.component"; import {ExpandedTimelineComponent} from "./expanded_timeline.component"; import {MiniTimelineComponent} from "./mini_timeline.component"; -import {TimelineCoordinator} from "app/timeline_coordinator"; +import {TimelineData} from "app/timeline_data"; import {TraceType} from "common/trace/trace_type"; import {RealTimestamp, Timestamp} from "common/trace/timestamp"; import {By} from "@angular/platform-browser"; import {BrowserAnimationsModule} from "@angular/platform-browser/animations"; import {MatInputModule} from "@angular/material/input"; import { SingleTimelineComponent } from "./single_timeline.component"; +import {Mediator} from "app/mediator"; +import {TraceData} from "app/trace_data"; describe("TimelineComponent", () => { let fixture: ComponentFixture; @@ -40,9 +42,6 @@ describe("TimelineComponent", () => { beforeEach(async () => { await TestBed.configureTestingModule({ - providers: [ - TimelineCoordinator - ], imports: [ FormsModule, MatButtonModule, @@ -68,6 +67,11 @@ describe("TimelineComponent", () => { fixture = TestBed.createComponent(TimelineComponent); component = fixture.componentInstance; htmlElement = fixture.nativeElement; + + const traceData = new TraceData(); + const timelineData = new TimelineData(); + component.mediator = new Mediator(traceData, timelineData); + component.timelineData = timelineData; }); it("can be created", () => { @@ -76,10 +80,10 @@ describe("TimelineComponent", () => { it("can be expanded", () => { const timestamps = [timestamp(100), timestamp(110)]; - component.timelineCoordinator.setTimelines([{ + component.timelineData.initialize([{ traceType: TraceType.SURFACE_FLINGER, timestamps: timestamps - }]); + }], undefined); fixture.detectChanges(); const button = htmlElement.querySelector(`.${component.TOGGLE_BUTTON_CLASS}`); @@ -100,10 +104,10 @@ describe("TimelineComponent", () => { it("handles no timestamps", () => { const timestamps: Timestamp[] = []; - component.timelineCoordinator.setTimelines([{ + component.timelineData.initialize([{ traceType: TraceType.SURFACE_FLINGER, timestamps: timestamps - }]); + }], undefined); fixture.detectChanges(); // no expand button @@ -121,22 +125,22 @@ describe("TimelineComponent", () => { }); it("processes active trace input and updates selected traces", () => { - component.activeTrace = TraceType.SURFACE_FLINGER; + component.activeViewTraceTypes = [TraceType.SURFACE_FLINGER]; expect(component.wrappedActiveTrace).toEqual(TraceType.SURFACE_FLINGER); expect(component.selectedTraces).toEqual([TraceType.SURFACE_FLINGER]); - component.activeTrace = TraceType.SURFACE_FLINGER; + component.activeViewTraceTypes = [TraceType.SURFACE_FLINGER]; expect(component.wrappedActiveTrace).toEqual(TraceType.SURFACE_FLINGER); expect(component.selectedTraces).toEqual([TraceType.SURFACE_FLINGER]); - component.activeTrace = TraceType.TRANSACTIONS; + component.activeViewTraceTypes = [TraceType.TRANSACTIONS]; expect(component.wrappedActiveTrace).toEqual(TraceType.TRANSACTIONS); expect(component.selectedTraces).toEqual([ TraceType.SURFACE_FLINGER, TraceType.TRANSACTIONS ]); - component.activeTrace = TraceType.WINDOW_MANAGER; + component.activeViewTraceTypes = [TraceType.WINDOW_MANAGER]; expect(component.wrappedActiveTrace).toEqual(TraceType.WINDOW_MANAGER); expect(component.selectedTraces).toEqual([ TraceType.SURFACE_FLINGER, @@ -144,7 +148,7 @@ describe("TimelineComponent", () => { TraceType.WINDOW_MANAGER ]); - component.activeTrace = TraceType.PROTO_LOG; + component.activeViewTraceTypes = [TraceType.PROTO_LOG]; expect(component.wrappedActiveTrace).toEqual(TraceType.PROTO_LOG); expect(component.selectedTraces).toEqual([ TraceType.TRANSACTIONS, @@ -154,174 +158,178 @@ describe("TimelineComponent", () => { }); it("handles undefined active trace input", () => { - component.activeTrace = undefined; + component.activeViewTraceTypes = undefined; expect(component.wrappedActiveTrace).toBeUndefined(); expect(component.selectedTraces).toEqual([]); - component.activeTrace = TraceType.SURFACE_FLINGER; + component.activeViewTraceTypes = [TraceType.SURFACE_FLINGER]; expect(component.wrappedActiveTrace).toEqual(TraceType.SURFACE_FLINGER); expect(component.selectedTraces).toEqual([TraceType.SURFACE_FLINGER]); - component.activeTrace = undefined; + component.activeViewTraceTypes = undefined; expect(component.wrappedActiveTrace).toEqual(TraceType.SURFACE_FLINGER); expect(component.selectedTraces).toEqual([TraceType.SURFACE_FLINGER]); }); it("handles some traces with no timestamps", () => { - component.timelineCoordinator.setTimelines([{ + component.timelineData.initialize([{ traceType: TraceType.SURFACE_FLINGER, timestamps: [] }, { traceType: TraceType.WINDOW_MANAGER, timestamps: [timestamp(100)] - }]); + }], undefined); fixture.detectChanges(); }); it("next button disabled if no next entry", () => { - component.timelineCoordinator.setTimelines([{ + component.timelineData.initialize([{ traceType: TraceType.SURFACE_FLINGER, timestamps: [timestamp(100), timestamp(110)] }, { traceType: TraceType.WINDOW_MANAGER, timestamps: [timestamp(90), timestamp(101), timestamp(110), timestamp(112)] - }]); - component.activeTrace = TraceType.SURFACE_FLINGER; + }], undefined); + component.activeViewTraceTypes = [TraceType.SURFACE_FLINGER]; + component.timelineData.setCurrentTimestamp(timestamp(100)); fixture.detectChanges(); - expect(component.timelineCoordinator.currentTimestamp?.getValueNs()).toEqual(100n); + expect(component.timelineData.getCurrentTimestamp()?.getValueNs()).toEqual(100n); const nextEntryButton = fixture.debugElement.query(By.css("#next_entry_button")); expect(nextEntryButton).toBeTruthy(); expect(nextEntryButton.nativeElement.getAttribute("disabled")).toBeFalsy(); - component.timelineCoordinator.updateCurrentTimestamp(timestamp(90)); + component.timelineData.setCurrentTimestamp(timestamp(90)); fixture.detectChanges(); expect(nextEntryButton.nativeElement.getAttribute("disabled")).toBeFalsy(); - component.timelineCoordinator.updateCurrentTimestamp(timestamp(110)); + component.timelineData.setCurrentTimestamp(timestamp(110)); fixture.detectChanges(); expect(nextEntryButton.nativeElement.getAttribute("disabled")).toBeTruthy(); - component.timelineCoordinator.updateCurrentTimestamp(timestamp(112)); + component.timelineData.setCurrentTimestamp(timestamp(112)); fixture.detectChanges(); expect(nextEntryButton.nativeElement.getAttribute("disabled")).toBeTruthy(); }); it("prev button disabled if no prev entry", () => { - component.timelineCoordinator.setTimelines([{ + component.timelineData.initialize([{ traceType: TraceType.SURFACE_FLINGER, timestamps: [timestamp(100), timestamp(110)] }, { traceType: TraceType.WINDOW_MANAGER, timestamps: [timestamp(90), timestamp(101), timestamp(110), timestamp(112)] - }]); - component.activeTrace = TraceType.SURFACE_FLINGER; + }], undefined); + component.activeViewTraceTypes = [TraceType.SURFACE_FLINGER]; + component.timelineData.setCurrentTimestamp(timestamp(100)); fixture.detectChanges(); - expect(component.timelineCoordinator.currentTimestamp?.getValueNs()).toEqual(100n); + expect(component.timelineData.getCurrentTimestamp()?.getValueNs()).toEqual(100n); const prevEntryButton = fixture.debugElement.query(By.css("#prev_entry_button")); expect(prevEntryButton).toBeTruthy(); expect(prevEntryButton.nativeElement.getAttribute("disabled")).toBeTruthy(); - component.timelineCoordinator.updateCurrentTimestamp(timestamp(90)); + component.timelineData.setCurrentTimestamp(timestamp(90)); fixture.detectChanges(); expect(prevEntryButton.nativeElement.getAttribute("disabled")).toBeTruthy(); - component.timelineCoordinator.updateCurrentTimestamp(timestamp(110)); + component.timelineData.setCurrentTimestamp(timestamp(110)); fixture.detectChanges(); expect(prevEntryButton.nativeElement.getAttribute("disabled")).toBeFalsy(); - component.timelineCoordinator.updateCurrentTimestamp(timestamp(112)); + component.timelineData.setCurrentTimestamp(timestamp(112)); fixture.detectChanges(); expect(prevEntryButton.nativeElement.getAttribute("disabled")).toBeFalsy(); }); it("changes timestamp on next entry button press", () => { - component.timelineCoordinator.setTimelines([{ + component.timelineData.initialize([{ traceType: TraceType.SURFACE_FLINGER, timestamps: [timestamp(100), timestamp(110)] }, { traceType: TraceType.WINDOW_MANAGER, timestamps: [timestamp(90), timestamp(101), timestamp(110), timestamp(112)] - }]); - component.activeTrace = TraceType.SURFACE_FLINGER; + }], undefined); + component.activeViewTraceTypes = [TraceType.SURFACE_FLINGER]; + component.timelineData.setCurrentTimestamp(timestamp(100)); fixture.detectChanges(); - expect(component.timelineCoordinator.currentTimestamp?.getValueNs()).toEqual(100n); + expect(component.timelineData.getCurrentTimestamp()?.getValueNs()).toEqual(100n); const nextEntryButton = fixture.debugElement.query(By.css("#next_entry_button")); expect(nextEntryButton).toBeTruthy(); - component.timelineCoordinator.updateCurrentTimestamp(timestamp(105)); + component.timelineData.setCurrentTimestamp(timestamp(105)); fixture.detectChanges(); nextEntryButton.nativeElement.click(); - expect(component.timelineCoordinator.currentTimestamp?.getValueNs()).toEqual(110n); + expect(component.timelineData.getCurrentTimestamp()?.getValueNs()).toEqual(110n); - component.timelineCoordinator.updateCurrentTimestamp(timestamp(100)); + component.timelineData.setCurrentTimestamp(timestamp(100)); fixture.detectChanges(); nextEntryButton.nativeElement.click(); - expect(component.timelineCoordinator.currentTimestamp?.getValueNs()).toEqual(110n); + expect(component.timelineData.getCurrentTimestamp()?.getValueNs()).toEqual(110n); - component.timelineCoordinator.updateCurrentTimestamp(timestamp(90)); + component.timelineData.setCurrentTimestamp(timestamp(90)); fixture.detectChanges(); nextEntryButton.nativeElement.click(); - expect(component.timelineCoordinator.currentTimestamp?.getValueNs()).toEqual(100n); + expect(component.timelineData.getCurrentTimestamp()?.getValueNs()).toEqual(100n); // No change when we are already on the last timestamp of the active trace - component.timelineCoordinator.updateCurrentTimestamp(timestamp(110)); + component.timelineData.setCurrentTimestamp(timestamp(110)); fixture.detectChanges(); nextEntryButton.nativeElement.click(); - expect(component.timelineCoordinator.currentTimestamp?.getValueNs()).toEqual(110n); + expect(component.timelineData.getCurrentTimestamp()?.getValueNs()).toEqual(110n); // No change when we are after the last entry of the active trace - component.timelineCoordinator.updateCurrentTimestamp(timestamp(112)); + component.timelineData.setCurrentTimestamp(timestamp(112)); fixture.detectChanges(); nextEntryButton.nativeElement.click(); - expect(component.timelineCoordinator.currentTimestamp?.getValueNs()).toEqual(112n); + expect(component.timelineData.getCurrentTimestamp()?.getValueNs()).toEqual(112n); }); it("changes timestamp on previous entry button press", () => { - component.timelineCoordinator.setTimelines([{ + component.timelineData.initialize([{ traceType: TraceType.SURFACE_FLINGER, timestamps: [timestamp(100), timestamp(110)] }, { traceType: TraceType.WINDOW_MANAGER, timestamps: [timestamp(90), timestamp(101), timestamp(110), timestamp(112)] - }]); - component.activeTrace = TraceType.SURFACE_FLINGER; + }], undefined); + component.activeViewTraceTypes = [TraceType.SURFACE_FLINGER]; + component.timelineData.setCurrentTimestamp(timestamp(100)); fixture.detectChanges(); - expect(component.timelineCoordinator.currentTimestamp?.getValueNs()).toEqual(100n); + expect(component.timelineData.getCurrentTimestamp()?.getValueNs()).toEqual(100n); const prevEntryButton = fixture.debugElement.query(By.css("#prev_entry_button")); expect(prevEntryButton).toBeTruthy(); // In this state we are already on the first entry at timestamp 100, so // there is no entry to move to before and we just don't update the timestamp - component.timelineCoordinator.updateCurrentTimestamp(timestamp(105)); + component.timelineData.setCurrentTimestamp(timestamp(105)); fixture.detectChanges(); prevEntryButton.nativeElement.click(); - expect(component.timelineCoordinator.currentTimestamp?.getValueNs()).toEqual(105n); + expect(component.timelineData.getCurrentTimestamp()?.getValueNs()).toEqual(105n); - component.timelineCoordinator.updateCurrentTimestamp(timestamp(110)); + component.timelineData.setCurrentTimestamp(timestamp(110)); fixture.detectChanges(); prevEntryButton.nativeElement.click(); - expect(component.timelineCoordinator.currentTimestamp?.getValueNs()).toEqual(100n); + expect(component.timelineData.getCurrentTimestamp()?.getValueNs()).toEqual(100n); // Active entry here should be 110 so moving back means moving to 100. - component.timelineCoordinator.updateCurrentTimestamp(timestamp(112)); + component.timelineData.setCurrentTimestamp(timestamp(112)); fixture.detectChanges(); prevEntryButton.nativeElement.click(); - expect(component.timelineCoordinator.currentTimestamp?.getValueNs()).toEqual(100n); + expect(component.timelineData.getCurrentTimestamp()?.getValueNs()).toEqual(100n); // No change when we are already on the first timestamp of the active trace - component.timelineCoordinator.updateCurrentTimestamp(timestamp(100)); + component.timelineData.setCurrentTimestamp(timestamp(100)); fixture.detectChanges(); prevEntryButton.nativeElement.click(); - expect(component.timelineCoordinator.currentTimestamp?.getValueNs()).toEqual(100n); + expect(component.timelineData.getCurrentTimestamp()?.getValueNs()).toEqual(100n); // No change when we are before the first entry of the active trace - component.timelineCoordinator.updateCurrentTimestamp(timestamp(90)); + component.timelineData.setCurrentTimestamp(timestamp(90)); fixture.detectChanges(); prevEntryButton.nativeElement.click(); - expect(component.timelineCoordinator.currentTimestamp?.getValueNs()).toEqual(90n); + expect(component.timelineData.getCurrentTimestamp()?.getValueNs()).toEqual(90n); }); }); diff --git a/tools/winscope-ng/src/app/components/timeline/timeline.component.ts b/tools/winscope-ng/src/app/components/timeline/timeline.component.ts index fa0372a77..895d4fdad 100644 --- a/tools/winscope-ng/src/app/components/timeline/timeline.component.ts +++ b/tools/winscope-ng/src/app/components/timeline/timeline.component.ts @@ -30,9 +30,11 @@ import { FormControl, FormGroup, Validators} from "@angular/forms"; import { DomSanitizer, SafeUrl } from "@angular/platform-browser"; import { TraceType } from "common/trace/trace_type"; import { TRACE_INFO } from "app/trace_info"; -import { TimelineCoordinator, TimestampChangeObserver } from "app/timeline_coordinator"; +import { Mediator } from "app/mediator"; +import { TimelineData } from "app/timeline_data"; import { MiniTimelineComponent } from "./mini_timeline.component"; import { Timestamp, TimestampType } from "common/trace/timestamp"; +import { FunctionUtils } from "common/utils/function_utils"; import { TimeUtils } from "common/utils/time_utils"; @Component({ @@ -42,24 +44,25 @@ import { TimeUtils } from "common/utils/time_utils";
-
+

No screenrecording frame to show

Current timestamp before first screenrecording frame.

- +
-
+
-
+

No timeline to show!

All loaded traces contain no timestamps!

-
+

No timeline to show!

Only a single timestamp has been recorded.

@@ -268,19 +272,23 @@ import { TimeUtils } from "common/utils/time_utils"; } `], }) -export class TimelineComponent implements TimestampChangeObserver { +export class TimelineComponent { public readonly TOGGLE_BUTTON_CLASS: string = "button-toggle-expansion"; public readonly MAX_SELECTED_TRACES = 3; - @Input() set activeTrace(trace: TraceType|undefined) { - if (!trace) { + @Input() set activeViewTraceTypes(types: TraceType[]|undefined) { + if (!types) { return; } - this.wrappedActiveTrace = trace; + if (types.length !== 1) { + throw Error("Timeline component doesn't support viewers with dependencies length !== 1"); + } - if (!this.selectedTraces.includes(trace)) { - this.selectedTraces.push(trace); + this.wrappedActiveTrace = types[0]; + + if (!this.selectedTraces.includes(this.wrappedActiveTrace)) { + this.selectedTraces.push(this.wrappedActiveTrace); } if (this.selectedTraces.length > this.MAX_SELECTED_TRACES) { @@ -292,16 +300,11 @@ export class TimelineComponent implements TimestampChangeObserver { } public wrappedActiveTrace: TraceType|undefined = undefined; + @Input() mediator!: Mediator; + @Input() timelineData!: TimelineData; @Input() availableTraces: TraceType[] = []; - @Input() set videoData(value: Blob|undefined) { - if (value !== undefined) { - this.videoUrl = this.sanitizer.bypassSecurityTrustUrl(URL.createObjectURL(value)); - } else { - this.videoUrl = undefined; - } - } - @Output() onCollapsedTimelineSizeChanged = new EventEmitter(); + @Output() collapsedTimelineSizeChanged = new EventEmitter(); @ViewChild("miniTimeline") private miniTimelineComponent!: MiniTimelineComponent; @ViewChild("collapsedTimeline") private collapsedTimelineRef!: ElementRef; @@ -330,30 +333,50 @@ export class TimelineComponent implements TimestampChangeObserver { TRACE_INFO = TRACE_INFO; - get hasVideo() { - return this.timelineCoordinator.getTimelines().get(TraceType.SCREEN_RECORDING) !== undefined; + constructor( + @Inject(DomSanitizer) private sanitizer: DomSanitizer, + @Inject(ChangeDetectorRef) private changeDetectorRef: ChangeDetectorRef) { } - get videoCurrentTime() { - return this.timelineCoordinator.timestampAsElapsedScreenrecordingSeconds(this.currentTimestamp); + ngOnInit() { + this.mediator.setNotifyCurrentTimestampChangedToTimelineComponentCallback((timestamp: Timestamp|undefined) => { + this.onCurrentTimestampChanged(timestamp); + }); + + if (this.timelineData.hasTimestamps()) { + this.updateTimeInputValuesToCurrentTimestamp(); + } + + const screenRecordingVideo = this.timelineData.getScreenRecordingVideo(); + if (screenRecordingVideo) { + this.videoUrl = + this.sanitizer.bypassSecurityTrustUrl(URL.createObjectURL(screenRecordingVideo)); + } + } + + ngOnDestroy() { + this.mediator.setNotifyCurrentTimestampChangedToTimelineComponentCallback( + FunctionUtils.DO_NOTHING + ); + } + + ngAfterViewInit() { + const height = this.collapsedTimelineRef.nativeElement.offsetHeight; + this.collapsedTimelineSizeChanged.emit(height); + } + + getVideoCurrentTime() { + return this.timelineData.searchCorrespondingScreenRecordingTimeSeconds(this.currentTimestamp); } private seekTimestamp: Timestamp|undefined; - hasTimestamps(): boolean { - return this.timelineCoordinator.getAllUniqueTimestamps().length > 0; - } - - hasMoreThanOneDistinctTimestamp(): boolean { - return this.timelineCoordinator.getAllUniqueTimestamps().length > 1; - } - get currentTimestamp(): Timestamp { if (this.seekTimestamp !== undefined) { return this.seekTimestamp; } - const timestamp = this.timelineCoordinator.currentTimestamp; + const timestamp = this.timelineData.getCurrentTimestamp(); if (timestamp === undefined) { throw Error("A timestamp should have been set by the time the timeline is loaded"); } @@ -361,22 +384,6 @@ export class TimelineComponent implements TimestampChangeObserver { return timestamp; } - constructor( - @Inject(TimelineCoordinator) public timelineCoordinator: TimelineCoordinator, - @Inject(DomSanitizer) private sanitizer: DomSanitizer, - @Inject(ChangeDetectorRef) private changeDetectorRef: ChangeDetectorRef) { - this.timelineCoordinator.registerObserver(this); - } - - ngOnDestroy() { - this.timelineCoordinator.unregisterObserver(this); - } - - ngAfterViewInit() { - const height = this.collapsedTimelineRef.nativeElement.offsetHeight; - this.onCollapsedTimelineSizeChanged.emit(height); - } - onCurrentTimestampChanged(timestamp: Timestamp|undefined): void { if (!timestamp) { return; @@ -390,11 +397,11 @@ export class TimelineComponent implements TimestampChangeObserver { } updateCurrentTimestamp(timestamp: Timestamp) { - this.timelineCoordinator.updateCurrentTimestamp(timestamp); + this.timelineData.setCurrentTimestamp(timestamp); } usingRealtime(): boolean { - return this.timelineCoordinator.getTimestampType() === TimestampType.REAL; + return this.timelineData.getTimestampType() === TimestampType.REAL; } updateSeekTimestamp(timestamp: Timestamp|undefined) { @@ -446,32 +453,32 @@ export class TimelineComponent implements TimestampChangeObserver { hasPrevEntry(): boolean { if (!this.wrappedActiveTrace || - (this.timelineCoordinator.getTimelines().get(this.wrappedActiveTrace)?.length ?? 0) === 0) { + (this.timelineData.getTimelines().get(this.wrappedActiveTrace)?.length ?? 0) === 0) { return false; } - return this.timelineCoordinator.getPreviousTimestampFor(this.wrappedActiveTrace) !== undefined; + return this.timelineData.getPreviousTimestampFor(this.wrappedActiveTrace) !== undefined; } hasNextEntry(): boolean { if (!this.wrappedActiveTrace || - (this.timelineCoordinator.getTimelines().get(this.wrappedActiveTrace)?.length ?? 0) === 0) { + (this.timelineData.getTimelines().get(this.wrappedActiveTrace)?.length ?? 0) === 0) { return false; } - return this.timelineCoordinator.getNextTimestampFor(this.wrappedActiveTrace) !== undefined; + return this.timelineData.getNextTimestampFor(this.wrappedActiveTrace) !== undefined; } moveToPreviousEntry() { if (!this.wrappedActiveTrace) { return; } - this.timelineCoordinator.moveToPreviousEntryFor(this.wrappedActiveTrace); + this.timelineData.moveToPreviousTimestampFor(this.wrappedActiveTrace); } moveToNextEntry() { if (!this.wrappedActiveTrace) { return; } - this.timelineCoordinator.moveToNextEntryFor(this.wrappedActiveTrace); + this.timelineData.moveToNextTimestampFor(this.wrappedActiveTrace); } humanElapsedTimeInputChange(event: Event) { @@ -479,9 +486,9 @@ export class TimelineComponent implements TimestampChangeObserver { return; } const target = event.target as HTMLInputElement; - const timestamp = new Timestamp(this.timelineCoordinator.getTimestampType()!, + const timestamp = new Timestamp(this.timelineData.getTimestampType()!, TimeUtils.humanElapsedToNanoseconds(target.value)); - this.timelineCoordinator.updateCurrentTimestamp(timestamp); + this.timelineData.setCurrentTimestamp(timestamp); this.updateTimeInputValuesToCurrentTimestamp(); } @@ -491,9 +498,9 @@ export class TimelineComponent implements TimestampChangeObserver { } const target = event.target as HTMLInputElement; - const timestamp = new Timestamp(this.timelineCoordinator.getTimestampType()!, + const timestamp = new Timestamp(this.timelineData.getTimestampType()!, TimeUtils.humanRealToNanoseconds(target.value)); - this.timelineCoordinator.updateCurrentTimestamp(timestamp); + this.timelineData.setCurrentTimestamp(timestamp); this.updateTimeInputValuesToCurrentTimestamp(); } @@ -503,8 +510,8 @@ export class TimelineComponent implements TimestampChangeObserver { } const target = event.target as HTMLInputElement; - const timestamp = new Timestamp(this.timelineCoordinator.getTimestampType()!, BigInt(target.value)); - this.timelineCoordinator.updateCurrentTimestamp(timestamp); + const timestamp = new Timestamp(this.timelineData.getTimestampType()!, BigInt(target.value)); + this.timelineData.setCurrentTimestamp(timestamp); this.updateTimeInputValuesToCurrentTimestamp(); } } diff --git a/tools/winscope-ng/src/app/components/timeline/utils.ts b/tools/winscope-ng/src/app/components/timeline/utils.ts index b59cff917..782f0c806 100644 --- a/tools/winscope-ng/src/app/components/timeline/utils.ts +++ b/tools/winscope-ng/src/app/components/timeline/utils.ts @@ -14,15 +14,8 @@ * limitations under the License. */ -import { Timestamp } from "common/trace/timestamp"; import { TraceType } from "common/trace/trace_type"; export type Segment = { from: number, to: number } export type BigIntSegment = { from: bigint, to: bigint } -export type TimeRange = { from: Timestamp, to: Timestamp } -export type MiniTimelineData = { - width: bigint, - selection: BigIntSegment - traceSegments: Map -} -export type TimelineData = Map \ No newline at end of file +export type TimelineData = Map diff --git a/tools/winscope-ng/src/app/components/upload_traces.component.spec.ts b/tools/winscope-ng/src/app/components/upload_traces.component.spec.ts index 430470d0e..3670fc2a3 100644 --- a/tools/winscope-ng/src/app/components/upload_traces.component.spec.ts +++ b/tools/winscope-ng/src/app/components/upload_traces.component.spec.ts @@ -17,8 +17,7 @@ import {ComponentFixture, TestBed} from "@angular/core/testing"; import {UploadTracesComponent} from "./upload_traces.component"; import { MatCardModule } from "@angular/material/card"; import { MatSnackBar, MatSnackBarModule } from "@angular/material/snack-bar"; -import { TraceCoordinator } from "app/trace_coordinator"; -import { TimelineCoordinator } from "app/timeline_coordinator"; +import {TraceData} from "app/trace_data"; describe("UploadTracesComponent", () => { let fixture: ComponentFixture; @@ -40,8 +39,8 @@ describe("UploadTracesComponent", () => { fixture = TestBed.createComponent(UploadTracesComponent); component = fixture.componentInstance; htmlElement = fixture.nativeElement; - const timelineCoordinator = new TimelineCoordinator(); - component.traceCoordinator = new TraceCoordinator(timelineCoordinator); + const traceData = new TraceData(); + component.traceData = traceData; }); it("can be created", () => { diff --git a/tools/winscope-ng/src/app/components/upload_traces.component.ts b/tools/winscope-ng/src/app/components/upload_traces.component.ts index bfaff1a6a..4d8c209c6 100644 --- a/tools/winscope-ng/src/app/components/upload_traces.component.ts +++ b/tools/winscope-ng/src/app/components/upload_traces.component.ts @@ -13,13 +13,21 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -import { Component, Input, Output, EventEmitter, Inject, NgZone } from "@angular/core"; -import { TraceCoordinator } from "app/trace_coordinator"; -import { TRACE_INFO } from "app/trace_info"; -import { LoadedTrace } from "app/loaded_trace"; +import { + Component, + Input, + Output, + EventEmitter, + Inject, + NgZone, + ChangeDetectorRef} from "@angular/core"; import { MatSnackBar } from "@angular/material/snack-bar"; -import { ParserErrorSnackBarComponent } from "./parser_error_snack_bar_component"; +import { TraceData} from "app/trace_data"; +import { TRACE_INFO } from "app/trace_info"; +import {Trace} from "common/trace/trace"; +import {FileUtils} from "common/utils/file_utils"; import { ParserError } from "parsers/parser_factory"; +import { ParserErrorSnackBarComponent } from "./parser_error_snack_bar_component"; @Component({ selector: "upload-traces", @@ -44,14 +52,15 @@ import { ParserError } from "parsers/parser_factory"; (change)="onInputFile($event)" /> - - + + {{TRACE_INFO[trace.type].icon}}

- {{trace.name}} ({{TRACE_INFO[trace.type].name}}) + {{trace.file.name}} ({{TRACE_INFO[trace.type].name}})

@@ -79,7 +88,7 @@ import { ParserError } from "parsers/parser_factory"; Upload another file -
@@ -135,14 +144,14 @@ import { ParserError } from "parsers/parser_factory"; ] }) export class UploadTracesComponent { - loadedTraces: LoadedTrace[] = []; + loadedTraces: Trace[] = []; TRACE_INFO = TRACE_INFO; - dataLoaded = false; - @Input() traceCoordinator!: TraceCoordinator; - @Output() dataLoadedChange = new EventEmitter(); + @Input() traceData!: TraceData; + @Output() traceDataLoaded = new EventEmitter(); constructor( + @Inject(ChangeDetectorRef) private changeDetectorRef: ChangeDetectorRef, @Inject(NgZone) private ngZone: NgZone, @Inject(MatSnackBar) private snackBar: MatSnackBar ) {} @@ -153,26 +162,22 @@ export class UploadTracesComponent { } public async processFiles(files: File[]) { - const unzippedFiles = await this.traceCoordinator.getUnzippedFiles(files); - const parserErrors = await this.traceCoordinator.setTraces(unzippedFiles); + const unzippedFiles = await FileUtils.unzipFilesIfNeeded(files); + const parserErrors = await this.traceData.loadTraces(unzippedFiles); if (parserErrors.length > 0) { this.openTempSnackBar(parserErrors); } this.ngZone.run(() => { - this.loadedTraces = this.traceCoordinator.getLoadedTraces(); + this.loadedTraces = this.traceData.getLoadedTraces(); }); } - public onLoadData() { - this.dataLoaded = true; - this.dataLoadedChange.emit(this.dataLoaded); + public onViewTracesButtonClick() { + this.traceDataLoaded.emit(); } - public onClearData() { - this.traceCoordinator.clearData(); - this.dataLoaded = false; - this.loadedTraces = []; - this.dataLoadedChange.emit(this.dataLoaded); + public onClearButtonClick() { + this.traceData.clear(); } public onFileDragIn(e: DragEvent) { @@ -193,11 +198,11 @@ export class UploadTracesComponent { await this.processFiles(Array.from(droppedFiles)); } - public onRemoveTrace(event: MouseEvent, trace: LoadedTrace) { + public onRemoveTrace(event: MouseEvent, trace: Trace) { event.preventDefault(); event.stopPropagation(); - this.traceCoordinator.removeTrace(trace.type); - this.loadedTraces = this.loadedTraces.filter(loaded => loaded.type !== trace.type); + this.traceData.removeTrace(trace.type); + this.changeDetectorRef.detectChanges(); } private openTempSnackBar(parserErrors: ParserError[]) { diff --git a/tools/winscope-ng/src/app/loaded_trace.ts b/tools/winscope-ng/src/app/loaded_trace.ts deleted file mode 100644 index 83cbfcdd6..000000000 --- a/tools/winscope-ng/src/app/loaded_trace.ts +++ /dev/null @@ -1,6 +0,0 @@ -import { TraceType } from "common/trace/trace_type"; - -export interface LoadedTrace { - name: string; - type: TraceType; -} diff --git a/tools/winscope-ng/src/app/mediator.spec.ts b/tools/winscope-ng/src/app/mediator.spec.ts new file mode 100644 index 000000000..88dfe236d --- /dev/null +++ b/tools/winscope-ng/src/app/mediator.spec.ts @@ -0,0 +1,111 @@ +/* + * Copyright (C) 2022 The Android Open Source Project + * + * 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 {Timestamp, TimestampType} from "common/trace/timestamp"; +import {Mediator} from "./mediator"; +import {UnitTestUtils} from "test/unit/utils"; +import {ViewerFactory} from "viewers/viewer_factory"; +import {ViewerStub} from "viewers/viewer_stub"; +import {TimelineData} from "./timeline_data"; +import {TraceData} from "./trace_data"; +import {MockStorage} from "test/unit/mock_storage"; + +class TimelineComponentStub { + onCurrentTimestampChanged(timestamp: Timestamp|undefined) { + // do nothing + } +} + +describe("Mediator", () => { + const viewerStub = new ViewerStub("Title"); + let timelineComponent: TimelineComponentStub; + let traceData: TraceData; + let timelineData: TimelineData; + let mediator: Mediator; + + beforeEach(async () => { + timelineComponent = new TimelineComponentStub(); + traceData = new TraceData(); + timelineData = new TimelineData(); + mediator = new Mediator(traceData, timelineData); + mediator.setNotifyCurrentTimestampChangedToTimelineComponentCallback(timestamp => { + timelineComponent.onCurrentTimestampChanged(timestamp); + }); + + spyOn(ViewerFactory.prototype, "createViewers").and.returnValue([viewerStub]); + }); + + it("initializes TimelineData on data load event", async () => { + spyOn(timelineData, "initialize").and.callThrough(); + + await loadTraces(); + expect(timelineData.initialize).toHaveBeenCalledTimes(0); + + mediator.onTraceDataLoaded(new MockStorage()); + expect(timelineData.initialize).toHaveBeenCalledTimes(1); + }); + + + it("it creates viewers on data load event", async () => { + spyOn(viewerStub, "notifyCurrentTraceEntries"); + + await loadTraces(); + expect(mediator.getViewers()).toEqual([]); + + mediator.onTraceDataLoaded(new MockStorage()); + expect(mediator.getViewers()).toEqual([viewerStub]); + + // notifies viewer about current timestamp on creation + expect(viewerStub.notifyCurrentTraceEntries).toHaveBeenCalledTimes(1); + }); + + it("forwards timestamp changed events/notifications", async () => { + const timestamp10 = new Timestamp(TimestampType.REAL, 10n); + const timestamp11 = new Timestamp(TimestampType.REAL, 11n); + + await loadTraces(); + mediator.onTraceDataLoaded(new MockStorage()); + expect(mediator.getViewers()).toEqual([viewerStub]); + + spyOn(viewerStub, "notifyCurrentTraceEntries"); + spyOn(timelineComponent, "onCurrentTimestampChanged"); + expect(viewerStub.notifyCurrentTraceEntries).toHaveBeenCalledTimes(0); + expect(timelineComponent.onCurrentTimestampChanged).toHaveBeenCalledTimes(0); + + // notify timestamp + timelineData.setCurrentTimestamp(timestamp10); + expect(viewerStub.notifyCurrentTraceEntries).toHaveBeenCalledTimes(1); + expect(timelineComponent.onCurrentTimestampChanged).toHaveBeenCalledTimes(1); + + // notify timestamp again (no timestamp change) + timelineData.setCurrentTimestamp(timestamp10); + expect(viewerStub.notifyCurrentTraceEntries).toHaveBeenCalledTimes(1); + expect(timelineComponent.onCurrentTimestampChanged).toHaveBeenCalledTimes(1); + + // reset back to the default timestamp should trigger a change + timelineData.setCurrentTimestamp(timestamp11); + expect(viewerStub.notifyCurrentTraceEntries).toHaveBeenCalledTimes(2); + expect(timelineComponent.onCurrentTimestampChanged).toHaveBeenCalledTimes(2); + }); + + const loadTraces = async () => { + const traces = [ + await UnitTestUtils.getFixtureFile("traces/elapsed_and_real_timestamp/SurfaceFlinger.pb"), + await UnitTestUtils.getFixtureFile("traces/elapsed_and_real_timestamp/WindowManager.pb"), + await UnitTestUtils.getFixtureFile("traces/elapsed_and_real_timestamp/screen_recording_metadata_v2.mp4"), + ]; + const errors = await traceData.loadTraces(traces); + }; +}); diff --git a/tools/winscope-ng/src/app/mediator.ts b/tools/winscope-ng/src/app/mediator.ts new file mode 100644 index 000000000..3d0d92a04 --- /dev/null +++ b/tools/winscope-ng/src/app/mediator.ts @@ -0,0 +1,84 @@ +/* + * Copyright (C) 2022 The Android Open Source Project + * + * 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 {Timestamp} from "common/trace/timestamp"; +import {TraceType} from "common/trace/trace_type"; +import {FunctionUtils} from "common/utils/function_utils"; +import { Viewer } from "viewers/viewer"; +import { ViewerFactory } from "viewers/viewer_factory"; +import {TimelineData} from "./timeline_data"; +import {TraceData} from "./trace_data"; + +type CurrentTimestampChangedCallback = (timestamp: Timestamp|undefined) => void; + +class Mediator { + private traceData: TraceData; + private timelineData: TimelineData; + private viewers: Viewer[] = []; + private notifyCurrentTimestampChangedToTimelineComponent: CurrentTimestampChangedCallback = + FunctionUtils.DO_NOTHING; + + constructor(traceData: TraceData, timelineData: TimelineData) { + this.traceData = traceData; + this.timelineData = timelineData; + this.timelineData.setOnCurrentTimestampChangedCallback(timestamp => { + this.onCurrentTimestampChanged(timestamp); + }); + } + + public setNotifyCurrentTimestampChangedToTimelineComponentCallback(callback: CurrentTimestampChangedCallback) { + this.notifyCurrentTimestampChangedToTimelineComponent = callback; + } + + public getViewers(): Viewer[] { + return this.viewers; + } + + public onTraceDataLoaded(storage: Storage) { + this.timelineData.initialize( + this.traceData.getTimelines(), + this.traceData.getScreenRecordingVideo() + ); + this.createViewers(storage); + } + + public onCurrentTimestampChanged(timestamp: Timestamp|undefined) { + const entries = this.traceData.getTraceEntries(timestamp); + this.viewers.forEach(viewer => { + viewer.notifyCurrentTraceEntries(entries); + }); + + this.notifyCurrentTimestampChangedToTimelineComponent(timestamp); + } + + public clearData() { + this.traceData.clear(); + this.timelineData.clear(); + this.viewers = []; + } + + private createViewers(storage: Storage) { + const traceTypes = this.traceData.getLoadedTraces().map(trace => trace.type); + this.viewers = new ViewerFactory().createViewers(new Set(traceTypes), storage); + + // Make sure to update the viewers active entries as soon as they are created. + if (this.timelineData.getCurrentTimestamp()) { + this.onCurrentTimestampChanged(this.timelineData.getCurrentTimestamp()); + } + } +} + +export { Mediator }; diff --git a/tools/winscope-ng/src/app/timeline_coordinator.spec.ts b/tools/winscope-ng/src/app/timeline_coordinator.spec.ts deleted file mode 100644 index f57e47d2e..000000000 --- a/tools/winscope-ng/src/app/timeline_coordinator.spec.ts +++ /dev/null @@ -1,153 +0,0 @@ -/* - * Copyright (C) 2022 The Android Open Source Project - * - * 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 {Timestamp, TimestampType} from "common/trace/timestamp"; -import {TraceType} from "common/trace/trace_type"; -import {Timeline, TimelineCoordinator, TimestampChangeObserver} from "./timeline_coordinator"; - -class TimestampChangeObserverStub implements TimestampChangeObserver { - onCurrentTimestampChanged(timestamp: Timestamp): void { - // do nothing - function meant to be spied - } -} - -describe("TimelineCoordinator", () => { - let coordinator: TimelineCoordinator; - let observer: TimestampChangeObserver; - - const timestamp10 = new Timestamp(TimestampType.REAL, 10n); - const timestamp11 = new Timestamp(TimestampType.REAL, 11n); - - const timelines: Timeline[] = [{ - traceType: TraceType.SURFACE_FLINGER, - timestamps: [timestamp10] - }, - { - traceType: TraceType.WINDOW_MANAGER, - timestamps: [timestamp11] - }]; - - beforeEach(() => { - coordinator = new TimelineCoordinator(); - observer = new TimestampChangeObserverStub(); - coordinator.registerObserver(observer); - }); - - it("sets timelines", () => { - expect(coordinator.currentTimestamp).toBeUndefined(); - - coordinator.setTimelines(timelines); - expect(coordinator.currentTimestamp).toEqual(timestamp10); - }); - - it("removes timeline", () => { - coordinator.setTimelines(timelines); - expect(coordinator.currentTimestamp).toEqual(timestamp10); - - coordinator.removeTimeline(TraceType.SURFACE_FLINGER); - expect(coordinator.currentTimestamp).toEqual(timestamp11); - - coordinator.removeTimeline(TraceType.WINDOW_MANAGER); - expect(coordinator.currentTimestamp).toBeUndefined(); - }); - - it("removes timeline even if currently active", () => { - coordinator.setTimelines(timelines); - coordinator.setActiveTraceTypes([TraceType.WINDOW_MANAGER]); - coordinator.removeTimeline(TraceType.WINDOW_MANAGER); - expect(coordinator.currentTimestamp).toEqual(timestamp10); - }); - - it("sets active trace types and update timestamp", () => { - coordinator.setTimelines(timelines); - - coordinator.setActiveTraceTypes([]); - expect(coordinator.currentTimestamp).toEqual(timestamp10); - - coordinator.setActiveTraceTypes([TraceType.WINDOW_MANAGER]); - expect(coordinator.currentTimestamp).toEqual(timestamp11); - - coordinator.setActiveTraceTypes([TraceType.SURFACE_FLINGER]); - expect(coordinator.currentTimestamp).toEqual(timestamp10); - - coordinator.setActiveTraceTypes([TraceType.SURFACE_FLINGER, TraceType.WINDOW_MANAGER]); - expect(coordinator.currentTimestamp).toEqual(timestamp10); - }); - - it("sets/gets active trace types", () => { - coordinator.setTimelines(timelines); - expect(coordinator.getActiveTraceTypes()).toEqual([]); - - coordinator.setActiveTraceTypes([]); - expect(coordinator.getActiveTraceTypes()).toEqual([]); - - coordinator.setActiveTraceTypes([TraceType.WINDOW_MANAGER]); - expect(coordinator.getActiveTraceTypes()).toEqual([TraceType.WINDOW_MANAGER]); - - coordinator.setActiveTraceTypes([TraceType.SURFACE_FLINGER, TraceType.WINDOW_MANAGER]); - expect(coordinator.getActiveTraceTypes()).toEqual([ - TraceType.SURFACE_FLINGER, - TraceType.WINDOW_MANAGER - ]); - - coordinator.removeTimeline(TraceType.SURFACE_FLINGER); - expect(coordinator.getActiveTraceTypes()).toEqual([TraceType.WINDOW_MANAGER]); - - coordinator.removeTimeline(TraceType.WINDOW_MANAGER); - expect(coordinator.getActiveTraceTypes()).toEqual([]); - }); - - it("notifies observers when current timestamp changes", () => { - spyOn(observer, "onCurrentTimestampChanged"); - expect(observer.onCurrentTimestampChanged).toHaveBeenCalledTimes(0); - - coordinator.setTimelines(timelines); - expect(observer.onCurrentTimestampChanged).toHaveBeenCalledTimes(1); - - coordinator.setActiveTraceTypes([TraceType.WINDOW_MANAGER]); - expect(observer.onCurrentTimestampChanged).toHaveBeenCalledTimes(2); - - coordinator.removeTimeline(TraceType.WINDOW_MANAGER); - expect(observer.onCurrentTimestampChanged).toHaveBeenCalledTimes(3); - }); - - it("doesn't notify observers when current timestamp doesn't change", () => { - coordinator.setTimelines(timelines); - - spyOn(observer, "onCurrentTimestampChanged"); - expect(observer.onCurrentTimestampChanged).toHaveBeenCalledTimes(0); - - coordinator.setActiveTraceTypes([TraceType.SURFACE_FLINGER]); - expect(observer.onCurrentTimestampChanged).toHaveBeenCalledTimes(0); - - coordinator.setActiveTraceTypes([TraceType.SURFACE_FLINGER, TraceType.WINDOW_MANAGER]); - expect(observer.onCurrentTimestampChanged).toHaveBeenCalledTimes(0); - - coordinator.removeTimeline(TraceType.WINDOW_MANAGER); - expect(observer.onCurrentTimestampChanged).toHaveBeenCalledTimes(0); - }); - - it("uses first timestamp if no active trace or timestamp is specified", () => { - coordinator.setTimelines(timelines); - expect(coordinator.currentTimestamp?.getValueNs()).toEqual(10n); - }); - - it("sets first timestamp of active trace if no timestamp is specified", () => { - coordinator.setTimelines(timelines); - coordinator.setActiveTraceTypes([TraceType.WINDOW_MANAGER]); - expect(coordinator.currentTimestamp?.getValueNs()).toEqual(11n); - }); -}); diff --git a/tools/winscope-ng/src/app/timeline_coordinator.ts b/tools/winscope-ng/src/app/timeline_coordinator.ts deleted file mode 100644 index bced7d1f7..000000000 --- a/tools/winscope-ng/src/app/timeline_coordinator.ts +++ /dev/null @@ -1,309 +0,0 @@ -/* - * Copyright (C) 2022 The Android Open Source Project - * - * 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 { Injectable, Type } from "@angular/core"; -import {Timestamp, TimestampType} from "common/trace/timestamp"; -import {TraceType} from "common/trace/trace_type"; -import { ArrayUtils } from "common/utils/array_utils"; -import { TimeRange } from "./components/timeline/utils"; - -type TimestampWithIndex = {index: number, timestamp: Timestamp}; -@Injectable() -export class TimelineCoordinator { - private timelines = new Map(); - private explicitlySetTimestamp: undefined|Timestamp = undefined; - private timestampType: undefined|TimestampType = undefined; - private observers = new Set(); - private explicitlySetSelection: TimeRange|undefined = undefined; - private videoData: Blob|undefined = undefined; - private screenRecordingTimeMapping: Map|undefined = undefined; - // The trace type the currently active view depends on - private activeTraceTypes: TraceType[] = []; - - get currentTimestamp(): Timestamp|undefined { - if (this.explicitlySetTimestamp === undefined) { - if (this.timelines.size === 0) { - return undefined; - } - if (this.activeTraceTypes.length === 0) { - return this.getFirstTimestamp(); - } - return this.getFirstTimestampOfActiveTraces(); - } else { - return this.explicitlySetTimestamp; - } - } - - private getFirstTimestampOfActiveTraces(): Timestamp|undefined { - if (this.activeTraceTypes.length === 0) { - return undefined; - } - const activeTimestamps = this.activeTraceTypes.map(it => this.timelines.get(it)!).flatMap(it => it).sort(); - if (activeTimestamps.length === 0) { - return undefined; - } - return activeTimestamps[0]; - } - - public setActiveTraceTypes(types: TraceType[]) { - this.applyOperationAndNotifyObserversIfTimestampChanged(() => { - this.activeTraceTypes = types; - }); - } - - public getActiveTraceTypes(): TraceType[] { - return this.activeTraceTypes; - } - - public getTimestampType(): TimestampType|undefined { - return this.timestampType; - } - - public getActiveTimestampFor(type: TraceType): TimestampWithIndex|undefined { - if (this.currentTimestamp === undefined) { - return undefined; - } - return this.getActiveTimestampForTraceAt(type, this.currentTimestamp); - } - - public getActiveTimestampForTraceAt(type: TraceType, timestamp: Timestamp): TimestampWithIndex|undefined { - if (timestamp.getType() !== this.timestampType) { - throw Error("Invalid timestamp type"); - } - - const timeline = this.timelines.get(type); - if (timeline === undefined) { - throw Error(`No timeline for requested trace type ${type}`); - } - const index = ArrayUtils.binarySearchLowerOrEqual(timeline, timestamp); - if (index === undefined) { - return undefined; - } - return { index, timestamp: timeline[index] }; - } - - get fullRange() { - const timestamps = this.getAllUniqueTimestamps(); - if (timestamps.length === 0) { - throw Error("Trying to get full range when there are no timestamps"); - } - return { - from: timestamps[0], - to: timestamps[timestamps.length - 1] - }; - } - - get selection(): TimeRange { - if (this.explicitlySetSelection === undefined) { - return this.fullRange; - } else { - return this.explicitlySetSelection; - } - } - - public setSelection(selection: TimeRange) { - this.explicitlySetSelection = selection; - } - - public getTimelines() { - return this.timelines; - } - - public registerObserver(observer: TimestampChangeObserver) { - this.observers.add(observer); - observer.onCurrentTimestampChanged(this.currentTimestamp); - } - - public unregisterObserver(observer: TimestampChangeObserver) { - this.observers.delete(observer); - } - - public setTimelines(timelines: Timeline[]) { - const allTimestamps = timelines.flatMap(timeline => timeline.timestamps); - if (allTimestamps.some(timestamp => timestamp.getType() != allTimestamps[0].getType())) { - throw Error("Added timeline has inconsistent timestamps."); - } - - if (allTimestamps.length > 0) { - this.timestampType = allTimestamps[0].getType(); - } - - this.timelines.clear(); - timelines.forEach(timeline => { - this.timelines.set(timeline.traceType, timeline.timestamps); - }); - - this.notifyOfTimestampUpdate(); - } - - public removeTimeline(typeToRemove: TraceType) { - this.applyOperationAndNotifyObserversIfTimestampChanged(() => { - this.timelines.delete(typeToRemove); - this.activeTraceTypes = this.activeTraceTypes.filter(type => type != typeToRemove); - }); - } - - public setScreenRecordingData(videoData: Blob, timeMapping: Map) { - this.videoData = videoData; - this.screenRecordingTimeMapping = timeMapping; - } - - public removeScreenRecordingData() { - this.videoData = undefined; - this.screenRecordingTimeMapping = undefined; - } - - public getVideoData(): Blob|undefined { - return this.videoData; - } - - public updateCurrentTimestamp(timestamp: Timestamp|undefined) { - if (this.getAllUniqueTimestamps().length === 0) { - console.warn("Setting timestamp on traces with no timestamps/entries..."); - return; - } - - if (timestamp !== undefined) { - if (this.timestampType === undefined) { - throw Error("Timestamp type wasn't set before calling updateCurrentTimestamp"); - } - if (timestamp.getType() !== this.timestampType) { - throw Error("Timeline based on different timestamp type"); - } - } - - this.applyOperationAndNotifyObserversIfTimestampChanged(() => { - this.explicitlySetTimestamp = timestamp; - }); - } - - public getAllUniqueTimestamps(): Timestamp[] { - const allTimestamps = Array.from(this.timelines.values()).flatMap(num => num).sort(); - const uniqueTimestamps: Timestamp[] = []; - - let prevTimestamp: Timestamp | undefined = undefined; - for (const timestamp of allTimestamps) { - if (prevTimestamp?.getValueNs() !== timestamp.getValueNs()) { - uniqueTimestamps.push(timestamp); - } - prevTimestamp = timestamp; - } - return uniqueTimestamps; - } - - private getFirstTimestamp(): Timestamp|undefined { - if (this.getAllUniqueTimestamps().length === 0) { - return undefined; - } - - return this.getAllUniqueTimestamps()[0]; - } - - public getPreviousTimestampFor(traceType: TraceType): Timestamp|undefined { - const activeIndex = this.getActiveTimestampFor(traceType)?.index; - if (activeIndex === undefined) { - // Only acceptable reason for this to be undefined is if we are before the first entry for this type - if (this.timelines.get(traceType)!.length === 0 || - this.currentTimestamp!.getValueNs() < this.timelines.get(traceType)![0].getValueNs()) { - return undefined; - } - throw Error(`Missing active timestamp for trace type ${traceType}`); - } - - const previousIndex = activeIndex - 1; - if (previousIndex < 0) { - return undefined; - } - - return this.timelines.get(traceType)?.[previousIndex]; - } - - public getNextTimestampFor(traceType: TraceType): Timestamp|undefined { - const activeIndex = this.getActiveTimestampFor(traceType)?.index ?? -1; - if (this.timelines.get(traceType)?.length == 0 ?? true) { - throw Error(`Missing active timestamp for trace type ${traceType}`); - } - - const timestamps = this.timelines.get(traceType); - if (timestamps === undefined) { - throw Error("Timestamps for tracetype not found"); - } - const nextIndex = activeIndex + 1; - if (nextIndex >= (timestamps.length)) { - return undefined; - } - - return timestamps[nextIndex]; - } - - public timestampAsElapsedScreenrecordingSeconds(timestamp: Timestamp): number|undefined { - const latestScreenRecordingEntry = this.getActiveTimestampForTraceAt(TraceType.SCREEN_RECORDING, timestamp)?.timestamp; - if (latestScreenRecordingEntry === undefined) { - return undefined; - } - - return this.screenRecordingTimeMapping!.get(latestScreenRecordingEntry); - } - - public clearData() { - this.applyOperationAndNotifyObserversIfTimestampChanged(() => { - this.timelines.clear(); - this.explicitlySetTimestamp = undefined; - this.timestampType = undefined; - this.explicitlySetSelection = undefined; - this.videoData = undefined; - this.screenRecordingTimeMapping = new Map(); - this.activeTraceTypes = []; - }); - } - - public moveToPreviousEntryFor(type: TraceType) { - const prevTimestamp = this.getPreviousTimestampFor(type); - if (prevTimestamp !== undefined) { - this.updateCurrentTimestamp(prevTimestamp); - } - } - - public moveToNextEntryFor(type: TraceType) { - const nextTimestamp = this.getNextTimestampFor(type); - if (nextTimestamp !== undefined) { - this.updateCurrentTimestamp(nextTimestamp); - } - } - - private applyOperationAndNotifyObserversIfTimestampChanged(op: () => void) { - const prevTimestamp = this.currentTimestamp; - op(); - if (prevTimestamp !== this.currentTimestamp) { - this.notifyOfTimestampUpdate(); - } - } - - private notifyOfTimestampUpdate() { - const timestamp = this.currentTimestamp; - this.observers.forEach(observer => - observer.onCurrentTimestampChanged(timestamp)); - } -} - -export interface Timeline { - traceType: TraceType; - timestamps: Timestamp[]; -} - -export interface TimestampChangeObserver { - onCurrentTimestampChanged(timestamp: undefined|Timestamp): void; -} diff --git a/tools/winscope-ng/src/app/timeline_data.spec.ts b/tools/winscope-ng/src/app/timeline_data.spec.ts new file mode 100644 index 000000000..0543f41fd --- /dev/null +++ b/tools/winscope-ng/src/app/timeline_data.spec.ts @@ -0,0 +1,158 @@ +/* + * Copyright (C) 2022 The Android Open Source Project + * + * 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 {Timestamp, TimestampType} from "common/trace/timestamp"; +import {TraceType} from "common/trace/trace_type"; +import {TimelineData} from "./timeline_data"; +import {Timeline} from "./trace_data"; + +class TimestampChangedObserver { + onCurrentTimestampChanged(timestamp: Timestamp|undefined) { + // do nothing + } +} + +describe("TimelineData", () => { + let timelineData: TimelineData; + const timestampChangedObserver = new TimestampChangedObserver(); + + const timestamp10 = new Timestamp(TimestampType.REAL, 10n); + const timestamp11 = new Timestamp(TimestampType.REAL, 11n); + + const timelines: Timeline[] = [{ + traceType: TraceType.SURFACE_FLINGER, + timestamps: [timestamp10] + }, + { + traceType: TraceType.WINDOW_MANAGER, + timestamps: [timestamp11] + }]; + + beforeEach(() => { + timelineData = new TimelineData(); + timelineData.setOnCurrentTimestampChangedCallback(timestamp => { + timestampChangedObserver.onCurrentTimestampChanged(timestamp); + }); + }); + + it("sets timelines", () => { + expect(timelineData.getCurrentTimestamp()).toBeUndefined(); + + timelineData.initialize(timelines, undefined); + expect(timelineData.getCurrentTimestamp()).toEqual(timestamp10); + }); + + it("uses first timestamp by default", () => { + timelineData.initialize(timelines, undefined); + expect(timelineData.getCurrentTimestamp()?.getValueNs()).toEqual(10n); + }); + + it("uses explicit timestamp if set", () => { + timelineData.initialize(timelines, undefined); + expect(timelineData.getCurrentTimestamp()?.getValueNs()).toEqual(10n); + + const explicitTimestamp = new Timestamp(TimestampType.REAL, 1000n); + timelineData.setCurrentTimestamp(explicitTimestamp); + expect(timelineData.getCurrentTimestamp()).toEqual(explicitTimestamp); + + timelineData.setActiveViewTraceTypes([TraceType.WINDOW_MANAGER]); + expect(timelineData.getCurrentTimestamp()).toEqual(explicitTimestamp); + }); + + it("sets active trace types and update current timestamp accordingly", () => { + timelineData.initialize(timelines, undefined); + + timelineData.setActiveViewTraceTypes([]); + expect(timelineData.getCurrentTimestamp()).toEqual(timestamp10); + + timelineData.setActiveViewTraceTypes([TraceType.WINDOW_MANAGER]); + expect(timelineData.getCurrentTimestamp()).toEqual(timestamp11); + + timelineData.setActiveViewTraceTypes([TraceType.SURFACE_FLINGER]); + expect(timelineData.getCurrentTimestamp()).toEqual(timestamp10); + + timelineData.setActiveViewTraceTypes([TraceType.SURFACE_FLINGER, TraceType.WINDOW_MANAGER]); + expect(timelineData.getCurrentTimestamp()).toEqual(timestamp10); + }); + + it("notifies callback when current timestamp changes", () => { + spyOn(timestampChangedObserver, "onCurrentTimestampChanged"); + expect(timestampChangedObserver.onCurrentTimestampChanged).toHaveBeenCalledTimes(0); + + timelineData.initialize(timelines, undefined); + expect(timestampChangedObserver.onCurrentTimestampChanged).toHaveBeenCalledTimes(1); + + timelineData.setActiveViewTraceTypes([TraceType.WINDOW_MANAGER]); + expect(timestampChangedObserver.onCurrentTimestampChanged).toHaveBeenCalledTimes(2); + }); + + it("doesn't notify observers when current timestamp doesn't change", () => { + timelineData.initialize(timelines, undefined); + + spyOn(timestampChangedObserver, "onCurrentTimestampChanged"); + expect(timestampChangedObserver.onCurrentTimestampChanged).toHaveBeenCalledTimes(0); + + timelineData.setActiveViewTraceTypes([TraceType.SURFACE_FLINGER]); + expect(timestampChangedObserver.onCurrentTimestampChanged).toHaveBeenCalledTimes(0); + + timelineData.setActiveViewTraceTypes([TraceType.SURFACE_FLINGER, TraceType.WINDOW_MANAGER]); + expect(timestampChangedObserver.onCurrentTimestampChanged).toHaveBeenCalledTimes(0); + }); + + it("hasTimestamps()", () => { + expect(timelineData.hasTimestamps()).toBeFalse(); + + timelineData.initialize([], undefined); + expect(timelineData.hasTimestamps()).toBeFalse(); + + timelineData.initialize([{ + traceType: TraceType.SURFACE_FLINGER, + timestamps: [] + }], undefined); + expect(timelineData.hasTimestamps()).toBeFalse(); + + timelineData.initialize([{ + traceType: TraceType.SURFACE_FLINGER, + timestamps: [new Timestamp(TimestampType.REAL, 10n)] + }], undefined); + expect(timelineData.hasTimestamps()).toBeTrue(); + }); + + it("hasMoreThanOneDistinctTimestamp()", () => { + expect(timelineData.hasMoreThanOneDistinctTimestamp()).toBeFalse(); + + timelineData.initialize([], undefined); + expect(timelineData.hasMoreThanOneDistinctTimestamp()).toBeFalse(); + + timelineData.initialize([{ + traceType: TraceType.SURFACE_FLINGER, + timestamps: [new Timestamp(TimestampType.REAL, 10n)] + }, { + traceType: TraceType.WINDOW_MANAGER, + timestamps: [new Timestamp(TimestampType.REAL, 10n)] + }], undefined); + expect(timelineData.hasMoreThanOneDistinctTimestamp()).toBeFalse(); + + timelineData.initialize([{ + traceType: TraceType.SURFACE_FLINGER, + timestamps: [new Timestamp(TimestampType.REAL, 10n)] + }, { + traceType: TraceType.WINDOW_MANAGER, + timestamps: [new Timestamp(TimestampType.REAL, 11n)] + }], undefined); + expect(timelineData.hasMoreThanOneDistinctTimestamp()).toBeTrue(); + }); +}); diff --git a/tools/winscope-ng/src/app/timeline_data.ts b/tools/winscope-ng/src/app/timeline_data.ts new file mode 100644 index 000000000..eb713318a --- /dev/null +++ b/tools/winscope-ng/src/app/timeline_data.ts @@ -0,0 +1,293 @@ +/* + * Copyright (C) 2022 The Android Open Source Project + * + * 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 {Timeline} from "./trace_data"; +import {Timestamp, TimestampType} from "common/trace/timestamp"; +import {TraceType} from "common/trace/trace_type"; +import { ArrayUtils } from "common/utils/array_utils"; +import { FunctionUtils} from "common/utils/function_utils"; +import {TimeUtils} from "common/utils/time_utils"; +import {ScreenRecordingUtils} from "common/trace/screen_recording_utils"; + +export type TimestampCallbackType = (timestamp: Timestamp|undefined) => void; +export type TimeRange = { from: Timestamp, to: Timestamp } +type TimestampWithIndex = {index: number, timestamp: Timestamp}; + +export class TimelineData { + private timelines = new Map(); + private timestampType?: TimestampType = undefined; + private explicitlySetTimestamp?: Timestamp = undefined; + private explicitlySetSelection?: TimeRange = undefined; + private screenRecordingVideo?: Blob = undefined; + private activeViewTraceTypes: TraceType[] = []; // dependencies of current active view + private onCurrentTimestampChanged: TimestampCallbackType = FunctionUtils.DO_NOTHING; + + public initialize(timelines: Timeline[], screenRecordingVideo: Blob|undefined) { + this.clear(); + + this.screenRecordingVideo = screenRecordingVideo; + + const allTimestamps = timelines.flatMap(timeline => timeline.timestamps); + if (allTimestamps.some(timestamp => timestamp.getType() != allTimestamps[0].getType())) { + throw Error("Added timeline has inconsistent timestamps."); + } + + if (allTimestamps.length > 0) { + this.timestampType = allTimestamps[0].getType(); + } + + timelines.forEach(timeline => { + this.timelines.set(timeline.traceType, timeline.timestamps); + }); + + this.onCurrentTimestampChanged(this.getCurrentTimestamp()); + } + + setOnCurrentTimestampChangedCallback(callback: TimestampCallbackType) { + this.onCurrentTimestampChanged = callback; + } + + getCurrentTimestamp(): Timestamp|undefined { + if (this.explicitlySetTimestamp !== undefined) { + return this.explicitlySetTimestamp; + } + if (this.getFirstTimestampOfActiveViewTraces() !== undefined) { + return this.getFirstTimestampOfActiveViewTraces(); + } + return this.getFirstTimestamp(); + } + + public setCurrentTimestamp(timestamp: Timestamp|undefined) { + if (!this.hasTimestamps()) { + console.warn("Attempted to set timestamp on traces with no timestamps/entries..."); + return; + } + + if (timestamp !== undefined) { + if (this.timestampType === undefined) { + throw Error("Attempted to set explicit timestamp but no timestamp type is available"); + } + if (timestamp.getType() !== this.timestampType) { + throw Error("Attempted to set explicit timestamp with incompatible type"); + } + } + + this.applyOperationAndNotifyIfCurrentTimestampChanged(() => { + this.explicitlySetTimestamp = timestamp; + }); + } + + + public setActiveViewTraceTypes(types: TraceType[]) { + this.applyOperationAndNotifyIfCurrentTimestampChanged(() => { + this.activeViewTraceTypes = types; + }); + } + + public getTimestampType(): TimestampType|undefined { + return this.timestampType; + } + + public getFullRange(): TimeRange { + if (!this.hasTimestamps()) { + throw Error("Trying to get full range when there are no timestamps"); + } + return { + from: this.getFirstTimestamp()!, + to: this.getLastTimestamp()! + }; + } + + public getSelectionRange(): TimeRange { + if (this.explicitlySetSelection === undefined) { + return this.getFullRange(); + } else { + return this.explicitlySetSelection; + } + } + + public setSelectionRange(selection: TimeRange) { + this.explicitlySetSelection = selection; + } + + public getTimelines(): Map { + return this.timelines; + } + + public getScreenRecordingVideo(): Blob|undefined { + return this.screenRecordingVideo; + } + + public searchCorrespondingScreenRecordingTimeSeconds(timestamp: Timestamp): number|undefined { + const timestamps = this.timelines.get(TraceType.SCREEN_RECORDING); + if (!timestamps) { + return undefined; + } + + const firstTimestamp = timestamps[0]; + + const correspondingTimestamp = this.searchCorrespondingTimestampFor(TraceType.SCREEN_RECORDING, timestamp)?.timestamp; + if (correspondingTimestamp === undefined) { + return undefined; + } + + return ScreenRecordingUtils.timestampToVideoTimeSeconds(firstTimestamp, correspondingTimestamp); + } + + public hasTimestamps(): boolean { + return Array.from(this.timelines.values()).some(timestamps => timestamps.length > 0); + } + + public hasMoreThanOneDistinctTimestamp(): boolean { + return this.hasTimestamps() && this.getFirstTimestamp() !== this.getLastTimestamp(); + } + + public getCurrentTimestampFor(type: TraceType): Timestamp|undefined { + return this.searchCorrespondingTimestampFor(type, this.getCurrentTimestamp())?.timestamp; + } + + public getPreviousTimestampFor(type: TraceType): Timestamp|undefined { + const currentIndex = + this.searchCorrespondingTimestampFor(type, this.getCurrentTimestamp())?.index; + + if (currentIndex === undefined) { + // Only acceptable reason for this to be undefined is if we are before the first entry for this type + if (this.timelines.get(type)!.length === 0 || + this.getCurrentTimestamp()!.getValueNs() < this.timelines.get(type)![0].getValueNs()) { + return undefined; + } + throw Error(`Missing active timestamp for trace type ${type}`); + } + + const previousIndex = currentIndex - 1; + if (previousIndex < 0) { + return undefined; + } + + return this.timelines.get(type)?.[previousIndex]; + } + + public getNextTimestampFor(type: TraceType): Timestamp|undefined { + const currentIndex = + this.searchCorrespondingTimestampFor(type, this.getCurrentTimestamp())?.index ?? -1; + + if (this.timelines.get(type)?.length == 0 ?? true) { + throw Error(`Missing active timestamp for trace type ${type}`); + } + + const timestamps = this.timelines.get(type); + if (timestamps === undefined) { + throw Error("Timestamps for tracetype not found"); + } + const nextIndex = currentIndex + 1; + if (nextIndex >= timestamps.length) { + return undefined; + } + + return timestamps[nextIndex]; + } + + public moveToPreviousTimestampFor(type: TraceType) { + const prevTimestamp = this.getPreviousTimestampFor(type); + if (prevTimestamp !== undefined) { + this.setCurrentTimestamp(prevTimestamp); + } + } + + public moveToNextTimestampFor(type: TraceType) { + const nextTimestamp = this.getNextTimestampFor(type); + if (nextTimestamp !== undefined) { + this.setCurrentTimestamp(nextTimestamp); + } + } + + public clear() { + this.applyOperationAndNotifyIfCurrentTimestampChanged(() => { + this.timelines.clear(); + this.explicitlySetTimestamp = undefined; + this.timestampType = undefined; + this.explicitlySetSelection = undefined; + this.screenRecordingVideo = undefined; + this.activeViewTraceTypes = []; + }); + } + + private getFirstTimestamp(): Timestamp|undefined { + if (!this.hasTimestamps()) { + return undefined; + } + + return Array.from(this.timelines.values()) + .map(timestamps => timestamps[0]) + .filter(timestamp => timestamp !== undefined) + .reduce((prev, current) => prev < current ? prev : current); + } + + private getLastTimestamp(): Timestamp|undefined { + if (!this.hasTimestamps()) { + return undefined; + } + + return Array.from(this.timelines.values()) + .map(timestamps => timestamps[timestamps.length-1]) + .filter(timestamp => timestamp !== undefined) + .reduce((prev, current) => prev > current ? prev : current); + } + + private searchCorrespondingTimestampFor(type: TraceType, timestamp: Timestamp|undefined): + TimestampWithIndex|undefined { + if (timestamp === undefined) { + return undefined; + } + + if (timestamp.getType() !== this.timestampType) { + throw Error("Invalid timestamp type"); + } + + const timeline = this.timelines.get(type); + if (timeline === undefined) { + throw Error(`No timeline for requested trace type ${type}`); + } + const index = ArrayUtils.binarySearchLowerOrEqual(timeline, timestamp); + if (index === undefined) { + return undefined; + } + return { index, timestamp: timeline[index] }; + } + + private getFirstTimestampOfActiveViewTraces(): Timestamp|undefined { + if (this.activeViewTraceTypes.length === 0) { + return undefined; + } + const activeTimestamps = this.activeViewTraceTypes + .map(traceType => this.timelines.get(traceType)!) + .map(timestamps => timestamps[0]) + .filter(timestamp => timestamp !== undefined) + .sort(TimeUtils.compareFn); + if (activeTimestamps.length === 0) { + return undefined; + } + return activeTimestamps[0]; + } + + private applyOperationAndNotifyIfCurrentTimestampChanged(op: () => void) { + const prevTimestamp = this.getCurrentTimestamp(); + op(); + if (prevTimestamp !== this.getCurrentTimestamp()) { + this.onCurrentTimestampChanged(this.getCurrentTimestamp()); + } + } +} diff --git a/tools/winscope-ng/src/app/trace_coordinator.spec.ts b/tools/winscope-ng/src/app/trace_coordinator.spec.ts deleted file mode 100644 index 25b44c88f..000000000 --- a/tools/winscope-ng/src/app/trace_coordinator.spec.ts +++ /dev/null @@ -1,212 +0,0 @@ -/* - * Copyright (C) 2022 The Android Open Source Project - * - * 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 {Timestamp, TimestampType} from "common/trace/timestamp"; -import {TraceType} from "common/trace/trace_type"; -import {TraceCoordinator} from "./trace_coordinator"; -import {UnitTestUtils} from "test/unit/utils"; -import {ViewerFactory} from "viewers/viewer_factory"; -import {ViewerStub} from "viewers/viewer_stub"; -import { TimelineCoordinator } from "./timeline_coordinator"; -import { MockStorage } from "test/unit/mock_storage"; - -describe("TraceCoordinator", () => { - let traceCoordinator: TraceCoordinator; - let timelineCoordinator: TimelineCoordinator; - - beforeEach(async () => { - spyOn(TimelineCoordinator.prototype, "setScreenRecordingData").and.callThrough(); - spyOn(TimelineCoordinator.prototype, "removeScreenRecordingData").and.callThrough(); - timelineCoordinator = new TimelineCoordinator(); - traceCoordinator = new TraceCoordinator(timelineCoordinator); - }); - - it("processes trace files", async () => { - expect(traceCoordinator.getParsers().length).toEqual(0); - const traces = [ - await UnitTestUtils.getFixtureFile("traces/elapsed_and_real_timestamp/dump_SurfaceFlinger.pb"), - await UnitTestUtils.getFixtureFile("traces/dump_WindowManager.pb"), - ]; - const errors = await traceCoordinator.setTraces(traces); - expect(traceCoordinator.getParsers().length).toEqual(2); - expect(errors.length).toEqual(0); - }); - - it("it is robust to invalid trace files", async () => { - expect(traceCoordinator.getParsers().length).toEqual(0); - const traces = [ - await UnitTestUtils.getFixtureFile("winscope_homepage.png"), - ]; - const errors = await traceCoordinator.setTraces(traces); - expect(traceCoordinator.getParsers().length).toEqual(0); - expect(errors.length).toEqual(1); - }); - - it("is robust to trace files with no entries", async () => { - const traces = [ - await UnitTestUtils.getFixtureFile( - "traces/no_entries_InputMethodClients.pb") - ]; - await traceCoordinator.setTraces(traces); - - let timestamp = new Timestamp(TimestampType.REAL, 0n); - timelineCoordinator.updateCurrentTimestamp(timestamp); - - timestamp = new Timestamp(TimestampType.ELAPSED, 0n); - timelineCoordinator.updateCurrentTimestamp(timestamp); - }); - - it("processes mixed valid and invalid trace files", async () => { - expect(traceCoordinator.getParsers().length).toEqual(0); - const traces = [ - await UnitTestUtils.getFixtureFile("winscope_homepage.png"), - await UnitTestUtils.getFixtureFile("traces/dump_WindowManager.pb"), - ]; - const errors = await traceCoordinator.setTraces(traces); - expect(traceCoordinator.getParsers().length).toEqual(1); - expect(errors.length).toEqual(1); - }); - - it("can remove traces", async () => { - expect(traceCoordinator.getParsers().length).toEqual(0); - const traces = [ - await UnitTestUtils.getFixtureFile("traces/elapsed_and_real_timestamp/dump_SurfaceFlinger.pb"), - ]; - await traceCoordinator.setTraces(traces); - expect(traceCoordinator.getParsers().length).toEqual(1); - - traceCoordinator.removeTrace(TraceType.SURFACE_FLINGER); - expect(traceCoordinator.getParsers().length).toEqual(0); - }); - - it("can find a parser based on trace type", async () => { - const traces = [ - await UnitTestUtils.getFixtureFile("traces/elapsed_and_real_timestamp/dump_SurfaceFlinger.pb"), - await UnitTestUtils.getFixtureFile("traces/dump_WindowManager.pb"), - ]; - await traceCoordinator.setTraces(traces); - - const parser = traceCoordinator.findParser(TraceType.SURFACE_FLINGER); - expect(parser).toBeTruthy(); - expect(parser!.getTraceType()).toEqual(TraceType.SURFACE_FLINGER); - }); - - it("cannot find parser that does not exist", async () => { - expect(traceCoordinator.getParsers().length).toEqual(0); - const parser = traceCoordinator.findParser(TraceType.SURFACE_FLINGER); - expect(parser).toBe(null); - }); - - it("can get all timestamps from multiple parsers", async () => { - const traces = [ - await UnitTestUtils.getFixtureFile("traces/elapsed_and_real_timestamp/SurfaceFlinger.pb"), - await UnitTestUtils.getFixtureFile("traces/elapsed_and_real_timestamp/WindowManager.pb"), - ]; - await traceCoordinator.setTraces(traces); - const timestamps = timelineCoordinator.getAllUniqueTimestamps(); - expect(timestamps.length).toEqual(48); - }); - - it("can create viewers and notify current trace entries", async () => { - const viewerStub = new ViewerStub("Title"); - - spyOn(ViewerFactory.prototype, "createViewers").and.returnValue([viewerStub]); - spyOn(viewerStub, "notifyCurrentTraceEntries"); - - const traces = [ - await UnitTestUtils.getFixtureFile( - "traces/elapsed_and_real_timestamp/SurfaceFlinger.pb"), - await UnitTestUtils.getFixtureFile( - "traces/elapsed_and_real_timestamp/WindowManager.pb"), - // trace file with no entries for some more robustness checks - await UnitTestUtils.getFixtureFile( - "traces/no_entries_InputMethodClients.pb") - ]; - await traceCoordinator.setTraces(traces); - - // create viewers (mocked factory) - expect(traceCoordinator.getViewers()).toEqual([]); - traceCoordinator.createViewers(new MockStorage()); - expect(traceCoordinator.getViewers()).toEqual([viewerStub]); - - // Gets notified of the current timestamp on creation - expect(viewerStub.notifyCurrentTraceEntries).toHaveBeenCalledTimes(1); - - // When we update to an undefined timestamp we reset to the default selected - // timestamp based on the active trace and loaded timelines. Given that - // we haven't set a timestamp we should still be in the default timestamp - // and require no update to the current trace entries. - timelineCoordinator.updateCurrentTimestamp(undefined); - expect(viewerStub.notifyCurrentTraceEntries).toHaveBeenCalledTimes(1); - - // notify timestamp - const timestamp = new Timestamp(TimestampType.REAL, 14500282843n); - expect(timelineCoordinator.getTimestampType()).toBe(TimestampType.REAL); - timelineCoordinator.updateCurrentTimestamp(timestamp); - expect(viewerStub.notifyCurrentTraceEntries).toHaveBeenCalledTimes(2); - - // notify timestamp again - timelineCoordinator.updateCurrentTimestamp(timestamp); - expect(viewerStub.notifyCurrentTraceEntries).toHaveBeenCalledTimes(2); - - // reset back to the default timestamp should trigger a change - timelineCoordinator.updateCurrentTimestamp(undefined); - expect(viewerStub.notifyCurrentTraceEntries).toHaveBeenCalledTimes(3); - }); - - it("trace coordinator sets video data on timelineCoordinator when screenrecording is loaded", async () => { - expect(traceCoordinator.getParsers().length).toEqual(0); - const traces = [ - await UnitTestUtils.getFixtureFile("traces/elapsed_and_real_timestamp/SurfaceFlinger.pb"), - await UnitTestUtils.getFixtureFile("traces/elapsed_and_real_timestamp/WindowManager.pb"), - await UnitTestUtils.getFixtureFile("traces/elapsed_and_real_timestamp/screen_recording_metadata_v2.mp4"), - ]; - const errors = await traceCoordinator.setTraces(traces); - expect(traceCoordinator.getParsers().length).toEqual(3); - expect(errors.length).toEqual(0); - - expect(timelineCoordinator.setScreenRecordingData).toHaveBeenCalledTimes(1); - }); - - it("video data is removed if video trace is deleted", async () => { - expect(traceCoordinator.getParsers().length).toEqual(0); - const traces = [ - await UnitTestUtils.getFixtureFile("traces/elapsed_and_real_timestamp/SurfaceFlinger.pb"), - await UnitTestUtils.getFixtureFile("traces/elapsed_and_real_timestamp/WindowManager.pb"), - await UnitTestUtils.getFixtureFile("traces/elapsed_and_real_timestamp/screen_recording_metadata_v2.mp4"), - ]; - const errors = await traceCoordinator.setTraces(traces); - expect(traceCoordinator.getParsers().length).toEqual(3); - expect(errors.length).toEqual(0); - expect(traceCoordinator.getParserFor(TraceType.SCREEN_RECORDING)) - .withContext("Should have screen recording parser").toBeDefined(); - expect(timelineCoordinator.getTimelines().keys()) - .withContext("Should have screen recording timeline").toContain(TraceType.SCREEN_RECORDING); - - expect(timelineCoordinator.setScreenRecordingData).toHaveBeenCalledTimes(1); - expect(timelineCoordinator.getVideoData()).withContext("Should have video data").toBeDefined(); - expect(timelineCoordinator.timestampAsElapsedScreenrecordingSeconds( - new Timestamp(TimestampType.REAL, 1666361049372271045n))) - .withContext("Should be able to covert timestamp to video seconds").toBeDefined(); - - traceCoordinator.removeTrace(TraceType.SCREEN_RECORDING); - - expect(timelineCoordinator.removeScreenRecordingData).toHaveBeenCalledTimes(1); - expect(timelineCoordinator.getVideoData()).withContext("Should no longer have video data").toBeUndefined(); - expect(() => { - timelineCoordinator.timestampAsElapsedScreenrecordingSeconds(new Timestamp(TimestampType.REAL, 1666361049372271045n)) - }).toThrow(new Error("No timeline for requested trace type 3")); - }); -}); diff --git a/tools/winscope-ng/src/app/trace_coordinator.ts b/tools/winscope-ng/src/app/trace_coordinator.ts deleted file mode 100644 index 8ef98c7bb..000000000 --- a/tools/winscope-ng/src/app/trace_coordinator.ts +++ /dev/null @@ -1,229 +0,0 @@ -/* - * Copyright (C) 2022 The Android Open Source Project - * - * 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 {ArrayUtils} from "common/utils/array_utils"; -import {Timestamp, TimestampType} from "common/trace/timestamp"; -import {TraceType} from "common/trace/trace_type"; -import {Parser} from "parsers/parser"; -import {ParserError, ParserFactory} from "parsers/parser_factory"; -import { Viewer } from "viewers/viewer"; -import { ViewerFactory } from "viewers/viewer_factory"; -import { LoadedTrace } from "app/loaded_trace"; -import { FileUtils } from "common/utils/file_utils"; -import { TRACE_INFO } from "app/trace_info"; -import { TimelineCoordinator, TimestampChangeObserver, Timeline} from "./timeline_coordinator"; -import { Inject, Injectable } from "@angular/core"; -import { ScreenRecordingTraceEntry } from "common/trace/screen_recording"; - -@Injectable() -class TraceCoordinator implements TimestampChangeObserver { - private parsers: Parser[] = []; - private viewers: Viewer[] = []; - - constructor(@Inject(TimelineCoordinator) private timelineCoordinator: TimelineCoordinator) { - this.timelineCoordinator.registerObserver(this); - } - - public async setTraces(traces: File[]) { - traces = this.parsers.map(parser => parser.getTrace()).concat(traces); - let parserErrors: ParserError[]; - [this.parsers, parserErrors] = await new ParserFactory().createParsers(traces); - this.addAllTracesToTimelineCoordinator(); - this.addScreenRecodingTimeMappingToTraceCooordinator(); - return parserErrors; - } - - public removeTrace(type: TraceType) { - this.parsers = this.parsers.filter(parser => parser.getTraceType() !== type); - this.timelineCoordinator.removeTimeline(type); - if (type === TraceType.SCREEN_RECORDING) { - this.timelineCoordinator.removeScreenRecordingData(); - } - } - - private addAllTracesToTimelineCoordinator() { - const timelines: Timeline[] = this.parsers.map(parser => { - const timestamps = parser.getTimestamps(this.timestampTypeToUse()); - if (timestamps === undefined) { - throw Error("Couldn't get timestamps from trace parser."); - } - return {traceType: parser.getTraceType(), timestamps: timestamps}; - }); - - this.timelineCoordinator.setTimelines(timelines); - } - - private addScreenRecodingTimeMappingToTraceCooordinator() { - const parser = this.getParserFor(TraceType.SCREEN_RECORDING); - if (parser === undefined) { - return; - } - - const timestampMapping = new Map(); - let videoData: Blob|undefined = undefined; - for (const timestamp of parser.getTimestamps(this.timestampTypeToUse()) ?? []) { - const entry = parser.getTraceEntry(timestamp) as ScreenRecordingTraceEntry; - timestampMapping.set(timestamp, entry.videoTimeSeconds); - if (videoData === undefined) { - videoData = entry.videoData; - } - } - - if (videoData === undefined) { - throw Error("No video data available!"); - } - - this.timelineCoordinator.setScreenRecordingData(videoData, timestampMapping); - } - - private timestampTypeToUse() { - const priorityOrder = [TimestampType.REAL, TimestampType.ELAPSED]; - for (const type of priorityOrder) { - if (this.parsers.every(it => it.getTimestamps(type) !== undefined)) { - return type; - } - } - - throw Error("No common timestamp type across all traces"); - } - - public createViewers(storage: Storage) { - const activeTraceTypes = this.parsers.map(parser => parser.getTraceType()); - this.viewers = new ViewerFactory().createViewers(new Set(activeTraceTypes), storage); - - // Make sure to update the viewers active entries as soon as they are created. - if (this.timelineCoordinator.currentTimestamp) { - this.onCurrentTimestampChanged(this.timelineCoordinator.currentTimestamp); - } - } - - public getLoadedTraces(): LoadedTrace[] { - return this.parsers.map((parser: Parser) => { - const name = (parser.getTrace()).name; - const type = parser.getTraceType(); - return {name: name, type: type}; - }); - } - - public getParsers(): Parser[] { - return this.parsers; - } - - public getViewers(): Viewer[] { - return this.viewers; - } - - public findParser(traceType: TraceType): Parser | null { - const parser = this.parsers.find(parser => parser.getTraceType() === traceType); - return parser ?? null; - } - - public onCurrentTimestampChanged(timestamp: Timestamp|undefined) { - const entries = this.getCurrentTraceEntries(timestamp); - this.viewers.forEach(viewer => { - viewer.notifyCurrentTraceEntries(entries); - }); - } - - private getCurrentTraceEntries(timestamp: Timestamp|undefined): Map { - const traceEntries: Map = new Map(); - - if (!timestamp) { - return traceEntries; - } - - this.parsers.forEach(parser => { - const targetTimestamp = timestamp; - const entry = parser.getTraceEntry(targetTimestamp); - let prevEntry = null; - - const parserTimestamps = parser.getTimestamps(timestamp.getType()); - if (parserTimestamps === undefined) { - throw new Error(`Unexpected timestamp type ${timestamp.getType()}.` - + ` Not supported by parser for trace type: ${parser.getTraceType()}`); - } - - const index = ArrayUtils.binarySearchLowerOrEqual(parserTimestamps, targetTimestamp); - if (index !== undefined && index > 0) { - prevEntry = parser.getTraceEntry(parserTimestamps[index-1]); - } - - if (entry !== undefined) { - traceEntries.set(parser.getTraceType(), [entry, prevEntry]); - } - }); - - return traceEntries; - } - - public clearData() { - this.parsers = []; - this.viewers = []; - this.timelineCoordinator.clearData(); - } - - public async getUnzippedFiles(files: File[]): Promise { - const unzippedFiles: File[] = []; - for (let i=0; i { - const trace = parser.getTrace(); - if (trace) { - const traceType = TRACE_INFO[parser.getTraceType()].name; - const name = traceType + "/" + FileUtils.removeDirFromFileName(trace.name); - const blob = await trace.arrayBuffer(); - return new File([blob], name); - } - return null; - } - - public async getAllTracesForDownload(): Promise { - const traces: File[] = []; - for (let i=0; i < this.parsers.length; i++) { - const trace = await this.getTraceForDownload(this.parsers[i]); - if (trace) { - traces.push(trace); - } - } - return traces; - } - - public getParserFor(traceType: TraceType): undefined|Parser { - const matchingParsers = this.getParsers() - .filter((parser) => parser.getTraceType() === traceType); - - if (matchingParsers.length === 0) { - return undefined; - } - - if (matchingParsers.length > 1) { - throw Error(`Too many matching parsers for trace type ${traceType}. `); - } - - return matchingParsers[0]; - } -} - -export { TraceCoordinator }; diff --git a/tools/winscope-ng/src/app/trace_data.spec.ts b/tools/winscope-ng/src/app/trace_data.spec.ts new file mode 100644 index 000000000..eb835c936 --- /dev/null +++ b/tools/winscope-ng/src/app/trace_data.spec.ts @@ -0,0 +1,166 @@ +/* + * Copyright (C) 2022 The Android Open Source Project + * + * 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 {Timestamp, TimestampType} from "common/trace/timestamp"; +import {TraceType} from "common/trace/trace_type"; +import {TraceData} from "./trace_data"; +import {UnitTestUtils} from "test/unit/utils"; + +describe("TraceData", () => { + let traceData: TraceData; + + beforeEach(async () => { + traceData = new TraceData(); + }); + + it("can load valid trace files", async () => { + expect(traceData.getLoadedTraces().length).toEqual(0); + await loadValidSfWmTraces(); + expect(traceData.getLoadedTraces().length).toEqual(2); + }); + + it("is robust to invalid trace files", async () => { + const invalidTraceFiles = [ + await UnitTestUtils.getFixtureFile("winscope_homepage.png"), + ]; + + const errors = await traceData.loadTraces(invalidTraceFiles); + expect(errors.length).toEqual(1); + expect(traceData.getLoadedTraces().length).toEqual(0); + }); + + it("is robust to mixed valid and invalid trace files", async () => { + expect(traceData.getLoadedTraces().length).toEqual(0); + const traces = [ + await UnitTestUtils.getFixtureFile("winscope_homepage.png"), + await UnitTestUtils.getFixtureFile("traces/dump_WindowManager.pb"), + ]; + const errors = await traceData.loadTraces(traces); + expect(traceData.getLoadedTraces().length).toEqual(1); + expect(errors.length).toEqual(1); + }); + + it("is robust to trace files with no entries", async () => { + const traceFilesWithNoEntries = [ + await UnitTestUtils.getFixtureFile( + "traces/no_entries_InputMethodClients.pb") + ]; + + const errors = await traceData.loadTraces(traceFilesWithNoEntries); + + expect(errors.length).toEqual(0); + + expect(traceData.getLoadedTraces().length).toEqual(1); + + const timelines = traceData.getTimelines(); + expect(timelines.length).toEqual(1); + expect(timelines[0].timestamps).toEqual([]); + }); + + it("can remove traces", async () => { + await loadValidSfWmTraces(); + expect(traceData.getLoadedTraces().length).toEqual(2); + + traceData.removeTrace(TraceType.SURFACE_FLINGER); + expect(traceData.getLoadedTraces().length).toEqual(1); + + traceData.removeTrace(TraceType.WINDOW_MANAGER); + expect(traceData.getLoadedTraces().length).toEqual(0); + }); + + it("gets loaded traces", async () => { + await loadValidSfWmTraces(); + + const traces = traceData.getLoadedTraces(); + expect(traces.length).toEqual(2); + expect(traces[0].file).toBeTruthy(); + + const actualTraceTypes = new Set(traces.map(trace => trace.type)); + const expectedTraceTypes = new Set([TraceType.SURFACE_FLINGER, TraceType.WINDOW_MANAGER]); + expect(actualTraceTypes).toEqual(expectedTraceTypes); + }); + + it("gets trace entries for a given timestamp", async () => { + const traceFiles = [ + await UnitTestUtils.getFixtureFile("traces/elapsed_and_real_timestamp/SurfaceFlinger.pb"), + await UnitTestUtils.getFixtureFile("traces/elapsed_and_real_timestamp/WindowManager.pb"), + ]; + + const errors = await traceData.loadTraces(traceFiles); + expect(errors.length).toEqual(0); + + { + const entries = traceData.getTraceEntries(undefined); + expect(entries.size).toEqual(0); + } + { + const timestamp = new Timestamp(TimestampType.REAL, 0n); + const entries = traceData.getTraceEntries(timestamp); + expect(entries.size).toEqual(0); + } + { + const twoHundredYearsTimestamp = new Timestamp(TimestampType.REAL, 200n * 365n * 24n * 60n * 3600n * 1000000000n); + const entries = traceData.getTraceEntries(twoHundredYearsTimestamp); + expect(entries.size).toEqual(2); + } + }); + + it("gets timelines", async () => { + await loadValidSfWmTraces(); + + const timelines = traceData.getTimelines(); + + const actualTraceTypes = new Set(timelines.map(timeline => timeline.traceType)); + const expectedTraceTypes = new Set([TraceType.SURFACE_FLINGER, TraceType.WINDOW_MANAGER]); + expect(actualTraceTypes).toEqual(expectedTraceTypes); + + timelines.forEach(timeline => { + expect(timeline.timestamps.length).toBeGreaterThan(0); + }); + }); + + it("gets screenrecording data", async () => { + expect(traceData.getScreenRecordingVideo()).toBeUndefined(); + + const traceFiles = [ + await UnitTestUtils.getFixtureFile("traces/elapsed_and_real_timestamp/screen_recording_metadata_v2.mp4"), + ]; + await traceData.loadTraces(traceFiles); + + const video = traceData.getScreenRecordingVideo(); + expect(video).toBeDefined(); + expect(video!.size).toBeGreaterThan(0); + }); + + it("can be cleared", async () => { + await loadValidSfWmTraces(); + expect(traceData.getLoadedTraces().length).toBeGreaterThan(0); + expect(traceData.getTimelines().length).toBeGreaterThan(0); + + traceData.clear(); + expect(traceData.getLoadedTraces().length).toEqual(0); + expect(traceData.getTimelines().length).toEqual(0); + }); + + const loadValidSfWmTraces = async () => { + const traceFiles = [ + await UnitTestUtils.getFixtureFile("traces/elapsed_and_real_timestamp/SurfaceFlinger.pb"), + await UnitTestUtils.getFixtureFile("traces/elapsed_and_real_timestamp/WindowManager.pb"), + ]; + + const errors = await traceData.loadTraces(traceFiles); + expect(errors.length).toEqual(0); + }; +}); diff --git a/tools/winscope-ng/src/app/trace_data.ts b/tools/winscope-ng/src/app/trace_data.ts new file mode 100644 index 000000000..5209bc821 --- /dev/null +++ b/tools/winscope-ng/src/app/trace_data.ts @@ -0,0 +1,129 @@ +/* + * Copyright (C) 2022 The Android Open Source Project + * + * 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 {ArrayUtils} from "common/utils/array_utils"; +import {ScreenRecordingTraceEntry} from "common/trace/screen_recording"; +import {Timestamp, TimestampType} from "common/trace/timestamp"; +import {Trace} from "common/trace/trace"; +import {TraceType} from "common/trace/trace_type"; +import {Parser} from "parsers/parser"; +import {ParserError, ParserFactory} from "parsers/parser_factory"; + +interface Timeline { + traceType: TraceType; + timestamps: Timestamp[]; +} + +class TraceData { + private parsers: Parser[] = []; + private commonTimestampType?: TimestampType; + + public async loadTraces(traces: File[]): Promise { + traces = this.parsers.map(parser => parser.getTrace().file).concat(traces); + let parserErrors: ParserError[]; + [this.parsers, parserErrors] = await new ParserFactory().createParsers(traces); + return parserErrors; + } + + public removeTrace(type: TraceType) { + this.parsers = this.parsers.filter(parser => parser.getTraceType() !== type); + } + + public getLoadedTraces(): Trace[] { + return this.parsers.map((parser: Parser) => parser.getTrace()); + } + + public getTraceEntries(timestamp: Timestamp|undefined): Map { + const traceEntries: Map = new Map(); + + if (!timestamp) { + return traceEntries; + } + + this.parsers.forEach(parser => { + const targetTimestamp = timestamp; + const entry = parser.getTraceEntry(targetTimestamp); + let prevEntry = null; + + const parserTimestamps = parser.getTimestamps(timestamp.getType()); + if (parserTimestamps === undefined) { + throw new Error(`Unexpected timestamp type ${timestamp.getType()}.` + + ` Not supported by parser for trace type: ${parser.getTraceType()}`); + } + + const index = ArrayUtils.binarySearchLowerOrEqual(parserTimestamps, targetTimestamp); + if (index !== undefined && index > 0) { + prevEntry = parser.getTraceEntry(parserTimestamps[index-1]); + } + + if (entry !== undefined) { + traceEntries.set(parser.getTraceType(), [entry, prevEntry]); + } + }); + + return traceEntries; + } + + public getTimelines(): Timeline[] { + const timelines = this.parsers.map((parser): Timeline => { + const timestamps = parser.getTimestamps(this.getCommonTimestampType()); + if (timestamps === undefined) { + throw Error("Failed to get timestamps from parser"); + } + return {traceType: parser.getTraceType(), timestamps: timestamps}; + }); + + return timelines; + } + + public getScreenRecordingVideo(): undefined|Blob { + const parser = this.parsers + .find((parser) => parser.getTraceType() === TraceType.SCREEN_RECORDING); + if (!parser) { + return undefined; + } + + const timestamps = parser.getTimestamps(this.getCommonTimestampType()); + if (!timestamps || timestamps.length === 0) { + return undefined; + } + + return (parser.getTraceEntry(timestamps[0]) as ScreenRecordingTraceEntry)?.videoData; + } + + public clear() { + this.parsers = []; + this.commonTimestampType = undefined; + } + + private getCommonTimestampType(): TimestampType { + if (this.commonTimestampType !== undefined) { + return this.commonTimestampType; + } + + const priorityOrder = [TimestampType.REAL, TimestampType.ELAPSED]; + for (const type of priorityOrder) { + if (this.parsers.every(it => it.getTimestamps(type) !== undefined)) { + this.commonTimestampType = type; + return this.commonTimestampType; + } + } + + throw Error("Failed to find common timestamp type across all traces"); + } +} + +export {Timeline, TraceData}; diff --git a/tools/winscope-ng/src/common/trace/screen_recording_utils.ts b/tools/winscope-ng/src/common/trace/screen_recording_utils.ts new file mode 100644 index 000000000..103e57c3a --- /dev/null +++ b/tools/winscope-ng/src/common/trace/screen_recording_utils.ts @@ -0,0 +1,30 @@ +/* + * Copyright (C) 2022 The Android Open Source Project + * + * 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 {Timestamp} from "./timestamp"; + +class ScreenRecordingUtils { + static timestampToVideoTimeSeconds(firstTimestamp: Timestamp, currentTimestamp: Timestamp) { + if (firstTimestamp.getType() !== currentTimestamp.getType()) { + throw new Error("Attempted to use timestamps with different type"); + } + const videoTimeSeconds = + Number(currentTimestamp.getValueNs() - firstTimestamp.getValueNs()) / 1000000000; + return videoTimeSeconds; + } +} + +export {ScreenRecordingUtils}; diff --git a/tools/winscope-ng/src/common/trace/trace.ts b/tools/winscope-ng/src/common/trace/trace.ts new file mode 100644 index 000000000..eec48d1d5 --- /dev/null +++ b/tools/winscope-ng/src/common/trace/trace.ts @@ -0,0 +1,24 @@ +/* + * Copyright (C) 2022 The Android Open Source Project + * + * 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 {TraceType} from "./trace_type"; + +interface Trace { + type: TraceType + file: File, +} + +export {Trace}; diff --git a/tools/winscope-ng/src/common/utils/file_utils.ts b/tools/winscope-ng/src/common/utils/file_utils.ts index eedf45c5a..b73dc07ee 100644 --- a/tools/winscope-ng/src/common/utils/file_utils.ts +++ b/tools/winscope-ng/src/common/utils/file_utils.ts @@ -16,16 +16,6 @@ import JSZip from "jszip"; class FileUtils { - static async createZipArchive(files: File[]): Promise { - const zip = new JSZip(); - for (let i=0; i < files.length; i++) { - const file = files[i]; - const blob = await file.arrayBuffer(); - zip.file(file.name, blob); - } - return await zip.generateAsync({type: "blob"}); - } - static async readFile(file: File): Promise { return await new Promise((resolve, _) => { const reader = new FileReader(); @@ -37,10 +27,6 @@ class FileUtils { }); } - static isZipFile(file: File) { - return this.getFileExtension(file) === "zip"; - } - static getFileExtension(file: File) { const split = file.name.split("."); if (split.length > 1) { @@ -58,6 +44,16 @@ class FileUtils { } } + static async createZipArchive(files: File[]): Promise { + const zip = new JSZip(); + for (let i=0; i < files.length; i++) { + const file = files[i]; + const blob = await file.arrayBuffer(); + zip.file(file.name, blob); + } + return await zip.generateAsync({type: "blob"}); + } + static async unzipFile(file: File): Promise { const unzippedFiles: File[] = []; const buffer: Uint8Array = await this.readFile(file); @@ -77,6 +73,23 @@ class FileUtils { } return unzippedFiles; } + + static async unzipFilesIfNeeded(files: File[]): Promise { + const unzippedFiles: File[] = []; + for (let i=0; i { + // do nothing + }; +} + +export {FunctionUtils}; diff --git a/tools/winscope-ng/src/common/utils/time_utils.spec.ts b/tools/winscope-ng/src/common/utils/time_utils.spec.ts index 758c139df..916a9bb64 100644 --- a/tools/winscope-ng/src/common/utils/time_utils.spec.ts +++ b/tools/winscope-ng/src/common/utils/time_utils.spec.ts @@ -13,7 +13,7 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -import { Timestamp, TimestampType } from "common/trace/timestamp"; +import {ElapsedTimestamp, RealTimestamp, Timestamp, TimestampType} from "common/trace/timestamp"; import {TimeUtils} from "./time_utils"; describe("TimeUtils", () => { @@ -23,6 +23,37 @@ describe("TimeUtils", () => { const HOUR = BigInt(60) * MINUTE; const DAY = BigInt(24) * HOUR; + describe("compareFn", () => { + it("throws if timestamps have different type", () => { + const real = new RealTimestamp(10n); + const elapsed = new ElapsedTimestamp(10n); + + expect(() => { + TimeUtils.compareFn(real, elapsed); + }).toThrow(); + }); + + it("allows to sort arrays", () => { + const array = [ + new RealTimestamp(100n), + new RealTimestamp(10n), + new RealTimestamp(12n), + new RealTimestamp(110n), + new RealTimestamp(11n), + ]; + array.sort(TimeUtils.compareFn); + + const expected = [ + new RealTimestamp(10n), + new RealTimestamp(11n), + new RealTimestamp(12n), + new RealTimestamp(100n), + new RealTimestamp(110n), + ]; + expect(array).toEqual(expected); + }); + }); + it("nanosecondsToHuman", () => { expect(TimeUtils.nanosecondsToHumanElapsed(0)) .toEqual("0ms"); expect(TimeUtils.nanosecondsToHumanElapsed(0, false)) .toEqual("0ns"); diff --git a/tools/winscope-ng/src/common/utils/time_utils.ts b/tools/winscope-ng/src/common/utils/time_utils.ts index 4f1aaa1d8..48d671e88 100644 --- a/tools/winscope-ng/src/common/utils/time_utils.ts +++ b/tools/winscope-ng/src/common/utils/time_utils.ts @@ -18,6 +18,13 @@ import { Timestamp, TimestampType } from "common/trace/timestamp"; import dateFormat, { masks } from "dateformat"; export class TimeUtils { + static compareFn(a: Timestamp, b: Timestamp): number { + if (a.getType() !== b.getType()) { + throw new Error("Attempted to compare two timestamps with different type"); + } + return Number(a.getValueNs() - b.getValueNs()); + } + static format(timestamp: Timestamp, hideNs = false): string { switch (timestamp.getType()) { case TimestampType.ELAPSED: { diff --git a/tools/winscope-ng/src/parsers/parser.ts b/tools/winscope-ng/src/parsers/parser.ts index c14b517e5..54e53d43f 100644 --- a/tools/winscope-ng/src/parsers/parser.ts +++ b/tools/winscope-ng/src/parsers/parser.ts @@ -15,9 +15,14 @@ */ import {ArrayUtils} from "common/utils/array_utils"; import {Timestamp, TimestampType} from "common/trace/timestamp"; +import {Trace} from "common/trace/trace"; import {TraceType} from "common/trace/trace_type"; abstract class Parser { + protected trace: File; + protected decodedEntries: any[] = []; + private timestamps: Map = new Map(); + protected constructor(trace: File) { this.trace = trace; } @@ -57,8 +62,11 @@ abstract class Parser { public abstract getTraceType(): TraceType; - public getTrace(): File { - return this.trace; + public getTrace(): Trace { + return { + type: this.getTraceType(), + file: this.trace + }; } public getTimestamps(type: TimestampType): undefined|Timestamp[] { @@ -85,10 +93,6 @@ abstract class Parser { protected abstract decodeTrace(trace: Uint8Array): any[]; protected abstract getTimestamp(type: TimestampType, decodedEntry: any): undefined|Timestamp; protected abstract processDecodedEntry(index: number, timestampType: TimestampType, decodedEntry: any): any; - - protected trace: File; - protected decodedEntries: any[] = []; - private timestamps: Map = new Map(); } export {Parser}; diff --git a/tools/winscope-ng/src/parsers/parser_screen_recording.ts b/tools/winscope-ng/src/parsers/parser_screen_recording.ts index c8c2352cd..cc1c37e1e 100644 --- a/tools/winscope-ng/src/parsers/parser_screen_recording.ts +++ b/tools/winscope-ng/src/parsers/parser_screen_recording.ts @@ -18,6 +18,7 @@ import {TraceType} from "common/trace/trace_type"; import {ArrayUtils} from "common/utils/array_utils"; import {Parser} from "./parser"; import {ScreenRecordingTraceEntry} from "common/trace/screen_recording"; +import {ScreenRecordingUtils} from "common/trace/screen_recording_utils"; class ScreenRecordingMetadataEntry { constructor(public timestampElapsedNs: bigint, public timestampRealtimeNs: bigint) { @@ -82,9 +83,10 @@ class ParserScreenRecording extends Parser { } override processDecodedEntry(index: number, timestampType: TimestampType, entry: ScreenRecordingMetadataEntry): ScreenRecordingTraceEntry { - const initialTimestampNs = this.getTimestamps(TimestampType.ELAPSED)![0].getValueNs(); - const currentTimestampNs = entry.timestampElapsedNs; - const videoTimeSeconds = Number(currentTimestampNs - initialTimestampNs) / 1000000000; + const initialTimestamp = this.getTimestamps(TimestampType.ELAPSED)![0]; + const currentTimestamp = new Timestamp(TimestampType.ELAPSED, entry.timestampElapsedNs); + const videoTimeSeconds = + ScreenRecordingUtils.timestampToVideoTimeSeconds(initialTimestamp, currentTimestamp); const videoData = this.trace; return new ScreenRecordingTraceEntry(videoTimeSeconds, videoData); }