Skip to content
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

Jump to bottom

chore: convert dev server to webpack plugin #3850

Open
wants to merge 11 commits into
base: master
Choose a base branch
from
Open

chore: convert dev server to webpack plugin #3850

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
5f340d6
chore: add stub
rishabh3112 Sep 16, 2021
8265a61
chore: complete plugin support
rishabh3112 Sep 16, 2021
bd23953
chore: keep backwards compatibility
rishabh3112 Sep 16, 2021
50748da
chore: lint server js
rishabh3112 Sep 17, 2021
323f9f9
chore: rebase
rishabh3112 Sep 17, 2021
cf33c23
test: basic plugin support
rishabh3112 Sep 17, 2021
c3cd6b7
test: add e2e test for plugin API
rishabh3112 Sep 21, 2021
9d35ac4
chore: remove comment
rishabh3112 Sep 21, 2021
dc9075c
chore: update snapshot for webpack 4
rishabh3112 Sep 21, 2021
11be35c
chore: rebase
rishabh3112 Sep 21, 2021
85d443a
fix: plugin usage
alexander-akait Sep 21, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
33 changes: 26 additions & 7 deletions lib/Server.js
View file
Open in desktop
Expand Up @@ -15,6 +15,8 @@ if (!process.env.WEBPACK_SERVE) {
process.env.WEBPACK_SERVE = true;
}

const pluginName = "webpack-dev-server";

class Server {
constructor(options = {}, compiler) {
// TODO: remove this after plugin support is published
Expand All @@ -35,7 +37,10 @@ class Server {
// Keep track of websocket proxies for external websocket upgrade.
this.webSocketProxies = [];
this.sockets = [];
this.compiler = compiler;

if (compiler) {
rishabh3112 marked this conversation as resolved.
Show resolved Hide resolved
this.compiler = compiler;
}
}

static get DEFAULT_STATS() {
Expand Down Expand Up @@ -126,6 +131,20 @@ class Server {
return path.resolve(dir, "node_modules/.cache/webpack-dev-server");
}

apply(compiler) {
this.compiler = compiler;

let started = false;

compiler.hooks.watchRun.tapPromise(pluginName, async () => {
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 should enable watch before taping into watchRun hook.

Copy link
Member

Choose a reason for hiding this comment

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

Yes, plugin should work only for webpack watch/webpack serve, but I am afraid it is so late to override fs, need think more about it

Copy link
Member Author

Choose a reason for hiding this comment

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

ping @alexander-akait

Copy link
Member

Choose a reason for hiding this comment

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

Yep, in my roadmap on the next week

if (!started) {
await this.start();

started = true;
}
});
}

addAdditionalEntries(compiler) {
const additionalEntries = [];

Expand Down Expand Up @@ -395,7 +414,7 @@ class Server {
const { options } = this;

if (!this.logger) {
this.logger = this.compiler.getInfrastructureLogger("webpack-dev-server");
this.logger = this.compiler.getInfrastructureLogger(pluginName);
}

const compilerOptions = this.getCompilerOptions();
Expand Down Expand Up @@ -688,7 +707,7 @@ class Server {
if (typeof options.ipc === "boolean") {
const isWindows = process.platform === "win32";
const pipePrefix = isWindows ? "\\\\.\\pipe\\" : os.tmpdir();
const pipeName = "webpack-dev-server.sock";
const pipeName = `${pluginName}.sock`;

options.ipc = path.join(pipePrefix, pipeName);
}
Expand Down Expand Up @@ -1150,12 +1169,12 @@ class Server {
}

setupHooks() {
this.compiler.hooks.invalid.tap("webpack-dev-server", () => {
this.compiler.hooks.invalid.tap(pluginName, () => {
if (this.webSocketServer) {
this.sendMessage(this.webSocketServer.clients, "invalid");
}
});
this.compiler.hooks.done.tap("webpack-dev-server", (stats) => {
this.compiler.hooks.done.tap(pluginName, (stats) => {
if (this.webSocketServer) {
this.sendStats(this.webSocketServer.clients, this.getStats(stats));
}
Expand Down Expand Up @@ -2138,7 +2157,7 @@ class Server {
}
}

startCallback(callback) {
startCallback(callback = () => {}) {
this.start().then(() => callback(null), callback);
}

Expand Down Expand Up @@ -2210,7 +2229,7 @@ class Server {
"DEP_WEBPACK_DEV_SERVER_LISTEN"
)();

this.logger = this.compiler.getInfrastructureLogger("webpack-dev-server");
this.logger = this.compiler.getInfrastructureLogger(pluginName);

if (typeof port === "function") {
fn = port;
Expand Down
11 changes: 11 additions & 0 deletions test/e2e/__snapshots__/api.test.js.snap.webpack4
View file
Open in desktop
Expand Up @@ -87,3 +87,14 @@ Array [
`;

exports[`API should work with deprecated API (the order of the arguments in the constructor): page errors 1`] = `Array []`;

exports[`API should work with plugin API: console messages 1`] = `
Array [
"[HMR] Waiting for update signal from WDS...",
"Hey.",
"[webpack-dev-server] Hot Module Replacement enabled.",
"[webpack-dev-server] Live Reloading enabled.",
]
`;

exports[`API should work with plugin API: page errors 1`] = `Array []`;
11 changes: 11 additions & 0 deletions test/e2e/__snapshots__/api.test.js.snap.webpack5
View file
Open in desktop
Expand Up @@ -87,3 +87,14 @@ Array [
`;

exports[`API should work with deprecated API (the order of the arguments in the constructor): page errors 1`] = `Array []`;

exports[`API should work with plugin API: console messages 1`] = `
Array [
"[HMR] Waiting for update signal from WDS...",
"Hey.",
"[webpack-dev-server] Hot Module Replacement enabled.",
"[webpack-dev-server] Live Reloading enabled.",
]
`;

exports[`API should work with plugin API: page errors 1`] = `Array []`;
32 changes: 32 additions & 0 deletions test/e2e/api.test.js
View file
Open in desktop
Expand Up @@ -8,6 +8,38 @@ const runBrowser = require("../helpers/run-browser");
const port = require("../ports-map").api;

describe("API", () => {
it(`should work with plugin API`, async () => {
const compiler = webpack(config);
const server = new Server({ port });

server.apply(compiler);

const { page, browser } = await runBrowser();

const pageErrors = [];
const consoleMessages = [];

page
.on("console", (message) => {
consoleMessages.push(message);
})
.on("pageerror", (error) => {
pageErrors.push(error);
});

await page.goto(`http://127.0.0.1:${port}/main`, {
waitUntil: "networkidle0",
});

expect(consoleMessages.map((message) => message.text())).toMatchSnapshot(
"console messages"
);
expect(pageErrors).toMatchSnapshot("page errors");

await browser.close();
await server.stop();
});

it(`should work with async API`, async () => {
const compiler = webpack(config);
const server = new Server({ port }, compiler);
Expand Down
11 changes: 11 additions & 0 deletions test/server/Server.test.js
View file
Open in desktop
Expand Up @@ -50,6 +50,17 @@ describe("Server", () => {
}
}

it("should accept plugin API", (done) => {
const compiler = webpack(config);
const server = new Server(baseDevConfig);
server.apply(compiler);

compiler.hooks.done.tap("webpack-dev-server", () => {
expect(true).toBe(true);
server.stopCallback(done);
});
});
rishabh3112 marked this conversation as resolved.
Show resolved Hide resolved

it("add hot option", (done) => {
const compiler = webpack(config);
const server = new Server({ ...baseDevConfig, hot: true }, compiler);
Expand Down