diff options
Diffstat (limited to 'devtools/client/performance/test/browser_perf-console-record-08.js')
| -rw-r--r-- | devtools/client/performance/test/browser_perf-console-record-08.js | 268 |
1 files changed, 268 insertions, 0 deletions
diff --git a/devtools/client/performance/test/browser_perf-console-record-08.js b/devtools/client/performance/test/browser_perf-console-record-08.js new file mode 100644 index 000000000..2ad81c413 --- /dev/null +++ b/devtools/client/performance/test/browser_perf-console-record-08.js @@ -0,0 +1,268 @@ +/* Any copyright is dedicated to the Public Domain. + http://creativecommons.org/publicdomain/zero/1.0/ */ +"use strict"; + +/** + * Tests if the profiler can correctly handle simultaneous console and manual + * recordings (via `console.profile` and clicking the record button). + */ + +const { Constants } = require("devtools/client/performance/modules/constants"); +const { SIMPLE_URL } = require("devtools/client/performance/test/helpers/urls"); +const { initPerformanceInTab, initConsoleInNewTab, teardownToolboxAndRemoveTab } = require("devtools/client/performance/test/helpers/panel-utils"); +const { startRecording, stopRecording } = require("devtools/client/performance/test/helpers/actions"); +const { waitForRecordingStartedEvents, waitForRecordingStoppedEvents } = require("devtools/client/performance/test/helpers/actions"); +const { once, times } = require("devtools/client/performance/test/helpers/event-utils"); +const { setSelectedRecording } = require("devtools/client/performance/test/helpers/recording-utils"); + +/** + * The following are bit flag constants that are used to represent the state of a + * recording. + */ + +// Represents a manually recorded profile, if a user hit the record button. +const MANUAL = 0; +// Represents a recorded profile from console.profile(). +const CONSOLE = 1; +// Represents a profile that is currently recording. +const RECORDING = 2; +// Represents a profile that is currently selected. +const SELECTED = 4; + +/** + * Utility function to provide a meaningful inteface for testing that the bits + * match for the recording state. + * @param {integer} expected - The expected bit values packed in an integer. + * @param {integer} actual - The actual bit values packed in an integer. + */ +function hasBitFlag(expected, actual) { + return !!(expected & actual); +} + +add_task(function* () { + // This test seems to take a very long time to finish on Linux VMs. + requestLongerTimeout(4); + + let { target, console } = yield initConsoleInNewTab({ + url: SIMPLE_URL, + win: window + }); + + let { panel } = yield initPerformanceInTab({ tab: target.tab }); + let { EVENTS, PerformanceController, OverviewView } = panel.panelWin; + + info("Recording 1 - Starting console.profile()..."); + let started = waitForRecordingStartedEvents(panel, { + // only emitted for manual recordings + skipWaitingForBackendReady: true + }); + yield console.profile("rust"); + yield started; + testRecordings(PerformanceController, [ + CONSOLE + SELECTED + RECORDING + ]); + + info("Recording 2 - Starting manual recording..."); + yield startRecording(panel); + testRecordings(PerformanceController, [ + CONSOLE + RECORDING, + MANUAL + RECORDING + SELECTED + ]); + + info("Recording 3 - Starting console.profile(\"3\")..."); + started = waitForRecordingStartedEvents(panel, { + // only emitted for manual recordings + skipWaitingForBackendReady: true, + // only emitted when an in-progress recording is selected + skipWaitingForOverview: true, + // the view state won't switch to "console-recording" unless the new + // in-progress recording is selected, which won't happen + skipWaitingForViewState: true, + }); + yield console.profile("3"); + yield started; + testRecordings(PerformanceController, [ + CONSOLE + RECORDING, + MANUAL + RECORDING + SELECTED, + CONSOLE + RECORDING + ]); + + info("Recording 4 - Starting console.profile(\"4\")..."); + started = waitForRecordingStartedEvents(panel, { + // only emitted for manual recordings + skipWaitingForBackendReady: true, + // only emitted when an in-progress recording is selected + skipWaitingForOverview: true, + // the view state won't switch to "console-recording" unless the new + // in-progress recording is selected, which won't happen + skipWaitingForViewState: true, + }); + yield console.profile("4"); + yield started; + testRecordings(PerformanceController, [ + CONSOLE + RECORDING, + MANUAL + RECORDING + SELECTED, + CONSOLE + RECORDING, + CONSOLE + RECORDING + ]); + + info("Recording 4 - Ending console.profileEnd()..."); + let stopped = waitForRecordingStoppedEvents(panel, { + // only emitted for manual recordings + skipWaitingForBackendReady: true, + // only emitted when a finished recording is selected + skipWaitingForOverview: true, + skipWaitingForSubview: true, + // the view state won't switch to "recorded" unless the new + // finished recording is selected, which won't happen + skipWaitingForViewState: true, + }); + yield console.profileEnd(); + yield stopped; + testRecordings(PerformanceController, [ + CONSOLE + RECORDING, + MANUAL + RECORDING + SELECTED, + CONSOLE + RECORDING, + CONSOLE + ]); + + info("Recording 4 - Select last recording..."); + let recordingSelected = once(PerformanceController, EVENTS.RECORDING_SELECTED); + setSelectedRecording(panel, 3); + yield recordingSelected; + testRecordings(PerformanceController, [ + CONSOLE + RECORDING, + MANUAL + RECORDING, + CONSOLE + RECORDING, + CONSOLE + SELECTED + ]); + ok(!OverviewView.isRendering(), + "Stop rendering overview when a completed recording is selected."); + + info("Recording 2 - Stop manual recording."); + + yield stopRecording(panel); + testRecordings(PerformanceController, [ + CONSOLE + RECORDING, + MANUAL + SELECTED, + CONSOLE + RECORDING, + CONSOLE + ]); + ok(!OverviewView.isRendering(), + "Stop rendering overview when a completed recording is selected."); + + info("Recording 1 - Select first recording."); + recordingSelected = once(PerformanceController, EVENTS.RECORDING_SELECTED); + setSelectedRecording(panel, 0); + yield recordingSelected; + testRecordings(PerformanceController, [ + CONSOLE + RECORDING + SELECTED, + MANUAL, + CONSOLE + RECORDING, + CONSOLE + ]); + ok(OverviewView.isRendering(), + "Should be rendering overview a recording in progress is selected."); + + // Ensure overview is still rendering. + yield times(OverviewView, EVENTS.UI_OVERVIEW_RENDERED, 3, { + expectedArgs: { "1": Constants.FRAMERATE_GRAPH_LOW_RES_INTERVAL } + }); + + info("Ending console.profileEnd()..."); + stopped = waitForRecordingStoppedEvents(panel, { + // only emitted for manual recordings + skipWaitingForBackendReady: true, + // only emitted when a finished recording is selected + skipWaitingForOverview: true, + skipWaitingForSubview: true, + // the view state won't switch to "recorded" unless the new + // finished recording is selected, which won't happen + skipWaitingForViewState: true, + }); + yield console.profileEnd(); + yield stopped; + testRecordings(PerformanceController, [ + CONSOLE + RECORDING + SELECTED, + MANUAL, + CONSOLE, + CONSOLE + ]); + ok(OverviewView.isRendering(), + "Should be rendering overview a recording in progress is selected."); + + // Ensure overview is still rendering. + yield times(OverviewView, EVENTS.UI_OVERVIEW_RENDERED, 3, { + expectedArgs: { "1": Constants.FRAMERATE_GRAPH_LOW_RES_INTERVAL } + }); + + info("Recording 5 - Start one more manual recording."); + yield startRecording(panel); + testRecordings(PerformanceController, [ + CONSOLE + RECORDING, + MANUAL, + CONSOLE, + CONSOLE, + MANUAL + RECORDING + SELECTED + ]); + ok(OverviewView.isRendering(), + "Should be rendering overview a recording in progress is selected."); + + // Ensure overview is still rendering. + yield times(OverviewView, EVENTS.UI_OVERVIEW_RENDERED, 3, { + expectedArgs: { "1": Constants.FRAMERATE_GRAPH_LOW_RES_INTERVAL } + }); + + info("Recording 5 - Stop manual recording."); + yield stopRecording(panel); + testRecordings(PerformanceController, [ + CONSOLE + RECORDING, + MANUAL, + CONSOLE, + CONSOLE, + MANUAL + SELECTED + ]); + ok(!OverviewView.isRendering(), + "Stop rendering overview when a completed recording is selected."); + + info("Recording 1 - Ending console.profileEnd()..."); + stopped = waitForRecordingStoppedEvents(panel, { + // only emitted for manual recordings + skipWaitingForBackendReady: true, + // only emitted when a finished recording is selected + skipWaitingForOverview: true, + skipWaitingForSubview: true, + // the view state won't switch to "recorded" unless the new + // in-progress recording is selected, which won't happen + skipWaitingForViewState: true, + }); + yield console.profileEnd(); + yield stopped; + testRecordings(PerformanceController, [ + CONSOLE, + MANUAL, + CONSOLE, + CONSOLE, + MANUAL + SELECTED + ]); + ok(!OverviewView.isRendering(), + "Stop rendering overview when a completed recording is selected."); + + yield teardownToolboxAndRemoveTab(panel); +}); + +function testRecordings(controller, expectedBitFlags) { + let recordings = controller.getRecordings(); + let current = controller.getCurrentRecording(); + is(recordings.length, expectedBitFlags.length, "Expected number of recordings."); + + recordings.forEach((recording, i) => { + const expected = expectedBitFlags[i]; + is(recording.isConsole(), hasBitFlag(expected, CONSOLE), + `Recording ${i + 1} has expected console state.`); + is(recording.isRecording(), hasBitFlag(expected, RECORDING), + `Recording ${i + 1} has expected console state.`); + is((recording == current), hasBitFlag(expected, SELECTED), + `Recording ${i + 1} has expected selected state.`); + }); +} |