Merge pull request #145 from boscop-fr/fix-cookie-deletion

Fixed cookie deletion

Author: felixgirault

e2e/OrejimePage.ts

@@ -1,7 +1,15 @@
-import {expect, BrowserContext, Page, Locator} from '@playwright/test';
+import {BrowserContext, expect, Page} from '@playwright/test';
 import Cookie from 'js-cookie';
+import {OrejimeInstance} from '../src/setup';
 import {Config} from '../src/ui/types';
 
+declare global {
+	interface Window {
+		orejimeConfig: Partial<Config>;
+		orejime: OrejimeInstance;
+	}
+}
+
 export class OrejimePage {
 	constructor(
 		public readonly page: Page,
@@ -80,6 +88,12 @@ export class OrejimePage {
 		await this.page.getByTestId('orejime-banner-decline').click();
 	}
 
+	async acceptAllFromManager() {
+		return await this.page.evaluate(() => {
+			window.orejime.manager.acceptAll();
+		});
+	}
+
 	async openModalFromBanner() {
 		await this.learnMoreBannerButton.click();
 	}
@@ -119,15 +133,34 @@ export class OrejimePage {
 		await this.page.getByTestId('orejime-contextual-notice-accept').click();
 	}
 
+	async expectUndefinedConsents() {
+		await expect(await this.getConsentsFromCookies()).toBeUndefined();
+	}
+
+	async expectAnyConsents() {
+		await expect(await this.getConsentsFromCookies()).not.toBeUndefined();
+	}
+
 	async expectConsents(consents: Record<string, unknown>) {
 		await expect(await this.getConsentsFromCookies()).toEqual(consents);
 	}
 
 	async getConsentsFromCookies() {
 		const name = 'eu-consent';
 		const cookies = await this.context.cookies();
-		const {value} = cookies.find((cookie) => cookie.name === name)!;
-		return JSON.parse(Cookie.converter.read(value, name));
+		const cookie = cookies.find((cookie) => cookie.name === name)!;
+
+		if (!cookie) {
+			return undefined;
+		}
+
+		return JSON.parse(Cookie.converter.read(cookie.value, cookie.name));
+	}
+
+	async clearConsents() {
+		return await this.page.evaluate(() => {
+			window.orejime.manager.clearConsents();
+		});
 	}
 
 	// In specific conditions, browser events can get queued

e2e/orejime.spec.ts

@@ -255,6 +255,14 @@ test.describe('Orejime', () => {
 		const position2 = await orejimePage.banner.boundingBox();
 		await expect(position2).toEqual(initalPosition);
 	});
+
+	test('should clear consents', async () => {
+		await orejimePage.expectUndefinedConsents();
+		await orejimePage.acceptAllFromManager();
+		await orejimePage.expectAnyConsents();
+		await orejimePage.clearConsents();
+		await orejimePage.expectUndefinedConsents();
+	});
 });
 
 test.describe('Orejime with forced banner', () => {

src/core/utils/cookies.ts

@@ -1,4 +1,5 @@
 import Cookie from 'js-cookie';
+import {listSubdomains} from './urls';
 
 export type CookieSameSite = 'strict' | 'lax' | 'none';
 
@@ -24,24 +25,15 @@ export const setCookie = (
 	});
 };
 
-export const deleteCookie = (name: string, path?: string, domain?: string) => {
-	if (domain) {
+export const deleteCookie = (name: string, path = '/', domain?: string) => {
+	// If no domain is specified, we try deleting the cookie
+	// on the current domain or any of its subdomains.
+	const domains = domain ? [domain] : listSubdomains(location.hostname);
+
+	domains.forEach((domain) => {
 		Cookie.remove(name, {
 			path,
 			domain
 		});
-
-		return;
-	}
-
-	// if domain is not defined, try to delete cookie on multiple default domains
-	Cookie.remove(name, {
-		path,
-		domain: location.hostname
-	});
-
-	Cookie.remove(name, {
-		path,
-		domain: location.hostname.split('.').slice(-2).join('.')
 	});
 };

src/core/utils/urls.test.ts

@@ -0,0 +1,19 @@
+import {listSubdomains} from './urls';
+
+test('listSubdomains', () => {
+	expect(listSubdomains('localhost')).toEqual(
+		expect.arrayContaining(['localhost'])
+	);
+
+	expect(listSubdomains('foo.com')).toEqual(
+		expect.arrayContaining(['foo.com'])
+	);
+
+	expect(listSubdomains('foo.bar.com')).toEqual(
+		expect.arrayContaining(['bar.com', 'foo.bar.com'])
+	);
+
+	expect(listSubdomains('foo.bar.baz.com')).toEqual(
+		expect.arrayContaining(['baz.com', 'bar.baz.com', 'foo.bar.baz.com'])
+	);
+});

src/core/utils/urls.ts

@@ -0,0 +1,12 @@
+export const listSubdomains = (hostname: string) => {
+	const parts = hostname.split('.');
+	const primary = parts.slice(-2);
+	const subs = parts.slice(0, -2);
+	const all = [primary];
+
+	for (let i = 0; i < subs.length; i++) {
+		all.push(subs.slice(i).concat(primary));
+	}
+
+	return all.map((parts) => parts.join('.'));
+};