Skip to content

Implement Multipeer Replicator Support in iOS (API 1.2.1) #194

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions servers/ios/TestServer.xcodeproj/project.pbxproj
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,14 @@
404619D22CB9A985003835C7 /* NewSessionHandler.swift in Sources */ = {isa = PBXBuildFile; fileRef = 404619D12CB9A985003835C7 /* NewSessionHandler.swift */; };
4055CAA02CDC33A400EDD0CB /* IPAddress.swift in Sources */ = {isa = PBXBuildFile; fileRef = 4055CA9F2CDC33A400EDD0CB /* IPAddress.swift */; };
409F45302DFA7BC900BB7851 /* FileDownloader.swift in Sources */ = {isa = PBXBuildFile; fileRef = 409F452F2DFA7BC900BB7851 /* FileDownloader.swift */; };
409F43F82DEA348500BB7851 /* StartMultipeerReplicatorRequest.swift in Sources */ = {isa = PBXBuildFile; fileRef = 409F43F72DEA348500BB7851 /* StartMultipeerReplicatorRequest.swift */; };
409F43FC2DEA373E00BB7851 /* StartMultipeerReplicator.swift in Sources */ = {isa = PBXBuildFile; fileRef = 409F43FB2DEA373E00BB7851 /* StartMultipeerReplicator.swift */; };
409F44002DEA561A00BB7851 /* MultipeerReplicatorConfiguration.swift in Sources */ = {isa = PBXBuildFile; fileRef = 409F43FF2DEA561A00BB7851 /* MultipeerReplicatorConfiguration.swift */; };
409F44022DEA823A00BB7851 /* StopMultipeerReplicator.swift in Sources */ = {isa = PBXBuildFile; fileRef = 409F44012DEA823A00BB7851 /* StopMultipeerReplicator.swift */; };
409F44172DEE187600BB7851 /* GetMultipeerReplicatorStatus.swift in Sources */ = {isa = PBXBuildFile; fileRef = 409F44162DEE187600BB7851 /* GetMultipeerReplicatorStatus.swift */; };
409F442C2DEE228300BB7851 /* MultipeerReplicatorStatus.swift in Sources */ = {isa = PBXBuildFile; fileRef = 409F442B2DEE228300BB7851 /* MultipeerReplicatorStatus.swift */; };
409F443D2DF0EB3800BB7851 /* MultipeerReplicatorCAAuthenticator.swift in Sources */ = {isa = PBXBuildFile; fileRef = 409F443C2DF0EB3800BB7851 /* MultipeerReplicatorCAAuthenticator.swift */; };
409F443F2DF1016C00BB7851 /* MultipeerReplicatorIdentity.swift in Sources */ = {isa = PBXBuildFile; fileRef = 409F443E2DF1016C00BB7851 /* MultipeerReplicatorIdentity.swift */; };
40AA34992CAF5D20004F4D08 /* StopReplicator.swift in Sources */ = {isa = PBXBuildFile; fileRef = 40AA34982CAF5D20004F4D08 /* StopReplicator.swift */; };
40AA349D2CAF6755004F4D08 /* CollectionSpec.swift in Sources */ = {isa = PBXBuildFile; fileRef = 40AA349C2CAF6755004F4D08 /* CollectionSpec.swift */; };
40AA34A12CAF6BE4004F4D08 /* ReplicationConflictResolver.swift in Sources */ = {isa = PBXBuildFile; fileRef = 40AA34A02CAF6BE4004F4D08 /* ReplicationConflictResolver.swift */; };
Expand Down Expand Up @@ -97,6 +105,14 @@
404619D12CB9A985003835C7 /* NewSessionHandler.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = NewSessionHandler.swift; sourceTree = "<group>"; };
4055CA9F2CDC33A400EDD0CB /* IPAddress.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = IPAddress.swift; sourceTree = "<group>"; };
409F452F2DFA7BC900BB7851 /* FileDownloader.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FileDownloader.swift; sourceTree = "<group>"; };
409F43F72DEA348500BB7851 /* StartMultipeerReplicatorRequest.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = StartMultipeerReplicatorRequest.swift; sourceTree = "<group>"; };
409F43FB2DEA373E00BB7851 /* StartMultipeerReplicator.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = StartMultipeerReplicator.swift; sourceTree = "<group>"; };
409F43FF2DEA561A00BB7851 /* MultipeerReplicatorConfiguration.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MultipeerReplicatorConfiguration.swift; sourceTree = "<group>"; };
409F44012DEA823A00BB7851 /* StopMultipeerReplicator.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = StopMultipeerReplicator.swift; sourceTree = "<group>"; };
409F44162DEE187600BB7851 /* GetMultipeerReplicatorStatus.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = GetMultipeerReplicatorStatus.swift; sourceTree = "<group>"; };
409F442B2DEE228300BB7851 /* MultipeerReplicatorStatus.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MultipeerReplicatorStatus.swift; sourceTree = "<group>"; };
409F443C2DF0EB3800BB7851 /* MultipeerReplicatorCAAuthenticator.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MultipeerReplicatorCAAuthenticator.swift; sourceTree = "<group>"; };
409F443E2DF1016C00BB7851 /* MultipeerReplicatorIdentity.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MultipeerReplicatorIdentity.swift; sourceTree = "<group>"; };
40A219D62CDC3E790038204C /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
40AA34982CAF5D20004F4D08 /* StopReplicator.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = StopReplicator.swift; sourceTree = "<group>"; };
40AA349C2CAF6755004F4D08 /* CollectionSpec.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CollectionSpec.swift; sourceTree = "<group>"; };
Expand Down Expand Up @@ -231,6 +247,7 @@
children = (
40BDA7F72AF1C13B008DB256 /* GetAllDocuments.swift */,
40AA34A42CAF94A4004F4D08 /* GetDocument.swift */,
409F44162DEE187600BB7851 /* GetMultipeerReplicatorStatus.swift */,
40BDA7F62AF1C13B008DB256 /* GetReplicatorStatus.swift */,
40BDA7F02AF1C13B008DB256 /* GetRootHandler.swift */,
40BDA7F32AF1C13B008DB256 /* Handler.swift */,
Expand All @@ -239,7 +256,9 @@
40BDA7EE2AF1C13B008DB256 /* ResetHandler.swift */,
40C7A5622CA4AF5C0053ADCB /* RunQuery.swift */,
40BDA7F42AF1C13B008DB256 /* SnapshotDocuments.swift */,
409F43FB2DEA373E00BB7851 /* StartMultipeerReplicator.swift */,
40BDA7EF2AF1C13B008DB256 /* StartReplicator.swift */,
409F44012DEA823A00BB7851 /* StopMultipeerReplicator.swift */,
40AA34982CAF5D20004F4D08 /* StopReplicator.swift */,
40BDA7F22AF1C13B008DB256 /* UpdateDatabase.swift */,
40BDA7F12AF1C13B008DB256 /* VerifyDocuments.swift */,
Expand Down Expand Up @@ -296,6 +315,10 @@
40BDA8D92AF20AAB008DB256 /* DocumentID.swift */,
40BDA8D22AF20AAB008DB256 /* DocumentReplication.swift */,
40AA34A62CAF9BC8004F4D08 /* GetDocumentRequest.swift */,
409F443C2DF0EB3800BB7851 /* MultipeerReplicatorCAAuthenticator.swift */,
409F43FF2DEA561A00BB7851 /* MultipeerReplicatorConfiguration.swift */,
409F443E2DF1016C00BB7851 /* MultipeerReplicatorIdentity.swift */,
409F442B2DEE228300BB7851 /* MultipeerReplicatorStatus.swift */,
404619CF2CB9A761003835C7 /* NewSession.swift */,
40BDA8D32AF20AAB008DB256 /* PerformMaintenanceConfiguration.swift */,
40C7A5662CA4B15B0053ADCB /* QueryResults.swift */,
Expand All @@ -311,6 +334,7 @@
40BDA8DC2AF20AAB008DB256 /* ServerInfo.swift */,
40BDA8CF2AF20AAB008DB256 /* SnapshotID.swift */,
40BDA8CC2AF20AAB008DB256 /* SnapshotRequest.swift */,
409F43F72DEA348500BB7851 /* StartMultipeerReplicatorRequest.swift */,
40BDA8CD2AF20AAB008DB256 /* StartReplicatorRequest.swift */,
40BDA8D72AF20AAB008DB256 /* TestServerError.swift */,
40BDA8DB2AF20AAB008DB256 /* UpdateRequest.swift */,
Expand Down Expand Up @@ -435,10 +459,14 @@
40BDA8132AF1C15C008DB256 /* ReplicationFilterFactory.swift in Sources */,
40BDA8EC2AF20AAB008DB256 /* VerifyRequest.swift in Sources */,
40BDA8062AF1C13B008DB256 /* TestServerMiddleware.swift in Sources */,
409F43F82DEA348500BB7851 /* StartMultipeerReplicatorRequest.swift in Sources */,
409F443D2DF0EB3800BB7851 /* MultipeerReplicatorCAAuthenticator.swift in Sources */,
40BDA8F22AF20AAB008DB256 /* ServerInfo.swift in Sources */,
40BDA8F42AF20AAB008DB256 /* DatabaseUpdateItem.swift in Sources */,
40BDA8002AF1C13B008DB256 /* Handler.swift in Sources */,
409F44022DEA823A00BB7851 /* StopMultipeerReplicator.swift in Sources */,
40BDA7FC2AF1C13B008DB256 /* StartReplicator.swift in Sources */,
409F44172DEE187600BB7851 /* GetMultipeerReplicatorStatus.swift in Sources */,
40BDA7FE2AF1C13B008DB256 /* VerifyDocuments.swift in Sources */,
40BDA7FD2AF1C13B008DB256 /* GetRootHandler.swift in Sources */,
40BDA7FB2AF1C13B008DB256 /* ResetHandler.swift in Sources */,
Expand All @@ -455,13 +483,15 @@
40AA34A12CAF6BE4004F4D08 /* ReplicationConflictResolver.swift in Sources */,
40BDA8E72AF20AAB008DB256 /* CollectionDocuments.swift in Sources */,
40C7A5672CA4B15B0053ADCB /* QueryResults.swift in Sources */,
409F44002DEA561A00BB7851 /* MultipeerReplicatorConfiguration.swift in Sources */,
EACC964D2AF3F8B500999C70 /* CBLVersion.swift in Sources */,
40AA34992CAF5D20004F4D08 /* StopReplicator.swift in Sources */,
404619D22CB9A985003835C7 /* NewSessionHandler.swift in Sources */,
40BDA8E92AF20AAB008DB256 /* PerformMaintenanceConfiguration.swift in Sources */,
40BDA8022AF1C13B008DB256 /* PerformMaintenance.swift in Sources */,
40BDA8032AF1C13B008DB256 /* GetReplicatorStatus.swift in Sources */,
40BDA8012AF1C13B008DB256 /* SnapshotDocuments.swift in Sources */,
409F443F2DF1016C00BB7851 /* MultipeerReplicatorIdentity.swift in Sources */,
40BDA8E42AF20AAB008DB256 /* ContentTypes.swift in Sources */,
40BDA8152AF1C15C008DB256 /* AnyCodable.swift in Sources */,
40AA34A32CAF8C4C004F4D08 /* ReplicationConflictResolverFactory.swift in Sources */,
Expand All @@ -477,8 +507,10 @@
409F45302DFA7BC900BB7851 /* FileDownloader.swift in Sources */,
40BDA8ED2AF20AAB008DB256 /* TestServerError.swift in Sources */,
40BDA8142AF1C15C008DB256 /* KeyPathParser.swift in Sources */,
409F43FC2DEA373E00BB7851 /* StartMultipeerReplicator.swift in Sources */,
40C7A5652CA4AFB40053ADCB /* RunQueryConfiguration.swift in Sources */,
40C7A5632CA4AF5C0053ADCB /* RunQuery.swift in Sources */,
409F442C2DEE228300BB7851 /* MultipeerReplicatorStatus.swift in Sources */,
4055CAA02CDC33A400EDD0CB /* IPAddress.swift in Sources */,
40BDA8EE2AF20AAB008DB256 /* ResetConfiguration.swift in Sources */,
40BDA8EB2AF20AAB008DB256 /* ReplicatorConfiguration.swift in Sources */,
Expand Down
15 changes: 15 additions & 0 deletions servers/ios/TestServer/ContentTypes/DocumentReplication.swift
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
//

