CBL-6813: Deprecate removeChangeListenerWithToken for Replicator and Query APIs (#3447)

velicuvlad · web-flow · commit 386416e35158 · 2025-09-08T18:50:45.000+01:00
diff --git a/Objective-C/CBLQuery.h b/Objective-C/CBLQuery.h
@@ -98,7 +98,8 @@ NS_ASSUME_NONNULL_BEGIN
  
  @param token The listener token.
  */
-- (void) removeChangeListenerWithToken: (id<CBLListenerToken>)token;
+- (void) removeChangeListenerWithToken: (id<CBLListenerToken>)token
+__deprecated_msg("Use [ListenerToken remove] instead.");
 
 
 /** Not available */
diff --git a/Objective-C/CBLQuery.mm b/Objective-C/CBLQuery.mm
@@ -309,7 +309,13 @@ - (void) removeChangeListenerWithToken: (id<CBLListenerToken>)token {
 #pragma mark delegate(CBLRemovableListenerToken)
 
 - (void) removeToken: (id)token {
-    [self removeChangeListenerWithToken: token];
+    CBLAssertNotNil(token);
+    
+    CBL_LOCK(self) {
+        CBLChangeListenerToken* t = (CBLChangeListenerToken*)token;
+        [(CBLQueryObserver*)t.context stop];
+        [_changeNotifier removeChangeListenerWithToken: token];
+    }
 }
 
 #pragma mark - Internal
diff --git a/Objective-C/CBLReplicator.h b/Objective-C/CBLReplicator.h
@@ -135,7 +135,8 @@ the replicator change notification.
  
  @param token The listener token;
  */
-- (void) removeChangeListenerWithToken: (id<CBLListenerToken>)token;
+- (void) removeChangeListenerWithToken: (id<CBLListenerToken>)token
+__deprecated_msg("Use [ListenerToken remove] instead.");
 
 /**
  Get pending document ids for default collection. If the default collection is not part of the
diff --git a/Objective-C/CBLReplicator.mm b/Objective-C/CBLReplicator.mm
@@ -492,7 +492,12 @@ - (void) removeChangeListenerWithToken: (id<CBLListenerToken>)token {
 #pragma mark delegate(CBLRemovableListenerToken)
 
 - (void) removeToken: (id)token {
-    [self removeChangeListenerWithToken: token];
+    [_changeNotifier removeChangeListenerWithToken: token];
+    
+    CBL_LOCK(self) {
+        if ([_docReplicationNotifier removeChangeListenerWithToken: token] == 0)
+            [self setProgressLevel: kCBLProgressLevelOverall];
+    }
 }
 
 - (void) setProgressLevel: (CBLReplicatorProgressLevel)level {
diff --git a/Objective-C/Internal/Replicator/CBLReplicator+Backgrounding.m b/Objective-C/Internal/Replicator/CBLReplicator+Backgrounding.m
@@ -56,12 +56,8 @@ - (void) startBackgroundingMonitor {
 }
 
 - (NSFileProtectionType) fileProtection {
-// TODO: Remove https://issues.couchbase.com/browse/CBL-3206
-#pragma clang diagnostic push
-#pragma clang diagnostic ignored "-Wdeprecated-declarations"
     NSDictionary* attrs = [NSFileManager.defaultManager attributesOfItemAtPath: self.config.database.path error: NULL];
     return attrs[NSFileProtectionKey] ?: NSFileProtectionNone;
-#pragma clang diagnostic pop
 }
 
 - (void) endBackgroundingMonitor {
diff --git a/Objective-C/Tests/ArrayTest.m b/Objective-C/Tests/ArrayTest.m
@@ -30,10 +30,6 @@ @interface ArrayTest : CBLTestCase
 
 @implementation ArrayTest
 
-// TODO: Remove https://issues.couchbase.com/browse/CBL-3206
-#pragma clang diagnostic push
-#pragma clang diagnostic ignored "-Wdeprecated-declarations"
-
 - (NSArray*) arrayOfAllTypes {
     NSMutableArray* array = [NSMutableArray array];
     [array addObject: @(YES)];
@@ -1106,6 +1102,4 @@ - (void) testGetBlobContentFromMutableObject {
     AssertNotNil(blob.content);
 }
 
-#pragma clang diagnostic pop
-
 @end
diff --git a/Objective-C/Tests/CBLTestCase.m b/Objective-C/Tests/CBLTestCase.m
@@ -37,10 +37,6 @@ @implementation CBLTestCase
 
 @synthesize db=_db, otherDB=_otherDB, disableObjectLeakCheck=_disableObjectLeakCheck;
 
-// TODO: Remove https://issues.couchbase.com/browse/CBL-3206
-#pragma clang diagnostic push
-#pragma clang diagnostic ignored "-Wdeprecated-declarations"
-
 - (XCTestExpectation*) allowOverfillExpectationWithDescription:(NSString *)description {
     XCTestExpectation* e = [super expectationWithDescription: description];
     e.assertForOverFulfill = false;
@@ -483,6 +479,4 @@ - (NSString*) getRickAndMortyJSON {
     return [self stringFromResource: @"rick_morty" ofType: @"json"];
 }
 
-#pragma clang diagnostic pop
-
 @end
diff --git a/Objective-C/Tests/DocumentTest.m b/Objective-C/Tests/DocumentTest.m
@@ -33,10 +33,6 @@ @interface DocumentTest : CBLTestCase
 
 @implementation DocumentTest
 
-// TODO: Remove https://issues.couchbase.com/browse/CBL-3206
-#pragma clang diagnostic push
-#pragma clang diagnostic ignored "-Wdeprecated-declarations"
-
 - (void) populateData: (CBLMutableDocument*)doc {
     [doc setValue: @(YES) forKey: @"true"];
     [doc setValue: @(NO) forKey: @"false"];
@@ -2381,6 +2377,4 @@ - (void) testDocumentRevisionHistory {
     Assert(doc._getRevisionHistory);
 }
 
-#pragma clang diagnostic pop
-
 @end
diff --git a/Objective-C/Tests/FragmentTest.m b/Objective-C/Tests/FragmentTest.m
@@ -25,10 +25,6 @@ @interface FragmentTest : CBLTestCase
 
 @implementation FragmentTest
 
-// TODO: Remove https://issues.couchbase.com/browse/CBL-3206
-#pragma clang diagnostic push
-#pragma clang diagnostic ignored "-Wdeprecated-declarations"
-
 - (void) testBasicGetFragmentValues {
     CBLMutableDocument* doc = [self createDocument: @"doc1"];
     [doc setData: @{ @"name": @"Jason",
@@ -682,6 +678,4 @@ - (void) testOutOfRangeArrayFragmentSetObject {
     }];
 }
 
-#pragma clang diagnostic pop
-
 @end
diff --git a/Objective-C/Tests/PredicateQueryTest.m b/Objective-C/Tests/PredicateQueryTest.m
@@ -30,10 +30,6 @@ @interface PredicateQueryTest : CBLTestCase
 
 @implementation PredicateQueryTest
 
-// TODO: Remove https://issues.couchbase.com/browse/CBL-3206
-#pragma clang diagnostic push
-#pragma clang diagnostic ignored "-Wdeprecated-declarations"
-
 - (CBLDocument*) docForRow: (CBLQueryRow*)row {
     NSString* docID = [row stringAtIndex: 0];
     C4SequenceNumber sequence = [row integerAtIndex: 1];
@@ -415,6 +411,4 @@ - (void) testWhereIn {
     AssertEqual((int)numRows, (int)expected.count);
 }
 
-#pragma clang diagnostic pop
-
 @end
diff --git a/Objective-C/Tests/PredictiveQueryTest+CoreML.m b/Objective-C/Tests/PredictiveQueryTest+CoreML.m
@@ -25,10 +25,6 @@ @interface PredictiveQueryWithCoreMLTest : CBLTestCase
 
 @implementation PredictiveQueryWithCoreMLTest
 
-// TODO: Remove https://issues.couchbase.com/browse/CBL-3206
-#pragma clang diagnostic push
-#pragma clang diagnostic ignored "-Wdeprecated-declarations"
-
 - (MLModel*) coreMLModel: (NSString*)name mustExist: (BOOL)mustExist {
     NSString* resource = [NSString stringWithFormat: @"mlmodels/%@", name];
     NSURL* modelURL = [self urlForResource: resource ofType: @"mlmodel"];
@@ -400,6 +396,4 @@ - (void) testInputOutputTransformer {
     [CBLDatabase.prediction unregisterModelWithName: @"MobileNet"];
 }
 
-#pragma clang diagnostic pop
-
 @end
diff --git a/Objective-C/Tests/PredictiveQueryTest.m b/Objective-C/Tests/PredictiveQueryTest.m
@@ -55,10 +55,6 @@ @interface PredictiveQueryTest : CBLTestCase
 
 @implementation PredictiveQueryTest
 
-// TODO: Remove https://issues.couchbase.com/browse/CBL-3206
-#pragma clang diagnostic push
-#pragma clang diagnostic ignored "-Wdeprecated-declarations"
-
 - (void) setUp {
     [super setUp];
     [CBLDatabase.prediction unregisterModelWithName: [CBLAggregateModel name]];
@@ -1141,6 +1137,4 @@ - (CBLDictionary*) doPredict: (CBLDictionary*)input {
     return output;
 }
 
-#pragma clang diagnostic pop
-
 @end
diff --git a/Objective-C/Tests/QueryTest+Join.m b/Objective-C/Tests/QueryTest+Join.m
@@ -25,10 +25,6 @@ @interface QueryTestWithJoin : QueryTest
 
 @implementation QueryTestWithJoin
 
-// TODO: Remove https://issues.couchbase.com/browse/CBL-3206
-#pragma clang diagnostic push
-#pragma clang diagnostic ignored "-Wdeprecated-declarations"
-
 #pragma mark - JOIN
 
 - (void) testJoin {
@@ -502,6 +498,4 @@ - (void) testForumJoin {
     AssertEqual(i, 2);
 }
 
-#pragma clang diagnostic pop
-
 @end
diff --git a/Objective-C/Tests/QueryTest+Meta.m b/Objective-C/Tests/QueryTest+Meta.m
@@ -25,10 +25,6 @@ @interface QueryTestWithMeta: QueryTest
 
 @implementation QueryTestWithMeta
 
-// TODO: Remove https://issues.couchbase.com/browse/CBL-3206
-#pragma clang diagnostic push
-#pragma clang diagnostic ignored "-Wdeprecated-declarations"
-
 #pragma mark - id & isDeleted
 
 - (void) testMeta {
@@ -347,6 +343,4 @@ - (void) testRevisionID {
     }];
 }
 
-#pragma clang diagnostic pop
-
 @end
diff --git a/Objective-C/Tests/ReplicatorTest+MessageEndPoint.m b/Objective-C/Tests/ReplicatorTest+MessageEndPoint.m
@@ -31,10 +31,6 @@ @implementation ReplicatorTest_MessageEndpoint {
     MockConnectionFactory* _delegate;
 }
 
-// TODO: Remove https://issues.couchbase.com/browse/CBL-3206
-#pragma clang diagnostic push
-#pragma clang diagnostic ignored "-Wdeprecated-declarations"
-
 - (XCTestExpectation *) waitForListenerIdle: (CBLMessageEndpointListener*)listener {
     XCTestExpectation* x = [self expectationWithDescription:@"Listener idle"];
     __block id token = nil;
@@ -354,6 +350,4 @@ - (instancetype) initWithErrorLogic: (nullable id<CBLMockConnectionErrorLogic>)e
     return retVal;
 }
 
-#pragma clang diagnostic pop
-
 @end
diff --git a/Objective-C/Tests/ReplicatorTest+SG.m b/Objective-C/Tests/ReplicatorTest+SG.m
@@ -25,10 +25,6 @@ @interface ReplicatorTest_SG : ReplicatorTest
 
 @implementation ReplicatorTest_SG
 
-// TODO: Remove https://issues.couchbase.com/browse/CBL-3206
-#pragma clang diagnostic push
-#pragma clang diagnostic ignored "-Wdeprecated-declarations"
-
 - (void) testAuthenticationFailure_SG {
     id target = [self remoteEndpointWithName: @"seekrit" secure: YES];
     if (!target)
@@ -282,6 +278,4 @@ - (void) testPushAndPullExpiredDocument_SG {
     AssertNil([savedDoc stringForKey: propertyKey]);
 }
 
-#pragma clang diagnostic pop
-
 @end
diff --git a/Objective-C/Tests/ReplicatorTest.m b/Objective-C/Tests/ReplicatorTest.m
@@ -35,10 +35,6 @@ @implementation ReplicatorTest {
 @synthesize disableDefaultServerCertPinning=_disableDefaultServerCertPinning;
 @synthesize crashWhenStoppedTimeoutOccurred=_crashWhenStoppedTimeoutOccurred;
 
-// TODO: Remove https://issues.couchbase.com/browse/CBL-3206
-#pragma clang diagnostic push
-#pragma clang diagnostic ignored "-Wdeprecated-declarations"
-
 + (void) initialize {
     if (self == [ReplicatorTest class]) {
         // You can set environment variables to force use of a proxy:
@@ -523,8 +519,6 @@ - (XCTestExpectation *) waitForReplicatorStopped:(CBLReplicator*)replicator {
     return x;
 }
 
-#pragma clang diagnostic pop
-
 @end
 
 @implementation TestConflictResolver {
diff --git a/Objective-C/Tests/TunesPerfTest.mm b/Objective-C/Tests/TunesPerfTest.mm
@@ -39,10 +39,6 @@
 static constexpr auto kInterTestSleep = milliseconds(0);
 #endif
 
-// TODO: Remove https://issues.couchbase.com/browse/CBL-3206
-#pragma clang diagnostic push
-#pragma clang diagnostic ignored "-Wdeprecated-declarations"
-
 @implementation TunesPerfTest
 {
     NSArray* _tracks;
@@ -396,6 +392,4 @@ - (unsigned) fullTextSearch {
     }
 }
 
-#pragma clang diagnostic pop
-
 @end
diff --git a/Swift/Query.swift b/Swift/Query.swift
@@ -150,6 +150,7 @@ public class Query {
     /// Removes a change listener wih the given listener token.
     ///
     /// - Parameter token: The listener token.
+    @available(*, deprecated, message: "Use token.remove() instead.")
     public func removeChangeListener(withToken token: ListenerToken) {
         token.remove()
     }
diff --git a/Swift/Replicator.swift b/Swift/Replicator.swift
@@ -193,6 +193,7 @@ public final class Replicator {
     /// Removes a change listener with the given listener token.
     ///
     /// - Parameter token: The listener token.
+    @available(*, deprecated, message: "Use token.remove() instead.")
     public func removeChangeListener(withToken token: ListenerToken) {
         impl.removeChangeListener(with: token.impl)
     }
diff --git a/Swift/Tests/PredictiveQueryTest+CoreML.swift b/Swift/Tests/PredictiveQueryTest+CoreML.swift
@@ -268,5 +268,4 @@ class PredictiveQueryWithCoreMLTest: CBLTestCase {
         
         Database.prediction.unregisterModel(withName: "MobileNet")
     }
-    
 }
diff --git a/Swift/Tests/QueryTest.swift b/Swift/Tests/QueryTest.swift
@@ -1887,7 +1887,7 @@ class QueryTest: CBLTestCase {
         try! self.createDoc(numbered: -1, of: 100)
         
         wait(for: [x2], timeout: expTimeout)
-        query.removeChangeListener(withToken: token)
+        token.remove()
     }
     
     func testLiveQueryNoUpdate() throws {
@@ -1907,7 +1907,7 @@ class QueryTest: CBLTestCase {
         
         wait(for: [x1], timeout: expTimeout)
         XCTAssertEqual(count, 1)
-        q.removeChangeListener(withToken: token)
+        token.remove()
     }
     
     // When adding a second listener after the first listener is notified, the second listener
@@ -1949,8 +1949,8 @@ class QueryTest: CBLTestCase {
         }        
         
         wait(for: [x2], timeout: expTimeout)
-        query.removeChangeListener(withToken: token)
-        query.removeChangeListener(withToken: token2)
+        token.remove()
+        token2.remove()
         XCTAssertEqual(count, 1)
         XCTAssertEqual(count2, 1)
     }
@@ -1982,7 +1982,7 @@ class QueryTest: CBLTestCase {
             try! self.defaultCollection!.purge(id: "doc1")
         }
         wait(for: [x1], timeout: expTimeout)
-        query.removeChangeListener(withToken: token)
+        token.remove()
         XCTAssertEqual(count, 2)
     }
     
@@ -2058,8 +2058,8 @@ class QueryTest: CBLTestCase {
         
         wait(for: [x2, y2], timeout: expTimeout)
         
-        query.removeChangeListener(withToken: token1)
-        query.removeChangeListener(withToken: token2)
+        token1.remove()
+        token2.remove()
         XCTAssertEqual(count1, 2)
         XCTAssertEqual(count2, 2)
     }
@@ -2093,7 +2093,7 @@ class QueryTest: CBLTestCase {
         query.parameters = Parameters().setInt(5, forName: "param")
         
         wait(for: [x2], timeout: expTimeout)
-        query.removeChangeListener(withToken: token)
+        token.remove()
         XCTAssertEqual(count, 2)
     }
 }
diff --git a/Swift/Tests/ReplicatorTest+CustomConflict.swift b/Swift/Tests/ReplicatorTest+CustomConflict.swift
diff --git a/Swift/Tests/ReplicatorTest.swift b/Swift/Tests/ReplicatorTest.swift
diff --git a/Swift/Tests/URLEndpointListenerTest.swift b/Swift/Tests/URLEndpointListenerTest.swift

Original file line number	Diff line number	Diff line change
`@@ -56,12 +56,8 @@ - (void) startBackgroundingMonitor {`
`56`	`56`	`}`
`57`	`57`
`58`	`58`	`- (NSFileProtectionType) fileProtection {`
`59`		`-// TODO: Remove https://issues.couchbase.com/browse/CBL-3206`
`60`		`-#pragma clang diagnostic push`
`61`		`-#pragma clang diagnostic ignored "-Wdeprecated-declarations"`
`62`	`59`	`NSDictionary* attrs = [NSFileManager.defaultManager attributesOfItemAtPath: self.config.database.path error: NULL];`
`63`	`60`	`return attrs[NSFileProtectionKey] ?: NSFileProtectionNone;`
`64`		`-#pragma clang diagnostic pop`
`65`	`61`	`}`
`66`	`62`
`67`	`63`	`- (void) endBackgroundingMonitor {`