webpack/test/Compiler.test.js

1104 lines
28 KiB
JavaScript
Raw Permalink Normal View History

2017-01-18 16:03:37 +08:00
"use strict";
2013-01-31 01:49:25 +08:00
require("./helpers/warmup-webpack");
2013-01-31 01:49:25 +08:00
const path = require("path");
2025-07-03 17:06:45 +08:00
const { Volume, createFsFromVolume } = require("memfs");
const Stats = require("../lib/Stats");
2019-08-01 02:48:22 +08:00
const captureStdio = require("./helpers/captureStdio");
const deprecationTracking = require("./helpers/deprecationTracking");
2017-01-18 16:03:37 +08:00
describe("Compiler", () => {
2018-10-24 21:56:50 +08:00
jest.setTimeout(20000);
2013-01-31 01:49:25 +08:00
function compile(entry, options, callback) {
2017-01-18 16:03:37 +08:00
const noOutputPath = !options.output || !options.output.path;
const webpack = require("..");
options = webpack.config.getNormalizedWebpackOptions(options);
2018-02-25 18:46:17 +08:00
if (!options.mode) options.mode = "production";
2013-01-31 01:49:25 +08:00
options.entry = entry;
options.context = path.join(__dirname, "fixtures");
2018-02-25 18:46:17 +08:00
if (noOutputPath) options.output.path = "/";
2013-01-31 01:49:25 +08:00
options.output.pathinfo = true;
2017-12-13 23:05:21 +08:00
options.optimization = {
minimize: false
};
2017-01-18 16:03:37 +08:00
const logs = {
mkdir: [],
2018-02-25 18:46:17 +08:00
writeFile: []
};
2013-01-31 01:49:25 +08:00
2017-01-18 16:03:37 +08:00
const c = webpack(options);
const files = {};
2013-01-31 01:49:25 +08:00
c.outputFileSystem = {
mkdir(path, callback) {
logs.mkdir.push(path);
const err = new Error("error");
err.code = "EEXIST";
callback(err);
2013-01-31 01:49:25 +08:00
},
2018-01-24 23:00:43 +08:00
writeFile(name, content, callback) {
logs.writeFile.push(name, content);
files[name] = content.toString("utf8");
2013-01-31 01:49:25 +08:00
callback();
2019-11-04 18:40:36 +08:00
},
stat(path, callback) {
callback(new Error("ENOENT"));
2013-01-31 01:49:25 +08:00
}
};
2018-02-25 18:46:17 +08:00
c.hooks.compilation.tap(
"CompilerTest",
(compilation) => (compilation.bail = true)
2018-02-25 18:46:17 +08:00
);
2017-01-18 16:03:37 +08:00
c.run((err, stats) => {
2018-02-25 18:46:17 +08:00
if (err) throw err;
2018-01-24 23:00:43 +08:00
expect(typeof stats).toBe("object");
2017-01-18 16:03:37 +08:00
const compilation = stats.compilation;
2013-01-31 01:49:25 +08:00
stats = stats.toJson({
modules: true,
reasons: true
});
2018-01-24 23:00:43 +08:00
expect(typeof stats).toBe("object");
expect(stats).toHaveProperty("errors");
expect(Array.isArray(stats.errors)).toBe(true);
2018-02-25 18:46:17 +08:00
if (stats.errors.length > 0) {
2018-01-24 23:00:43 +08:00
expect(stats.errors[0]).toBeInstanceOf(Error);
2013-01-31 01:49:25 +08:00
throw stats.errors[0];
}
stats.logs = logs;
c.close((err) => {
2021-07-06 20:01:32 +08:00
if (err) return callback(err);
callback(stats, files, compilation);
});
2013-01-31 01:49:25 +08:00
});
}
2021-07-06 20:01:32 +08:00
let compiler;
afterEach((callback) => {
2021-07-06 20:01:32 +08:00
if (compiler) {
compiler.close(callback);
compiler = undefined;
} else {
callback();
}
});
it("should compile a single file to deep output", (done) => {
2018-02-25 18:46:17 +08:00
compile(
"./c",
{
output: {
path: "/what",
filename: "the/hell.js"
}
},
2025-07-08 22:46:17 +08:00
(stats, _files) => {
expect(stats.logs.mkdir).toEqual(["/what", "/what/the"]);
2018-02-25 18:46:17 +08:00
done();
}
2018-02-25 18:46:17 +08:00
);
});
it("should compile a single file", (done) => {
2017-01-18 16:03:37 +08:00
compile("./c", {}, (stats, files) => {
2018-01-24 23:00:43 +08:00
expect(Object.keys(files)).toEqual(["/main.js"]);
const bundle = files["/main.js"];
2018-01-24 23:00:43 +08:00
expect(bundle).toMatch("function __webpack_require__(");
2018-10-25 23:57:23 +08:00
expect(bundle).toMatch(/__webpack_require__\(\/\*! \.\/a \*\/ \w+\);/);
2018-01-24 23:00:43 +08:00
expect(bundle).toMatch("./c.js");
expect(bundle).toMatch("./a.js");
expect(bundle).toMatch("This is a");
expect(bundle).toMatch("This is c");
expect(bundle).not.toMatch("2: function(");
expect(bundle).not.toMatch("window");
expect(bundle).not.toMatch("jsonp");
expect(bundle).not.toMatch("fixtures");
2013-01-31 01:49:25 +08:00
done();
});
});
it("should compile a complex file", (done) => {
2017-01-18 16:03:37 +08:00
compile("./main1", {}, (stats, files) => {
2018-01-24 23:00:43 +08:00
expect(Object.keys(files)).toEqual(["/main.js"]);
const bundle = files["/main.js"];
2018-01-24 23:00:43 +08:00
expect(bundle).toMatch("function __webpack_require__(");
expect(bundle).toMatch("__webpack_require__(/*! ./a */");
expect(bundle).toMatch("./main1.js");
expect(bundle).toMatch("./a.js");
expect(bundle).toMatch("./b.js");
expect(bundle).toMatch("./node_modules/m1/a.js");
expect(bundle).toMatch("This is a");
expect(bundle).toMatch("This is b");
expect(bundle).toMatch("This is m1/a");
expect(bundle).not.toMatch("4: function(");
expect(bundle).not.toMatch("window");
expect(bundle).not.toMatch("jsonp");
expect(bundle).not.toMatch("fixtures");
2013-01-31 01:49:25 +08:00
done();
});
});
it("should compile a file with transitive dependencies", (done) => {
2017-01-18 16:03:37 +08:00
compile("./abc", {}, (stats, files) => {
2018-01-24 23:00:43 +08:00
expect(Object.keys(files)).toEqual(["/main.js"]);
const bundle = files["/main.js"];
2018-01-24 23:00:43 +08:00
expect(bundle).toMatch("function __webpack_require__(");
expect(bundle).toMatch("__webpack_require__(/*! ./a */");
expect(bundle).toMatch("__webpack_require__(/*! ./b */");
expect(bundle).toMatch("__webpack_require__(/*! ./c */");
expect(bundle).toMatch("./abc.js");
expect(bundle).toMatch("./a.js");
expect(bundle).toMatch("./b.js");
expect(bundle).toMatch("./c.js");
expect(bundle).toMatch("This is a");
expect(bundle).toMatch("This is b");
expect(bundle).toMatch("This is c");
expect(bundle).not.toMatch("4: function(");
expect(bundle).not.toMatch("window");
expect(bundle).not.toMatch("jsonp");
expect(bundle).not.toMatch("fixtures");
2013-01-31 01:49:25 +08:00
done();
});
});
it("should compile a file with multiple chunks", (done) => {
2017-01-18 16:03:37 +08:00
compile("./chunks", {}, (stats, files) => {
2018-01-24 23:00:43 +08:00
expect(stats.chunks).toHaveLength(2);
2024-02-02 03:21:24 +08:00
expect(Object.keys(files)).toEqual(["/main.js", "/78.js"]);
const bundle = files["/main.js"];
2024-02-02 03:21:24 +08:00
const chunk = files["/78.js"];
2018-01-24 23:00:43 +08:00
expect(bundle).toMatch("function __webpack_require__(");
expect(bundle).toMatch("__webpack_require__(/*! ./b */");
expect(chunk).not.toMatch("__webpack_require__(/* ./b */");
expect(bundle).toMatch("./chunks.js");
expect(chunk).toMatch("./a.js");
expect(chunk).toMatch("./b.js");
expect(chunk).toMatch("This is a");
expect(bundle).not.toMatch("This is a");
expect(chunk).toMatch("This is b");
expect(bundle).not.toMatch("This is b");
expect(bundle).not.toMatch("4: function(");
expect(bundle).not.toMatch("fixtures");
expect(chunk).not.toMatch("fixtures");
2020-08-28 17:20:58 +08:00
expect(bundle).toMatch("webpackChunk");
expect(chunk).toMatch('self["webpackChunk"] || []).push');
2013-01-31 01:49:25 +08:00
done();
});
});
// cspell:word asmjs
it("should not evaluate constants in asm.js", (done) => {
compile("./asmjs", {}, (stats, files) => {
expect(Object.keys(files)).toEqual(["/main.js"]);
const bundle = files["/main.js"];
expect(bundle).toMatch('"use asm";');
expect(bundle).toMatch("101");
expect(bundle).toMatch("102");
expect(bundle).toMatch("103");
expect(bundle).toMatch("104");
expect(bundle).toMatch("105");
expect(bundle).not.toMatch("106");
expect(bundle).not.toMatch("107");
expect(bundle).not.toMatch("108");
expect(bundle).toMatch("109");
expect(bundle).toMatch("110");
done();
});
});
2017-06-24 04:30:30 +08:00
describe("methods", () => {
let compiler;
2017-06-24 04:30:30 +08:00
beforeEach(() => {
const webpack = require("..");
2017-06-24 04:30:30 +08:00
compiler = webpack({
entry: "./c",
context: path.join(__dirname, "fixtures"),
output: {
2020-02-13 23:57:10 +08:00
path: "/directory",
2018-02-25 18:46:17 +08:00
pathinfo: true
2017-06-24 04:30:30 +08:00
}
});
});
afterEach((callback) => {
2021-07-06 20:01:32 +08:00
if (compiler) {
compiler.close(callback);
compiler = undefined;
} else {
callback();
}
});
it("default platform info", (done) => {
2024-05-01 23:10:57 +08:00
const platform = compiler.platform;
2024-05-01 22:54:03 +08:00
expect(platform.web).toBe(true);
expect(platform.node).toBe(false);
done();
});
2017-06-24 04:30:30 +08:00
describe("purgeInputFileSystem", () => {
it("invokes purge() if inputFileSystem.purge", (done) => {
2018-05-07 21:26:04 +08:00
const mockPurge = jest.fn();
2017-06-24 04:30:30 +08:00
compiler.inputFileSystem = {
2018-02-25 18:46:17 +08:00
purge: mockPurge
2017-06-24 04:30:30 +08:00
};
compiler.purgeInputFileSystem();
expect(mockPurge.mock.calls).toHaveLength(1);
2017-06-24 04:30:30 +08:00
done();
});
it("does NOT invoke purge() if !inputFileSystem.purge", (done) => {
2018-05-07 21:26:04 +08:00
const mockPurge = jest.fn();
2017-06-24 04:30:30 +08:00
compiler.inputFileSystem = null;
compiler.purgeInputFileSystem();
expect(mockPurge.mock.calls).toHaveLength(0);
2017-06-24 04:30:30 +08:00
done();
});
});
2017-06-24 04:30:30 +08:00
describe("isChild", () => {
it("returns booleanized this.parentCompilation", (done) => {
2017-06-24 04:30:30 +08:00
compiler.parentCompilation = "stringyStringString";
const response1 = compiler.isChild();
2018-01-24 23:00:43 +08:00
expect(response1).toBe(true);
2017-06-24 04:30:30 +08:00
compiler.parentCompilation = 123456789;
const response2 = compiler.isChild();
2018-01-24 23:00:43 +08:00
expect(response2).toBe(true);
2017-06-24 04:30:30 +08:00
2017-06-24 04:45:59 +08:00
compiler.parentCompilation = {
what: "I belong to an object"
};
2017-06-24 04:30:30 +08:00
const response3 = compiler.isChild();
2018-01-24 23:00:43 +08:00
expect(response3).toBe(true);
2017-06-24 04:30:30 +08:00
compiler.parentCompilation = ["Array", 123, true, null, [], () => {}];
const response4 = compiler.isChild();
2018-01-24 23:00:43 +08:00
expect(response4).toBe(true);
2017-06-24 04:30:30 +08:00
compiler.parentCompilation = false;
const response5 = compiler.isChild();
2018-01-24 23:00:43 +08:00
expect(response5).toBe(false);
2017-06-24 04:30:30 +08:00
compiler.parentCompilation = 0;
const response6 = compiler.isChild();
2018-01-24 23:00:43 +08:00
expect(response6).toBe(false);
2017-06-24 04:30:30 +08:00
compiler.parentCompilation = null;
const response7 = compiler.isChild();
2018-01-24 23:00:43 +08:00
expect(response7).toBe(false);
2017-06-24 04:30:30 +08:00
compiler.parentCompilation = "";
const response8 = compiler.isChild();
2018-01-24 23:00:43 +08:00
expect(response8).toBe(false);
2017-06-24 04:30:30 +08:00
2024-08-02 02:36:27 +08:00
compiler.parentCompilation = Number.NaN;
2017-06-24 04:30:30 +08:00
const response9 = compiler.isChild();
2018-01-24 23:00:43 +08:00
expect(response9).toBe(false);
2017-06-24 04:30:30 +08:00
done();
});
});
});
2024-05-01 22:54:03 +08:00
it("platformPlugin", (done) => {
2024-05-01 22:54:03 +08:00
const webpack = require("..");
2024-05-01 22:54:03 +08:00
const compiler = webpack({
entry: "./c",
context: path.join(__dirname, "fixtures"),
output: {
path: "/directory"
},
plugins: [
new (require("../lib/PlatformPlugin"))({ node: true }),
(compiler) => {
2024-05-01 22:54:03 +08:00
compiler.hooks.afterEnvironment.tap("test", () => {
2024-05-01 23:10:57 +08:00
const platform = compiler.platform;
2024-05-01 22:54:03 +08:00
expect(platform.node).toBe(true);
expect(platform.web).toBe(true);
});
}
]
});
compiler.close(done);
});
it("should not emit on errors", (done) => {
const webpack = require("..");
2021-07-06 20:01:32 +08:00
compiler = webpack({
context: __dirname,
mode: "production",
entry: "./missing",
output: {
2020-02-13 23:57:10 +08:00
path: "/directory",
filename: "bundle.js"
}
});
compiler.outputFileSystem = createFsFromVolume(new Volume());
2025-07-08 22:46:17 +08:00
compiler.run((err, _stats) => {
2018-02-25 18:46:17 +08:00
if (err) return done(err);
if (compiler.outputFileSystem.existsSync("/bundle.js")) {
return done(new Error("Bundle should not be created on error"));
}
done();
});
});
2021-06-22 15:29:10 +08:00
it("should bubble up errors when wrapped in a promise and bail is true", async () => {
2025-04-22 20:42:33 +08:00
let errored;
try {
const createCompiler = (options) =>
2024-07-31 11:31:11 +08:00
new Promise((resolve, reject) => {
const webpack = require("..");
const c = webpack(options);
c.run((err, stats) => {
if (err) {
reject(err);
}
if (stats !== undefined && "errors" in stats) {
reject(err);
} else {
resolve(stats);
}
});
});
2021-07-06 20:01:32 +08:00
compiler = await createCompiler({
context: __dirname,
mode: "production",
entry: "./missing-file",
output: {
2020-02-13 23:57:10 +08:00
path: "/directory",
filename: "bundle.js"
},
bail: true
});
} catch (err) {
2025-04-22 20:42:33 +08:00
errored = err;
}
2025-04-22 20:42:33 +08:00
if (!errored) {
throw new Error("Should throw an error");
}
expect(errored.toString()).toMatch(
"ModuleNotFoundError: Module not found: Error: Can't resolve './missing-file'"
);
});
2021-06-22 15:29:10 +08:00
it("should not emit compilation errors in async (watch)", async () => {
const createStats = (options) =>
2024-07-31 11:31:11 +08:00
new Promise((resolve, reject) => {
const webpack = require("..");
2021-06-22 15:29:10 +08:00
const c = webpack(options);
c.outputFileSystem = createFsFromVolume(new Volume());
const watching = c.watch({}, (err, stats) => {
watching.close(() => {
if (err) return reject(err);
resolve(stats);
});
});
});
const stats = await createStats({
2021-06-22 15:29:10 +08:00
context: __dirname,
mode: "production",
entry: "./missing-file",
output: {
path: "/directory",
filename: "bundle.js"
}
});
expect(stats).toBeInstanceOf(Stats);
});
it("should not emit on errors (watch)", (done) => {
const webpack = require("..");
2021-07-06 20:01:32 +08:00
compiler = webpack({
context: __dirname,
mode: "production",
entry: "./missing",
output: {
2020-02-13 23:57:10 +08:00
path: "/directory",
filename: "bundle.js"
}
});
compiler.outputFileSystem = createFsFromVolume(new Volume());
2025-07-08 22:46:17 +08:00
const watching = compiler.watch({}, (err, _stats) => {
watching.close();
2018-02-25 18:46:17 +08:00
if (err) return done(err);
if (compiler.outputFileSystem.existsSync("/bundle.js")) {
return done(new Error("Bundle should not be created on error"));
}
done();
});
});
it("should not be running twice at a time (run)", (done) => {
const webpack = require("..");
2021-07-06 20:01:32 +08:00
compiler = webpack({
context: __dirname,
mode: "production",
entry: "./c",
output: {
2020-02-13 23:57:10 +08:00
path: "/directory",
filename: "bundle.js"
}
});
compiler.outputFileSystem = createFsFromVolume(new Volume());
2025-07-08 22:46:17 +08:00
compiler.run((err, _stats) => {
if (err) return done(err);
});
2025-07-08 22:46:17 +08:00
compiler.run((err, _stats) => {
if (err) return done();
});
});
it("should not be running twice at a time (watch)", (done) => {
const webpack = require("..");
2021-07-06 20:01:32 +08:00
compiler = webpack({
context: __dirname,
mode: "production",
entry: "./c",
output: {
2020-02-13 23:57:10 +08:00
path: "/directory",
filename: "bundle.js"
}
});
compiler.outputFileSystem = createFsFromVolume(new Volume());
2025-07-08 22:46:17 +08:00
compiler.watch({}, (err, _stats) => {
if (err) return done(err);
});
2025-07-08 22:46:17 +08:00
compiler.watch({}, (err, _stats) => {
if (err) return done();
});
2018-03-07 06:31:14 +08:00
});
it("should not be running twice at a time (run - watch)", (done) => {
const webpack = require("..");
2021-07-06 20:01:32 +08:00
compiler = webpack({
context: __dirname,
mode: "production",
entry: "./c",
output: {
2020-02-13 23:57:10 +08:00
path: "/directory",
filename: "bundle.js"
}
});
compiler.outputFileSystem = createFsFromVolume(new Volume());
2025-07-08 22:46:17 +08:00
compiler.run((err, _stats) => {
if (err) return done(err);
});
2025-07-08 22:46:17 +08:00
compiler.watch({}, (err, _stats) => {
if (err) return done();
});
});
it("should not be running twice at a time (watch - run)", (done) => {
const webpack = require("..");
2021-07-06 20:01:32 +08:00
compiler = webpack({
context: __dirname,
mode: "production",
entry: "./c",
output: {
2020-02-13 23:57:10 +08:00
path: "/directory",
filename: "bundle.js"
}
});
compiler.outputFileSystem = createFsFromVolume(new Volume());
2025-07-08 22:46:17 +08:00
compiler.watch({}, (err, _stats) => {
if (err) return done(err);
});
2025-07-08 22:46:17 +08:00
compiler.run((err, _stats) => {
if (err) return done();
});
});
it("should not be running twice at a time (instance cb)", (done) => {
const webpack = require("..");
2021-07-06 20:01:32 +08:00
compiler = webpack(
2018-03-07 06:31:14 +08:00
{
context: __dirname,
mode: "production",
entry: "./c",
output: {
2020-02-13 23:57:10 +08:00
path: "/directory",
2018-03-07 06:31:14 +08:00
filename: "bundle.js"
}
},
() => {}
);
compiler.outputFileSystem = createFsFromVolume(new Volume());
2025-07-08 22:46:17 +08:00
compiler.run((err, _stats) => {
if (err) return done();
});
});
it("should run again correctly after first compilation", (done) => {
const webpack = require("..");
2021-07-06 20:01:32 +08:00
compiler = webpack({
context: __dirname,
mode: "production",
entry: "./c",
output: {
2020-02-13 23:57:10 +08:00
path: "/directory",
filename: "bundle.js"
}
});
compiler.outputFileSystem = createFsFromVolume(new Volume());
2021-05-18 22:54:16 +08:00
compiler.run((err, stats1) => {
2018-03-07 06:31:14 +08:00
if (err) return done(err);
2025-07-08 22:46:17 +08:00
compiler.run((err, _stats2) => {
2018-03-07 06:31:14 +08:00
if (err) return done(err);
2021-05-18 22:54:16 +08:00
expect(stats1.toString({ all: true })).toBeTypeOf("string");
2018-03-07 06:31:14 +08:00
done();
});
});
});
it("should watch again correctly after first compilation", (done) => {
const webpack = require("..");
2021-07-06 20:01:32 +08:00
compiler = webpack({
context: __dirname,
mode: "production",
entry: "./c",
output: {
2020-02-13 23:57:10 +08:00
path: "/directory",
filename: "bundle.js"
}
});
compiler.outputFileSystem = createFsFromVolume(new Volume());
2025-07-08 22:46:17 +08:00
compiler.run((err, _stats) => {
2018-03-07 06:31:14 +08:00
if (err) return done(err);
2025-07-08 22:46:17 +08:00
const watching = compiler.watch({}, (err, _stats) => {
2018-03-07 06:31:14 +08:00
if (err) return done(err);
2021-07-06 20:01:32 +08:00
watching.close(done);
2018-03-07 06:31:14 +08:00
});
});
});
it("should run again correctly after first closed watch", (done) => {
const webpack = require("..");
2021-07-06 20:01:32 +08:00
compiler = webpack({
context: __dirname,
mode: "production",
entry: "./c",
output: {
2020-02-13 23:57:10 +08:00
path: "/directory",
filename: "bundle.js"
}
});
compiler.outputFileSystem = createFsFromVolume(new Volume());
2025-07-08 22:46:17 +08:00
const watching = compiler.watch({}, (err, _stats) => {
2018-03-07 06:31:14 +08:00
if (err) return done(err);
});
watching.close(() => {
2025-07-08 22:46:17 +08:00
compiler.run((err, _stats) => {
2018-03-07 06:31:14 +08:00
if (err) return done(err);
done();
});
});
});
it("should set compiler.watching correctly", (done) => {
const webpack = require("..");
2021-07-06 20:01:32 +08:00
compiler = webpack({
2020-09-19 12:52:34 +08:00
context: __dirname,
mode: "production",
entry: "./c",
output: {
path: "/directory",
filename: "bundle.js"
}
});
compiler.outputFileSystem = createFsFromVolume(new Volume());
2025-07-08 22:46:17 +08:00
const watching = compiler.watch({}, (err, _stats) => {
2020-09-19 12:52:34 +08:00
if (err) return done(err);
2021-07-06 20:01:32 +08:00
watching.close(done);
2020-09-19 12:52:34 +08:00
});
expect(compiler.watching).toBe(watching);
});
it("should watch again correctly after first closed watch", (done) => {
const webpack = require("..");
2021-07-06 20:01:32 +08:00
compiler = webpack({
2018-03-07 17:16:40 +08:00
context: __dirname,
mode: "production",
entry: "./c",
output: {
2020-02-13 23:57:10 +08:00
path: "/directory",
2018-03-07 17:16:40 +08:00
filename: "bundle.js"
}
});
compiler.outputFileSystem = createFsFromVolume(new Volume());
2025-07-08 22:46:17 +08:00
const watching = compiler.watch({}, (err, _stats) => {
2018-03-07 17:16:40 +08:00
if (err) return done(err);
});
watching.close(() => {
2025-07-08 22:46:17 +08:00
compiler.watch({}, (err, _stats) => {
2018-03-07 17:16:40 +08:00
if (err) return done(err);
done();
});
});
2018-12-25 15:08:45 +08:00
});
it("should run again correctly inside afterDone hook", (done) => {
const webpack = require("..");
2021-07-06 20:01:32 +08:00
compiler = webpack({
2018-12-25 15:08:45 +08:00
context: __dirname,
mode: "production",
entry: "./c",
output: {
2020-02-13 23:57:10 +08:00
path: "/directory",
2018-12-25 15:08:45 +08:00
filename: "bundle.js"
}
});
compiler.outputFileSystem = createFsFromVolume(new Volume());
2019-07-10 21:01:13 +08:00
let once = true;
2018-12-25 15:08:45 +08:00
compiler.hooks.afterDone.tap("RunAgainTest", () => {
2019-07-10 21:01:13 +08:00
if (!once) return;
once = false;
2025-07-08 22:46:17 +08:00
compiler.run((err, _stats) => {
2018-12-25 15:08:45 +08:00
if (err) return done(err);
done();
});
});
2025-07-08 22:46:17 +08:00
compiler.run((err, _stats) => {
2018-12-25 15:08:45 +08:00
if (err) return done(err);
});
});
it("should call afterDone hook after other callbacks (run)", (done) => {
const webpack = require("..");
2021-07-06 20:01:32 +08:00
compiler = webpack({
2018-12-25 15:08:45 +08:00
context: __dirname,
mode: "production",
entry: "./c",
output: {
2020-02-13 23:57:10 +08:00
path: "/directory",
2018-12-25 15:08:45 +08:00
filename: "bundle.js"
}
});
compiler.outputFileSystem = createFsFromVolume(new Volume());
const runCb = jest.fn();
const doneHookCb = jest.fn();
compiler.hooks.done.tap("afterDoneRunTest", doneHookCb);
compiler.hooks.afterDone.tap("afterDoneRunTest", () => {
expect(runCb).toHaveBeenCalled();
expect(doneHookCb).toHaveBeenCalled();
done();
});
2025-07-08 22:46:17 +08:00
compiler.run((err, _stats) => {
2019-07-10 20:58:31 +08:00
if (err) return done(err);
runCb();
});
});
it("should call afterDone hook after other callbacks (instance cb)", (done) => {
const instanceCb = jest.fn();
const webpack = require("..");
2021-07-06 20:01:32 +08:00
compiler = webpack(
2019-07-10 20:58:31 +08:00
{
context: __dirname,
mode: "production",
entry: "./c",
output: {
2020-02-13 23:57:10 +08:00
path: "/directory",
2019-07-10 20:58:31 +08:00
filename: "bundle.js"
}
},
2025-07-08 22:46:17 +08:00
(err, _stats) => {
2019-07-10 20:58:31 +08:00
if (err) return done(err);
instanceCb();
}
2019-07-10 20:58:31 +08:00
);
compiler.outputFileSystem = createFsFromVolume(new Volume());
const doneHookCb = jest.fn();
compiler.hooks.done.tap("afterDoneRunTest", doneHookCb);
compiler.hooks.afterDone.tap("afterDoneRunTest", () => {
expect(instanceCb).toHaveBeenCalled();
expect(doneHookCb).toHaveBeenCalled();
done();
});
});
it("should call afterDone hook after other callbacks (watch)", (done) => {
const webpack = require("..");
2021-07-06 20:01:32 +08:00
compiler = webpack({
context: __dirname,
mode: "production",
entry: "./c",
output: {
2020-02-13 23:57:10 +08:00
path: "/directory",
filename: "bundle.js"
}
});
compiler.outputFileSystem = createFsFromVolume(new Volume());
const invalidHookCb = jest.fn();
const doneHookCb = jest.fn();
const watchCb = jest.fn();
const invalidateCb = jest.fn();
compiler.hooks.invalid.tap("afterDoneWatchTest", invalidHookCb);
compiler.hooks.done.tap("afterDoneWatchTest", doneHookCb);
compiler.hooks.afterDone.tap("afterDoneWatchTest", () => {
expect(invalidHookCb).toHaveBeenCalled();
expect(doneHookCb).toHaveBeenCalled();
expect(watchCb).toHaveBeenCalled();
expect(invalidateCb).toHaveBeenCalled();
2021-07-06 20:01:32 +08:00
watching.close(done);
});
2025-07-08 22:46:17 +08:00
const watching = compiler.watch({}, (err, _stats) => {
2018-12-25 15:08:45 +08:00
if (err) return done(err);
watchCb();
2018-12-25 15:08:45 +08:00
});
process.nextTick(() => {
2021-07-06 20:01:32 +08:00
watching.invalidate(invalidateCb);
});
});
it("should call afterDone hook after other callbacks (watch close)", (done) => {
const webpack = require("..");
2021-07-06 20:01:32 +08:00
compiler = webpack({
context: __dirname,
mode: "production",
entry: "./c",
output: {
2020-02-13 23:57:10 +08:00
path: "/directory",
filename: "bundle.js"
}
});
compiler.outputFileSystem = createFsFromVolume(new Volume());
const invalidHookCb = jest.fn();
const watchCloseCb = jest.fn();
const watchCloseHookCb = jest.fn();
const invalidateCb = jest.fn();
compiler.hooks.invalid.tap("afterDoneWatchTest", invalidHookCb);
compiler.hooks.watchClose.tap("afterDoneWatchTest", watchCloseHookCb);
compiler.hooks.afterDone.tap("afterDoneWatchTest", () => {
expect(invalidHookCb).toHaveBeenCalled();
expect(watchCloseCb).toHaveBeenCalled();
expect(watchCloseHookCb).toHaveBeenCalled();
expect(invalidateCb).toHaveBeenCalled();
done();
});
2025-07-08 22:46:17 +08:00
const watch = compiler.watch({}, (err, _stats) => {
2018-12-25 15:08:45 +08:00
if (err) return done(err);
watch.close(watchCloseCb);
2018-12-25 15:08:45 +08:00
});
process.nextTick(() => {
watch.invalidate(invalidateCb);
});
2018-03-07 17:16:40 +08:00
});
it("should flag watchMode as true in watch", (done) => {
const webpack = require("..");
2021-07-06 20:01:32 +08:00
compiler = webpack({
context: __dirname,
mode: "production",
entry: "./c",
output: {
2020-02-13 23:57:10 +08:00
path: "/directory",
filename: "bundle.js"
}
});
compiler.outputFileSystem = createFsFromVolume(new Volume());
2018-10-24 02:12:36 +08:00
const watch = compiler.watch({}, (err) => {
if (err) return done(err);
2018-10-23 07:12:42 +08:00
expect(compiler.watchMode).toBeTruthy();
2018-10-24 02:12:36 +08:00
watch.close(() => {
expect(compiler.watchMode).toBeFalsy();
done();
});
});
2018-10-23 07:12:42 +08:00
});
it("should use cache on second run call", (done) => {
const webpack = require("..");
2021-07-06 20:01:32 +08:00
compiler = webpack({
2018-06-20 03:41:23 +08:00
context: __dirname,
mode: "development",
devtool: false,
entry: "./fixtures/count-loader!./fixtures/count-loader",
output: {
2020-02-13 23:57:10 +08:00
path: "/directory"
2018-06-20 03:41:23 +08:00
}
});
compiler.outputFileSystem = createFsFromVolume(new Volume());
2018-06-20 03:41:23 +08:00
compiler.run(() => {
compiler.run(() => {
const result = compiler.outputFileSystem.readFileSync(
2020-02-13 23:57:10 +08:00
"/directory/main.js",
"utf8"
2018-06-20 03:41:23 +08:00
);
expect(result).toContain("module.exports = 0;");
done();
});
});
2018-06-20 16:23:26 +08:00
});
it("should call the failed-hook on error", (done) => {
const failedSpy = jest.fn();
const webpack = require("..");
2021-07-06 20:01:32 +08:00
compiler = webpack({
bail: true,
context: __dirname,
mode: "production",
entry: "./missing",
output: {
2020-02-13 23:57:10 +08:00
path: "/directory",
filename: "bundle.js"
}
});
compiler.hooks.failed.tap("CompilerTest", failedSpy);
compiler.outputFileSystem = createFsFromVolume(new Volume());
2025-07-08 22:46:17 +08:00
compiler.run((err, _stats) => {
expect(err).toBeTruthy();
expect(failedSpy).toHaveBeenCalledTimes(1);
expect(failedSpy).toHaveBeenCalledWith(err);
done();
});
});
it("should deprecate when watch option is used without callback", () => {
const tracker = deprecationTracking.start();
const webpack = require("..");
compiler = webpack({
watch: true
});
const deprecations = tracker();
expect(deprecations).toEqual([
expect.objectContaining({
code: "DEP_WEBPACK_WATCH_WITHOUT_CALLBACK"
})
]);
});
2019-07-22 15:18:00 +08:00
describe("infrastructure logging", () => {
2019-08-01 02:48:22 +08:00
let capture;
2019-07-22 15:18:00 +08:00
beforeEach(() => {
2019-08-01 02:48:22 +08:00
capture = captureStdio(process.stderr);
2019-07-22 15:18:00 +08:00
});
2019-07-22 15:18:00 +08:00
afterEach(() => {
2019-08-01 02:48:22 +08:00
capture.restore();
2019-07-22 15:18:00 +08:00
});
const escapeAnsi = (stringRaw) =>
stringRaw
2024-08-02 02:36:27 +08:00
.replace(/\u001B\[1m\u001B\[([0-9;]*)m/g, "<CLR=$1,BOLD>")
.replace(/\u001B\[1m/g, "<CLR=BOLD>")
.replace(/\u001B\[39m\u001B\[22m/g, "</CLR>")
.replace(/\u001B\[([0-9;]*)m/g, "<CLR=$1>");
2019-07-22 16:35:26 +08:00
class MyPlugin {
apply(compiler) {
const logger = compiler.getInfrastructureLogger("MyPlugin");
logger.time("Time");
logger.group("Group");
logger.error("Error");
logger.warn("Warning");
logger.info("Info");
logger.log("Log");
logger.debug("Debug");
2021-04-04 11:16:58 +08:00
logger.groupCollapsed("Collapsed group");
2019-07-22 16:35:26 +08:00
logger.log("Log inside collapsed group");
logger.groupEnd();
logger.groupEnd();
logger.timeEnd("Time");
2019-07-22 15:18:00 +08:00
}
2019-07-22 16:35:26 +08:00
}
it("should log to the console (verbose)", (done) => {
const webpack = require("..");
2021-07-06 20:01:32 +08:00
compiler = webpack({
2019-07-22 15:18:00 +08:00
context: path.join(__dirname, "fixtures"),
entry: "./a",
output: {
2020-02-13 23:57:10 +08:00
path: "/directory",
2019-07-22 15:18:00 +08:00
filename: "bundle.js"
},
infrastructureLogging: {
level: "verbose"
},
plugins: [new MyPlugin()]
});
compiler.outputFileSystem = createFsFromVolume(new Volume());
2025-07-08 22:46:17 +08:00
compiler.run((_err, _stats) => {
expect(capture.toString().replace(/[\d.]+ ms/, "X ms"))
2019-08-01 02:48:22 +08:00
.toMatchInlineSnapshot(`
"<-> [MyPlugin] Group
<e> [MyPlugin] Error
<w> [MyPlugin] Warning
<i> [MyPlugin] Info
[MyPlugin] Log
2021-04-04 11:16:58 +08:00
<-> [MyPlugin] Collapsed group
2019-08-01 02:48:22 +08:00
[MyPlugin] Log inside collapsed group
<t> [MyPlugin] Time: X ms
2019-08-01 02:48:22 +08:00
"
`);
2019-07-22 15:18:00 +08:00
done();
});
});
it("should log to the console (debug mode)", (done) => {
const webpack = require("..");
2021-07-06 20:01:32 +08:00
compiler = webpack({
2019-07-22 16:35:26 +08:00
context: path.join(__dirname, "fixtures"),
entry: "./a",
output: {
2020-02-13 23:57:10 +08:00
path: "/directory",
2019-07-22 16:35:26 +08:00
filename: "bundle.js"
},
infrastructureLogging: {
level: "error",
debug: /MyPlugin/
},
plugins: [new MyPlugin()]
});
compiler.outputFileSystem = createFsFromVolume(new Volume());
2025-07-08 22:46:17 +08:00
compiler.run((_err, _stats) => {
expect(capture.toString().replace(/[\d.]+ ms/, "X ms"))
2019-08-01 02:48:22 +08:00
.toMatchInlineSnapshot(`
"<-> [MyPlugin] Group
<e> [MyPlugin] Error
<w> [MyPlugin] Warning
<i> [MyPlugin] Info
[MyPlugin] Log
[MyPlugin] Debug
2021-04-04 11:16:58 +08:00
<-> [MyPlugin] Collapsed group
2019-08-01 02:48:22 +08:00
[MyPlugin] Log inside collapsed group
<t> [MyPlugin] Time: X ms
2019-08-01 02:48:22 +08:00
"
`);
2019-07-22 16:35:26 +08:00
done();
});
});
it("should log to the console (none)", (done) => {
const webpack = require("..");
2021-07-06 20:01:32 +08:00
compiler = webpack({
2019-07-22 16:35:26 +08:00
context: path.join(__dirname, "fixtures"),
entry: "./a",
output: {
2020-02-13 23:57:10 +08:00
path: "/directory",
2019-07-22 16:35:26 +08:00
filename: "bundle.js"
},
infrastructureLogging: {
level: "none"
},
plugins: [new MyPlugin()]
});
compiler.outputFileSystem = createFsFromVolume(new Volume());
2025-07-08 22:46:17 +08:00
compiler.run((_err, _stats) => {
2024-10-14 11:02:08 +08:00
expect(capture.toString()).toMatchInlineSnapshot('""');
2019-07-22 16:35:26 +08:00
done();
});
});
it("should log to the console with colors (verbose)", (done) => {
const webpack = require("..");
2021-07-06 20:01:32 +08:00
compiler = webpack({
context: path.join(__dirname, "fixtures"),
entry: "./a",
output: {
path: "/directory",
filename: "bundle.js"
},
infrastructureLogging: {
level: "verbose",
colors: true
},
plugins: [new MyPlugin()]
});
compiler.outputFileSystem = createFsFromVolume(new Volume());
2025-07-08 22:46:17 +08:00
compiler.run((_err, _stats) => {
expect(escapeAnsi(capture.toStringRaw()).replace(/[\d.]+ ms/, "X ms"))
.toMatchInlineSnapshot(`
"<-> <CLR=36,BOLD>[MyPlugin] Group</CLR>
<e> <CLR=31,BOLD>[MyPlugin] Error</CLR>
<w> <CLR=33,BOLD>[MyPlugin] Warning</CLR>
<i> <CLR=32,BOLD>[MyPlugin] Info</CLR>
<CLR=BOLD>[MyPlugin] Log<CLR=22>
<-> <CLR=36,BOLD>[MyPlugin] Collapsed group</CLR>
<CLR=BOLD>[MyPlugin] Log inside collapsed group<CLR=22>
<t> <CLR=35,BOLD>[MyPlugin] Time: X ms</CLR>
"
`);
done();
});
});
it("should log to the console with colors (debug mode)", (done) => {
const webpack = require("..");
2021-07-06 20:01:32 +08:00
compiler = webpack({
context: path.join(__dirname, "fixtures"),
entry: "./a",
output: {
path: "/directory",
filename: "bundle.js"
},
infrastructureLogging: {
level: "error",
debug: /MyPlugin/,
colors: true
},
plugins: [new MyPlugin()]
});
compiler.outputFileSystem = createFsFromVolume(new Volume());
2025-07-08 22:46:17 +08:00
compiler.run((_err, _stats) => {
expect(escapeAnsi(capture.toStringRaw()).replace(/[\d.]+ ms/, "X ms"))
.toMatchInlineSnapshot(`
"<-> <CLR=36,BOLD>[MyPlugin] Group</CLR>
<e> <CLR=31,BOLD>[MyPlugin] Error</CLR>
<w> <CLR=33,BOLD>[MyPlugin] Warning</CLR>
<i> <CLR=32,BOLD>[MyPlugin] Info</CLR>
<CLR=BOLD>[MyPlugin] Log<CLR=22>
[MyPlugin] Debug
<-> <CLR=36,BOLD>[MyPlugin] Collapsed group</CLR>
<CLR=BOLD>[MyPlugin] Log inside collapsed group<CLR=22>
<t> <CLR=35,BOLD>[MyPlugin] Time: X ms</CLR>
"
`);
done();
});
});
2019-07-22 15:18:00 +08:00
});
});