mirror of
https://github.com/Novaloop-AG/element-x-ios.git
synced 2026-11-03 16:10:20 +00:00
Make the SessionDirectories type responsible for cleaning up data. (#3261)
This commit is contained in:
Doug
GitHub
@@ -31,8 +31,7 @@ class KeychainControllerTests: XCTestCase {
|
||||
homeserverUrl: "homeserverUrl",
|
||||
oidcData: "oidcData",
|
||||
slidingSyncVersion: .proxy(url: "https://my.sync.proxy")),
|
||||
sessionDirectory: .homeDirectory.appending(component: UUID().uuidString),
|
||||
cacheDirectory: .homeDirectory.appending(component: UUID().uuidString),
|
||||
sessionDirectories: .init(),
|
||||
passphrase: "passphrase",
|
||||
pusherNotificationClientIdentifier: "pusherClientID")
|
||||
keychain.setRestorationToken(restorationToken, forUsername: username)
|
||||
@@ -51,8 +50,7 @@ class KeychainControllerTests: XCTestCase {
|
||||
homeserverUrl: "homeserverUrl",
|
||||
oidcData: "oidcData",
|
||||
slidingSyncVersion: .proxy(url: "https://my.sync.proxy")),
|
||||
sessionDirectory: .homeDirectory.appending(component: UUID().uuidString),
|
||||
cacheDirectory: .homeDirectory.appending(component: UUID().uuidString),
|
||||
sessionDirectories: .init(),
|
||||
passphrase: "passphrase",
|
||||
pusherNotificationClientIdentifier: "pusherClientID")
|
||||
keychain.setRestorationToken(restorationToken, forUsername: username)
|
||||
@@ -77,8 +75,7 @@ class KeychainControllerTests: XCTestCase {
|
||||
homeserverUrl: "homeserverUrl",
|
||||
oidcData: "oidcData",
|
||||
slidingSyncVersion: .proxy(url: "https://my.sync.proxy")),
|
||||
sessionDirectory: .homeDirectory.appending(component: UUID().uuidString),
|
||||
cacheDirectory: .homeDirectory.appending(component: UUID().uuidString),
|
||||
sessionDirectories: .init(),
|
||||
passphrase: "passphrase",
|
||||
pusherNotificationClientIdentifier: "pusherClientID")
|
||||
keychain.setRestorationToken(restorationToken, forUsername: "@test\(index):example.com")
|
||||
@@ -102,8 +99,7 @@ class KeychainControllerTests: XCTestCase {
|
||||
homeserverUrl: "homeserverUrl",
|
||||
oidcData: "oidcData",
|
||||
slidingSyncVersion: .proxy(url: "https://my.sync.proxy")),
|
||||
sessionDirectory: .homeDirectory.appending(component: UUID().uuidString),
|
||||
cacheDirectory: .homeDirectory.appending(component: UUID().uuidString),
|
||||
sessionDirectories: .init(),
|
||||
passphrase: "passphrase",
|
||||
pusherNotificationClientIdentifier: "pusherClientID")
|
||||
keychain.setRestorationToken(restorationToken, forUsername: "@test\(index):example.com")
|
||||
@@ -135,8 +131,7 @@ class KeychainControllerTests: XCTestCase {
|
||||
homeserverUrl: "homeserverUrl",
|
||||
oidcData: "oidcData",
|
||||
slidingSyncVersion: .native),
|
||||
sessionDirectory: .homeDirectory.appending(component: UUID().uuidString),
|
||||
cacheDirectory: .homeDirectory.appending(component: UUID().uuidString),
|
||||
sessionDirectories: .init(),
|
||||
passphrase: "passphrase",
|
||||
pusherNotificationClientIdentifier: "pusherClientID")
|
||||
keychain.setRestorationToken(restorationToken, forUsername: username)
|
||||
|
||||
@@ -29,9 +29,9 @@ class RestorationTokenTests: XCTestCase {
|
||||
XCTAssertEqual(decodedToken.session, originalToken.session, "The session should not be changed.")
|
||||
XCTAssertNil(decodedToken.passphrase, "There should not be a passphrase.")
|
||||
XCTAssertNil(decodedToken.pusherNotificationClientIdentifier, "There should not be a push notification client ID.")
|
||||
XCTAssertEqual(decodedToken.sessionDirectory, .sessionsBaseDirectory.appending(component: "@user_example.com"),
|
||||
XCTAssertEqual(decodedToken.sessionDirectories.dataDirectory, .sessionsBaseDirectory.appending(component: "@user_example.com"),
|
||||
"The session directory should match the original location set by the Rust SDK from our base directory.")
|
||||
XCTAssertEqual(decodedToken.cacheDirectory, .cachesBaseDirectory.appending(component: "@user_example.com"),
|
||||
XCTAssertEqual(decodedToken.sessionDirectories.cacheDirectory, .cachesBaseDirectory.appending(component: "@user_example.com"),
|
||||
"The cache directory should be derived from the session directory but in the caches directory.")
|
||||
}
|
||||
|
||||
@@ -58,14 +58,44 @@ class RestorationTokenTests: XCTestCase {
|
||||
XCTAssertEqual(decodedToken.passphrase, originalToken.passphrase, "The passphrase should not be changed.")
|
||||
XCTAssertEqual(decodedToken.pusherNotificationClientIdentifier, originalToken.pusherNotificationClientIdentifier,
|
||||
"The push notification client identifier should not be changed.")
|
||||
XCTAssertEqual(decodedToken.sessionDirectory, originalToken.sessionDirectory, "The session directory should not be changed.")
|
||||
XCTAssertEqual(decodedToken.cacheDirectory, .cachesBaseDirectory.appending(component: sessionDirectoryName),
|
||||
XCTAssertEqual(decodedToken.sessionDirectories.dataDirectory, originalToken.sessionDirectory,
|
||||
"The session directory should not be changed.")
|
||||
XCTAssertEqual(decodedToken.sessionDirectories.cacheDirectory, .cachesBaseDirectory.appending(component: sessionDirectoryName),
|
||||
"The cache directory should be derived from the session directory but in the caches directory.")
|
||||
}
|
||||
|
||||
func testDecodeFromTokenV5() throws {
|
||||
// Given an encoded restoration token in the 5th format that contains separate directories for session data and caches.
|
||||
let sessionDirectoryName = UUID().uuidString
|
||||
let originalToken = RestorationTokenV5(session: Session(accessToken: "1234",
|
||||
refreshToken: "5678",
|
||||
userId: "@user:example.com",
|
||||
deviceId: "D3V1C3",
|
||||
homeserverUrl: "https://matrix.example.com",
|
||||
oidcData: "data-from-mas",
|
||||
slidingSyncVersion: .native),
|
||||
sessionDirectory: .sessionsBaseDirectory.appending(component: sessionDirectoryName),
|
||||
cacheDirectory: .cachesBaseDirectory.appending(component: sessionDirectoryName),
|
||||
passphrase: "passphrase",
|
||||
pusherNotificationClientIdentifier: "pusher-identifier")
|
||||
let data = try JSONEncoder().encode(originalToken)
|
||||
|
||||
// When decoding the data.
|
||||
let decodedToken = try JSONDecoder().decode(RestorationToken.self, from: data)
|
||||
|
||||
// Then the output should be a valid token.
|
||||
XCTAssertEqual(decodedToken.session, originalToken.session, "The session should not be changed.")
|
||||
XCTAssertEqual(decodedToken.passphrase, originalToken.passphrase, "The passphrase should not be changed.")
|
||||
XCTAssertEqual(decodedToken.pusherNotificationClientIdentifier, originalToken.pusherNotificationClientIdentifier,
|
||||
"The push notification client identifier should not be changed.")
|
||||
XCTAssertEqual(decodedToken.sessionDirectories.dataDirectory, originalToken.sessionDirectory,
|
||||
"The session directory should not be changed.")
|
||||
XCTAssertEqual(decodedToken.sessionDirectories.cacheDirectory, originalToken.cacheDirectory,
|
||||
"The cache directory should not be changed.")
|
||||
}
|
||||
|
||||
func testDecodeFromCurrentToken() throws {
|
||||
// Given an encoded restoration token in the current format.
|
||||
let sessionDirectoryName = UUID().uuidString
|
||||
let originalToken = RestorationToken(session: Session(accessToken: "1234",
|
||||
refreshToken: "5678",
|
||||
userId: "@user:example.com",
|
||||
@@ -73,8 +103,7 @@ class RestorationTokenTests: XCTestCase {
|
||||
homeserverUrl: "https://matrix.example.com",
|
||||
oidcData: "data-from-mas",
|
||||
slidingSyncVersion: .native),
|
||||
sessionDirectory: .sessionsBaseDirectory.appending(component: sessionDirectoryName),
|
||||
cacheDirectory: .cachesBaseDirectory.appending(component: sessionDirectoryName),
|
||||
sessionDirectories: .init(),
|
||||
passphrase: "passphrase",
|
||||
pusherNotificationClientIdentifier: "pusher-identifier")
|
||||
let data = try JSONEncoder().encode(originalToken)
|
||||
@@ -97,3 +126,11 @@ struct RestorationTokenV4: Equatable, Codable {
|
||||
let passphrase: String?
|
||||
let pusherNotificationClientIdentifier: String?
|
||||
}
|
||||
|
||||
struct RestorationTokenV5: Equatable, Codable {
|
||||
let session: MatrixRustSDK.Session
|
||||
let sessionDirectory: URL
|
||||
let cacheDirectory: URL
|
||||
let passphrase: String?
|
||||
let pusherNotificationClientIdentifier: String?
|
||||
}
|
||||
|
||||
@@ -10,6 +10,8 @@ import XCTest
|
||||
@testable import ElementX
|
||||
|
||||
class SessionDirectoriesTests: XCTestCase {
|
||||
let fileManager = FileManager.default
|
||||
|
||||
func testInitWithUserID() {
|
||||
// Given only a user ID.
|
||||
let userID = "@user:matrix.org"
|
||||
@@ -51,4 +53,67 @@ class SessionDirectoriesTests: XCTestCase {
|
||||
XCTAssertEqual(returnedDataPath, originalDataPath)
|
||||
XCTAssertEqual(returnedCachePath, originalCachePath)
|
||||
}
|
||||
|
||||
func testDeleteDirectories() throws {
|
||||
// Given a new set of session directories.
|
||||
let sessionDirectories = SessionDirectories()
|
||||
try fileManager.createDirectory(at: sessionDirectories.dataDirectory, withIntermediateDirectories: true)
|
||||
try fileManager.createDirectory(at: sessionDirectories.cacheDirectory, withIntermediateDirectories: true)
|
||||
XCTAssertTrue(fileManager.directoryExists(at: sessionDirectories.dataDirectory))
|
||||
XCTAssertTrue(fileManager.directoryExists(at: sessionDirectories.cacheDirectory))
|
||||
|
||||
// When deleting the directories.
|
||||
sessionDirectories.delete()
|
||||
|
||||
// Then neither directory should exist on disk.
|
||||
XCTAssertFalse(fileManager.directoryExists(at: sessionDirectories.dataDirectory))
|
||||
XCTAssertFalse(fileManager.directoryExists(at: sessionDirectories.cacheDirectory))
|
||||
}
|
||||
|
||||
func testDeleteTransientUserData() throws {
|
||||
// Given a set of session directories with some databases.
|
||||
let sessionDirectories = SessionDirectories()
|
||||
try fileManager.createDirectory(at: sessionDirectories.dataDirectory, withIntermediateDirectories: true)
|
||||
try fileManager.createDirectory(at: sessionDirectories.cacheDirectory, withIntermediateDirectories: true)
|
||||
XCTAssertTrue(fileManager.directoryExists(at: sessionDirectories.dataDirectory))
|
||||
XCTAssertTrue(fileManager.directoryExists(at: sessionDirectories.cacheDirectory))
|
||||
|
||||
sessionDirectories.generateMockData()
|
||||
XCTAssertTrue(fileManager.fileExists(atPath: sessionDirectories.mockStateStorePath))
|
||||
XCTAssertTrue(fileManager.fileExists(atPath: sessionDirectories.mockCryptoStorePath))
|
||||
XCTAssertTrue(fileManager.fileExists(atPath: sessionDirectories.mockEventCachePath))
|
||||
XCTAssertEqual(try fileManager.numberOfItems(at: sessionDirectories.dataDirectory), 6)
|
||||
XCTAssertEqual(try fileManager.numberOfItems(at: sessionDirectories.cacheDirectory), 3)
|
||||
|
||||
// When deleting transient user data.
|
||||
sessionDirectories.deleteTransientUserData()
|
||||
|
||||
// Then the data directory should only contain the crypto store and the cache directory should remain but be empty.
|
||||
XCTAssertTrue(fileManager.directoryExists(at: sessionDirectories.dataDirectory))
|
||||
XCTAssertEqual(try fileManager.numberOfItems(at: sessionDirectories.dataDirectory), 3)
|
||||
XCTAssertFalse(fileManager.fileExists(atPath: sessionDirectories.mockStateStorePath))
|
||||
XCTAssertTrue(fileManager.fileExists(atPath: sessionDirectories.mockCryptoStorePath))
|
||||
|
||||
XCTAssertTrue(fileManager.directoryExists(at: sessionDirectories.cacheDirectory))
|
||||
XCTAssertEqual(try fileManager.numberOfItems(at: sessionDirectories.cacheDirectory), 0)
|
||||
XCTAssertFalse(fileManager.fileExists(atPath: sessionDirectories.mockEventCachePath))
|
||||
}
|
||||
}
|
||||
|
||||
private extension SessionDirectories {
|
||||
var mockStateStorePath: String { dataDirectory.appending(component: "matrix-sdk-state.sqlite3").path(percentEncoded: false) }
|
||||
var mockCryptoStorePath: String { dataDirectory.appending(component: "matrix-sdk-crypto.sqlite3").path(percentEncoded: false) }
|
||||
var mockEventCachePath: String { cacheDirectory.appending(component: "matrix-sdk-event-cache.sqlite3").path(percentEncoded: false) }
|
||||
|
||||
func generateMockData() {
|
||||
generateMockDatabase(atPath: mockStateStorePath)
|
||||
generateMockDatabase(atPath: mockCryptoStorePath)
|
||||
generateMockDatabase(atPath: mockEventCachePath)
|
||||
}
|
||||
|
||||
private func generateMockDatabase(atPath path: String) {
|
||||
FileManager.default.createFile(atPath: path, contents: nil)
|
||||
FileManager.default.createFile(atPath: path + "-shm", contents: nil)
|
||||
FileManager.default.createFile(atPath: path + "-wal", contents: nil)
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user