Rayan Kanso | 6890420 | 2019-02-21 14:16:25 | [diff] [blame] | 1 | // Copyright 2019 The Chromium Authors. All rights reserved. |
| 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
| 4 | |
| 5 | Resources.BackgroundServiceView = class extends UI.VBox { |
| 6 | /** |
Rayan Kanso | c0bfdd8 | 2019-04-24 12:32:22 | [diff] [blame] | 7 | * @param {string} serviceName The name of the background service. |
| 8 | * @return {string} The UI String to display. |
| 9 | */ |
| 10 | static getUIString(serviceName) { |
| 11 | switch (serviceName) { |
| 12 | case Protocol.BackgroundService.ServiceName.BackgroundFetch: |
| 13 | return ls`Background Fetch`; |
| 14 | case Protocol.BackgroundService.ServiceName.BackgroundSync: |
| 15 | return ls`Background Sync`; |
Fergus Dall | 0be4f4c | 2019-05-21 00:01:29 | [diff] [blame] | 16 | case Protocol.BackgroundService.ServiceName.PushMessaging: |
| 17 | return ls`Push Messaging`; |
| 18 | case Protocol.BackgroundService.ServiceName.Notifications: |
| 19 | return ls`Notifications`; |
Rayan Kanso | 8d7918a | 2019-07-03 21:03:38 | [diff] [blame] | 20 | case Protocol.BackgroundService.ServiceName.PaymentHandler: |
| 21 | return ls`Payment Handler`; |
Rayan Kanso | 5480967 | 2019-07-24 18:40:28 | [diff] [blame] | 22 | case Protocol.BackgroundService.ServiceName.PeriodicBackgroundSync: |
| 23 | return ls`Periodic Background Sync`; |
Rayan Kanso | c0bfdd8 | 2019-04-24 12:32:22 | [diff] [blame] | 24 | default: |
| 25 | return ''; |
| 26 | } |
| 27 | } |
| 28 | |
| 29 | /** |
Rayan Kanso | 8fe8ee2 | 2019-03-04 14:58:46 | [diff] [blame] | 30 | * @param {!Protocol.BackgroundService.ServiceName} serviceName |
| 31 | * @param {!Resources.BackgroundServiceModel} model |
Rayan Kanso | 6890420 | 2019-02-21 14:16:25 | [diff] [blame] | 32 | */ |
Rayan Kanso | 8fe8ee2 | 2019-03-04 14:58:46 | [diff] [blame] | 33 | constructor(serviceName, model) { |
Rayan Kanso | 6890420 | 2019-02-21 14:16:25 | [diff] [blame] | 34 | super(true); |
| 35 | this.registerRequiredCSS('resources/backgroundServiceView.css'); |
Rayan Kanso | 6156d22 | 2019-04-29 23:40:55 | [diff] [blame] | 36 | this.registerRequiredCSS('ui/emptyWidget.css'); |
Rayan Kanso | 6890420 | 2019-02-21 14:16:25 | [diff] [blame] | 37 | |
Rayan Kanso | 8fe8ee2 | 2019-03-04 14:58:46 | [diff] [blame] | 38 | /** @const {!Protocol.BackgroundService.ServiceName} */ |
Rayan Kanso | 6890420 | 2019-02-21 14:16:25 | [diff] [blame] | 39 | this._serviceName = serviceName; |
| 40 | |
Rayan Kanso | 8fe8ee2 | 2019-03-04 14:58:46 | [diff] [blame] | 41 | /** @const {!Resources.BackgroundServiceModel} */ |
| 42 | this._model = model; |
| 43 | this._model.addEventListener( |
| 44 | Resources.BackgroundServiceModel.Events.RecordingStateChanged, this._onRecordingStateChanged, this); |
Rayan Kanso | f40e315 | 2019-03-11 13:49:43 | [diff] [blame] | 45 | this._model.addEventListener( |
| 46 | Resources.BackgroundServiceModel.Events.BackgroundServiceEventReceived, this._onEventReceived, this); |
Rayan Kanso | 8fe8ee2 | 2019-03-04 14:58:46 | [diff] [blame] | 47 | this._model.enable(this._serviceName); |
| 48 | |
Rayan Kanso | aca06e7 | 2019-03-27 11:57:06 | [diff] [blame] | 49 | /** @const {?SDK.ServiceWorkerManager} */ |
| 50 | this._serviceWorkerManager = this._model.target().model(SDK.ServiceWorkerManager); |
| 51 | |
| 52 | /** @const {?SDK.SecurityOriginManager} */ |
| 53 | this._securityOriginManager = this._model.target().model(SDK.SecurityOriginManager); |
| 54 | this._securityOriginManager.addEventListener( |
| 55 | SDK.SecurityOriginManager.Events.MainSecurityOriginChanged, () => this._onOriginChanged()); |
| 56 | |
Rayan Kanso | cc02ea3 | 2019-05-02 21:26:52 | [diff] [blame] | 57 | |
| 58 | /** @const {!UI.Action} */ |
| 59 | this._recordAction = /** @type {!UI.Action} */ (UI.actionRegistry.action('background-service.toggle-recording')); |
Joel Einbinder | 346980e | 2019-07-16 15:35:48 | [diff] [blame] | 60 | /** @type {?UI.ToolbarButton} */ |
Rayan Kanso | 8fe8ee2 | 2019-03-04 14:58:46 | [diff] [blame] | 61 | this._recordButton = null; |
| 62 | |
Rayan Kanso | aca06e7 | 2019-03-27 11:57:06 | [diff] [blame] | 63 | /** @type {?UI.ToolbarCheckbox} */ |
| 64 | this._originCheckbox = null; |
| 65 | |
Rayan Kanso | b852ba8 | 2019-04-08 13:48:07 | [diff] [blame] | 66 | /** @type {?UI.ToolbarButton} */ |
| 67 | this._saveButton = null; |
| 68 | |
Rayan Kanso | 6890420 | 2019-02-21 14:16:25 | [diff] [blame] | 69 | /** @const {!UI.Toolbar} */ |
| 70 | this._toolbar = new UI.Toolbar('background-service-toolbar', this.contentElement); |
| 71 | this._setupToolbar(); |
Rayan Kanso | 3252d5e | 2019-03-27 11:37:24 | [diff] [blame] | 72 | |
Rayan Kanso | b451b4f | 2019-04-04 23:12:11 | [diff] [blame] | 73 | /** |
| 74 | * This will contain the DataGrid for displaying events, and a panel at the bottom for showing |
| 75 | * extra metadata related to the selected event. |
| 76 | * @const {!UI.SplitWidget} |
| 77 | */ |
| 78 | this._splitWidget = new UI.SplitWidget(/* isVertical= */ false, /* secondIsSidebar= */ true); |
| 79 | this._splitWidget.show(this.contentElement); |
| 80 | |
Rayan Kanso | 3252d5e | 2019-03-27 11:37:24 | [diff] [blame] | 81 | /** @const {!DataGrid.DataGrid} */ |
| 82 | this._dataGrid = this._createDataGrid(); |
Rayan Kanso | b451b4f | 2019-04-04 23:12:11 | [diff] [blame] | 83 | |
| 84 | /** @const {!UI.VBox} */ |
| 85 | this._previewPanel = new UI.VBox(); |
| 86 | |
Rayan Kanso | c0bfdd8 | 2019-04-24 12:32:22 | [diff] [blame] | 87 | /** @type {?Resources.BackgroundServiceView.EventDataNode} */ |
| 88 | this._selectedEventNode = null; |
| 89 | |
Rayan Kanso | b451b4f | 2019-04-04 23:12:11 | [diff] [blame] | 90 | /** @type {?UI.Widget} */ |
| 91 | this._preview = null; |
| 92 | |
| 93 | this._splitWidget.setMainWidget(this._dataGrid.asWidget()); |
| 94 | this._splitWidget.setSidebarWidget(this._previewPanel); |
| 95 | |
| 96 | this._showPreview(null); |
Rayan Kanso | 6890420 | 2019-02-21 14:16:25 | [diff] [blame] | 97 | } |
| 98 | |
| 99 | /** |
| 100 | * Creates the toolbar UI element. |
| 101 | */ |
Rayan Kanso | 8fe8ee2 | 2019-03-04 14:58:46 | [diff] [blame] | 102 | async _setupToolbar() { |
Rayan Kanso | cc02ea3 | 2019-05-02 21:26:52 | [diff] [blame] | 103 | this._recordButton = UI.Toolbar.createActionButton(this._recordAction); |
Rayan Kanso | 8fe8ee2 | 2019-03-04 14:58:46 | [diff] [blame] | 104 | this._toolbar.appendToolbarItem(this._recordButton); |
Rayan Kanso | 6890420 | 2019-02-21 14:16:25 | [diff] [blame] | 105 | |
Rayan Kanso | b852ba8 | 2019-04-08 13:48:07 | [diff] [blame] | 106 | const clearButton = new UI.ToolbarButton(ls`Clear`, 'largeicon-clear'); |
Rayan Kanso | b451b4f | 2019-04-04 23:12:11 | [diff] [blame] | 107 | clearButton.addEventListener(UI.ToolbarButton.Events.Click, () => this._clearEvents()); |
Rayan Kanso | 6890420 | 2019-02-21 14:16:25 | [diff] [blame] | 108 | this._toolbar.appendToolbarItem(clearButton); |
| 109 | |
| 110 | this._toolbar.appendSeparator(); |
| 111 | |
Rayan Kanso | b852ba8 | 2019-04-08 13:48:07 | [diff] [blame] | 112 | this._saveButton = new UI.ToolbarButton(ls`Save events`, 'largeicon-download'); |
| 113 | this._saveButton.addEventListener(UI.ToolbarButton.Events.Click, () => this._saveToFile()); |
| 114 | this._saveButton.setEnabled(false); |
| 115 | this._toolbar.appendToolbarItem(this._saveButton); |
Rayan Kanso | c0bfdd8 | 2019-04-24 12:32:22 | [diff] [blame] | 116 | |
| 117 | this._toolbar.appendSeparator(); |
| 118 | |
| 119 | this._originCheckbox = |
| 120 | new UI.ToolbarCheckbox(ls`Show events from other domains`, undefined, () => this._refreshView()); |
| 121 | this._toolbar.appendToolbarItem(this._originCheckbox); |
Rayan Kanso | 6890420 | 2019-02-21 14:16:25 | [diff] [blame] | 122 | } |
Rayan Kanso | 8fe8ee2 | 2019-03-04 14:58:46 | [diff] [blame] | 123 | |
| 124 | /** |
Rayan Kanso | b451b4f | 2019-04-04 23:12:11 | [diff] [blame] | 125 | * Displays all available events in the grid. |
| 126 | */ |
| 127 | _refreshView() { |
| 128 | this._clearView(); |
| 129 | const events = this._model.getEvents(this._serviceName).filter(event => this._acceptEvent(event)); |
Tim van der Lippe | 1d6e57a | 2019-09-30 11:55:34 | [diff] [blame^] | 130 | for (const event of events) { |
Rayan Kanso | b451b4f | 2019-04-04 23:12:11 | [diff] [blame] | 131 | this._addEvent(event); |
Tim van der Lippe | 1d6e57a | 2019-09-30 11:55:34 | [diff] [blame^] | 132 | } |
Rayan Kanso | b451b4f | 2019-04-04 23:12:11 | [diff] [blame] | 133 | } |
| 134 | |
| 135 | /** |
| 136 | * Clears the grid and panel. |
| 137 | */ |
| 138 | _clearView() { |
Rayan Kanso | c0bfdd8 | 2019-04-24 12:32:22 | [diff] [blame] | 139 | this._selectedEventNode = null; |
Rayan Kanso | b451b4f | 2019-04-04 23:12:11 | [diff] [blame] | 140 | this._dataGrid.rootNode().removeChildren(); |
Rayan Kanso | b852ba8 | 2019-04-08 13:48:07 | [diff] [blame] | 141 | this._saveButton.setEnabled(false); |
Rayan Kanso | c0bfdd8 | 2019-04-24 12:32:22 | [diff] [blame] | 142 | this._showPreview(null); |
Rayan Kanso | b451b4f | 2019-04-04 23:12:11 | [diff] [blame] | 143 | } |
| 144 | |
| 145 | /** |
Rayan Kanso | 8fe8ee2 | 2019-03-04 14:58:46 | [diff] [blame] | 146 | * Called when the `Toggle Record` button is clicked. |
| 147 | */ |
| 148 | _toggleRecording() { |
| 149 | this._model.setRecording(!this._recordButton.toggled(), this._serviceName); |
| 150 | } |
| 151 | |
| 152 | /** |
Rayan Kanso | 3252d5e | 2019-03-27 11:37:24 | [diff] [blame] | 153 | * Called when the `Clear` button is clicked. |
| 154 | */ |
Rayan Kanso | b451b4f | 2019-04-04 23:12:11 | [diff] [blame] | 155 | _clearEvents() { |
Rayan Kanso | 3252d5e | 2019-03-27 11:37:24 | [diff] [blame] | 156 | this._model.clearEvents(this._serviceName); |
| 157 | this._clearView(); |
| 158 | } |
| 159 | |
| 160 | /** |
Rayan Kanso | 8fe8ee2 | 2019-03-04 14:58:46 | [diff] [blame] | 161 | * @param {!Common.Event} event |
| 162 | */ |
| 163 | _onRecordingStateChanged(event) { |
| 164 | const state = /** @type {!Resources.BackgroundServiceModel.RecordingState} */ (event.data); |
Tim van der Lippe | 1d6e57a | 2019-09-30 11:55:34 | [diff] [blame^] | 165 | if (state.serviceName !== this._serviceName) { |
Rayan Kanso | 8fe8ee2 | 2019-03-04 14:58:46 | [diff] [blame] | 166 | return; |
Tim van der Lippe | 1d6e57a | 2019-09-30 11:55:34 | [diff] [blame^] | 167 | } |
Rayan Kanso | c0bfdd8 | 2019-04-24 12:32:22 | [diff] [blame] | 168 | |
Tim van der Lippe | 1d6e57a | 2019-09-30 11:55:34 | [diff] [blame^] | 169 | if (state.isRecording === this._recordButton.toggled()) { |
Rayan Kanso | c0bfdd8 | 2019-04-24 12:32:22 | [diff] [blame] | 170 | return; |
Tim van der Lippe | 1d6e57a | 2019-09-30 11:55:34 | [diff] [blame^] | 171 | } |
Rayan Kanso | c0bfdd8 | 2019-04-24 12:32:22 | [diff] [blame] | 172 | |
Rayan Kanso | 0b30aba | 2019-05-17 13:39:59 | [diff] [blame] | 173 | this._recordButton.setToggled(state.isRecording); |
Rayan Kanso | c0bfdd8 | 2019-04-24 12:32:22 | [diff] [blame] | 174 | this._showPreview(this._selectedEventNode); |
Rayan Kanso | 8fe8ee2 | 2019-03-04 14:58:46 | [diff] [blame] | 175 | } |
Rayan Kanso | f40e315 | 2019-03-11 13:49:43 | [diff] [blame] | 176 | |
| 177 | /** |
| 178 | * @param {!Common.Event} event |
| 179 | */ |
| 180 | _onEventReceived(event) { |
| 181 | const serviceEvent = /** @type {!Protocol.BackgroundService.BackgroundServiceEvent} */ (event.data); |
Tim van der Lippe | 1d6e57a | 2019-09-30 11:55:34 | [diff] [blame^] | 182 | if (!this._acceptEvent(serviceEvent)) { |
Rayan Kanso | f40e315 | 2019-03-11 13:49:43 | [diff] [blame] | 183 | return; |
Tim van der Lippe | 1d6e57a | 2019-09-30 11:55:34 | [diff] [blame^] | 184 | } |
Rayan Kanso | 3252d5e | 2019-03-27 11:37:24 | [diff] [blame] | 185 | this._addEvent(serviceEvent); |
| 186 | } |
| 187 | |
Rayan Kanso | aca06e7 | 2019-03-27 11:57:06 | [diff] [blame] | 188 | _onOriginChanged() { |
| 189 | // No need to refresh the view if we are already showing all events. |
Tim van der Lippe | 1d6e57a | 2019-09-30 11:55:34 | [diff] [blame^] | 190 | if (this._originCheckbox.checked()) { |
Rayan Kanso | aca06e7 | 2019-03-27 11:57:06 | [diff] [blame] | 191 | return; |
Tim van der Lippe | 1d6e57a | 2019-09-30 11:55:34 | [diff] [blame^] | 192 | } |
Rayan Kanso | aca06e7 | 2019-03-27 11:57:06 | [diff] [blame] | 193 | this._refreshView(); |
| 194 | } |
| 195 | |
Rayan Kanso | 3252d5e | 2019-03-27 11:37:24 | [diff] [blame] | 196 | /** |
| 197 | * @param {!Protocol.BackgroundService.BackgroundServiceEvent} serviceEvent |
| 198 | */ |
| 199 | _addEvent(serviceEvent) { |
Rayan Kanso | aca06e7 | 2019-03-27 11:57:06 | [diff] [blame] | 200 | const data = this._createEventData(serviceEvent); |
| 201 | const dataNode = new Resources.BackgroundServiceView.EventDataNode(data, serviceEvent.eventMetadata); |
Rayan Kanso | 3252d5e | 2019-03-27 11:37:24 | [diff] [blame] | 202 | this._dataGrid.rootNode().appendChild(dataNode); |
Rayan Kanso | b852ba8 | 2019-04-08 13:48:07 | [diff] [blame] | 203 | |
Rayan Kanso | c0bfdd8 | 2019-04-24 12:32:22 | [diff] [blame] | 204 | if (this._dataGrid.rootNode().children.length === 1) { |
| 205 | this._saveButton.setEnabled(true); |
| 206 | this._showPreview(this._selectedEventNode); |
| 207 | } |
Rayan Kanso | 3252d5e | 2019-03-27 11:37:24 | [diff] [blame] | 208 | } |
| 209 | |
| 210 | /** |
| 211 | * @return {!DataGrid.DataGrid} |
| 212 | */ |
| 213 | _createDataGrid() { |
| 214 | const columns = /** @type {!Array<!DataGrid.DataGrid.ColumnDescriptor>} */ ([ |
Rayan Kanso | b852ba8 | 2019-04-08 13:48:07 | [diff] [blame] | 215 | {id: 'id', title: ls`#`, weight: 1}, |
| 216 | {id: 'timestamp', title: ls`Timestamp`, weight: 8}, |
Rayan Kanso | c0bfdd8 | 2019-04-24 12:32:22 | [diff] [blame] | 217 | {id: 'eventName', title: ls`Event`, weight: 10}, |
Rayan Kanso | b852ba8 | 2019-04-08 13:48:07 | [diff] [blame] | 218 | {id: 'origin', title: ls`Origin`, weight: 10}, |
Rayan Kanso | cc02ea3 | 2019-05-02 21:26:52 | [diff] [blame] | 219 | {id: 'swScope', title: ls`SW Scope`, weight: 2}, |
Rayan Kanso | b852ba8 | 2019-04-08 13:48:07 | [diff] [blame] | 220 | {id: 'instanceId', title: ls`Instance ID`, weight: 10}, |
Rayan Kanso | 3252d5e | 2019-03-27 11:37:24 | [diff] [blame] | 221 | ]); |
| 222 | const dataGrid = new DataGrid.DataGrid(columns); |
| 223 | dataGrid.setStriped(true); |
Rayan Kanso | b451b4f | 2019-04-04 23:12:11 | [diff] [blame] | 224 | |
| 225 | dataGrid.addEventListener( |
| 226 | DataGrid.DataGrid.Events.SelectedNode, |
| 227 | event => this._showPreview(/** @type {!Resources.BackgroundServiceView.EventDataNode} */ (event.data))); |
| 228 | |
Rayan Kanso | 3252d5e | 2019-03-27 11:37:24 | [diff] [blame] | 229 | return dataGrid; |
| 230 | } |
| 231 | |
| 232 | /** |
Rayan Kanso | aca06e7 | 2019-03-27 11:57:06 | [diff] [blame] | 233 | * Creates the data object to pass to the DataGrid Node. |
| 234 | * @param {!Protocol.BackgroundService.BackgroundServiceEvent} serviceEvent |
| 235 | * @return {!Resources.BackgroundServiceView.EventData} |
| 236 | */ |
| 237 | _createEventData(serviceEvent) { |
Rayan Kanso | cc02ea3 | 2019-05-02 21:26:52 | [diff] [blame] | 238 | let swScope = ''; |
Rayan Kanso | aca06e7 | 2019-03-27 11:57:06 | [diff] [blame] | 239 | |
Rayan Kanso | cc02ea3 | 2019-05-02 21:26:52 | [diff] [blame] | 240 | // Try to get the scope of the Service Worker registration to be more user-friendly. |
| 241 | const registration = this._serviceWorkerManager.registrations().get(serviceEvent.serviceWorkerRegistrationId); |
Tim van der Lippe | 1d6e57a | 2019-09-30 11:55:34 | [diff] [blame^] | 242 | if (registration) { |
Rayan Kanso | cc02ea3 | 2019-05-02 21:26:52 | [diff] [blame] | 243 | swScope = registration.scopeURL.substr(registration.securityOrigin.length); |
Tim van der Lippe | 1d6e57a | 2019-09-30 11:55:34 | [diff] [blame^] | 244 | } |
Rayan Kanso | aca06e7 | 2019-03-27 11:57:06 | [diff] [blame] | 245 | |
| 246 | return { |
Rayan Kanso | c79a8bb | 2019-05-29 21:08:38 | [diff] [blame] | 247 | id: this._dataGrid.rootNode().children.length + 1, |
Rayan Kanso | aca06e7 | 2019-03-27 11:57:06 | [diff] [blame] | 248 | timestamp: UI.formatTimestamp(serviceEvent.timestamp * 1000, /* full= */ true), |
| 249 | origin: serviceEvent.origin, |
Rayan Kanso | cc02ea3 | 2019-05-02 21:26:52 | [diff] [blame] | 250 | swScope, |
Rayan Kanso | aca06e7 | 2019-03-27 11:57:06 | [diff] [blame] | 251 | eventName: serviceEvent.eventName, |
| 252 | instanceId: serviceEvent.instanceId, |
| 253 | }; |
| 254 | } |
| 255 | |
| 256 | /** |
Rayan Kanso | 3252d5e | 2019-03-27 11:37:24 | [diff] [blame] | 257 | * Filtration function to know whether event should be shown or not. |
| 258 | * @param {!Protocol.BackgroundService.BackgroundServiceEvent} event |
| 259 | * @return {boolean} |
| 260 | */ |
| 261 | _acceptEvent(event) { |
Tim van der Lippe | 1d6e57a | 2019-09-30 11:55:34 | [diff] [blame^] | 262 | if (event.service !== this._serviceName) { |
Rayan Kanso | aca06e7 | 2019-03-27 11:57:06 | [diff] [blame] | 263 | return false; |
Tim van der Lippe | 1d6e57a | 2019-09-30 11:55:34 | [diff] [blame^] | 264 | } |
Rayan Kanso | aca06e7 | 2019-03-27 11:57:06 | [diff] [blame] | 265 | |
Tim van der Lippe | 1d6e57a | 2019-09-30 11:55:34 | [diff] [blame^] | 266 | if (this._originCheckbox.checked()) { |
Rayan Kanso | aca06e7 | 2019-03-27 11:57:06 | [diff] [blame] | 267 | return true; |
Tim van der Lippe | 1d6e57a | 2019-09-30 11:55:34 | [diff] [blame^] | 268 | } |
Rayan Kanso | aca06e7 | 2019-03-27 11:57:06 | [diff] [blame] | 269 | |
| 270 | // Trim the trailing '/'. |
| 271 | const origin = event.origin.substr(0, event.origin.length - 1); |
| 272 | |
| 273 | return this._securityOriginManager.securityOrigins().includes(origin); |
Rayan Kanso | 3252d5e | 2019-03-27 11:37:24 | [diff] [blame] | 274 | } |
Rayan Kanso | b451b4f | 2019-04-04 23:12:11 | [diff] [blame] | 275 | |
| 276 | /** |
Rayan Kanso | 42c0f9e | 2019-09-02 12:21:09 | [diff] [blame] | 277 | * @return {!Element} |
| 278 | */ |
| 279 | _createLearnMoreLink() { |
| 280 | let url = |
| 281 | 'https://developers.google.com/web/tools/chrome-devtools/javascript/background-services?utm_source=devtools'; |
| 282 | |
| 283 | switch (this._serviceName) { |
| 284 | case Protocol.BackgroundService.ServiceName.BackgroundFetch: |
| 285 | url += '#fetch'; |
| 286 | break; |
| 287 | case Protocol.BackgroundService.ServiceName.BackgroundSync: |
| 288 | url += '#sync'; |
| 289 | break; |
| 290 | case Protocol.BackgroundService.ServiceName.PushMessaging: |
| 291 | url += '#push'; |
| 292 | break; |
| 293 | case Protocol.BackgroundService.ServiceName.Notifications: |
| 294 | url += '#notifications'; |
| 295 | break; |
| 296 | default: |
| 297 | break; |
| 298 | } |
| 299 | |
| 300 | return UI.XLink.create(url, ls`Learn more`); |
| 301 | } |
| 302 | |
| 303 | /** |
Rayan Kanso | b451b4f | 2019-04-04 23:12:11 | [diff] [blame] | 304 | * @param {?Resources.BackgroundServiceView.EventDataNode} dataNode |
| 305 | */ |
| 306 | _showPreview(dataNode) { |
Tim van der Lippe | 1d6e57a | 2019-09-30 11:55:34 | [diff] [blame^] | 307 | if (this._selectedEventNode && this._selectedEventNode === dataNode) { |
Rayan Kanso | c0bfdd8 | 2019-04-24 12:32:22 | [diff] [blame] | 308 | return; |
Tim van der Lippe | 1d6e57a | 2019-09-30 11:55:34 | [diff] [blame^] | 309 | } |
Rayan Kanso | c0bfdd8 | 2019-04-24 12:32:22 | [diff] [blame] | 310 | |
| 311 | this._selectedEventNode = dataNode; |
| 312 | |
Tim van der Lippe | 1d6e57a | 2019-09-30 11:55:34 | [diff] [blame^] | 313 | if (this._preview) { |
Rayan Kanso | b451b4f | 2019-04-04 23:12:11 | [diff] [blame] | 314 | this._preview.detach(); |
Tim van der Lippe | 1d6e57a | 2019-09-30 11:55:34 | [diff] [blame^] | 315 | } |
Rayan Kanso | b451b4f | 2019-04-04 23:12:11 | [diff] [blame] | 316 | |
Rayan Kanso | c0bfdd8 | 2019-04-24 12:32:22 | [diff] [blame] | 317 | if (this._selectedEventNode) { |
| 318 | this._preview = this._selectedEventNode.createPreview(); |
Rayan Kanso | 4476ca5 | 2019-07-22 11:51:24 | [diff] [blame] | 319 | this._preview.show(this._previewPanel.contentElement); |
| 320 | return; |
| 321 | } |
| 322 | |
| 323 | this._preview = new UI.VBox(); |
| 324 | this._preview.contentElement.classList.add('background-service-preview', 'fill'); |
| 325 | const centered = this._preview.contentElement.createChild('div'); |
| 326 | |
| 327 | if (this._dataGrid.rootNode().children.length) { |
Rayan Kanso | c0bfdd8 | 2019-04-24 12:32:22 | [diff] [blame] | 328 | // Inform users that grid entries are clickable. |
Rayan Kanso | 4476ca5 | 2019-07-22 11:51:24 | [diff] [blame] | 329 | centered.createChild('p').textContent = ls`Select an entry to view metadata`; |
Rayan Kanso | c0bfdd8 | 2019-04-24 12:32:22 | [diff] [blame] | 330 | } else if (this._recordButton.toggled()) { |
| 331 | // Inform users that we are recording/waiting for events. |
Rayan Kanso | 4476ca5 | 2019-07-22 11:51:24 | [diff] [blame] | 332 | const featureName = Resources.BackgroundServiceView.getUIString(this._serviceName); |
| 333 | centered.createChild('p').textContent = ls`Recording ${featureName} activity...`; |
| 334 | centered.createChild('p').textContent = |
| 335 | ls`DevTools will record all ${featureName} activity for up to 3 days, even when closed.`; |
Rayan Kanso | c0bfdd8 | 2019-04-24 12:32:22 | [diff] [blame] | 336 | } else { |
Rayan Kanso | cc02ea3 | 2019-05-02 21:26:52 | [diff] [blame] | 337 | const landingRecordButton = UI.Toolbar.createActionButton(this._recordAction); |
Rayan Kanso | c0bfdd8 | 2019-04-24 12:32:22 | [diff] [blame] | 338 | |
Rayan Kanso | 6156d22 | 2019-04-29 23:40:55 | [diff] [blame] | 339 | const recordKey = createElementWithClass('b', 'background-service-shortcut'); |
| 340 | recordKey.textContent = |
| 341 | UI.shortcutRegistry.shortcutDescriptorsForAction('background-service.toggle-recording')[0].name; |
| 342 | |
Rayan Kanso | f402ef3 | 2019-08-12 13:05:18 | [diff] [blame] | 343 | const inlineButton = UI.createInlineButton(landingRecordButton); |
| 344 | inlineButton.classList.add('background-service-record-inline-button'); |
| 345 | centered.createChild('p').appendChild( |
| 346 | UI.formatLocalized('Click the record button %s or hit %s to start recording.', [inlineButton, recordKey])); |
Rayan Kanso | 42c0f9e | 2019-09-02 12:21:09 | [diff] [blame] | 347 | |
| 348 | centered.appendChild(this._createLearnMoreLink()); |
Rayan Kanso | c0bfdd8 | 2019-04-24 12:32:22 | [diff] [blame] | 349 | } |
Rayan Kanso | b451b4f | 2019-04-04 23:12:11 | [diff] [blame] | 350 | |
| 351 | this._preview.show(this._previewPanel.contentElement); |
| 352 | } |
Rayan Kanso | b852ba8 | 2019-04-08 13:48:07 | [diff] [blame] | 353 | |
| 354 | /** |
| 355 | * Saves all currently displayed events in a file (JSON format). |
| 356 | */ |
| 357 | async _saveToFile() { |
| 358 | const fileName = `${this._serviceName}-${new Date().toISO8601Compact()}.json`; |
| 359 | const stream = new Bindings.FileOutputStream(); |
| 360 | |
| 361 | const accepted = await stream.open(fileName); |
Tim van der Lippe | 1d6e57a | 2019-09-30 11:55:34 | [diff] [blame^] | 362 | if (!accepted) { |
Rayan Kanso | b852ba8 | 2019-04-08 13:48:07 | [diff] [blame] | 363 | return; |
Tim van der Lippe | 1d6e57a | 2019-09-30 11:55:34 | [diff] [blame^] | 364 | } |
Rayan Kanso | b852ba8 | 2019-04-08 13:48:07 | [diff] [blame] | 365 | |
| 366 | const events = this._model.getEvents(this._serviceName).filter(event => this._acceptEvent(event)); |
| 367 | await stream.write(JSON.stringify(events, undefined, 2)); |
| 368 | stream.close(); |
| 369 | } |
Rayan Kanso | 3252d5e | 2019-03-27 11:37:24 | [diff] [blame] | 370 | }; |
| 371 | |
Rayan Kanso | aca06e7 | 2019-03-27 11:57:06 | [diff] [blame] | 372 | /** |
| 373 | * @typedef {{ |
| 374 | * id: number, |
| 375 | * timestamp: string, |
| 376 | * origin: string, |
Rayan Kanso | cc02ea3 | 2019-05-02 21:26:52 | [diff] [blame] | 377 | * swScope: string, |
Rayan Kanso | aca06e7 | 2019-03-27 11:57:06 | [diff] [blame] | 378 | * eventName: string, |
| 379 | * instanceId: string, |
| 380 | * }} |
| 381 | */ |
| 382 | Resources.BackgroundServiceView.EventData; |
| 383 | |
Rayan Kanso | 3252d5e | 2019-03-27 11:37:24 | [diff] [blame] | 384 | Resources.BackgroundServiceView.EventDataNode = class extends DataGrid.DataGridNode { |
| 385 | /** |
Rayan Kanso | aca06e7 | 2019-03-27 11:57:06 | [diff] [blame] | 386 | * @param {!Object<string, string>} data |
| 387 | * @param {!Array<!Protocol.BackgroundService.EventMetadata>} eventMetadata |
Rayan Kanso | 3252d5e | 2019-03-27 11:37:24 | [diff] [blame] | 388 | */ |
Rayan Kanso | aca06e7 | 2019-03-27 11:57:06 | [diff] [blame] | 389 | constructor(data, eventMetadata) { |
| 390 | super(data); |
Rayan Kanso | 3252d5e | 2019-03-27 11:37:24 | [diff] [blame] | 391 | |
| 392 | /** @const {!Array<!Protocol.BackgroundService.EventMetadata>} */ |
Rayan Kanso | c79a8bb | 2019-05-29 21:08:38 | [diff] [blame] | 393 | this._eventMetadata = eventMetadata.sort((m1, m2) => m1.key.compareTo(m2.key)); |
Rayan Kanso | 3252d5e | 2019-03-27 11:37:24 | [diff] [blame] | 394 | } |
| 395 | |
| 396 | /** |
Rayan Kanso | c0bfdd8 | 2019-04-24 12:32:22 | [diff] [blame] | 397 | * @return {!UI.VBox} |
Rayan Kanso | 3252d5e | 2019-03-27 11:37:24 | [diff] [blame] | 398 | */ |
Rayan Kanso | b451b4f | 2019-04-04 23:12:11 | [diff] [blame] | 399 | createPreview() { |
Rayan Kanso | c0bfdd8 | 2019-04-24 12:32:22 | [diff] [blame] | 400 | const preview = new UI.VBox(); |
| 401 | preview.element.classList.add('background-service-metadata'); |
| 402 | |
| 403 | for (const entry of this._eventMetadata) { |
| 404 | const div = createElementWithClass('div', 'background-service-metadata-entry'); |
| 405 | div.createChild('div', 'background-service-metadata-name').textContent = entry.key + ': '; |
Rayan Kanso | 4476ca5 | 2019-07-22 11:51:24 | [diff] [blame] | 406 | if (entry.value) { |
| 407 | div.createChild('div', 'background-service-metadata-value source-code').textContent = entry.value; |
| 408 | } else { |
| 409 | div.createChild('div', 'background-service-metadata-value background-service-empty-value').textContent = |
| 410 | ls`empty`; |
| 411 | } |
Rayan Kanso | c0bfdd8 | 2019-04-24 12:32:22 | [diff] [blame] | 412 | preview.element.appendChild(div); |
| 413 | } |
| 414 | |
| 415 | if (!preview.element.children.length) { |
| 416 | const div = createElementWithClass('div', 'background-service-metadata-entry'); |
| 417 | div.createChild('div', 'background-service-metadata-name').textContent = ls`No metadata for this event`; |
| 418 | preview.element.appendChild(div); |
| 419 | } |
| 420 | |
| 421 | return preview; |
Rayan Kanso | f40e315 | 2019-03-11 13:49:43 | [diff] [blame] | 422 | } |
Rayan Kanso | 6890420 | 2019-02-21 14:16:25 | [diff] [blame] | 423 | }; |
Rayan Kanso | 6156d22 | 2019-04-29 23:40:55 | [diff] [blame] | 424 | |
| 425 | /** |
| 426 | * @implements {UI.ActionDelegate} |
| 427 | * @unrestricted |
| 428 | */ |
| 429 | Resources.BackgroundServiceView.ActionDelegate = class { |
| 430 | /** |
| 431 | * @override |
| 432 | * @param {!UI.Context} context |
| 433 | * @param {string} actionId |
| 434 | * @return {boolean} |
| 435 | */ |
| 436 | handleAction(context, actionId) { |
| 437 | const view = context.flavor(Resources.BackgroundServiceView); |
| 438 | switch (actionId) { |
| 439 | case 'background-service.toggle-recording': |
| 440 | view._toggleRecording(); |
| 441 | return true; |
| 442 | } |
| 443 | return false; |
| 444 | } |
| 445 | }; |