@dittolive/ditto 4.1.0 → 4.1.1

package/README.md

@@ -3,10 +3,10 @@
 *Ditto is a cross platform SDK that allows mobile, web, and IoT apps to sync
 with and even without connectivity.*
 
-Version: **4.1.0**
+Version: **4.1.1**
 
 Please visit [ditto.live](https://ditto.live) for more info as well as the
-[API Reference](https://software.ditto.live/js/Ditto/4.1.0/api-reference/) for this particular version.
+[API Reference](https://software.ditto.live/js/Ditto/4.1.1/api-reference/) for this particular version.
 
 --------------------------------------------------------------------------------
 

package/node/ditto.cjs.js

@@ -379,10 +379,12 @@ function ditto_validate_document_id(...args) { return ditto.ditto_validate_docum
 function ditto_write_transaction(...args) { return ditto.ditto_write_transaction(...args) }
 function ditto_write_transaction_commit(...args) { return ditto.ditto_write_transaction_commit(...args) }
 function ditto_write_transaction_rollback(...args) { return ditto.ditto_write_transaction_rollback(...args) }
+function getDeadlockTimeout$1(...args) { return ditto.getDeadlockTimeout(...args) }
 function jsDocsToCDocs(...args) { return ditto.jsDocsToCDocs(...args) }
 function mdns_client_free_handle(...args) { return ditto.mdns_client_free_handle(...args) }
 function mdns_server_free_handle(...args) { return ditto.mdns_server_free_handle(...args) }
 function refCStringToString(...args) { return ditto.refCStringToString(...args) }
+function setDeadlockTimeout$1(...args) { return ditto.setDeadlockTimeout(...args) }
 function static_tcp_client_free_handle(...args) { return ditto.static_tcp_client_free_handle(...args) }
 function uninitialized_ditto_make(...args) { return ditto.uninitialized_ditto_make(...args) }
 function verify_license(...args) { return ditto.verify_license(...args) }
@@ -650,9 +652,10 @@ onError) {
     ensureInitialized();
     const collectionNameBuffer = bytesFromString(collectionName);
     const queryBuffer = bytesFromString(query);
-    // Note(Daniel): the callback is now registered to be called in a detached manner:
-    // if the FFI / Rust does `cb()`, then when that call returns, the js callback itself may not
-    // have completed. This is fine, since `signalNext()` shall be the proper way to achieve this.
+    // Note(Daniel): the callback is now registered to be called in a detached
+    // manner: if the FFI / Rust does `cb()`, then when that call returns, the js
+    // callback itself may not have completed. This is fine, since `signalNext()`
+    // shall be the proper way to achieve this.
     const { status_code: errorCode, i64: id } = ditto_live_query_register_str_detached(ditto, collectionNameBuffer, queryBuffer, queryArgsCBOR, orderBy, limit, offset, wrapBackgroundCbForFFI(onError, eventHandler));
     if (errorCode !== 0)
         throw new Error(errorMessage() || `\`ditto_live_query_register_str()\` failed with error code: ${errorCode}`);
@@ -948,6 +951,16 @@ function dittoFree(self) {
     return ditto_free(self);
 }
 /** @internal */
+function getDeadlockTimeout() {
+    ensureInitialized();
+    return getDeadlockTimeout$1();
+}
+/** @internal */
+function setDeadlockTimeout(duration) {
+    ensureInitialized();
+    setDeadlockTimeout$1(duration);
+}
+/** @internal */
 async function dittoRegisterPresenceV1Callback(self, cb) {
     ensureInitialized();
     ditto_register_presence_v1_callback(self, wrapBackgroundCbForFFI((err) => console.error(`The registered presence callback v1 errored with ${err}`), (cJsonStr) => {
@@ -1439,7 +1452,7 @@ function awdlDestroy(awdl) {
 
 // NOTE: this is patched up with the actual build version by Jake task
 // build:package and has to be a valid semantic version as defined here: https://semver.org.
-const fullBuildVersionString = '4.1.0';
+const fullBuildVersionString = '4.1.1';
 
 //
 /**
@@ -2749,6 +2762,11 @@ function augmentJSONValue(json, mutDoc, workingPath) {
         return json;
     }
 }
+/**
+ * Converts objects that may contain instances of classes of this SDK, i.e.
+ * `DocumentID`, `Counter`, `Register` and `Attachment`, into plain JS objects
+ * that can be passed to the FFI layer.
+ */
 function desugarJSObject(jsObj, atRoot = false) {
     if (jsObj && typeof jsObj === 'object') {
         if (Array.isArray(jsObj)) {
@@ -2786,8 +2804,25 @@ function desugarJSObject(jsObj, atRoot = false) {
         }
     }
     else {
+        checkForUnsupportedValues(jsObj);
         return jsObj;
     }
+}
+/**
+ * Throws an error if input is a non-finite float value.
+ *
+ * Workaround while we don't have a reliable way of receiving error messages
+ * from `dittoCore.ditto_collection_insert_value()`.
+ *
+ * See https://github.com/getditto/ditto/issues/8657 for details.
+ *
+ * @param jsObj The object to check.
+ * @throws {Error} If `jsObj` is a non-finite float value.
+ */
+function checkForUnsupportedValues(jsObj) {
+    if (Number.isNaN(jsObj) || jsObj === Infinity || jsObj === -Infinity) {
+        throw new Error('Non-finite float values are not supported');
+    }
 }
 
 //
@@ -6762,12 +6797,59 @@ class Ditto {
         this.attachmentFetcherManager = new AttachmentFetcherManager(this);
         this.transportConditionsManager = new TransportConditionsManager(this);
         this.subscriptionManager = new SubscriptionManager(this);
+        disableDeadlockTimeoutWhenDebugging();
         // WORKAROUND: see description above where the
         // secondsRemainingUntilAuthenticationExpires variable is declared.
         if (secondsRemainingUntilAuthenticationExpires !== null) {
             this.auth['@ditto.authenticationExpiring'](secondsRemainingUntilAuthenticationExpires);
         }
     }
+    /**
+     * Don't terminate the process when callbacks are pending for a long time.
+     *
+     * Some methods in the Ditto library accept asynchronous functions as callback
+     * parameters. If these asynchronous functions do not resolve within a certain
+     * period of time after having been invoked by Ditto, deadlock detection gets
+     * triggered, resulting in the termination of the process.
+     *
+     * When Ditto is executed in a Node.js environment with an interactive
+     * debugger attached, this deadlock detection might get activated upon
+     * encountering a breakpoint. Calling `Ditto.disableDeadlockDetection()`
+     * disables this behavior, thus allowing the use of an interactive debugger
+     * without triggering the deadlock detection.
+     *
+     * This feature is not available in the browser.
+     */
+    static disableDeadlockDetection() {
+        {
+            const current = getDeadlockTimeout();
+            if (current !== 0) {
+                try {
+                    setDeadlockTimeout(0);
+                }
+                catch (e) {
+                    throw new Error(`Failed to disable deadlock detection: ${e === null || e === void 0 ? void 0 : e.message}`);
+                }
+            }
+        }
+    }
+    /**
+     * Returns `true` if deadlock detection is enabled.
+     *
+     * See
+     * {@link Ditto.disableDeadlockDetection | Ditto.disableDeadlockDetection()}
+     * for more information.
+     *
+     * This method always returns `false` in the browser where deadlock detection
+     * is not available.
+     *
+     * @returns `true` if deadlock detection is enabled
+     */
+    static hasDeadlockDetection() {
+        {
+            return getDeadlockTimeout() !== 0;
+        }
+    }
     /**
      * Check if the current environment supports running Ditto.
      *
@@ -6779,7 +6861,7 @@ class Ditto {
      *
      *  Internet Explorer is not supported.
      *
-     * @returns true if the environment is supported
+     * @returns `true` if the environment is supported
      */
     static isEnvironmentSupported() {
         // From https://stackoverflow.com/questions/21825157/internet-explorer-11-detection
@@ -7130,6 +7212,31 @@ const checkAPIs = (_globalObject) => {
     const requiredBrowserAPIs = ['BigInt', 'WeakRef', 'FinalizationRegistry'];
     const globalObject = _globalObject || globalThis || global || window;
     return requiredBrowserAPIs.every((apiName) => !!globalObject[apiName]);
+};
+/**
+ * Disable deadlock timeout when Node.js is running with `--inspect` parameter.
+ *
+ * This heuristic is not failsafe as debugging mode can also be enabled by
+ * sending a `SIGUSR1` signal to the process.
+ *
+ * @internal
+ */
+const disableDeadlockTimeoutWhenDebugging = () => {
+    var _a, _b;
+    {
+        const hasInspector = process && ((_a = process === null || process === void 0 ? void 0 : process.execArgv) === null || _a === void 0 ? void 0 : _a.some((arg) => arg.includes('--inspect') || arg.includes('--debug')));
+        // @ts-ignore - v8debug may be undefined
+        const hasLegacyDebugMode = (process && ((_b = process === null || process === void 0 ? void 0 : process.execArgv) === null || _b === void 0 ? void 0 : _b.some((arg) => arg.includes('--debug')))) || typeof v8debug === 'object';
+        if (hasInspector || hasLegacyDebugMode) {
+            try {
+                setDeadlockTimeout(0);
+                Logger.warning('Detected Node running with inspector enabled, disabling deadlock timeout.');
+            }
+            catch (e) {
+                Logger.error(`Detected Node running with inspector enabled but failed to disable deadlock timeout: ${e === null || e === void 0 ? void 0 : e.message}`);
+            }
+        }
+    }
 };
 
 /**
@@ -7224,6 +7331,7 @@ exports.WriteTransactionPendingCursorOperation = WriteTransactionPendingCursorOp
 exports.WriteTransactionPendingIDSpecificOperation = WriteTransactionPendingIDSpecificOperation;
 exports.addressToString = addressToString;
 exports.checkAPIs = checkAPIs;
+exports.disableDeadlockTimeoutWhenDebugging = disableDeadlockTimeoutWhenDebugging;
 exports.getBridgeLoad = getBridgeLoad;
 exports.init = init;
 exports.validateDocumentIDCBOR = validateDocumentIDCBOR;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dittolive/ditto",
-  "version": "4.1.0",
+  "version": "4.1.1",
   "description": "Ditto is a cross-platform embeddable NoSQL database that can sync with or without an internet connection.",
   "homepage": "https://ditto.live",
   "license": "SEE LICENSE IN LICENSE.md",

package/types/ditto.d.ts

@@ -1919,6 +1919,36 @@ declare class Ditto {
      * @see {@link Ditto.path}
      */
     constructor(identity?: Identity, path?: string);
+    /**
+     * Don't terminate the process when callbacks are pending for a long time.
+     *
+     * Some methods in the Ditto library accept asynchronous functions as callback
+     * parameters. If these asynchronous functions do not resolve within a certain
+     * period of time after having been invoked by Ditto, deadlock detection gets
+     * triggered, resulting in the termination of the process.
+     *
+     * When Ditto is executed in a Node.js environment with an interactive
+     * debugger attached, this deadlock detection might get activated upon
+     * encountering a breakpoint. Calling `Ditto.disableDeadlockDetection()`
+     * disables this behavior, thus allowing the use of an interactive debugger
+     * without triggering the deadlock detection.
+     *
+     * This feature is not available in the browser.
+     */
+    static disableDeadlockDetection(): void;
+    /**
+     * Returns `true` if deadlock detection is enabled.
+     *
+     * See
+     * {@link Ditto.disableDeadlockDetection | Ditto.disableDeadlockDetection()}
+     * for more information.
+     *
+     * This method always returns `false` in the browser where deadlock detection
+     * is not available.
+     *
+     * @returns `true` if deadlock detection is enabled
+     */
+    static hasDeadlockDetection(): boolean;
     /**
      * Check if the current environment supports running Ditto.
      *
@@ -1930,7 +1960,7 @@ declare class Ditto {
      *
      *  Internet Explorer is not supported.
      *
-     * @returns true if the environment is supported
+     * @returns `true` if the environment is supported
      */
     static isEnvironmentSupported(): boolean;
     /**
@@ -2109,6 +2139,15 @@ declare class Ditto {
 }
 /** @internal */
 declare const checkAPIs: (_globalObject?: Window | typeof globalThis) => boolean;
+/**
+ * Disable deadlock timeout when Node.js is running with `--inspect` parameter.
+ *
+ * This heuristic is not failsafe as debugging mode can also be enabled by
+ * sending a `SIGUSR1` signal to the process.
+ *
+ * @internal
+ */
+declare const disableDeadlockTimeoutWhenDebugging: () => void;
 
 /**
  * Represents an attachment and can be used to insert the associated attachment
@@ -3023,5 +3062,5 @@ declare class CBOR {
     static decode(data: Uint8Array): any;
 }
 
-export { Address, Attachment, AttachmentFetchEvent, AttachmentFetchEventCompleted, AttachmentFetchEventDeleted, AttachmentFetchEventProgress, AttachmentFetchEventType, AttachmentFetcher, AttachmentToken, AuthenticationHandler, AuthenticationStatus, Authenticator, BasePendingCursorOperation, BasePendingIDSpecificOperation, CBOR, Collection, CollectionInterface, CollectionsEvent, CollectionsEventParams, CollectionsObservationHandler, ConditionSource, Connection, ConnectionType, Counter, CustomLogCallback, Ditto, Document, DocumentID, DocumentIDValue, DocumentPath, DocumentValue, ExperimentalStore, Identity, IdentityManual, IdentityOfflinePlayground, IdentityOnlinePlayground, IdentityOnlineWithAuthentication, IdentitySharedKey, IdentityTypesRequiringOfflineLicenseToken, InitOptions, KeepAlive, LiveQuery, LiveQueryEvent, LiveQueryEventInitial, LiveQueryEventUpdate, LiveQueryEventUpdateParams, LiveQueryMove, LogLevel, Logger, MutableCounter, MutableDocument, MutableDocumentPath, MutableRegister, NotAvailableAuthenticator, Observer, ObserverOptions, OnlineAuthenticator, Peer, PendingCollectionsOperation, PendingCursorOperation, PendingIDSpecificOperation, Presence, PresenceConnectionType, PresenceGraph, QueryArguments, QueryObservationHandler, Register, RemotePeer, SingleDocumentLiveQueryEvent, SingleObservationHandler, SortDirection, Store, Subscription, TransportCondition, TransportConfig, TransportConfigConnect, TransportConfigGlobal, TransportConfigLan, TransportConfigListen, TransportConfigListenHTTP, TransportConfigListenTCP, TransportConfigPeerToPeer, UpdateResult, UpdateResultType, UpdateResultsMap, UpsertOptions, Value, WebAssemblyModule, WriteStrategy, WriteTransaction, WriteTransactionCollection, WriteTransactionPendingCursorOperation, WriteTransactionPendingIDSpecificOperation, WriteTransactionResult, addressToString, checkAPIs, getBridgeLoad, init, validateDocumentIDCBOR, validateDocumentIDValue };
+export { Address, Attachment, AttachmentFetchEvent, AttachmentFetchEventCompleted, AttachmentFetchEventDeleted, AttachmentFetchEventProgress, AttachmentFetchEventType, AttachmentFetcher, AttachmentToken, AuthenticationHandler, AuthenticationStatus, Authenticator, BasePendingCursorOperation, BasePendingIDSpecificOperation, CBOR, Collection, CollectionInterface, CollectionsEvent, CollectionsEventParams, CollectionsObservationHandler, ConditionSource, Connection, ConnectionType, Counter, CustomLogCallback, Ditto, Document, DocumentID, DocumentIDValue, DocumentPath, DocumentValue, ExperimentalStore, Identity, IdentityManual, IdentityOfflinePlayground, IdentityOnlinePlayground, IdentityOnlineWithAuthentication, IdentitySharedKey, IdentityTypesRequiringOfflineLicenseToken, InitOptions, KeepAlive, LiveQuery, LiveQueryEvent, LiveQueryEventInitial, LiveQueryEventUpdate, LiveQueryEventUpdateParams, LiveQueryMove, LogLevel, Logger, MutableCounter, MutableDocument, MutableDocumentPath, MutableRegister, NotAvailableAuthenticator, Observer, ObserverOptions, OnlineAuthenticator, Peer, PendingCollectionsOperation, PendingCursorOperation, PendingIDSpecificOperation, Presence, PresenceConnectionType, PresenceGraph, QueryArguments, QueryObservationHandler, Register, RemotePeer, SingleDocumentLiveQueryEvent, SingleObservationHandler, SortDirection, Store, Subscription, TransportCondition, TransportConfig, TransportConfigConnect, TransportConfigGlobal, TransportConfigLan, TransportConfigListen, TransportConfigListenHTTP, TransportConfigListenTCP, TransportConfigPeerToPeer, UpdateResult, UpdateResultType, UpdateResultsMap, UpsertOptions, Value, WebAssemblyModule, WriteStrategy, WriteTransaction, WriteTransactionCollection, WriteTransactionPendingCursorOperation, WriteTransactionPendingIDSpecificOperation, WriteTransactionResult, addressToString, checkAPIs, disableDeadlockTimeoutWhenDebugging, getBridgeLoad, init, validateDocumentIDCBOR, validateDocumentIDValue };
 //# sourceMappingURL=ditto.d.ts.map