Skip to content

refactor(core): detect if codegen should quote property without using eval() #8045

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

Merged
Josh-Cena merged 1 commit into from
Sep 2, 2022
Merged

refactor(core): detect if codegen should quote property without using eval() #8045

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
20 changes: 3 additions & 17 deletions packages/docusaurus/src/server/routes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,23 +123,9 @@ ${indent(subroutesCodeStrings.join(',\n'))}
}

Object.entries(props).forEach(([propName, propValue]) => {
// Inspired by https://github.com/armanozak/should-quote/blob/main/packages/should-quote/src/lib/should-quote.ts
const shouldQuote = ((key: string) => {
// Pre-sanitation to prevent injection
if (/[.,;:}/\s]/.test(key)) {
return true;
}
try {
// If this key can be used in an expression like ({a:0}).a
// eslint-disable-next-line no-eval
eval(`({${key}:0}).${key}`);
return false;
} catch {
return true;
}
})(propName);
// Escape quotes as well
const key = shouldQuote ? JSON.stringify(propName) : propName;
const isIdentifier =

@slorber slorber Sep 7, 2022

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

what about the test 😅 not really confident it works here, but it looks like it does

@Josh-Cena Josh-Cena Sep 7, 2022

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

We already have decent tests for this, plus this is a direct translation of the spec, so I won't worry about it too much.

/^[$_\p{ID_Start}][$\u200c\u200d\p{ID_Continue}]*$/u.test(propName);
const key = isIdentifier ? propName : JSON.stringify(propName);
parts.push(`${key}: ${JSON.stringify(propValue)}`);
});

Expand Down