Merge pull request #2240 from DataDog/ncreated/GH-2239/limit-clear-all-data-errors

GH-2239 chore: Refine errors printed from `clearAllData()`

Author: ncreated

DatadogCore/Sources/Core/DataStore/FeatureDataStore.swift

@@ -90,8 +90,8 @@ internal final class FeatureDataStore: DataStore {
     func clearAllData() {
         queue.async {
             do {
-                let directory = try self.coreDirectory.coreDirectory.subdirectory(path: self.directoryPath)
-                try directory.deleteAllFiles()
+                let directory = try self.coreDirectory.coreDirectory.subdirectoryIfExists(path: self.directoryPath)
+                try directory?.deleteAllFiles()
             } catch let error {
                 DD.logger.error("[Data Store] Error on clearing all data for `\(self.feature)`", error: error)
                 self.telemetry.error("[Data Store] Error on clearing all data for `\(self.feature)`", error: DDError(error: error))

DatadogCore/Sources/Core/Storage/Files/Directory.swift

@@ -107,6 +107,21 @@ internal struct Directory: DirectoryProtocol {
         }
     }
 
+    /// Returns directory at given path if it exists or `nil` otherwise. Throws if `path` exists but is not a directory.
+    func subdirectoryIfExists(path: String) throws -> Directory? {
+        let directoryURL = url.appendingPathComponent(path, isDirectory: true)
+        var isDirectory = ObjCBool(false)
+        let exists = FileManager.default.fileExists(atPath: directoryURL.path, isDirectory: &isDirectory)
+
+        guard exists else {
+            return nil
+        }
+        guard isDirectory.boolValue else {
+            throw InternalError(description: "Path is not a directory: \(directoryURL)")
+        }
+        return Directory(url: directoryURL)
+    }
+
     /// Creates file with given name.
     func createFile(named fileName: String) throws -> File {
         let fileURL = url.appendingPathComponent(fileName, isDirectory: false)

DatadogCore/Tests/Datadog/Core/Persistence/Files/DirectoryTests.swift

@@ -55,9 +55,11 @@ class DirectoryTests: XCTestCase {
 
         let uniqueName = uniqueSubdirectoryName()
         let expectedDirectory = try directory.createSubdirectory(path: uniqueName)
-        let actualDirectory = try directory.subdirectory(path: uniqueName)
+        let actualDirectory1 = try directory.subdirectory(path: uniqueName)
+        let actualDirectory2 = try directory.subdirectoryIfExists(path: uniqueName)
 
-        XCTAssertEqual(expectedDirectory.url, actualDirectory.url)
+        XCTAssertEqual(expectedDirectory.url, actualDirectory1.url)
+        XCTAssertEqual(expectedDirectory.url, actualDirectory2?.url)
     }
 
     func testItThrowsWhenAskedForSubdirectoryWhichDoesNotExist() throws {
@@ -75,6 +77,19 @@ class DirectoryTests: XCTestCase {
         }
     }
 
+    func testReturnsNilWhenAskedForSubdirectoryWhichDoesNotExist() throws {
+        let directory = Directory(url: temporaryDirectory)
+        CreateTemporaryDirectory()
+        defer { DeleteTemporaryDirectory() }
+
+        XCTAssertNil(try directory.subdirectoryIfExists(path: "abc"))
+
+        _ = try directory.createFile(named: "file-instead-of-directory")
+        XCTAssertThrowsError(try directory.subdirectory(path: "file-instead-of-directory")) { error in
+            XCTAssertTrue(error is InternalError, "It should throw as given path is a file, not directory")
+        }
+    }
+
     // MARK: - Files manipulation
 
     func testItCreatesFile() throws {