ldn-inbox-server 1.8.2 → 1.8.4

package/.dockerignore

@@ -0,0 +1,10 @@
+node_modules
+npm-debug.log
+Dockerfile
+.env
+.dockerignore
+.git
+.gitignore
+ecosystem.config.js
+output/*.jsonld
+inbox/*.jsonld

package/.env-docker

@@ -0,0 +1,16 @@
+LOG4JS=INFO
+LDN_SERVER_HOST=0.0.0.0
+LDN_SERVER_PORT=8000
+LDN_SERVER_INBOX_GLOB="^.*\.jsonld$"
+LDN_SERVER_BASEURL=http://0.0.0.0:8000
+LDN_SERVER_INBOX_BATH_SIZE=5
+LDN_SERVER_LOCKDIR=.lockdir
+LDN_SERVER_INBOX_URL=inbox/
+LDN_SERVER_INBOX_PATH=./inbox
+LDN_SERVER_ERROR_PATH=./error
+LDN_SERVER_OUTBOX_PATH=./outbox
+LDN_SERVER_PUBLIC_PATH=./public
+#LDN_SERVER_JSON_SCHEMA=./config/notification_schema.json
+LDN_SERVER_INBOX_CONFIG=./config/inbox_config.json
+LDN_SERVER_OUTBOX_CONFIG=./config/outbox_config.json
+LDN_SERVER_HAS_PUBLIC_INBOX=1

package/Dockerfile

@@ -0,0 +1,19 @@
+FROM node:18-alpine3.20
+
+ENV NODE_ENV=production
+
+WORKDIR /app
+
+COPY .env-docker ./.env
+
+COPY ecosystem.config.js-example ./ecosystem.config.js
+
+COPY package*.json ./
+
+RUN npm install && npm install -g pm2
+
+COPY . .
+
+EXPOSE 8000
+
+CMD [ "pm2-runtime" , "start", "ecosystem.config.js" ]

package/README.md

@@ -272,6 +272,26 @@ Generate a ISO8601 date time string.
 Parse a path containing `.json` | `.jsonld` | `.json5` | `.yaml` | `.yml` into a
 JavaScript object.
 
+## Docker
+
+Pull 
+
+```
+docker pull hochstenbach/ldn-inbox-server:v0.0.1
+```
+
+```
+docker run -p 8000:8000 hochstenbach/ldn-inbox-server:v0.0.1
+```
+
+Post a notification:
+
+```
+curl -X POST -H 'Content-Type: application/ld+json' --data-binary '@examples/offer.jsonld' http://localhost:8000/inbox/
+```
+
+Check the inbox: http://localhost:8000/inbox/
+
 ## See also
 
 - [mellon-server](https://www.npmjs.com/package/mellon-server)

package/config/inbox_config.json

@@ -27,7 +27,7 @@
                  },
                  {
                     "id": "@handler/notification_handler/offer_memento.js",
-                    "$sequential": true,
+                    "$lock": true,
                     "actor": {
                         "id": "http://localhost:8000/profile/card#me" ,
                         "inbox": "http://localhost:8000/inbox/" ,

package/ecosystem.config.js-example

@@ -3,14 +3,6 @@ module.exports = {
    {
     name   : "ldn-inbox-server",
     script : "./bin/ldn-inbox-server.js start-server"
-   } ,
-   {
-    name   : "ldn-inbox-inbox",
-    script : "LOG4JS=info ./bin/ldn-inbox-server.js handler @inbox --loop 20 -hn ./handler/notification_handler/multi.js"
-   } ,
-   {
-    name   : "ldn-inbox-outbox",
-    script : "LOG4JS=info ./bin/ldn-inbox-server.js handler @outbox --loop 20 -hn ./handler/notification_handler/multi.js"
    } 
  ]
 }

package/handler/notification_handler/multi.js

@@ -13,8 +13,8 @@ const md5 = require('md5');
  * need to run on an notifiction message. The inner array defines the steps: a
  * sequence of handlers that need to success.
  * 
- * Optionally a configuration for a handler can contain the property `$sequential` set
- * to true to force the sequential execution of this handler.
+ * Optionally a configuration for a handler can contain the property `$lock` set
+ * to true to force the singular execution of this handler.
  */
 async function handle({path,options,_,notification}) {
     let success = false;
@@ -70,7 +70,11 @@ async function handle({path,options,_,notification}) {
                     return await handler({path,options,config,notification});
                 });
             
-                if (result['break']) {
+                if (! result) {
+                    logger.error(`workflow[${i}] : failed ${step} (no results)`);
+                    thisWorkflow = result['failure'];
+                }
+                else if (result['break']) {
                     logger.info(`workflow[${i}] : breaks ${step} with ${result['success']}`);
                     thisWorkflow = result['success'];
                 }
@@ -140,8 +144,10 @@ async function handle({path,options,_,notification}) {
 }
 
 async function maybeLock(step,config,callback) {
-    if (config['$sequential']) {
-        const lockDir = process.env.LDN_SERVER_LOCKDIR || '.lockdir';
+    if (config['$lock']) {
+        const lockDir = process.env.LDN_SERVER_LOCK_DIR || '.lockdir';
+        const lockStale = process.env.LDN_SERVER_LOCK_STALE || 10000;
+        const lockRetries = process.env.LDN_SERVER_LOCK_RETRIES || 10;
 
         if (! fs.existsSync(lockDir)) {
             logger.debug(`creating lock dir ${lockDir}`);
@@ -155,15 +161,22 @@ async function maybeLock(step,config,callback) {
             fs.writeFileSync(lockFile,'');
         }
         
-        logger.debug(`locking ${step} using ${lockFile}`);
+        let result = null;
+
+        try {
+            logger.debug(`locking ${step} using ${lockFile}`);
 
-        const unlock = await lockfile.lock(lockFile);
+            const unlock = await lockfile.lock(lockFile, { stale : lockStale , retries: lockRetries });
 
-        const result = await callback();
+            result = await callback();
 
-        logger.debug(`unlocking ${step} from ${lockFile}`);
+            logger.debug(`unlocking ${step} from ${lockFile}`);
 
-        unlock();
+            unlock();
+        }
+        catch (e) {
+            logger.error(`lock failed: ${e.message}`);
+        }
 
         return result;
     }

package/lib/util.js

@@ -122,10 +122,10 @@ function moveTo(path,destination) {
 
     const newPath = destPath + '/' + fsPath.basename(path);
 
-    fs.rename(fsPath.resolve(path), fsPath.resolve(newPath), function (err) {
-        if (err) throw err
-        logger.info(`moving ${path} to${newPath}`);
-    });
+    fs.copyFileSync(fsPath.resolve(path),fsPath.resolve(newPath));
+    fs.unlinkSync(fsPath.resolve(path));
+    
+    logger.info(`moving ${path} to${newPath}`);
 }
 
 function dynamic_handler(handler,fallback) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ldn-inbox-server",
-  "version": "1.8.2",
+  "version": "1.8.4",
   "description": "A demonstration Event Notifications Inbox server",
   "main": "lib/index.js",
   "author": "Patrick Hochstenbach <Patrick.Hochstenbach@UGent.be>",