relayx-js 1.0.18 → 1.1.0

package/realtime/realtime.js

@@ -1,8 +1,11 @@
 import { connect, JSONCodec, Events, DebugEvents, AckPolicy, ReplayPolicy, credsAuthenticator } from "nats";
-import { DeliverPolicy, jetstream } from "@nats-io/jetstream";
+import { DeliverPolicy, jetstream, jetstreamManager } from "@nats-io/jetstream";
 import { encode, decode } from "@msgpack/msgpack";
 import { v4 as uuidv4 } from 'uuid';
 import { initDNSSpoof } from "./dns_change.js";
+import { Queue } from "./queue.js";
+import { ErrorLogging } from "./utils.js";
+import { KVStore } from "./kv_storage.js";
 
 export class Realtime {
 
@@ -11,11 +14,16 @@ export class Realtime {
     #natsClient = null; 
     #codec = JSONCodec();
     #jetstream = null;
+    #jetStreamManager = null;
     #consumerMap = {};
 
+    #kvStore = null;
+
     #event_func = {}; 
     #topicMap = []; 
 
+    #errorLogging = null;
+
     // Status Codes
     #RECONNECTING = "RECONNECTING";
     #RECONNECTED = "RECONNECTED";
@@ -71,56 +79,17 @@ export class Realtime {
     /*
     Initializes library with configuration options.
     */
-    async init(staging, opts){
-        /**
-         * Method can take in 2 variables
-         * @param{boolean} staging - Sets URL to staging or production URL
-         * @param{Object} opts - Library configuration options
-         */
-        var len = arguments.length;
-
-        if (len > 2){
-            new Error("Method takes only 2 variables, " + len + " given");
-        }
+    async init(data){
+        this.#errorLogging = new ErrorLogging();
 
-        if (len == 2){
-            if(typeof arguments[0] == "boolean"){
-                staging = arguments[0]; 
-            }else{
-                staging = false;
-            }
-
-            if(arguments[1] instanceof Object){
-                opts = arguments[1];
-            }else{
-                opts = {};
-            }
-        }else if(len == 1){
-            if(arguments[0] instanceof Object){
-                opts = arguments[0];
-                staging = false;
-            }else if(typeof arguments[0] == "boolean"){
-                opts = {};
-                staging = arguments[0];
-                this.#log(staging)
-            }else{
-                opts = {};
-                staging = false
-            }
-        }else{
-            staging = false;
-            opts = {};
-        }
-
-        this.staging = staging; 
-        this.opts = opts;
+        this.staging = this.#checkVarOk(data.staging) && typeof data.staging == "boolean" ? data.staging : false; 
+        this.opts = data.opts;
 
         if(process.env.PROXY){
             this.#baseUrl = ["tls://api2.relay-x.io:8666"];
             initDNSSpoof();
         }else{
-            if (staging !== undefined || staging !== null){
-                this.#baseUrl = staging ? [
+            this.#baseUrl = this.staging ? [
                         "nats://0.0.0.0:4221",
                         "nats://0.0.0.0:4222",
                         "nats://0.0.0.0:4223",
@@ -130,17 +99,10 @@ export class Realtime {
                         `tls://api.relay-x.io:4222`,
                         `tls://api.relay-x.io:4223`
                     ];
-            }else{
-                this.#baseUrl = [
-                    `tls://api.relay-x.io:4221`,
-                    `tls://api.relay-x.io:4222`,
-                    `tls://api.relay-x.io:4223`
-                ];
-            }
         }
 
         this.#log(this.#baseUrl);
-        this.#log(opts);
+        this.#log(this.opts);
     }
 
     /**
@@ -199,14 +161,23 @@ export class Realtime {
             });
 
             this.#jetstream = await jetstream(this.#natsClient);
+            this.#jetStreamManager = await jetstreamManager(this.#natsClient)
 
             await this.#getNameSpace()
 
             this.connected = true;
             this.#connectCalled = true;
         }catch(err){
-            this.#log("ERR")
-            this.#log(err);
+            this.#errorLogging.logError({
+                err: err
+            })
+
+            // Callback on client side
+            if (CONNECTED in this.#event_func){
+                if (this.#event_func[CONNECTED] !== null || this.#event_func[CONNECTED] !== undefined){
+                    this.#event_func[CONNECTED](false)
+                }
+            }
 
             this.connected = false;
         }
@@ -231,54 +202,56 @@ export class Realtime {
             
             (async () => {
                 for await (const s of this.#natsClient.status()) {
-                this.#log(s.type)
-
-                switch (s.type) {
-                    case Events.Disconnect:
-                        this.#log(`client disconnected - ${s.data}`);
-
-                        this.connected = false;
-                    break;
-                    case Events.LDM:
-                        this.#log("client has been requested to reconnect");
-                    break;
-                    case Events.Update:
-                        this.#log(`client received a cluster update - `);
-                        this.#log(s.data)
-                    break;
-                    case Events.Reconnect:
-                        this.#log(`client reconnected -`);
-                        this.#log(s.data)
-
-                        this.reconnecting = false;
-                        this.connected = true;
-
-                        if(RECONNECT in this.#event_func){
-                            this.#event_func[RECONNECT](this.#RECONNECTED);   
-                        }
-
-                        // Resend any messages sent while client was offline
-                        this.#publishMessagesOnReconnect();
-                    break;
-                    case Events.Error:
-                        this.#log("client got a permissions error");
-                    break;
-                    case DebugEvents.Reconnecting:
-                        this.#log("client is attempting to reconnect");
-
-                        this.reconnecting = true;
-                        this.connected = false;
-
-                        if(RECONNECT in this.#event_func && this.reconnecting){
-                            this.#event_func[RECONNECT](this.#RECONNECTING);   
-                        }
-                    break;
-                    case DebugEvents.StaleConnection:
-                        this.#log("client has a stale connection");
-                    break;
-                    default:
-                        this.#log(`got an unknown status ${s.type}`);
-                }
+                    switch (s.type) {
+                        case Events.Disconnect:
+                            this.#log(`client disconnected - ${s.data}`);
+
+                            this.connected = false;
+                        break;
+                        case Events.LDM:
+                            this.#log("client has been requested to reconnect");
+                        break;
+                        case Events.Update:
+                            this.#log(`client received a cluster update - `);
+                            this.#log(s.data)
+                        break;
+                        case Events.Reconnect:
+                            this.#log(`client reconnected -`);
+                            this.#log(s.data)
+
+                            this.reconnecting = false;
+                            this.connected = true;
+
+                            if(RECONNECT in this.#event_func){
+                                this.#event_func[RECONNECT](this.#RECONNECTED);   
+                            }
+
+                            // Resend any messages sent while client was offline
+                            this.#publishMessagesOnReconnect();
+                        break;
+                        case Events.Error:
+                            if(s.data == "NATS_PROTOCOL_ERR"){
+                                console.log("User kicked off network by account admin!")
+
+                                await this.#natsClient.close();
+                            }
+                        break;
+                        case DebugEvents.Reconnecting:
+                            this.#log("client is attempting to reconnect");
+
+                            this.reconnecting = true;
+                            this.connected = false;
+
+                            if(RECONNECT in this.#event_func && this.reconnecting){
+                                this.#event_func[RECONNECT](this.#RECONNECTING);   
+                            }
+                        break;
+                        case DebugEvents.StaleConnection:
+                            this.#log("client has a stale connection");
+                        break;
+                        // default:
+                        //     this.#log(`got an unknown status ${s.type}`);
+                    }
                 }
             })().then();
 
@@ -289,7 +262,7 @@ export class Realtime {
             // Callback on client side
             if (CONNECTED in this.#event_func){
                 if (this.#event_func[CONNECTED] !== null || this.#event_func[CONNECTED] !== undefined){
-                    this.#event_func[CONNECTED]()
+                    this.#event_func[CONNECTED](true)
                 }
             }
         }
@@ -320,7 +293,15 @@ export class Realtime {
     async #subscribeToTopics(){
         this.#topicMap.forEach(async (topic) => {
             // Subscribe to stream
-            await this.#startConsumer(topic); 
+            try{
+                await this.#startConsumer(topic); 
+            }catch(err){
+                this.#errorLogging.logError({
+                    err: err,
+                    topic: topic,
+                    op: "subscribe"
+                })
+            }
         });
     }
 
@@ -395,7 +376,15 @@ export class Realtime {
 
             if(this.connected){
                 // Connected we need to create a topic in a stream
-                await this.#startConsumer(topic);
+                try{
+                    await this.#startConsumer(topic); 
+                }catch(err){
+                    this.#errorLogging.logError({
+                        err: err,
+                        topic: topic,
+                        op: "subscribe"
+                    })
+                }
             }
         }
 
@@ -434,7 +423,6 @@ export class Realtime {
         var messageId = crypto.randomUUID();
 
         var message = {
-            "client_id": this.#getClientId(),
             "id": messageId,
             "room": topic,
             "message": data,
@@ -447,12 +435,22 @@ export class Realtime {
 
             this.#log(`Publishing to topic => ${this.#getStreamTopic(topic)}`)
     
-            const ack = await this.#jetstream.publish(this.#getStreamTopic(topic), encodedMessage);
-            this.#log(`Publish Ack =>`)
-            this.#log(ack)
-    
-            var latency = Date.now() - start;
-            this.#log(`Latency => ${latency} ms`);
+            var ack = null;
+
+            try{
+                ack = await this.#jetstream.publish(this.#getStreamTopic(topic), encodedMessage);
+                this.#log(`Publish Ack =>`)
+                this.#log(ack)
+        
+                var latency = Date.now() - start;
+                this.#log(`Latency => ${latency} ms`);
+            }catch(err){
+                this.#errorLogging.logError({
+                    err: err,
+                    topic: topic,
+                    op: "publish"
+                })
+            }
 
             return ack !== null && ack !== undefined;
         }else{
@@ -511,7 +509,7 @@ export class Realtime {
         }
 
         var opts = { 
-            name: `${topic}_${uuidv4()}_history`,
+            name: `nodejs_${topic}_${uuidv4()}_history_consumer`,
             filter_subjects: [this.#getStreamTopic(topic)],
             replay_policy: ReplayPolicy.Instant,
             opt_start_time: start,
@@ -597,11 +595,11 @@ export class Realtime {
      * @param {string} topic 
      */
     async #startConsumer(topic){
-        const consumerName = `${topic}_${uuidv4()}_consumer`;
+        const consumerName = `nodejs_${uuidv4()}_consumer`;
 
         var opts = { 
             name: consumerName,
-            filter_subjects: [this.#getStreamTopic(topic)],
+            filter_subjects: this.#getStreamTopic(topic),
             replay_policy: ReplayPolicy.Instant,
             opt_start_time: new Date(),
             ack_policy: AckPolicy.Explicit,
@@ -609,7 +607,6 @@ export class Realtime {
         }
 
         const consumer = await this.#jetstream.consumers.get(this.#getStreamName(), opts);
-        this.#log(this.#topicMap)
 
         this.#consumerMap[topic] = consumer;
 
@@ -626,16 +623,14 @@ export class Realtime {
                     this.#log(data);
 
                     // Push topic message to main thread
-                    if (data.client_id != this.#getClientId()){
-                        var topicMatch = this.#topicPatternMatcher(topic, msgTopic)
-
-                        if(topicMatch){
-                            this.#event_func[topic]({
-                                "id": data.id,
-                                "topic": msgTopic,
-                                "data": data.message
-                            });
-                        }
+                    var topicMatch = this.#topicPatternMatcher(topic, msgTopic)
+
+                    if(topicMatch){
+                        this.#event_func[topic]({
+                            "id": data.id,
+                            "topic": msgTopic,
+                            "data": data.message
+                        });
                     }
 
                     msg.ack();
@@ -647,7 +642,8 @@ export class Realtime {
                 }
             }
         });
