Integrate logger client into cdp-client with service-based discovery by stefanrammo · Pull Request #27 · CDPTechnologies/JavascriptCDPClient

stefanrammo · 2026-04-08T13:28:25Z

Bundle cdplogger-client as studio.logger and add client.logger() method that discovers loggers via ServicesNotification and connects through proxy transport via makeServiceTransport (CDP 5.1+).

client.logger(name, options): auto-discovers logserver proxy service, creates service transport, passes to LoggerClient constructor
client.loggers(): returns all discovered logger services as [{name, metadata}] after first ServicesNotification
LoggerClient constructor extended to accept service transport object in addition to endpoint string (autoReconnect forced false)
Caching by name with eviction on transport close
close() disconnects cached loggers and rejects pending promises
Logger transports registered in serviceConnections for proper cleanup on primary connection drop
Rejects immediately on CDP < 5.1 (no proxy protocol support)
Proto files use raw .proto.js format matching studioapi.proto.js, with Node/browser parity via require() and window globals
Unit tests adapted from cdplogger-client test suite
README.rst updated with Logger Integration API documentation

Initial implementation: logger, example usage, and tests

A test for Events using the example case in CDP Studio

This reverts commit cbea695.

Added event support

Fixes for added event support

Event data handling

Match type added and restructuring client.js

…ancies Fix documentation

…e-detection Add automatic detection to client.js between Node.js or browser

stefanrammo · 2026-04-08T13:36:25Z

The bundled logger client is adapted from https://github.com/CDPTechnologies/JavascriptCDPLoggerClient with these changes to support integration:

Proto loading: replaced pre-compiled containerPb.js with runtime protobuf.parse() of raw .proto.js files — same format as studioapi.proto.js, Node/browser parity via require() and window globals
Transport mode: constructor accepts a service transport object (duck-typed via typeof send === 'function'), forces autoReconnect = false, wires onopen/onmessage/onerror/onclose handlers — enables tunneling through StudioAPI proxy
disconnected flag: tracks connection state for cache eviction in client.logger()
_rejectIfDisconnected() guard: every public method rejects immediately after disconnect() or transport close
countEvents dispatch: added missing case in _sendQueuedRequests switch

Karmo7 · 2026-04-09T08:02:05Z

logger/logger-client.js

Were there any changes to this file? It would be better to make bringing in existing code a separate commit, so it would be easier to review the actual changes done after that.

By the way, we have a guide in our wiki how to merge repositories (or some files from a repository) while keeping commit history, search for the "Git tips & tricks" page. Then the development log of the logger client will be preserved.

Karmo7 · 2026-04-09T08:09:35Z

index.js

