From bf842fa643a667063717e58c819a15b61841832e Mon Sep 17 00:00:00 2001
From: Andrew Bulat <andrii.bulat@gmail.com>
Date: Wed, 12 Feb 2025 06:14:40 +0000
Subject: [PATCH] Use more specific error codes for LiveObjects errors

Resolves PUB-1011
---
 .../liveobjects/batchcontextlivecounter.ts    |  2 +-
 src/plugins/liveobjects/livecounter.ts        | 18 ++++++-------
 src/plugins/liveobjects/livemap.ts            | 26 +++++++++----------
 src/plugins/liveobjects/liveobject.ts         |  4 +--
 src/plugins/liveobjects/liveobjects.ts        |  4 +--
 src/plugins/liveobjects/objectid.ts           | 10 +++----
 6 files changed, 32 insertions(+), 32 deletions(-)

diff --git a/src/plugins/liveobjects/batchcontextlivecounter.ts b/src/plugins/liveobjects/batchcontextlivecounter.ts
index e61cd9d1c..3528c3ecb 100644
--- a/src/plugins/liveobjects/batchcontextlivecounter.ts
+++ b/src/plugins/liveobjects/batchcontextlivecounter.ts
@@ -33,7 +33,7 @@ export class BatchContextLiveCounter {
     // do an explicit type safety check here before negating the amount value,
     // so we don't unintentionally change the type sent by a user
     if (typeof amount !== 'number') {
-      throw new this._client.ErrorInfo('Counter value decrement should be a number', 40013, 400);
+      throw new this._client.ErrorInfo('Counter value decrement should be a number', 40003, 400);
     }
 
     this.increment(-amount);
diff --git a/src/plugins/liveobjects/livecounter.ts b/src/plugins/liveobjects/livecounter.ts
index c5a7be1bb..34b9ecf59 100644
--- a/src/plugins/liveobjects/livecounter.ts
+++ b/src/plugins/liveobjects/livecounter.ts
@@ -52,7 +52,7 @@ export class LiveCounter extends LiveObject<LiveCounterData, LiveCounterUpdate>
     const client = liveObjects.getClient();
 
     if (typeof amount !== 'number' || !isFinite(amount)) {
-      throw new client.ErrorInfo('Counter value increment should be a valid number', 40013, 400);
+      throw new client.ErrorInfo('Counter value increment should be a valid number', 40003, 400);
     }
 
     const stateMessage = StateMessage.fromValues(
@@ -77,7 +77,7 @@ export class LiveCounter extends LiveObject<LiveCounterData, LiveCounterUpdate>
     const client = liveObjects.getClient();
 
     if (count !== undefined && (typeof count !== 'number' || !Number.isFinite(count))) {
-      throw new client.ErrorInfo('Counter value should be a valid number', 40013, 400);
+      throw new client.ErrorInfo('Counter value should be a valid number', 40003, 400);
     }
 
     const initialValueObj = LiveCounter.createInitialValueObject(count);
@@ -150,7 +150,7 @@ export class LiveCounter extends LiveObject<LiveCounterData, LiveCounterUpdate>
     // do an explicit type safety check here before negating the amount value,
     // so we don't unintentionally change the type sent by a user
     if (typeof amount !== 'number' || !isFinite(amount)) {
-      throw new this._client.ErrorInfo('Counter value decrement should be a valid number', 40013, 400);
+      throw new this._client.ErrorInfo('Counter value decrement should be a valid number', 40003, 400);
     }
 
     return this.increment(-amount);
@@ -163,7 +163,7 @@ export class LiveCounter extends LiveObject<LiveCounterData, LiveCounterUpdate>
     if (op.objectId !== this.getObjectId()) {
       throw new this._client.ErrorInfo(
         `Cannot apply state operation with objectId=${op.objectId}, to this LiveCounter with objectId=${this.getObjectId()}`,
-        50000,
+        92000,
         500,
       );
     }
@@ -211,7 +211,7 @@ export class LiveCounter extends LiveObject<LiveCounterData, LiveCounterUpdate>
       default:
         throw new this._client.ErrorInfo(
           `Invalid ${op.action} op for LiveCounter objectId=${this.getObjectId()}`,
-          50000,
+          92000,
           500,
         );
     }
@@ -226,7 +226,7 @@ export class LiveCounter extends LiveObject<LiveCounterData, LiveCounterUpdate>
     if (stateObject.objectId !== this.getObjectId()) {
       throw new this._client.ErrorInfo(
         `Invalid state object: state object objectId=${stateObject.objectId}; LiveCounter objectId=${this.getObjectId()}`,
-        50000,
+        92000,
         500,
       );
     }
@@ -236,7 +236,7 @@ export class LiveCounter extends LiveObject<LiveCounterData, LiveCounterUpdate>
       if (stateObject.createOp.objectId !== this.getObjectId()) {
         throw new this._client.ErrorInfo(
           `Invalid state object: state object createOp objectId=${stateObject.createOp?.objectId}; LiveCounter objectId=${this.getObjectId()}`,
-          50000,
+          92000,
           500,
         );
       }
@@ -244,7 +244,7 @@ export class LiveCounter extends LiveObject<LiveCounterData, LiveCounterUpdate>
       if (stateObject.createOp.action !== StateOperationAction.COUNTER_CREATE) {
         throw new this._client.ErrorInfo(
           `Invalid state object: state object createOp action=${stateObject.createOp?.action}; LiveCounter objectId=${this.getObjectId()}`,
-          50000,
+          92000,
           500,
         );
       }
@@ -308,7 +308,7 @@ export class LiveCounter extends LiveObject<LiveCounterData, LiveCounterUpdate>
   private _throwNoPayloadError(op: StateOperation): void {
     throw new this._client.ErrorInfo(
       `No payload found for ${op.action} op for LiveCounter objectId=${this.getObjectId()}`,
-      50000,
+      92000,
       500,
     );
   }
diff --git a/src/plugins/liveobjects/livemap.ts b/src/plugins/liveobjects/livemap.ts
index 6b9f60e80..637c5eeed 100644
--- a/src/plugins/liveobjects/livemap.ts
+++ b/src/plugins/liveobjects/livemap.ts
@@ -143,7 +143,7 @@ export class LiveMap<T extends API.LiveMapType> extends LiveObject<LiveMapData,
     const client = liveObjects.getClient();
 
     if (typeof key !== 'string') {
-      throw new client.ErrorInfo('Map key should be string', 40013, 400);
+      throw new client.ErrorInfo('Map key should be string', 40003, 400);
     }
 
     const stateMessage = StateMessage.fromValues(
@@ -172,7 +172,7 @@ export class LiveMap<T extends API.LiveMapType> extends LiveObject<LiveMapData,
     const client = liveObjects.getClient();
 
     if (typeof key !== 'string') {
-      throw new client.ErrorInfo('Map key should be string', 40013, 400);
+      throw new client.ErrorInfo('Map key should be string', 40003, 400);
     }
 
     if (
@@ -193,7 +193,7 @@ export class LiveMap<T extends API.LiveMapType> extends LiveObject<LiveMapData,
     const client = liveObjects.getClient();
 
     if (entries !== undefined && (entries === null || typeof entries !== 'object')) {
-      throw new client.ErrorInfo('Map entries should be a key/value object', 40013, 400);
+      throw new client.ErrorInfo('Map entries should be a key/value object', 40003, 400);
     }
 
     Object.entries(entries ?? {}).forEach(([key, value]) => LiveMap.validateKeyValue(liveObjects, key, value));
@@ -368,7 +368,7 @@ export class LiveMap<T extends API.LiveMapType> extends LiveObject<LiveMapData,
     if (op.objectId !== this.getObjectId()) {
       throw new this._client.ErrorInfo(
         `Cannot apply state operation with objectId=${op.objectId}, to this LiveMap with objectId=${this.getObjectId()}`,
-        50000,
+        92000,
         500,
       );
     }
@@ -426,7 +426,7 @@ export class LiveMap<T extends API.LiveMapType> extends LiveObject<LiveMapData,
       default:
         throw new this._client.ErrorInfo(
           `Invalid ${op.action} op for LiveMap objectId=${this.getObjectId()}`,
-          50000,
+          92000,
           500,
         );
     }
@@ -441,7 +441,7 @@ export class LiveMap<T extends API.LiveMapType> extends LiveObject<LiveMapData,
     if (stateObject.objectId !== this.getObjectId()) {
       throw new this._client.ErrorInfo(
         `Invalid state object: state object objectId=${stateObject.objectId}; LiveMap objectId=${this.getObjectId()}`,
-        50000,
+        92000,
         500,
       );
     }
@@ -449,7 +449,7 @@ export class LiveMap<T extends API.LiveMapType> extends LiveObject<LiveMapData,
     if (stateObject.map?.semantics !== this._semantics) {
       throw new this._client.ErrorInfo(
         `Invalid state object: state object map semantics=${stateObject.map?.semantics}; LiveMap semantics=${this._semantics}`,
-        50000,
+        92000,
         500,
       );
     }
@@ -459,7 +459,7 @@ export class LiveMap<T extends API.LiveMapType> extends LiveObject<LiveMapData,
       if (stateObject.createOp.objectId !== this.getObjectId()) {
         throw new this._client.ErrorInfo(
           `Invalid state object: state object createOp objectId=${stateObject.createOp?.objectId}; LiveMap objectId=${this.getObjectId()}`,
-          50000,
+          92000,
           500,
         );
       }
@@ -467,7 +467,7 @@ export class LiveMap<T extends API.LiveMapType> extends LiveObject<LiveMapData,
       if (stateObject.createOp.action !== StateOperationAction.MAP_CREATE) {
         throw new this._client.ErrorInfo(
           `Invalid state object: state object createOp action=${stateObject.createOp?.action}; LiveMap objectId=${this.getObjectId()}`,
-          50000,
+          92000,
           500,
         );
       }
@@ -475,7 +475,7 @@ export class LiveMap<T extends API.LiveMapType> extends LiveObject<LiveMapData,
       if (stateObject.createOp.map?.semantics !== this._semantics) {
         throw new this._client.ErrorInfo(
           `Invalid state object: state object createOp map semantics=${stateObject.createOp.map?.semantics}; LiveMap semantics=${this._semantics}`,
-          50000,
+          92000,
           500,
         );
       }
@@ -621,7 +621,7 @@ export class LiveMap<T extends API.LiveMapType> extends LiveObject<LiveMapData,
   private _throwNoPayloadError(op: StateOperation): void {
     throw new this._client.ErrorInfo(
       `No payload found for ${op.action} op for LiveMap objectId=${this.getObjectId()}`,
-      50000,
+      92000,
       500,
     );
   }
@@ -643,7 +643,7 @@ export class LiveMap<T extends API.LiveMapType> extends LiveObject<LiveMapData,
     if (this._semantics !== op.map?.semantics) {
       throw new this._client.ErrorInfo(
         `Cannot apply MAP_CREATE op on LiveMap objectId=${this.getObjectId()}; map's semantics=${this._semantics}, but op expected ${op.map?.semantics}`,
-        50000,
+        92000,
         500,
       );
     }
@@ -669,7 +669,7 @@ export class LiveMap<T extends API.LiveMapType> extends LiveObject<LiveMapData,
     if (Utils.isNil(op.data) || (Utils.isNil(op.data.value) && Utils.isNil(op.data.objectId))) {
       throw new ErrorInfo(
         `Invalid state data for MAP_SET op on objectId=${this.getObjectId()} on key=${op.key}`,
-        50000,
+        92000,
         500,
       );
     }
diff --git a/src/plugins/liveobjects/liveobject.ts b/src/plugins/liveobjects/liveobject.ts
index 49d079688..88a4d9953 100644
--- a/src/plugins/liveobjects/liveobject.ts
+++ b/src/plugins/liveobjects/liveobject.ts
@@ -188,11 +188,11 @@ export abstract class LiveObject<
    */
   protected _canApplyOperation(opOriginTimeserial: string | undefined, opSiteCode: string | undefined): boolean {
     if (!opOriginTimeserial) {
-      throw new this._client.ErrorInfo(`Invalid timeserial: ${opOriginTimeserial}`, 50000, 500);
+      throw new this._client.ErrorInfo(`Invalid timeserial: ${opOriginTimeserial}`, 92000, 500);
     }
 
     if (!opSiteCode) {
-      throw new this._client.ErrorInfo(`Invalid site code: ${opSiteCode}`, 50000, 500);
+      throw new this._client.ErrorInfo(`Invalid site code: ${opSiteCode}`, 92000, 500);
     }
 
     const siteTimeserial = this._siteTimeserials[opSiteCode];
diff --git a/src/plugins/liveobjects/liveobjects.ts b/src/plugins/liveobjects/liveobjects.ts
index 7458e3d64..d44002ac8 100644
--- a/src/plugins/liveobjects/liveobjects.ts
+++ b/src/plugins/liveobjects/liveobjects.ts
@@ -467,10 +467,10 @@ export class LiveObjects {
     // channel.modes is only populated on channel attachment, so use it only if it is set,
     // otherwise as a best effort use user provided channel options
     if (this._channel.modes != null && !this._channel.modes.includes(expectedMode)) {
-      throw new this._client.ErrorInfo(`"${expectedMode}" channel mode must be set for this operation`, 40160, 400);
+      throw new this._client.ErrorInfo(`"${expectedMode}" channel mode must be set for this operation`, 40024, 400);
     }
     if (!this._client.Utils.allToLowerCase(this._channel.channelOptions.modes ?? []).includes(expectedMode)) {
-      throw new this._client.ErrorInfo(`"${expectedMode}" channel mode must be set for this operation`, 40160, 400);
+      throw new this._client.ErrorInfo(`"${expectedMode}" channel mode must be set for this operation`, 40024, 400);
     }
   }
 
diff --git a/src/plugins/liveobjects/objectid.ts b/src/plugins/liveobjects/objectid.ts
index 35bd81148..77508f43f 100644
--- a/src/plugins/liveobjects/objectid.ts
+++ b/src/plugins/liveobjects/objectid.ts
@@ -39,25 +39,25 @@ export class ObjectId {
    */
   static fromString(client: BaseClient, objectId: string | null | undefined): ObjectId {
     if (client.Utils.isNil(objectId)) {
-      throw new client.ErrorInfo('Invalid object id string', 50000, 500);
+      throw new client.ErrorInfo('Invalid object id string', 92000, 500);
     }
 
     const [type, rest] = objectId.split(':');
     if (!type || !rest) {
-      throw new client.ErrorInfo('Invalid object id string', 50000, 500);
+      throw new client.ErrorInfo('Invalid object id string', 92000, 500);
     }
 
     if (!['map', 'counter'].includes(type)) {
-      throw new client.ErrorInfo(`Invalid object type in object id: ${objectId}`, 50000, 500);
+      throw new client.ErrorInfo(`Invalid object type in object id: ${objectId}`, 92000, 500);
     }
 
     const [hash, msTimestamp] = rest.split('@');
     if (!hash || !msTimestamp) {
-      throw new client.ErrorInfo('Invalid object id string', 50000, 500);
+      throw new client.ErrorInfo('Invalid object id string', 92000, 500);
     }
 
     if (!Number.isInteger(Number.parseInt(msTimestamp))) {
-      throw new client.ErrorInfo('Invalid object id string', 50000, 500);
+      throw new client.ErrorInfo('Invalid object id string', 92000, 500);
     }
 
     return new ObjectId(type as LiveObjectType, hash, Number.parseInt(msTimestamp));