Skip to content

migrate to built-in logger #2563

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 8 commits into from
Closed

migrate to built-in logger #2563

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
d85c473
chore(deps): upgrade chokidar (#2539)
knagaitsev Apr 27, 2020
4e9b3db
fix(run-open): introduce open instead of opn (#2532)
hiroppy Apr 27, 2020
4fc5ecd
chore(deps): upgrade some deps (#2542)
hiroppy Apr 29, 2020
f5498c9
test: support webapck5 (#2553)
hiroppy Apr 30, 2020
d29ddee
chore(deps): update package-lock.json (#2551)
hiroppy Apr 30, 2020
ecab24b
BREAKING CHANGE(server): get rid of conditions of Node version (#2552)
hiroppy Apr 30, 2020
308ee21
BREAKING CHANGE: remove inline and iframe/live mode (#2550)
knagaitsev May 1, 2020
b6af4e9
feat: migrate to built-in logger
hiroppy May 2, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .eslintignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
/client
!/test/client
coverage
client-src/live/web_modules/
node_modules
1 change: 0 additions & 1 deletion .prettierignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
/client
!/test/client
coverage
client-src/live/web_modules/
node_modules
CHANGELOG.md
18 changes: 0 additions & 18 deletions azure-pipelines.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,12 +52,6 @@ jobs:
node-10:
node_version: ^10.13.0
webpack_version: latest
node-8:
node_version: ^8.9.0
webpack_version: latest
node-6:
node_version: ^6.9.0
webpack_version: latest
node-10-canary:
node_version: ^10.13.0
webpack_version: next
Expand Down Expand Up @@ -111,12 +105,6 @@ jobs:
node-10:
node_version: ^10.13.0
webpack_version: latest
node-8:
node_version: ^8.9.0
webpack_version: latest
node-6:
node_version: ^6.9.0
webpack_version: latest
node-10-canary:
node_version: ^10.13.0
webpack_version: next
Expand Down Expand Up @@ -170,12 +158,6 @@ jobs:
node-10:
node_version: ^10.13.0
webpack_version: latest
node-8:
node_version: ^8.9.0
webpack_version: latest
node-6:
node_version: ^6.9.0
webpack_version: latest
node-10-canary:
node_version: ^10.13.0
webpack_version: next
Expand Down
12 changes: 0 additions & 12 deletions bin/cli-flags.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,6 @@ module.exports = {
type: Boolean,
describe: 'Broadcasts the server via ZeroConf networking on start',
},
{
name: 'lazy',
type: Boolean,
describe: 'Lazy',
},
{
name: 'liveReload',
type: Boolean,
Expand All @@ -31,13 +26,6 @@ module.exports = {
describe: 'Enables/Disables serveIndex middleware',
defaultValue: true,
},
{
name: 'inline',
type: Boolean,
defaultValue: true,
describe:
'Inline mode (set to false to disable including client scripts like livereload)',
},
{
name: 'profile',
type: Boolean,
Expand Down
17 changes: 1 addition & 16 deletions bin/options.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,6 @@ const options = {
type: 'boolean',
describe: 'Broadcasts the server via ZeroConf networking on start',
},
lazy: {
type: 'boolean',
describe: 'Lazy',
},
liveReload: {
type: 'boolean',
describe: 'Enables/Disables live reloading on changing files',
Expand All @@ -30,12 +26,6 @@ const options = {
describe: 'Enables/Disables serveIndex middleware',
default: true,
},
inline: {
type: 'boolean',
default: true,
describe:
'Inline mode (set to false to disable including client scripts like livereload)',
},
profile: {
type: 'boolean',
describe: 'Print compilation profile data for progress steps',
Expand Down Expand Up @@ -84,17 +74,12 @@ const options = {
default: true,
describe: 'Info',
},
quiet: {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Respect to infrastructurelogging.level.

type: 'boolean',
group: DISPLAY_GROUP,
describe: 'Quiet',
},
'client-log-level': {
type: 'string',
group: DISPLAY_GROUP,
default: 'info',
describe:
'Log level in the browser (trace, debug, info, warn, error or silent)',
'Log level in the browser (none, error, warn, info, log, verbose)',
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We've already talked about it and they should respect infrastructurelogging.level.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hm, in fact, client-log-level should respect infrastructurelogging.level? What do you think?

},
https: {
type: 'boolean',
Expand Down
15 changes: 7 additions & 8 deletions bin/webpack-dev-server.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

'use strict';

/* eslint-disable no-shadow, no-console */
/* eslint-disable no-shadow */

const fs = require('fs');
const net = require('net');
Expand All @@ -19,6 +19,7 @@ const getVersions = require('../lib/utils/getVersions');
const options = require('./options');

let server;
const log = createLogger(null);
const serverData = {
server: null,
};
Expand All @@ -38,12 +39,12 @@ if (importLocal(__filename)) {
try {
require.resolve('webpack-cli');
} catch (err) {
console.error('The CLI moved into a separate package: webpack-cli');
console.error(
log.error('The CLI moved into a separate package: webpack-cli');
log.error(
"Please install 'webpack-cli' in addition to webpack itself to use the CLI"
);
console.error('-> When using npm: npm i -D webpack-cli');
console.error('-> When using yarn: yarn add -D webpack-cli');
log.error('-> When using npm: npm i -D webpack-cli');
log.error('-> When using yarn: yarn add -D webpack-cli');

process.exitCode = 1;
}
Expand Down Expand Up @@ -86,8 +87,6 @@ const config = require(convertArgvPath)(yargs, argv, {
});

function startDevServer(config, options) {
const log = createLogger(options);

let compiler;

try {
Expand All @@ -103,7 +102,7 @@ function startDevServer(config, options) {
}

try {
server = new Server(compiler, options, log);
server = new Server(compiler, options);
serverData.server = server;
} catch (err) {
if (err.name === 'ValidationError') {
Expand Down
36 changes: 19 additions & 17 deletions client-src/default/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,16 @@
'use strict';

// webpack@5 doesn't inject node polyfill automatically
// this is for tapable
// window.process = require('process/browser');
// require('util/util');

/* global __resourceQuery WorkerGlobalScope self */
/* eslint prefer-destructuring: off */
const stripAnsi = require('strip-ansi');
const socket = require('./socket');
const overlay = require('./overlay');
const { log, setLogLevel } = require('./utils/log');
const createLogger = require('./utils/createLogger');
const sendMessage = require('./utils/sendMessage');
const reloadApp = require('./utils/reloadApp');
const createSocketUrl = require('./utils/createSocketUrl');
Expand All @@ -24,6 +29,7 @@ const options = {
useProgress: false,
};
const socketUrl = createSocketUrl(__resourceQuery);
let log = createLogger(null);

self.addEventListener('beforeunload', () => {
status.isUnloading = true;
Expand All @@ -37,14 +43,14 @@ if (typeof window !== 'undefined') {
const onSocketMessage = {
hot() {
options.hot = true;
log.info('[WDS] Hot Module Replacement enabled.');
log.info('Hot Module Replacement enabled.');
},
liveReload() {
options.liveReload = true;
log.info('[WDS] Live Reloading enabled.');
log.info('Live Reloading enabled.');
},
invalid() {
log.info('[WDS] App updated. Recompiling...');
log.info('App updated. Recompiling...');
// fixes #1042. overlay doesn't clear if errors are fixed but warnings remain.
if (options.useWarningOverlay || options.useErrorOverlay) {
overlay.clear();
Expand All @@ -55,18 +61,14 @@ const onSocketMessage = {
status.currentHash = hash;
},
'still-ok': function stillOk() {
log.info('[WDS] Nothing changed.');
log.info('Nothing changed.');
if (options.useWarningOverlay || options.useErrorOverlay) {
overlay.clear();
}
sendMessage('StillOk');
},
'log-level': function logLevel(level) {
const hotCtx = require.context('webpack/hot', false, /^\.\/log$/);
if (hotCtx.keys().indexOf('./log') !== -1) {
hotCtx('./log').setLogLevel(level);
Copy link
Member Author

@hiroppy hiroppy May 2, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure but I think this is unnecessary. I've already checked that this log-level is applied to clientLogLevel which is from CLI flag.

}
setLogLevel(level);
log = createLogger(level);
},
overlay(value) {
if (typeof document !== 'undefined') {
Expand All @@ -86,7 +88,7 @@ const onSocketMessage = {
},
'progress-update': function progressUpdate(data) {
if (options.useProgress) {
log.info(`[WDS] ${data.percent}% - ${data.msg}.`);
log.info(`${data.percent}% - ${data.msg}.`);
}
sendMessage('Progress', data);
},
Expand All @@ -98,14 +100,14 @@ const onSocketMessage = {
if (options.initial) {
return (options.initial = false);
} // eslint-disable-line no-return-assign
reloadApp(options, status);
reloadApp(options, status, log);
},
'content-changed': function contentChanged() {
log.info('[WDS] Content base changed. Reloading...');
log.info('Content base changed. Reloading...');
self.location.reload();
},
warnings(warnings) {
log.warn('[WDS] Warnings while compiling.');
log.warn('Warnings while compiling.');
const strippedWarnings = warnings.map((warning) => stripAnsi(warning));
sendMessage('Warnings', strippedWarnings);
for (let i = 0; i < strippedWarnings.length; i++) {
Expand All @@ -118,10 +120,10 @@ const onSocketMessage = {
if (options.initial) {
return (options.initial = false);
} // eslint-disable-line no-return-assign
reloadApp(options, status);
reloadApp(options, status, log);
},
errors(errors) {
log.error('[WDS] Errors while compiling. Reload prevented.');
log.error('Errors while compiling. Reload prevented.');
const strippedErrors = errors.map((error) => stripAnsi(error));
sendMessage('Errors', strippedErrors);
for (let i = 0; i < strippedErrors.length; i++) {
Expand All @@ -136,7 +138,7 @@ const onSocketMessage = {
log.error(error);
},
close() {
log.error('[WDS] Disconnected!');
log.error('Disconnected!');
sendMessage('Close');
},
};
Expand Down
8 changes: 3 additions & 5 deletions client-src/default/overlay.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,11 +113,9 @@ function clear() {
function showMessage(messages) {
ensureOverlayDivExists((div) => {
// Make it look similar to our terminal.
div.innerHTML = `<span style="color: #${
colors.red
}">Failed to compile.</span><br><br>${ansiHTML(
entities.encode(messages[0])
)}`;
const text = ansiHTML(entities.encode(messages[0]));

div.innerHTML = `<span style="color: #${colors.red}">Failed to compile.</span><br><br>${text}`;
});
}

Expand Down
15 changes: 15 additions & 0 deletions client-src/default/utils/createLogger.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
'use strict';

const log = require('webpack/lib/logging/runtime');

function createLogger(level = 'info') {
const name = 'webpack-dev-server';

log.configureDefaultLogger({
level,
});

return log.getLogger(name);
}

module.exports = createLogger;
47 changes: 0 additions & 47 deletions client-src/default/utils/log.js
View file
Open in desktop

This file was deleted.

9 changes: 4 additions & 5 deletions client-src/default/utils/reloadApp.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,16 @@

/* global WorkerGlobalScope self */

const { log } = require('./log');

function reloadApp(
{ hotReload, hot, liveReload },
{ isUnloading, currentHash }
{ isUnloading, currentHash },
log
) {
if (isUnloading || !hotReload) {
return;
}
if (hot) {
log.info('[WDS] App hot update...');
log.info('App hot update...');
const hotEmitter = require('webpack/hot/emitter');
hotEmitter.emit('webpackHotUpdate', currentHash);
if (typeof self !== 'undefined' && self.window) {
Expand Down Expand Up @@ -40,7 +39,7 @@ function reloadApp(

function applyReload(rootWindow, intervalId) {
clearInterval(intervalId);
log.info('[WDS] App updated. Reloading...');
log.info('App updated. Reloading...');
rootWindow.location.reload();
}
}
Expand Down
Loading