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

fix(cors): append access-control-max-age header to preflight response #856

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
+218 −2
Open

fix(cors): append access-control-max-age header to preflight response #856

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6f5f213
fix: append `access-control-max-age` header to preflight response
aaharu Aug 8, 2024
1c0b60f
fix: fix header types
aaharu Aug 8, 2024
3d8ccda
Revert "fix: fix header types"
aaharu Aug 8, 2024
540cddd
test(cors): add appendCorsPreflightHeaders and appendCorsHeaders tests
aaharu Aug 30, 2024
4b39934
fix(cors): `Access-Control-Expose-Headers` is not included in respons…
aaharu Aug 30, 2024
4ba3732
test(cors); fix it
aaharu Aug 30, 2024
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
3 changes: 2 additions & 1 deletion src/utils/cors.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import {
createAllowHeaderHeaders,
createCredentialsHeaders,
createExposeHeaders,
createMaxAgeHeader,
createMethodsHeaders,
createOriginHeaders,
resolveCorsOptions,
Expand Down Expand Up @@ -38,9 +39,9 @@ export function appendCorsPreflightHeaders(
const headers = {
...createOriginHeaders(event, options),
...createCredentialsHeaders(options),
...createExposeHeaders(options),
...createMethodsHeaders(options),
...createAllowHeaderHeaders(event, options),
...createMaxAgeHeader(options),
};
for (const [key, value] of Object.entries(headers)) {
event.response.headers.append(key, value);
Expand Down
217 changes: 216 additions & 1 deletion test/unit/cors.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
import type { H3CorsOptions } from "../../src/types";
import { expect, it, describe } from "vitest";
import { mockEvent, isPreflightRequest, isCorsOriginAllowed } from "../../src";
import {
mockEvent,
isPreflightRequest,
isCorsOriginAllowed,
appendCorsPreflightHeaders,
appendCorsHeaders,
} from "../../src";
import {
resolveCorsOptions,
createOriginHeaders,
Expand Down Expand Up @@ -434,4 +440,213 @@ describe("cors (unit)", () => {
});
});
});

describe("appendCorsPreflightHeaders", () => {
it("append CORS headers with preflight request", () => {
{
const eventMock = mockEvent("/", {
method: "OPTIONS",
headers: {
origin: "https://example.com",
"access-control-request-method": "GET",
"access-control-request-headers": "CUSTOM-HEADER",
},
});
// default options
const options: H3CorsOptions = {
origin: "*",
methods: "*",
allowHeaders: "*",
exposeHeaders: "*",
credentials: false,
maxAge: false,
preflight: {
statusCode: 204,
},
};

appendCorsPreflightHeaders(eventMock, options);

expect(
eventMock.response.headers.get("access-control-allow-origin"),
).toEqual("*");
expect(
eventMock.response.headers.has("access-control-allow-credentials"),
).toEqual(false);
expect(
eventMock.response.headers.get("access-control-allow-methods"),
).toEqual("*");
expect(
eventMock.response.headers.get("access-control-allow-headers"),
).toEqual("CUSTOM-HEADER");
expect(eventMock.response.headers.get("vary")).toEqual(
"access-control-request-headers",
);
expect(
eventMock.response.headers.has("access-control-max-age"),
).toEqual(false);
}

{
const eventMock = mockEvent("/", {
method: "OPTIONS",
headers: {
origin: "https://example.com",
"access-control-request-method": "GET",
"access-control-request-headers": "CUSTOM-HEADER",
},
});
// exposeHeaders and maxAge
const options: H3CorsOptions = {
origin: "*",
exposeHeaders: ["EXPOSE-HEADER", "Authorization"],
maxAge: "12345",
};

appendCorsPreflightHeaders(eventMock, options);

expect(
eventMock.response.headers.get("access-control-allow-origin"),
).toEqual("*");
expect(
eventMock.response.headers.has("access-control-allow-credentials"),
).toEqual(false);
expect(
eventMock.response.headers.has("access-control-allow-methods"),
).toEqual(false);
expect(
eventMock.response.headers.get("access-control-allow-headers"),
).toEqual("CUSTOM-HEADER");
expect(eventMock.response.headers.get("vary")).toEqual(
"access-control-request-headers",
);
expect(
eventMock.response.headers.get("access-control-max-age"),
).toEqual("12345");
}

{
const eventMock = mockEvent("/", {
method: "OPTIONS",
headers: {
origin: "https://example.com",
"access-control-request-method": "GET",
},
});
// credentials
const options: H3CorsOptions = {
origin: ["https://example.com"],
credentials: true,
};

appendCorsPreflightHeaders(eventMock, options);

expect(
eventMock.response.headers.get("access-control-allow-origin"),
).toEqual("https://example.com");
expect(eventMock.response.headers.get("vary")).toEqual("origin");
expect(
eventMock.response.headers.get("access-control-allow-credentials"),
).toEqual("true");
expect(
eventMock.response.headers.has("access-control-allow-methods"),
).toEqual(false);
expect(
eventMock.response.headers.has("access-control-allow-headers"),
).toEqual(false);
expect(
eventMock.response.headers.has("access-control-max-age"),
).toEqual(false);
}
});
});

describe("appendCorsHeaders", () => {
it("append CORS headers with CORS request", () => {
{
const eventMock = mockEvent("/", {
method: "GET",
headers: {
origin: "https://example.com",
"CUSTOM-HEADER": "CUSTOM-HEADER-VALUE",
},
});
// default options
const options: H3CorsOptions = {
origin: "*",
methods: "*",
allowHeaders: "*",
exposeHeaders: "*",
credentials: false,
maxAge: false,
preflight: {
statusCode: 204,
},
};

appendCorsHeaders(eventMock, options);

expect(
eventMock.response.headers.get("access-control-allow-origin"),
).toEqual("*");
expect(
eventMock.response.headers.has("access-control-allow-credentials"),
).toEqual(false);
expect(
eventMock.response.headers.get("access-control-expose-headers"),
).toEqual("*");
}

{
const eventMock = mockEvent("/", {
method: "GET",
headers: {
origin: "https://example.com",
},
});
// exposeHeaders and maxAge
const options: H3CorsOptions = {
origin: "*",
exposeHeaders: ["EXPOSE-HEADER", "Authorization"],
maxAge: "12345",
};

appendCorsHeaders(eventMock, options);

expect(
eventMock.response.headers.get("access-control-allow-origin"),
).toEqual("*");
expect(
eventMock.response.headers.has("access-control-allow-credentials"),
).toEqual(false);
expect(
eventMock.response.headers.get("access-control-expose-headers"),
).toEqual("EXPOSE-HEADER,Authorization");
}

{
const eventMock = mockEvent("/", {
method: "GET",
headers: {
origin: "https://example.com",
},
});
// credentials
const options: H3CorsOptions = {
origin: ["https://example.com"],
credentials: true,
};

appendCorsHeaders(eventMock, options);

expect(
eventMock.response.headers.get("access-control-allow-origin"),
).toEqual("https://example.com");
expect(eventMock.response.headers.get("vary")).toEqual("origin");
expect(
eventMock.response.headers.get("access-control-allow-credentials"),
).toEqual("true");
}
});
});
});