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: Page crash on half surrogate pair #261

Merged
merged 1 commit into from
Nov 4, 2023
Merged

Fix: Page crash on half surrogate pair #261

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
32 changes: 29 additions & 3 deletions packages/docusaurus-theme-openapi/src/theme/ApiDemoPanel/buildPostmanRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,30 @@ type Param = {
value?: string | string[];
} & ParameterObject;

function endsWithHalfSurrogatePair(value: string) {
if (value.length === 0) {
return false;
}
const lastIndex = value.length - 1;
const charCode = value.charCodeAt(lastIndex);
// https://unicodebook.readthedocs.io/unicode_encodings.html#utf-16-surrogate-pairs
// If ends with high surrogates string is invalid and encodeURIComponent fails
// Only end checked for cases where surrogates input is sequential
// We assume the user inputs a valid string but sequential write might temporarily
// result in half a pair ending string
if (charCode < 0xd800 || charCode > 0xdbff) {
return false; // If any character is not a high surrogate, return false
}
return true;
}

function safeEncodeURIComponent(value: string | number | boolean) {
if (typeof value === "string" && endsWithHalfSurrogatePair(value)) {
return encodeURIComponent(value.slice(0, -1));
}
return encodeURIComponent(value);
}

export function openApiQueryParams2PostmanQueryParams(
queryParams: Param[]
): sdk.QueryParam[] {
Expand Down Expand Up @@ -46,7 +70,7 @@ export function openApiQueryParams2PostmanQueryParams(
if (Array.isArray(param.value)) {
return new sdk.QueryParam({
key: param.name,
value: param.value.map(encodeURIComponent).join(delimiter),
value: param.value.map(safeEncodeURIComponent).join(delimiter),
});
}

Expand All @@ -63,7 +87,7 @@ export function openApiQueryParams2PostmanQueryParams(

return new sdk.QueryParam({
key: param.name,
value: encodeURIComponent(param.value),
value: safeEncodeURIComponent(param.value),
});
})
.filter((item): item is sdk.QueryParam => item !== undefined);
Expand All @@ -79,7 +103,9 @@ function setQueryParams(postman: sdk.Request, queryParams: Param[]) {

function setPathParams(postman: sdk.Request, queryParams: Param[]) {
const recursiveEncodeURIComponent = (c: string | string[]) =>
Array.isArray(c) ? c.map(encodeURIComponent) : encodeURIComponent(c);
Array.isArray(c)
? c.map(safeEncodeURIComponent)
: safeEncodeURIComponent(c);

const source = queryParams.map((param) => {
return new sdk.Variable({
Expand Down