Skip to content
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.

Sign up for GitHub

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

[cc] Expose Swift APIs #3032

Draft
wants to merge 1 commit into
base: cbl-2993
Choose a base branch
from
+204 −3
Draft

[cc] Expose Swift APIs #3032

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
26 changes: 25 additions & 1 deletion CouchbaseLite.xcodeproj/project.pbxproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,12 @@
1A84E900268560E600C43AF9 /* IndexConfiguration.swift in Sources */ = {isa = PBXBuildFile; fileRef = 1A84E8F4268560E600C43AF9 /* IndexConfiguration.swift */; };
1A84E901268560E600C43AF9 /* IndexConfiguration.swift in Sources */ = {isa = PBXBuildFile; fileRef = 1A84E8F4268560E600C43AF9 /* IndexConfiguration.swift */; };
1A8DD7DA21C9876E00741C47 /* DateTimeQueryFunctionTest.swift in Sources */ = {isa = PBXBuildFile; fileRef = 1A8DD7D921C9876E00741C47 /* DateTimeQueryFunctionTest.swift */; };
1A8E2F9628FBD30B00E141A8 /* RemoteDatabase.swift in Sources */ = {isa = PBXBuildFile; fileRef = 1A8E2F9428FBD2F800E141A8 /* RemoteDatabase.swift */; };
1A8E2F9828FBD30F00E141A8 /* RemoteDatabase.swift in Sources */ = {isa = PBXBuildFile; fileRef = 1A8E2F9428FBD2F800E141A8 /* RemoteDatabase.swift */; };
1A8E2F9A28FBE65E00E141A8 /* RemoteDatabaseTest.swift in Sources */ = {isa = PBXBuildFile; fileRef = 1A8E2F9928FBDDD400E141A8 /* RemoteDatabaseTest.swift */; };
1A8E2F9B28FBE65E00E141A8 /* RemoteDatabaseTest.swift in Sources */ = {isa = PBXBuildFile; fileRef = 1A8E2F9928FBDDD400E141A8 /* RemoteDatabaseTest.swift */; };
1A8E2F9C28FBE66300E141A8 /* RemoteDatabaseTest.swift in Sources */ = {isa = PBXBuildFile; fileRef = 1A8E2F9928FBDDD400E141A8 /* RemoteDatabaseTest.swift */; };
1A8E2F9D28FBE66300E141A8 /* RemoteDatabaseTest.swift in Sources */ = {isa = PBXBuildFile; fileRef = 1A8E2F9928FBDDD400E141A8 /* RemoteDatabaseTest.swift */; };
1A93FAFC24F735250015D54D /* ReplicatorTest+PendingDocIds.m in Sources */ = {isa = PBXBuildFile; fileRef = 1ACDD8C223FF5BB200AF5D56 /* ReplicatorTest+PendingDocIds.m */; };
1A93FB0824F735260015D54D /* ReplicatorTest+PendingDocIds.m in Sources */ = {isa = PBXBuildFile; fileRef = 1ACDD8C223FF5BB200AF5D56 /* ReplicatorTest+PendingDocIds.m */; };
1A93FB0924F737320015D54D /* ReplicatorTest+PendingDocIds.swift in Sources */ = {isa = PBXBuildFile; fileRef = 1A690CC824214EE70084D017 /* ReplicatorTest+PendingDocIds.swift */; };
Expand Down Expand Up @@ -1927,6 +1933,8 @@
1A6F0941246C78FC0097D8B5 /* URLEndpointListenerTest.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = URLEndpointListenerTest.m; sourceTree = "<group>"; };
1A84E8F4268560E600C43AF9 /* IndexConfiguration.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = IndexConfiguration.swift; sourceTree = "<group>"; };
1A8DD7D921C9876E00741C47 /* DateTimeQueryFunctionTest.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DateTimeQueryFunctionTest.swift; sourceTree = "<group>"; };
1A8E2F9428FBD2F800E141A8 /* RemoteDatabase.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = RemoteDatabase.swift; sourceTree = "<group>"; };
1A8E2F9928FBDDD400E141A8 /* RemoteDatabaseTest.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = RemoteDatabaseTest.swift; sourceTree = "<group>"; };
1A93FAE124F0E6E60015D54D /* prepare_project.sh */ = {isa = PBXFileReference; lastKnownFileType = text.script.sh; name = prepare_project.sh; path = ../Scripts/prepare_project.sh; sourceTree = "<group>"; };
1A93FAE224F0E6E60015D54D /* generate_carthage_package.sh */ = {isa = PBXFileReference; lastKnownFileType = text.script.sh; name = generate_carthage_package.sh; path = ../Scripts/generate_carthage_package.sh; sourceTree = "<group>"; };
1A93FAE324F0E6E60015D54D /* generate_ee_release_zip.sh */ = {isa = PBXFileReference; lastKnownFileType = text.script.sh; name = generate_ee_release_zip.sh; path = ../Scripts/generate_ee_release_zip.sh; sourceTree = "<group>"; };
Expand Down Expand Up @@ -2655,6 +2663,14 @@
name = ConflictResolution;
sourceTree = "<group>";
};
1A8E2F8828FBD2E100E141A8 /* RemoteDatabase */ = {
isa = PBXGroup;
children = (
1A8E2F9428FBD2F800E141A8 /* RemoteDatabase.swift */,
);
name = RemoteDatabase;
sourceTree = "<group>";
};
1A93FAE024F0E6C50015D54D /* Scripts */ = {
isa = PBXGroup;
children = (
Expand Down Expand Up @@ -2757,6 +2773,7 @@
93EC43831FB53F6A00D54BB4 /* PredicateQueryTest.swift */,
93EB25A321CDCC160006FB88 /* PredictiveQueryTest.swift */,
93AE16E2221DC92E00539C05 /* PredictiveQueryTest+CoreML.swift */,
1A8E2F9928FBDDD400E141A8 /* RemoteDatabaseTest.swift */,
93DB80021ED8FE5100C4F845 /* ReplicatorTest.swift */,
1AA3D6B022A1A3490098E16B /* ReplicatorTest+CustomConflict.swift */,
1A690CC824214EE70084D017 /* ReplicatorTest+PendingDocIds.swift */,
Expand Down Expand Up @@ -2944,6 +2961,7 @@
9338BEE21ED5475200634873 /* Replication */ = {
isa = PBXGroup;
children = (
1A8E2F8828FBD2E100E141A8 /* RemoteDatabase */,
1A41601A227D084A0061A567 /* ConflictResolution */,
93CED8D020488C9500E6F0A4 /* Authenticator.swift */,
93248DE72005E72A00C15B00 /* Endpoint.swift */,
Expand Down Expand Up @@ -4964,7 +4982,7 @@
9398D9111E03434200464432 = {
CreatedOnToolsVersion = 8.1;
DevelopmentTeam = N2Q372V7W2;
LastSwiftMigration = 1250;
LastSwiftMigration = 1400;
ProvisioningStyle = Automatic;
};
9398D91A1E03434200464432 = {
Expand Down Expand Up @@ -5348,6 +5366,7 @@
937A693F1F1065610058277F /* CBLQueryMeta.m in Sources */,
9388CC4721C250D1005CA66D /* Log.swift in Sources */,
93248DE82005E72A00C15B00 /* Endpoint.swift in Sources */,
1A8E2F9628FBD30B00E141A8 /* RemoteDatabase.swift in Sources */,
9380D2641F0D7BD6007DD84A /* GroupBy.swift in Sources */,
27D7219C1F8E97F400AA4458 /* CBLFleece.mm in Sources */,
1A3F5556274345AA0088ECF1 /* Errors.swift in Sources */,
Expand Down Expand Up @@ -5520,6 +5539,7 @@
93DB80031ED8FE5100C4F845 /* ReplicatorTest.swift in Sources */,
1AA3D6C122A1A41E0098E16B /* ReplicatorTest+CustomConflict.swift in Sources */,
93E17F151ED4ED4000671CA1 /* NotificationTest.swift in Sources */,
1A8E2F9B28FBE65E00E141A8 /* RemoteDatabaseTest.swift in Sources */,
27BE3B4D1E4E51C80012B74A /* DatabaseTest.swift in Sources */,
934C2CDE1F4FC0D20010316F /* CBLTestHelper.m in Sources */,
9388CC5521C25CC7005CA66D /* LogTest.swift in Sources */,
Expand Down Expand Up @@ -5561,6 +5581,7 @@
buildActionMask = 2147483647;
files = (
93BB1CB4246BB2ED004FFA00 /* ReplicatorTest.swift in Sources */,
1A8E2F9C28FBE66300E141A8 /* RemoteDatabaseTest.swift in Sources */,
93BB1CB1246BB2E4004FFA00 /* PredictiveQueryTest.swift in Sources */,
93BB1CBA246BB2F4004FFA00 /* CustomLogger.swift in Sources */,
93BB1CA1246BB2CA004FFA00 /* DateTimeQueryFunctionTest.swift in Sources */,
Expand Down Expand Up @@ -5931,6 +5952,7 @@
9343F0A9207D61AB00F19A89 /* CBLFullTextIndex.m in Sources */,
9343F0AA207D61AB00F19A89 /* Document.swift in Sources */,
9343F0AB207D61AB00F19A89 /* SelectResult.swift in Sources */,
1A8E2F9828FBD30F00E141A8 /* RemoteDatabase.swift in Sources */,
932E913220A3F10F00FB8EF0 /* MessageEndpoint.swift in Sources */,
9343F0AC207D61AB00F19A89 /* CBLStringBytes.mm in Sources */,
9343F0AD207D61AB00F19A89 /* CBLCompoundExpression.m in Sources */,
Expand Down Expand Up @@ -6044,6 +6066,7 @@
buildActionMask = 2147483647;
files = (
93EB25A421CDCC160006FB88 /* PredictiveQueryTest.swift in Sources */,
1A8E2F9D28FBE66300E141A8 /* RemoteDatabaseTest.swift in Sources */,
9343F18E207D636300F19A89 /* DocumentTest.swift in Sources */,
93E8FEBD20A3E4600061347F /* MessageEndpointTest.swift in Sources */,
9343F18F207D636300F19A89 /* ArrayTest.swift in Sources */,
Expand Down Expand Up @@ -6272,6 +6295,7 @@
93BB1CB5246BB2F3004FFA00 /* ReplicatorTest+CustomConflict.swift in Sources */,
93BB1CA5246BB2D3004FFA00 /* FragmentTest.swift in Sources */,
93BB1CAE246BB2DC004FFA00 /* QueryTest.swift in Sources */,
1A8E2F9A28FBE65E00E141A8 /* RemoteDatabaseTest.swift in Sources */,
93BB1CAD246BB2DC004FFA00 /* NotificationTest.swift in Sources */,
93BB1CA6246BB2D3004FFA00 /* LogTest.swift in Sources */,
93BB1CB7246BB2F3004FFA00 /* CustomLogger.swift in Sources */,
Expand Down
1 change: 1 addition & 0 deletions Objective-C/CouchbaseLite.exp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@
.objc_class_name_CBLIndexConfiguration
.objc_class_name_CBLFullTextIndexConfiguration
.objc_class_name_CBLValueIndexConfiguration
.objc_class_name_CBLRemoteDatabase

# NSString constants:
_CBLErrorDomain
Expand Down
15 changes: 13 additions & 2 deletions Objective-C/Tests/RemoteDatabaseTest.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,19 @@
// RemoteDatabaseTest.h
// CouchbaseLite
//
// Created by Jayahari Vavachan on 4/12/22.
// Copyright © 2022 Couchbase. All rights reserved.
// Copyright (c) 2022 Couchbase, Inc All rights reserved.
//
// 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 "URLEndpointListenerTest.h"
Expand Down
1 change: 1 addition & 0 deletions Swift/CouchbaseLiteSwift-EE.modulemap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ framework module CouchbaseLiteSwift {
header "CBLIndexConfiguration.h"
header "CBLFullTextIndexConfiguration.h"
header "CBLValueIndexConfiguration.h"
header "CBLRemoteDatabase.h"

// Swift Extensions:
header "CBLArray+Swift.h"
Expand Down
1 change: 1 addition & 0 deletions Swift/CouchbaseLiteSwift.modulemap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ framework module CouchbaseLiteSwift {
header "CBLIndexConfiguration.h"
header "CBLFullTextIndexConfiguration.h"
header "CBLValueIndexConfiguration.h"
header "CBLRemoteDatabase.h"

// Swift Extensions:
header "CBLArray+Swift.h"
Expand Down
76 changes: 76 additions & 0 deletions Swift/RemoteDatabase.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
//
// RemoteDatabase.swift
// CouchbaseLite
//
// Copyright (c) 2022 Couchbase, Inc All rights reserved.
//
// 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 Foundation

/// This is a wrapper for Sync Gateway's CRUD APIs.
/// https://docs.couchbase.com/sync-gateway/current/rest-api.html
public class RemoteDatabase {
/// Creates a new RemoteDatabase instance, and starts it automatically.
public init(url: URL, authenticator: Authenticator? = nil) {
impl = CBLRemoteDatabase(url: url, authenticator: (authenticator as? IAuthenticator)?.toImpl())
}

/// Gets an existing document with the given ID. If a document with the given ID
/// doesn't exist in the database, the value returned will be nil.
public func document(withID id: String, completion: @escaping (_ document: Document?) -> Void) {
self.impl.document(withID: id) { (doc: CBLDocument?, error: Error?) in
if let cblDoc = doc {
completion(Document(cblDoc))
} else {
completion(nil)
}
}
}

/// Stop and close the connection with the remote database.
public func stop() {
self.impl.stop()
}

/// Saves a document to the remote database.
public func saveDocument(document: MutableDocument, completion: @escaping (_ document: Document?) -> Void) {
guard let mDoc = (document._impl as? CBLMutableDocument) else {
fatalError("document is not MutableDocument type!")
}

self.impl.save(mDoc) { (doc: CBLDocument?, error: Error?) in
if let cblDoc = doc {
completion(Document(cblDoc))
} else {
completion(nil)
}
}
}

/// Deletes a document from the remote database.
public func deleteDocument(document: Document, completion: @escaping (_ document: Document?) -> Void) {
self.impl.delete(document._impl) { (doc: CBLDocument?, error: Error?) in
if let cblDoc = doc {
completion(Document(cblDoc))
} else {
completion(nil)
}
}
}

// MARK: Internal

let impl: CBLRemoteDatabase
}
87 changes: 87 additions & 0 deletions Swift/Tests/RemoteDatabaseTest.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
//
// RemoteDatabaseTest.swift
// CouchbaseLite
//
// Copyright (c) 2022 Couchbase, Inc All rights reserved.
//
// 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
import CouchbaseLiteSwift

final class RemoteDatabaseTest: URLEndpontListenerTest {
var client: RemoteDatabase!

override func setUpWithError() throws {
try super.setUpWithError()

timeout = 10.0
}

override func tearDownWithError() throws {
try super.tearDownWithError()
}

func start() throws {
var config = URLEndpointListenerConfiguration(database: self.oDB)
config.disableTLS = true
config.allowConnectedClient = true
let list = URLEndpointListener(config: config)
try list.start()

client = RemoteDatabase(url: list.localURL)
}

func testConnectedClient() throws {
try start()

let x = self.expectation(description: "Document receive")

// create a doc in server (listener)
let doc1 = MutableDocument(id: "doc-1")
doc1.setString("someString", forKey: "someKeyString")
try self.oDB.saveDocument(doc1)

client.document(withID: "doc-1") { doc in

guard let doc = doc else {
XCTFail("Document not present")
return
}

XCTAssertEqual(doc.id, "doc-1")
XCTAssertEqual(doc.revisionID, "1-32a289db92b52a11cc4fe04216ada40c17296b45")
XCTAssert(doc.toDictionary() == ["someKeyString": "someString"])

x.fulfill()
}

wait(for: [x], timeout: timeout)
}

func testConnectedClientUnknownHostname() throws {
let x = self.expectation(description: "Document receive")

client = RemoteDatabase(url: URL(string: "ws://foo")!)

client.document(withID: "doc-1") { doc in

XCTAssertNil(doc)

x.fulfill()
}

wait(for: [x], timeout: timeout)
}
}