feat: view SDK events on ldcli dev server by dmashuda · Pull Request #596 · launchdarkly/ldcli

dmashuda · 2025-08-04T19:35:56Z

Add SDK Event to Ldcli:

1.) Adds a new navigation so that uses can switch between multiple pages
2.) Adds new local event debugger:

When a user is viewing the "Events" Page:

A new "Debug Session" is created
SDK events are streamed via SSE to the frontend and displayed
SDK events are stored on the "Debug Session

A User can View/Delete Debug Sessions:

When A user is viewing a past "Debug Session", they can search for events:

This reverts commit 0774bfc.

This reverts commit 4a251b4.

This reverts commit 62b25bf.

This reverts commit 9731ced.

…i into moonshot-xxii-debugger

mike-zorn · 2025-08-19T23:49:30Z

internal/dev_server/sdk/routes.go

-	router.HandleFunc("/bulk", DevNull)
+	router.HandleFunc("/bulk", SdkEventsReceiveHandler)
 	router.HandleFunc("/diagnostic", DevNull)
+	router.HandleFunc("/events/tee", SdkEventsTeeHandler)


What is this for?

mike-zorn · 2025-08-19T23:49:56Z

internal/dev_server/sdk/routes.go

+	router.HandleFunc("/bulk", SdkEventsReceiveHandler)
 	router.HandleFunc("/diagnostic", DevNull)
+	router.HandleFunc("/events/tee", SdkEventsTeeHandler)
 	router.Handle("/events/bulk/{envId}", EventsCorsHeaders(DevNull))


This one is for js sdk events

mike-zorn · 2025-08-19T23:50:13Z

internal/dev_server/sdk/routes.go

 	router.HandleFunc("/mobile", DevNull)
 	router.HandleFunc("/mobile/events", DevNull)


These are for old mobile SDKs

mike-zorn · 2025-08-19T23:51:26Z

internal/dev_server/ui/src/EventsPage.tsx

