relayx-js 1.0.6 → 1.0.7

package/CHANGELOG.md

@@ -0,0 +1,3 @@
+V1.0.7
+- History API added
+- README updated to explain history API usage

package/README.md

@@ -65,21 +65,43 @@ Unsubscribe from a topic:<br>
         console.log("Unable to unsubscribe from power_telemetry");
     }
     ```
-4. <b>Valid Topic Check</b><br>
+4. <b>History</b><br>
+Get previously published messages between a start date and end date
+    ```javascript
+    var start = new Date();
+    var past = start.setDate(start.getDate() - 4) // Get start date from 4 days ago
+    var startDate = new Date(past)
+
+    var end = new Date();
+    var past = end.setDate(end.getDate() - 2) // Get end date from 2 days ago
+    var endDate = new Date(past)
+
+    var history = await realtime.history(topic, startDate, endDate)
+    ```
+    The end date is optional. Supplying only the start time will fetch all messages from the start time to now.
+    ```javascript
+    var start = new Date();
+    var past = start.setDate(start.getDate() - 4) // Get start date from 4 days ago
+    var startDate = new Date(past)
+
+    // This will get all messages from 4 days ago to now
+    var history = await realtime.history(topic, startDate)
+    ```
+5. <b>Valid Topic Check</b><br>
 Utility function to check if a particular topic is valid
     ```javascript
     var isValid = realtime.isTopicValid("topic");
 
     console.log(`Topic Valid => ${isValid}`);
     ```
-5. <b>Sleep</b><br>
+6. <b>Sleep</b><br>
 Utility async function to delay code execution
     ```javascript
     console.log("Starting code execution...");
     await realtime.sleep(2000) // arg is in ms
     console.log("This line executed after 2 seconds");
     ```
-6. <b>Close Connection to Relay</b><br>
+7. <b>Close Connection to Relay</b><br>
 Manually disconnect from the Relay Network
     ```javascript
     // Logic here
@@ -148,9 +170,16 @@ Subscribes to a topic. This is an async function.
 Deletes reference to user defined event callback for a topic. This will stop listening to a topic. This is an async function.
      * @param {string} topic 
      * @returns {boolean} - To check if topic unsubscribe was successful
-4. isTopicValid()<br>
+4. history()<br>
+Get a list of messages published in the past. This is an async function.<br>
+A list of messages can be obtained using a start time and end time. End time is optional. If end time is not specified, all messages from the start time to now is returned.
+     * @param {string} topic 
+     * @param {Date} start
+     * @param {Date} end
+     * @returns {JSON Array} - List of messages published in the past
+5. isTopicValid()<br>
 Checks if a topic can be used to send messages to.
      * @param {string} topic - Name of event
      * @returns {boolean} - If topic is valid or not
-5. sleep()<br>
+6. sleep()<br>
 Pauses code execution for a user defined time. Time passed into the method is in milliseconds.  This is an async function.

package/examples/example_chat.js

