Skip to content

Commit 35835a7

Browse files
Unify desktop component logging
- Introduce a shared component logger helper for desktop services - Replace ad hoc log annotations across startup, backend, updates, menu, and window code
1 parent dc3aa27 commit 35835a7

8 files changed

Lines changed: 131 additions & 125 deletions

File tree

‎apps/desktop/src/app/DesktopApp.ts‎

Lines changed: 30 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ import * as DesktopApplicationMenu from "../window/DesktopApplicationMenu.ts";
1515
import * as DesktopBackendManager from "../backend/DesktopBackendManager.ts";
1616
import * as DesktopEnvironment from "./DesktopEnvironment.ts";
1717
import * as DesktopLifecycle from "./DesktopLifecycle.ts";
18+
import * as DesktopObservability from "./DesktopObservability.ts";
1819
import * as DesktopServerExposure from "../serverExposure/DesktopServerExposure.ts";
1920
import * as DesktopAppSettings from "../settings/DesktopAppSettings.ts";
2021
import * as DesktopShellEnvironment from "../shell/DesktopShellEnvironment.ts";
@@ -49,6 +50,12 @@ class DesktopDevelopmentBackendPortRequiredError extends Data.TaggedError(
4950
}
5051
}
5152

53+
const { logInfo: logBootstrapInfo, logWarning: logBootstrapWarning } =
54+
DesktopObservability.makeComponentLogger("desktop-bootstrap");
55+
56+
const { logInfo: logStartupInfo, logError: logStartupError } =
57+
DesktopObservability.makeComponentLogger("desktop-startup");
58+
5259
const resolveDesktopBackendPort = Effect.fn("resolveDesktopBackendPort")(function* (
5360
configuredPort: Option.Option<number>,
5461
) {
@@ -103,13 +110,11 @@ const handleFatalStartupError = Effect.fn("desktop.startup.handleFatalStartupErr
103110
const message = error instanceof Error ? error.message : String(error);
104111
const detail =
105112
error instanceof Error && typeof error.stack === "string" ? `\n${error.stack}` : "";
106-
yield* Effect.logError("fatal startup error").pipe(
107-
Effect.annotateLogs({
108-
stage,
109-
message,
110-
...(detail.length > 0 ? { detail } : {}),
111-
}),
112-
);
113+
yield* logStartupError("fatal startup error", {
114+
stage,
115+
message,
116+
...(detail.length > 0 ? { detail } : {}),
117+
});
113118
const wasQuitting = yield* Ref.getAndSet(state.quitting, true);
114119
if (!wasQuitting) {
115120
yield* electronDialog.showErrorBox(
@@ -130,52 +135,51 @@ const bootstrap = Effect.gen(function* () {
130135
const environment = yield* DesktopEnvironment.DesktopEnvironment;
131136
const desktopSettings = yield* DesktopAppSettings.DesktopAppSettings;
132137
const serverExposure = yield* DesktopServerExposure.DesktopServerExposure;
133-
yield* Effect.logInfo("bootstrap start");
138+
yield* logBootstrapInfo("bootstrap start");
134139

135140
if (environment.isDevelopment && Option.isNone(environment.configuredBackendPort)) {
136141
return yield* new DesktopDevelopmentBackendPortRequiredError();
137142
}
138143

139144
const backendPortSelection = yield* resolveDesktopBackendPort(environment.configuredBackendPort);
140145
const backendPort = backendPortSelection.port;
141-
yield* Effect.logInfo(
146+
yield* logBootstrapInfo(
142147
backendPortSelection.selectedByScan
143148
? "selected backend port via sequential scan"
144149
: "using configured backend port",
145-
).pipe(
146-
Effect.annotateLogs({
150+
{
147151
port: backendPort,
148152
...(backendPortSelection.selectedByScan ? { startPort: DEFAULT_DESKTOP_BACKEND_PORT } : {}),
149-
}),
153+
},
150154
);
151155

152156
const settings = yield* desktopSettings.get;
153157
if (settings.serverExposureMode !== environment.defaultDesktopSettings.serverExposureMode) {
154-
yield* Effect.logInfo("bootstrap restoring persisted server exposure mode").pipe(
155-
Effect.annotateLogs({ mode: settings.serverExposureMode }),
156-
);
158+
yield* logBootstrapInfo("bootstrap restoring persisted server exposure mode", {
159+
mode: settings.serverExposureMode,
160+
});
157161
}
158162
const serverExposureState = yield* serverExposure.configureFromSettings({ port: backendPort });
159163
const backendConfig = yield* serverExposure.backendConfig;
160-
yield* Effect.logInfo("bootstrap resolved backend endpoint").pipe(
161-
Effect.annotateLogs({ baseUrl: backendConfig.httpBaseUrl.href }),
162-
);
164+
yield* logBootstrapInfo("bootstrap resolved backend endpoint", {
165+
baseUrl: backendConfig.httpBaseUrl.href,
166+
});
163167
if (serverExposureState.endpointUrl) {
164-
yield* Effect.logInfo("bootstrap enabled network access").pipe(
165-
Effect.annotateLogs({ endpointUrl: serverExposureState.endpointUrl }),
166-
);
168+
yield* logBootstrapInfo("bootstrap enabled network access", {
169+
endpointUrl: serverExposureState.endpointUrl,
170+
});
167171
} else if (settings.serverExposureMode === "network-accessible") {
168-
yield* Effect.logWarning(
172+
yield* logBootstrapWarning(
169173
"bootstrap fell back to local-only because no advertised network host was available",
170174
);
171175
}
172176

173177
yield* installDesktopIpcHandlers;
174-
yield* Effect.logInfo("bootstrap ipc handlers registered");
178+
yield* logBootstrapInfo("bootstrap ipc handlers registered");
175179

176180
if (!(yield* Ref.get(state.quitting))) {
177181
yield* backendManager.start;
178-
yield* Effect.logInfo("bootstrap backend start requested");
182+
yield* logBootstrapInfo("bootstrap backend start requested");
179183
}
180184
}).pipe(Effect.withSpan("desktop.bootstrap"));
181185

@@ -193,9 +197,7 @@ const startup = Effect.gen(function* () {
193197
yield* shellEnvironment.installIntoProcess;
194198
const userDataPath = yield* appIdentity.resolveUserDataPath;
195199
yield* electronApp.setPath("userData", userDataPath);
196-
yield* Effect.logInfo("runtime logging configured").pipe(
197-
Effect.annotateLogs({ logDir: environment.logDir }),
198-
);
200+
yield* logStartupInfo("runtime logging configured", { logDir: environment.logDir });
199201
yield* desktopSettings.load;
200202

201203
if (environment.platform === "linux") {
@@ -209,7 +211,7 @@ const startup = Effect.gen(function* () {
209211
Effect.withSpan("desktop.electron.whenReady"),
210212
Effect.catchCause((cause) => fatalStartupCause("whenReady", cause)),
211213
);
212-
yield* Effect.logInfo("app ready");
214+
yield* logStartupInfo("app ready");
213215
yield* appIdentity.configure;
214216
yield* applicationMenu.configure;
215217
yield* electronProtocol.registerDesktopFileProtocol;

‎apps/desktop/src/app/DesktopLifecycle.ts‎

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ import * as Scope from "effect/Scope";
99
import type * as Electron from "electron";
1010

1111
import * as DesktopEnvironment from "./DesktopEnvironment.ts";
12+
import * as DesktopObservability from "./DesktopObservability.ts";
1213
import * as ElectronApp from "../electron/ElectronApp.ts";
1314
import * as ElectronTheme from "../electron/ElectronTheme.ts";
1415
import * as DesktopState from "./DesktopState.ts";
@@ -64,13 +65,8 @@ export class DesktopLifecycle extends Context.Service<DesktopLifecycle, DesktopL
6465
"t3/desktop/Lifecycle",
6566
) {}
6667

67-
const logLifecycleInfo = (message: string, annotations?: Record<string, unknown>) =>
68-
Effect.logInfo(message).pipe(
69-
Effect.annotateLogs({
70-
component: "desktop-lifecycle",
71-
...annotations,
72-
}),
73-
);
68+
const { logInfo: logLifecycleInfo, logError: logLifecycleError } =
69+
DesktopObservability.makeComponentLogger("desktop-lifecycle");
7470

7571
function addScopedListener<Args extends ReadonlyArray<unknown>>(
7672
target: unknown,
@@ -178,12 +174,9 @@ export const layer = Layer.succeed(
178174
yield* electronApp.exit(0);
179175
}).pipe(
180176
Effect.catchCause((cause) =>
181-
Effect.logError("desktop relaunch failed").pipe(
182-
Effect.annotateLogs({
183-
component: "desktop-lifecycle",
184-
cause: Cause.pretty(cause),
185-
}),
186-
),
177+
logLifecycleError("desktop relaunch failed", {
178+
cause: Cause.pretty(cause),
179+
}),
187180
),
188181
Effect.forkDetach,
189182
Effect.asVoid,

‎apps/desktop/src/app/DesktopObservability.ts‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,40 @@ export class DesktopBackendOutputLog extends Context.Service<
4848
const textEncoder = new TextEncoder();
4949
const textDecoder = new TextDecoder();
5050

51+
export type DesktopLogAnnotations = Record<string, unknown>;
52+
53+
export interface DesktopComponentLogger {
54+
readonly annotate: <A, E, R>(
55+
effect: Effect.Effect<A, E, R>,
56+
annotations?: DesktopLogAnnotations,
57+
) => Effect.Effect<A, E, R>;
58+
readonly logDebug: (message: string, annotations?: DesktopLogAnnotations) => Effect.Effect<void>;
59+
readonly logInfo: (message: string, annotations?: DesktopLogAnnotations) => Effect.Effect<void>;
60+
readonly logWarning: (
61+
message: string,
62+
annotations?: DesktopLogAnnotations,
63+
) => Effect.Effect<void>;
64+
readonly logError: (message: string, annotations?: DesktopLogAnnotations) => Effect.Effect<void>;
65+
}
66+
67+
export function makeComponentLogger(component: string): DesktopComponentLogger {
68+
const annotate: DesktopComponentLogger["annotate"] = (effect, annotations) =>
69+
effect.pipe(
70+
Effect.annotateLogs({
71+
component,
72+
...annotations,
73+
}),
74+
);
75+
76+
return {
77+
annotate,
78+
logDebug: (message, annotations) => annotate(Effect.logDebug(message), annotations),
79+
logInfo: (message, annotations) => annotate(Effect.logInfo(message), annotations),
80+
logWarning: (message, annotations) => annotate(Effect.logWarning(message), annotations),
81+
logError: (message, annotations) => annotate(Effect.logError(message), annotations),
82+
};
83+
}
84+
5185
class DesktopLogFileWriterConfigurationError extends Data.TaggedError(
5286
"DesktopLogFileWriterConfigurationError",
5387
)<{

‎apps/desktop/src/backend/DesktopBackendConfiguration.ts‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ import * as Ref from "effect/Ref";
99

1010
import * as DesktopBackendManager from "./DesktopBackendManager.ts";
1111
import * as DesktopEnvironment from "../app/DesktopEnvironment.ts";
12+
import * as DesktopObservability from "../app/DesktopObservability.ts";
1213
import * as DesktopServerExposure from "../serverExposure/DesktopServerExposure.ts";
1314

1415
export interface DesktopBackendConfigurationShape {
@@ -46,6 +47,10 @@ const DESKTOP_BACKEND_ENV_NAMES = [
4647
const backendChildEnvPatch = (): Record<string, string | undefined> =>
4748
Object.fromEntries(DESKTOP_BACKEND_ENV_NAMES.map((name) => [name, undefined]));
4849

50+
const { logWarning: logBackendConfigurationWarning } = DesktopObservability.makeComponentLogger(
51+
"desktop-backend-configuration",
52+
);
53+
4954
const readPersistedBackendObservabilitySettings: Effect.Effect<
5055
BackendObservabilitySettings,
5156
never,
@@ -62,7 +67,9 @@ const readPersistedBackendObservabilitySettings: Effect.Effect<
6267

6368
const raw = yield* fileSystem.readFileString(environment.serverSettingsPath).pipe(Effect.option);
6469
if (Option.isNone(raw)) {
65-
yield* Effect.logWarning("failed to read persisted backend observability settings");
70+
yield* logBackendConfigurationWarning(
71+
"failed to read persisted backend observability settings",
72+
);
6673
return emptyBackendObservabilitySettings;
6774
}
6875

‎apps/desktop/src/backend/DesktopBackendManager.ts‎

Lines changed: 26 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,21 @@
1+
import * as Cause from "effect/Cause";
2+
import * as Context from "effect/Context";
3+
import * as Data from "effect/Data";
14
import * as Duration from "effect/Duration";
25
import * as Effect from "effect/Effect";
6+
import * as Exit from "effect/Exit";
7+
import * as Fiber from "effect/Fiber";
38
import * as FileSystem from "effect/FileSystem";
49
import * as Layer from "effect/Layer";
510
import * as Option from "effect/Option";
6-
import * as Schema from "effect/Schema";
7-
import * as Scope from "effect/Scope";
8-
import * as Stream from "effect/Stream";
9-
import * as Result from "effect/Result";
1011
import * as PlatformError from "effect/PlatformError";
11-
import * as Data from "effect/Data";
12-
import * as Context from "effect/Context";
13-
import * as Fiber from "effect/Fiber";
14-
import * as Exit from "effect/Exit";
15-
import * as Schedule from "effect/Schedule";
1612
import * as Ref from "effect/Ref";
13+
import * as Result from "effect/Result";
14+
import * as Schedule from "effect/Schedule";
15+
import * as Schema from "effect/Schema";
1716
import * as Semaphore from "effect/Semaphore";
17+
import * as Scope from "effect/Scope";
18+
import * as Stream from "effect/Stream";
1819
import { HttpClient } from "effect/unstable/http";
1920
import { ChildProcess, ChildProcessSpawner } from "effect/unstable/process";
2021

@@ -117,6 +118,9 @@ export class DesktopBackendManager extends Context.Service<
117118
DesktopBackendManagerShape
118119
>()("t3/desktop/BackendManager") {}
119120

121+
const { logWarning: logBackendManagerWarning, logError: logBackendManagerError } =
122+
DesktopObservability.makeComponentLogger("desktop-backend-manager");
123+
120124
interface ActiveBackendRun {
121125
readonly id: number;
122126
readonly scope: Scope.Closeable;
@@ -455,16 +459,16 @@ const makeDesktopBackendManager = Effect.fn("makeDesktopBackendManager")(functio
455459
yield* Ref.set(desktopState.backendReady, true);
456460
yield* desktopWindow.handleBackendReady.pipe(
457461
Effect.catch((error) =>
458-
Effect.logError("failed to open main window after backend readiness").pipe(
459-
Effect.annotateLogs({ message: error.message }),
460-
),
462+
logBackendManagerError("failed to open main window after backend readiness", {
463+
message: error.message,
464+
}),
461465
),
462466
);
463467
}),
464468
onReadinessFailure: (error) =>
465-
Effect.logWarning("backend readiness check failed during bootstrap").pipe(
466-
Effect.annotateLogs({ error: error.message }),
467-
),
469+
logBackendManagerWarning("backend readiness check failed during bootstrap", {
470+
error: error.message,
471+
}),
468472
onOutput: (streamName, chunk) => backendOutputLog.writeOutputChunk(streamName, chunk),
469473
}).pipe(
470474
Effect.provideService(ChildProcessSpawner.ChildProcessSpawner, spawner),
@@ -507,12 +511,10 @@ const makeDesktopBackendManager = Effect.fn("makeDesktopBackendManager")(functio
507511
yield* Option.match(scheduled, {
508512
onNone: () => Effect.void,
509513
onSome: Effect.fn("desktop.backendManager.scheduleRestartFiber")(function* (delay) {
510-
yield* Effect.logError("backend exited unexpectedly; restart scheduled").pipe(
511-
Effect.annotateLogs({
512-
reason,
513-
delayMs: Duration.toMillis(delay),
514-
}),
515-
);
514+
yield* logBackendManagerError("backend exited unexpectedly; restart scheduled", {
515+
reason,
516+
delayMs: Duration.toMillis(delay),
517+
});
516518
const restartFiber = yield* Effect.forkIn(
517519
Effect.sleep(delay).pipe(
518520
Effect.andThen(
@@ -529,7 +531,9 @@ const makeDesktopBackendManager = Effect.fn("makeDesktopBackendManager")(functio
529531
),
530532
Effect.flatMap((shouldRestart) => (shouldRestart ? start : Effect.void)),
531533
Effect.catchCause((cause) =>
532-
Effect.logError("desktop backend restart fiber failed", { cause }),
534+
logBackendManagerError("desktop backend restart fiber failed", {
535+
cause: Cause.pretty(cause),
536+
}),
533537
),
534538
),
535539
parentScope,

‎apps/desktop/src/updates/DesktopUpdates.ts‎

Lines changed: 10 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,15 @@ import * as Ref from "effect/Ref";
1818
import * as Schema from "effect/Schema";
1919
import * as Scope from "effect/Scope";
2020

21-
import * as ElectronUpdater from "../electron/ElectronUpdater.ts";
22-
import * as ElectronWindow from "../electron/ElectronWindow.ts";
2321
import * as DesktopBackendManager from "../backend/DesktopBackendManager.ts";
2422
import * as DesktopConfig from "../app/DesktopConfig.ts";
25-
import * as DesktopAppSettings from "../settings/DesktopAppSettings.ts";
26-
import * as DesktopState from "../app/DesktopState.ts";
2723
import * as DesktopEnvironment from "../app/DesktopEnvironment.ts";
24+
import * as DesktopObservability from "../app/DesktopObservability.ts";
25+
import * as DesktopState from "../app/DesktopState.ts";
26+
import * as ElectronUpdater from "../electron/ElectronUpdater.ts";
27+
import * as ElectronWindow from "../electron/ElectronWindow.ts";
2828
import * as IpcChannels from "../ipc/channels.ts";
29+
import * as DesktopAppSettings from "../settings/DesktopAppSettings.ts";
2930
import { resolveDefaultDesktopUpdateChannel } from "./updateChannels.ts";
3031
import {
3132
createInitialDesktopUpdateState,
@@ -99,32 +100,11 @@ export class DesktopUpdates extends Context.Service<DesktopUpdates, DesktopUpdat
99100
"t3/desktop/Updates",
100101
) {}
101102

102-
const withUpdaterLogAnnotations = (
103-
effect: Effect.Effect<void>,
104-
annotations?: Record<string, unknown>,
105-
): Effect.Effect<void> =>
106-
effect.pipe(
107-
Effect.annotateLogs({
108-
scope: "desktop",
109-
component: "desktop-updater",
110-
...annotations,
111-
}),
112-
);
113-
114-
const logUpdaterInfo = (
115-
message: string,
116-
annotations?: Record<string, unknown>,
117-
): Effect.Effect<void> => withUpdaterLogAnnotations(Effect.logInfo(message), annotations);
118-
119-
const logUpdaterWarning = (
120-
message: string,
121-
annotations?: Record<string, unknown>,
122-
): Effect.Effect<void> => withUpdaterLogAnnotations(Effect.logWarning(message), annotations);
123-
124-
const logUpdaterError = (
125-
message: string,
126-
annotations?: Record<string, unknown>,
127-
): Effect.Effect<void> => withUpdaterLogAnnotations(Effect.logError(message), annotations);
103+
const {
104+
logInfo: logUpdaterInfo,
105+
logWarning: logUpdaterWarning,
106+
logError: logUpdaterError,
107+
} = DesktopObservability.makeComponentLogger("desktop-updater");
128108

129109
function parseAppUpdateYml(raw: string): Effect.Effect<Option.Option<AppUpdateYmlConfig>> {
130110
const entries: Record<string, string> = {};

0 commit comments

Comments
 (0)