-
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
/
DevServerPlugin.js
352 lines (296 loc) · 10.1 KB
/
DevServerPlugin.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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
'use strict';
/**
* An Entry, it can be of type string or string[] or Object<string | string[],string>
* @typedef {(string[] | string | Object<string | string[],string>)} Entry
*/
class DevServerPlugin {
/**
* @param {Object} options - Dev-Server options
*/
constructor(options) {
this.options = options;
}
getWebsocketTransport() {
let ClientImplementation;
let clientImplementationFound = true;
const isKnownWebSocketServerImplementation =
this.options.webSocketServer &&
typeof this.options.webSocketServer.type === 'string' &&
(this.options.webSocketServer.type === 'ws' ||
this.options.webSocketServer.type === 'sockjs');
let clientTransport;
if (this.options.client) {
if (typeof this.options.client.webSocketTransport !== 'undefined') {
clientTransport = this.options.client.webSocketTransport;
} else if (isKnownWebSocketServerImplementation) {
clientTransport = this.options.webSocketServer.type;
} else {
clientTransport = 'ws';
}
} else {
clientTransport = 'ws';
}
switch (typeof clientTransport) {
case 'string':
// could be 'sockjs', 'ws', or a path that should be required
if (clientTransport === 'sockjs') {
ClientImplementation = require.resolve(
'../../client/clients/SockJSClient'
);
} else if (clientTransport === 'ws') {
ClientImplementation = require.resolve(
'../../client/clients/WebsocketClient'
);
} else {
try {
// eslint-disable-next-line import/no-dynamic-require
ClientImplementation = require.resolve(clientTransport);
} catch (e) {
clientImplementationFound = false;
}
}
break;
default:
clientImplementationFound = false;
}
if (!clientImplementationFound) {
throw new Error(
`${
!isKnownWebSocketServerImplementation
? 'When you use custom web socket implementation you must explicitly specify client.webSocketTransport. '
: ''
}client.webSocketTransport must be a string denoting a default implementation (e.g. 'sockjs', 'ws') or a full path to a JS file via require.resolve(...) which exports a class `
);
}
return ClientImplementation;
}
/**
* @returns {string}
*/
getWebSocketURL() {
const { options } = this;
const searchParams = new URLSearchParams();
/** @type {"ws:" | "wss:" | "http:" | "https:" | "auto:"} */
let protocol;
// We are proxying dev server and need to specify custom `hostname`
if (typeof options.client.webSocketURL.protocol !== 'undefined') {
protocol = options.client.webSocketURL.protocol;
} else {
protocol = options.https ? 'wss:' : 'ws:';
}
searchParams.set('protocol', protocol);
if (typeof options.client.webSocketURL.username !== 'undefined') {
searchParams.set('username', options.client.webSocketURL.username);
}
if (typeof options.client.webSocketURL.password !== 'undefined') {
searchParams.set('password', options.client.webSocketURL.password);
}
/** @type {string} */
let hostname;
// SockJS is not supported server mode, so `hostname` and `port` can't specified, let's ignore them
// TODO show warning about this
const isSockJSType = options.webSocketServer.type === 'sockjs';
// We are proxying dev server and need to specify custom `hostname`
if (typeof options.client.webSocketURL.hostname !== 'undefined') {
hostname = options.client.webSocketURL.hostname;
}
// Web socket server works on custom `hostname`, only for `ws` because `sock-js` is not support custom `hostname`
else if (
typeof options.webSocketServer.options.host !== 'undefined' &&
!isSockJSType
) {
hostname = options.webSocketServer.options.host;
}
// The `host` option is specified
else if (typeof this.options.host !== 'undefined') {
hostname = this.options.host;
}
// The `port` option is not specified
else {
hostname = '0.0.0.0';
}
searchParams.set('hostname', hostname);
/** @type {number | string} */
let port;
// We are proxying dev server and need to specify custom `port`
if (typeof options.client.webSocketURL.port !== 'undefined') {
port = options.client.webSocketURL.port;
}
// Web socket server works on custom `port`, only for `ws` because `sock-js` is not support custom `port`
else if (
typeof options.webSocketServer.options.port !== 'undefined' &&
!isSockJSType
) {
port = options.webSocketServer.options.port;
}
// The `port` option is specified
else if (typeof options.port === 'number') {
port = options.port;
}
// The `port` option is specified using `string`
else if (typeof options.port === 'string' && options.port !== 'auto') {
port = Number(options.port);
}
// The `port` option is not specified or set to `auto`
else {
port = '0';
}
searchParams.set('port', String(port));
/** @type {string} */
let pathname = '';
// We are proxying dev server and need to specify custom `pathname`
if (typeof options.client.webSocketURL.pathname !== 'undefined') {
pathname = options.client.webSocketURL.pathname;
}
// Web socket server works on custom `path`
else if (
typeof options.webSocketServer.options.prefix !== 'undefined' ||
typeof options.webSocketServer.options.path !== 'undefined'
) {
pathname =
options.webSocketServer.options.prefix ||
options.webSocketServer.options.path;
}
searchParams.set('pathname', pathname);
if (typeof options.client.logging !== 'undefined') {
searchParams.set('logging', options.client.logging);
}
return searchParams.toString();
}
/**
* @returns {string}
*/
getClientEntry() {
/** @type {string} */
const webSocketURL = this.options.webSocketServer
? this.getWebSocketURL()
: '';
return `${require.resolve('../../client/index.js')}?${webSocketURL}`;
}
getHotEntry() {
const { options } = this;
/** @type {(string[] | string)} */
let hotEntry;
if (options.hot === 'only') {
hotEntry = require.resolve('webpack/hot/only-dev-server');
} else if (options.hot) {
hotEntry = require.resolve('webpack/hot/dev-server');
}
return hotEntry;
}
/**
* @param {Object} compilerOptions
* @returns {boolean}
*/
// eslint-disable-next-line class-methods-use-this
isWebTarget(compilerOptions) {
return compilerOptions.externalsPresets
? compilerOptions.externalsPresets.web
: [
'web',
'webworker',
'electron-preload',
'electron-renderer',
'node-webkit',
// eslint-disable-next-line no-undefined
undefined,
null,
].includes(compilerOptions.target);
}
/**
* Apply the plugin
* @param {Object} compiler the compiler instance
* @returns {void}
*/
apply(compiler) {
/**
*
* Description of the option for checkInject method
* @typedef {Function} checkInjectOptionsParam
* @param {Object} _config - compilerConfig
* @return {Boolean}
*/
const additionalEntries = [];
// TODO maybe empty empty client
if (this.options.client && this.isWebTarget(compiler.options)) {
const clientEntry = this.getClientEntry();
additionalEntries.push(clientEntry);
}
if (this.options.hot) {
const hotEntry = this.getHotEntry();
additionalEntries.push(hotEntry);
}
const webpack = compiler.webpack || require('webpack');
// use a hook to add entries if available
if (typeof webpack.EntryPlugin !== 'undefined') {
for (const additionalEntry of additionalEntries) {
new webpack.EntryPlugin(compiler.context, additionalEntry, {
// eslint-disable-next-line no-undefined
name: undefined,
}).apply(compiler);
}
} else {
/**
* prependEntry Method for webpack 4
* @param {Entry} originalEntry
* @param {Entry} newAdditionalEntries
* @returns {Entry}
*/
const prependEntry = (originalEntry, newAdditionalEntries) => {
if (typeof originalEntry === 'function') {
return () =>
Promise.resolve(originalEntry()).then((entry) =>
prependEntry(entry, newAdditionalEntries)
);
}
if (
typeof originalEntry === 'object' &&
!Array.isArray(originalEntry)
) {
/** @type {Object<string,string>} */
const clone = {};
Object.keys(originalEntry).forEach((key) => {
// entry[key] should be a string here
const entryDescription = originalEntry[key];
clone[key] = prependEntry(entryDescription, newAdditionalEntries);
});
return clone;
}
// in this case, entry is a string or an array.
// make sure that we do not add duplicates.
/** @type {Entry} */
const entriesClone = additionalEntries.slice(0);
[].concat(originalEntry).forEach((newEntry) => {
if (!entriesClone.includes(newEntry)) {
entriesClone.push(newEntry);
}
});
return entriesClone;
};
compiler.options.entry = prependEntry(
compiler.options.entry || './src',
additionalEntries
);
compiler.hooks.entryOption.call(
compiler.options.context,
compiler.options.entry
);
}
const providePlugin = new webpack.ProvidePlugin({
__webpack_dev_server_client__: this.getWebsocketTransport(),
});
providePlugin.apply(compiler);
compiler.options.plugins = compiler.options.plugins || [];
if (
this.options.hot &&
!compiler.options.plugins.find(
(p) => p.constructor === webpack.HotModuleReplacementPlugin
)
) {
// apply the HMR plugin, if it didn't exist before.
const plugin = new webpack.HotModuleReplacementPlugin();
plugin.apply(compiler);
}
}
}
module.exports = DevServerPlugin;