-
Notifications
You must be signed in to change notification settings - Fork 669
/
plugin-host.js
181 lines (136 loc) · 5.2 KB
/
plugin-host.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
import { assignIn } from 'lodash';
import promisifyEvent from 'promisify-event';
import BROWSER_JOB_RESULT from '../../runner/browser-job-result';
import BrowserConnection from '../connection';
import WARNING_MESSAGE from '../../notifications/warning-message';
import { generateUniqueId } from 'testcafe-hammerhead';
const name = Symbol();
export default class BrowserProviderPluginHost {
constructor (providerObject, providerName) {
this.JOB_RESULT = assignIn({}, BROWSER_JOB_RESULT);
assignIn(this, providerObject);
this[name] = providerName;
}
// Helpers
get providerName () {
return this[name];
}
async runInitScript (browserId, code) {
const connection = BrowserConnection.getById(browserId);
return connection.runInitScript(`(${code})()`);
}
calculateWindowId () {
return generateUniqueId();
}
waitForConnectionReady (browserId) {
const connection = BrowserConnection.getById(browserId);
if (connection.isReady())
return Promise.resolve();
return promisifyEvent(connection, 'ready');
}
reportWarning (browserId, ...args) {
const connection = BrowserConnection.getById(browserId);
connection.addWarning(...args);
}
setUserAgentMetaInfo (browserId, message, ...args) {
const connection = BrowserConnection.getById(browserId);
connection.setProviderMetaInfo(message, ...args);
}
async closeLocalBrowser (browserId) {
const connection = BrowserConnection.getById(browserId);
await connection.provider._ensureBrowserWindowDescriptor(browserId);
await connection.provider._closeLocalBrowser(browserId);
}
async resizeLocalBrowserWindow (browserId, width, height, currentWidth, currentHeight) {
const connection = BrowserConnection.getById(browserId);
await connection.provider._ensureBrowserWindowParameters(browserId);
await connection.provider._resizeLocalBrowserWindow(browserId, width, height, currentWidth, currentHeight);
}
// API
// Browser control
async openBrowser (/* browserId, pageUrl, browserName */) {
throw new Error('Not implemented!');
}
async closeBrowser (/* browserId */) {
throw new Error('Not implemented!');
}
// Initialization
async init () {
return;
}
async dispose () {
return;
}
// Browser names handling
async getBrowserList () {
throw new Error('Not implemented!');
}
async isValidBrowserName (/* browserName */) {
return true;
}
// Extra functions
// NOTE:
// The browserName argument is optional, and must be supplied if the browserId argument is not valid
// (browser is not opened)
async isLocalBrowser (/* browserId[, browserName] */) {
return false;
}
// NOTE:
// The browserName argument is optional, and must be supplied if the browserId argument is not valid
// (browser is not opened)
isHeadlessBrowser (/* browserId[, browserName] */) {
return false;
}
async hasCustomActionForBrowser (/* browserId */) {
return {
hasCloseBrowser: this.hasOwnProperty('closeBrowser'),
hasResizeWindow: this.hasOwnProperty('resizeWindow'),
hasTakeScreenshot: this.hasOwnProperty('takeScreenshot'),
hasGetVideoFrameData: this.hasOwnProperty('getVideoFrameData'),
hasCanResizeWindowToDimensions: this.hasOwnProperty('canResizeWindowToDimensions'),
hasMaximizeWindow: this.hasOwnProperty('maximizeWindow'),
hasChromelessScreenshots: false,
};
}
async resizeWindow (browserId/*, width, height, currentWidth, currentHeight */) {
this.reportWarning(browserId, WARNING_MESSAGE.resizeNotSupportedByBrowserProvider, this[name]);
}
async canResizeWindowToDimensions (/* browserId, width, height */) {
return true;
}
async takeScreenshot (browserId/*, screenshotPath, pageWidth, pageHeight */) {
this.reportWarning(browserId, WARNING_MESSAGE.screenshotNotSupportedByBrowserProvider, this[name]);
}
async maximizeWindow (browserId) {
this.reportWarning(browserId, WARNING_MESSAGE.maximizeNotSupportedByBrowserProvider, this[name]);
}
async startCapturingVideo (/*browserId*/) {
}
async stopCapturingVideo (/*browserId*/) {
}
async getVideoFrameData (browserId) {
const browserAlias = BrowserConnection.getById(browserId).browserInfo.alias;
this.reportWarning(browserId, WARNING_MESSAGE.videoNotSupportedByBrowser, browserAlias);
}
async reportJobResult (/*browserId, status, data*/) {
return;
}
getConfig (value) {
return value;
}
async closeBrowserChildWindow (/*browserId, windowId*/) {
return Promise.resolve();
}
async getOSInfo (/*browserId*/) {
return null;
}
supportNativeAutomation () {
return false;
}
getNativeAutomation (/*browserId*/) {
return null;
}
getNewWindowIdInNativeAutomation (/*browserId, windowId*/) {
return Promise.resolve();
}
}