relayx-js 1.0.13 → 1.0.15

package/.github/workflows/jekyll-gh-pages.yml

@@ -0,0 +1,51 @@
+# Sample workflow for building and deploying a Jekyll site to GitHub Pages
+name: Deploy Jekyll with GitHub Pages dependencies preinstalled
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Build with Jekyll
+        uses: actions/jekyll-build-pages@v1
+        with:
+          source: ./
+          destination: ./_site
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

package/CHANGELOG.md

@@ -1,3 +1,7 @@
+V1.0.15
+- Wildcard topic pub / sub
+- Message replay on reconnect
+
 V1.0.8
 - History API fetch() to consume()
 

package/README.md

@@ -22,9 +22,7 @@ Install the relay library by running the command below in your terminal<br>
         api_key: process.env.api_key,
         secret: process.env.secret,
     });
-    realtime.init({
-        browser_mode: true // Enable when using in webapps
-    });
+    realtime.init();
 
     // Initialization of topic listeners go here... (look at examples/example_chat.js for full implementation)
 
@@ -160,7 +158,6 @@ This event is fired when the library resends the messages upon reconnection to t
 1. init()<br>
 Initializes library with configuration options.
     * debug (boolean): enables library level logging
-    * browser_mode (boolean): Allows websocket connections to be made from a browser. Default is TCP
 2. connect()<br>
 Connects the library to the Relay Network. This is an async function.
 3. close()<br>

package/examples/example_chat.js

@@ -11,7 +11,7 @@ async function run(){
         api_key: process.env.AUTH_JWT,
         secret: process.env.AUTH_SECRET
     });
