@osdk/client 2.1.0-beta.3 → 2.1.0-beta.31

package/build/esm/objectSet/ObjectSetListenerWebsocket.js

@@ -13,25 +13,28 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 import WebSocket from "isomorphic-ws";
 import invariant from "tiny-invariant";
-import { convertWireToOsdkObjects } from "../object/convertWireToOsdkObjects.js";
-const ONE_DAY_MS = 24 * 60 * 60 * 1000;
 const MINIMUM_RECONNECT_DELAY_MS = 5 * 1000;
+
 /** Noop function to reduce conditional checks */
 function doNothing() {}
+
 /**
  * Converts an ObjectSetListener to one where all the functions are defined.
  */
 function fillOutListener({
   onChange = doNothing,
   onError = doNothing,
-  onOutOfDate = doNothing
+  onOutOfDate = doNothing,
+  onSuccessfulSubscription = doNothing
 }) {
   return {
     onChange,
     onError,
-    onOutOfDate
+    onOutOfDate,
+    onSuccessfulSubscription
   };
 }
 function isReady(sub) {
@@ -40,11 +43,10 @@ function isReady(sub) {
 function subscriptionIsDone(sub) {
   return sub.status === "done" || sub.status === "error";
 }
+
 /** @internal */
 export class ObjectSetListenerWebsocket {
   static #instances = new WeakMap();
-  OBJECT_SET_EXPIRY_MS;
-  MINIMUM_RECONNECT_DELAY_MS;
   // FIXME
   static getInstance(client) {
     let instance = ObjectSetListenerWebsocket.#instances.get(client.clientCacheKey);
@@ -58,55 +60,62 @@ export class ObjectSetListenerWebsocket {
   #lastWsConnect = 0;
   #client;
   #logger;
+
   /**
    * map of requestId to all active subscriptions at the time of the request
    */
   #pendingSubscriptions = new Map();
+
   /**
    * Map of subscriptionId to Subscription. Note: the subscriptionId may be
    * temporary and not the actual subscriptionId from the server.
    */
   #subscriptions = new Map();
+  #endedSubscriptions = new Set();
   #maybeDisconnectTimeout;
+
   // DO NOT CONSTRUCT DIRECTLY. ONLY EXPOSED AS A TESTING SEAM
   constructor(client, {
-    objectSetExpiryMs = ONE_DAY_MS,
     minimumReconnectDelayMs = MINIMUM_RECONNECT_DELAY_MS
   } = {}) {
-    this.OBJECT_SET_EXPIRY_MS = objectSetExpiryMs;
     this.MINIMUM_RECONNECT_DELAY_MS = minimumReconnectDelayMs;
     this.#client = client;
     this.#logger = client.logger?.child({}, {
       msgPrefix: "<OSW> "
     });
-    !(client.baseUrl.startsWith("https://") || client.baseUrl.startsWith("http://")) ? invariant(false, "Stack must be a URL") : void 0;
+    !(client.baseUrl.startsWith("https://") || client.baseUrl.startsWith("http://")) ? process.env.NODE_ENV !== "production" ? invariant(false, "Stack must be a URL") : invariant(false) : void 0;
   }
-  async subscribe(objectType, objectSet, listener, properties) {
-    // Node 18 does not expose 'crypto' on globalThis, so we need to do it ourselves. This
-    // will not be needed after our minimum version is 19 or greater.
-    globalThis.crypto ??= (await import("node:crypto")).webcrypto;
-    const objDef = await this.#client.ontologyProvider.getObjectDefinition(objectType.apiName);
-    const objectProperties = properties.filter(p => objDef.properties[p].type !== "geotimeSeriesReference");
-    const referenceProperties = properties.filter(p => objDef.properties[p].type === "geotimeSeriesReference");
+  async subscribe(objectType, objectSet, listener, properties = []) {
+    const objOrInterfaceDef = objectType.type === "object" ? await this.#client.ontologyProvider.getObjectDefinition(objectType.apiName) : await this.#client.ontologyProvider.getInterfaceDefinition(objectType.apiName);
+    let objectProperties = [];
+    let referenceProperties = [];
+    if (properties.length === 0) {
+      properties = Object.keys(objOrInterfaceDef.properties);
+    }
+    objectProperties = properties.filter(p => objOrInterfaceDef.properties[p].type !== "geotimeSeriesReference");
+    referenceProperties = properties.filter(p => objOrInterfaceDef.properties[p].type === "geotimeSeriesReference");
     const sub = {
       listener: fillOutListener(listener),
       objectSet,
-      primaryKeyPropertyName: objDef.primaryKeyApiName,
+      primaryKeyPropertyName: objOrInterfaceDef.type === "interface" ? undefined : objOrInterfaceDef.primaryKeyApiName,
       requestedProperties: objectProperties,
       requestedReferenceProperties: referenceProperties,
       status: "preparing",
       // Since we don't have a real subscription id yet but we need to keep
       // track of this reference, we can just use a random uuid.
-      subscriptionId: `TMP-${crypto.randomUUID()}`
+      subscriptionId: `TMP-${nextUuid()}}`,
+      interfaceApiName: objOrInterfaceDef.type === "object" ? undefined : objOrInterfaceDef.apiName
     };
     this.#subscriptions.set(sub.subscriptionId, sub);
+
     // actually prepares the subscription, ensures the ws is ready, and sends
     // a subscribe message. We don't want to block on this.
-    this.#initiateSubscribe(sub);
+    void this.#initiateSubscribe(sub);
     return () => {
       this.#unsubscribe(sub);
     };
   }
+
   /**
    * Called at least once for every subscription.
    *
@@ -117,18 +126,12 @@ export class ObjectSetListenerWebsocket {
    * @returns
    */
   async #initiateSubscribe(sub) {
-    if (process?.env?.NODE_ENV !== "production") {
+    if (process.env.NODE_ENV !== "production") {
       this.#logger?.trace("#initiateSubscribe()");
     }
-    if (sub.expiry) {
-      clearTimeout(sub.expiry);
-    }
-    // expiry is tied to the temporary object set, which is set to `timeToLive: "ONE_DAY"`
-    // in `#createTemporaryObjectSet`. They should be in sync
-    sub.expiry = setTimeout(() => this.#expire(sub), this.OBJECT_SET_EXPIRY_MS);
-    await this.#client.ontologyRid;
     try {
       await this.#ensureWebsocket();
+
       // the consumer may have already unsubscribed before we are ready to request a subscription
       // so we have to acquire the pendingSubscription after the await.
       if (subscriptionIsDone(sub)) {
@@ -141,27 +144,21 @@ export class ObjectSetListenerWebsocket {
       }
     } catch (error) {
       this.#logger?.error(error, "Error in #initiateSubscribe");
-      sub.listener.onError([error]);
+      this.#tryCatchOnError(sub, true, error);
     }
   }
   #sendSubscribeMessage() {
-    if (process?.env?.NODE_ENV !== "production") {
+    if (process.env.NODE_ENV !== "production") {
       this.#logger?.trace("#sendSubscribeMessage()");
     }
     // If two calls to `.subscribe()` happen at once (or if the connection is reset),
     // we may have multiple subscriptions that don't have a subscriptionId yet,
     // so we filter those out.
     const readySubs = [...this.#subscriptions.values()].filter(isReady);
-    if (readySubs.length === 0) {
-      if (process?.env?.NODE_ENV !== "production") {
-        this.#logger?.trace("#sendSubscribeMessage(): aborting due to no ready subscriptions");
-      }
-      return;
-    }
-    // Assumes the node 18 crypto fallback to globalThis in `subscribe` has happened.
-    const id = crypto.randomUUID();
+    const id = nextUuid();
     // responses come back as an array of subIds, so we need to know the sources
     this.#pendingSubscriptions.set(id, readySubs);
+
     // every subscribe message "overwrites" the previous ones that are not
     // re-included, so we have to reconstitute the entire list of subscriptions
     const subscribe = {
@@ -169,7 +166,8 @@ export class ObjectSetListenerWebsocket {
       requests: readySubs.map(({
         objectSet,
         requestedProperties,
-        requestedReferenceProperties
+        requestedReferenceProperties,
+        interfaceApiName
       }) => {
         return {
           objectSet: objectSet,
@@ -178,37 +176,26 @@ export class ObjectSetListenerWebsocket {
         };
       })
     };
-    if (process?.env?.NODE_ENV !== "production") {
+    if (process.env.NODE_ENV !== "production") {
       this.#logger?.trace({
         payload: subscribe
       }, "sending subscribe message");
     }
     this.#ws?.send(JSON.stringify(subscribe));
   }
-  #expire(sub) {
-    if (process?.env?.NODE_ENV !== "production") {
-      this.#logger?.trace({
-        subscription: sub
-      }, "#expire()");
-    }
-    // the temporary ObjectSet has expired, we should re-subscribe which will cause the
-    // listener to get an onOutOfDate message when it becomes subscribed again
-    sub.status = "expired";
-    this.#initiateSubscribe(sub);
-  }
   #unsubscribe(sub, newStatus = "done") {
     if (subscriptionIsDone(sub)) {
       // if we are already done, we don't need to do anything
       return;
     }
     sub.status = newStatus;
+
     // make sure listeners do nothing now
     sub.listener = fillOutListener({});
-    if (sub.expiry) {
-      clearTimeout(sub.expiry);
-      sub.expiry = undefined;
-    }
     this.#subscriptions.delete(sub.subscriptionId);
+    this.#endedSubscriptions.add(sub.subscriptionId);
+    this.#sendSubscribeMessage();
+
     // If we have no more subscriptions, we can disconnect the websocket
     // however we should wait a bit to see if we get any more subscriptions.
     // For example, when switching between react views, you may unsubscribe
@@ -238,9 +225,9 @@ export class ObjectSetListenerWebsocket {
         baseUrl,
         tokenProvider
       } = this.#client;
-      const base = new URL(baseUrl);
-      const url = `wss://${base.host}/api/v2/ontologySubscriptions/ontologies/${this.#client.ontologyRid}/streamSubscriptions`;
+      const url = constructWebsocketUrl(baseUrl, await this.#client.ontologyRid);
       const token = await tokenProvider();
+
       // tokenProvider is async, there could potentially be a race to create the websocket.
       // Only the first call to reach here will find a null this.#ws, the rest will bail out
       if (this.#ws == null) {
@@ -253,9 +240,10 @@ export class ObjectSetListenerWebsocket {
           });
         }
         this.#lastWsConnect = Date.now();
+
         // we again may have lost the race after our minimum backoff time
         if (this.#ws == null) {
-          if (process?.env?.NODE_ENV !== "production") {
+          if (process.env.NODE_ENV !== "production") {
             this.#logger?.trace("Creating websocket");
           }
           this.#ws = new WebSocket(url, [`Bearer-${token}`]);
@@ -295,38 +283,38 @@ export class ObjectSetListenerWebsocket {
   };
   #onMessage = async message => {
     const data = JSON.parse(message.data.toString());
-    if (process?.env?.NODE_ENV !== "production") {
+    if (process.env.NODE_ENV !== "production") {
       this.#logger?.trace({
         payload: data
       }, "received message from ws");
     }
     switch (data.type) {
       case "objectSetChanged":
-        return this.#handleMessage_objectSetChanged(data);
+        return void this.#handleMessage_objectSetChanged(data);
       case "refreshObjectSet":
-        return this.#handleMessage_refreshObjectSet(data);
+        return void this.#handleMessage_refreshObjectSet(data);
       case "subscribeResponses":
-        return this.#handleMessage_subscribeResponses(data);
+        return void this.#handleMessage_subscribeResponses(data);
       case "subscriptionClosed":
         {
-          return this.#handleMessage_subscriptionClosed(data);
+          return void this.#handleMessage_subscriptionClosed(data);
         }
       default:
-        invariant(false, "Unexpected message type");
+        process.env.NODE_ENV !== "production" ? invariant(false, "Unexpected message type") : invariant(false);
     }
   };
   #handleMessage_objectSetChanged = async payload => {
     const sub = this.#subscriptions.get(payload.id);
-    !sub ? invariant(false, `Expected subscription id ${payload.id}`) : void 0;
+    if (sub == null) return;
     const objectUpdates = payload.updates.filter(update => update.type === "object");
     const referenceUpdates = payload.updates.filter(update => update.type === "reference");
     const osdkObjectsWithReferenceUpdates = await Promise.all(referenceUpdates.map(async o => {
-      const osdkObjectArray = await convertWireToOsdkObjects(this.#client, [{
+      const osdkObjectArray = await this.#client.objectFactory2(this.#client, [{
         __apiName: o.objectType,
-        __primaryKey: o.primaryKey[sub.primaryKeyPropertyName],
+        __primaryKey: sub.primaryKeyPropertyName != null ? o.primaryKey[sub.primaryKeyPropertyName] : undefined,
         ...o.primaryKey,
         [o.property]: o.value
-      }], undefined);
+      }], sub.interfaceApiName, false, undefined, false, await this.#fetchInterfaceMapping(o.objectType, sub.interfaceApiName));
       const singleOsdkObject = osdkObjectArray[0] ?? undefined;
       return singleOsdkObject != null ? {
         object: singleOsdkObject,
@@ -335,7 +323,12 @@ export class ObjectSetListenerWebsocket {
     }));
     for (const osdkObject of osdkObjectsWithReferenceUpdates) {
       if (osdkObject != null) {
-        sub.listener.onChange?.(osdkObject);
+        try {
+          sub.listener.onChange?.(osdkObject);
+        } catch (error) {
+          this.#logger?.error(error, "Error in onChange callback");
+          this.#tryCatchOnError(sub, false, error);
+        }
       }
     }
     const osdkObjects = await Promise.all(objectUpdates.map(async o => {
@@ -343,7 +336,7 @@ export class ObjectSetListenerWebsocket {
       for (const key of keysToDelete) {
         delete o.object[key];
       }
-      const osdkObjectArray = await convertWireToOsdkObjects(this.#client, [o.object], undefined);
+      const osdkObjectArray = await this.#client.objectFactory2(this.#client, [o.object], sub.interfaceApiName, false, undefined, false, await this.#fetchInterfaceMapping(o.object.__apiName, sub.interfaceApiName));
       const singleOsdkObject = osdkObjectArray[0] ?? undefined;
       return singleOsdkObject != null ? {
         object: singleOsdkObject,
@@ -352,14 +345,33 @@ export class ObjectSetListenerWebsocket {
     }));
     for (const osdkObject of osdkObjects) {
       if (osdkObject != null) {
-        sub.listener.onChange?.(osdkObject);
+        try {
+          sub.listener.onChange?.(osdkObject);
+        } catch (error) {
+          this.#logger?.error(error, "Error in onChange callback");
+          this.#tryCatchOnError(sub, false, error);
+        }
       }
     }
   };
+  async #fetchInterfaceMapping(objectTypeApiName, interfaceApiName) {
+    if (interfaceApiName == null) return {};
+    const interfaceMap = (await this.#client.ontologyProvider.getObjectDefinition(objectTypeApiName)).interfaceMap;
+    return {
+      [interfaceApiName]: {
+        [objectTypeApiName]: interfaceMap[interfaceApiName]
+      }
+    };
+  }
   #handleMessage_refreshObjectSet = payload => {
     const sub = this.#subscriptions.get(payload.id);
-    !sub ? invariant(false, `Expected subscription id ${payload.id}`) : void 0;
-    sub.listener.onOutOfDate();
+    !sub ? process.env.NODE_ENV !== "production" ? invariant(false, `Expected subscription id ${payload.id}`) : invariant(false) : void 0;
+    try {
+      sub.listener.onOutOfDate();
+    } catch (error) {
+      this.#logger?.error(error, "Error in onOutOfDate callback");
+      this.#tryCatchOnError(sub, false, error);
+    }
   };
   #handleMessage_subscribeResponses = payload => {
     const {
@@ -367,14 +379,14 @@ export class ObjectSetListenerWebsocket {
       responses
     } = payload;
     const subs = this.#pendingSubscriptions.get(id);
-    !subs ? invariant(false, `should have a pending subscription for ${id}`) : void 0;
+    !subs ? process.env.NODE_ENV !== "production" ? invariant(false, `should have a pending subscription for ${id}`) : invariant(false) : void 0;
     this.#pendingSubscriptions.delete(id);
     for (let i = 0; i < responses.length; i++) {
       const sub = subs[i];
       const response = responses[i];
       switch (response.type) {
         case "error":
-          sub.listener.onError(response.errors);
+          this.#tryCatchOnError(sub, true, response.errors);
           this.#unsubscribe(sub, "error");
           break;
         case "qos":
@@ -384,7 +396,7 @@ export class ObjectSetListenerWebsocket {
         case "success":
           // `"preparing"` should only be the status on an initial subscribe.
           const shouldFireOutOfDate = sub.status === "expired" || sub.status === "reconnecting";
-          if (process?.env?.NODE_ENV !== "production") {
+          if (process.env.NODE_ENV !== "production") {
             this.#logger?.trace({
               shouldFireOutOfDate
             }, "success");
@@ -396,21 +408,27 @@ export class ObjectSetListenerWebsocket {
             sub.subscriptionId = response.id;
             this.#subscriptions.set(sub.subscriptionId, sub); // future messages come by this subId
           }
-          if (shouldFireOutOfDate) sub.listener.onOutOfDate();
+          try {
+            if (shouldFireOutOfDate) sub.listener.onOutOfDate();else sub.listener.onSuccessfulSubscription();
+          } catch (error) {
+            this.#logger?.error(error, "Error in onOutOfDate or onSuccessfulSubscription callback");
+            this.#tryCatchOnError(sub, false, error);
+          }
           break;
         default:
-          sub.listener.onError(response);
+          this.#tryCatchOnError(sub, true, response);
       }
     }
   };
   #handleMessage_subscriptionClosed(payload) {
     const sub = this.#subscriptions.get(payload.id);
-    !sub ? invariant(false, `Expected subscription id ${payload.id}`) : void 0;
-    sub.listener.onError([payload.cause]);
+    if (sub == null && this.#endedSubscriptions.has(payload.id)) return;
+    !sub ? process.env.NODE_ENV !== "production" ? invariant(false, `Expected subscription id ${payload.id}`) : invariant(false) : void 0;
+    this.#tryCatchOnError(sub, true, payload.cause);
     this.#unsubscribe(sub, "error");
   }
   #onClose = event => {
-    if (process?.env?.NODE_ENV !== "production") {
+    if (process.env.NODE_ENV !== "production") {
       this.#logger?.trace({
         event
       }, "Received close event from ws", event);
@@ -428,18 +446,54 @@ export class ObjectSetListenerWebsocket {
       }
       this.#ws = undefined;
     }
+
     // if we have any listeners that are still depending on us, go ahead and reopen the websocket
     if (this.#subscriptions.size > 0) {
-      if (process?.env?.NODE_ENV !== "production") {
+      if (process.env.NODE_ENV !== "production") {
         for (const s of this.#subscriptions.values()) {
-          !(s.status !== "done" && s.status !== "error") ? invariant(false, "should not have done/error subscriptions still") : void 0;
+          !(s.status !== "done" && s.status !== "error") ? process.env.NODE_ENV !== "production" ? invariant(false, "should not have done/error subscriptions still") : invariant(false) : void 0;
         }
       }
       for (const s of this.#subscriptions.values()) {
         if (s.status === "subscribed") s.status = "reconnecting";
       }
-      this.#ensureWebsocket();
+
+      // we don't care about the result of this (we want cycleWebsocket to be fire and forget)
+      // just that it happens
+      void this.#ensureWebsocket();
     }
   };
+  #tryCatchOnError = (sub, subscriptionClosed, error) => {
+    try {
+      sub.listener.onError({
+        subscriptionClosed: subscriptionClosed,
+        error
+      });
+    } catch (onErrorError) {
+      // eslint-disable-next-line no-console
+      console.error(`Error encountered in an onError callback for an OSDK subscription`, onErrorError);
+      // eslint-disable-next-line no-console
+      console.error(`This onError call was triggered by an error in another callback`, error);
+      // eslint-disable-next-line no-console
+      console.error(`The subscription has been closed.`, error);
+      if (!subscriptionClosed) {
+        this.#logger?.error(error, "Error in onError callback");
+        this.#unsubscribe(sub, "error");
+        this.#tryCatchOnError(sub, true, onErrorError);
+      }
+    }
+  };
+}
+
+/** @internal */
+export function constructWebsocketUrl(baseUrl, ontologyRid) {
+  const base = new URL(baseUrl);
+  const url = new URL(`api/v2/ontologySubscriptions/ontologies/${ontologyRid}/streamSubscriptions`, base);
+  url.protocol = url.protocol.replace("https", "wss");
+  return url;
+}
+let uuidCounter = 0;
+function nextUuid() {
+  return `00000000-0000-0000-0000-${(uuidCounter++).toString().padStart(12, "0")}`;
 }
 //# sourceMappingURL=ObjectSetListenerWebsocket.js.map