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.

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

fix: response correctly when receive an OPTIONS request #4185

Merged
merged 4 commits into from Aug 10, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
26 changes: 26 additions & 0 deletions lib/Server.js
Expand Up @@ -2131,6 +2131,32 @@ class Server {
});
}

{
/**
*
* @param {Request} req
* @param {Response} res
* @param {NextFunction} next
* @returns {void}
*
*/
const optionsRequestResponseMiddleware = (req, res, next) => {
if (req.method === "OPTIONS") {
res.statusCode = 204;
res.setHeader("Content-Length", "0");
res.end();
return;
}
next();
};

middlewares.push({
name: "options-middleware",
path: "*",
middleware: optionsRequestResponseMiddleware,
});
TrickyPi marked this conversation as resolved.
Show resolved Hide resolved
}

middlewares.push({
name: "webpack-dev-middleware",
middleware:
Expand Down
80 changes: 80 additions & 0 deletions test/e2e/options-middleware.test.js
@@ -0,0 +1,80 @@
"use strict";

const webpack = require("webpack");
const Express = require("express");
const Server = require("../../lib/Server");
const config = require("../fixtures/client-config/webpack.config");
const runBrowser = require("../helpers/run-browser");
const port = require("../ports-map")["options-request-response"];

const createWaiting = () => {
let reslove;
let reject;
const waiting = new Promise((resolve$, reject$) => {
reslove = resolve$;
reject = reject$;
});
return {
reslove,
reject,
waiting,
};
};

describe("handle options-request correctly", () => {
it("should response with 200 http code", async () => {
const compiler = webpack(config);
const [portForServer, portForApp] = port;
const closeApp = await (async () => {
const { reslove, waiting } = createWaiting();
const app = new Express();
app.get("/", (req, res) => {
res.sendStatus(200);
});
const server = app.listen(portForApp, () => {
reslove();
});
await waiting;
return async () => {
const { reslove: reslove2, waiting: waiting2 } = createWaiting();
server.close(() => {
reslove2();
});
await waiting2;
};
})();
const server = new Server(
{
port: portForServer,
headers: {
"Access-Control-Allow-Origin": "*",
"Access-Control-Allow-Headers": "*",
},
},
compiler
);
await server.start();
const { page, browser } = await runBrowser();
const prefixUrl = "http://127.0.0.1";
const htmlUrl = `${prefixUrl}:${portForServer}/test.html`;
const appUrl = `${prefixUrl}:${portForApp}`;
await page.goto(appUrl);
const responseStatus = [];
page.on("response", (res) => {
responseStatus.push(res.status());
});
await page.evaluate(
(url) =>
window.fetch(url, {
headers: {
"another-header": "1",
},
}),
htmlUrl
);
await browser.close();
await server.stop();
await closeApp();
expect(responseStatus).toEqual([204, 200]);
});
});
1 change: 1 addition & 0 deletions test/ports-map.js
Expand Up @@ -79,6 +79,7 @@ const listOfTests = {
"server-option": 1,
"normalize-option": 1,
"setup-middlewares-option": 1,
"options-request-response": 2,
};

let startPort = 8089;
Expand Down