import Vapor
import CouchbaseLiteSwift

//DocumentReplication:
// type: object
Expand Down Expand Up @@ -55,3 +56,17 @@ extension ContentTypes {
case accessRemoved = "accessRemoved"
}
}

extension ContentTypes.DocumentReplication {
init(doc: CouchbaseLiteSwift.ReplicatedDocument, isPush: Bool) {
var flags: [ContentTypes.DocumentReplicationFlags] = []
if doc.flags.contains(.accessRemoved) { flags.append(.accessRemoved) }
if doc.flags.contains(.deleted) { flags.append(.deleted) }

self.collection = "\(doc.scope).\(doc.collection)"
self.documentID = doc.id
self.isPush = isPush
self.flags = flags
self.error = doc.error.map(TestServerError.cblError)
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
//
// MultipeerReplicatorCAAuthenticator.swift
// TestServer
//
// Created by Pasin Suriyentrakorn on 6/4/25.
//

import Vapor

extension ContentTypes {
enum MultipeerReplicatorCAAuthenticatorType : String, Codable {
case CACERT = "CA-CERT"
}

struct MultipeerReplicatorCAAuthenticator : Content {
let type: MultipeerReplicatorCAAuthenticatorType
let certificate: String
}
}

Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
//
// MultipeerReplicatorConfiguration.swift
// TestServer
//
// Created by Pasin Suriyentrakorn on 5/30/25.
//

import Vapor

extension ContentTypes {
struct MultipeerReplicatorConfiguration : Content {
let peerGroupID: String
let database: String
let collections: [ReplicationCollection]
let identity: MultipeerReplicatorIdentity
let authenticator: MultipeerReplicatorCAAuthenticator?
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
//
// MultipeerReplicatorIdentity.swift
// TestServer
//
// Created by Pasin Suriyentrakorn on 6/4/25.
//

import Vapor

extension ContentTypes {
enum IdentityDataEncoding : String, Codable {
case PKCS12 = "PKCS12"
}

struct MultipeerReplicatorIdentity : Content {
let encoding: IdentityDataEncoding
let data: String
let password: String?
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
//
// MultipeerReplicatorStatus.swift
// TestServer
//
// Created by Pasin Suriyentrakorn on 6/2/25.
//

import Vapor

extension ContentTypes {
struct PeerReplicatorStatus : Content {
let peerID: String
let status: ReplicatorStatus
}

struct MultipeerReplicatorStatus : Content {
let replicators: [PeerReplicatorStatus]
}
}
32 changes: 32 additions & 0 deletions servers/ios/TestServer/ContentTypes/ReplicatorStatus.swift
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
//

import Vapor
import CouchbaseLiteSwift

extension ContentTypes {
enum ReplicatorActivity : String, Codable {
Expand All @@ -15,10 +16,12 @@ extension ContentTypes {
case IDLE = "IDLE"
case BUSY = "BUSY"
}

struct ReplicatorStatus : Content, CustomStringConvertible {
struct Progress : Codable {
let completed: Bool
}

let activity: ReplicatorActivity
let progress: Progress
let documents: [DocumentReplication]?
Expand All @@ -38,3 +41,32 @@ extension ContentTypes {
}
}
}

extension ContentTypes.ReplicatorActivity {
init(activityLevel: Replicator.ActivityLevel) {
switch activityLevel {
case .busy:
self = .BUSY
case .connecting:
self = .CONNECTING
case .idle:
self = .IDLE
case .offline:
self = .OFFLINE
case .stopped:
self = .STOPPED
@unknown default:
fatalError("Encountered unknown enum value from Replicator.status.activity")
}
}
}

extension ContentTypes.ReplicatorStatus {
init(status: Replicator.Status, docs: [ContentTypes.DocumentReplication]) {
self.activity = ContentTypes.ReplicatorActivity(activityLevel: status.activity)
self.progress = ContentTypes.ReplicatorStatus.Progress(
completed: status.progress.completed == status.progress.total)
self.documents = docs
self.error = status.error.map(TestServerError.cblError)
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
//
// StartMultipeerReplicatorRequest.swift
// TestServer
//
// Created by Pasin Suriyentrakorn on 5/30/25.
//

import Vapor

extension ContentTypes {
struct StartMultipeerReplicatorRequest : Content {
let peerGroupID: String
let database: String
let collections: [ReplicationCollection]
let identity: MultipeerReplicatorIdentity
let authenticator: MultipeerReplicatorCAAuthenticator?
}
}
6 changes: 6 additions & 0 deletions servers/ios/TestServer/ContentTypes/TestServerError.swift
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,14 @@ struct TestServerError : Error, Codable {
if let error = error as NSError? {
return TestServerError(domain: .TESTSERVER, code: error.code, message: error.localizedDescription)
}

return badRequest(error.localizedDescription)
}

static func cblError(_ error: Error) -> TestServerError {
let err = error as NSError
return TestServerError(domain: .CBL, code: err.code, message: err.localizedDescription)
}

static let cblDBNotOpen = TestServerError(domain: .CBL, code: CBLError.notOpen, message: "Database is not open.")
static let docNotFoundErr = TestServerError(domain: .TESTSERVER, code: 404, message: "Document not found")
Expand Down
21 changes: 21 additions & 0 deletions servers/ios/TestServer/Handlers/GetMultipeerReplicatorStatus.swift
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
//
// GetMultipeerReplicatorStatus.swift
// TestServer
//
// Created by Pasin Suriyentrakorn on 6/2/25.
//

import Foundation

extension Handlers {
static let getMultipperReplicatorStatus : EndpointHandler<ContentTypes.MultipeerReplicatorStatus> = { req throws in
guard let repl = try? req.content.decode(ContentTypes.Replicator.self) else {
throw TestServerError.badRequest("Request body does not match the 'Replicator' schema.") }

let dbManager = req.databaseManager
guard let status = dbManager.multipeerReplicatorStatus(forID: repl.id) else {
throw TestServerError.badRequest("MultipeerReplicator with ID '\(repl.id)' does not exist.")
}
return status
}
}
29 changes: 29 additions & 0 deletions servers/ios/TestServer/Handlers/StartMultipeerReplicator.swift
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
//
// StartMultipeerReplicator.swift
// TestServer
//
// Created by Pasin Suriyentrakorn on 5/30/25.
//

import Foundation

extension Handlers {
static let startMultipeerReplicator: EndpointHandler<ContentTypes.Replicator> = { req throws in
guard let request = try? req.content.decode(ContentTypes.StartMultipeerReplicatorRequest.self) else {
throw TestServerError.badRequest("Request body is not a valid startMultipeerReplicator Request.")
}

let dbManager = req.databaseManager

var config = ContentTypes.MultipeerReplicatorConfiguration(
peerGroupID: request.peerGroupID,
database: request.database,
collections: request.collections,
identity: request.identity,
authenticator: request.authenticator)

let id = try dbManager.startMultipeerReplicator(config: config)

return ContentTypes.Replicator(id: id)
}
}
20 changes: 20 additions & 0 deletions servers/ios/TestServer/Handlers/StopMultipeerReplicator.swift
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
//
// StopMultipeerReplicator.swift
// TestServer
//
// Created by Pasin Suriyentrakorn on 5/30/25.
//

import Vapor

extension Handlers {
static let stopMultipeerReplicator: EndpointHandlerEmptyResponse = { req throws in
guard let requestedReplicator = try? req.content.decode(ContentTypes.Replicator.self) else {
throw TestServerError.badRequest("Request body does not match the 'Replicator' schema.")
}

let dbManager = req.databaseManager
try dbManager.stopMultipeerReplicator(forID: requestedReplicator.id)
return Response(status: .ok)
}
}
5 changes: 4 additions & 1 deletion servers/ios/TestServer/Server/TestServer.swift
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ class TestServer : ObservableObject {
setupRoutes()
}

/// Implement API v1.0.0
/// Implement API v1.2.1 (No support for start/stop listener - 1.1.0, and dynamic dataset - 1.1.1 yet)
private func setupRoutes() {
app.get("", use: Handlers.getRoot)
app.post("newSession", use: Handlers.newSession)
Expand All @@ -66,7 +66,10 @@ class TestServer : ObservableObject {
app.post("verifyDocuments", use: Handlers.verifyDocuments)
app.post("startReplicator", use: Handlers.startReplicator)
app.post("getReplicatorStatus", use: Handlers.getReplicatorStatus)
app.post("startMultipeerReplicator", use: Handlers.startMultipeerReplicator)
app.post("stopMultipeerReplicator", use: Handlers.stopMultipeerReplicator)
app.post("performMaintenance", use: Handlers.performMaintenance)
app.post("getMultipeerReplicatorStatus", use: Handlers.getMultipperReplicatorStatus)
app.post("runQuery", use: Handlers.runQuery)

Log.log(level: .debug, message: "Server configured with the following routes: \n\(app.routes.description)")
Expand Down
Loading