-        this.#log("Consumer is consuming");
+        
+        this.#log("Consumer is consuming => " + topic);
     }
 
     async #deleteConsumer(topic){
@@ -711,6 +707,51 @@ export class Realtime {
         }
     }
 
+    // Queue Functions
+    async initQueue(queueID){
+        if(!this.connected){
+            this.#log("Not connected to relayX network. Skipping queue init")
+
+            return;
+        }
+
+        this.#log("Validating queue ID...")
+        if(queueID == undefined || queueID == null || queueID == ""){
+            throw new Error("$queueID cannot be null / undefined / empty!")
+        }
+
+        var queue = new Queue({
+            jetstream: this.#jetstream,
+            nats_client: this.#natsClient,
+            api_key: this.api_key,
+            debug: this.opts?.debug ? this.opts?.debug : false
+        });
+
+        var initResult = await queue.init(queueID);
+
+        return initResult ? queue : null;
+    }
+
+    // KV Functions
+    async initKVStore(){
+
+        if(this.#kvStore == null){
+            var debugCheck = this.opts.debug !== null && this.opts.debug !== undefined && typeof this.opts.debug == "boolean"
+
+            this.#kvStore = new KVStore({
+                namespace: this.namespace,
+                jetstream: this.#jetstream,
+                debug: debugCheck ? this.opts.debug : false
+            })
+
+            var init = await this.#kvStore.init()
+
+            return init ? this.#kvStore : null;
+        }else{
+            return this.#kvStore
+        }
+    }
+
     // Utility functions
     #getClientId(){
         return this.#natsClient?.info?.client_id
