mirror of
https://github.com/Novaloop-AG/element-x-ios.git
synced 2026-11-02 21:33:26 +00:00
Update the SDK (#3196)
* Update the SDK. * Fix API breaks on send failures and propagate the new type. * Handle new SDK ShieldState. * Set up the ClientBuilder's `cachePath` option. * Delete the cacheDirectory during logout/clearCache. * Add unit tests for RestorationToken decoding and SessionDirectories generation.
This commit is contained in:
Doug
GitHub
@@ -41,6 +41,7 @@ class KeychainControllerTests: XCTestCase {
|
||||
oidcData: "oidcData",
|
||||
slidingSyncProxy: "https://my.sync.proxy"),
|
||||
sessionDirectory: .homeDirectory.appending(component: UUID().uuidString),
|
||||
cacheDirectory: .homeDirectory.appending(component: UUID().uuidString),
|
||||
passphrase: "passphrase",
|
||||
pusherNotificationClientIdentifier: "pusherClientID")
|
||||
keychain.setRestorationToken(restorationToken, forUsername: username)
|
||||
@@ -60,6 +61,7 @@ class KeychainControllerTests: XCTestCase {
|
||||
oidcData: "oidcData",
|
||||
slidingSyncProxy: "https://my.sync.proxy"),
|
||||
sessionDirectory: .homeDirectory.appending(component: UUID().uuidString),
|
||||
cacheDirectory: .homeDirectory.appending(component: UUID().uuidString),
|
||||
passphrase: "passphrase",
|
||||
pusherNotificationClientIdentifier: "pusherClientID")
|
||||
keychain.setRestorationToken(restorationToken, forUsername: username)
|
||||
@@ -85,6 +87,7 @@ class KeychainControllerTests: XCTestCase {
|
||||
oidcData: "oidcData",
|
||||
slidingSyncProxy: "https://my.sync.proxy"),
|
||||
sessionDirectory: .homeDirectory.appending(component: UUID().uuidString),
|
||||
cacheDirectory: .homeDirectory.appending(component: UUID().uuidString),
|
||||
passphrase: "passphrase",
|
||||
pusherNotificationClientIdentifier: "pusherClientID")
|
||||
keychain.setRestorationToken(restorationToken, forUsername: "@test\(index):example.com")
|
||||
@@ -109,6 +112,7 @@ class KeychainControllerTests: XCTestCase {
|
||||
oidcData: "oidcData",
|
||||
slidingSyncProxy: "https://my.sync.proxy"),
|
||||
sessionDirectory: .homeDirectory.appending(component: UUID().uuidString),
|
||||
cacheDirectory: .homeDirectory.appending(component: UUID().uuidString),
|
||||
passphrase: "passphrase",
|
||||
pusherNotificationClientIdentifier: "pusherClientID")
|
||||
keychain.setRestorationToken(restorationToken, forUsername: "@test\(index):example.com")
|
||||
@@ -141,6 +145,7 @@ class KeychainControllerTests: XCTestCase {
|
||||
oidcData: "oidcData",
|
||||
slidingSyncProxy: nil),
|
||||
sessionDirectory: .homeDirectory.appending(component: UUID().uuidString),
|
||||
cacheDirectory: .homeDirectory.appending(component: UUID().uuidString),
|
||||
passphrase: "passphrase",
|
||||
pusherNotificationClientIdentifier: "pusherClientID")
|
||||
keychain.setRestorationToken(restorationToken, forUsername: username)
|
||||
|
||||
@@ -0,0 +1,108 @@
|
||||
//
|
||||
// Copyright 2024 New Vector Ltd
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
//
|
||||
|
||||
import XCTest
|
||||
|
||||
@testable import ElementX
|
||||
import MatrixRustSDK
|
||||
|
||||
class RestorationTokenTests: XCTestCase {
|
||||
func testDecodeFromTokenV1() throws {
|
||||
// Given an encoded restoration token in the original format that only contains a Session from the SDK.
|
||||
let originalToken = RestorationTokenV1(session: Session(accessToken: "1234",
|
||||
refreshToken: nil,
|
||||
userId: "@user:example.com",
|
||||
deviceId: "D3V1C3",
|
||||
homeserverUrl: "https://matrix.example.com",
|
||||
oidcData: nil,
|
||||
slidingSyncProxy: "https://sync.example.com"))
|
||||
let data = try JSONEncoder().encode(originalToken)
|
||||
|
||||
// When decoding the data to the current restoration token format.
|
||||
let decodedToken = try JSONDecoder().decode(RestorationToken.self, from: data)
|
||||
|
||||
// Then the output should be a valid token with the expected store directories.
|
||||
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"),
|
||||
"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"),
|
||||
"The cache directory should be derived from the session directory but in the caches directory.")
|
||||
}
|
||||
|
||||
func testDecodeFromTokenV4() throws {
|
||||
// Given an encoded restoration token in the 4th format that contains a stored session directory.
|
||||
let sessionDirectoryName = UUID().uuidString
|
||||
let originalToken = RestorationTokenV4(session: Session(accessToken: "1234",
|
||||
refreshToken: "5678",
|
||||
userId: "@user:example.com",
|
||||
deviceId: "D3V1C3",
|
||||
homeserverUrl: "https://matrix.example.com",
|
||||
oidcData: "data-from-mas",
|
||||
slidingSyncProxy: "https://sync.example.com"),
|
||||
sessionDirectory: .sessionsBaseDirectory.appending(component: sessionDirectoryName),
|
||||
passphrase: "passphrase",
|
||||
pusherNotificationClientIdentifier: "pusher-identifier")
|
||||
let data = try JSONEncoder().encode(originalToken)
|
||||
|
||||
// When decoding the data to the current restoration token format.
|
||||
let decodedToken = try JSONDecoder().decode(RestorationToken.self, from: data)
|
||||
|
||||
// Then the output should be a valid token with the expected store directories.
|
||||
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.sessionDirectory, originalToken.sessionDirectory, "The session directory should not be changed.")
|
||||
XCTAssertEqual(decodedToken.cacheDirectory, .cachesBaseDirectory.appending(component: sessionDirectoryName),
|
||||
"The cache directory should be derived from the session directory but in the caches directory.")
|
||||
}
|
||||
|
||||
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",
|
||||
deviceId: "D3V1C3",
|
||||
homeserverUrl: "https://matrix.example.com",
|
||||
oidcData: "data-from-mas",
|
||||
slidingSyncProxy: nil),
|
||||
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, originalToken, "The token should remain identical.")
|
||||
}
|
||||
}
|
||||
|
||||
struct RestorationTokenV1: Equatable, Codable {
|
||||
let session: MatrixRustSDK.Session
|
||||
}
|
||||
|
||||
struct RestorationTokenV4: Equatable, Codable {
|
||||
let session: MatrixRustSDK.Session
|
||||
let sessionDirectory: URL
|
||||
let passphrase: String?
|
||||
let pusherNotificationClientIdentifier: String?
|
||||
}
|
||||
@@ -0,0 +1,63 @@
|
||||
//
|
||||
// Copyright 2024 New Vector Ltd
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
//
|
||||
|
||||
import XCTest
|
||||
|
||||
@testable import ElementX
|
||||
|
||||
class SessionDirectoriesTests: XCTestCase {
|
||||
func testInitWithUserID() {
|
||||
// Given only a user ID.
|
||||
let userID = "@user:matrix.org"
|
||||
|
||||
// When creating the session directories using this.
|
||||
let sessionDirectories = SessionDirectories(userID: userID)
|
||||
|
||||
// Then the directories should be generated in the correct location, using an escaped version of the user ID
|
||||
XCTAssertEqual(sessionDirectories.dataDirectory, .sessionsBaseDirectory.appending(component: "@user_matrix.org"))
|
||||
XCTAssertEqual(sessionDirectories.cacheDirectory, .cachesBaseDirectory.appending(component: "@user_matrix.org"))
|
||||
}
|
||||
|
||||
func testInitWithDataDirectory() {
|
||||
// Given only a session directory without a caches directory.
|
||||
let sessionDirectoryName = UUID().uuidString
|
||||
let sessionDirectory = URL.applicationSupportBaseDirectory.appending(component: sessionDirectoryName)
|
||||
|
||||
// When creating the session directories using this.
|
||||
let sessionDirectories = SessionDirectories(dataDirectory: sessionDirectory)
|
||||
|
||||
// Then the data directory should remain unchanged and the caches directory should be generated.
|
||||
XCTAssertEqual(sessionDirectories.dataDirectory, sessionDirectory)
|
||||
XCTAssertEqual(sessionDirectories.cacheDirectory, .cachesBaseDirectory.appending(component: sessionDirectoryName))
|
||||
}
|
||||
|
||||
func testPathOutput() {
|
||||
// Given session directories created from paths with spaces in them.
|
||||
let originalDataPath = "/Users/John Smith/Data"
|
||||
let originalCachePath = "/Users/John Smith/Caches"
|
||||
let dataDirectory = URL(filePath: originalDataPath)
|
||||
let cacheDirectory = URL(filePath: originalCachePath)
|
||||
let sessionDirectories = SessionDirectories(dataDirectory: dataDirectory, cacheDirectory: cacheDirectory)
|
||||
|
||||
// When getting the paths from the session directories struct.
|
||||
let returnedDataPath = sessionDirectories.dataPath
|
||||
let returnedCachePath = sessionDirectories.cachePath
|
||||
|
||||
// Then the paths should not be escaped.
|
||||
XCTAssertEqual(returnedDataPath, originalDataPath)
|
||||
XCTAssertEqual(returnedCachePath, originalCachePath)
|
||||
}
|
||||
}
|
||||
@@ -70,7 +70,7 @@ final class TextBasedRoomTimelineTests: XCTestCase {
|
||||
sender: .init(id: UUID().uuidString),
|
||||
content: .init(body: "Test"))
|
||||
timelineItem.properties.isEdited = true
|
||||
timelineItem.properties.deliveryStatus = .sendingFailed
|
||||
timelineItem.properties.deliveryStatus = .sendingFailed(.unknown)
|
||||
let editedCount = L10n.commonEditedSuffix.count
|
||||
XCTAssertEqual(timelineItem.additionalWhitespaces(), timestamp.count + editedCount + 5)
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user