Skip to content
TypeScript

fix(server): quitting no longer waits on an unreachable telemetry endpoint (#30033)

levelorbitece6322f611a
diff --git a/apps/server/src/telemetry/AnalyticsService.test.ts b/apps/server/src/telemetry/AnalyticsService.test.ts
index 98e3d640c60..4d3c2d54212 100644
--- a/apps/server/src/telemetry/AnalyticsService.test.ts
+++ b/apps/server/src/telemetry/AnalyticsService.test.ts
@@ -5,8 +5,11 @@ import { assert, it } from "@effect/vitest";
import * as Clock from "effect/Clock";
import * as ConfigProvider from "effect/ConfigProvider";
import * as Effect from "effect/Effect";
+import * as Exit from "effect/Exit";
+import * as Fiber from "effect/Fiber";
import * as Layer from "effect/Layer";
import * as Schema from "effect/Schema";
+import * as Scope from "effect/Scope";
import * as TestClock from "effect/testing/TestClock";
import * as HttpClient from "effect/http/HttpClient";
import * as HttpClientError from "effect/http/HttpClientError";
@@ -110,6 +113,30 @@ const recordTwentyEvents = Effect.gen(function* () {
}
});
+const analyticsLayerWith = (client: HttpClient.HttpClient, policy?: ManagedPolicyDocument) =>
+ AnalyticsService.layer.pipe(
+ Layer.provideMerge(
+ ServerConfig.ServerConfig.layerTest(process.cwd(), { prefix: "t3-telemetry-retry-" }),
+ ),
+ Layer.provide(
+ ConfigProvider.layer(
+ ConfigProvider.fromUnknown({
+ T3CODE_TELEMETRY_ENABLED: true,
+ T3CODE_POSTHOG_KEY: "phc_test_key",
+ T3CODE_POSTHOG_HOST: "http://localhost",
+ }),
+ ),
+ ),
+ Layer.provide(
+ Layer.mergeAll(
+ Layer.succeed(HostProcess.Platform, "win32"),
+ Layer.succeed(HostProcess.Architecture, "x64"),
+ Layer.succeed(HttpClient.HttpClient, client),
+ ManagedPolicy.layerTest(policy),
+ ),
+ ),
+ );
+
/**
* Runs `record` (20 events by default), then lets `minutes` of background
* flushes run against a client that answers every send with `respond`.
@@ -138,28 +165,7 @@ const sendFor = (
return yield* respond(request);
}),
);
- const runtimeLayer = AnalyticsService.layer.pipe(
- Layer.provideMerge(
- ServerConfig.ServerConfig.layerTest(process.cwd(), { prefix: "t3-telemetry-retry-" }),
- ),
- Layer.provide(
- ConfigProvider.layer(
- ConfigProvider.fromUnknown({
- T3CODE_TELEMETRY_ENABLED: true,
- T3CODE_POSTHOG_KEY: "phc_test_key",
- T3CODE_POSTHOG_HOST: "http://localhost",
- }),
- ),
- ),
- Layer.provide(
- Layer.mergeAll(
- Layer.succeed(HostProcess.Platform, "win32"),
- Layer.succeed(HostProcess.Architecture, "x64"),
- Layer.succeed(HttpClient.HttpClient, client),
- ManagedPolicy.layerTest(policy),
- ),
- ),
- );
+ const runtimeLayer = analyticsLayerWith(client, policy);
yield* Effect.gen(function* () {
yield* record;
@@ -271,6 +277,21 @@ it.layer(Layer.mergeAll(NodeServices.layer, NodeCrypto.layer))("AnalyticsService
}),
);
+ it.effect("shutdown stops waiting for a telemetry endpoint that never answers", () =>
+ Effect.gen(function* () {
+ const scope = yield* Scope.make();
+ const context = yield* Layer.buildWithScope(
+ analyticsLayerWith(HttpClient.make(() => Effect.never)),
+ scope,
+ );
+ yield* recordTwentyEvents.pipe(Effect.provide(context));
+
+ const shutdown = yield* Scope.close(scope, Exit.void).pipe(Effect.forkChild);
+ yield* TestClock.adjust("1 second");
+ yield* Fiber.join(shutdown);
+ }),
+ );
+
it.effect("flush drains all buffered events across multiple batches", () =>
Effect.gen(function* () {
const capturedRequests: Array<RecordedBatchRequest> = [];
diff --git a/apps/server/src/telemetry/AnalyticsService.ts b/apps/server/src/telemetry/AnalyticsService.ts
index 91b00eeb123..384da92b3f3 100644
--- a/apps/server/src/telemetry/AnalyticsService.ts
+++ b/apps/server/src/telemetry/AnalyticsService.ts
@@ -41,8 +41,10 @@ interface DeliveryState {
// Retry delays shorter than this still wait for the next background check.
const FLUSH_INTERVAL_MS = 10_000;
-// A hung send would hold the flush lock, and with it the shutdown flush.
+// A hung send would hold the flush lock for the next background flush.
const SEND_TIMEOUT = "10 seconds";
+// Quit and restart wait for this flush; events it cannot send in time are dropped.
+const SHUTDOWN_FLUSH_TIMEOUT = "1 second";
// A failed batch is tried again until it has failed for this long. Ingest answers 503 when it
// cannot store a batch, and a broken Cloudflare location can take about 5 minutes to fail over.
// The waiting batch holds newer events back; `maxBufferedEvents` bounds them meanwhile.
@@ -352,7 +354,9 @@ export const make = Effect.gen(function* () {
disableYield: true,
}).pipe(Effect.forkScoped);
- yield* Effect.addFinalizer(() => flush);
+ yield* Effect.addFinalizer(() =>
+ flush.pipe(Effect.timeout(SHUTDOWN_FLUSH_TIMEOUT), Effect.ignore),
+ );
return AnalyticsService.of({ record, flush, recordOwners });
});