relayx-js 1.0.8 → 1.0.10

package/README.md

@@ -66,7 +66,7 @@ Unsubscribe from a topic:<br>
     }
     ```
 4. <b>History</b><br>
-Get previously published messages between a start date and end date
+Get previously published messages between a start date and end date. Dates are in UTC.
     ```javascript
     var start = new Date();
     var past = start.setDate(start.getDate() - 4) // Get start date from 4 days ago

package/examples/example_chat.js

@@ -11,7 +11,7 @@ async function run(){
         api_key: process.env.user_key,
         secret: process.env.secret
     });
-    await realtime.init(true, {
+    await realtime.init(false, {
         max_retries: 2,
         debug: true
     });
@@ -28,12 +28,12 @@ async function run(){
         console.log(`[IMPL] DISONNECT`)
     });
 
-    await realtime.on("hello", (data) => {
-        console.log("hello", data);
+    await realtime.on("power-telemetry", (data) => {
+        console.log("power-telemetry", data);
     });
 
-    await realtime.on("hello1", (data) => {
-        console.log("hello1", data);
+    await realtime.on("test232", (data) => {
+        console.log("test232", data);
     });
 
     realtime.on(MESSAGE_RESEND, (data) => {
@@ -57,11 +57,11 @@ async function run(){
                 var pastDate = new Date(past)
 
                 var end = new Date();
-                var past = end.setDate(end.getDate() - 2)
+                var past = end.setDate(end.getDate())
                 var endDate = new Date(past)
 
-                var history = await realtime.history(topic, pastDate, endDate)
-                // console.log(history)
+                var history = await realtime.history(topic, pastDate)
+                console.log(history)
             })
         }else if(input == "off"){
             rl.question("topic to off(): ", async (topic) => {
@@ -83,9 +83,7 @@ async function run(){
             })
         }else{
             rl.question("topic: ", async (topic) => {
-                var output = await realtime.publish(topic, {
-                    "data": input
-                });
+                var output = await realtime.publish(topic, input);
             })
         }
     });

package/examples/example_send_data_on_connect.js

@@ -7,7 +7,7 @@ async function run(){
     });
     await realtime.init(true, {
         max_retries: 2,
-        // debug: true
+        debug: true
     });
 
     realtime.on(CONNECTED, async () => {
@@ -16,12 +16,6 @@ async function run(){
         for (let angle = 0; angle <= 18000; angle++){
 
             var value = Math.floor(Math.random() * (100 + 1))
-            console.log(value)
-
-            // await realtime.publish("test-power-1", {
-            //     "value": value,
-            //     "time": Date.now() + 2000
-            // })
 
             var sent = await realtime.publish("power-telemetry", {
                 "value": value,

package/package.json

@@ -1,20 +1,28 @@
 {
   "name": "relayx-js",
-  "version": "1.0.8",
+  "version": "1.0.10",
   "main": "realtime/realtime.js",
   "type": "module",
   "scripts": {
     "test": "NODE_ENV=test node tests/test.js"
   },
-  "keywords": ["realtime", "realtime-communication", "relay", "relay-x", "relay-x-js"],
+  "keywords": [
+    "realtime",
+    "realtime-communication",
+    "relay",
+    "relay-x",
+    "relay-x-js"
+  ],
   "author": "Relay",
   "license": "Apache 2.0",
   "description": "A powerful library for integrating real-time communication into your software stack, powered by the Relay Network.",
   "dependencies": {
+    "@msgpack/msgpack": "^3.1.1",
     "@nats-io/jetstream": "^3.0.0-35",
-    "axios": "1.7.7",
+    "axios": "^1.8.4",
     "jest": "^29.7.0",
-    "nats": "^2.28.2"
+    "nats": "^2.28.2",
+    "uuid": "^11.1.0"
   },
   "devDependencies": {
     "@babel/core": "^7.26.0",

package/realtime/realtime.js

@@ -1,7 +1,8 @@
 import axios from 'axios';
 import { connect, JSONCodec, Events, DebugEvents, AckPolicy, ReplayPolicy, credsAuthenticator } from "nats";
-import { DeliverPolicy, jetstream, jetstreamManager } from "@nats-io/jetstream";
-import { readFileSync } from "fs"
+import { DeliverPolicy, jetstream } from "@nats-io/jetstream";
+import { encode, decode } from "@msgpack/msgpack";
+import { v4 as uuidv4 } from 'uuid';
 
 export class Realtime {
 
@@ -10,8 +11,6 @@ export class Realtime {
     #natsClient = null; 
     #codec = JSONCodec();
     #jetstream = null;
-    #jsManager = null;
-    #streamTracker = []; 
     #consumerMap = {};
 
     #event_func = {}; 
@@ -36,9 +35,6 @@ export class Realtime {
     // Offline messages
     #offlineMessageBuffer = [];
 
-    // Test Variables
-    #timeout = 1000;
-
     #maxPublishRetries = 5; 
 
     constructor(config){
@@ -62,6 +58,7 @@ export class Realtime {
         }
 
         this.namespace = null;
+        this.topicHash = null;
     }
 
     /*
@@ -114,7 +111,8 @@ export class Realtime {
                 "nats://0.0.0.0:4223",
                 "nats://0.0.0.0:4224",
                 "nats://0.0.0.0:4225",
-                "nats://0.0.0.0:4226"] : 
+                "nats://0.0.0.0:4226"
+                ] : 
                 [
                     "nats://api.relay-x.io:4221",
                     "nats://api.relay-x.io:4222",
@@ -160,8 +158,10 @@ export class Realtime {
 
         if(data["status"] == "NAMESPACE_RETRIEVE_SUCCESS"){
             this.namespace = data["data"]["namespace"]
+            this.topicHash = data["data"]["hash"]
         }else{
             this.namespace = null;
+            this.topicHash = null;
             return
         }
     }
@@ -185,10 +185,9 @@ export class Realtime {
                 reconnect: true,
                 reconnectTimeWait: 1000,
                 authenticator: credsAuth,
-                token: this.api_key
+                token: this.api_key,
             });
 
-            this.#jsManager = await jetstreamManager(this.#natsClient);
             this.#jetstream = await jetstream(this.#natsClient);
 
             await this.#getNameSpace()
@@ -224,7 +223,6 @@ export class Realtime {
                         this.#log(`client disconnected - ${s.data}`);
 
                         this.connected = false;
-                        this.#streamTracker = []; 
                         this.#consumerMap = {};
 
                         if (DISCONNECTED in this.#event_func){
@@ -247,8 +245,6 @@ export class Realtime {
                         this.reconnecting = false;
                         this.connected = true;
 
-                        // this.#subscribeToTopics();
-
                         if(RECONNECT in this.#event_func){
                             this.#event_func[RECONNECT](this.#RECONNECTED);   
                         }
@@ -279,6 +275,7 @@ export class Realtime {
 
             // Subscribe to topics
             this.#subscribeToTopics();
+            this.#log("Subscribed to topics");
         }
     }
 
@@ -358,7 +355,7 @@ export class Realtime {
         }
 
         if (![CONNECTED, DISCONNECTED, RECONNECT, this.#RECONNECTED,
-            this.#RECONNECTING, this.#RECONN_FAIL, MESSAGE_RESEND].includes(topic)){
+            this.#RECONNECTING, this.#RECONN_FAIL, MESSAGE_RESEND, SERVER_DISCONNECT].includes(topic)){
                 if(!this.isTopicValid(topic)){
                     // We have an invalid topic, lets remove it
                     if(topic in this.#event_func){
@@ -416,13 +413,12 @@ export class Realtime {
             "start": Date.now()
         }
 
-        var encodedMessage = this.#codec.encode(message)
+        this.#log("Encoding message via msg pack...")
+        var encodedMessage = encode(message);
 
         if(this.connected){
             if(!this.#topicMap.includes(topic)){
                 this.#topicMap.push(topic);
-
-                await this.#createOrGetStream();
             }else{
                 this.#log(`${topic} exists locally, moving on...`)
             }
@@ -485,12 +481,8 @@ export class Realtime {
             end = end.toISOString();
         }
 
-        console.log(`END => ${end}`)
-
-        await this.#createOrGetStream();
-
         var opts = { 
-            name: topic,
+            name: `${topic}_${uuidv4()}_history`,
             filter_subjects: [this.#getStreamTopic(topic)],
             replay_policy: ReplayPolicy.Instant,
             opt_start_time: start,
@@ -501,30 +493,33 @@ export class Realtime {
         this.#log(this.#topicMap)
         this.#log("Consumer is consuming");
 
-        this.#consumerMap[topic] = consumer;
-
-        const msgs = await consumer.consume();
-
         var history = [];
 
-        for await (const m of msgs){
-            m.ack();
+        while(true){
+            var msg = await consumer.next({
+                expires: 1000
+            });
+
+            if(msg == null){
+                break;
+            }
 
             if(end != null || end != undefined){
-                if(m.timestamp > end){
+                if(msg.timestamp > end){
                     break
                 }
             }
 
-            console.log(m.timestamp)
-
-            var data = m.json();
+            this.#log("Decoding msgpack message...")
+            var data = decode(msg.data);
+            this.#log(data);
+            
             history.push(data.message);
         }
 
         var del = await consumer.delete();
 
-        this.#log("History pull done", del)
+        this.#log("History pull done: " + del);
 
         return history;
     }
@@ -567,10 +562,8 @@ export class Realtime {
      * @param {string} topic 
      */
     async #startConsumer(topic){
-        await this.#createOrGetStream();
-
         var opts = { 
-            name: topic,
+            name: `${topic}_${uuidv4()}`,
             filter_subjects: [this.#getStreamTopic(topic), this.#getStreamTopic(topic) + "_presence"],
             replay_policy: ReplayPolicy.Instant,
             opt_start_time: new Date(),
@@ -580,16 +573,15 @@ export class Realtime {
 
         const consumer = await this.#jetstream.consumers.get(this.#getStreamName(), opts);
         this.#log(this.#topicMap)
-        this.#log("Consumer is consuming");
 
         this.#consumerMap[topic] = consumer;
 
         await consumer.consume({
             callback: (msg) => {
-
-                msg.ack();
                 try{
-                    var data = this.#codec.decode(msg.data);
+                    this.#log("Decoding msgpack message...")
+                    var data = decode(msg.data);
+
                     var room = data.room;
 
                     this.#log(data);
@@ -603,12 +595,15 @@ export class Realtime {
                             "data": data.message
                         });
                     }
+
+                    msg.ack();
                 }catch(err){
                     this.#log("Consumer err " + err);
-                    msg.nack();
+                    msg.nack(5000);
                 }
             }
         });
+        this.#log("Consumer is consuming");
     }
 
     /**
@@ -631,39 +626,6 @@ export class Realtime {
         return del;
     }
 
-    /**
-     * Gets stream if it exists or creates one
-     * @param {string} streamName 
-     */
-    async #createOrGetStream(){
-        const streamName = this.#getStreamName();
-        var stream = null;
-        
-        try{
-            stream = await this.#jsManager.streams.info(streamName);
-        }catch(err){
-            stream = null;
-        }
-
-        this.#log(`STREAM => ${stream}`)
-
-        if (stream == null){
-            // Stream does not exist, create one
-            await this.#jsManager.streams.add({
-                name: streamName,
-                subjects: [...this.#getStreamTopicList(), ...this.#getPresenceTopics()],
-            });
-
-            this.#log(`${streamName} created`);
-        }else{
-            var subs = [...stream.config.subjects, ...this.#getStreamTopicList(), ...this.#getPresenceTopics()];
-            stream.config.subjects = [...new Set(subs)];
-            await this.#jsManager.streams.update(streamName, stream.config);
-
-            this.#log(`${streamName} exists, updating and moving on...`);
-        }
-    }
-
     // Utility functions
     #getClientId(){
         return this.#natsClient?.info?.client_id
@@ -677,9 +639,9 @@ export class Realtime {
     isTopicValid(topic){
         if(topic !== null && topic !== undefined && (typeof topic) == "string"){
             var arrayCheck = ![CONNECTED, DISCONNECTED, RECONNECT, this.#RECONNECTED,
-                this.#RECONNECTING, this.#RECONN_FAIL, MESSAGE_RESEND].includes(topic);
+                this.#RECONNECTING, this.#RECONN_FAIL, MESSAGE_RESEND, SERVER_DISCONNECT].includes(topic);
 
-            var spaceStarCheck = !topic.includes(" ") && !topic.includes("*");
+            var spaceStarCheck = !topic.includes(" ") && !topic.includes("*") && !topic.includes(".");
 
             return arrayCheck && spaceStarCheck;
         }else{
@@ -697,34 +659,14 @@ export class Realtime {
     }
 
     #getStreamTopic(topic){
-        if(this.namespace != null){
-            return this.namespace + "_stream_" + topic;
+        if(this.topicHash != null){
+            return this.topicHash + "." + topic;
         }else{
             this.close();
-            throw new Error("$namespace is null. Cannot initialize program with null $namespace")
+            throw new Error("$topicHash is null. Cannot initialize program with null $topicHash")
         }
     }
 
-    #getStreamTopicList(){
-        var topics = [];
-
-        this.#topicMap.forEach((topic) => {
-            topics.push(this.#getStreamTopic(topic))
-        })
-
-        return topics
-    }
-
-    #getPresenceTopics(){
-        var presence = [];
-
-        this.#topicMap.forEach((topic) => {
-            presence.push(this.#getStreamTopic(topic) + "_presence")
-        })
-
-        return presence
-    }
-
     sleep(ms) {
         return new Promise(resolve => setTimeout(resolve, ms));
     }
@@ -861,4 +803,5 @@ export class Realtime {
 export const CONNECTED = "CONNECTED";
 export const RECONNECT = "RECONNECT";
 export const MESSAGE_RESEND = "MESSAGE_RESEND";
-export const DISCONNECTED = "DISCONNECTED";
+export const DISCONNECTED = "DISCONNECTED";
+export const SERVER_DISCONNECT = "SERVER_DISCONNECT";

package/tests/test.js

@@ -116,6 +116,7 @@ test('init() function test', async () => {
 
 test("Namespace check test", async () => {
     assert.strictEqual(realTimeEnabled.namespace.length > 0, true)
+    assert.strictEqual(realTimeEnabled.topicHash.length > 0, true)
 });
 
 test("Retry method test", async () => {
@@ -401,17 +402,19 @@ test("Get stream name test", () => {
     });
 
     realtime.namespace = "spacex-dragon-program"
+    realtime.topicHash = "topic_hash";
 
     var getStreamName = realtime.testGetStreamName();
     var getStreamTopic = realtime.testGetStreamTopic();
 
     var name = getStreamName();
-    assert.strictEqual(name, "spacex-dragon-program_stream")
+    assert.strictEqual(name, `${realtime.namespace}_stream`);
 
     var topic = getStreamTopic("hello_world")
-    assert.strictEqual(topic, "spacex-dragon-program_stream_hello_world")
+    assert.strictEqual(topic, `${realtime.topicHash}.hello_world`)
 
     realtime.namespace = null;
+    realtime.topicHash = null;
 
     assert.throws(() => {
         getStreamName();
@@ -422,7 +425,7 @@ test("Get stream name test", () => {
     assert.throws(() => {
         getStreamTopic("hello_world");
     }, 
-    new Error("$namespace is null. Cannot initialize program with null $namespace"),
+    new Error("$topicHash is null. Cannot initialize program with null $topicHash"),
     "Expected error was not thrown")
 });
 
@@ -508,19 +511,4 @@ test("History test", async () => {
     },
     new Error("$start must be a Date object"),
     "Expected error was not thrown");
-
-    await realTimeEnabled.history("hello", new Date());
-
-    await realTimeEnabled.history("hello", new Date(), new Date());
-
-    var start = new Date();
-    var past = start.setDate(start.getDate() - 4)
-    var pastDate = new Date(past)
-
-    var end = new Date();
-    var past = end.setDate(end.getDate() - 2)
-    var endDate = new Date(past)
-
-    var history = await realTimeEnabled.history("hello", pastDate, endDate)
-    assert.strictEqual(history.length > 0, true)
 })