-    await realtime.init(true, {
+    await realtime.init(false, {
         max_retries: 2,
         debug: true
     });
@@ -32,8 +32,8 @@ async function run(){
         console.log("power-telemetry", data);
     });
 
-    await realtime.on("test232", (data) => {
-        console.log("test232", data);
+    await realtime.on("hello.*", (data) => {
+        console.log("hello.*", data);
     });
 
     realtime.on(MESSAGE_RESEND, (data) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "relayx-js",
-  "version": "1.0.13",
+  "version": "1.0.15",
   "main": "realtime/realtime.js",
   "type": "module",
   "scripts": {
@@ -17,12 +17,11 @@
   "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.8.4",
-    "jest": "^29.7.0",
-    "nats": "^2.28.2",
-    "uuid": "^11.1.0"
+    "@msgpack/msgpack": "3.1.1",
+    "@nats-io/jetstream": "3.0.0-35",
+    "jest": "29.7.0",
+    "nats": "2.28.2",
+    "uuid": "11.1.0"
   },
   "devDependencies": {
     "@babel/core": "^7.26.0",

package/realtime/dns_change.js

@@ -0,0 +1,20 @@
+import dns from 'node:dns';
+
+export function initDNSSpoof(){
+    const originalLookup = dns.lookup;
+
+    // Override for the whole process
+    dns.lookup = function patchedLookup(hostname, options, callback) {
+
+    // ── Our one special case ──────────────────────────────────
+    if (hostname === 'api2.relay-x.io') {
+        // Map to loop‑back; family 4 avoids ::1
+        return process.nextTick(() =>
+        callback(null, [{address: '127.0.0.1', family: 4}])
+        );
+    }
+
+    // Anything else → real DNS
+    return originalLookup.call(dns, hostname, options, callback);
+    };
+}

package/realtime/realtime.js

@@ -1,8 +1,8 @@
-import axios from 'axios';
 import { connect, JSONCodec, Events, DebugEvents, AckPolicy, ReplayPolicy, credsAuthenticator } from "nats";
 import { DeliverPolicy, jetstream } from "@nats-io/jetstream";
 import { encode, decode } from "@msgpack/msgpack";
 import { v4 as uuidv4 } from 'uuid';
+import { initDNSSpoof } from "./dns_change.js";
 
 export class Realtime {
 
@@ -110,30 +110,28 @@ export class Realtime {
         this.staging = staging; 
         this.opts = opts;
 
-        var browserMode = this.opts["browser_mode"];
-        var protocol = "tls"
-
-        if(browserMode != null && browserMode != undefined && (typeof browserMode == "boolean")){
-            protocol = browserMode ? "wss" : "tls"
-        }
-
-        if (staging !== undefined || staging !== null){
-            this.#baseUrl = staging ? [
-                "nats://0.0.0.0:4221",
-                "nats://0.0.0.0:4222",
-                "nats://0.0.0.0:4223"
-                ] : 
-                [
-                    `${protocol}://api.relay-x.io:4221`,
-                    `${protocol}://api.relay-x.io:4222`,
-                    `${protocol}://api.relay-x.io:4223`
-                ];
+        if(process.env.PROXY){
+            this.#baseUrl = ["tls://api2.relay-x.io:8666"];
+            initDNSSpoof();
         }else{
-            this.#baseUrl = [
-                `${protocol}://api.relay-x.io:4221`,
-                `${protocol}://api.relay-x.io:4222`,
-                `${protocol}://api.relay-x.io:4223`
-            ];
+            if (staging !== undefined || staging !== null){
+                this.#baseUrl = staging ? [
+                        "nats://0.0.0.0:4221",
+                        "nats://0.0.0.0:4222",
+                        "nats://0.0.0.0:4223",
+                    ] : 
+                    [
+                        `tls://api2.relay-x.io:4221`,
+                        `tls://api2.relay-x.io:4222`,
+                        `tls://api2.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);
@@ -188,6 +186,7 @@ export class Realtime {
                 reconnectTimeWait: 1000,
                 authenticator: credsAuth,
                 token: this.api_key,
+                resolve: process.env.PROXY ? false : true
             });
 
             this.#jetstream = await jetstream(this.#natsClient);
@@ -216,6 +215,12 @@ export class Realtime {
                 this.#log("the connection closed!");
 
                 this.#offlineMessageBuffer.length = 0;
+
+                if (DISCONNECTED in this.#event_func){
+                    if (this.#event_func[DISCONNECTED] !== null || this.#event_func[DISCONNECTED] !== undefined){
+                        this.#event_func[DISCONNECTED]()
+                    }
+                }
             });
             
             (async () => {
@@ -576,7 +581,7 @@ export class Realtime {
 
         var opts = { 
             name: `${topic}_${uuidv4()}`,
-            filter_subjects: [this.#getStreamTopic(topic), this.#getStreamTopic(topic) + "_presence"],
+            filter_subjects: [this.#getStreamTopic(topic)],
             replay_policy: ReplayPolicy.Instant,
             opt_start_time: new Date(),
             ack_policy: AckPolicy.Explicit,
@@ -666,7 +671,7 @@ export class Realtime {
             this.#latencyPush = setTimeout(async () => {
                 this.#log("setTimeout called");
 
-                if(this.#latency.length > 0){
+                if(this.#latency.length > 0 && this.connected){
                     this.#log("Push from setTimeout")
                     await this.#pushLatencyData({
                         timezone: timeZone,
@@ -738,7 +743,9 @@ export class Realtime {
             var arrayCheck = ![CONNECTED, DISCONNECTED, RECONNECT, this.#RECONNECTED,
                 this.#RECONNECTING, this.#RECONN_FAIL, MESSAGE_RESEND, SERVER_DISCONNECT].includes(topic);
 
-            var spaceStarCheck = !topic.includes(" ") && !topic.includes("*") && !topic.includes(".");
+            const TOPIC_REGEX = /^(?!\$)[A-Za-z0-9_,.*>\$-]+$/;
+
+            var spaceStarCheck = !topic.includes(" ") && TOPIC_REGEX.test(topic);
 
             return arrayCheck && spaceStarCheck;
         }else{

package/tests/test.js

@@ -1,5 +1,4 @@
 import { Realtime, CONNECTED, RECONNECT, DISCONNECTED, MESSAGE_RESEND } from "../realtime/realtime.js";
-import axios from "axios";
 import { test, before, after } from 'node:test';
 import assert from 'node:assert';
 
@@ -8,10 +7,10 @@ let realTimeEnabled;
 before(async () => {
     // Start server for testing. Run local server!!
     realTimeEnabled = new Realtime({
-        api_key: process.env.user_key,
-        secret: process.env.secret
+        api_key: process.env.AUTH_JWT,
+        secret: process.env.AUTH_SECRET
     });
-    await realTimeEnabled.init(true, {
+    await realTimeEnabled.init(false, {
         debug: true
     });
     await realTimeEnabled.connect();
@@ -55,8 +54,8 @@ test("No creds in constructor", async () => {
 
 test('init() function test', async () => {
     var realtime =  new Realtime({
-        api_key: process.env.user_key,
-        secret: process.env.secret
+        api_key: process.env.AUTH_JWT,
+        secret: process.env.AUTH_SECRET
     });
     await realtime.init(true);
 
@@ -119,37 +118,10 @@ test("Namespace check test", async () => {
     assert.strictEqual(realTimeEnabled.topicHash.length > 0, true)
 });
 
-test("Retry method test", async () => {
-    var retryMethod = realTimeEnabled.testRetryTillSuccess(); 
-
-    assert.notStrictEqual(retryMethod, null, "Obj != null")
-
-    function testMethod1(arg){
-        return {
-            success: true, 
-            output: arg
-        }
-    }
-
-    var output = await retryMethod(testMethod1, 5, 1, "test_output")
-
-    assert.strictEqual(output, "test_output");
-
-    function testMethod2(){
-        return {
-            success: false,
-            output: null
-        }
-    }
-
-    output = await retryMethod(testMethod2, 5, 1);
-    assert.strictEqual(output, null);
-});
-
 test("get publish retry count test based in init()", async () => {
     var realtime =  new Realtime({
-        api_key: process.env.user_key,
-        secret: process.env.secret
+        api_key: process.env.AUTH_JWT,
+        secret: process.env.AUTH_SECRET
     });
 
     await realtime.init({
@@ -199,6 +171,60 @@ test("Testing publish(topic, data) method", async () => {
     });
 
     assert.strictEqual(response, true);
+
+    response = await realTimeEnabled.publish("hello.hey", {
+        message: "Hello World!"
+    });
+
+    assert.strictEqual(response, true);
+
+    response = await realTimeEnabled.publish("hello.*", {
+        message: "Hello World!"
+    });
+
+    assert.strictEqual(response, true);
+
+    response = await realTimeEnabled.publish("hello.>", {
+        message: "Hello World!"
+    });
+
+    assert.strictEqual(response, true);
+
+    response = await realTimeEnabled.publish("test-room", {
+        message: "Hello World!"
+    });
+
+    assert.strictEqual(response, true);
+
+    response = await realTimeEnabled.publish("test-room.*", {
+        message: "Hello World!"
+    });
+
+    assert.strictEqual(response, true);
+
+    response = await realTimeEnabled.publish("test-room.>", {
+        message: "Hello World!"
+    });
+
+    assert.strictEqual(response, true);
+
+    response = await realTimeEnabled.publish("test_room", {
+        message: "Hello World!"
+    });
+
+    assert.strictEqual(response, true);
+
+    response = await realTimeEnabled.publish("test_room.*", {
+        message: "Hello World!"
+    });
+
+    assert.strictEqual(response, true);
+
+    response = await realTimeEnabled.publish("test_room.>", {
+        message: "Hello World!"
+    });
+
+    assert.strictEqual(response, true);
 });
 
 test("Testing publish(topic, data) with invalid inputs", async () => {
@@ -271,8 +297,8 @@ test("Testing publish(topic, data) with invalid inputs", async () => {
 
 test("on() test", async () => {
     var realtime = new Realtime({
-        api_key: process.env.user_key,
-        secret: process.env.secret
+        api_key: process.env.AUTH_JWT,
+        secret: process.env.AUTH_SECRET
     });
 
     await assert.rejects(async () => {
@@ -349,8 +375,8 @@ test("on() test", async () => {
 
 test("off() test", async () => {
     var realtime = new Realtime({
-        api_key: process.env.user_key,
-        secret: process.env.secret
+        api_key: process.env.AUTH_JWT,
+        secret: process.env.AUTH_SECRET
     });
 
     await assert.rejects(async () => {
@@ -397,8 +423,8 @@ test("off() test", async () => {
 
 test("Get stream name test", () => {
     var realtime = new Realtime({
-        api_key: process.env.user_key,
-        secret: process.env.secret
+        api_key: process.env.AUTH_JWT,
+        secret: process.env.AUTH_SECRET
     });
 
     realtime.namespace = "spacex-dragon-program"
@@ -449,7 +475,14 @@ test("Test isTopicValidMethod()", () => {
         assert.strictEqual(valid, false);
     });
 
-    var unreservedValidTopics = ["hello", "test-room", "heyyyyy", "room-connect"]; 
+    unreservedInvalidTopics = ["$hey.hey", "orders created", ""];
+        
+    unreservedInvalidTopics.forEach(topic => {
+        var valid = realTimeEnabled.isTopicValid(topic);
+        assert.strictEqual(valid, false);
+    });
+
+    var unreservedValidTopics = ["hello", "test-room", "heyyyyy", "room-connect", "hey$"]; 
 
     unreservedValidTopics.forEach(topic => {
         var valid = realTimeEnabled.isTopicValid(topic);

package/realtime/history.js

@@ -1,160 +0,0 @@
-import axios from 'axios';
-
-/**
- * Class responsible for getting messages stored in the DB
- */
-export class History{
-    
-    #api_key = null;
-    #staging = null;
-    #baseUrl = null;
-    #debug = null;
-
-    constructor(api_key){
-        this.#api_key = api_key;
-    }
-
-    init(staging, debug){
-        this.#staging = staging;
-        this.#debug = debug;
-
-        this.#setBaseUrl();
-    }
-
-    /**
-     * Get message from DB since a $timestamp
-     * @param {number} timestamp - unix timestamp
-     * @param {number} page - page number of pagination
-     * @param {number} limit - limit per page
-     * @returns - Message array
-     */
-    async getMessagesSince(topic, timestamp, page, limit){
-        if(topic == null || topic == undefined){
-            return new Error("$topic variable missing in getMessagesSince()");
-        }else{
-            if(typeof topic !== "string"){
-                return new Error("$topic is not a string");
-            }
-        }
-
-        if(timestamp == null || timestamp == undefined){
-            return new Error("$timestamp variable missing in getMessagesSince()");
-        }else{
-            if(!Number.isInteger(timestamp) && !Number.isNaN(timestamp)){
-                return new Error("$timestamp is either NaN or not an invalid integer");
-            }
-        }
-
-        if(page == null || page == undefined){
-            return new Error("$page variable missing in getMessagesSince()");
-        }else{
-            if(!Number.isInteger(page) && !Number.isNaN(page)){
-                return new Error("$page is either NaN or not an invalid integer");
-            }
-        }
-
-        if(limit == null || limit == undefined){
-            return new Error("$limit variable missing in getMessagesSince()");
-        }else{
-            if(!Number.isInteger(limit) && !Number.isNaN(limit)){
-                console.log("$limit is either NaN or not an invalid integer")
-                return new Error("$limit is either NaN or not an invalid integer");
-            }
-        }
-
-        try{
-            var startTime = Date.now();
-            var urlPart = `/history/since?topic=${topic}&timestamp=${timestamp}&page=${page}&limit=${limit}`
-
-            var response = await axios.get(this.#baseUrl + urlPart,{
-                headers: {
-                    "Authorization": `Bearer ${this.#api_key}`
-                }
-            });
-
-            var data = response.data
-            this.#log(data);
-
-            this.#logResponseTime(startTime, urlPart);
-
-            if (data?.status === "SUCCESS"){
-                return data.data;
-            }else{
-                return null;
-            }
-       }catch(err){
-            throw Error(err.message);
-       }
-    }
-
-    /**
-     * Get message from DB by ID
-     * @param {string} id - ID of the message
-     * @returns - Message object
-     */
-    async getMessageById(id){
-        var startTime = Date.now();
-        var urlPart = `/history/message-by-id?id=${id}`;
-
-        if(id !== null && id !== undefined){
-            try{
-                var response = await axios.get(this.#baseUrl + urlPart,{
-                    headers: {
-                        "Authorization": `Bearer ${this.#api_key}`
-                    }
-                });
-    
-                var data = response.data
-                this.#log(data);
-
-                this.#logResponseTime(startTime, urlPart);
-    
-                if (data?.status === "SUCCESS"){
-                    return data.data;
-                }else{
-                    return null;
-                }
-           }catch(err){
-                throw new Error(err.message);
-           }
-        }else{
-            return null;
-        }
-    }
-
-    // Utility Functions
-    /**
-     * Constructs base url based on staging flag
-     */
-    #setBaseUrl(){
-        if (this.#staging !== undefined || this.#staging !== null){
-            this.#baseUrl = this.#staging ? "http://127.0.0.1:3000" : "http://128.199.176.185:3000";
-        }else{
-            this.#baseUrl = "http://128.199.176.185:3000";
-        }
-    }
-
-    #log(msg){
-        if(this.#debug !== null && this.#debug !== undefined && (typeof this.#debug == "boolean")){
-            if(this.#debug){
-                console.log(msg);
-            }
-        }
-    }
-
-    async #logResponseTime(startTime, url){
-        var responseTime = Date.now() - startTime;
-
-        var data = {
-            "url": url,
-            "response_time": responseTime
-        }
-
-        await axios.post(this.#baseUrl + "/metrics/log", data, {
-            headers: {
-                "Authorization": `Bearer ${this.#api_key}`
-            }
-        });
-    }
-
-}