change OperationQueueItem to interface

Author: fadi-george

package.json

@@ -84,7 +84,7 @@
     },
     {
       "path": "./build/releases/OneSignalSDK.page.es6.js",
-      "limit": "47.886 kB",
+      "limit": "47.8 kB",
       "gzip": true
     },
     {

src/core/operationRepo/OperationRepo.test.ts

@@ -19,7 +19,7 @@ import {
   OP_REPO_POST_CREATE_DELAY,
 } from './constants';
 import { NewRecordsState } from './NewRecordsState';
-import { OperationQueueItem, OperationRepo } from './OperationRepo';
+import { OperationRepo } from './OperationRepo';
 
 vi.spyOn(Log, '_error').mockImplementation((msg) => {
   if (typeof msg === 'string' && msg.includes('Operation execution failed'))
@@ -224,43 +224,49 @@ describe('OperationRepo', () => {
     const singleOp = new Operation('1', GroupComparisonType.NONE);
     const groupedOps = getGroupedOp();
 
-    let op = new OperationQueueItem({
+    let op = {
       operation: singleOp,
       bucket: 0,
-    });
+      retries: 0,
+    };
 
     // single operation should be returned as is
     expect(opRepo._getGroupableOperations(op)).toEqual([op]);
 
     // can group operations by same create comparison key
-    op = new OperationQueueItem({
+    op = {
       operation: groupedOps[0],
       bucket: 0,
-    });
-    let op2 = new OperationQueueItem({
+      retries: 0,
+    };
+    let op2 = {
       operation: groupedOps[1],
       bucket: 0,
-    });
+      retries: 0,
+    };
     opRepo._enqueue(op2.operation);
     expect(opRepo._getGroupableOperations(op)).toEqual([op, op2]);
 
     // can group operations by same modify comparison key
-    op = new OperationQueueItem({
+    op = {
       operation: new Operation('1', GroupComparisonType.ALTER, '', 'abc'),
       bucket: 0,
-    });
-    op2 = new OperationQueueItem({
+      retries: 0,
+    };
+    op2 = {
       operation: new Operation('2', GroupComparisonType.ALTER, '', 'abc'),
       bucket: 0,
-    });
+      retries: 0,
+    };
     opRepo._enqueue(op2.operation);
     expect(opRepo._getGroupableOperations(op)).toEqual([op, op2]);
 
     // throws for no comparison keys
-    op = new OperationQueueItem({
+    op = {
       operation: new Operation('1', GroupComparisonType.CREATE),
       bucket: 0,
-    });
+      retries: 0,
+    };
     opRepo._enqueue(op2.operation);
     expect(() => opRepo._getGroupableOperations(op)).toThrow(
       'Both comparison keys cannot be blank!',
@@ -271,10 +277,11 @@ describe('OperationRepo', () => {
     const records = opRepo._records;
     records.set(blockedId, Date.now());
 
-    op = new OperationQueueItem({
+    op = {
       operation: new Operation('1', GroupComparisonType.CREATE, 'def'),
       bucket: 0,
-    });
+      retries: 0,
+    };
     op2.operation._setProperty('onesignalId', blockedId);
 
     opRepo._enqueue(op2.operation);

src/core/operationRepo/OperationRepo.ts

@@ -22,27 +22,11 @@ const removeOpFromDB = (op: Operation) => {
 
 // Implements logic similar to Android SDK's OperationRepo & OperationQueueItem
 // Reference: https://github.com/OneSignal/OneSignal-Android-SDK/blob/5.1.31/OneSignalSDK/onesignal/core/src/main/java/com/onesignal/core/internal/operations/impl/OperationRepo.kt
-export class OperationQueueItem {
-  public operation: Operation;
-  public bucket: number;
-  public retries: number;
-  public resolver?: (value: boolean) => void;
-
-  constructor(props: {
-    operation: Operation;
-    bucket: number;
-    retries?: number;
-    resolver?: (value: boolean) => void;
-  }) {
-    this.operation = props.operation;
-    this.bucket = props.bucket;
-    this.retries = props.retries ?? 0;
-    this.resolver = props.resolver;
-  }
-
-  toString(): string {
-    return `bucket:${this.bucket}, retries:${this.retries}, operation:${this.operation}\n`;
-  }
+export interface OperationQueueItem {
+  operation: Operation;
+  bucket: number;
+  retries: number;
+  resolver?: (value: boolean) => void;
 }
 
 // OperationRepo Class
@@ -103,10 +87,11 @@ export class OperationRepo implements IOperationRepo, IStartableService {
     Log._debug(`OperationRepo.enqueue(operation: ${operation})`);
 
     this._internalEnqueue(
-      new OperationQueueItem({
+      {
         operation,
         bucket: this._enqueueIntoBucket,
-      }),
+        retries: 0,
+      },
       true,
     );
   }
@@ -116,11 +101,12 @@ export class OperationRepo implements IOperationRepo, IStartableService {
 
     await new Promise<void>((resolve, reject) => {
       this._internalEnqueue(
-        new OperationQueueItem({
+        {
           operation,
           bucket: this._enqueueIntoBucket,
+          retries: 0,
           resolver: (value) => (value ? resolve() : reject()),
-        }),
+        },
         true,
       );
     });
@@ -258,10 +244,11 @@ export class OperationRepo implements IOperationRepo, IStartableService {
       // Handle additional operations from the response
       if (response.operations) {
         for (const op of [...response.operations].reverse()) {
-          const queueItem = new OperationQueueItem({
+          const queueItem = {
             operation: op,
             bucket: 0,
-          });
+            retries: 0,
+          };
           this._queue.unshift(queueItem);
           this._operationModelStore.addAt(0, queueItem.operation);
         }
@@ -364,10 +351,11 @@ export class OperationRepo implements IOperationRepo, IStartableService {
 
     for (const operation of operations) {
       this._internalEnqueue(
-        new OperationQueueItem({
+        {
           operation,
           bucket: this._enqueueIntoBucket,
-        }),
+          retries: 0,
+        },
         false,
         0,
       );

src/onesignal/OneSignal.test.ts

@@ -42,7 +42,7 @@ import {
   updateIdentityModel,
 } from '__test__/support/helpers/setup';
 import { MockServiceWorker } from '__test__/support/mocks/MockServiceWorker';
-import { OperationQueueItem } from 'src/core/operationRepo/OperationRepo';
+import type { OperationQueueItem } from 'src/core/operationRepo/OperationRepo';
 import { type ICreateUserSubscription } from 'src/core/types/api';
 import { ModelChangeTags } from 'src/core/types/models';
 import { db } from 'src/shared/database/client';