Update to use connectionDetails.objectsGCGracePeriod

The field was renamed server-side to better reflect that this is
specifically for LiveObjects

Author: VeskeR

src/plugins/objects/defaults.ts

@@ -1,7 +1,7 @@
 export const DEFAULTS = {
   gcInterval: 1000 * 60 * 5, // 5 minutes
   /**
-   * The SDK will attempt to use the `gcGracePeriod` value provided by the server in the `connectionDetails` object of the `CONNECTED` event.
+   * The SDK will attempt to use the `objectsGCGracePeriod` value provided by the server in the `connectionDetails` object of the `CONNECTED` event.
    * If the server does not provide this value, the SDK will fall back to this default value.
    *
    * Must be > 2 minutes to ensure we keep tombstones long enough to avoid the possibility of receiving an operation

src/plugins/objects/objects.ts

@@ -65,10 +65,10 @@ export class Objects {
     this._objectsPool = new ObjectsPool(this);
     this._syncObjectsDataPool = new SyncObjectsDataPool(this);
     this._bufferedObjectOperations = [];
-    // use server-provided gcGracePeriod if available, and subscribe to new connectionDetails that can be emitted as part of the RTN24
-    this.gcGracePeriod = this._channel.connectionManager.connectionDetails?.gcGracePeriod ?? DEFAULTS.gcGracePeriod;
+    // use server-provided objectsGCGracePeriod if available, and subscribe to new connectionDetails that can be emitted as part of the RTN24
+    this.gcGracePeriod = this._channel.connectionManager.connectionDetails?.objectsGCGracePeriod ?? DEFAULTS.gcGracePeriod;
     this._channel.connectionManager.on('connectiondetails', (details: Record<string, any>) => {
-      this.gcGracePeriod = details.gcGracePeriod ?? DEFAULTS.gcGracePeriod;
+      this.gcGracePeriod = details.objectsGCGracePeriod ?? DEFAULTS.gcGracePeriod;
     });
   }
 

test/realtime/objects.test.js

@@ -4234,7 +4234,7 @@ define(['ably', 'shared_helper', 'chai', 'objects', 'objects_helper'], function
         }, client);
       });
 
-      it('gcGracePeriod is set from connectionDetails', async function () {
+      it('gcGracePeriod is set from connectionDetails.objectsGCGracePeriod', async function () {
         const helper = this.test.helper;
         const client = RealtimeWithObjects(helper);
 
@@ -4248,11 +4248,11 @@ define(['ably', 'shared_helper', 'chai', 'objects', 'objects_helper'], function
 
           // gcGracePeriod should be set after the initial connection
           helper.recordPrivateApi('read.Objects.gcGracePeriod');
-          expect(objects.gcGracePeriod, 'Check gcGracePeriod is set after initial connection').to.exist;
+          expect(objects.gcGracePeriod, 'Check gcGracePeriod is set after initial connection from connectionDetails.objectsGCGracePeriod').to.exist;
           helper.recordPrivateApi('read.Objects.gcGracePeriod');
           expect(objects.gcGracePeriod).to.equal(
-            connectionDetails.gcGracePeriod,
-            'Check gcGracePeriod is set to equal connectionDetails.gcGracePeriod',
+            connectionDetails.objectsGCGracePeriod,
+            'Check gcGracePeriod is set to equal connectionDetails.objectsGCGracePeriod',
           );
 
           const connectionDetailsPromise = connectionManager.once('connectiondetails');
@@ -4265,7 +4265,7 @@ define(['ably', 'shared_helper', 'chai', 'objects', 'objects_helper'], function
               action: 4, // CONNECTED
               connectionDetails: {
                 ...connectionDetails,
-                gcGracePeriod: 999,
+                objectsGCGracePeriod: 999,
               },
             }),
           );