Skip to content

Commit 782d815

Browse files
snitin315snitin315
committed
refactor: client logging
1 parent 37201f9 commit 782d815

File tree

44 files changed

+692
-664
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+692
-664
lines changed

‎client-src/index.js

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import stripAnsi from "./utils/stripAnsi.js";
55
import parseURL from "./utils/parseURL.js";
66
import socket from "./socket.js";
77
import { formatProblem, show, hide } from "./overlay.js";
8-
import { log, setLogLevel } from "./utils/log.js";
8+
import { log, logEnabledFeatures, setLogLevel } from "./utils/log.js";
99
import sendMessage from "./utils/sendMessage.js";
1010
import reloadApp from "./utils/reloadApp.js";
1111
import createSocketURL from "./utils/createSocketURL.js";
@@ -46,22 +46,26 @@ const options = {
4646
};
4747
const parsedResourceQuery = parseURL(__resourceQuery);
4848

49-
const enabledFeatures = [];
49+
const enabledFeatures = {
50+
"Hot Module Replacement": false,
51+
"Live Reloading": false,
52+
Progress: false,
53+
Overlay: false,
54+
};
5055

5156
if (parsedResourceQuery.hot === "true") {
5257
options.hot = true;
53-
54-
enabledFeatures.push("Hot Module Replacement");
58+
enabledFeatures["Hot Module Replacement"] = true;
5559
}
5660

5761
if (parsedResourceQuery["live-reload"] === "true") {
5862
options.liveReload = true;
59-
enabledFeatures.push("Live Reloading");
63+
enabledFeatures["Live Reloading"] = true;
6064
}
6165

6266
if (parsedResourceQuery.progress === "true") {
6367
options.progress = true;
64-
enabledFeatures.push("Progress");
68+
enabledFeatures.Progress = true;
6569
}
6670

6771
if (parsedResourceQuery.overlay) {
@@ -79,7 +83,7 @@ if (parsedResourceQuery.overlay) {
7983
...options.overlay,
8084
};
8185
}
82-
enabledFeatures.push("Overlay");
86+
enabledFeatures.Overlay = true;
8387
}
8488

