-
Notifications
You must be signed in to change notification settings - Fork 3.7k
Expand file tree
/
Copy pathe2e.spec.ts
More file actions
2232 lines (1730 loc) · 71.4 KB
/
e2e.spec.ts
File metadata and controls
2232 lines (1730 loc) · 71.4 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
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import type { BrowserContext, Locator, Page } from '@playwright/test'
import { expect, test } from '@playwright/test'
import * as path from 'path'
import { mapAsync } from 'payload'
import { wait } from 'payload/shared'
import { fileURLToPath } from 'url'
import type { PayloadTestSDK } from '../__helpers/shared/sdk/index.js'
import type {
Autosave,
Config,
Page as PageType,
PayloadLockedDocument,
Post,
ServerComponent,
Simple,
SimpleWithVersion,
Test,
User,
} from './payload-types.js'
import { goToNextPage } from '../__helpers/e2e/goToNextPage.js'
import {
ensureCompilationIsDone,
exactText,
initPageConsoleErrorCatch,
saveDocAndAssert,
} from '../__helpers/e2e/helpers.js'
import { AdminUrlUtil } from '../__helpers/shared/adminUrlUtil.js'
import { reInitializeDB } from '../__helpers/shared/clearAndSeed/reInitializeDB.js'
import { initPayloadE2ENoConfig } from '../__helpers/shared/initPayloadE2ENoConfig.js'
import { TEST_TIMEOUT_LONG } from '../playwright.config.js'
const filename = fileURLToPath(import.meta.url)
const dirname = path.dirname(filename)
const { beforeAll, describe, beforeEach } = test
const lockedDocumentCollection = 'payload-locked-documents'
let page: Page
let globalUrl: AdminUrlUtil
let postsUrl: AdminUrlUtil
let pagesUrl: AdminUrlUtil
let serverComponentsUrl: AdminUrlUtil
let testsUrl: AdminUrlUtil
let simpleUrl: AdminUrlUtil
let simpleWithVersionsUrl: AdminUrlUtil
let autosaveUrl: AdminUrlUtil
let payload: PayloadTestSDK<Config>
let serverURL: string
describe('Locked Documents', () => {
beforeAll(async ({ browser }, testInfo) => {
testInfo.setTimeout(TEST_TIMEOUT_LONG)
;({ payload, serverURL } = await initPayloadE2ENoConfig<Config>({ dirname }))
globalUrl = new AdminUrlUtil(serverURL, 'menu')
postsUrl = new AdminUrlUtil(serverURL, 'posts')
pagesUrl = new AdminUrlUtil(serverURL, 'pages')
serverComponentsUrl = new AdminUrlUtil(serverURL, 'server-components')
testsUrl = new AdminUrlUtil(serverURL, 'tests')
simpleUrl = new AdminUrlUtil(serverURL, 'simple')
simpleWithVersionsUrl = new AdminUrlUtil(serverURL, 'simple-with-versions')
autosaveUrl = new AdminUrlUtil(serverURL, 'autosave')
const context = await browser.newContext()
page = await context.newPage()
initPageConsoleErrorCatch(page)
await ensureCompilationIsDone({ page, serverURL })
})
beforeEach(async () => {
await reInitializeDB({
serverURL,
snapshotKey: 'lockedDocumentsTest',
})
})
describe('disabled locking', () => {
test('should prevent locking of documents if lockDocuments is false', async () => {
const { id } = await createPageDoc({})
await page.goto(pagesUrl.edit(id))
const textInput = page.locator('#field-text')
await textInput.fill('hello world')
// eslint-disable-next-line payload/no-wait-function
await wait(500)
const lockedDocs = await payload.find({
collection: lockedDocumentCollection,
limit: 1,
pagination: false,
where: {
'document.value': { equals: id },
},
})
expect(lockedDocs.docs.length).toBe(0)
})
})
describe('list view - collections', () => {
let postDoc: Post
let anotherPostDoc: Post
let user2: User
let lockedDoc: PayloadLockedDocument
let testDoc: Test
let testLockedDoc: PayloadLockedDocument
beforeEach(async () => {
postDoc = await createPostDoc({
text: 'hello locked',
})
anotherPostDoc = await createPostDoc({
text: 'another post',
})
testDoc = await createTestDoc({
text: 'test doc',
})
user2 = await payload.create({
collection: 'users',
data: {
email: 'user2@payloadcms.com',
password: '1234',
roles: ['is_user'],
},
})
lockedDoc = await payload.create({
collection: lockedDocumentCollection,
data: {
document: {
relationTo: 'posts',
value: postDoc.id,
},
globalSlug: undefined,
user: {
relationTo: 'users',
value: user2.id,
},
},
})
testLockedDoc = await payload.create({
collection: lockedDocumentCollection,
data: {
document: {
relationTo: 'tests',
value: testDoc.id,
},
globalSlug: undefined,
user: {
relationTo: 'users',
value: user2.id,
},
},
})
})
test('should show lock icon on document row if locked', async () => {
await page.goto(postsUrl.list)
await expect(page.locator('.table .row-2 .locked svg')).toBeVisible()
})
test('should not show lock icon on document row if unlocked', async () => {
await page.goto(postsUrl.list)
await expect(page.locator('.table .row-3 .checkbox-input__input')).toBeVisible()
})
test('should not show lock icon on document if expired', async () => {
await page.goto(testsUrl.list)
// Need to wait for lock duration to expire (lockDuration: 5 seconds)
// eslint-disable-next-line payload/no-wait-function
await wait(5000)
await page.reload()
await expect(page.locator('.table .row-1 .checkbox-input__input')).toBeVisible()
})
test('should not show lock icon on document row if locked by current user', async () => {
await page.goto(postsUrl.edit(anotherPostDoc.id))
const textInput = page.locator('#field-text')
await textInput.fill('testing')
await page.reload()
await page.goto(postsUrl.list)
await expect(page.locator('.table .row-1 .checkbox-input__input')).toBeVisible()
})
test('should only allow bulk delete on unlocked documents on current page', async () => {
await page.goto(postsUrl.list)
await page.locator('input#select-all').click()
// Should be partial since one doc is locked and cannot be selected
await expect(page.locator('.select-all .checkbox-input__icon.partial')).toBeVisible()
await page.locator('.delete-documents__toggle').click()
await expect(
page.locator('#confirm-delete-many-docs .confirmation-modal__content p'),
).toHaveText('You are about to delete 2 Posts')
})
test('should only allow bulk delete on unlocked documents on all pages', async () => {
await mapAsync([...Array(9)], async () => {
await createPostDoc({
text: 'Ready for delete',
})
})
await page.reload()
await page.goto(postsUrl.list)
await page.locator('input#select-all').check()
await page.locator('.list-selection .list-selection__button#select-all-across-pages').click()
await page.locator('.delete-documents__toggle').click()
await page.locator('#confirm-delete-many-docs #confirm-action').click()
await expect(page.locator('.cell-_select')).toHaveCount(1)
})
test('should only allow bulk publish on unlocked documents on all pages', async () => {
await mapAsync([...Array(9)], async () => {
await createPostDoc({
text: 'Ready for unpublish',
})
})
await page.reload()
await page.goto(postsUrl.list)
await page.locator('input#select-all').check()
await page.locator('.list-selection .list-selection__button#select-all-across-pages').click()
await page.locator('.list-selection__button[aria-label="Publish"]').click()
await page.locator('#publish-posts #confirm-action').click()
await goToNextPage(page)
await expect(page.locator('.row-1 .cell-_status')).toContainText('Draft')
})
test('should only allow bulk unpublish on unlocked documents on all pages', async () => {
await mapAsync([...Array(10)], async () => {
await createPostDoc({
text: 'Ready for publish',
_status: 'published',
})
})
await page.goto(postsUrl.list)
await page.locator('input#select-all').check()
await page.locator('.list-selection .list-selection__button#select-all-across-pages').click()
await page.locator('.list-selection__button[aria-label="Unpublish"]').click()
await page.locator('#unpublish-posts #confirm-action').click()
await expect(page.locator('.payload-toast-container .toast-success')).toHaveText(
'Updated 10 Posts successfully.',
)
})
test('should only allow bulk edit on unlocked documents on all pages', async () => {
await mapAsync([...Array(8)], async () => {
await createPostDoc({
text: 'doc',
_status: 'draft',
})
})
await page.goto(postsUrl.list)
const bulkText = 'Bulk update title'
await page.locator('input#select-all').click()
// Should be partial since one doc is locked and cannot be selected
await expect(page.locator('.select-all .checkbox-input__icon.partial')).toBeVisible()
await page.locator('.list-selection .list-selection__button#select-all-across-pages').click()
await page.locator('.edit-many__toggle').click()
await page.locator('.field-select .rs__control').click()
const textOption = page.locator('.field-select .rs__option', {
hasText: exactText('Text'),
})
await expect(textOption).toBeVisible()
await textOption.click()
const textInput = page.locator('#field-text')
await expect(textInput).toBeVisible()
await textInput.fill(bulkText)
await page.locator('.form-submit button[type="submit"].edit-many__publish').click()
await expect(page.locator('.payload-toast-container .toast-error')).toContainText(
'Unable to update 1 out of 11 Posts.',
)
await page.locator('.edit-many__header__close').click()
await page.reload()
await expect(page.locator('.row-1 .cell-text')).toContainText(bulkText)
await expect(page.locator('.row-2 .cell-text')).toContainText(bulkText)
await expect(page.locator('.row-10 .cell-text')).toContainText('hello locked')
})
})
describe('document locking / unlocking - one user', () => {
let postDoc: Post
let postDocTwo: Post
let expiredDocOne: Test
let expiredLockedDocOne: PayloadLockedDocument
let expiredDocTwo: Test
let expiredLockedDocTwo: PayloadLockedDocument
let testDoc: Test
let user2: User
beforeEach(async () => {
postDoc = await createPostDoc({
text: 'hello',
})
postDocTwo = await createPostDoc({
text: 'post doc two',
})
user2 = await payload.create({
collection: 'users',
data: {
email: 'user2@payloadcms.com',
password: '1234',
roles: ['is_user'],
},
})
expiredDocOne = await createTestDoc({
text: 'expired doc one',
})
expiredLockedDocOne = await payload.create({
collection: lockedDocumentCollection,
data: {
document: {
relationTo: 'tests',
value: expiredDocOne.id,
},
globalSlug: undefined,
user: {
relationTo: 'users',
value: user2.id,
},
},
})
expiredDocTwo = await createTestDoc({
text: 'expired doc two',
})
expiredLockedDocTwo = await payload.create({
collection: lockedDocumentCollection,
data: {
document: {
relationTo: 'tests',
value: expiredDocTwo.id,
},
globalSlug: undefined,
user: {
relationTo: 'users',
value: user2.id,
},
},
})
testDoc = await createTestDoc({ text: 'hello' })
})
test('should delete all expired locked documents upon initial editing of unlocked document', async () => {
await page.goto(testsUrl.list)
await expect(page.locator('.table .row-2 .locked svg')).toBeVisible()
await expect(page.locator('.table .row-3 .locked svg')).toBeVisible()
// eslint-disable-next-line payload/no-wait-function
await wait(5000)
await page.reload()
await expect(page.locator('.table .row-2 .checkbox-input__input')).toBeVisible()
await expect(page.locator('.table .row-3 .checkbox-input__input')).toBeVisible()
const lockedTestDocs = await payload.find({
collection: lockedDocumentCollection,
pagination: false,
})
expect(lockedTestDocs.docs.length).toBe(2)
await page.goto(testsUrl.edit(testDoc.id))
const textInput = page.locator('#field-text')
await textInput.fill('some test doc')
// eslint-disable-next-line payload/no-wait-function
await wait(500)
const lockedDocs = await payload.find({
collection: lockedDocumentCollection,
pagination: false,
})
expect(lockedDocs.docs.length).toBe(1)
})
test('should lock document upon initial editing of unlocked document', async () => {
await page.goto(postsUrl.edit(postDoc.id))
const textInput = page.locator('#field-text')
await textInput.fill('hello world')
// eslint-disable-next-line payload/no-wait-function
await wait(500)
const lockedDocs = await payload.find({
collection: lockedDocumentCollection,
limit: 1,
pagination: false,
where: {
'document.value': { equals: postDoc.id },
},
})
expect(lockedDocs.docs.length).toBe(1)
})
test('should unlock document on save / publish', async () => {
await page.goto(postsUrl.edit(postDoc.id))
const textInput = page.locator('#field-text')
await textInput.fill('hello world')
// eslint-disable-next-line payload/no-wait-function
await wait(500)
const lockedDocs = await payload.find({
collection: lockedDocumentCollection,
limit: 1,
pagination: false,
where: {
'document.value': { equals: postDoc.id },
},
})
expect(lockedDocs.docs.length).toBe(1)
await saveDocAndAssert(page)
// eslint-disable-next-line payload/no-wait-function
await wait(500)
const unlockedDocs = await payload.find({
collection: lockedDocumentCollection,
limit: 1,
pagination: false,
where: {
'document.value': { equals: postDoc.id },
},
})
expect(unlockedDocs.docs.length).toBe(0)
})
test('should keep document locked when navigating to other tabs i.e. api', async () => {
await page.goto(postsUrl.edit(postDoc.id))
const textInput = page.locator('#field-text')
await textInput.fill('testing tab navigation...')
// eslint-disable-next-line payload/no-wait-function
await wait(500)
const lockedDocs = await payload.find({
collection: lockedDocumentCollection,
limit: 1,
pagination: false,
where: {
'document.value': { equals: postDoc.id },
},
})
expect(lockedDocs.docs.length).toBe(1)
await page.locator('a[aria-label="API"]').click()
// Locate the modal container
const modalContainer = page.locator('.payload__modal-container')
await expect(modalContainer).toBeVisible()
// Click the "Leave anyway" button
await page
.locator('#leave-without-saving .confirmation-modal__controls .btn--style-primary')
.click()
// eslint-disable-next-line payload/no-wait-function
await wait(500)
const unlockedDocs = await payload.find({
collection: lockedDocumentCollection,
limit: 1,
pagination: false,
where: {
'document.value': { equals: postDoc.id },
},
})
expect(unlockedDocs.docs.length).toBe(1)
await payload.delete({
collection: lockedDocumentCollection,
where: {
'document.value': { equals: postDoc.id },
},
})
})
test('should unlock document on navigate away', async () => {
await page.goto(postsUrl.edit(postDocTwo.id))
const textInput = page.locator('#field-text')
await textInput.fill('hello world')
// eslint-disable-next-line payload/no-wait-function
await wait(1000)
const lockedDocs = await payload.find({
collection: lockedDocumentCollection,
limit: 1,
pagination: false,
where: {
'document.value': { equals: postDocTwo.id },
},
})
expect(lockedDocs.docs.length).toBe(1)
await page.locator('header.app-header a[href="/admin/collections/posts"]').click()
// Locate the modal container
const modalContainer = page.locator('.payload__modal-container')
await expect(modalContainer).toBeVisible()
// Click the "Leave anyway" button
await page
.locator('#leave-without-saving .confirmation-modal__controls .btn--style-primary')
.click()
// eslint-disable-next-line payload/no-wait-function
await wait(500)
expect(page.url()).toContain(postsUrl.list)
const unlockedDocs = await payload.find({
collection: lockedDocumentCollection,
limit: 1,
pagination: false,
where: {
'document.value': { equals: postDoc.id },
},
})
expect(unlockedDocs.docs.length).toBe(0)
})
})
describe('document locking - incoming user', () => {
let postDoc: Post
let user2: User
let lockedDoc: PayloadLockedDocument
let expiredTestDoc: Test
let expiredTestLockedDoc: PayloadLockedDocument
let expiredPostDoc: Post
let expiredPostLockedDoc: PayloadLockedDocument
let serverComponentDoc: ServerComponent
let lockedServerComponentDoc: PayloadLockedDocument
beforeEach(async () => {
postDoc = await createPostDoc({
text: 'new post doc',
})
serverComponentDoc = await payload.create({
collection: 'server-components',
data: {},
})
expiredTestDoc = await createTestDoc({
text: 'expired doc',
})
user2 = await payload.create({
collection: 'users',
data: {
email: 'user2@payloadcms.com',
password: '1234',
roles: ['is_user'],
},
})
lockedDoc = await payload.create({
collection: lockedDocumentCollection,
data: {
document: {
relationTo: 'posts',
value: postDoc.id,
},
globalSlug: undefined,
user: {
relationTo: 'users',
value: user2.id,
},
},
})
expiredTestLockedDoc = await payload.create({
collection: lockedDocumentCollection,
data: {
document: {
relationTo: 'tests',
value: expiredTestDoc.id,
},
globalSlug: undefined,
user: {
relationTo: 'users',
value: user2.id,
},
},
})
expiredPostDoc = await createPostDoc({
text: 'expired post doc',
})
expiredPostLockedDoc = await payload.create({
collection: lockedDocumentCollection,
data: {
document: {
relationTo: 'posts',
value: expiredPostDoc.id,
},
globalSlug: undefined,
user: {
relationTo: 'users',
value: user2.id,
},
createdAt: new Date(Date.now() - 1000 * 60 * 60).toISOString(),
updatedAt: new Date(Date.now() - 1000 * 60 * 60).toISOString(),
},
})
lockedServerComponentDoc = await payload.create({
collection: lockedDocumentCollection,
data: {
document: {
relationTo: 'server-components',
value: serverComponentDoc.id,
},
globalSlug: undefined,
user: {
relationTo: 'users',
value: user2.id,
},
},
})
})
test('should show Document Locked modal for incoming user when entering locked document', async () => {
await page.goto(postsUrl.list)
// eslint-disable-next-line payload/no-wait-function
await wait(500)
await page.goto(postsUrl.edit(postDoc.id))
const modalContainer = page.locator('.payload__modal-container')
await expect(modalContainer).toBeVisible()
await page.locator('#document-locked-go-back').click()
// should go back to collection list view
expect(page.url()).toContain(postsUrl.list)
})
test('should properly close modal and allow re-opening after clicking Go Back', async () => {
await page.goto(postsUrl.list)
// eslint-disable-next-line payload/no-wait-function
await wait(500)
// First time: navigate to locked document
await page.goto(postsUrl.edit(postDoc.id))
const modalContainer = page.locator('.payload__modal-container')
await expect(modalContainer).toBeVisible()
// Click Go Back
await page.locator('#document-locked-go-back').click()
// Wait for navigation to complete
await page.waitForURL(`**${postsUrl.list}`)
// Modal should be completely closed
await expect(modalContainer).toBeHidden()
// Second time: navigate to the same locked document again
await page.goto(postsUrl.edit(postDoc.id))
// Modal should appear again (verifies no stuck modal state)
await expect(modalContainer).toBeVisible()
await expect(page.locator('#document-locked-go-back')).toBeVisible()
})
test('should not show Document Locked modal for incoming user when entering expired locked document', async () => {
await page.goto(testsUrl.list)
// Need to wait for lock duration to expire (lockDuration: 5 seconds)
// eslint-disable-next-line payload/no-wait-function
await wait(5000)
await page.reload()
await page.goto(testsUrl.edit(expiredTestDoc.id))
const modalContainer = page.locator('.payload__modal-container')
await expect(modalContainer).toBeHidden()
})
test('expired lock should render editable fields (no read-only)', async () => {
await page.goto(postsUrl.edit(expiredPostDoc.id))
await expect(page.locator('#field-text')).toBeEnabled()
const richTextRoot = page
.locator('.rich-text-lexical .ContentEditable__root[data-lexical-editor="true"]')
.first()
await expect(richTextRoot).toBeVisible()
// ensure richtext is editable
await expect(richTextRoot).toHaveAttribute('contenteditable', 'true')
})
test('should show fields in read-only if incoming user views locked doc in read-only mode', async () => {
await page.goto(postsUrl.edit(postDoc.id))
const modalContainer = page.locator('.payload__modal-container')
await expect(modalContainer).toBeVisible()
// Click read-only button to view doc in read-only mode
await page.locator('#document-locked-view-read-only').click()
// save buttons should be readOnly / disabled
await expect(page.locator('#action-save-draft')).toBeDisabled()
await expect(page.locator('#action-save')).toBeDisabled()
await expect(page.locator('.doc-controls__dots')).toBeHidden()
// fields should be readOnly / disabled
await expect(page.locator('#field-text')).toBeDisabled()
const richTextRoot = page
.locator('.rich-text-lexical .ContentEditable__root[data-lexical-editor="true"]')
.first()
// ensure editor is present
await expect(richTextRoot).toBeVisible()
// core read-only checks
await expect(richTextRoot).toHaveAttribute('contenteditable', 'false')
await expect(richTextRoot).toHaveAttribute('aria-readonly', 'true')
// wrapper has read-only class
await expect(page.locator('.rich-text-lexical').first()).toHaveClass(
/rich-text-lexical--read-only/,
)
})
test('should show server rendered fields in read-only if incoming user views locked doc in read-only mode', async () => {
await page.goto(serverComponentsUrl.edit(serverComponentDoc.id))
const modalContainer = page.locator('.payload__modal-container')
await expect(modalContainer).toBeVisible()
// Click read-only button to view doc in read-only mode
await page.locator('#document-locked-view-read-only').click()
// Wait for the modal to disappear
await expect(modalContainer).toBeHidden()
// fields should be readOnly / disabled
await expect(page.locator('#field-customTextServer')).toBeDisabled()
})
})
describe('document take over - modal - incoming user', () => {
let postDoc: Post
let user2: User
let lockedDoc: PayloadLockedDocument
let serverComponentDoc: ServerComponent
let lockedServerComponentsDoc: PayloadLockedDocument
beforeEach(async () => {
postDoc = await createPostDoc({
text: 'hello',
})
serverComponentDoc = await payload.create({
collection: 'server-components',
data: {},
})
user2 = await payload.create({
collection: 'users',
data: {
email: 'user2@payloadcms.com',
password: '1234',
roles: ['is_user'],
},
})
lockedDoc = await payload.create({
collection: lockedDocumentCollection,
data: {
document: {
relationTo: 'posts',
value: postDoc.id,
},
globalSlug: undefined,
user: {
relationTo: 'users',
value: user2.id,
},
},
})
lockedServerComponentsDoc = await payload.create({
collection: lockedDocumentCollection,
data: {
document: {
relationTo: 'server-components',
value: serverComponentDoc.id,
},
globalSlug: undefined,
user: {
relationTo: 'users',
value: user2.id,
},
},
})
})
test('should update user data if incoming user takes over from document modal', async () => {
await page.goto(postsUrl.edit(postDoc.id))
const modalContainer = page.locator('.payload__modal-container')
await expect(modalContainer).toBeVisible()
// Click take-over button to take over editing rights of locked doc
await page.locator('#document-locked-take-over').click()
// eslint-disable-next-line payload/no-wait-function
await wait(1000)
const lockedDoc = await payload.find({
collection: lockedDocumentCollection,
limit: 1,
pagination: false,
where: {
'document.value': { equals: postDoc.id },
},
})
// eslint-disable-next-line payload/no-wait-function
await wait(500)
expect(lockedDoc.docs.length).toBe(1)
const userEmail =
// eslint-disable-next-line playwright/no-conditional-in-test
lockedDoc.docs[0]?.user.value &&
typeof lockedDoc.docs[0].user.value === 'object' &&
'email' in lockedDoc.docs[0].user.value &&
lockedDoc.docs[0].user.value.email
expect(userEmail).toEqual('dev@payloadcms.com')
})
test('should render server rendered fields as editable on take over from document modal', async () => {
await page.goto(serverComponentsUrl.edit(serverComponentDoc.id))
const modalContainer = page.locator('.payload__modal-container')
await expect(modalContainer).toBeVisible()
// Click take-over button to take over editing rights of locked doc
await page.locator('#document-locked-take-over').click()
// Wait for the modal to disappear
await expect(modalContainer).toBeHidden()
// server fields should be enabled
await expect(page.locator('#field-customTextServer')).toBeEnabled()
})
})
describe('document take over - doc - incoming user', () => {
let postDoc: Post
let user2: User
let lockedDoc: PayloadLockedDocument
let serverComponentsDoc: ServerComponent
let lockedServerComponentsDoc: PayloadLockedDocument
beforeEach(async () => {
postDoc = await createPostDoc({
text: 'hello',
})
serverComponentsDoc = await payload.create({
collection: 'server-components',
data: {},
})
user2 = await payload.create({
collection: 'users',
data: {
email: 'user2@payloadcms.com',
password: '1234',
roles: ['is_user'],
},
})
lockedDoc = await payload.create({
collection: lockedDocumentCollection,
data: {
document: {
relationTo: 'posts',
value: postDoc.id,
},
globalSlug: undefined,
user: {
relationTo: 'users',
value: user2.id,
},
},
})
lockedServerComponentsDoc = await payload.create({
collection: lockedDocumentCollection,
data: {
document: {
relationTo: 'server-components',
value: serverComponentsDoc.id,
},
globalSlug: undefined,
user: {
relationTo: 'users',
value: user2.id,
},
},
})
})
test('should update user data if incoming user takes over from within document', async () => {
await page.goto(postsUrl.edit(postDoc.id))
const modalContainer = page.locator('.payload__modal-container')
await expect(modalContainer).toBeVisible()
// Click read-only button to view doc in read-only mode
await page.locator('#document-locked-view-read-only').click()
await page.locator('#take-over').click()
// eslint-disable-next-line payload/no-wait-function
await wait(500)
const lockedDoc = await payload.find({
collection: lockedDocumentCollection,
limit: 1,
pagination: false,
where: {