Create AccountInfo interface

kloenk · kloenk · commit ecae6b9d830d · 2022-04-16T18:23:58.000+02:00
diff --git a/Package.resolved b/Package.resolved
diff --git a/Package.swift b/Package.swift
@@ -5,6 +5,10 @@ import PackageDescription
 
 let package = Package(
     name: "MatrixSQLiteStore",
+    platforms: [
+        .iOS(.v15), .tvOS(.v15),
+        .watchOS(.v8), .macOS(.v12)
+    ],
     products: [
         // Products define the executables and libraries a package produces, and make them visible to other packages.
         .library(
@@ -14,13 +18,17 @@ let package = Package(
     dependencies: [
         // Dependencies declare other packages that this package depends on.
         // .package(url: /* package url */, from: "1.0.0"),
+        .package(name: "MatrixCore", path: "/Users/kloenk/Developer/Xcode/MatrixCore"),
+        .package(url: "https://github.com/groue/GRDB.swift.git", from: "5.23.0")
     ],
     targets: [
-        // Targets are the basic building blocks of a package. A target can define a module or a test suite.
-        // Targets can depend on other targets in this package, and on products in packages this package depends on.
         .target(
             name: "MatrixSQLiteStore",
-            dependencies: []),
+            dependencies: [
+                .product(name: "MatrixCore", package: "MatrixCore"),
+                .product(name: "MatrixClient", package: "MatrixCore"),
+                .product(name: "GRDB", package: "GRDB.swift")
+            ]),
         .testTarget(
             name: "MatrixSQLiteStoreTests",
             dependencies: ["MatrixSQLiteStore"]),
diff --git a/Sources/MatrixSQLiteStore/AccountInfo.swift b/Sources/MatrixSQLiteStore/AccountInfo.swift
@@ -0,0 +1,34 @@
+//
+//  File.swift
+//
+//
+//  Created by Finn Behrens on 16.04.22.
+//
+
+import Foundation
+import GRDB
+import MatrixClient
+import MatrixCore
+
+public struct MatrixSQLAccountInfo: MatrixStoreAccountInfo {
+    public var name: String
+
+    public var displayName: String?
+
+    public var mxID: MatrixUserIdentifier
+
+    public var homeServer: MatrixHomeserver
+
+    public var accessToken: String?
+}
+
+extension MatrixSQLAccountInfo: Codable, FetchableRecord, PersistableRecord {
+    public static var databaseTableName: String = "account"
+
+    enum CodingKeys: String, CodingKey {
+        case name
+        case displayName
+        case mxID = "id"
+        case homeServer = "homeserver"
+    }
+}
diff --git a/Sources/MatrixSQLiteStore/MatrixSQLiteStore.swift b/Sources/MatrixSQLiteStore/MatrixSQLiteStore.swift
@@ -1,6 +1,78 @@
+
+import Foundation
+import GRDB
+import MatrixClient
+import MatrixCore
+
 public struct MatrixSQLiteStore {
-    public private(set) var text = "Hello, World!"
+    var dbWriter: DatabaseWriter
+
+    public init(_ dbWriter: DatabaseWriter) throws {
+        self.dbWriter = dbWriter
+        try migrator.migrate(dbWriter)
+    }
+
+    // TODO: lazy instead of computed?
+    private var migrator: DatabaseMigrator {
+        var migrator = DatabaseMigrator()
+
+        #if DEBUG
+            // Speed up development by nuking the database when migrations change
+            // See https://github.com/groue/GRDB.swift/blob/master/Documentation/Migrations.md#the-erasedatabaseonschemachange-option
+            migrator.eraseDatabaseOnSchemaChange = true
+        #endif
+
+        migrator.registerMigration("createAccount") { db in
+            try db.create(table: "account") { t in
+                t.column("id", .text).notNull().indexed().primaryKey().unique()
+                t.column("name", .text).notNull()
+                t.column("displayName", .text)
+                t.column("homeserver", .text).notNull()
+            }
+        }
+
+        return migrator
+    }
+}
+
+extension MatrixSQLiteStore: MatrixStore {
+    public func saveAccountInfo(account: MatrixSQLAccountInfo) async throws {
+        try await dbWriter.write { [account] db in
+            try account.save(db)
+            try account.saveToKeychain()
+        }
+    }
+
+    public func getAccountInfo(accountID: MatrixUserIdentifier) async throws -> MatrixSQLAccountInfo {
+        let account = try await dbWriter.read { db in
+            try MatrixSQLAccountInfo.fetchOne(db, key: accountID.FQMXID!)
+        }
+
+        guard var account = account else {
+            throw SQLError.missingData
+        }
+
+        account.accessToken = try MatrixSQLAccountInfo.getFromKeychain(account: accountID)
+
+        return account
+    }
+
+    public func getAccountInfos() async throws -> [MatrixSQLAccountInfo] {
+        let accounts = try await dbWriter.read { db in
+            try MatrixSQLAccountInfo.fetchAll(db)
+        }
+
+        return try accounts.map { account in
+            var account = account
+            account.accessToken = try MatrixSQLAccountInfo.getFromKeychain(account: account.mxID)
+            return account
+        }
+    }
+}
 
-    public init() {
+public extension MatrixSQLiteStore {
+    enum SQLError: Error {
+        case invalidType
+        case missingData
     }
 }
diff --git a/Tests/MatrixSQLiteStoreTests/MatrixAccountInfoTests.swift b/Tests/MatrixSQLiteStoreTests/MatrixAccountInfoTests.swift
@@ -0,0 +1,65 @@
+//
+//  File.swift
+//
+//
+//  Created by Finn Behrens on 16.04.22.
+//
+
+import GRDB
+import MatrixClient
+@testable import MatrixSQLiteStore
+import XCTest
+
+class AccountInfoTests: XCTestCase {
+    func testGet() async throws {
+        let dbQueue = DatabaseQueue()
+        let store = try MatrixSQLiteStore(dbQueue)
+
+        let id = MatrixUserIdentifier(rawValue: "@test:example.com")!
+        let data = MatrixSQLAccountInfo(name: "test", mxID: id, homeServer: MatrixHomeserver(string: "https://example.com")!, accessToken: "secret")
+
+        defer {
+            try! data.deleteFromKeychain()
+        }
+
+        try await store.saveAccountInfo(account: data)
+
+        let account = try await store.getAccountInfo(accountID: id)
+
+        XCTAssertEqual(account.accessToken, data.accessToken)
+    }
+
+    func testGetAll() async throws {
+        let dbQueue = DatabaseQueue()
+
+        let store = try MatrixSQLiteStore(dbQueue)
+        let homeserver = MatrixHomeserver(string: "https://example.com")!
+
+        let id1 = MatrixUserIdentifier(locapart: "test1", domain: "example.com")
+        let data1 = MatrixSQLAccountInfo(name: "test1", mxID: id1, homeServer: homeserver, accessToken: "secret2")
+
+        let id2 = MatrixUserIdentifier(locapart: "test2", domain: "example.com")
+        let data2 = MatrixSQLAccountInfo(name: "test2", mxID: id2, homeServer: homeserver, accessToken: "secret2")
+
+        defer {
+            try! data1.deleteFromKeychain()
+            try! data2.deleteFromKeychain()
+        }
+
+        try await store.saveAccountInfo(account: data1)
+        try await store.saveAccountInfo(account: data2)
+
+        let accounts = try await store.getAccountInfos()
+
+        XCTAssertEqual(accounts.count, 2)
+
+        XCTAssertEqual(accounts[0].name, data1.name)
+        XCTAssertEqual(accounts[1].name, data2.name)
+
+        XCTAssertEqual(accounts[0].accessToken, data1.accessToken)
+        XCTAssertEqual(accounts[1].accessToken, data2.accessToken)
+
+        XCTAssertEqual(accounts[0].mxID, data1.mxID)
+        XCTAssertEqual(accounts[1].mxID, data2.mxID)
+    }
+}
diff --git a/Tests/MatrixSQLiteStoreTests/MatrixSQLiteStoreTests.swift b/Tests/MatrixSQLiteStoreTests/MatrixSQLiteStoreTests.swift
@@ -1,11 +1,4 @@
-import XCTest
 @testable import MatrixSQLiteStore
+import XCTest
 
-final class MatrixSQLiteStoreTests: XCTestCase {
-    func testExample() throws {
-        // This is an example of a functional test case.
-        // Use XCTAssert and related functions to verify your tests produce the correct
-        // results.
-        XCTAssertEqual(MatrixSQLiteStore().text, "Hello, World!")
-    }
-}
+final class MatrixSQLiteStoreTests: XCTestCase {}
