forked from TryGhost/Ghost
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdesign.test.ts
More file actions
586 lines (464 loc) · 24.2 KB
/
Copy pathdesign.test.ts
File metadata and controls
586 lines (464 loc) · 24.2 KB
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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
import {
chooseOptionInSelect,
globalDataRequests,
mockApi,
mockSitePreview,
responseFixtures,
updatedSettingsResponse,
waitForApiRequest
} from '@tryghost/admin-x-framework/test/acceptance';
import {expect, test} from '@playwright/test';
test.describe('Design settings', async () => {
test('Working with the preview', async ({page}) => {
await mockApi({page, requests: {
...globalDataRequests,
browseCustomThemeSettings: {method: 'GET', path: '/custom_theme_settings/', response: responseFixtures.customThemeSettings},
browseLatestPost: {method: 'GET', path: /^\/posts\/.+limit=1/, response: responseFixtures.latestPost}
}});
await mockSitePreview({
page,
url: responseFixtures.site.site.url,
response: '<html><head><style></style></head><body><div>homepage preview</div></body></html>'
});
await mockSitePreview({
page,
url: responseFixtures.latestPost.posts[0].url,
response: '<html><head><style></style></head><body><div>post preview</div></body></html>'
});
await page.goto('/#/settings/design');
const section = page.getByTestId('design');
await section.getByRole('button', {name: 'Customize'}).click();
const modal = page.getByTestId('design-modal');
// Homepage and post preview
await expect(modal.frameLocator('[data-testid="theme-preview"] iframe[data-visible=true]').getByText('homepage preview')).toHaveCount(1);
await modal.getByTestId('design-toolbar').getByRole('tab', {name: 'Post'}).click();
await expect(modal.frameLocator('[data-testid="theme-preview"] iframe[data-visible=true]').getByText('post preview')).toHaveCount(1);
// Desktop and mobile preview
await modal.getByRole('button', {name: 'Mobile'}).click();
await expect(modal.getByTestId('preview-mobile')).toBeVisible();
await modal.getByRole('button', {name: 'Desktop'}).click();
await expect(modal.getByTestId('preview-mobile')).not.toBeVisible();
});
test('Warns when leaving without saving', async ({page}) => {
const {lastApiRequests} = await mockApi({page, requests: {
...globalDataRequests,
editSettings: {method: 'PUT', path: '/settings/', response: responseFixtures.settings},
browseCustomThemeSettings: {method: 'GET', path: '/custom_theme_settings/', response: responseFixtures.customThemeSettings},
browseLatestPost: {method: 'GET', path: /^\/posts\/.+limit=1/, response: responseFixtures.latestPost}
}});
await page.goto('/#/settings/design');
const section = page.getByTestId('design');
// Brand setting
await section.getByRole('button', {name: 'Customize'}).click();
const modal = page.getByTestId('design-modal');
const accentColorPicker = modal.getByTestId('accent-color-picker');
await accentColorPicker.getByRole('button').click();
await accentColorPicker.getByRole('textbox').fill('#cd5786');
// set timeout of 1000ms to wait for the debounce
await page.waitForTimeout(1000);
await modal.getByRole('button', {name: 'Close'}).click();
await expect(page.getByTestId('confirmation-modal')).toHaveText(/leave/i);
await page.getByTestId('confirmation-modal').getByRole('button', {name: 'Leave'}).click();
await expect(modal).toBeHidden();
// Custom theme setting
await section.getByRole('button', {name: 'Customize'}).click();
await modal.getByTestId('design-setting-tabs').getByRole('tab', {name: 'Theme'}).click();
await modal.getByLabel('Email signup text').fill('test');
await modal.getByRole('button', {name: 'Close'}).click();
await expect(page.getByTestId('confirmation-modal')).toHaveText(/leave/i);
await page.getByTestId('confirmation-modal').getByRole('button', {name: 'Leave'}).click();
await expect(modal).toBeHidden();
expect(lastApiRequests.editSettings).toBeUndefined();
});
test('Editing brand settings', async ({page}) => {
const {lastApiRequests} = await mockApi({page, requests: {
...globalDataRequests,
editSettings: {method: 'PUT', path: '/settings/', response: responseFixtures.settings},
browseCustomThemeSettings: {method: 'GET', path: '/custom_theme_settings/', response: responseFixtures.customThemeSettings},
browseLatestPost: {method: 'GET', path: /^\/posts\/.+limit=1/, response: responseFixtures.latestPost}
}});
await mockSitePreview({
page,
url: responseFixtures.site.site.url,
response: '<html><head><style></style></head><body><div>homepage preview</div></body></html>'
});
await page.goto('/#/settings/design');
const section = page.getByTestId('design');
await section.getByRole('button', {name: 'Customize'}).click();
const modal = page.getByTestId('design-modal');
await expect(modal.frameLocator('[data-testid="theme-preview"] iframe[data-visible=true]').getByText('homepage preview')).toHaveCount(1);
const accentColorPicker = modal.getByTestId('accent-color-picker');
await accentColorPicker.getByRole('button').click();
await accentColorPicker.getByRole('textbox').fill('#cd5786');
const previewHeaders = await page.waitForRequest((request) => {
const headers = request.headers();
return headers['x-ghost-preview'] !== undefined;
});
const matchingHeader = previewHeaders.headers()['x-ghost-preview'];
expect(matchingHeader).toContain('cd5786');
expect(previewHeaders.headers().accept).toBe('text/html');
await expect(modal.getByTestId('toggle-unsplash-button')).toBeVisible();
await modal.getByRole('button', {name: 'Save'}).click();
const editSettings = await waitForApiRequest(lastApiRequests, 'editSettings');
expect(editSettings.body).toEqual({
settings: [
{key: 'accent_color', value: '#cd5786'}
]
});
});
test('Editing custom theme settings', async ({page}) => {
const {lastApiRequests} = await mockApi({page, requests: {
...globalDataRequests,
editCustomThemeSettings: {method: 'PUT', path: '/custom_theme_settings/', response: responseFixtures.customThemeSettings},
browseCustomThemeSettings: {method: 'GET', path: '/custom_theme_settings/', response: {
custom_theme_settings: [{
type: 'select',
options: [
'Logo on cover',
'Logo in the middle',
'Stacked'
],
default: 'Logo on cover',
id: '648047658d265b0c8b33c591',
value: 'Stacked',
key: 'navigation_layout'
}]
}},
browseLatestPost: {method: 'GET', path: /^\/posts\/.+limit=1/, response: responseFixtures.latestPost}
}});
const {previewRequests} = await mockSitePreview({
page,
url: responseFixtures.site.site.url,
response: '<html><head><style></style></head><body><div>homepage preview</div></body></html>'
});
await page.goto('/#/settings/design');
const section = page.getByTestId('design');
await section.getByRole('button', {name: 'Customize'}).click();
const modal = page.getByTestId('design-modal');
await modal.getByRole('tab', {name: 'Theme'}).click();
await chooseOptionInSelect(modal.getByTestId('setting-select-navigation_layout'), 'Logo in the middle');
const expectedSettings = {navigation_layout: 'Logo in the middle'};
const expectedEncoded = new URLSearchParams([['custom', JSON.stringify(expectedSettings)]]).toString();
await expect.poll(() => previewRequests.find(header => new RegExp(`&${expectedEncoded.replace(/\+/g, '\\+')}`).test(header))).toBeTruthy();
const matchingHeader = previewRequests.find(header => new RegExp(`&${expectedEncoded.replace(/\+/g, '\\+')}`).test(header));
expect(matchingHeader).toBeDefined();
await modal.getByRole('button', {name: 'Save'}).click();
const editCustomThemeSettings = await waitForApiRequest(lastApiRequests, 'editCustomThemeSettings');
expect(editCustomThemeSettings.body).toMatchObject({
custom_theme_settings: [
{key: 'navigation_layout', value: 'Logo in the middle'}
]
});
});
test('Rendering with no custom theme settings', async ({page}) => {
await mockApi({page, requests: {
...globalDataRequests,
browseCustomThemeSettings: {method: 'GET', path: '/custom_theme_settings/', response: {
custom_theme_settings: []
}},
browseLatestPost: {method: 'GET', path: /^\/posts\/.+limit=1/, response: responseFixtures.latestPost}
}});
await mockSitePreview({
page,
url: responseFixtures.site.site.url,
response: '<html><head><style></style></head><body><div>homepage preview</div></body></html>'
});
await page.goto('/#/settings/design');
const section = page.getByTestId('design');
await section.getByRole('button', {name: 'Customize'}).click();
const previewHeaders = await page.waitForRequest((request) => {
const headers = request.headers();
return headers['x-ghost-preview'] !== undefined;
});
const previewHeader = previewHeaders.headers()['x-ghost-preview'];
const expectedEncoded = new URLSearchParams([['custom', JSON.stringify({})]]).toString();
expect(previewHeader).toContain(expectedEncoded);
const modal = page.getByTestId('design-modal');
const designSettingTabs = modal.getByTestId('design-setting-tabs');
await expect(designSettingTabs.getByRole('tab', {name: 'Brand'})).toBeHidden();
await expect(designSettingTabs.getByRole('tab', {name: 'Theme'})).toBeHidden();
await expect(designSettingTabs.getByTestId('accent-color-picker')).toBeVisible();
});
test('Custom theme setting visibility', async ({page}) => {
const {lastApiRequests} = await mockApi({page, requests: {
...globalDataRequests,
editCustomThemeSettings: {method: 'PUT', path: '/custom_theme_settings/', response: responseFixtures.customThemeSettings},
browseCustomThemeSettings: {method: 'GET', path: '/custom_theme_settings/', response: {
custom_theme_settings: [{
type: 'select',
options: [
'Logo on cover',
'Logo in the middle',
'Stacked'
],
default: 'Logo on cover',
id: '648047658d265b0c8b33c591',
value: 'Stacked',
key: 'navigation_layout'
}, {
type: 'boolean',
default: 'false',
id: '648047658d265b0c8b33c592',
value: 'false',
key: 'show_featured_posts',
visibility: 'navigation_layout:[Stacked]'
}]
}},
browseLatestPost: {method: 'GET', path: /^\/posts\/.+limit=1/, response: responseFixtures.latestPost}
}});
const {previewRequests} = await mockSitePreview({
page,
url: responseFixtures.site.site.url,
response: '<html><head><style></style></head><body><div>homepage preview</div></body></html>'
});
await page.goto('/#/settings/design');
const section = page.getByTestId('design');
await section.getByRole('button', {name: 'Customize'}).click();
const modal = page.getByTestId('design-modal');
await modal.getByRole('tab', {name: 'Theme'}).click();
const showFeaturedPostsCustomThemeSetting = modal.getByLabel('Show featured posts');
await expect(showFeaturedPostsCustomThemeSetting).toBeVisible();
await chooseOptionInSelect(modal.getByTestId('setting-select-navigation_layout'), 'Logo in the middle');
// set timeout of 1000ms to wait for the debounce
// await page.waitForTimeout(1000);
const expectedSettings = {navigation_layout: 'Logo in the middle', show_featured_posts: null};
const expectedEncoded = new URLSearchParams([['custom', JSON.stringify(expectedSettings)]]).toString();
await expect.poll(() => previewRequests.find(header => header.includes(expectedEncoded))).toBeTruthy();
const matchingHeader = previewRequests.find(header => header.includes(expectedEncoded));
expect(matchingHeader).toBeDefined();
await expect(showFeaturedPostsCustomThemeSetting).not.toBeVisible();
await modal.getByRole('button', {name: 'Save'}).click();
const editCustomThemeSettings = await waitForApiRequest(lastApiRequests, 'editCustomThemeSettings');
expect(editCustomThemeSettings.body).toMatchObject({
custom_theme_settings: [
{key: 'navigation_layout', value: 'Logo in the middle'},
{key: 'show_featured_posts', value: 'false'}
]
});
});
test('Custom fonts', async ({page}) => {
await mockApi({page, requests: {
...globalDataRequests,
browseCustomThemeSettings: {method: 'GET', path: '/custom_theme_settings/', response: {
custom_theme_settings: []
}},
browseLatestPost: {method: 'GET', path: /^\/posts\/.+limit=1/, response: responseFixtures.latestPost}
}});
const {lastRequest} = await mockSitePreview({
page,
url: responseFixtures.site.site.url,
response: '<html><head><style></style></head><body><div>homepage preview</div></body></html>'
});
await page.goto('/#/settings/design');
const section = page.getByTestId('design');
await section.getByRole('button', {name: 'Customize'}).click();
const modal = page.getByTestId('design-modal');
const designSettingTabs = modal.getByTestId('design-setting-tabs');
await expect(designSettingTabs.getByTestId('accent-color-picker')).toBeVisible();
await expect(designSettingTabs.getByText('Typography')).toBeVisible();
await expect(designSettingTabs.getByTestId('heading-font-select')).toBeVisible();
await expect(designSettingTabs.getByTestId('body-font-select')).toBeVisible();
// select a different heading font
const headingFontSelect = designSettingTabs.getByTestId('heading-font-select');
await headingFontSelect.click();
await headingFontSelect.getByText('Cardo').click();
// select a different body font
const bodyFontSelect = designSettingTabs.getByTestId('body-font-select');
await bodyFontSelect.click();
await bodyFontSelect.getByText('Inter').click();
const expectedEncoded = new URLSearchParams([['bf', 'Inter'], ['hf', 'Cardo']]).toString();
await expect(lastRequest.previewHeader).toMatch(new RegExp(`&${expectedEncoded.replace(/\+/g, '\\+')}`));
});
test('Custom fonts setting back to default', async ({page}) => {
await mockApi({page, requests: {
...globalDataRequests,
browseSettings: {...globalDataRequests.browseSettings, response: updatedSettingsResponse([
{key: 'heading_font', value: 'Cardo'},
{key: 'body_font', value: 'Inter'}
])},
browseCustomThemeSettings: {method: 'GET', path: '/custom_theme_settings/', response: {
custom_theme_settings: []
}},
browseLatestPost: {method: 'GET', path: /^\/posts\/.+limit=1/, response: responseFixtures.latestPost}
}});
const {previewRequests} = await mockSitePreview({
page,
url: responseFixtures.site.site.url,
response: '<html><head><style></style></head><body><div>homepage preview</div></body></html>'
});
await page.goto('/#/settings/design');
const section = page.getByTestId('design');
await section.getByRole('button', {name: 'Customize'}).click();
const modal = page.getByTestId('design-modal');
// The fonts should be set to the values in the settings
await expect(modal.getByTestId('heading-font-select')).toHaveText(/Cardo/);
await expect(modal.getByTestId('body-font-select')).toHaveText(/Inter/);
const designSettingTabs = modal.getByTestId('design-setting-tabs');
// select a different heading font
const headingFontSelect = designSettingTabs.getByTestId('heading-font-select');
await headingFontSelect.click();
await headingFontSelect.getByText('Theme default').click();
// select a different body font
const bodyFontSelect = designSettingTabs.getByTestId('body-font-select');
await bodyFontSelect.click();
await bodyFontSelect.getByText('Theme default').click();
const expectedEncoded = new URLSearchParams([['bf', ''], ['hf', '']]).toString();
const matchingHeader = previewRequests.find(header => header.includes(expectedEncoded));
expect(matchingHeader).toBeDefined();
// expect(lastRequest.previewHeader).toMatch(new RegExp(`&${expectedEncoded.replace(/\+/g, '\\+')}`));
});
test('Old font settings are hidden with custom fonts support', async ({page}) => {
const {lastApiRequests} = await mockApi({page, requests: {
...globalDataRequests,
browseThemes: {method: 'GET', path: '/themes/', response: responseFixtures.themes},
installTheme: {method: 'POST', path: /^\/themes\/install\/\?/, response: {
themes: [{
name: 'headline',
package: {},
active: false,
templates: []
}]
}},
activateTheme: {method: 'PUT', path: '/themes/headline/activate/', response: {
themes: [{
name: 'headline',
package: {
name: 'headline',
author: {
name: 'Ghost Foundation'
}
},
active: true,
templates: []
}]
}},
browseCustomThemeSettings: {method: 'GET', path: '/custom_theme_settings/', response: {
custom_theme_settings: [
{
type: 'select',
options: [
'Modern sans-serif',
'Elegant serif'
],
default: 'Modern sans-serif',
value: 'Modern sans-serif',
key: 'title_font'
},
{
type: 'select',
options: [
'Modern sans-serif',
'Elegant serif'
],
default: 'Elegant serif',
value: 'Elegant serif',
key: 'body_font'
}
]
}},
activeTheme: {
method: 'GET',
path: '/themes/active/',
response: {
themes: [{
name: 'casper',
package: {},
active: true,
templates: []
}]
}
}
}});
await page.goto('/#/settings/theme');
const themeSection = page.getByTestId('theme');
await themeSection.getByRole('button', {name: 'Change theme'}).click();
const modal = page.getByTestId('theme-modal');
await modal.getByRole('button', {name: /Headline/}).click();
await modal.getByRole('button', {name: 'Install Headline'}).click();
await expect(page.getByTestId('confirmation-modal')).toHaveText(/installed/);
await page.getByRole('button', {name: 'Activate'}).click();
await expect(page.getByTestId('toast-success')).toHaveText(/headline is now your active theme/);
expect(lastApiRequests.installTheme?.url).toMatch(/\?source=github&ref=TryGhost%2FHeadline/);
await page.goto('/#/settings/design');
const designSection = page.getByTestId('design');
await designSection.getByRole('button', {name: 'Customize'}).click();
const designModal = page.getByTestId('design-modal');
await designModal.getByRole('tab', {name: 'Theme'}).click();
const titleFontCustomThemeSetting = designModal.getByLabel('Title font');
await expect(titleFontCustomThemeSetting).not.toBeVisible();
const bodyFontCustomThemeSetting = designModal.getByLabel('Body font');
await expect(bodyFontCustomThemeSetting).not.toBeVisible();
});
test('Old font settings are visible with no custom fonts support', async ({page}) => {
await mockApi({page, requests: {
...globalDataRequests,
browseThemes: {method: 'GET', path: '/themes/', response: responseFixtures.themes},
activateTheme: {method: 'PUT', path: '/themes/casper/activate/', response: {
themes: [{
name: 'casper',
package: {},
active: true,
templates: []
}]
}},
browseCustomThemeSettings: {method: 'GET', path: '/custom_theme_settings/', response: {
custom_theme_settings: [
{
type: 'select',
options: [
'Modern sans-serif',
'Elegant serif'
],
default: 'Modern sans-serif',
value: 'Modern sans-serif',
key: 'title_font'
},
{
type: 'select',
options: [
'Modern sans-serif',
'Elegant serif'
],
default: 'Elegant serif',
value: 'Elegant serif',
key: 'body_font'
}
]
}},
activeTheme: {
method: 'GET',
path: '/themes/active/',
response: {
themes: [{
name: 'casper',
package: {},
active: true,
templates: [],
warnings: [{
fatal: false,
level: 'warning',
rule: 'Missing support for custom fonts',
details: 'CSS variables for Ghost font settings are not present: <code>--gh-font-heading</code>, <code>--gh-font-body</code>',
regex: {},
failures: [
{
ref: 'styles'
}
],
code: 'GS051-CUSTOM-FONTS'
}]
}]
}
}
}});
await page.goto('/#/settings/design');
const designSection = page.getByTestId('design');
await designSection.getByRole('button', {name: 'Customize'}).click();
const designModal = page.getByTestId('design-modal');
await designModal.getByRole('tab', {name: 'Theme'}).click();
const titleFontCustomThemeSetting = designModal.getByLabel('Title font');
await expect(titleFontCustomThemeSetting).toBeVisible();
const bodyFontCustomThemeSetting = designModal.getByLabel('Body font');
await expect(bodyFontCustomThemeSetting).toBeVisible();
});
});