@@ -4,7 +4,10 @@ import { assert, describe, it } from "@effect/vitest";
44import * as Effect from "effect/Effect" ;
55import * as FileSystem from "effect/FileSystem" ;
66import * as Layer from "effect/Layer" ;
7+ import * as Metric from "effect/Metric" ;
78import * as Schema from "effect/Schema" ;
9+ import * as HttpClient from "effect/unstable/http/HttpClient" ;
10+ import * as HttpClientResponse from "effect/unstable/http/HttpClientResponse" ;
811
912import * as DesktopConfig from "./DesktopConfig.ts" ;
1013import * as DesktopEnvironment from "./DesktopEnvironment.ts" ;
@@ -49,19 +52,69 @@ const environmentInput = (baseDir: string) =>
4952 runningUnderArm64Translation : false ,
5053 } ) satisfies DesktopEnvironment . MakeDesktopEnvironmentInput ;
5154
52- const makeEnvironmentLayer = ( baseDir : string , isDevelopment = true ) =>
55+ const makeEnvironmentLayer = (
56+ baseDir : string ,
57+ isDevelopment = true ,
58+ env : Readonly < Record < string , string | undefined > > = { } ,
59+ ) =>
5360 DesktopEnvironment . layer ( environmentInput ( baseDir ) ) . pipe (
5461 Layer . provide (
5562 Layer . mergeAll (
5663 NodeServices . layer ,
5764 DesktopConfig . layerTest ( {
5865 T3CODE_HOME : baseDir ,
5966 VITE_DEV_SERVER_URL : isDevelopment ? "http://127.0.0.1:5733" : undefined ,
67+ ...env ,
6068 } ) ,
6169 ) ,
6270 ) ,
6371 ) ;
6472
73+ interface ExportedRequest {
74+ readonly url : string ;
75+ readonly headers : Readonly < Record < string , string > > ;
76+ readonly body : string ;
77+ }
78+
79+ /** Answers every export with a 200 and keeps what was posted for assertions. */
80+ const collectorLayer = ( requests : Array < ExportedRequest > ) =>
81+ Layer . succeed (
82+ HttpClient . HttpClient ,
83+ HttpClient . make ( ( request ) =>
84+ Effect . sync ( ( ) => {
85+ requests . push ( {
86+ url : request . url ,
87+ headers : request . headers ,
88+ body :
89+ request . body . _tag === "Uint8Array" ? new TextDecoder ( ) . decode ( request . body . body ) : "" ,
90+ } ) ;
91+ return HttpClientResponse . fromWeb ( request , new Response ( null , { status : 200 } ) ) ;
92+ } ) ,
93+ ) ,
94+ ) ;
95+
96+ const encodeObservabilitySettingsFile = Schema . encodeSync (
97+ Schema . fromJsonString (
98+ Schema . Struct ( { observability : Schema . Record ( Schema . String , Schema . String ) } ) ,
99+ ) ,
100+ ) ;
101+
102+ const writeObservabilitySettings = Effect . fn ( function * (
103+ environmentLayer : ReturnType < typeof makeEnvironmentLayer > ,
104+ observability : Readonly < Record < string , string > > ,
105+ ) {
106+ const fileSystem = yield * FileSystem . FileSystem ;
107+ const { path, serverSettingsPath } = yield * Effect . gen ( function * ( ) {
108+ const environment = yield * DesktopEnvironment . DesktopEnvironment ;
109+ return environment ;
110+ } ) . pipe ( Effect . provide ( environmentLayer ) ) ;
111+ yield * fileSystem . makeDirectory ( path . dirname ( serverSettingsPath ) , { recursive : true } ) ;
112+ yield * fileSystem . writeFileString (
113+ serverSettingsPath ,
114+ encodeObservabilitySettingsFile ( { observability } ) ,
115+ ) ;
116+ } ) ;
117+
65118describe ( "DesktopObservability" , ( ) => {
66119 it ( "advances a retained output offset instead of repeatedly copying a full head chunk" , ( ) => {
67120 const maxBufferedBytes = 1024 * 1024 ;
@@ -328,4 +381,140 @@ describe("DesktopObservability", () => {
328381 Effect . provide ( Layer . mergeAll ( NodeServices . layer , NodeHttpClient . layerUndici ) ) ,
329382 ) ,
330383 ) ;
384+
385+ it . effect ( "exports main process log records to the configured logs endpoint" , ( ) => {
386+ const requests : Array < ExportedRequest > = [ ] ;
387+ return Effect . gen ( function * ( ) {
388+ const fileSystem = yield * FileSystem . FileSystem ;
389+ const baseDir = yield * fileSystem . makeTempDirectoryScoped ( {
390+ prefix : "t3-desktop-observability-test-" ,
391+ } ) ;
392+ const environmentLayer = makeEnvironmentLayer ( baseDir , true , {
393+ T3CODE_OTLP_LOGS_URL : "https://collector.example.com/v1/logs" ,
394+ T3CODE_OTLP_HEADERS : "x-scope=desktop" ,
395+ } ) ;
396+ const tracePath = yield * Effect . gen ( function * ( ) {
397+ const environment = yield * DesktopEnvironment . DesktopEnvironment ;
398+ return environment . path . join ( environment . logDir , "desktop.trace.ndjson" ) ;
399+ } ) . pipe ( Effect . provide ( environmentLayer ) ) ;
400+
401+ yield * Effect . scoped (
402+ Effect . logInfo ( "desktop log export" ) . pipe (
403+ Effect . withSpan ( "desktop-log-export-test" ) ,
404+ Effect . provide ( DesktopObservability . layer . pipe ( Layer . provideMerge ( environmentLayer ) ) ) ,
405+ ) ,
406+ ) ;
407+
408+ assert . lengthOf ( requests , 1 ) ;
409+ const [ request ] = requests ;
410+ assert . strictEqual ( request ?. url , "https://collector.example.com/v1/logs" ) ;
411+ assert . include ( request ?. body ?? "" , "desktop log export" ) ;
412+ assert . include ( request ?. body ?? "" , "service.runtime" ) ;
413+ assert . strictEqual ( request ?. headers [ "x-scope" ] , "desktop" ) ;
414+
415+ // The log record is the export now, so the same message must not also
416+ // ride along as an event on the span.
417+ const record = ( yield * fileSystem . readFileString ( tracePath ) )
418+ . trim ( )
419+ . split ( "\n" )
420+ . filter ( ( line ) => line . length > 0 )
421+ . map ( ( line ) => decodeTraceRecordLine ( line ) )
422+ . find ( ( entry ) => entry . name === "desktop-log-export-test" ) ;
423+ assert . notEqual ( record , undefined ) ;
424+ assert . lengthOf ( record ?. events ?? [ ] , 0 ) ;
425+ } ) . pipe (
426+ Effect . scoped ,
427+ Effect . provide ( Layer . mergeAll ( NodeServices . layer , collectorLayer ( requests ) ) ) ,
428+ ) ;
429+ } ) ;
430+
431+ it . effect ( "exports main process metrics to the configured metrics endpoint" , ( ) => {
432+ const requests : Array < ExportedRequest > = [ ] ;
433+ return Effect . gen ( function * ( ) {
434+ const fileSystem = yield * FileSystem . FileSystem ;
435+ const baseDir = yield * fileSystem . makeTempDirectoryScoped ( {
436+ prefix : "t3-desktop-observability-test-" ,
437+ } ) ;
438+ const environmentLayer = makeEnvironmentLayer ( baseDir , true , {
439+ T3CODE_OTLP_METRICS_URL : "https://collector.example.com/v1/metrics" ,
440+ } ) ;
441+
442+ yield * Effect . scoped (
443+ Metric . update ( Metric . counter ( "desktop_metrics_export_test_total" ) , 1 ) . pipe (
444+ Effect . provide ( DesktopObservability . layer . pipe ( Layer . provideMerge ( environmentLayer ) ) ) ,
445+ ) ,
446+ ) ;
447+
448+ assert . lengthOf ( requests , 1 ) ;
449+ assert . strictEqual ( requests [ 0 ] ?. url , "https://collector.example.com/v1/metrics" ) ;
450+ assert . include ( requests [ 0 ] ?. body ?? "" , "desktop_metrics_export_test_total" ) ;
451+ } ) . pipe (
452+ Effect . scoped ,
453+ Effect . provide ( Layer . mergeAll ( NodeServices . layer , collectorLayer ( requests ) ) ) ,
454+ ) ;
455+ } ) ;
456+
457+ it . effect ( "reads every signal endpoint from Settings when the environment names none" , ( ) => {
458+ const requests : Array < ExportedRequest > = [ ] ;
459+ return Effect . gen ( function * ( ) {
460+ const fileSystem = yield * FileSystem . FileSystem ;
461+ const baseDir = yield * fileSystem . makeTempDirectoryScoped ( {
462+ prefix : "t3-desktop-observability-test-" ,
463+ } ) ;
464+ const environmentLayer = makeEnvironmentLayer ( baseDir ) ;
465+ yield * writeObservabilitySettings ( environmentLayer , {
466+ otlpLogsUrl : "https://settings.example.com/v1/logs" ,
467+ otlpMetricsUrl : "https://settings.example.com/v1/metrics" ,
468+ } ) ;
469+
470+ yield * Effect . scoped (
471+ Effect . gen ( function * ( ) {
472+ yield * Effect . logInfo ( "desktop log export from settings" ) ;
473+ yield * Metric . update ( Metric . counter ( "desktop_settings_export_test_total" ) , 1 ) ;
474+ } ) . pipe (
475+ Effect . provide ( DesktopObservability . layer . pipe ( Layer . provideMerge ( environmentLayer ) ) ) ,
476+ ) ,
477+ ) ;
478+
479+ assert . deepEqual ( requests . map ( ( request ) => request . url ) . toSorted ( ) , [
480+ "https://settings.example.com/v1/logs" ,
481+ "https://settings.example.com/v1/metrics" ,
482+ ] ) ;
483+ assert . include (
484+ requests . find ( ( request ) => request . url . endsWith ( "/v1/logs" ) ) ?. body ?? "" ,
485+ "desktop log export from settings" ,
486+ ) ;
487+ assert . include (
488+ requests . find ( ( request ) => request . url . endsWith ( "/v1/metrics" ) ) ?. body ?? "" ,
489+ "desktop_settings_export_test_total" ,
490+ ) ;
491+ } ) . pipe (
492+ Effect . scoped ,
493+ Effect . provide ( Layer . mergeAll ( NodeServices . layer , collectorLayer ( requests ) ) ) ,
494+ ) ;
495+ } ) ;
496+
497+ it . effect ( "stays off the network when no endpoint is configured" , ( ) => {
498+ const requests : Array < ExportedRequest > = [ ] ;
499+ return Effect . gen ( function * ( ) {
500+ const fileSystem = yield * FileSystem . FileSystem ;
501+ const baseDir = yield * fileSystem . makeTempDirectoryScoped ( {
502+ prefix : "t3-desktop-observability-test-" ,
503+ } ) ;
504+
505+ yield * Effect . scoped (
506+ Effect . logInfo ( "desktop log stays local" ) . pipe (
507+ Effect . withSpan ( "desktop-offline-test" ) ,
508+ Effect . provide (
509+ DesktopObservability . layer . pipe ( Layer . provideMerge ( makeEnvironmentLayer ( baseDir ) ) ) ,
510+ ) ,
511+ ) ,
512+ ) ;
513+
514+ assert . lengthOf ( requests , 0 ) ;
515+ } ) . pipe (
516+ Effect . scoped ,
517+ Effect . provide ( Layer . mergeAll ( NodeServices . layer , collectorLayer ( requests ) ) ) ,
518+ ) ;
519+ } ) ;
331520} ) ;
0 commit comments