@@ -801,7 +842,7 @@ export class Realtime {
 
     #getStreamName(){
         if(this.namespace != null){
-            return this.namespace + "_stream"
+            return `${this.namespace}_stream`
         }else{
             this.close();
             throw new Error("$namespace is null. Cannot initialize program with null $namespace")
@@ -856,19 +897,6 @@ export class Realtime {
             const tokA = a[i];
             const tokB = b[j];
 
-            /*──────────── literal match or single‑token wildcard on either side ────────────*/
-            const singleWildcard =
-            (tokA === "*" && j < b.length) ||
-            (tokB === "*" && i < a.length);
-
-            if (
-            (tokA !== undefined && tokA === tokB) ||
-            singleWildcard
-            ) {
-            i++; j++;
-            continue;
-            }
-
             /*────────────────── multi‑token wildcard ">" — must be **final** ───────────────*/
             if (tokA === ">") {
             if (i !== a.length - 1) return false;   // '>' not in last position → invalid
@@ -885,6 +913,19 @@ export class Realtime {
             continue;
             }
 
+            /*──────────── literal match or single‑token wildcard on either side ────────────*/
+            const singleWildcard =
+            (tokA === "*" && j < b.length) ||
+            (tokB === "*" && i < a.length);
+
+            if (
+            (tokA !== undefined && tokA === tokB) ||
+            singleWildcard
+            ) {
+            i++; j++;
+            continue;
+            }
+
             /*───────────────────────────── back‑track using last '>' ───────────────────────*/
             if (starAi !== -1) {          // let patternA's '>' absorb one more token of B
             j = ++starAj;
@@ -899,7 +940,7 @@ export class Realtime {
             return false;
         }
 
-        return true; 
+        return true;
     } 
 
     sleep(ms) {
@@ -984,6 +1025,10 @@ ${secret}
 *************************************************************`
     }
 
+    #checkVarOk(variable){
+        return variable !== null && variable !== undefined
+    }
+
     // Exposure for tests
     testRetryTillSuccess(){
         if(process.env.NODE_ENV == "test"){
@@ -1048,6 +1093,14 @@ ${secret}
             return null;
         }
     }
+
+    testGetJetstream(){
+        if(process.env.NODE_ENV == "test"){
+            return this.#jetstream;
+        }else{
+            return null;
+        }
+    }
 }
 
 export const CONNECTED = "CONNECTED";

package/realtime/utils.js

@@ -0,0 +1,114 @@
+import { JetStreamApiError, JetStreamError } from "@nats-io/jetstream";
+import NatsError from "nats"
+
+export class ErrorLogging {
+
+    logError(data){
+        var err = data.err;
+
+        if(err instanceof JetStreamApiError){
+            var code = err.code;
+
+            if(code == 10077){
+                // Code 10077 is for message limit exceeded
+                console.table({
+                    Event: "Message Limit Exceeded",
+                    Description: "Current message count for account exceeds plan defined limits. Upgrade plan to remove limits",
+                    Link: "https://console.relay-x.io/billing"
+                })
+
+                throw new Error("Message limit exceeded!")
+            }
+        }
+
+        if(err instanceof JetStreamError){
+            var code = err.code;
+
+            if(code == 409){
+                // Consumer deleted
+
+                console.table({
+                    Event: "Consumer Manually Deleted!",
+                    Description: "Consumer was manually deleted by user using deleteConsumer() or the library equivalent",
+                    "Docs to Solve Issue": "https://docs.relay-x.io/docs/detailed_doc/NodeJS/queue_consume#deleting-a-consumer"
+                })
+            }
+        }
+
+        if(err.name == "NatsError"){
+            var code = err.code;
+            var chainedError = err.chainedError;
+            var permissionContext = err.permissionContext;
+            var userOp = data.op;
+
+            if(code == "PERMISSIONS_VIOLATION"){
+                if(userOp == "publish"){
+                    console.table({
+                        Event: "Publish Permissions Violation",
+                        Description: `User is not permitted to publish on '${data.topic}'`,
+                        Topic: data.topic,
+                        "Docs to Solve Issue": "https://docs.relay-x.io/docs/setup/api_key_permissions#messaging--publish-permissions"
+                    })
+
+                    throw new Error(`User is not permitted to publish on '${data.topic}'`)
+                }else if(userOp == "subscribe"){
+                    console.table({
+                        Event: "Subscribe Permissions Violation",
+                        Description: `User is not permitted to subscribe to '${data.topic}'`,
+                        Topic: data.topic,
+                        "Docs to Solve Issue": "https://docs.relay-x.io/docs/setup/api_key_permissions#messaging--subscribe-permissions"
+                    })
+
+                    throw new Error(`User is not permitted to subscribe to '${data.topic}'`)
+                }else if(userOp == "kv_write"){
+                    console.table({
+                        Event: "KV Write Failure",
+                        Description: `User is not permitted to write to KV Store`,
+                        "Docs to Solve Issue": "https://docs.relay-x.io/docs/setup/api_key_permissions#write-permission"
+                    })
+
+                    throw new Error(`User is not permitted to write to KV Store`)
+                }else if(userOp == "kv_read"){
+                    console.table({
+                        Event: "KV Read Failure",
+                        Description: `User is not permitted to read from KV Store`,
+                        "Docs to Solve Issue": "https://docs.relay-x.io/docs/setup/api_key_permissions#read-permission"
+                    })
+
+                    throw new Error(`User is not permitted to read from KV Store`)
+                }else if(userOp == "kv_delete"){
+                    console.table({
+                        Event: "KV Key Delete Failure",
+                        Description: `User is not permitted to delete key from KV Store`,
+                        "Docs to Solve Issue": "https://docs.relay-x.io/docs/setup/api_key_permissions#write-permission"
+                    })
+
+                    throw new Error(`User is not permitted to delete key from KV Store`)
+                }
+            }else if(code == "AUTHORIZATION_VIOLATION"){
+                console.table({
+                    Event: "Authentication Failure",
+                    Description: `User failed to authenticate. Check if API key exists & if it is enabled`,
+                    "Docs to Solve Issue": "https://docs.relay-x.io/docs/setup/api_key_permissions#enabling-and-disabling-keys"
+                })
+            }
+        }
+    }
+
+}
+
+export class Logging {
+
+    #debug = false;
+
+    constructor(debug){
+        this.#debug = debug !== null && debug !== undefined && typeof debug == "boolean" ? debug : false;
+    }
+
+    log(...msg){
+        if(this.#debug){
+            console.log(...msg)
+        }
+    }
+
+}