8589
if (parsedResourceQuery.logging) {
@@ -90,9 +94,7 @@ if (typeof parsedResourceQuery.reconnect !== "undefined") {
9094
options.reconnect = Number(parsedResourceQuery.reconnect);
9195
}
9296

93-
if (enabledFeatures.length > 0) {
94-
log.info(`server started with ${enabledFeatures.join(", ")} enabled.`);
95-
}
97+
logEnabledFeatures(enabledFeatures);
9698

9799
/**
98100
* @param {string} level

‎client-src/utils/log.js

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,22 @@ setLogLevel(defaultLevel);
1818

1919
const log = logger.getLogger(name);
2020

21-
export { log, setLogLevel };
21+
const logEnabledFeatures = (features) => {
22+
const enabledFeatures = Object.entries(features);
23+
if (!features || enabledFeatures.length === 0) {
24+
return;
25+
}
26+
27+
let logString = "Server started:";
28+
29+
// Server started: Hot Module Replacement enabled, Live Reloading enabled, Overlay disabled.
30+
for (const [key, value] of Object.entries(features)) {
31+
logString += ` ${key} ${value ? "enabled" : "disabled"},`;
32+
}
33+
// replace last comma with a period
34+
logString = logString.slice(0, -1).concat(".");
35+
36+
log.info(logString);
37+
};
38+
39+
export { log, logEnabledFeatures, setLogLevel };

‎test/e2e/__snapshots__/allowed-hosts.test.js.snap.webpack4

Lines changed: 28 additions & 28 deletions
Large diffs are not rendered by default.

‎test/e2e/__snapshots__/allowed-hosts.test.js.snap.webpack5

Lines changed: 28 additions & 28 deletions
Large diffs are not rendered by default.

‎test/e2e/__snapshots__/api.test.js.snap.webpack4

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
exports[`API Invalidate callback should use the default \`noop\` callback when invalidate is called without any callback: console messages 1`] = `
44
Array [
5-
"[webpack-dev-server] server started with Hot Module Replacement, Live Reloading, Overlay enabled.",
5+
"[webpack-dev-server] Server started: Hot Module Replacement enabled, Live Reloading enabled, Progress disabled, Overlay enabled.",
66
"[HMR] Waiting for update signal from WDS...",
77
"Hey.",
88
]
@@ -14,7 +14,7 @@ exports[`API Invalidate callback should use the default \`noop\` callback when i
1414

1515
exports[`API Invalidate callback should use the provided \`callback\` function: console messages 1`] = `
1616
Array [
17-
"[webpack-dev-server] server started with Hot Module Replacement, Live Reloading, Overlay enabled.",
17+
"[webpack-dev-server] Server started: Hot Module Replacement enabled, Live Reloading enabled, Progress disabled, Overlay enabled.",
1818
"[HMR] Waiting for update signal from WDS...",
1919
"Hey.",
2020
]
@@ -26,7 +26,7 @@ exports[`API Invalidate callback should use the provided \`callback\` function:
2626

2727
exports[`API Server.checkHostHeader should allow URLs with scheme for checking origin when the "option.client.webSocketURL" is object: console messages 1`] = `
2828
Array [
29-
"[webpack-dev-server] server started with Hot Module Replacement, Live Reloading, Overlay enabled.",
29+
"[webpack-dev-server] Server started: Hot Module Replacement enabled, Live Reloading enabled, Progress disabled, Overlay enabled.",
3030
"[HMR] Waiting for update signal from WDS...",
3131
"Hey.",
3232
"WebSocket connection to 'ws://test.host:8158/ws' failed: Error in connection establishment: net::ERR_NAME_NOT_RESOLVED",
@@ -44,7 +44,7 @@ exports[`API Server.checkHostHeader should allow URLs with scheme for checking o
4444

4545
exports[`API Server.getFreePort should retry finding the port for up to defaultPortRetry times (number): console messages 1`] = `
4646
Array [
47-
"[webpack-dev-server] server started with Hot Module Replacement, Live Reloading, Overlay enabled.",
47+
"[webpack-dev-server] Server started: Hot Module Replacement enabled, Live Reloading enabled, Progress disabled, Overlay enabled.",
4848
"[HMR] Waiting for update signal from WDS...",
4949
"Hey.",
5050
]
@@ -56,7 +56,7 @@ exports[`API Server.getFreePort should retry finding the port for up to defaultP
5656

5757
exports[`API Server.getFreePort should retry finding the port for up to defaultPortRetry times (string): console messages 1`] = `
5858
Array [
59-
"[webpack-dev-server] server started with Hot Module Replacement, Live Reloading, Overlay enabled.",
59+
"[webpack-dev-server] Server started: Hot Module Replacement enabled, Live Reloading enabled, Progress disabled, Overlay enabled.",
6060
"[HMR] Waiting for update signal from WDS...",
6161
"Hey.",
6262
]
@@ -68,7 +68,7 @@ exports[`API Server.getFreePort should retry finding the port for up to defaultP
6868

6969
exports[`API Server.getFreePort should retry finding the port when serial ports are busy: console messages 1`] = `
7070
Array [
71-
"[webpack-dev-server] server started with Hot Module Replacement, Live Reloading, Overlay enabled.",
71+
"[webpack-dev-server] Server started: Hot Module Replacement enabled, Live Reloading enabled, Progress disabled, Overlay enabled.",
7272
"[HMR] Waiting for update signal from WDS...",
7373
"Hey.",
7474
]
@@ -80,7 +80,7 @@ exports[`API Server.getFreePort should retry finding the port when serial ports
8080

8181
exports[`API Server.getFreePort should return the port when the port is \`null\`: console messages 1`] = `
8282
Array [
83-
"[webpack-dev-server] server started with Hot Module Replacement, Live Reloading, Overlay enabled.",
83+
"[webpack-dev-server] Server started: Hot Module Replacement enabled, Live Reloading enabled, Progress disabled, Overlay enabled.",
8484
"[HMR] Waiting for update signal from WDS...",
8585
"Hey.",
8686
]
@@ -92,7 +92,7 @@ exports[`API Server.getFreePort should return the port when the port is \`null\`
9292

9393
exports[`API Server.getFreePort should return the port when the port is undefined: console messages 1`] = `
9494
Array [
95-
"[webpack-dev-server] server started with Hot Module Replacement, Live Reloading, Overlay enabled.",
95+
"[webpack-dev-server] Server started: Hot Module Replacement enabled, Live Reloading enabled, Progress disabled, Overlay enabled.",
9696
"[HMR] Waiting for update signal from WDS...",
9797
"Hey.",
9898
]
@@ -106,7 +106,7 @@ exports[`API Server.getFreePort should throw the error when the port isn't found
106106

107107
exports[`API WEBPACK_SERVE environment variable should be present: console messages 1`] = `
108108
Array [
109-
"[webpack-dev-server] server started with Hot Module Replacement, Live Reloading, Overlay enabled.",
109+
"[webpack-dev-server] Server started: Hot Module Replacement enabled, Live Reloading enabled, Progress disabled, Overlay enabled.",
110110
"[HMR] Waiting for update signal from WDS...",
111111
"Hey.",
112112
]
@@ -118,7 +118,7 @@ exports[`API WEBPACK_SERVE environment variable should be present: response stat
118118

119119
exports[`API deprecated API should log warning when the "port" and "host" options from options different from arguments ('listen' method): console messages 1`] = `
120120
Array [
121-
"[webpack-dev-server] server started with Hot Module Replacement, Live Reloading, Overlay enabled.",
121+
"[webpack-dev-server] Server started: Hot Module Replacement enabled, Live Reloading enabled, Progress disabled, Overlay enabled.",
122122
"[HMR] Waiting for update signal from WDS...",
123123
"Hey.",
124124
]
@@ -130,7 +130,7 @@ exports[`API deprecated API should work with deprecated API ('listen' and 'close
130130

131131
exports[`API deprecated API should work with deprecated API ('listen' and 'close' methods): console messages 1`] = `
132132
Array [
133-
"[webpack-dev-server] server started with Hot Module Replacement, Live Reloading, Overlay enabled.",
133+
"[webpack-dev-server] Server started: Hot Module Replacement enabled, Live Reloading enabled, Progress disabled, Overlay enabled.",
134134
"[HMR] Waiting for update signal from WDS...",
135135
"Hey.",
136136
]
@@ -142,7 +142,7 @@ exports[`API deprecated API should work with deprecated API ('listen' and 'close
142142

143143
exports[`API deprecated API should work with deprecated API (only compiler in constructor): console messages 1`] = `
144144
Array [
145-
"[webpack-dev-server] server started with Hot Module Replacement, Live Reloading, Overlay enabled.",
145+
"[webpack-dev-server] Server started: Hot Module Replacement enabled, Live Reloading enabled, Progress disabled, Overlay enabled.",
146146
"[HMR] Waiting for update signal from WDS...",
147147
"Hey.",
148148
]
@@ -154,7 +154,7 @@ exports[`API deprecated API should work with deprecated API (only compiler in co
154154

155155
exports[`API deprecated API should work with deprecated API (the order of the arguments in the constructor): console messages 1`] = `
156156
Array [
157-
"[webpack-dev-server] server started with Hot Module Replacement, Live Reloading, Overlay enabled.",
157+
"[webpack-dev-server] Server started: Hot Module Replacement enabled, Live Reloading enabled, Progress disabled, Overlay enabled.",
158158
"[HMR] Waiting for update signal from WDS...",
159159
"Hey.",
160160
]
@@ -166,15 +166,15 @@ exports[`API deprecated API should work with deprecated API (the order of the ar
166166

167167
exports[`API latest async API should work and allow to rerun dev server multiple times: console messages 1`] = `
168168
Array [
169-
"[webpack-dev-server] server started with Hot Module Replacement, Live Reloading, Overlay enabled.",
169+
"[webpack-dev-server] Server started: Hot Module Replacement enabled, Live Reloading enabled, Progress disabled, Overlay enabled.",
170170
"[HMR] Waiting for update signal from WDS...",
171171
"Hey.",
172172
]
173173
`;
174174

175175
exports[`API latest async API should work and allow to rerun dev server multiple times: console messages 2`] = `
176176
Array [
177-
"[webpack-dev-server] server started with Hot Module Replacement, Live Reloading, Overlay enabled.",
177+
"[webpack-dev-server] Server started: Hot Module Replacement enabled, Live Reloading enabled, Progress disabled, Overlay enabled.",
178178
"[HMR] Waiting for update signal from WDS...",
179179
"Hey.",
180180
]
@@ -187,7 +187,7 @@ exports[`API latest async API should work and allow to rerun dev server multiple
187187
exports[`API latest async API should work when using configured manually: console messages 1`] = `
188188
Array [
189189
"[HMR] Waiting for update signal from WDS...",
190-
"[webpack-dev-server] server started with Hot Module Replacement enabled.",
190+
"[webpack-dev-server] Server started: Hot Module Replacement enabled, Live Reloading disabled, Progress disabled, Overlay disabled.",
191191
"Hey.",
192192
]
193193
`;
@@ -196,7 +196,7 @@ exports[`API latest async API should work when using configured manually: page e
196196

197197
exports[`API latest async API should work with async API: console messages 1`] = `
198198
Array [
199-
"[webpack-dev-server] server started with Hot Module Replacement, Live Reloading, Overlay enabled.",
199+
"[webpack-dev-server] Server started: Hot Module Replacement enabled, Live Reloading enabled, Progress disabled, Overlay enabled.",
200200
"[HMR] Waiting for update signal from WDS...",
201201
"Hey.",
202202
]
@@ -206,7 +206,7 @@ exports[`API latest async API should work with async API: page errors 1`] = `Arr
206206

207207
exports[`API latest async API should work with callback API: console messages 1`] = `
208208
Array [
209-
"[webpack-dev-server] server started with Hot Module Replacement, Live Reloading, Overlay enabled.",
209+
"[webpack-dev-server] Server started: Hot Module Replacement enabled, Live Reloading enabled, Progress disabled, Overlay enabled.",
210210
"[HMR] Waiting for update signal from WDS...",
211211
"Hey.",
212212
]

0 commit comments

Comments
 (0)