Skip to content

Node: Safe use of document for preview #24248

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
ndelangen merged 5 commits into from
Mar 26, 2024
Merged

Node: Safe use of document for preview #24248

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
556b02e
fix: avoid relying on document for preview file used in the compose/t…
DylanPiercey Sep 20, 2023
45ab3c2
Merge branch 'next' into avoid-document-reference
ndelangen Sep 22, 2023
6243f1c
Merge branch 'next' into avoid-document-reference
ndelangen Nov 24, 2023
830890c
Fix document undefined error in UrlStore and WebView
ndelangen Mar 26, 2024
779117c
Merge branch 'next' into pr/DylanPiercey/24248
ndelangen Mar 26, 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
32 changes: 17 additions & 15 deletions code/lib/preview-api/src/modules/preview-web/UrlStore.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ const getQueryString = ({
selection?: Selection;
extraParams?: qs.ParsedQs;
}) => {
const { search = '' } = document.location;
const search = typeof document !== 'undefined' ? document.location.search : '';
const { path, selectedKind, selectedStory, ...rest } = qs.parse(search, {
ignoreQueryPrefix: true,
});
Expand Down Expand Up @@ -65,20 +65,22 @@ const getFirstString = (v: ValueOf<qs.ParsedQs>): string | void => {
};

export const getSelectionSpecifierFromPath: () => SelectionSpecifier | null = () => {
const query = qs.parse(document.location.search, { ignoreQueryPrefix: true });
const args = typeof query.args === 'string' ? parseArgsParam(query.args) : undefined;
const globals = typeof query.globals === 'string' ? parseArgsParam(query.globals) : undefined;

let viewMode = getFirstString(query.viewMode) as ViewMode;
if (typeof viewMode !== 'string' || !viewMode.match(/docs|story/)) {
viewMode = 'story';
}

const path = getFirstString(query.path);
const storyId = path ? pathToId(path) : getFirstString(query.id);

if (storyId) {
return { storySpecifier: storyId, args, globals, viewMode };
if (typeof document !== 'undefined') {
const query = qs.parse(document.location.search, { ignoreQueryPrefix: true });
const args = typeof query.args === 'string' ? parseArgsParam(query.args) : undefined;
const globals = typeof query.globals === 'string' ? parseArgsParam(query.globals) : undefined;

let viewMode = getFirstString(query.viewMode) as ViewMode;
if (typeof viewMode !== 'string' || !viewMode.match(/docs|story/)) {
viewMode = 'story';
}

const path = getFirstString(query.path);
const storyId = path ? pathToId(path) : getFirstString(query.id);

if (storyId) {
return { storySpecifier: storyId, args, globals, viewMode };
}
}

return null;
Expand Down
38 changes: 21 additions & 17 deletions code/lib/preview-api/src/modules/preview-web/WebView.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,22 +46,24 @@ export class WebView implements View<HTMLElement> {

constructor() {
// Special code for testing situations
// eslint-disable-next-line @typescript-eslint/naming-convention
const { __SPECIAL_TEST_PARAMETER__ } = qs.parse(document.location.search, {
ignoreQueryPrefix: true,
});
switch (__SPECIAL_TEST_PARAMETER__) {
case 'preparing-story': {
this.showPreparingStory();
this.testing = true;
break;
}
case 'preparing-docs': {
this.showPreparingDocs();
this.testing = true;
break;
if (typeof document !== 'undefined') {
// eslint-disable-next-line @typescript-eslint/naming-convention
const { __SPECIAL_TEST_PARAMETER__ } = qs.parse(document.location.search, {
ignoreQueryPrefix: true,
});
switch (__SPECIAL_TEST_PARAMETER__) {
case 'preparing-story': {
this.showPreparingStory();
this.testing = true;
break;
}
case 'preparing-docs': {
this.showPreparingDocs();
this.testing = true;
break;
}
default: // pass;
}
default: // pass;
}
}

Expand Down Expand Up @@ -114,8 +116,10 @@ export class WebView implements View<HTMLElement> {
checkIfLayoutExists(layout: keyof typeof layoutClassMap) {
if (!layoutClassMap[layout]) {
logger.warn(
dedent`The desired layout: ${layout} is not a valid option.
The possible options are: ${Object.keys(layoutClassMap).join(', ')}, none.`
dedent`
The desired layout: ${layout} is not a valid option.
The possible options are: ${Object.keys(layoutClassMap).join(', ')}, none.
`
);
}
}
Expand Down