orejime/e2e/OrejimePage.ts at f4933e99b52b13bdc22ab79311431e167f75a748 · boscop-fr/orejime · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
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,
		public readonly context: BrowserContext
	) {}

	async load(config: Partial<Config>, body: string) {
		await this.page.route('/', async (route) => {
			await route.fulfill({
				body: `
					<!DOCTYPE html>

					<html>
						<head>
							<title>Orejime</title>
							<link rel="stylesheet" href="orejime-standard.css" />
						</head>

						<body>
							${body}

							<script>
								window.orejimeConfig = ${JSON.stringify(config)}
							</script>
							<script src="orejime-standard-en.js"></script>
						</body>
					</html>
				`
			});
		});

		await this.page.goto('/');
	}

	get banner() {
		return this.page.getByTestId('orejime-banner');
	}

	get learnMoreBannerButton() {
		return this.page.getByTestId('orejime-banner-configure');
	}

	get firstFocusableElementFromBanner() {
		return this.banner.locator(':is(a, button)').first();
	}

	get modal() {
		return this.page.getByTestId('orejime-modal');
	}

	get closeModalButton() {
		return this.page.getByTestId('orejime-modal-close');
	}

	get contextualNotice() {
		return this.page.getByTestId('orejime-contextual-notice');
	}

	get contextualNoticeTitle() {
		return this.page.getByTestId('orejime-contextual-notice-title');
	}

	get contextualNoticePlaceholder() {
		return this.page.getByTestId('orejime-contextual-notice-placeholder');
	}

	locator(selector: string) {
		return this.page.locator(selector);
	}

	purposeCheckbox(purposeId: string) {
		return this.page.getByTestId(`orejime-purpose-${purposeId}`);
	}

	async acceptAllFromBanner() {
		await this.page.getByTestId('orejime-banner-accept').click();
	}

	async declineAllFromBanner() {
		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();
	}

	async enableAllFromModal() {
		await this.page.getByTestId('orejime-modal-enable-all').click();
	}

	async disableAllFromModal() {
		await this.page.getByTestId('orejime-modal-disable-all').click();
	}

	async saveFromModal() {
		await this.page.getByTestId('orejime-modal-save').click();
	}

	async closeModalByClickingButton() {
		await this.closeModalButton.click();
	}

	async closeDialogByClickingOutside() {
		// We're clicking in a corner to avoid clicking on the
		// modal itself, which has no effect.
		await this.locator('body').click({
			position: {
				x: 1,
				y: 1
			}
		});
	}

	async closeModalByPressingEscape() {
		await this.page.keyboard.press('Escape');
	}

	async acceptContextualNotice() {
		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 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
	// up and won't be fired until some interaction with the
	// page.
	// We're using a dummy click to trigger queued events.
	// @see https://github.com/microsoft/playwright/issues/979
	emptyEventQueue() {
		return this.page.mouse.click(0, 0);
	}
}