Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,12 @@
* LICENSE file in the root directory of this source tree.
*/

import vm from 'node:vm';
import {describe, expect, it} from 'vitest';
import {getThemeInlineScript} from '../inlineScripts';
import {
getThemeInlineScript,
getAnnouncementBarInlineScript,
} from '../inlineScripts';

describe('inlineScripts', () => {
it('inline javascript for default options', () => {
Expand Down Expand Up @@ -40,4 +44,79 @@ describe('inlineScripts', () => {
}),
).toMatchSnapshot();
});

describe('getAnnouncementBarInlineScript', () => {
function runScript({
id,
namespace = '',
storage,
}: {
id: string;
namespace?: string;
storage: Record<string, string>;
}) {
const script = getAnnouncementBarInlineScript({
announcementBar: {
id,
content: 'Hello',
isCloseable: true,
},
siteStorage: {
type: 'localStorage',
namespace,
},
});
const attrs: Record<string, unknown> = {};
vm.runInNewContext(script, {
localStorage: {
getItem: (key: string) => storage[key] ?? null,
},
document: {
documentElement: {
setAttribute: (name: string, value: unknown) => {
attrs[name] = String(value);
},
},
},
});
return attrs['data-announcement-bar-initially-dismissed'];
}

it('marks bar dismissed when stored id matches current id', () => {
expect(
runScript({
id: 'announcement-1',
storage: {
'docusaurus.announcement.dismiss': 'true',
'docusaurus.announcement.id': 'announcement-1',
},
}),
).toBe('true');
});

it('does not mark bar dismissed when announcement id changed', () => {
expect(
runScript({
id: 'announcement-2',
storage: {
'docusaurus.announcement.dismiss': 'true',
'docusaurus.announcement.id': 'announcement-1',
},
}),
).toBe('false');
});

it('respects siteStorage namespace and escapes special characters in id', () => {
expect(
runScript({
id: "bob's-</script>-banner",
namespace: '-site',
storage: {
'docusaurus.announcement.dismiss-site': 'true',
'docusaurus.announcement.id-site': "bob's-</script>-banner",
},
}),
).toBe('true');
});
});
});
6 changes: 5 additions & 1 deletion packages/docusaurus-theme-classic/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,11 @@ export default function themeClassic(
innerHTML: `
${getThemeInlineScript({colorMode, siteStorage})}
${DataAttributeQueryStringInlineJavaScript}
${announcementBar ? getAnnouncementBarInlineScript({siteStorage}) : ''}
${
announcementBar
? getAnnouncementBarInlineScript({announcementBar, siteStorage})
: ''
}
`,
},
],
Expand Down
12 changes: 11 additions & 1 deletion packages/docusaurus-theme-classic/src/inlineScripts.ts
Original file line number Diff line number Diff line change
Expand Up @@ -75,23 +75,33 @@ export const DataAttributeQueryStringInlineJavaScript = `
// shifts on React hydration. The theme can use CSS + the data attribute to hide
// the announcement bar asap (before React hydration)
export function getAnnouncementBarInlineScript({
announcementBar,
siteStorage,
}: {
announcementBar: NonNullable<ThemeConfig['announcementBar']>;
siteStorage: SiteStorage;
}): string {
// Duplicated constant. Unfortunately we can't import it from theme-common, as
// we need to support older nodejs versions without ESM support
// TODO: import from theme-common once we support Node.js with ESM support
// + move all those announcementBar stuff there too
const AnnouncementBarDismissStorageKey = `docusaurus.announcement.dismiss${siteStorage.namespace}`;
const AnnouncementBarIdStorageKey = `docusaurus.announcement.id${siteStorage.namespace}`;
const AnnouncementBarDismissDataAttribute =
'data-announcement-bar-initially-dismissed';
const announcementBarId = JSON.stringify(announcementBar.id).replace(
/</g,
'\\u003c',
);

/* language=js */
return `(function() {
function isDismissed() {
try {
return localStorage.getItem('${AnnouncementBarDismissStorageKey}') === 'true';
return (
localStorage.getItem('${AnnouncementBarDismissStorageKey}') === 'true' &&
localStorage.getItem('${AnnouncementBarIdStorageKey}') === ${announcementBarId}
);
} catch (err) {}
return false;
}
Expand Down