improve performance for client build

xmtp · Dec 18, 2024 · eb038f6 · eb038f6
1 parent 712d873
commit eb038f6
Show file tree

Hide file tree

Showing 2 changed files with 66 additions and 16 deletions.
diff --git a/Sources/XMTPiOS/Client.swift b/Sources/XMTPiOS/Client.swift
@@ -91,6 +91,7 @@ public final class Client {
 	public let dbPath: String
 	public let installationID: String
 	public let environment: XMTPEnvironment
+	public let apiClient: XmtpApiClient
 	private let ffiClient: LibXMTP.FfiXmtpClient
 
 	public lazy var conversations: Conversations = .init(
@@ -108,13 +109,15 @@ public final class Client {
 		accountAddress: String,
 		options: ClientOptions,
 		signingKey: SigningKey?,
-		inboxId: String
+		inboxId: String,
+		apiClient: XmtpApiClient? = nil
 	) async throws -> Client {
-		let (libxmtpClient, dbPath) = try await initFFiClient(
+		let (libxmtpClient, dbPath, apiClient) = try await initFFiClient(
 			accountAddress: accountAddress.lowercased(),
 			options: options,
 			signingKey: signingKey,
-			inboxId: inboxId
+			inboxId: inboxId,
+			apiClient: apiClient
 		)
 
 		let client = try Client(
@@ -123,7 +126,8 @@ public final class Client {
 			dbPath: dbPath,
 			installationID: libxmtpClient.installationId().toHex,
 			inboxID: libxmtpClient.inboxId(),
-			environment: options.api.env
+			environment: options.api.env,
+			apiClient: apiClient
 		)
 
 		// Register codecs
@@ -150,7 +154,8 @@ public final class Client {
 	}
 
 	public static func build(
-		address: String, options: ClientOptions, inboxId: String? = nil
+		address: String, options: ClientOptions, inboxId: String? = nil,
+		apiClient: XmtpApiClient? = nil
 	)
 		async throws -> Client
 	{
@@ -167,16 +172,18 @@ public final class Client {
 			accountAddress: accountAddress,
 			options: options,
 			signingKey: nil,
-			inboxId: resolvedInboxId
+			inboxId: resolvedInboxId,
+			apiClient: apiClient
 		)
 	}
 
 	private static func initFFiClient(
 		accountAddress: String,
 		options: ClientOptions,
 		signingKey: SigningKey?,
-		inboxId: String
-	) async throws -> (FfiXmtpClient, String) {
+		inboxId: String,
+		apiClient: XmtpApiClient? = nil
+	) async throws -> (FfiXmtpClient, String, XmtpApiClient) {
 		let address = accountAddress.lowercased()
 
 		let mlsDbDirectory = options.dbDirectory
@@ -203,10 +210,17 @@ public final class Client {
 		let alias = "xmtp-\(options.api.env.rawValue)-\(inboxId).db3"
 		let dbURL = directoryURL.appendingPathComponent(alias).path
 
-		let ffiClient = try await LibXMTP.createClient(
-			api: connectToBackend(
+		let xmtpApiClient: XmtpApiClient
+		if let existingApiClient = apiClient {
+			xmtpApiClient = existingApiClient
+		} else {
+			xmtpApiClient = try await connectToBackend(
 				host: options.api.env.url,
-				isSecure: options.api.env.isSecure == true),
+				isSecure: options.api.env.isSecure == true)
+		}
+
+		let ffiClient = try await LibXMTP.createClient(
+			api: xmtpApiClient,
 			db: dbURL,
 			encryptionKey: options.dbEncryptionKey,
 			inboxId: inboxId,
@@ -236,7 +250,7 @@ public final class Client {
 			}
 		}
 
-		return (ffiClient, dbURL)
+		return (ffiClient, dbURL, xmtpApiClient)
 	}
 
 	private static func handleSignature(
@@ -293,7 +307,7 @@ public final class Client {
 		let address = "0x0000000000000000000000000000000000000000"
 		let inboxId = try await getOrCreateInboxId(api: api, address: address)
 
-		var directoryURL: URL = URL.documentsDirectory
+		let directoryURL: URL = URL.documentsDirectory
 		let alias = "xmtp-\(api.env.rawValue)-\(inboxId).db3"
 		let dbURL = directoryURL.appendingPathComponent(alias).path
 
@@ -322,14 +336,16 @@ public final class Client {
 
 	init(
 		address: String, ffiClient: LibXMTP.FfiXmtpClient, dbPath: String,
-		installationID: String, inboxID: String, environment: XMTPEnvironment
+		installationID: String, inboxID: String, environment: XMTPEnvironment,
+		apiClient: XmtpApiClient
 	) throws {
 		self.address = address
 		self.ffiClient = ffiClient
 		self.dbPath = dbPath
 		self.installationID = installationID
 		self.inboxID = inboxID
 		self.environment = environment
+		self.apiClient = apiClient
 	}
 
 	public func addAccount(newAccount: SigningKey)
@@ -450,7 +466,8 @@ public final class Client {
 		}
 	}
 
-	public func findConversation(conversationId: String) async throws -> Conversation?
+	public func findConversation(conversationId: String) async throws
+		-> Conversation?
 	{
 		do {
 			let conversation = try ffiClient.conversation(
@@ -461,7 +478,9 @@ public final class Client {
 		}
 	}
 
-	public func findConversationByTopic(topic: String) async throws -> Conversation? {
+	public func findConversationByTopic(topic: String) async throws
+		-> Conversation?
+	{
 		do {
 			let regexPattern = #"/xmtp/mls/1/g-(.*?)/proto"#
 			if let regex = try? NSRegularExpression(pattern: regexPattern) {

diff --git a/Tests/XMTPTests/ClientTests.swift b/Tests/XMTPTests/ClientTests.swift
@@ -531,6 +531,21 @@ class ClientTests: XCTestCase {
 		let time3 = end3.timeIntervalSince(start3)
 		print("PERF: Built a client with inboxId in \(time3)s")
 
+		// Measure time to build a client with an inboxId and apiClient
+		let start4 = Date()
+		let buildClient3 = try await Client.build(
+			address: fakeWallet.address,
+			options: ClientOptions(
+				api: ClientOptions.Api(env: .dev, isSecure: true),
+				dbEncryptionKey: key
+			),
+			inboxId: client.inboxID,
+			apiClient: client.apiClient
+		)
+		let end4 = Date()
+		let time4 = end4.timeIntervalSince(start4)
+		print("PERF: Built a client with inboxId in \(time4)s")
+
 		// Assert performance comparisons
 		XCTAssertTrue(
 			time2 < time1,
@@ -543,6 +558,18 @@ class ClientTests: XCTestCase {
 			time3 < time2,
 			"Building a client with inboxId should be faster than building one without."
 		)
+		XCTAssertTrue(
+			time4 < time1,
+			"Building a client with apiClient should be faster than creating one."
+		)
+		XCTAssertTrue(
+			time4 < time2,
+			"Building a client with apiClient should be faster than building one."
+		)
+		XCTAssertTrue(
+			time4 < time2,
+			"Building a client with apiClient should be faster than building one with inboxId."
+		)
 
 		// Assert that inbox IDs match
 		XCTAssertEqual(
@@ -553,6 +580,10 @@ class ClientTests: XCTestCase {
 			client.inboxID, buildClient2.inboxID,
 			"Inbox ID of the created client and second built client should match."
 		)
+		XCTAssertEqual(
+			client.inboxID, buildClient3.inboxID,
+			"Inbox ID of the created client and second built client should match."
+		)
 	}
 
 }