CBL-7394 : Add mdns logging domain (#3446)

pasin · web-flow · commit d3d4dfc08999 · 2025-09-08T16:01:45.000+01:00
* Added mdns logging domain to both objective-c and swift

* Reserved 128 and 256 value for bluetooth and wifi-aware that we may have in the future for multipeer replicator.

* Changed Swift LogDomain type from UInt8 to UInt.

* Fixed missing switch cases in CBLFileLogSink.mm.

* Skip testConfigurationValidation as precondition cannot be asserted

* We use Swift’s precondition() for parameter validation in Precondition.swift. Since it traps like fatalError, it cannot be asserted in tests, so the test is left disabled for manual runs.

* Removed leftover debug logging
diff --git a/Objective-C/CBLLog.mm b/Objective-C/CBLLog.mm
@@ -133,6 +133,9 @@ - (void) logTo: (CBLLogDomain)domain level: (CBLLogLevel)level message: (NSStrin
         case kCBLLogDomainPeerDiscovery:
             c4Domain = kCBL_LogDomainDiscovery;
             break;
+        case kCBLLogDomainMDNS:
+            c4Domain = kCBL_LogDomainMDNS;
+            break;
         case kCBLLogDomainMultipeer:
             c4Domain = kCBL_LogDomainP2P;
             break;
diff --git a/Objective-C/Internal/CBLLog+Logging.h b/Objective-C/Internal/CBLLog+Logging.h
@@ -40,6 +40,7 @@ extern C4LogDomain kCBL_LogDomainSync;
 extern C4LogDomain kCBL_LogDomainWebSocket;
 extern C4LogDomain kCBL_LogDomainListener;
 extern C4LogDomain kCBL_LogDomainDiscovery;
+extern C4LogDomain kCBL_LogDomainMDNS;
 extern C4LogDomain kCBL_LogDomainP2P;
     
 // Logging functions. For the domain, just use the part of the name between kCBL… and …LogDomain.
diff --git a/Objective-C/LogSink/CBLConsoleLogSink.mm b/Objective-C/LogSink/CBLConsoleLogSink.mm
@@ -70,6 +70,9 @@ - (NSString*) domainName: (CBLLogDomain)domain {
         case kCBLLogDomainPeerDiscovery:
             return @"PeerDiscovery";
             break;
+        case kCBLLogDomainMDNS:
+            return @"mDNS";
+            break;
         case kCBLLogDomainMultipeer:
             return @"Multipeer";
             break;
diff --git a/Objective-C/LogSink/CBLFileLogSink.mm b/Objective-C/LogSink/CBLFileLogSink.mm
@@ -111,11 +111,18 @@ - (void) writeLogWithLevel: (CBLLogLevel)level domain: (CBLLogDomain)domain mess
         case kCBLLogDomainNetwork:
             c4domain = kCBL_LogDomainWebSocket;
             break;
-#ifdef COUCHBASE_ENTERPRISE
         case kCBLLogDomainListener:
             c4domain = kCBL_LogDomainListener;
             break;
-#endif
+        case kCBLLogDomainPeerDiscovery:
+            c4domain = kCBL_LogDomainDiscovery;
+            break;
+        case kCBLLogDomainMDNS:
+            c4domain = kCBL_LogDomainMDNS;
+            break;
+        case kCBLLogDomainMultipeer:
+            c4domain = kCBL_LogDomainP2P;
+            break;
         default:
             c4domain = kCBL_LogDomainDatabase;
     }
diff --git a/Objective-C/LogSink/CBLLogSinks.mm b/Objective-C/LogSink/CBLLogSinks.mm
@@ -27,9 +27,10 @@
 C4LogDomain kCBL_LogDomainWebSocket;
 C4LogDomain kCBL_LogDomainListener;
 C4LogDomain kCBL_LogDomainDiscovery;
+C4LogDomain kCBL_LogDomainMDNS;
 C4LogDomain kCBL_LogDomainP2P;
 
-static NSArray* c4Domains = @[@"DB", @"Query", @"Sync", @"WS", @"Listener", @"Discovery", @"P2P"];
+static NSArray* c4Domains = @[@"DB", @"Query", @"Sync", @"WS", @"Listener", @"Discovery", @"mDNS", @"P2P"];
 static NSArray* platformDomains = @[@"BLIP", @"BLIPMessages", @"SyncBusy", @"TLS", @"Changes", @"Zip"];
 
 static CBLLogLevel _domainsLevel = kCBLLogLevelNone;
@@ -62,6 +63,7 @@ + (void) initialize {
         kCBL_LogDomainWebSocket  = c4log_getDomain("WS", true);
         kCBL_LogDomainListener  = c4log_getDomain("Listener", true);
         kCBL_LogDomainDiscovery = c4log_getDomain("Discovery", true);
+        kCBL_LogDomainMDNS = c4log_getDomain("mDNS", true);
         kCBL_LogDomainP2P = c4log_getDomain("P2P", true);
         
         // Create the default warning console log:
@@ -182,6 +184,7 @@ static CBLLogDomain toCBLLogDomain(C4LogDomain domain) {
                               @"TLS": @(kCBLLogDomainNetwork),
                               @"Listener": @(kCBLLogDomainListener),
                               @"Discovery": @(kCBLLogDomainPeerDiscovery),
+                              @"mDNS": @(kCBLLogDomainMDNS),
                               @"P2P": @(kCBLLogDomainMultipeer)
         };
     }
diff --git a/Objective-C/LogSink/CBLLogTypes.h b/Objective-C/LogSink/CBLLogTypes.h
@@ -27,8 +27,9 @@ typedef NS_OPTIONS(NSUInteger, CBLLogDomain) {
     kCBLLogDomainNetwork        = 1 << 3,       ///< Network domain.
     kCBLLogDomainListener       = 1 << 4,       ///< Listener domain.
     kCBLLogDomainPeerDiscovery  = 1 << 5,       ///< Peer Discovery domain.
-    kCBLLogDomainMultipeer      = 1 << 6,       ///< Multipeer Replication domain.
-    kCBLLogDomainAll            = (1 << 7) - 1  ///< All domains
+    kCBLLogDomainMDNS           = 1 << 6,       ///< mDNS specific logs used for DNS-SD peer discovery
+    kCBLLogDomainMultipeer      = 1 << 9,       ///< Multipeer Replication domain.
+    kCBLLogDomainAll            = (1 << 10) - 1 ///< All domains
 };
 
 /** Log level. */
diff --git a/Swift/ConsoleLogger.swift b/Swift/ConsoleLogger.swift
@@ -51,13 +51,17 @@ public struct LogDomains: OptionSet {
     /// Peer Discovery domain.
     public static let peerDiscovery = LogDomains(rawValue: Int(LogDomain.peerDiscovery.rawValue))
     
+    /// mDNS specific logs used for DNS-SD peer discovery.
+    public static let mdns = LogDomains(rawValue: Int(LogDomain.mdns.rawValue))
+    
     /// Multipeer Replication domain.
     public static let multipeer = LogDomains(rawValue: Int(LogDomain.multipeer.rawValue))
     
     /// All domains.
     public static let all: LogDomains = [
-        .database, .query, .replicator, .network, .listener, .peerDiscovery, .multipeer
+        .database, .query, .replicator, .network, .listener, .peerDiscovery, .mdns, .multipeer
     ]
+    
 }
 
 public class ConsoleLogger {
diff --git a/Swift/Log.swift b/Swift/Log.swift
@@ -40,7 +40,7 @@ public class Log {
                 let logLevel = CBLLogLevel(rawValue: UInt(logger.level.rawValue))!
                 CBLDatabase.log().setCustomLoggerWith(logLevel) { (level, domain, message) in
                     let l = LogLevel(rawValue: UInt8(level.rawValue))!
-                    let d = LogDomain(rawValue: UInt8(domain.rawValue))!
+                    let d = LogDomain(rawValue: domain.rawValue)!
                     logger.log(level: l, domain: d, message: message)
                 }
             } else {
diff --git a/Swift/LogSinks.swift b/Swift/LogSinks.swift
@@ -75,7 +75,7 @@ public class LogSinks {
         
         func writeLog(with level: CBLLogLevel, domain: CBLLogDomain, message: String) {
             let logLevel = LogLevel.init(rawValue: UInt8(level.rawValue))!
-            let logDomain = LogDomain.init(rawValue: UInt8(domain.rawValue))!
+            let logDomain = LogDomain.init(rawValue: domain.rawValue)!
             logSink.writeLog(level:logLevel, domain: logDomain, message: message)
         }
     }
diff --git a/Swift/Logger.swift b/Swift/Logger.swift
@@ -21,20 +21,30 @@ import Foundation
 import CouchbaseLiteSwift_Private
 
 /// Log domain.
-///
-/// database:   Database domain.
-/// query:      Query domain.
-/// replicator: Replicator domain.
-/// network:    Network domain.
-/// listener:   Listener domain.
-public enum LogDomain: UInt8 {
+public enum LogDomain: UInt {
+    /// Database domain.
     case database       = 1
+    
+    /// Query domain.
     case query          = 2
+    
+    /// Replicator domain.
     case replicator     = 4
+    
+    /// Network domain.
     case network        = 8
+    
+    /// Listener domain.
     case listener       = 16
+    
+    /// Peer Discovery domain.
     case peerDiscovery  = 32
-    case multipeer      = 64
+    
+    /// mDNS specific logs used for DNS-SD peer discovery
+    case mdns           = 64
+    
+    /// Multipeer Replication domain
+    case multipeer      = 512
 }
 
 /// Log level.
diff --git a/Swift/Tests/LogSinkTest.swift b/Swift/Tests/LogSinkTest.swift
@@ -399,7 +399,7 @@ class LogSinkTest: CBLTestCase {
             let logSink = TestCustomLogSink()
             LogSinks.custom = CustomLogSink(level: .debug, domains: domains[i], logSink: logSink)
             for j in 0..<domains.count {
-                Log.log(domain: LogDomain(rawValue: UInt8(domains[j].rawValue))!, level: .verbose, message: names[j])
+                Log.log(domain: LogDomain(rawValue: UInt(domains[j].rawValue))!, level: .verbose, message: names[j])
             }
             XCTAssertEqual(logSink.lines.count, 1)
             XCTAssertEqual(logSink.lines[0], names[i])
@@ -415,7 +415,7 @@ class LogSinkTest: CBLTestCase {
             let logSink = TestCustomLogSink()
             LogSinks.custom = CustomLogSink(level: .debug, domains: combined, logSink: logSink)
             for j in 0..<domains.count {
-                Log.log(domain: LogDomain(rawValue: UInt8(domains[j].rawValue))!, level: .verbose, message: names[j])
+                Log.log(domain: LogDomain(rawValue: UInt(domains[j].rawValue))!, level: .verbose, message: names[j])
             }
             
             XCTAssertEqual(logSink.lines.count, i + 1)
@@ -428,7 +428,7 @@ class LogSinkTest: CBLTestCase {
         let logSink = TestCustomLogSink()
         LogSinks.custom = CustomLogSink(level: .debug, domains: .all, logSink: logSink)
         for i in 0..<domains.count {
-            Log.log(domain: LogDomain(rawValue: UInt8(domains[i].rawValue))!, level: .verbose, message: names[i])
+            Log.log(domain: LogDomain(rawValue: UInt(domains[i].rawValue))!, level: .verbose, message: names[i])
         }
         XCTAssertEqual(logSink.lines.count, names.count)
         for i in 0..<names.count {
diff --git a/Swift/Tests/MultipeerReplicatorTest.swift b/Swift/Tests/MultipeerReplicatorTest.swift
@@ -346,31 +346,29 @@ class MultipeerReplicatorTest: CBLTestCase {
      4. Check that the configuration cannot be created as the collections are empty.
      */
     func testConfigurationValidation() throws {
+        throw XCTSkip("Swift's Precondition cannot be asserted. Enable manually when needed.")
+        
         // Create the collection and identity
         let collection = try db.defaultCollection()
         let identity = try createIdentity()
         let auth = MultipeerCertificateAuthenticator { _, _ in true }
         let collConfig = MultipeerCollectionConfiguration(collection: collection)
 
         // Create the configuration with an empty peerGroupID:
-        expectException(exception: .invalidArgumentException) {
-            _ = MultipeerReplicatorConfiguration(
-                peerGroupID: "",
-                identity: identity,
-                authenticator: auth,
-                collections: [collConfig]
-            )
-        }
+        _ = MultipeerReplicatorConfiguration(
+            peerGroupID: "",
+            identity: identity,
+            authenticator: auth,
+            collections: [collConfig]
+        )
         
         // Create the configuration with an empty collections:
-        expectException(exception: .invalidArgumentException) {
-            _ = MultipeerReplicatorConfiguration(
-                peerGroupID: self.kTestPeerGroupID,
-                identity: identity,
-                authenticator: auth,
-                collections: []
-            )
-        }
+        _ = MultipeerReplicatorConfiguration(
+            peerGroupID: self.kTestPeerGroupID,
+            identity: identity,
+            authenticator: auth,
+            collections: []
+        )
     }
     
     // MARK: - Stop and Restart
@@ -646,8 +644,6 @@ class MultipeerReplicatorTest: CBLTestCase {
         that one of the replicators is STOPPED with the error.
      */
     func testAuthenticateWithRootCertsFailed() throws {
-        LogSinks.console = ConsoleLogSink(level: .verbose)
-        
         let rootCertPEM = """
         -----BEGIN CERTIFICATE-----
         MIIE/DCCAuSgAwIBAgIUHKj9KlERcqJF62FpOzQn7rC9PPgwDQYJKoZIhvcNAQEL
@@ -749,8 +745,6 @@ class MultipeerReplicatorTest: CBLTestCase {
         that one of the replicators is STOPPED with the error.
      */
     func testAuthenticateWithCallbackFailed() throws {
-        LogSinks.console = ConsoleLogSink(level: .verbose)
-        
         let auth = MultipeerCertificateAuthenticator { peerID, certs in
             XCTAssertNotNil(peerID)
             XCTAssertFalse(certs.isEmpty)
@@ -1376,8 +1370,6 @@ class MultipeerReplicatorTest: CBLTestCase {
      13. Verify that MultipeerReplicator#2's neighborPeers is empty.
      */
     func testNeighborPeers() throws {
-        LogSinks.console = ConsoleLogSink(level: .verbose)
-        
         let repl1 = try multipeerReplicator(for: db)
         XCTAssertEqual(repl1.neighborPeers.count, 0)
 

Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ public class Log {`
`40`	`40`	`let logLevel = CBLLogLevel(rawValue: UInt(logger.level.rawValue))!`
`41`	`41`	`CBLDatabase.log().setCustomLoggerWith(logLevel) { (level, domain, message) in`
`42`	`42`	`let l = LogLevel(rawValue: UInt8(level.rawValue))!`
`43`		`- let d = LogDomain(rawValue: UInt8(domain.rawValue))!`
	`43`	`+ let d = LogDomain(rawValue: domain.rawValue)!`
`44`	`44`	`logger.log(level: l, domain: d, message: message)`
`45`	`45`	`}`
`46`	`46`	`} else {`
Original file line number	Diff line number	Diff line change
`@@ -75,7 +75,7 @@ public class LogSinks {`
`75`	`75`
`76`	`76`	`func writeLog(with level: CBLLogLevel, domain: CBLLogDomain, message: String) {`
`77`	`77`	`let logLevel = LogLevel.init(rawValue: UInt8(level.rawValue))!`
`78`		`- let logDomain = LogDomain.init(rawValue: UInt8(domain.rawValue))!`
	`78`	`+ let logDomain = LogDomain.init(rawValue: domain.rawValue)!`
`79`	`79`	`logSink.writeLog(level:logLevel, domain: logDomain, message: message)`
`80`	`80`	`}`
`81`	`81`	`}`