-
Notifications
You must be signed in to change notification settings - Fork 948
Expand file tree
/
Copy pathEnumeratorTests.swift
More file actions
2025 lines (1771 loc) · 90.3 KB
/
EnumeratorTests.swift
File metadata and controls
2025 lines (1771 loc) · 90.3 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
// SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
// SPDX-License-Identifier: LGPL-3.0-or-later
@preconcurrency import FileProvider
@testable import NextcloudFileProviderKit
import NextcloudFileProviderKitMocks
import NextcloudKit
import RealmSwift
@testable import TestInterface
import XCTest
final class EnumeratorTests: NextcloudFileProviderKitTestCase {
static let account = Account(
user: "testUser", id: "testUserId", serverUrl: "https://mock.nc.com", password: "abcd"
)
var rootItem: MockRemoteItem!
var remoteFolder: MockRemoteItem!
var remoteItemA: MockRemoteItem!
var remoteItemB: MockRemoteItem!
var remoteItemC: MockRemoteItem!
var rootTrashItem: MockRemoteItem!
var remoteTrashItemA: MockRemoteItem!
var remoteTrashItemB: MockRemoteItem!
var remoteTrashItemC: MockRemoteItem!
static let dbManager = FilesDatabaseManager(account: account, databaseDirectory: makeDatabaseDirectory(), fileProviderDomainIdentifier: NSFileProviderDomainIdentifier("test"), log: FileProviderLogMock())
override func setUp() {
super.setUp()
Realm.Configuration.defaultConfiguration.inMemoryIdentifier = name
rootItem = MockRemoteItem.rootItem(account: Self.account)
remoteFolder = MockRemoteItem(
identifier: "folder",
versionIdentifier: "NEW",
name: "folder",
remotePath: Self.account.davFilesUrl + "/folder",
directory: true,
account: Self.account.ncKitAccount,
username: Self.account.username,
userId: Self.account.id,
serverUrl: Self.account.serverUrl
)
remoteItemA = MockRemoteItem(
identifier: "itemA",
versionIdentifier: "NEW",
name: "itemA",
remotePath: Self.account.davFilesUrl + "/folder/itemA",
account: Self.account.ncKitAccount,
username: Self.account.username,
userId: Self.account.id,
serverUrl: Self.account.serverUrl
)
remoteItemB = MockRemoteItem(
identifier: "itemB",
name: "itemB",
remotePath: Self.account.davFilesUrl + "/folder/itemB",
account: Self.account.ncKitAccount,
username: Self.account.username,
userId: Self.account.id,
serverUrl: Self.account.serverUrl
)
remoteItemC = MockRemoteItem(
identifier: "itemC",
name: "itemC",
remotePath: Self.account.davFilesUrl + "/folder/itemC",
account: Self.account.ncKitAccount,
username: Self.account.username,
userId: Self.account.id,
serverUrl: Self.account.serverUrl
)
rootItem.children = [remoteFolder]
remoteFolder.parent = rootItem
remoteFolder.children = [remoteItemA, remoteItemB]
remoteItemA.parent = remoteFolder
remoteItemB.parent = remoteFolder
remoteItemC.parent = nil
rootTrashItem = MockRemoteItem.rootTrashItem(account: Self.account)
remoteTrashItemA = MockRemoteItem(
identifier: "trashItemA",
name: "a.txt",
remotePath: Self.account.trashUrl + "/a.txt",
data: Data(repeating: 1, count: 32),
account: Self.account.ncKitAccount,
username: Self.account.username,
userId: Self.account.id,
serverUrl: Self.account.serverUrl
)
remoteTrashItemB = MockRemoteItem(
identifier: "trashItemB",
name: "b.txt",
remotePath: Self.account.trashUrl + "/b.txt",
data: Data(repeating: 1, count: 69),
account: Self.account.ncKitAccount,
username: Self.account.username,
userId: Self.account.id,
serverUrl: Self.account.serverUrl
)
remoteTrashItemC = MockRemoteItem(
identifier: "trashItemC",
name: "c.txt",
remotePath: Self.account.trashUrl + "/c.txt",
data: Data(repeating: 1, count: 100),
account: Self.account.ncKitAccount,
username: Self.account.username,
userId: Self.account.id,
serverUrl: Self.account.serverUrl
)
rootTrashItem.children = [remoteTrashItemA, remoteTrashItemB, remoteTrashItemC]
remoteTrashItemA.parent = rootTrashItem
remoteTrashItemB.parent = rootTrashItem
remoteTrashItemC.parent = rootTrashItem
}
func testRootEnumeration() async throws {
let db = Self.dbManager.ncDatabase() // Strong ref for in memory test db
debugPrint(db) // Avoid build-time warning about unused variable, ensure compiler won't free
let remoteInterface = MockRemoteInterface(account: Self.account, rootItem: rootItem)
let enumerator = try Enumerator(
enumeratedItemIdentifier: .rootContainer,
account: Self.account,
remoteInterface: remoteInterface,
dbManager: Self.dbManager,
log: FileProviderLogMock()
)
let observer = MockEnumerationObserver(enumerator: enumerator)
try await observer.enumerateItems()
XCTAssertEqual(observer.items.count, 2)
let retrievedRootItem = try XCTUnwrap(observer.items.first)
XCTAssertEqual(retrievedRootItem.itemIdentifier.rawValue, rootItem.identifier)
let retrievedFolderItem = try XCTUnwrap(observer.items.last)
XCTAssertEqual(retrievedFolderItem.itemIdentifier.rawValue, remoteFolder.identifier)
XCTAssertEqual(retrievedFolderItem.filename, remoteFolder.name)
XCTAssertEqual(retrievedFolderItem.parentItemIdentifier.rawValue, rootItem.identifier)
XCTAssertEqual(retrievedFolderItem.creationDate, remoteFolder.creationDate)
XCTAssertEqual(
Int(retrievedFolderItem.contentModificationDate??.timeIntervalSince1970 ?? 0),
Int(remoteFolder.modificationDate.timeIntervalSince1970)
)
let dbFolder = try XCTUnwrap(Self.dbManager.itemMetadata(ocId: remoteFolder.identifier))
XCTAssertEqual(dbFolder.etag, remoteFolder.versionIdentifier)
XCTAssertEqual(dbFolder.fileName, remoteFolder.name)
XCTAssertEqual(dbFolder.fileNameView, remoteFolder.name)
XCTAssertEqual(dbFolder.serverUrl + "/" + dbFolder.fileName, remoteFolder.remotePath)
XCTAssertEqual(dbFolder.account, Self.account.ncKitAccount)
XCTAssertEqual(dbFolder.user, Self.account.username)
XCTAssertEqual(dbFolder.userId, Self.account.id)
XCTAssertEqual(dbFolder.urlBase, Self.account.serverUrl)
let storedFolderItemMaybe = await Item.storedItem(
identifier: .init(remoteFolder.identifier),
account: Self.account,
remoteInterface: remoteInterface,
dbManager: Self.dbManager,
log: FileProviderLogMock()
)
let storedFolderItem = try XCTUnwrap(storedFolderItemMaybe)
XCTAssertEqual(storedFolderItem.itemIdentifier.rawValue, remoteFolder.identifier)
XCTAssertEqual(storedFolderItem.filename, remoteFolder.name)
XCTAssertEqual(storedFolderItem.parentItemIdentifier.rawValue, rootItem.identifier)
XCTAssertEqual(storedFolderItem.creationDate, remoteFolder.creationDate)
XCTAssertEqual(
Int(storedFolderItem.contentModificationDate?.timeIntervalSince1970 ?? 0),
Int(remoteFolder.modificationDate.timeIntervalSince1970)
)
XCTAssertEqual(storedFolderItem.childItemCount?.intValue, 0) // Not visited yet, so no kids
}
func testWorkingSetEnumeration() async throws {
// This test verifies that the working set enumerator correctly returns ONLY the
// items that are "materialised" (downloaded files or visited directories) from the database
let db = Self.dbManager.ncDatabase() // Init DB
debugPrint(db)
// Item 1: A downloaded file (should be in working set)
var downloadedFile = remoteItemA.toItemMetadata(account: Self.account)
downloadedFile.downloaded = true
Self.dbManager.addItemMetadata(downloadedFile)
// Item 2: A visited directory (should be in working set)
var visitedDir = remoteFolder.toItemMetadata(account: Self.account)
visitedDir.visitedDirectory = true
Self.dbManager.addItemMetadata(visitedDir)
// Item 3: A file that is in the DB but not downloaded (should NOT be in working set)
var notDownloadedFile = remoteItemB.toItemMetadata(account: Self.account)
notDownloadedFile.downloaded = false
Self.dbManager.addItemMetadata(notDownloadedFile)
// Item 4: A directory that is in the DB but not visited (should NOT be in working set)
var notVisitedDir = remoteItemC.toItemMetadata(account: Self.account)
notVisitedDir.directory = true
notVisitedDir.visitedDirectory = false
Self.dbManager.addItemMetadata(notVisitedDir)
let enumerator = try Enumerator(
enumeratedItemIdentifier: .workingSet,
account: Self.account,
remoteInterface: MockRemoteInterface(account: Self.account),
dbManager: Self.dbManager,
log: FileProviderLogMock()
)
let observer = MockEnumerationObserver(enumerator: enumerator)
// 2. Act
try await observer.enumerateItems()
// 3. Assert
XCTAssertNil(observer.error, "Enumeration should complete without error.")
XCTAssertEqual(observer.items.count, 2, "Should only enumerate the 2 materialized items.")
let enumeratedIds = Set(observer.items.map(\.itemIdentifier.rawValue))
XCTAssertTrue(
enumeratedIds.contains(downloadedFile.ocId),
"The downloaded file should be in the working set."
)
XCTAssertTrue(
enumeratedIds.contains(visitedDir.ocId),
"The visited directory should be in the working set."
)
XCTAssertFalse(
enumeratedIds.contains(notDownloadedFile.ocId),
"The non-downloaded file should NOT be in the working set."
)
XCTAssertFalse(
enumeratedIds.contains(notVisitedDir.ocId),
"The non-visited directory should NOT be in the working set."
)
}
func testWorkingSetEnumerationWhenNoMaterialisedItems() async throws {
// This test verifies that the enumerator behaves correctly when there are
// no materialized items in the database.
// 1. Arrange
let db = Self.dbManager.ncDatabase()
debugPrint(db)
// Add items to the DB, but none are materialised.
var notDownloadedFile = remoteItemA.toItemMetadata(account: Self.account)
notDownloadedFile.downloaded = false
Self.dbManager.addItemMetadata(notDownloadedFile)
var notVisitedDir = remoteFolder.toItemMetadata(account: Self.account)
notVisitedDir.visitedDirectory = false
Self.dbManager.addItemMetadata(notVisitedDir)
let enumerator = try Enumerator(
enumeratedItemIdentifier: .workingSet,
account: Self.account,
remoteInterface: MockRemoteInterface(account: Self.account),
dbManager: Self.dbManager,
log: FileProviderLogMock()
)
let observer = MockEnumerationObserver(enumerator: enumerator)
// 2. Act
try await observer.enumerateItems()
// 3. Assert
XCTAssertNil(observer.error, "Enumeration should complete without error.")
XCTAssertTrue(observer.items.isEmpty, "Result should be empty when no items materialised.")
}
func testReadServerUrlFollowUpPagination() async throws {
// 1. Arrange: Setup a folder with enough children to require multiple pages.
remoteFolder.children = []
for i in 0 ..< 10 {
let childItem = MockRemoteItem(
identifier: "folderChild\(i)",
name: "folderChild\(i).txt",
remotePath: Self.account.davFilesUrl + "/folder/folderChild\(i).txt",
account: Self.account.ncKitAccount,
username: Self.account.username,
userId: Self.account.id,
serverUrl: Self.account.serverUrl
)
childItem.parent = remoteFolder
remoteFolder.children.append(childItem)
}
let db = Self.dbManager.ncDatabase()
debugPrint(db)
let remoteInterface = MockRemoteInterface(account: Self.account, rootItem: rootItem, pagination: true)
// Pre-populate the folder's metadata with an old etag to verify it gets updated
// on the initial call.
let oldEtag = "OLD_ETAG"
var folderMetadata = remoteFolder.toItemMetadata(account: Self.account)
folderMetadata.etag = oldEtag
Self.dbManager.addItemMetadata(folderMetadata)
// --- Scenario A: Initial Paginated Request (isFollowUpPaginatedRequest == false) ---
// 2. Act: Call readServerUrl for the first page.
let (initialMetadatas, _, _, _, initialNextPage, initialError) = await Enumerator.readServerUrl(
remoteFolder.remotePath,
pageSettings: (page: nil, index: 0, size: 5), // index is 0
account: Self.account,
remoteInterface: remoteInterface,
dbManager: Self.dbManager,
log: FileProviderLogMock()
)
// 3. Assert: Verify the initial request's behavior.
XCTAssertNil(initialError)
XCTAssertNotNil(initialNextPage, "Should receive a next page token for the initial request")
// The first request for a folder returns the folder itself plus the first page of children.
XCTAssertEqual(
initialMetadatas?.count,
4,
"""
Should get target + first page of children,
but the target should not be included in the first page,
so count is (4).
"""
)
XCTAssertFalse(initialMetadatas?.contains(where: { $0.ocId == remoteFolder.identifier }) ?? false, "The folder itself should not be in the initial results.")
// The logic inside `if !isFollowUpPaginatedRequest` should have run,
// updating the folder's metadata.
let updatedFolderMetadata = try XCTUnwrap(Self.dbManager.itemMetadata(ocId: remoteFolder.identifier))
XCTAssertNotEqual(updatedFolderMetadata.etag, oldEtag, "The folder's etag should have been updated.")
XCTAssertEqual(updatedFolderMetadata.etag, remoteFolder.versionIdentifier)
// --- Scenario B: Follow-up Paginated Request (isFollowUpPaginatedRequest == true) ---
// 4. Act: Call readServerUrl for the second page using the received page token.
let followUpPage = try NSFileProviderPage(XCTUnwrap(initialNextPage?.token?.data(using: .utf8)))
let (followUpMetadatas, _, _, _, finalNextPage, followUpError) = await Enumerator.readServerUrl(
remoteFolder.remotePath,
pageSettings: (page: followUpPage, index: 1, size: 5), // index > 0 and page is non-nil
account: Self.account,
remoteInterface: remoteInterface,
dbManager: Self.dbManager,
log: FileProviderLogMock()
)
// 5. Assert: Verify the follow-up request's behavior.
XCTAssertNil(followUpError)
XCTAssertNotNil(finalNextPage, "Should receive a next page token for the second request.")
// A follow-up request should *only* contain the children for that page.
XCTAssertEqual(
followUpMetadatas?.count, 5, "Should get only the second page of children (5)."
)
XCTAssertFalse(
followUpMetadatas?.contains(where: { $0.ocId == remoteFolder.identifier }) ?? true,
"The folder itself should NOT be in the follow-up page results."
)
// This confirms the `if !isFollowUpPaginatedRequest` block was correctly skipped, as it'd
// have processed the first item of the result array (`folderChild5`) as the parent folder,
// which would lead to incorrect data or errors.
let child5Metadata = Self.dbManager.itemMetadata(ocId: "folderChild5")
XCTAssertNotNil(
child5Metadata, "Metadata for the items on the second page should be in the database."
)
}
func testHandlePagedReadResults() {
// 1. Arrange
let dbManager = Self.dbManager
let db = dbManager.ncDatabase()
debugPrint(db)
let parentNKFile = remoteFolder.toNKFile()
let childrenNKFiles = (0 ..< 5).map { i in
MockRemoteItem(
identifier: "pagedChild\(i)",
name: "pagedChild\(i).txt",
remotePath: Self.account.davFilesUrl + "/folder/pagedChild\(i).txt",
account: Self.account.ncKitAccount,
username: Self.account.username,
userId: Self.account.id,
serverUrl: Self.account.serverUrl
).toNKFile()
}
let followUpChildrenNKFiles = (5 ..< 10).map { i in
MockRemoteItem(
identifier: "pagedChild\(i)",
name: "pagedChild\(i).txt",
remotePath: Self.account.davFilesUrl + "/folder/pagedChild\(i).txt",
account: Self.account.ncKitAccount,
username: Self.account.username,
userId: Self.account.id,
serverUrl: Self.account.serverUrl
).toNKFile()
}
// --- Scenario A: First Page (pageIndex == 0) ---
// 2. Act
let firstPageFiles = [parentNKFile] + childrenNKFiles
let (firstPageResult, firstPageError) = Enumerator.handlePagedReadResults(
files: firstPageFiles, pageIndex: 0, dbManager: dbManager
)
// 3. Assert
XCTAssertNil(firstPageError)
// Result should only contain the children, not the parent.
XCTAssertEqual(
firstPageResult?.count, 5, "First page result should only contain children."
)
// The parent's metadata should be processed and saved to the DB.
let parentMetadataFromDB = dbManager.itemMetadata(ocId: parentNKFile.ocId)
XCTAssertNotNil(
parentMetadataFromDB, "Parent folder metadata should be saved to DB from first page."
)
XCTAssertEqual(parentMetadataFromDB?.etag, parentNKFile.etag, "Parent etag should match.")
// The children's metadata should also be saved.
let childMetadataFromDB = dbManager.itemMetadata(ocId: "pagedChild0")
XCTAssertNotNil(
childMetadataFromDB, "Child metadata should be saved to DB from first page."
)
// --- Scenario B: Follow-up Page (pageIndex > 0) ---
// 4. Act
let (followUpPageResult, followUpPageError) = Enumerator.handlePagedReadResults(
files: followUpChildrenNKFiles, pageIndex: 1, dbManager: dbManager
)
// 5. Assert
XCTAssertNil(followUpPageError)
// Result should contain all items passed in, as the parent is not included.
XCTAssertEqual(
followUpPageResult?.count, 5, "Follow-up page result should contain all its items."
)
let followUpChildMetadata = dbManager.itemMetadata(ocId: "pagedChild5")
XCTAssertNotNil(
followUpChildMetadata, "Child metadata should be saved to DB from follow-up page."
)
// --- Scenario C: Root Folder (should not be ingested) ---
// 6. Act
var rootNKFile = MockRemoteItem.rootItem(account: Self.account).toNKFile()
// The check is based on URL string matching.
rootNKFile.path = Self.account.davFilesUrl
let (rootResult, rootError) = Enumerator.handlePagedReadResults(
files: [rootNKFile], pageIndex: 0, dbManager: dbManager
)
// 7. Assert
XCTAssertNil(rootError)
// The result should be empty as there are no children.
XCTAssertEqual(
rootResult?.count, 0, "Root folder enumeration should yield no children."
)
// Metadata should be saved for the root folder ID itself.
XCTAssertNotNil(
dbManager.itemMetadata(ocId: rootNKFile.ocId),
"Metadata for the root folder itself should be saved."
)
}
///
/// Children persisted by a page-0 paginated read must keep their existing
/// ``keepDownloaded`` flag. Before the fix for #9923 the bulk write at the
/// end of ``Enumerator.handlePagedReadResults`` used ``addItemMetadata``
/// which replaces the entire row, silently clearing flags set by a prior
/// "Always keep downloaded" enable.
///
/// The metadatas returned to the enumeration observer must also reflect
/// the preserved state: the framework builds `Item.contentPolicy` from
/// `metadata.keepDownloaded` on whatever metadata we hand it, so reporting
/// the pre-merge fresh-from-server metadata would leave the OS view of
/// pinned descendants stuck on `.inherited` even though the database row
/// is correct. (Symptom observed in #9923 for `/Documents/Documenter`.)
///
func testHandlePagedReadResultsPreservesKeepDownloadedOnPageZeroChildren() {
let dbManager = Self.dbManager
debugPrint(dbManager.ncDatabase())
// Seed two of the upcoming page-0 children as already pinned. The
// third stays unseeded so we can also assert the flag does not leak
// onto items that never had it.
let pinnedChildren = ["pagedChild0", "pagedChild2"]
for ocId in pinnedChildren {
var seeded = SendableItemMetadata(ocId: ocId, fileName: "\(ocId).txt", account: Self.account)
seeded.keepDownloaded = true
dbManager.addItemMetadata(seeded)
}
let parentNKFile = remoteFolder.toNKFile()
let childrenNKFiles = (0 ..< 3).map { i in
MockRemoteItem(
identifier: "pagedChild\(i)",
name: "pagedChild\(i).txt",
remotePath: Self.account.davFilesUrl + "/folder/pagedChild\(i).txt",
account: Self.account.ncKitAccount,
username: Self.account.username,
userId: Self.account.id,
serverUrl: Self.account.serverUrl
).toNKFile()
}
let (returnedMetadatas, error) = Enumerator.handlePagedReadResults(
files: [parentNKFile] + childrenNKFiles, pageIndex: 0, dbManager: dbManager
)
XCTAssertNil(error)
for ocId in pinnedChildren {
let stored = dbManager.itemMetadata(ocId: ocId)
XCTAssertEqual(
stored?.keepDownloaded, true,
"Page-0 child \(ocId) must retain keepDownloaded across the paginated write (#9923)."
)
let returned = returnedMetadatas?.first(where: { $0.ocId == ocId })
XCTAssertEqual(
returned?.keepDownloaded, true,
"Page-0 child \(ocId) reported back to the enumeration observer must also reflect the preserved keepDownloaded — the framework builds contentPolicy from this value."
)
}
XCTAssertEqual(
dbManager.itemMetadata(ocId: "pagedChild1")?.keepDownloaded, false,
"Children that were never pinned must not gain the flag from the paginated write."
)
}
///
/// Same protection on follow-up pages: a paginated read with `pageIndex > 0`
/// must not clobber ``keepDownloaded`` on any of its items. This is the
/// path most likely to land on already-pinned descendants because the
/// recursive enable of "Always keep downloaded" runs without pagination
/// while the OS-driven enumeration that follows uses pagination.
///
func testHandlePagedReadResultsPreservesKeepDownloadedOnFollowUpPage() {
let dbManager = Self.dbManager
debugPrint(dbManager.ncDatabase())
var seeded = SendableItemMetadata(ocId: "pagedChild5", fileName: "pagedChild5.txt", account: Self.account)
seeded.keepDownloaded = true
dbManager.addItemMetadata(seeded)
let followUpChildrenNKFiles = (5 ..< 8).map { i in
MockRemoteItem(
identifier: "pagedChild\(i)",
name: "pagedChild\(i).txt",
remotePath: Self.account.davFilesUrl + "/folder/pagedChild\(i).txt",
account: Self.account.ncKitAccount,
username: Self.account.username,
userId: Self.account.id,
serverUrl: Self.account.serverUrl
).toNKFile()
}
let (returnedMetadatas, error) = Enumerator.handlePagedReadResults(
files: followUpChildrenNKFiles, pageIndex: 1, dbManager: dbManager
)
XCTAssertNil(error)
XCTAssertEqual(
dbManager.itemMetadata(ocId: "pagedChild5")?.keepDownloaded, true,
"Follow-up page child must retain keepDownloaded across the paginated write (#9923)."
)
XCTAssertEqual(
returnedMetadatas?.first(where: { $0.ocId == "pagedChild5" })?.keepDownloaded, true,
"Follow-up page child reported back to the enumeration observer must also reflect the preserved keepDownloaded."
)
}
///
/// The page-0 target directory must continue to be marked as visited
/// after the preservation refactor — the original inline path applied
/// `visitedDirectory = true` unconditionally, and that behaviour must
/// survive even when a previous DB row carries `visitedDirectory = false`.
/// Previously-set ``keepDownloaded`` on the directory must also survive.
///
func testHandlePagedReadResultsTargetDirectoryRecordsVisitAndKeepsKeepDownloaded() {
let dbManager = Self.dbManager
debugPrint(dbManager.ncDatabase())
var seeded = remoteFolder.toItemMetadata(account: Self.account)
seeded.keepDownloaded = true
seeded.visitedDirectory = false
dbManager.addItemMetadata(seeded)
let parentNKFile = remoteFolder.toNKFile()
let (_, error) = Enumerator.handlePagedReadResults(
files: [parentNKFile], pageIndex: 0, dbManager: dbManager
)
XCTAssertNil(error)
let stored = dbManager.itemMetadata(ocId: parentNKFile.ocId)
XCTAssertEqual(
stored?.visitedDirectory, true,
"Page-0 target directory must be flagged as visited by the current request."
)
XCTAssertEqual(
stored?.keepDownloaded, true,
"Page-0 target directory must retain its existing keepDownloaded flag."
)
}
func testWorkingSetEnumerateChanges() async throws {
// This test verifies that `enumerateChanges` for the working set correctly
// queries the local database for changes since the provided sync anchor date.
let db = Self.dbManager.ncDatabase()
debugPrint(db)
let anchorDate = Date().addingTimeInterval(-300) // 5 minutes ago
let tenMinutesAgo = Date().addingTimeInterval(-600)
let now = Date()
// Create a sync anchor from our date.
let formatter = ISO8601DateFormatter()
let anchor = try NSFileProviderSyncAnchor(XCTUnwrap(formatter.string(from: anchorDate).data(using: .utf8)))
// Setup remote interface with the items we're testing
let remoteInterface = MockRemoteInterface(account: Self.account, rootItem: rootItem)
// --- Database State ---
var rootMetadata = rootItem.toItemMetadata(account: Self.account)
rootMetadata.syncTime = now
Self.dbManager.addItemMetadata(rootMetadata)
var folderMetadata = remoteFolder.toItemMetadata(account: Self.account)
folderMetadata.syncTime = now
Self.dbManager.addItemMetadata(folderMetadata)
// Item synced BEFORE the anchor date (should not be reported).
var oldItem = remoteItemA.toItemMetadata(account: Self.account)
oldItem.downloaded = true // Materialised
oldItem.syncTime = tenMinutesAgo
Self.dbManager.addItemMetadata(oldItem)
// Item synced AFTER the anchor date (should be reported as updated).
var updatedItem = remoteItemB.toItemMetadata(account: Self.account)
updatedItem.downloaded = true // Materialised
updatedItem.deleted = false
updatedItem.syncTime = now
Self.dbManager.addItemMetadata(updatedItem)
// Item marked as deleted AFTER the anchor date (should be reported as deleted).
var deletedItem = remoteItemC.toItemMetadata(account: Self.account)
deletedItem.downloaded = true // Materialised
deletedItem.deleted = true
deletedItem.syncTime = now
Self.dbManager.addItemMetadata(deletedItem)
// Non-materialised item synced after anchor date (should be ignored).
var nonMaterialisedItem = MockRemoteItem(
identifier: "non-mat",
name: "non-mat.txt",
remotePath: Self.account.davFilesUrl + "/non-mat.txt",
account: Self.account.ncKitAccount,
username: Self.account.username,
userId: Self.account.id,
serverUrl: Self.account.serverUrl
).toItemMetadata(account: Self.account)
nonMaterialisedItem.downloaded = false
nonMaterialisedItem.syncTime = now
Self.dbManager.addItemMetadata(nonMaterialisedItem)
let enumerator = try Enumerator(
enumeratedItemIdentifier: .workingSet,
account: Self.account,
remoteInterface: remoteInterface,
dbManager: Self.dbManager,
log: FileProviderLogMock()
)
let observer = MockChangeObserver(enumerator: enumerator)
// 2. Act
try await observer.enumerateChanges(from: anchor)
// 3. Assert
XCTAssertNil(observer.error, "Enumeration should complete without error.")
// Check for updated items
XCTAssertEqual(observer.changedItems.count, 2, "One item changed and the other did not but still its metadata was updated in the database.")
let firstChangedItem = observer.changedItems[0]
let secondChangedItem = observer.changedItems[1]
XCTAssertEqual(firstChangedItem.itemIdentifier.rawValue, oldItem.ocId, "The item unchanged on the server should be reported as updated locally nonetheless.")
XCTAssertEqual(secondChangedItem.itemIdentifier.rawValue, updatedItem.ocId, "The item which actually changed on the server should be reported as updated.")
// Check for deleted items
XCTAssertEqual(observer.deletedItemIdentifiers.count, 1, "There should be one deleted item.")
XCTAssertEqual(observer.deletedItemIdentifiers.first?.rawValue, deletedItem.ocId, "The correct item should be reported as deleted.")
}
///
/// Avoid enumeration of child directories and their content when their parent directory's ETag has not changed.
///
/// When checking the working set for changes, the file provider extension requests the latest state of every locally materialized directory from the server.
/// Based on this the file provider extension can report changed items to the file provider framework.
/// Because an unchanged directory ETag indicates the lack of changes in any of its descendants (no matter how far down the hierarchy) on the server, unnecessary requests for the server-side state of its descendants can be avoided.
/// This test implements the verification of this expected optimization.
///
func testChildDirectoriesOfAnUnchangedServerDirectoryShouldNotBeEnumerated() async throws {
// 1. Setup: Create a directory hierarchy with a parent and child directory
let db = Self.dbManager.ncDatabase()
debugPrint(db)
// Create a child directory within remoteFolder
let remoteChildFolder = MockRemoteItem(
identifier: "childFolder",
versionIdentifier: "CHILD_V1",
name: "childFolder",
remotePath: Self.account.davFilesUrl + "/folder/childFolder",
directory: true,
account: Self.account.ncKitAccount,
username: Self.account.username,
userId: Self.account.id,
serverUrl: Self.account.serverUrl
)
remoteChildFolder.parent = remoteFolder
remoteFolder.children.append(remoteChildFolder)
let remoteInterface = MockRemoteInterface(account: Self.account, rootItem: rootItem)
// Add parent folder to database with a specific ETag and mark as visited
var parentFolderMetadata = remoteFolder.toItemMetadata(account: Self.account)
parentFolderMetadata.visitedDirectory = true
parentFolderMetadata.etag = remoteFolder.versionIdentifier // Current ETag matches server
Self.dbManager.addItemMetadata(parentFolderMetadata)
// Add child folder to database and mark as visited (materialized)
var childFolderMetadata = remoteChildFolder.toItemMetadata(account: Self.account)
childFolderMetadata.visitedDirectory = true
childFolderMetadata.etag = remoteChildFolder.versionIdentifier
Self.dbManager.addItemMetadata(childFolderMetadata)
// Create a sync anchor from before now
let anchorDate = Date().addingTimeInterval(-300) // 5 minutes ago
let formatter = ISO8601DateFormatter()
let anchor = try NSFileProviderSyncAnchor(XCTUnwrap(formatter.string(from: anchorDate).data(using: .utf8)))
// Update sync times to be after the anchor (so they would be checked)
let now = Date()
parentFolderMetadata.syncTime = now
childFolderMetadata.syncTime = now
Self.dbManager.addItemMetadata(parentFolderMetadata)
Self.dbManager.addItemMetadata(childFolderMetadata)
// 2. Act: Enumerate changes for the working set
let enumerator = try Enumerator(
enumeratedItemIdentifier: .workingSet,
account: Self.account,
remoteInterface: remoteInterface,
dbManager: Self.dbManager,
log: FileProviderLogMock()
)
let observer = MockChangeObserver(enumerator: enumerator)
// Track how many times the remote interface is queried for each directory
let initialReadCount = remoteInterface.readOperationCount
try await observer.enumerateChanges(from: anchor)
// 3. Assert: Verify optimization behavior
XCTAssertNil(observer.error, "Enumeration should complete without error.")
// Since the parent folder's ETag hasn't changed, the child folder should NOT
// trigger a separate server request. The enumerator should recognize that
// an unchanged parent ETag means no descendants have changed.
// The parent folder should be checked (1 read), but the child should not
// trigger an additional read since parent ETag is unchanged
let finalReadCount = remoteInterface.readOperationCount
let additionalReads = finalReadCount - initialReadCount
// We expect reads for materialized directories, but child should be skipped
// because parent ETag is unchanged
XCTAssertLessThanOrEqual(
additionalReads,
1,
"Child directory should not be enumerated when parent ETag is unchanged"
)
// Verify that no changes were reported for either folder since nothing changed
XCTAssertEqual(
observer.changedItems.count,
4,
"When checking the remote folder for changes on the server but there are none, still all 4 items in the local client database should be updated."
)
XCTAssertEqual(
observer.deletedItemIdentifiers.count,
0,
"No items should be reported as deleted"
)
// Verify the metadata in the database remains correct
let finalParentMetadata = try XCTUnwrap(
Self.dbManager.itemMetadata(ocId: remoteFolder.identifier)
)
XCTAssertEqual(
finalParentMetadata.etag,
remoteFolder.versionIdentifier,
"Parent folder ETag should remain unchanged"
)
let finalChildMetadata = try XCTUnwrap(
Self.dbManager.itemMetadata(ocId: remoteChildFolder.identifier)
)
XCTAssertEqual(
finalChildMetadata.etag,
remoteChildFolder.versionIdentifier,
"Child folder ETag should remain unchanged"
)
}
func testFolderEnumeration() async throws {
let db = Self.dbManager.ncDatabase() // Strong ref for in memory test db
debugPrint(db)
let remoteInterface = MockRemoteInterface(account: Self.account, rootItem: rootItem)
let oldEtag = "OLD"
var folderMetadata = remoteFolder.toItemMetadata(account: Self.account)
folderMetadata.etag = oldEtag
Self.dbManager.addItemMetadata(folderMetadata)
XCTAssertNotNil(Self.dbManager.itemMetadata(ocId: remoteFolder.identifier))
let enumerator = try Enumerator(
enumeratedItemIdentifier: .init(remoteFolder.identifier),
account: Self.account,
remoteInterface: remoteInterface,
dbManager: Self.dbManager,
log: FileProviderLogMock()
)
let observer = MockEnumerationObserver(enumerator: enumerator)
try await observer.enumerateItems()
XCTAssertEqual(observer.items.count, 3)
// A pass of enumerating a target should update the target too. Let's check.
let dbFolderMetadata = try XCTUnwrap(
Self.dbManager.itemMetadata(ocId: remoteFolder.identifier)
)
let storedFolderItemMaybe = await Item.storedItem(
identifier: .init(remoteFolder.identifier),
account: Self.account,
remoteInterface: remoteInterface,
dbManager: Self.dbManager,
log: FileProviderLogMock()
)
let storedFolderItem = try XCTUnwrap(storedFolderItemMaybe)
XCTAssertEqual(dbFolderMetadata.etag, remoteFolder.versionIdentifier)
XCTAssertNotEqual(dbFolderMetadata.etag, oldEtag)
XCTAssertEqual(storedFolderItem.childItemCount?.intValue, remoteFolder.children.count)
XCTAssertEqual(storedFolderItem.isUploaded, true)
let retrievedItemA = try XCTUnwrap(
observer.items.first(where: { $0.itemIdentifier.rawValue == remoteItemA.identifier })
)
XCTAssertEqual(retrievedItemA.itemIdentifier.rawValue, remoteItemA.identifier)
XCTAssertEqual(retrievedItemA.filename, remoteItemA.name)
XCTAssertEqual(retrievedItemA.parentItemIdentifier.rawValue, remoteFolder.identifier)
XCTAssertEqual(retrievedItemA.creationDate, remoteItemA.creationDate)
XCTAssertEqual(
Int(retrievedItemA.contentModificationDate??.timeIntervalSince1970 ?? 0),
Int(remoteItemA.modificationDate.timeIntervalSince1970)
)
XCTAssertEqual(retrievedItemA.isDownloaded, false)
XCTAssertEqual(retrievedItemA.isUploaded, true)
}
func testEnumerateFile() async throws {
let db = Self.dbManager.ncDatabase() // Strong ref for in memory test db
debugPrint(db)
let remoteInterface = MockRemoteInterface(account: Self.account, rootItem: rootItem)
let folderMetadata = remoteFolder.toItemMetadata(account: Self.account)
var itemAMetadata = remoteItemA.toItemMetadata(account: Self.account)
itemAMetadata.downloaded = true
Self.dbManager.addItemMetadata(folderMetadata)
Self.dbManager.addItemMetadata(itemAMetadata)
XCTAssertNotNil(Self.dbManager.itemMetadata(ocId: remoteFolder.identifier))
XCTAssertNotNil(Self.dbManager.itemMetadata(ocId: remoteItemA.identifier))
let enumerator = try Enumerator(
enumeratedItemIdentifier: .init(remoteItemA.identifier),
account: Self.account,
remoteInterface: remoteInterface,
dbManager: Self.dbManager,
log: FileProviderLogMock()
)
let observer = MockEnumerationObserver(enumerator: enumerator)
try await observer.enumerateItems()
XCTAssertEqual(observer.items.count, 1)
let retrievedItemAItem = try XCTUnwrap(observer.items.first)
XCTAssertEqual(retrievedItemAItem.itemIdentifier.rawValue, remoteItemA.identifier)
XCTAssertEqual(retrievedItemAItem.filename, remoteItemA.name)
XCTAssertEqual(retrievedItemAItem.parentItemIdentifier.rawValue, remoteFolder.identifier)
XCTAssertEqual(retrievedItemAItem.creationDate, remoteItemA.creationDate)
XCTAssertEqual(
Int(retrievedItemAItem.contentModificationDate??.timeIntervalSince1970 ?? 0),
Int(remoteItemA.modificationDate.timeIntervalSince1970)
)
XCTAssertEqual(retrievedItemAItem.isDownloaded, true)
XCTAssertEqual(retrievedItemAItem.isUploaded, true)
let dbItemAMetadata = try XCTUnwrap(
Self.dbManager.itemMetadata(ocId: remoteItemA.identifier)
)
XCTAssertEqual(dbItemAMetadata.ocId, remoteItemA.identifier)
XCTAssertEqual(dbItemAMetadata.etag, remoteItemA.versionIdentifier)
XCTAssertTrue(dbItemAMetadata.downloaded)
// Check download state is not just always true
Self.dbManager.addItemMetadata(remoteItemB.toItemMetadata(account: Self.account))
XCTAssertNotNil(Self.dbManager.itemMetadata(ocId: remoteItemB.identifier))
let enumerator2 = try Enumerator(
enumeratedItemIdentifier: .init(remoteItemB.identifier),
account: Self.account,
remoteInterface: remoteInterface,
dbManager: Self.dbManager,
log: FileProviderLogMock()
)
let observer2 = MockEnumerationObserver(enumerator: enumerator2)
try await observer2.enumerateItems()
XCTAssertEqual(observer2.items.count, 1)
let dbItemBMetadata = try XCTUnwrap(
Self.dbManager.itemMetadata(ocId: remoteItemB.identifier)
)
XCTAssertEqual(dbItemBMetadata.ocId, remoteItemB.identifier)
XCTAssertEqual(dbItemBMetadata.etag, remoteItemB.versionIdentifier)
XCTAssertFalse(dbItemBMetadata.downloaded)
}
func testFolderAndContentsChangeEnumeration() async throws {
let db = Self.dbManager.ncDatabase() // Strong ref for in memory test db
debugPrint(db)
let remoteInterface = MockRemoteInterface(account: Self.account, rootItem: rootItem)
remoteFolder.children.removeAll(where: { $0.identifier == remoteItemB.identifier })
remoteFolder.children.append(remoteItemC)
remoteItemC.parent = remoteFolder
let oldFolderEtag = "OLD"
var folderMetadata = remoteFolder.toItemMetadata(account: Self.account)
folderMetadata.etag = oldFolderEtag
folderMetadata.downloaded = true // Test downloaded state is properly retained
let oldItemAEtag = "OLD"
var itemAMetadata = remoteItemA.toItemMetadata(account: Self.account)
itemAMetadata.etag = oldItemAEtag
itemAMetadata.downloaded = true // Test downloaded state is properly retained
let itemBMetadata = remoteItemB.toItemMetadata(account: Self.account)
Self.dbManager.addItemMetadata(folderMetadata)
Self.dbManager.addItemMetadata(itemAMetadata)
Self.dbManager.addItemMetadata(itemBMetadata)
XCTAssertNotNil(Self.dbManager.itemMetadata(ocId: remoteFolder.identifier))
XCTAssertNotNil(Self.dbManager.itemMetadata(ocId: remoteItemA.identifier))
XCTAssertNotNil(Self.dbManager.itemMetadata(ocId: remoteItemB.identifier))
let enumerator = try Enumerator(
enumeratedItemIdentifier: .init(remoteFolder.identifier),
account: Self.account,
remoteInterface: remoteInterface,
dbManager: Self.dbManager,
log: FileProviderLogMock()
)
let observer = MockChangeObserver(enumerator: enumerator)
try await observer.enumerateChanges()
// There are four changes: changed folder, changed Item A, removed Item B, added Item C
XCTAssertEqual(observer.changedItems.count, 3)
XCTAssertTrue(observer.changedItems.contains(
where: { $0.itemIdentifier.rawValue == remoteItemA.identifier }
))
XCTAssertTrue(observer.changedItems.contains(
where: { $0.itemIdentifier.rawValue == remoteItemC.identifier }
))
XCTAssertEqual(observer.deletedItemIdentifiers.count, 1)
XCTAssertTrue(observer.deletedItemIdentifiers.contains(
where: { $0.rawValue == remoteItemB.identifier }
))
// A pass of enumerating a target should update the target too. Let's check.
let dbFolderMetadata = try XCTUnwrap(
Self.dbManager.itemMetadata(ocId: remoteFolder.identifier)