Wrapped Client in a namespace cdplogger.Client

Author: stefanrammo

client.js

@@ -2,6 +2,8 @@ const WebSocket = require('ws');
 const root = require('./generated/containerPb.js');
 const Container = root.DBMessaging.Protobuf.Container;
 const CDPValueType = root.ICD.Protobuf.CDPValueType;
+const EventQuery = root.DBMessaging.Protobuf.EventQuery;
+
 
 /**
  * A client for interacting with a CDP Logger or LogServer via WebSocket.
@@ -14,7 +16,7 @@ const CDPValueType = root.ICD.Protobuf.CDPValueType;
 class Client {
   // Defined property names to use instead of ambiguous numbers.
   static EventQueryFlags = Object.freeze({
-    None: 0, // Client.EventQueryFlags.None === 0
+    None: 0, // cdplogger.Client.EventQueryFlags.None === 0
     NewestFirst: 1,
     TimeRangeBeginExclusive: 2,
     TimeRangeEndExclusive: 4,
@@ -288,11 +290,11 @@ class Client {
    *   dataConditions: {
    *     Text: ["Invalid or missing feature license detected."],
    *     // Multiple data conditions can be specified:
-   *     Level: { value: "ERROR", matchType: Client.MatchType.Exact }
+   *     Level: { value: "ERROR", matchType: cdplogger.Client.MatchType.Exact }
    *   },
    *   limit: 100,
    *   offset: 0,
-   *   flags: Client.EventQueryFlags.NewestFirst
+   *   flags: cdplogger.Client.EventQueryFlags.NewestFirst
    * });
    * 
    * @param {Object} query - A simple plain object representing the EventQuery.
@@ -1016,9 +1018,6 @@ class Client {
     // Validate the query object before building the EventQuery.
     this._validateEventQuery(query);
 
-    const root = require('./generated/containerPb.js');
-    const { EventQuery } = root.DBMessaging.Protobuf;
-
     // Conditionally include these fields only if the user has set them
     const optionalFields = [
       "timeRangeBegin",
@@ -1119,4 +1118,7 @@ class Client {
   }
 }
 
-module.exports = Client;
+const cdplogger = {};
+cdplogger.Client = Client;
+
+module.exports = cdplogger;

examples/event.js

@@ -1,10 +1,10 @@
 // event.js
 // An example script to see filtered events
 
-const Client = require('../client');
+const cdplogger = require('../client');
 
 async function main() {
-  const client = new Client('ws://127.0.0.1:17000', false);
+  const client = new cdplogger.Client('ws://127.0.0.1:17000', false);
 
   try {
     console.log("Waiting for connection to establish...");
@@ -16,15 +16,15 @@ async function main() {
       senderConditions: [
         {
           value: "CDPLoggerDemoApp.InvalidLicense",
-          matchType: Client.MatchType.Exact
+          matchType: cdplogger.Client.MatchType.Exact
         }
       ],
       dataConditions: {
         "Text": {
           value: "*", // Wildcard condition for Text field
         }
       },
-      flags: Client.EventQueryFlags.NewestFirst | Client.EventQueryFlags.UseLogStampForTimeRange,
+      flags: cdplogger.Client.EventQueryFlags.NewestFirst | cdplogger.Client.EventQueryFlags.UseLogStampForTimeRange,
       limit: 10,   // Request a maximum of 10 events
       offset: 0    // Starting at the beginning
     };

examples/index.js

@@ -2,7 +2,7 @@
 // Example demonstration including an events query for a specific time range (UTC 9:40)
 
 global.WebSocket = require('ws');
-const Client = require('../client');
+const cdplogger = require('../client');
 
 // Print the node information (name, routing, and tags)
 function printLoggedNodes() {
@@ -64,7 +64,7 @@ async function main() {
 }
 
 // Create a new client instance. (In this example, autoReconnect is disabled.)
-const client = new Client('ws://127.0.0.1:17000', false);
+const client = new cdplogger.Client('ws://127.0.0.1:17000', false);
 
 // Instead of overriding ws.onopen (which may cancel internal logic),
 // add an event listener so that _onOpen is still called.

test/client.test.js

@@ -1,21 +1,21 @@
 /*global WebSocket*/
 global.WebSocket = require('ws');
-const Client = require('../client');
+const cdplogger = require('../client');
 const fakeData = require('./fakeData');
 
 describe('ClientTester', () => {
   let client;
   beforeEach(() => {
     // Override _connect to return a fake ws object that doesn't actually connect.
-    Client.prototype._connect = function(url) {
+    cdplogger.Client.prototype._connect = function(url) {
       return {
         _url: url,
         close: jest.fn(),
         send: jest.fn()
       };
     };
     // Create a new client instance.
-    client = new Client('127.0.0.1:17000', true);
+    client = new cdplogger.Client('127.0.0.1:17000', true);
     // By default, disable time sync for most tests.
     client.setEnableTimeSync(false);
     // Adjust lastTimeRequest so that a new time request would normally be triggered.

test/testTimeSync.js

@@ -1,5 +1,5 @@
 // testTimeSync.js
-const Client = require('../client');
+const cdplogger = require('../client');
 const fakeData = require('./fakeData');
 
 // Override WebSocket with a dummy that provides a send() method.
@@ -15,8 +15,8 @@ global.WebSocket = class {
 // --- Capture Request IDs for time sync vs. API calls ---
 let capturedTimeSyncRequestId = null;
 let capturedApiRequestId = null;
-const originalGetRequestId = Client.prototype._getRequestId;
-Client.prototype._getRequestId = function() {
+const originalGetRequestId = cdplogger.Client.prototype._getRequestId;
+cdplogger.Client.prototype._getRequestId = function() {
   const id = originalGetRequestId.call(this);
   if (capturedTimeSyncRequestId === null) {
     capturedTimeSyncRequestId = id;
@@ -77,7 +77,7 @@ async function runThrough(methodName, callFunc, simulateResponse) {
 
 async function runTest() {
   // Create a new client instance.
-  client = new Client('127.0.0.1:17000', true);
+  client = new cdplogger.Client('127.0.0.1:17000', true);
 
   // Override _sendTimeRequest to simulate a server time response with variable delay.
   client._sendTimeRequest = function (requestId) {