+    /**
+     * Get a logger client via service-based discovery and proxy transport (CDP 5.1+).
+     * @param {string} [name] - Logger service name (node path) to filter by.
+     * @param {Object} [options] - Options.


[options] - Options. - just repeating the argument name is not useful

Karmo7 · 2026-04-09T08:12:05Z

index.js

+    }
+
+    /**
+     * Get a logger client via service-based discovery and proxy transport (CDP 5.1+).


I think the doc should describe more what one can do with the logger client (query historic data) not how it was found. Should keep the CDP 5.1+ comment though

Karmo7 · 2026-04-09T08:12:39Z

index.js

+     * Get a logger client via service-based discovery and proxy transport (CDP 5.1+).
+     * @param {string} [name] - Logger service name (node path) to filter by.
+     * @param {Object} [options] - Options.
+     * @param {number} [options.timeout] - Timeout in milliseconds. Rejects if no matching service appears in time.


What happens when timeout is not specified?

Indefinite wait for server event using 2s sibling polling.

Karmo7 · 2026-04-09T08:15:49Z

index.js

+            reject("Logger service discovery requires CDP 5.1+");
+            return;
+          }
+          var service = primary.findLoggerService(name);


Does it also look for logger services from other sibling applications?

In case there are multiple apps in the system, the connection to logger can be "tunneled twice", e.g. StudioAPI client -> MainApp -> LoggerApp -> CDPLogger server.

Changed it, it searches all connections now

Karmo7 · 2026-04-09T08:17:41Z

README.rst

+    Auto-discovers the first available CDPLogger or LogServer via service discovery,
+    creates a proxy transport, and returns a ready-to-use logger client. Repeated calls
+    return the same cached instance. A cached logger whose transport has closed is evicted
+    on the next call.


Should explain why is it relevant to the user when the cached call is evicted

Karmo7 · 2026-04-09T08:23:10Z

README.rst

+For more information about CDP Logger, see https://cdpstudio.com/manual/cdp/cdplogger/cdplogger-index.html.
+
+Logger data is served behind StudioAPI authentication and tunneled through the
+existing proxy connection.


Should have somewhere also a longer description. Either in this file or a different file. The https://github.com/CDPTechnologies/JavascriptCDPLoggerClient/blob/main/DOCUMENTATION.md had a good overview and some background into what the logger can do.

And I also liked the examples folder in the logger client repo, maybe should copy those also over here.

Merge JavascriptCDPLoggerClient repository into logger/ with full commit history preserved. All files imported unchanged. Source: https://github.com/CDPTechnologies/JavascriptCDPLoggerClient

Karmo7 · 2026-04-10T09:12:06Z

index.js

+     * Discovers loggers from all applications in the system, including
+     * sibling apps connected via proxy.
+     * @param {string} [name] - Logger service name to filter by, e.g. "App.CDPLogger".
+     * @param {number} [options.timeout] - Timeout in milliseconds. Without timeout, waits indefinitely until a matching logger appears.


Should mention that timeout 0 means immediate fail if logger was not found.

Karmo7 · 2026-04-10T09:13:51Z

logger/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 CDP Technologies


Karmo7 · 2026-04-10T09:15:00Z

README.rst

+to manually discover the logger port or manage a separate WebSocket connection.
+For more information about CDP Logger, see https://cdpstudio.com/manual/cdp/cdplogger/cdplogger-index.html.
+For background on the data query protocol, time synchronization, and API version
+history, see `logger/DOCUMENTATION.md <logger/DOCUMENTATION.md>`_. Runnable


Make sure to test that this link still works after pushing the code to npm

Bundle cdplogger-client as studio.logger and add client.logger() method that discovers loggers via ServicesNotification and connects through proxy transport via makeServiceTransport (CDP 5.1+). - client.logger(name, options): auto-discovers logserver proxy service across all connections including sibling apps via proxy - client.loggers(): returns all discovered logger services - Sibling app discovery: searches all AppConnections, not just primary; serviceUpdateListeners fire on all connections; poll interval catches new siblings that appear after initial listener registration - Dead connection guard: isConnectionAlive() skips connections whose transport is closed, preventing stale service discovery - Caching by name with eviction on transport close; stale promise cleanup via .then(clearPromise, clearPromise) on both resolve/reject - close() disconnects cached loggers and rejects pending promises - Error() rejections matching existing find()/onConnect() patterns - Proto files use raw .proto.js format matching studioapi.proto.js - Standalone files from import removed (client.js, package.json, generated/, test/, .github/, QUICKSTART.md, README.md) - DOCUMENTATION.md updated for bundled context - Unit tests adapted from cdplogger-client test suite - README.rst Logger Integration section with API docs and examples - Examples (event.js, value.js) updated for proxy-based discovery

Karmo7 and others added 30 commits March 19, 2025 16:56

Initial commit

172f775

Update README.md

6e5c935

Initial implementation: logger, example usage, and tests

671a042

Merge pull request #1 from stefanrammo/main

96c1f87

Initial implementation: logger, example usage, and tests

Added support for Events and a test

cbea695

A test for Events using the example case in CDP Studio

Revert "Added support for Events and a test"

a5b4810

This reverts commit cbea695.

Added support for Events and a test

9d10355

Refactored event into a seperate example file

7853884

Updated README.md

f3a7845

Fixed bugs

d30440c

Merge pull request #4 from CDPTechnologies/AddedEventSupport

6ef60ca

Added event support

Fixed pull request issues

0d8b2f0

Added sender and data conditions to event example

2cf2c24

Merge pull request #5 from CDPTechnologies/FixesForAddedEventSupport

423fedd

Fixes for added event support

Pull review #5 issues fixed

b51959b

Added getEventCodeString method

a6746e3

Fixed comments

44133d4

Merge pull request #6 from CDPTechnologies/EventDataHandling

c0b9fce

Event data handling

Match type added and restructuring client.js

e912ad4

Merge pull request #7 from CDPTechnologies/MatchTypeFix

29a78d4

Match type added and restructuring client.js

Changed documentation and added objects: EventQueryFlags and MatchType

bdd29ee

Formatting

0a7c4f1

Added Event Tags support and Count Events

6511630

Added tests and fake data related to Event Tags

1b3465a

Wrapped Client in a namespace cdplogger.Client

bec0606

Add GitHub Actions workflow for running tests

0512a8a

Update workflow to handle missing test directories

50d5262

Simplify workflow to run on single Node.js version

cc9d10c

Add working GitHub Actions workflow for running tests

4df8074

Added automatic test workflow

3ebf57d

stefanrammo and others added 13 commits April 4, 2025 10:00

Removed hardcoded port adding to url

189a984

Created a markdown file for docs and a quick start guide

f03f42f

Fixed documentation mistakes

bce99c9

NPM setup

f6aa706

Updated package.json

dc2dad6

Added contacts to README

b182d64

Updated docs

15621e0

Changed name from cdp-logger-client to cdplogger-client

3fdaba7

Publish version 1.0.2 and update package.json and README

2845852

Fix documentation

67a6a55

Merge pull request #13 from CDPTechnologies/fix-documentation-discrep…

5c158f8

…ancies Fix documentation

Add automatic detection to client.js between Node.js or browser

62136b6

Merge pull request #14 from CDPTechnologies/add-automatic-browser-nod…

bd73418

…e-detection Add automatic detection to client.js between Node.js or browser

stefanrammo requested review from Karmo7 and nuubik April 8, 2026 13:45

Karmo7 requested changes Apr 9, 2026

View reviewed changes

Import cdplogger-client into logger/ subdirectory

36bc568

Merge JavascriptCDPLoggerClient repository into logger/ with full commit history preserved. All files imported unchanged. Source: https://github.com/CDPTechnologies/JavascriptCDPLoggerClient

stefanrammo force-pushed the logger-client-integration branch from e8addfd to d4d7903 Compare April 9, 2026 17:19

Karmo7 approved these changes Apr 10, 2026

View reviewed changes

stefanrammo force-pushed the logger-client-integration branch from d4d7903 to 447cc35 Compare April 10, 2026 09:39

nuubik approved these changes Apr 10, 2026

View reviewed changes

stefanrammo merged commit fe96b14 into main Apr 10, 2026
4 checks passed

		@@ -0,0 +1,21 @@
		MIT License

		Copyright (c) 2025 CDP Technologies

Conversation

stefanrammo commented Apr 8, 2026

Uh oh!

stefanrammo commented Apr 8, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants