@dittolive/ditto 4.4.0 → 4.4.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.4.0**
+Version: **4.4.1**
 
 Please visit [ditto.live](https://ditto.live) for more info as well as the
-[API Reference](https://software.ditto.live/js/Ditto/4.4.0/api-reference/) for this particular version.
+[API Reference](https://software.ditto.live/js/Ditto/4.4.1/api-reference/) for this particular version.
 
 --------------------------------------------------------------------------------
 

package/node/ditto.cjs.js

@@ -1521,7 +1521,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.4.0';
+const fullBuildVersionString = '4.4.1';
 
 //
 // Copyright © 2021 DittoLive Incorporated. All rights reserved.
@@ -7908,7 +7908,8 @@ class Ditto {
      * `offlinePlayground` with `appID` being the empty string `''`.
      *
      * @param persistenceDirectory optional string containing a directory path
-     * that Ditto will use for persistence. Defaults to `"ditto"`.
+     * that Ditto will use for persistence. Defaults to `"ditto"`. On Windows,
+     * the path will be automatically normalized.
      *
      * @see {@link Ditto.identity}
      * @see {@link Ditto.persistenceDirectory}
@@ -8152,11 +8153,42 @@ class Ditto {
         }
         {
             const fs = require('fs');
+            const path = require('path');
+            if (process.platform === 'win32') {
+                // Normalize the path on Windows to prevent issues with its max path
+                // length. Windows has a hard limit at 260 characters for file paths
+                // [1]. When this limit is exceeded reads and writes may fail.
+                //
+                // [1]: https://docs.microsoft.com/en-us/windows/win32/fileio/naming-a-file#maximum-path-length-limitation
+                validatedPath = `\\\\?\\${path.resolve(validatedPath)}`;
+            }
+            const absolutePath = path.resolve(validatedPath);
+            // We check if the directory exists before creating it to be able to
+            // provide a more helpful error message in case the directory is not
+            // writable.
+            let isDirectoryExisting = false;
             try {
-                fs.mkdirSync(validatedPath, { recursive: true });
+                fs.statSync(absolutePath);
+                isDirectoryExisting = true;
             }
             catch (error) {
-                throw new Error(`Failed to create persistence directory at '${validatedPath}'`);
+                // On Windows, permissions can prevent us from checking if the directory
+                // exists: https://github.com/nodejs/node/issues/35853
+                if (error.code === 'EPERM') {
+                    throw new Error(`Missing read or write permissions for the persistence directory path '${absolutePath}'. Please update the permissions or use a different path.`);
+                }
+            }
+            if (!isDirectoryExisting) {
+                try {
+                    fs.mkdirSync(absolutePath, { recursive: true });
+                }
+                catch (error) {
+                    throw new Error(`Failed to create persistence directory at path '${absolutePath}'.\n\n${error}`);
+                }
+            }
+            // Caveat: It is still possible that these permissions are revoked during runtime.
+            if (!isDirectoryWritable(absolutePath)) {
+                throw new Error(`Missing read or write permissions for the persistence directory path '${absolutePath}'. Please update the permissions or use a different path.`);
             }
         }
         return validatedPath;
@@ -8535,6 +8567,54 @@ const disableDeadlockTimeoutWhenDebugging = () => {
         }
     }
 };
+/**
+ * Return true if we have read and write permissions for the given directory.
+ *
+ * Always returns `true` in the browser.
+ *
+ * Uses `fs.accessSync()` on all platforms except Windows, where ACLs are not
+ * checked by that method [1]. On Windows, we try writing and removing a temp
+ * file to the given path instead.
+ *
+ * [1]:
+ * https://nodejs.org/docs/latest-v18.x/api/fs.html#fsaccesspath-mode-callback
+ *
+ * @internal
+ */
+const isDirectoryWritable = (directoryPath) => {
+    {
+        const fs = require('fs');
+        const path = require('path');
+        if (process.platform === 'win32') {
+            const persistenceDirectory = path.resolve(directoryPath);
+            const testFilePath = path.join(persistenceDirectory, 'ditto-permissions-test.txt');
+            const testFileContents = 'permissions test';
+            try {
+                fs.writeFileSync(testFilePath, testFileContents);
+                const fileContents = fs.readFileSync(testFilePath, 'utf8');
+                if (fileContents !== testFileContents) {
+                    Logger.debug(`Failed to read back test file contents, expected '${testFileContents}' but got '${fileContents}'`);
+                    return false;
+                }
+                fs.unlinkSync(testFilePath);
+            }
+            catch (error) {
+                Logger.debug(`Failed to access persistence directory: ${error === null || error === void 0 ? void 0 : error.message}`);
+                return false;
+            }
+        }
+        else {
+            try {
+                fs.accessSync(directoryPath, fs.constants.W_OK | fs.constants.R_OK);
+            }
+            catch (error) {
+                Logger.debug(`Failed to access persistence directory: ${error === null || error === void 0 ? void 0 : error.message}`);
+                return false;
+            }
+        }
+    }
+    return true;
+};
 
 /**
  * Get a count of bridged objects binned by bridge type.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dittolive/ditto",
-  "version": "4.4.0",
+  "version": "4.4.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

@@ -1970,7 +1970,8 @@ declare class Ditto {
      * `offlinePlayground` with `appID` being the empty string `''`.
      *
      * @param persistenceDirectory optional string containing a directory path
-     * that Ditto will use for persistence. Defaults to `"ditto"`.
+     * that Ditto will use for persistence. Defaults to `"ditto"`. On Windows,
+     * the path will be automatically normalized.
      *
      * @see {@link Ditto.identity}
      * @see {@link Ditto.persistenceDirectory}