Skip to content

Fix consent theme initialization race #1511

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
Cedric Vidal (cedricvidal) merged 6 commits into from
Oct 15, 2026
Merged

Fix consent theme initialization race #1511

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8c23209
docs: expand Kubernetes self-hosting guide
cedricvidal Oct 15, 2026
46f116b
docs: clarify self-hosting architecture diagram
cedricvidal Oct 15, 2026
51bd664
docs: style KEDA autoscaling diagram
cedricvidal Oct 15, 2026
814dc05
docs: align diagram colors with website
cedricvidal Oct 15, 2026
b05d44d
Merge remote-tracking branch 'origin/main' into cedricvidal-docs-kube…
cedricvidal Oct 15, 2026
4bb387f
fix(website): deduplicate consent theme updates
cedricvidal Oct 15, 2026
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
18 changes: 14 additions & 4 deletions website/src/scripts/analytics.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,7 @@ async function initializeConsent(allowAnalytics: boolean): Promise<void> {
});
};
const theme = () => document.documentElement.dataset.theme === 'light' ? 'light' : 'dark';
const initialTheme = theme();
wcp.init(document.documentElement.lang || 'en-US', banner, (error, consent) => {
if (error || !consent) {
console.error('Scope cookie consent could not initialize', error ?? new Error('Missing consent manager'));
Expand All @@ -150,10 +151,19 @@ async function initializeConsent(allowAnalytics: boolean): Promise<void> {
manageCookies.hidden = false;
manageCookies.addEventListener('click', () => consent.manageConsent());
onConsentChanged();
new MutationObserver(() => {
consent.applyTheme(theme());
}).observe(document.documentElement, { attributes: true, attributeFilter: ['data-theme'] });
}, onConsentChanged, theme());
let appliedTheme = initialTheme;
const applyTheme = () => {
const nextTheme = theme();
if (nextTheme === appliedTheme) return;
appliedTheme = nextTheme;
consent.applyTheme(nextTheme);
};
applyTheme();
new MutationObserver(applyTheme).observe(
document.documentElement,
{ attributes: true, attributeFilter: ['data-theme'] },
);
}, onConsentChanged, initialTheme);
}

const base = import.meta.env.BASE_URL.replace(/\/?$/, '/');
Expand Down
16 changes: 12 additions & 4 deletions website/tests/analytics.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,10 +161,18 @@ test('stored consent initializes once and can be withdrawn and granted again', a
test('consent UI follows Starlight theme changes', async ({ page }) => {
await mockPublishedSite(page);
await page.goto('https://microsoft.github.io/scope/');
await page.evaluate(() => { document.documentElement.dataset.theme = 'light'; });
await expect.poll(() => page.evaluate(() => window.scopeAnalyticsTest.appliedThemes)).toEqual(['light']);
await page.evaluate(() => { document.documentElement.dataset.theme = 'dark'; });
await expect.poll(() => page.evaluate(() => window.scopeAnalyticsTest.appliedThemes)).toEqual(['light', 'dark']);
await expect.poll(() => page.evaluate(() => Boolean(window.scopeAnalyticsTest.changeConsent))).toBe(true);
const initialTheme = await page.evaluate(
() => document.documentElement.dataset.theme === 'light' ? 'light' : 'dark',
);
const nextTheme = initialTheme === 'light' ? 'dark' : 'light';

await page.evaluate((theme) => { document.documentElement.dataset.theme = theme; }, initialTheme);
await expect.poll(() => page.evaluate(() => window.scopeAnalyticsTest.appliedThemes)).toEqual([]);
await page.evaluate((theme) => { document.documentElement.dataset.theme = theme; }, nextTheme);
await expect.poll(() => page.evaluate(() => window.scopeAnalyticsTest.appliedThemes)).toEqual([nextTheme]);
await page.evaluate((theme) => { document.documentElement.dataset.theme = theme; }, initialTheme);
await expect.poll(() => page.evaluate(() => window.scopeAnalyticsTest.appliedThemes)).toEqual([nextTheme, initialTheme]);
});

for (const options of [
Expand Down
Loading