Marked IsSyncInProgress as a public deprecated method

ably · Apr 19, 2024 · 9c8f395 · 9c8f395
1 parent 8be657f
commit 9c8f395
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 9 deletions.
diff --git a/src/IO.Ably.Shared/Realtime/Presence.cs b/src/IO.Ably.Shared/Realtime/Presence.cs
@@ -43,18 +43,24 @@ internal Presence(IConnectionManager connection, RealtimeChannel channel, string
         /// </summary>
         ///
         [Obsolete("This property is deprecated, use SyncComplete instead")]
-        public bool IsSyncComplete => SyncComplete; // RTP13
+        public bool IsSyncComplete => SyncComplete; // RTP13.
 
         /// <summary>
         /// Checks if presence sync has ended.
         /// </summary>
         ///
-        public bool SyncComplete => MembersMap.SyncCompleted && !IsSyncInProgress; // RTP13
+        public bool SyncComplete => MembersMap.SyncCompleted && !SyncInProgress; // RTP13
 
         /// <summary>
         /// Indicates whether there is currently a sync in progress.
         /// </summary>
-        internal bool IsSyncInProgress => MembersMap.SyncInProgress;
+        [Obsolete("This property is internal, will be removed in the future")]
+        public bool IsSyncInProgress => SyncInProgress;
+
+        /// <summary>
+        /// Indicates whether there is currently a sync in progress.
+        /// </summary>
+        internal bool SyncInProgress => MembersMap.SyncInProgress;
 
         /// <summary>
         /// Indicates all members present on the channel.
@@ -540,7 +546,7 @@ internal void OnSyncMessage(ProtocolMessage protocolMessage)
                 /* If a new sequence identifier is sent from Ably, then the client library
                  * must consider that to be the start of a new sync sequence
                  * and any previous in-flight sync should be discarded. (part of RTP18)*/
-                if (IsSyncInProgress && _currentSyncChannelSerial.IsNotEmpty() && _currentSyncChannelSerial != syncSequenceId)
+                if (SyncInProgress && _currentSyncChannelSerial.IsNotEmpty() && _currentSyncChannelSerial != syncSequenceId)
                 {
                     EndSync();
                 }
@@ -621,15 +627,15 @@ internal void OnPresence(PresenceMessage[] messages)
 
         internal void StartSync()
         {
-            if (!IsSyncInProgress)
+            if (!SyncInProgress)
             {
                 MembersMap.StartSync();
             }
         }
 
         private void EndSync()
         {
-            if (!IsSyncInProgress)
+            if (!SyncInProgress)
             {
                 return;
             }

diff --git a/src/IO.Ably.Tests.Shared/Realtime/PresenceSandboxSpecs.cs b/src/IO.Ably.Tests.Shared/Realtime/PresenceSandboxSpecs.cs
@@ -109,7 +109,7 @@ public async Task WhenAttachingToAChannelWithMembers_PresenceShouldBeInProgress(
                     if (args.Current == ChannelState.Attached)
                     {
                         Logger.Debug("Test: Setting inSync to - " + channel2.Presence.MembersMap.SyncInProgress);
-                        syncInProgress = channel2.Presence.IsSyncInProgress;
+                        syncInProgress = channel2.Presence.SyncInProgress;
                         syncComplete = channel2.Presence.SyncComplete;
                         awaiter.SetCompleted();
                     }
@@ -740,7 +740,7 @@ public async Task PresenceMap_WhenNotSyncingAndLeaveActionArrivesMemberKeyShould
                 members.Should().HaveCount(20);
 
                 // sync should not be in progress and initial an sync should have completed
-                channel.Presence.IsSyncInProgress.Should().BeFalse("sync should have completed");
+                channel.Presence.SyncInProgress.Should().BeFalse("sync should have completed");
                 channel.Presence.SyncComplete.Should().BeTrue();
 
                 // pull a random member key from the presence map

diff --git a/src/IO.Ably.Tests.Shared/Rest/SandboxSpecExtension.cs b/src/IO.Ably.Tests.Shared/Rest/SandboxSpecExtension.cs
@@ -47,7 +47,7 @@ internal static async Task WaitForAttachedState(this IRealtimeChannel channel, T
         internal static async Task<bool> WaitSync(this Presence presence, TimeSpan? waitSpan = null)
         {
             TaskCompletionSource<bool> taskCompletionSource = new TaskCompletionSource<bool>();
-            var inProgress = presence.IsSyncInProgress;
+            var inProgress = presence.SyncInProgress;
             if (inProgress == false)
             {
                 return true;