From b44163bdf0196c3e17de7ce6b20d375e7c392829 Mon Sep 17 00:00:00 2001 From: um4tb Date: Sat, 21 Nov 2026 21:29:42 +0300 Subject: [PATCH] fix(theme-classic): check announcementBar id in inline dismiss script --- .../src/__tests__/inlineScripts.test.ts | 81 ++++++++++++++++++- .../docusaurus-theme-classic/src/index.ts | 6 +- .../src/inlineScripts.ts | 12 ++- 3 files changed, 96 insertions(+), 3 deletions(-) diff --git a/packages/docusaurus-theme-classic/src/__tests__/inlineScripts.test.ts b/packages/docusaurus-theme-classic/src/__tests__/inlineScripts.test.ts index 2690e0b09c89..9b58baf81dc2 100644 --- a/packages/docusaurus-theme-classic/src/__tests__/inlineScripts.test.ts +++ b/packages/docusaurus-theme-classic/src/__tests__/inlineScripts.test.ts @@ -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', () => { @@ -40,4 +44,79 @@ describe('inlineScripts', () => { }), ).toMatchSnapshot(); }); + + describe('getAnnouncementBarInlineScript', () => { + function runScript({ + id, + namespace = '', + storage, + }: { + id: string; + namespace?: string; + storage: Record; + }) { + const script = getAnnouncementBarInlineScript({ + announcementBar: { + id, + content: 'Hello', + isCloseable: true, + }, + siteStorage: { + type: 'localStorage', + namespace, + }, + }); + const attrs: Record = {}; + 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--banner", + namespace: '-site', + storage: { + 'docusaurus.announcement.dismiss-site': 'true', + 'docusaurus.announcement.id-site': "bob's--banner", + }, + }), + ).toBe('true'); + }); + }); }); diff --git a/packages/docusaurus-theme-classic/src/index.ts b/packages/docusaurus-theme-classic/src/index.ts index 95f63170441b..1b0d60335e7a 100644 --- a/packages/docusaurus-theme-classic/src/index.ts +++ b/packages/docusaurus-theme-classic/src/index.ts @@ -132,7 +132,11 @@ export default function themeClassic( innerHTML: ` ${getThemeInlineScript({colorMode, siteStorage})} ${DataAttributeQueryStringInlineJavaScript} -${announcementBar ? getAnnouncementBarInlineScript({siteStorage}) : ''} +${ + announcementBar + ? getAnnouncementBarInlineScript({announcementBar, siteStorage}) + : '' +} `, }, ], diff --git a/packages/docusaurus-theme-classic/src/inlineScripts.ts b/packages/docusaurus-theme-classic/src/inlineScripts.ts index fe49094a52c4..ca37d2dee73f 100644 --- a/packages/docusaurus-theme-classic/src/inlineScripts.ts +++ b/packages/docusaurus-theme-classic/src/inlineScripts.ts @@ -75,8 +75,10 @@ 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; siteStorage: SiteStorage; }): string { // Duplicated constant. Unfortunately we can't import it from theme-common, as @@ -84,14 +86,22 @@ export function getAnnouncementBarInlineScript({ // 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( + /