Skip to content

fix(server): Make telemetry opt in #3051

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mwolson wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(server): Make telemetry opt in #3051

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions apps/server/src/server.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -296,7 +296,6 @@ const RuntimeCoreDependenciesLive = ReactorLayerLive.pipe(
// no longer transitively provides it. Exposing it at the runtime level
// keeps a single Live for all opencode consumers.
Layer.provideMerge(OpenCodeRuntimeLive),
Layer.provideMerge(ServerSettingsLive),
Layer.provideMerge(WorkspaceLayerLive),
Layer.provideMerge(ProjectFaviconResolverLive),
Layer.provideMerge(RepositoryIdentityResolverLive),
Expand All @@ -312,11 +311,12 @@ const RuntimeCoreDependenciesLive = ReactorLayerLive.pipe(
);

const RuntimeDependenciesLive = RuntimeCoreDependenciesLive.pipe(
Layer.provideMerge(AnalyticsServiceLayerLive),
Layer.provideMerge(ServerSettingsLive),
// Misc.
Layer.provideMerge(ProcessDiagnostics.layer),
Layer.provideMerge(ProcessResourceMonitor.layer),
Layer.provideMerge(TraceDiagnostics.layer),
Layer.provideMerge(AnalyticsServiceLayerLive),
Layer.provideMerge(ExternalLauncher.layer),
Layer.provideMerge(ServerLifecycleEventsLive),
Layer.provide(NetService.layer),
Expand Down
6 changes: 4 additions & 2 deletions apps/server/src/serverSettings.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -427,6 +427,7 @@ it.layer(NodeServices.layer)("server settings", (it) => {
const fileSystem = yield* FileSystem.FileSystem;
const next = yield* serverSettings.updateSettings({
addProjectBaseDirectory: "~/Development",
automaticGitFetchInterval: Duration.seconds(10),
observability: {
otlpTracesUrl: "http://localhost:4318/v1/traces",
otlpMetricsUrl: "http://localhost:4318/v1/metrics",
Expand All @@ -440,7 +441,7 @@ it.layer(NodeServices.layer)("server settings", (it) => {
serverPassword: "secret-password",
},
},
automaticGitFetchInterval: Duration.seconds(10),
telemetryEnabled: true,
});

assert.equal(next.providers.codex.binaryPath, "/opt/homebrew/bin/codex");
Expand All @@ -449,6 +450,7 @@ it.layer(NodeServices.layer)("server settings", (it) => {
// @effect-diagnostics-next-line preferSchemaOverJson:off
assert.deepEqual(JSON.parse(raw), {
addProjectBaseDirectory: "~/Development",
automaticGitFetchInterval: 10_000,
observability: {
otlpTracesUrl: "http://localhost:4318/v1/traces",
otlpMetricsUrl: "http://localhost:4318/v1/metrics",
Expand All @@ -462,7 +464,7 @@ it.layer(NodeServices.layer)("server settings", (it) => {
serverPassword: "secret-password",
},
},
automaticGitFetchInterval: 10_000,
telemetryEnabled: true,
});
}).pipe(Effect.provide(makeServerSettingsLayer())),
);
Expand Down
265 changes: 264 additions & 1 deletion apps/server/src/telemetry/Layers/AnalyticsService.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,14 @@ import * as NodeServices from "@effect/platform-node/NodeServices";
import { assert, it } from "@effect/vitest";
import * as ConfigProvider from "effect/ConfigProvider";
import * as Effect from "effect/Effect";
import * as FileSystem from "effect/FileSystem";
import * as Layer from "effect/Layer";
import * as HttpServer from "effect/unstable/http/HttpServer";
import * as HttpServerRequest from "effect/unstable/http/HttpServerRequest";
import * as HttpServerResponse from "effect/unstable/http/HttpServerResponse";

import { ServerConfig } from "../../config.ts";
import { ServerSettingsService } from "../../serverSettings.ts";
import { getTelemetryIdentifier } from "../Identify.ts";
import { AnalyticsService } from "../Services/AnalyticsService.ts";
import { AnalyticsServiceLayerLive } from "./AnalyticsService.ts";
Expand Down Expand Up @@ -37,14 +39,119 @@ interface RecordedBatchBody {
}

it.layer(NodeServices.layer)("AnalyticsService test", (it) => {
it.effect("defaults to disabled without creating a telemetry identifier", () =>
Effect.gen(function* () {
const capturedRequests: Array<RecordedBatchRequest> = [];
const serverConfigLayer = ServerConfig.layerTest(process.cwd(), {
prefix: "t3-telemetry-disabled-",
});
const telemetryLayer = AnalyticsServiceLayerLive.pipe(
Layer.provideMerge(serverConfigLayer),
Layer.provideMerge(ServerSettingsService.layerTest()),
);
const configLayer = ConfigProvider.layer(
ConfigProvider.fromUnknown({
T3CODE_POSTHOG_KEY: "phc_test_key",
T3CODE_POSTHOG_HOST: "",
}),
);
const batchServerLayer = HttpServer.serve(
Effect.gen(function* () {
const request = yield* HttpServerRequest.HttpServerRequest;
const payload = yield* request.json.pipe(
Effect.map((body) => body as RecordedBatchRequest["body"]),
Effect.orElseSucceed(() => null),
);

capturedRequests.push({ path: request.url, body: payload });

return HttpServerResponse.jsonUnsafe({});
}),
);
const runtimeLayer = telemetryLayer.pipe(
Layer.provide(configLayer),
Layer.provideMerge(NodeHttpServer.layerTest),
);

const anonymousIdExists = yield* Effect.gen(function* () {
yield* Layer.launch(batchServerLayer).pipe(Effect.forkScoped);
const analytics = yield* AnalyticsService;
const serverConfig = yield* ServerConfig;
const fileSystem = yield* FileSystem.FileSystem;

yield* analytics.record("test.disabled");
yield* analytics.flush;

return yield* fileSystem.exists(serverConfig.anonymousIdPath);
}).pipe(Effect.provide(runtimeLayer));

assert.equal(capturedRequests.length, 0);
assert.equal(anonymousIdExists, false);
}),
);

it.effect("uses the server telemetry setting as an opt-in", () =>
Effect.gen(function* () {
const capturedRequests: Array<RecordedBatchRequest> = [];
const serverConfigLayer = ServerConfig.layerTest(process.cwd(), {
prefix: "t3-telemetry-setting-",
});
const telemetryLayer = AnalyticsServiceLayerLive.pipe(
Layer.provideMerge(serverConfigLayer),
Layer.provideMerge(ServerSettingsService.layerTest({ telemetryEnabled: true })),
);
const configLayer = ConfigProvider.layer(
ConfigProvider.fromUnknown({
T3CODE_POSTHOG_KEY: "phc_test_key",
T3CODE_POSTHOG_HOST: "",
}),
);
const batchServerLayer = HttpServer.serve(
Effect.gen(function* () {
const request = yield* HttpServerRequest.HttpServerRequest;
const payload = yield* request.json.pipe(
Effect.map((body) => body as RecordedBatchRequest["body"]),
Effect.orElseSucceed(() => null),
);

capturedRequests.push({ path: request.url, body: payload });

return HttpServerResponse.jsonUnsafe({});
}),
);
const runtimeLayer = telemetryLayer.pipe(
Layer.provide(configLayer),
Layer.provideMerge(NodeHttpServer.layerTest),
);

yield* Effect.gen(function* () {
yield* Layer.launch(batchServerLayer).pipe(Effect.forkScoped);
const analytics = yield* AnalyticsService;

yield* analytics.record("test.setting.enabled");
yield* analytics.flush;
}).pipe(Effect.provide(runtimeLayer));

const batchRequests = capturedRequests.filter(
(request): request is RecordedBatchRequest & { readonly body: RecordedBatchBody } =>
Array.isArray(request.body?.batch),
);
assert.equal(batchRequests.length, 1);
assert.equal(batchRequests[0]?.body.batch[0]?.event, "test.setting.enabled");
}),
);

it.effect("flush drains all buffered events across multiple batches", () =>
Effect.gen(function* () {
const capturedRequests: Array<RecordedBatchRequest> = [];
const serverConfigLayer = ServerConfig.layerTest(process.cwd(), {
prefix: "t3-telemetry-base-",
});

const telemetryLayer = AnalyticsServiceLayerLive.pipe(Layer.provideMerge(serverConfigLayer));
const telemetryLayer = AnalyticsServiceLayerLive.pipe(
Layer.provideMerge(serverConfigLayer),
Layer.provideMerge(ServerSettingsService.layerTest()),
);
const configLayer = ConfigProvider.layer(
ConfigProvider.fromUnknown({
T3CODE_TELEMETRY_ENABLED: true,
Expand Down Expand Up @@ -118,4 +225,160 @@ it.layer(NodeServices.layer)("AnalyticsService test", (it) => {
);
}),
);

it.effect("stops flushing buffered batches after telemetry is disabled mid-flush", () =>
Effect.gen(function* () {
const capturedRequests: Array<RecordedBatchRequest> = [];
const serverConfigLayer = ServerConfig.layerTest(process.cwd(), {
prefix: "t3-telemetry-disable-mid-flush-",
});

const telemetryLayer = AnalyticsServiceLayerLive.pipe(
Layer.provideMerge(serverConfigLayer),
Layer.provideMerge(ServerSettingsService.layerTest({ telemetryEnabled: true })),
);
const configLayer = ConfigProvider.layer(
ConfigProvider.fromUnknown({
T3CODE_POSTHOG_KEY: "phc_test_key",
T3CODE_POSTHOG_HOST: "",
T3CODE_TELEMETRY_FLUSH_BATCH_SIZE: 20,
}),
);
const batchServerLayer = HttpServer.serve(
Effect.gen(function* () {
const request = yield* HttpServerRequest.HttpServerRequest;
if (request.method !== "POST") {
return HttpServerResponse.empty({ status: 404 });
}

const payload = yield* request.json.pipe(
Effect.map((body) => body as RecordedBatchRequest["body"]),
Effect.orElseSucceed(() => null),
);

capturedRequests.push({ path: request.url, body: payload });

if (capturedRequests.length === 1) {
const serverSettings = yield* ServerSettingsService;
yield* serverSettings.updateSettings({ telemetryEnabled: false });
}

return HttpServerResponse.jsonUnsafe({});
}),
);
const runtimeLayer = telemetryLayer.pipe(
Layer.provide(configLayer),
Layer.provideMerge(NodeHttpServer.layerTest),
);

yield* Effect.gen(function* () {
yield* Layer.launch(batchServerLayer).pipe(Effect.forkScoped);
const analytics = yield* AnalyticsService;

for (let index = 0; index < 45; index += 1) {
yield* analytics.record("test.flush.mid-disable", { index });
}

yield* analytics.flush;
yield* analytics.flush;
}).pipe(Effect.provide(runtimeLayer));

const batchRequests = capturedRequests.filter(
(request): request is RecordedBatchRequest & { readonly body: RecordedBatchBody } =>
Array.isArray(request.body?.batch),
);
assert.equal(batchRequests.length, 1);
const deliveredIndexes = batchRequests.flatMap((request) =>
request.body.batch
.filter((event) => event.event === "test.flush.mid-disable")
.map((event) => event.properties?.index)
.filter((index): index is number => typeof index === "number"),
);

assert.deepEqual(
deliveredIndexes.toSorted((a, b) => a - b),
Array.from({ length: 20 }, (_, index) => index),
);
}),
);

it.effect("retains buffered events when telemetry identifier is unavailable", () =>
Effect.gen(function* () {
const capturedRequests: Array<RecordedBatchRequest> = [];
const serverConfigLayer = ServerConfig.layerTest(process.cwd(), {
prefix: "t3-telemetry-missing-identifier-",
});

const telemetryLayer = AnalyticsServiceLayerLive.pipe(
Layer.provideMerge(serverConfigLayer),
Layer.provideMerge(ServerSettingsService.layerTest()),
);
const configLayer = ConfigProvider.layer(
ConfigProvider.fromUnknown({
T3CODE_TELEMETRY_ENABLED: true,
T3CODE_POSTHOG_KEY: "phc_test_key",
T3CODE_POSTHOG_HOST: "",
T3CODE_TELEMETRY_FLUSH_BATCH_SIZE: 20,
}),
);
const batchServerLayer = HttpServer.serve(
Effect.gen(function* () {
const request = yield* HttpServerRequest.HttpServerRequest;
if (request.method !== "POST") {
return HttpServerResponse.empty({ status: 404 });
}

const payload = yield* request.json.pipe(
Effect.map((body) => body as RecordedBatchRequest["body"]),
Effect.orElseSucceed(() => null),
);

capturedRequests.push({ path: request.url, body: payload });

return HttpServerResponse.jsonUnsafe({});
}),
);
const runtimeLayer = telemetryLayer.pipe(
Layer.provide(configLayer),
Layer.provideMerge(NodeHttpServer.layerTest),
);

yield* Effect.gen(function* () {
yield* Layer.launch(batchServerLayer).pipe(Effect.forkScoped);
const fileSystem = yield* FileSystem.FileSystem;
const serverConfig = yield* ServerConfig;
const emptyHome = yield* fileSystem.makeTempDirectoryScoped({
prefix: "t3-telemetry-empty-home-",
});
const originalHome = process.env.HOME;
process.env.HOME = emptyHome;
yield* Effect.addFinalizer(() =>
Effect.sync(() => {
if (originalHome === undefined) {
delete process.env.HOME;
} else {
process.env.HOME = originalHome;
}
}),
);
yield* fileSystem.makeDirectory(serverConfig.anonymousIdPath);
const analytics = yield* AnalyticsService;

yield* analytics.record("test.flush.identifier-unavailable", { index: 0 });
yield* analytics.flush;
assert.equal(capturedRequests.length, 0);

yield* fileSystem.remove(serverConfig.anonymousIdPath, { recursive: true, force: true });
yield* analytics.flush;
}).pipe(Effect.provide(runtimeLayer));

const batchRequests = capturedRequests.filter(
(request): request is RecordedBatchRequest & { readonly body: RecordedBatchBody } =>
Array.isArray(request.body?.batch),
);
assert.equal(batchRequests.length, 1);
assert.equal(batchRequests[0]?.body.batch[0]?.event, "test.flush.identifier-unavailable");
assert.equal(batchRequests[0]?.body.batch[0]?.properties?.index, 0);
}),
);
});
Loading
Loading