cloudcms-server 3.3.1-beta.9 → 4.0.0-beta.2

package/LICENSE

@@ -1,6 +1,6 @@
 Cloud CMS Application Server Module
 
-Copyright 2019 Gitana Software, Inc.
+Copyright 2022 Gitana Software, Inc.
 
 Licensed under the Apache License, Version 2.0 (the "License"); 
 you may not use this file except in compliance with the License. 

package/README.md

@@ -13,7 +13,7 @@ This looks like:
 
 ````
 {
-    "setup": "single", // single, cluster, sticky-cluster
+    "setup": "single", // single, cluster, redis
     "name": "Cloud CMS Application Server",
     "socketFunctions": [],
     "routeFunctions": [],

package/broadcast/broadcast.js

@@ -11,10 +11,13 @@ module.exports = function()
         var self = this;
 
         // set up defaults
-        if (!process.env.CLOUDCMS_BROADCAST_TYPE) {
+        if (!process.env.CLOUDCMS_BROADCAST_TYPE)
+        {
             process.env.CLOUDCMS_BROADCAST_TYPE = "local";
-
-            if (process.configuration.setup !== "single") {
+    
+            // auto-configure
+            if (process.env.CLOUDCMS_LAUNCHPAD_SETUP === "redis")
+            {
                 process.env.CLOUDCMS_BROADCAST_TYPE = "redis";
             }
         }

package/broadcast/providers/redis.js

@@ -1,8 +1,7 @@
-var path = require("path");
+var redisClientFactory = require("../../clients/redis");
+var redisHelper = require("../../util/redis");
 
-var NRP = require('node-redis-pubsub');
-
-var logFactory = require("../../util/logger");
+var NRP = require("../../clients/nrp");
 
 /**
  * Redis broadcast provider.
@@ -12,55 +11,31 @@ var logFactory = require("../../util/logger");
 exports = module.exports = function(broadcastConfig)
 {
     var nrp = null;
-
-    var logger = logFactory("REDIS BROADCAST");
-    logger.setLevel("error");
-
-    // allow for global redis default
-    // allow for redis broadcast specific
-    // otherwise default to "error"
-    if (typeof(process.env.CLOUDCMS_REDIS_DEBUG_LEVEL) !== "undefined") {
-        logger.setLevel(("" + process.env.CLOUDCMS_REDIS_DEBUG_LEVEL).toLowerCase(), true);
-    }
-    else if (typeof(process.env.CLOUDCMS_BROADCAST_REDIS_DEBUG_LEVEL) !== "undefined") {
-        logger.setLevel(("" + process.env.CLOUDCMS_BROADCAST_REDIS_DEBUG_LEVEL).toLowerCase(), true);
-    }
-
+    
+    var logger = redisHelper.redisLogger("REDIS_BROADCAST", "CLOUDCMS_BROADCAST_", "error")
+    
     var r = {};
 
     r.start = function(callback)
     {
-        var redisPort = broadcastConfig.port;
-        if (typeof(redisPort) === "undefined" || !redisPort)
-        {
-            redisPort = process.env.CLOUDCMS_BROADCAST_REDIS_PORT;
-        }
-        if (typeof(redisPort) === "undefined" || !redisPort)
-        {
-            redisPort = process.env.CLOUDCMS_REDIS_PORT;
-        }
-
-        var redisEndpoint = broadcastConfig.endpoint;
-        if (typeof(redisEndpoint) === "undefined" || !redisEndpoint)
-        {
-            redisEndpoint = process.env.CLOUDCMS_BROADCAST_REDIS_ENDPOINT;
-        }
-        if (typeof(redisEndpoint) === "undefined" || !redisEndpoint)
-        {
-            redisEndpoint = process.env.CLOUDCMS_REDIS_ENDPOINT;
-        }
-
-        var nrpConfig = {
-            "port": redisPort,
-            "host": redisEndpoint,
-            "scope": "broadcast_cache"
-        };
-
-        logger.info("using config = " + nrpConfig);
-        
-        nrp = new NRP(nrpConfig);
-
-        callback();
+        redisClientFactory.create(broadcastConfig, function(err, client) {
+            
+            if (err) {
+                return callback(err);
+            }
+    
+            var nrpConfig = {
+                "client": client,
+                "scope": "broadcast_cache"
+            };
+    
+            //logger.info("using config = " + nrpConfig);
+    
+            nrp = new NRP(nrpConfig);
+            nrp.connect(function(err) {
+                callback(err);
+            });
+        });
     };
 
     r.publish = function(topic, message, callback)

package/clients/nrp.js

@@ -0,0 +1,117 @@
+// a revision of
+// https://raw.githubusercontent.com/louischatriot/node-redis-pubsub/master/lib/node-redis-pubsub.js
+// that works with Redis 6+
+
+"use strict";
+var redis = require('redis');
+
+/**
+ * Create a new NodeRedisPubsub instance that can subscribe to channels and publish messages
+ * @param {Object} options Options for the client creations:
+ *                 client - a connected Redis client
+ *                 scope - Optional, two NodeRedisPubsubs with different scopes will not share messages
+ */
+function NodeRedisPubsub(options)
+{
+    if (!(this instanceof NodeRedisPubsub)){ return new NodeRedisPubsub(options); }
+    
+    options || (options = {});
+    
+    this.emitter = options.client.duplicate();
+    this.emitter.setMaxListeners(0);
+    this.receiver = options.client.duplicate();
+    this.receiver.setMaxListeners(0);
+    
+    this.prefix = options.scope ? options.scope + ':' : '';
+}
+
+NodeRedisPubsub.prototype.connect = function(callback)
+{
+    var self = this;
+    
+    (async function() {
+        await self.emitter.connect();
+        await self.receiver.connect();
+        callback();
+    })();
+};
+
+/**
+ * Subscribe to a channel
+ * @param {String} channel The channel to subscribe to, can be a pattern e.g. 'user.*'
+ * @param {Function} handler Function to call with the received message.
+ * @param {Function} cb Optional callback to call once the handler is registered.
+ */
+NodeRedisPubsub.prototype.on = NodeRedisPubsub.prototype.subscribe = function(channel, handler, callback)
+{
+    if (!callback)
+    {
+        callback = function(){};
+    }
+    
+    var self = this;
+    
+    if (channel === "error")
+    {
+        self.errorHandler = handler;
+        self.emitter.on("error", handler);
+        self.receiver.on("error", handler);
+        return callback();
+    }
+    
+    var listener = function(self, handler)
+    {
+        return function(message, channel) {
+            
+            var jsonmsg = message;
+            try{
+                jsonmsg = JSON.parse(message);
+            } catch (ex){
+                if(typeof self.errorHandler === 'function'){
+                    return self.errorHandler("Invalid JSON received! Channel: " + self.prefix + channel + " Message: " + message);
+                }
+            }
+            return handler(jsonmsg, channel);
+        }
+    }(self, handler);
+    
+    (async function() {
+        await self.receiver.pSubscribe(self.prefix + channel, listener);
+    })();
+    
+    callback();
+};
+
+/**
+ * Emit an event
+ * @param {String} channel Channel on which to emit the message
+ * @param {Object} message
+ */
+NodeRedisPubsub.prototype.emit = NodeRedisPubsub.prototype.publish = function (channel, message)
+{
+    var self = this;
+    
+    (async function() {
+        return await self.emitter.publish(self.prefix + channel, JSON.stringify(message));
+    })();
+};
+
+/**
+ * Safely close the redis connections 'soon'
+ */
+NodeRedisPubsub.prototype.quit = function()
+{
+    this.emitter.quit();
+    this.receiver.quit();
+};
+
+/**
+ * Dangerously close the redis connections immediately
+ */
+NodeRedisPubsub.prototype.end = function()
+{
+    this.emitter.end(true);
+    this.receiver.end(true);
+};
+
+module.exports = NodeRedisPubsub;

package/clients/redis.js

@@ -0,0 +1,64 @@
+//var redis = require("redis");
+var redisHelper = require("../util/redis");
+
+var clients = {};
+
+/**
+ * Redis client factory.
+ *
+ * @type {*}
+ */
+exports = module.exports = {};
+
+var create = exports.create = function(config, baseOptions, callback)
+{
+    if (typeof(config) === "function") {
+        callback = config;
+        config = {};
+        baseOptions = {};
+    }
+    
+    if (typeof(baseOptions) === "function") {
+        callback = baseOptions;
+        baseOptions = {};
+    }
+    
+    if (!config) {
+        config = {};
+    }
+    
+    if (!baseOptions) {
+        baseOptions = {};
+    }
+    
+    var redisOptions = redisHelper.redisOptions(config);
+    if (baseOptions) {
+        for (var k in baseOptions) {
+            redisOptions[k] = baseOptions[k];
+        }
+    }
+    
+    var url = redisOptions.url;
+    
+    // cached client?
+    var client = clients[url];
+    if (client) {
+        return callback(null, client);
+    }
+    
+    // connect
+    (async function() {
+        await redisHelper.createAndConnect(redisOptions, function(err, client) {
+            
+            if (err) {
+                return callback(err);
+            }
+            
+            // cache it
+            clients[url] = client;
+            
+            // return
+            return callback(null, client);
+        });
+    })();
+};