Increases anti-lock timeout to avoid 'Locked !?!?' file-lock errors (…

…see #90) (#112)

* Armadietto is prone to 'Locked !?!?' file-lock errors in real world situations:  the timeout of 200ms is insufficient when batch putting or getting.

Provide file lock timeout flexibility and make gets non-locking:  just cross-checking etag before and after.

* Skip node 12.

* Add hosted load test link.

* Sets default lock timeout to 30 seconds

---------

Co-authored-by: Jakub Ner <[email protected]>

.github/workflows/publish.yml

@@ -21,7 +21,7 @@ jobs:
     strategy:
       matrix:
         # Support LTS versions based on https://nodejs.org/en/about/releases/
-        node-version: ['12', '14', '16']
+        node-version: ['18', '20', '21']
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2

.github/workflows/test-and-lint.yml

@@ -24,4 +24,3 @@ jobs:
         run: npm run lint
       - name: Run tests
         run: npm test
-

README.md

@@ -188,6 +188,17 @@ const server = new Armadietto({
 server.boot();
 ```
 
+## Lock file contention
+
+The data-access locking mechanism is lock-file based.
+
+You may need to tune the lock-file timeouts in your configuration:
+
+- *lock_timeout_ms* - millis to wait for lock file to be available
+- *lock_stale_after_ms* - millis to wait to deem lockfile stale
+
+To tune run the [hosted RS load test](https://overhide.github.io/armadietto/example/load.html) or follow instructions in [example/README.md](example/README.md) for local setup and subsequently run [example/load.html](example/load.html) off of `npm run serve` therein.
+
 ## Debugging an installation
 
 Set the environment `DEBUG` to enable logging.  For example `DEBUG=true armadietto -c /etc/armadietto/conf.json`

bin/armadietto.js

@@ -53,7 +53,7 @@ const remoteStorageServer = {
     }
 
     process.umask(0o077);
-    const store = new Armadietto.FileTree({ path: conf.storage_path });
+    const store = new Armadietto.FileTree({ path: conf.storage_path, lock_timeout_ms: conf.lock_timeout_ms, lock_stale_after_ms: conf.lock_stale_after_ms });
     const server = new Armadietto({
       basePath: conf.basePath,
       store,

bin/dev-conf.json

@@ -2,6 +2,8 @@
   "basePath": "",
   "allow_signup": true,
   "storage_path": "./dev-storage",
+  "lock_timeout_ms": 30000,
+  "lock_stale_after_ms": 60000,
   "cache_views": true,
   "http": {
     "host": "127.0.0.1",

contrib/openwrt/README.md

@@ -14,7 +14,7 @@ See [TLS certificates for a server](https://openwrt.org/docs/guide-user/services
 We assume that you already issued a cert
 
 To store data you need to mount a disk.
-See [Quick Start for Adding a USB drive](https://openwrt.org/docs/guide-user/storage/usb-drives-quickstart). 
+See [Quick Start for Adding a USB drive](https://openwrt.org/docs/guide-user/storage/usb-drives-quickstart).
 
 In the example it's mounted to /mnt/disk/
 Next we need to create a folder to store the user data. Login to OpenWrt with `ssh [email protected]` and execute:

example/index.html

@@ -4,8 +4,8 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width" />
     <title>RemoteStorage Demo</title>
-    <script type="text/javascript" src="../node_modules/remotestoragejs/release/remotestorage.js"></script>
-    <script src="../node_modules/remotestorage-widget/build/widget.js"></script>
+    <script src="https://cdn.jsdelivr.net/npm/remotestoragejs@latest/release/remotestorage.js"></script>
+    <script src="https://cdn.jsdelivr.net/npm/remotestorage-widget@latest/build/widget.js"></script>
 
     <!-- ignore below :: code pane / logging  pane setup -->
     <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script> <!-- only needed for logging and code panes -->