+
+      const newEvent: EventData = {
+        id: Math.random().toString(36).slice(2, 11),
+        timestamp: Date.now(),


😕 what is this doing?

@moribellamy setting an initial fake event like this necessary still or was this just during prototyping?

this looks like a real event to me, as collected by the server on line 25. id is so dom elements can have something unique to help react caching.

am i missing something?

ahh, so the id is just for the DOM. Why is the timestamp being set like this though? The events should have a timestamp in there.

Updated it to try and use the timestamp from the event in 252a933

mike-zorn · 2025-08-19T23:52:53Z

internal/dev_server/model/flags_state.go

-	Version int           `json:"version"`
+	Value       ldvalue.Value `json:"value"`
+	Version     int           `json:"version"`
+	TrackEvents bool          `json:"trackEvents"`


What behavior do we want? This will send an event for every flag eval which is not what will happen in real LD.

Our thought was any flag with an override, we can set trackEvents to be true to mimics like the flag is under an experiment/guarded rollout

Interesting. I guess that kinda makes sense, but the behavior needs to be documented somewhere. Maybe a new events section in the reference guide?

mike-zorn · 2025-08-19T23:54:40Z

internal/dev_server/events_db/sqlite.go

+
+	// Get total count for pagination info
+	var totalCount int64
+	countQuery := `SELECT count(DISTINCT(debug_session_key)) FROM debug_events`


query the other table

it is possible for a debug_session to end up with 0 events, and we did not want to show show those.

The main list query for events also excludes debug_sessions with 0 events

And we purge the orphaned debug_sessions at startup: http://github.com/launchdarkly/ldcli/pull/596/files#diff-bb1801aac503b2e2234ecb22f46b77b6d090c9274966475e2a2873f76166d20dR179

ahhhhh got it. Makes sense

mike-zorn · 2025-08-19T23:58:06Z

internal/dev_server/sdk/sdk_events.go

+	writer.WriteHeader(http.StatusAccepted)
+}
+
+func SdkEventsTeeHandler(writer http.ResponseWriter, request *http.Request) {


ohhhh. I get what this is for now. I think we should move this to not be in the SDK package. Similarly for this observer.

mike-zorn · 2025-08-20T00:05:32Z

internal/dev_server/sdk/sdk_events.go

+
+var observers *model.Observers = model.NewObservers()
+
+func SdkEventsReceiveHandler(writer http.ResponseWriter, request *http.Request) {


This is kinda busting the testable MVC-like pattern elsewhere in the dev server. I'd like to see this factored into the model so that we can have a test for the behavior independent of http.

mike-zorn · 2025-08-26T00:03:51Z

internal/dev_server/ui/src/EventsTable.tsx

+    <div>
+      <h3>Events Stream</h3>
+      {onToggleStreaming && (
+        <button


Why aren't launchpad components being used?

tvarney13 · 2025-09-17T18:02:27Z

Picking this back up, doccing the local dev loop:

run Okteto services
kill your dev server in Okteto
run local Gonfalon
run local Dev Server via make - make sure the base URL is catamorphic (docker-compose.yml for dev-server)

brianvans · 2025-09-18T23:29:45Z

internal/dev_server/ui/src/DebugSessionsPage.tsx

+        </Text>
+      </Box>
+
+      {debugSessions.length === 0 ? (


Getting a crash instead of showing zero-state page here

Uncaught TypeError: can't access property "length", debugSessions is null

Fixed in eb221a6

Resolves an issue where viewing a debug session and then going back in history caused pages to stop re-rendering

moribellamy

LGTM

dmashuda and others added 30 commits August 4, 2025 15:34

Add endpoint

0b42cf4

Update logging

edb122e

Add run configs

3807d19

Fix printly

3604ac0

Fix precommit

5db6c4d

fix typo in function name

5c75a46

SSE plumbing

026d81a

observer pattern

dbe2abc

rm nil check

fd32694

Add toggle for new "events" section on SPA.

4a251b4

modes for SPA

0774bfc

Revert "modes for SPA"

2c82092

This reverts commit 0774bfc.

Revert "Add toggle for new "events" section on SPA."

4086268

This reverts commit 4a251b4.

update git ignore

6a4c791

rename app to flagpage

9731ced

finish multi-page refactor

62b25bf

Revert "finish multi-page refactor"

2ae6b6a

This reverts commit 62b25bf.

Revert "rename app to flagpage"

f5b5fe7

This reverts commit 9731ced.

Merge remote-tracking branch 'origin/main' into moonshot-xxii-debugger

5f614b8

add buttons to swap

0974eb5

Add event splitting

f3b19db

Switch to raw message

a4fde70

initial stream page

770455a

Merge branch 'moonshot-xxii-debugger' of github.com:launchdarkly/ldcl…

d9fdfb6

…i into moonshot-xxii-debugger

Add kind selection

8228fa8

take event rendering to be its own component

f124472

Merge branch 'moonshot-xxii-debugger' of github.com:launchdarkly/ldcl…

3936b51

…i into moonshot-xxii-debugger

list

ecce163

add basic tabularization of summary events

c3fd209

more context types

9ca3e16

mike-zorn reviewed Aug 19, 2025

View reviewed changes

mike-zorn reviewed Aug 20, 2025

View reviewed changes

dmashuda added 3 commits August 20, 2025 09:13

Docs

6d0153a

Move event base

338e2ab

Move events api to its own package because its a cross-cutting concern

f00ec6a

mike-zorn reviewed Aug 26, 2025

View reviewed changes

brianvans reviewed Sep 18, 2025

View reviewed changes

brianvans added 6 commits September 18, 2025 18:48

Use launchdpad components for everything

8bd0edc

Fix debug sessions page zero state crash

eb221a6

Use event timestamps over now() where possible

252a933

Heading > h3

7056473

Merge remote-tracking branch 'origin/main' into moonshot-xxii-debugger

dbfa198

Fix issue where some pages dont re-render

d77388b

Resolves an issue where viewing a debug session and then going back in history caused pages to stop re-rendering

brianvans force-pushed the moonshot-xxii-debugger branch from 618cb61 to d77388b Compare September 26, 2025 00:01

brianvans and others added 3 commits September 25, 2025 17:49

Linter

38e6c8b

Revive the favicon by skipping SPA for /ui/*.svg

2722b1d

Remove log spam

efcb03c

brianvans requested a review from moribellamy September 29, 2025 17:51

moribellamy approved these changes Sep 29, 2025

View reviewed changes

brianvans merged commit cffa7ec into main Sep 30, 2025
11 checks passed

brianvans deleted the moonshot-xxii-debugger branch September 30, 2025 15:57

github-actions bot mentioned this pull request Sep 30, 2025

chore(main): release 1.18.0 #625

Merged

BrewTestBot mentioned this pull request Sep 30, 2025

ldcli 1.18.0 Homebrew/homebrew-core#246365

Merged

		router.HandleFunc("/mobile", DevNull)
		router.HandleFunc("/mobile/events", DevNull)


		var observers *model.Observers = model.NewObservers()

		func SdkEventsReceiveHandler(writer http.ResponseWriter, request *http.Request) {

Conversation

dmashuda commented Aug 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

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!

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!

tvarney13 commented Sep 17, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

moribellamy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

dmashuda commented Aug 4, 2025 •

edited

Loading