@@ -51,10 +51,18 @@ async function run(){
 
             process.exit();
         }else if(input == "history"){
-            var since = Date.now() - 1 * 60 * 60 * 1000; // 1 hour ago
+            rl.question("topic: ", async (topic) => {
+                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 realtime.history.getMessagesSince("hello", since, 1, 1000);
-            console.log(history);
+                var history = await realtime.history(topic, pastDate, endDate)
+                console.log(history)
+            })
         }else if(input == "off"){
             rl.question("topic to off(): ", async (topic) => {
                 await realtime.off(topic);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "relayx-js",
-  "version": "1.0.6",
+  "version": "1.0.7",
   "main": "realtime/realtime.js",
   "type": "module",
   "scripts": {

package/realtime/realtime.js

@@ -1,4 +1,3 @@
-import { History } from "./history.js";
 import axios from 'axios';
 import { connect, JSONCodec, Events, DebugEvents, AckPolicy, ReplayPolicy, credsAuthenticator } from "nats";
 import { DeliverPolicy, jetstream, jetstreamManager } from "@nats-io/jetstream";
@@ -37,9 +36,6 @@ export class Realtime {
     // Offline messages
     #offlineMessageBuffer = [];
 
-    // History API
-    history = null;
-
     // Test Variables
     #timeout = 1000;
 
@@ -451,6 +447,86 @@ export class Realtime {
         }
     }
 
+    /**
+     * Starts consumer for particular topic if stream exists
+     * @param {string} topic 
+     */
+    async history(topic, start, end){
+        this.#log(start)
+        if(topic == null || topic == undefined){
+            throw new Error("$topic is null or undefined");
+        }
+
+        if(topic == ""){
+            throw new Error("$topic cannot be an empty string")
+        }
+
+        if(typeof topic !== "string"){
+            throw new Error(`Expected $topic type -> string. Instead receieved -> ${typeof topic}`);
+        }
+
+        if(start == undefined || start == null){
+            throw new Error(`$start must be provided. $start is => ${start}`)
+        }
+
+        if(!(start instanceof Date)){
+            throw new Error(`$start must be a Date object`)
+        }
+
+        if(end != undefined && end != null){
+            if(!(end instanceof Date)){
+                throw new Error(`$end must be a Date object`)
+            }
+
+            if(start > end){
+                throw new Error("$start is greater than $end, must be before $end")
+            }
+
+            end = end.toISOString();
+        }
+
+        await this.#createOrGetStream();
+
+        var opts = { 
+            name: topic,
+            filter_subjects: [this.#getStreamTopic(topic)],
+            replay_policy: ReplayPolicy.Instant,
+            opt_start_time: start,
+            ack_policy: AckPolicy.Explicit,
+        }
+
+        const consumer = await this.#jetstream.consumers.get(this.#getStreamName(), opts);
+        this.#log(this.#topicMap)
+        this.#log("Consumer is consuming");
+
+        this.#consumerMap[topic] = consumer;
+
+        const msgs = await consumer.fetch({
+            expires: 10000
+        });
+
+        var history = [];
+
+        for await (const m of msgs){
+            m.ack();
+
+            if(end != null || end != undefined){
+                if(m.timestamp > end){
+                    break
+                }
+            }
+
+            var data = m.json();
+            history.push(data.message);
+        }
+
+        var del = await consumer.delete();
+
+        this.#log("History pull done", del)
+
+        return history;
+    }
+
     /**
      * Method resends messages when the client successfully connects to the
      * server again
@@ -510,7 +586,6 @@ export class Realtime {
             callback: (msg) => {
 
                 msg.ack();
-
                 try{
                     var data = this.#codec.decode(msg.data);
                     var room = data.room;

package/tests/test.js

@@ -370,9 +370,10 @@ test("off() test", async () => {
     new Error("Expected $topic type -> string. Instead receieved -> number"),
     "Expected error was not thrown");
 
+    // Turning off topic multiple times to check for crashes.
+    // Since it is off already, output will be false
     var status = await realtime.off("hello");
-
-    assert.strictEqual(status, true)
+    assert.strictEqual(status, false)
 
     var eventFunc = realtime.testGetEventMap();
     var topicMap = realtime.testGetTopicMap();
@@ -382,11 +383,6 @@ test("off() test", async () => {
     assert.strictEqual(eventFunc["hello"], undefined)
     assert.strictEqual(consumerMap["hello"], undefined)
 
-    // Turning off topic multiple times to check for crashes.
-    // Since it is off already, output will be false
-    var status = await realtime.off("hello");
-    assert.strictEqual(status, false)
-
     var status = await realtime.off("hello");
     assert.strictEqual(status, false)
 
@@ -456,4 +452,75 @@ test("Test isTopicValidMethod()", () => {
         var valid = realTimeEnabled.isTopicValid(topic);
         assert.strictEqual(valid, true);
     });
-});
+});
+
+test("History test", async () => {
+    await assert.rejects(async () => {
+        await realTimeEnabled.history(null);
+    },
+    new Error("$topic is null or undefined"),
+    "Expected error was not thrown");
+
+    await assert.rejects(async () => {
+        await realTimeEnabled.history(undefined);
+    },
+    new Error("$topic is null or undefined"),
+    "Expected error was not thrown");
+
+    await assert.rejects(async () => {
+        await realTimeEnabled.history("");
+    },
+    new Error("$topic cannot be an empty string"),
+    "Expected error was not thrown");
+
+    await assert.rejects(async () => {
+        await realTimeEnabled.history(1234);
+    },
+    new Error("Expected $topic type -> string. Instead receieved -> number"),
+    "Expected error was not thrown");
+
+    await assert.rejects(async () => {
+        await realTimeEnabled.history("hello", null);
+    },
+    new Error("$start must be provided. $start is => null"),
+    "Expected error was not thrown");
+
+    await assert.rejects(async () => {
+        await realTimeEnabled.history("hello", undefined);
+    },
+    new Error("$start must be provided. $start is => undefined"),
+    "Expected error was not thrown");
+
+    await assert.rejects(async () => {
+        await realTimeEnabled.history("hello", "undefined");
+    },
+    new Error("$start must be a Date object"),
+    "Expected error was not thrown");
+
+    await assert.rejects(async () => {
+        await realTimeEnabled.history("hello", 1234);
+    },
+    new Error("$start must be a Date object"),
+    "Expected error was not thrown");
+
+    await assert.rejects(async () => {
+        await realTimeEnabled.history("hello", {});
+    },
+    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)
+})