Skip to content

Commit ac68c39

Browse files
ci(relay): sweep preview tunnels as a stack resource on destroy
The standalone sweep script ran as a separate workflow step, so teardown depended on that step and on a dry-run flag. Alchemy Actions never run on destroy, so the sweep is a Resource instead: its delete sweeps the stage's managed tunnels and their CNAMEs, and `alchemy destroy` runs it. The resource depends on the Worker, so it is deleted before the Worker. Co-Authored-By: Claude Haiku 5.5 <[email protected]>
1 parent ea5dea2 commit ac68c39

7 files changed

Lines changed: 256 additions & 150 deletions

File tree

‎.github/workflows/relay-preview-cleanup.yml‎

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,7 @@ jobs:
6464
args:
6565
- --filter=t3code-relay...
6666
67-
# Destroy first, so the Worker that creates tunnels is gone before the
68-
# sweep runs. If destroy fails the sweep is skipped, and the nightly
69-
# sweep retries both.
67+
# Destroy also runs the preview tunnel sweep, which is part of the stack.
7068
- name: Destroy preview stage
7169
run: vp run --filter t3code-relay destroy --stage "$STAGE" --yes --no-input
7270
env:
@@ -76,13 +74,6 @@ jobs:
7674
AXIOM_TOKEN: ${{ secrets.AXIOM_TOKEN }}
7775
CLERK_SECRET_KEY: ${{ secrets.CLERK_SECRET_KEY }}
7876

79-
- name: Sweep preview tunnels and DNS
80-
run: vp run --filter t3code-relay sweep:preview
81-
env:
82-
CLOUDFLARE_API_TOKEN: ${{ secrets.CLOUDFLARE_API_TOKEN }}
83-
PREVIEW_STAGE: ${{ env.STAGE }}
84-
APPLY: "true"
85-
8677
sweep_orphans:
8778
name: Sweep orphaned relay previews
8879
if: github.event_name != 'pull_request_target'
@@ -119,9 +110,8 @@ jobs:
119110
args:
120111
- --filter=t3code-relay...
121112
122-
- name: Destroy and sweep stages of closed labeled PRs
113+
- name: Destroy stages of closed labeled PRs
123114
env:
124-
APPLY: "true"
125115
CLOUDFLARE_API_TOKEN: ${{ secrets.CLOUDFLARE_API_TOKEN }}
126116
PLANETSCALE_API_TOKEN_ID: ${{ secrets.PLANETSCALE_API_TOKEN_ID }}
127117
PLANETSCALE_API_TOKEN: ${{ secrets.PLANETSCALE_API_TOKEN }}
@@ -134,7 +124,6 @@ jobs:
134124
stage="pr-$number"
135125
echo "::group::$stage"
136126
vp run --filter t3code-relay destroy --stage "$stage" --yes --no-input \
137-
&& PREVIEW_STAGE="$stage" vp run --filter t3code-relay sweep:preview \
138127
|| { echo "Cleanup failed for $stage" >&2; failed=1; }
139128
echo "::endgroup::"
140129
done

‎infra/relay/alchemy.run.ts‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@ import * as Planetscale from "alchemy/Planetscale";
1111
import { PublishClientConfig, tokenDigest } from "./src/clientConfig.ts";
1212
import * as RelayDb from "./src/db.ts";
1313
import { RelayObservability } from "./src/observability.ts";
14-
import { ManagedEndpointZone, RelayApiZone } from "./src/zone.ts";
14+
import { isPreviewStage } from "./src/previewStages.ts";
15+
import { PreviewTunnelSweep, PreviewTunnelSweepProvider } from "./src/previewTunnelSweep.ts";
16+
import { ManagedEndpointZone, RelayApiZone, RelayDeploymentConfig } from "./src/zone.ts";
1517
import * as RelayWorker from "./src/worker.ts";
1618

1719
export default Alchemy.Stack(
@@ -22,16 +24,26 @@ export default Alchemy.Stack(
2224
Cloudflare.providers(),
2325
Drizzle.providers(),
2426
Planetscale.providers(),
27+
PreviewTunnelSweepProvider(),
2528
),
2629
state: Cloudflare.state(),
2730
},
2831
Effect.gen(function* () {
32+
const { stage } = yield* Alchemy.Stack;
2933
const db = yield* RelayDb.PlanetscaleDatabase;
3034
const hyperdrive = yield* RelayDb.RelayHyperdrive;
3135
const managedEndpointZone = yield* ManagedEndpointZone.pipe(Effect.orDie);
3236
const relayApiZone = yield* RelayApiZone.pipe(Effect.orDie);
3337
const observability = yield* RelayObservability;
3438
const api = yield* RelayWorker.Api;
39+
if (isPreviewStage(stage)) {
40+
const { managedEndpointZoneName } = yield* RelayDeploymentConfig;
41+
yield* PreviewTunnelSweep("PreviewTunnelSweep", {
42+
stage,
43+
tunnelZoneName: managedEndpointZoneName,
44+
workerName: api.workerName,
45+
});
46+
}
3547
yield* PublishClientConfig({
3648
url: api.url,
3749
mobileTracingUrl: observability.traces.otelTracesEndpoint,

‎infra/relay/package.json‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77
"push:android:smoke": "node scripts/android-push-smoke.ts",
88
"push:android:watch": "node scripts/android-push-watch.ts",
99
"tunnels:census": "node scripts/tunnel-census.ts",
10-
"sweep:preview": "node scripts/sweep-preview-tunnels.ts",
1110
"destroy": "alchemy destroy",
1211
"test": "vp test run --config ../../vite.config.ts --dir .",
1312
"typecheck": "tsc --noEmit"

‎infra/relay/scripts/sweep-preview-tunnels.ts‎

Lines changed: 0 additions & 134 deletions
This file was deleted.

‎infra/relay/src/previewStages.test.ts‎

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
import { describe, expect, it } from "vite-plus/test";
22

3-
import { isPreviewStage, isPreviewTunnelName, isPreviewTunnelRecordName } from "./previewStages.ts";
3+
import {
4+
isPreviewStage,
5+
isPreviewTunnelName,
6+
isPreviewTunnelRecordName,
7+
previewSweepTargets,
8+
tunnelCnameContent,
9+
} from "./previewStages.ts";
410

511
const KEY = "0123456789abcdef";
612

@@ -28,4 +34,27 @@ describe("preview stages", () => {
2834
expect(isPreviewTunnelRecordName(`pr-42-${KEY}.other.com`, "pr-42", zone)).toBe(false);
2935
expect(isPreviewTunnelRecordName(`relay.${zone}`, "pr-42", zone)).toBe(false);
3036
});
37+
38+
it("targets only this stage's tunnels and the records that point at them", () => {
39+
const zone = "tunnels.example.com";
40+
const mine = `t3coderelay-managedendpoint-pr-42-${KEY}`;
41+
const otherStage = `t3coderelay-managedendpoint-pr-7-${KEY}`;
42+
const otherKey = "fedcba9876543210";
43+
const targets = previewSweepTargets({
44+
stage: "pr-42",
45+
tunnelZoneName: zone,
46+
tunnels: [
47+
{ id: "t-mine", name: mine },
48+
{ id: "t-other", name: otherStage },
49+
],
50+
records: [
51+
{ id: "r-mine", name: `pr-42-${KEY}.${zone}`, content: tunnelCnameContent("t-mine") },
52+
{ id: "r-other", name: `pr-7-${KEY}.${zone}`, content: tunnelCnameContent("t-other") },
53+
// Right label, but it targets a tunnel outside this sweep.
54+
{ id: "r-stranger", name: `pr-42-${otherKey}.${zone}`, content: "x.cfargotunnel.com" },
55+
],
56+
});
57+
expect(targets.tunnels.map((tunnel) => tunnel.id)).toEqual(["t-mine"]);
58+
expect(targets.records.map((record) => record.id)).toEqual(["r-mine"]);
59+
});
3160
});

‎infra/relay/src/previewStages.ts‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,3 +39,36 @@ export function isPreviewTunnelRecordName(
3939
export function tunnelCnameContent(tunnelId: string): string {
4040
return `${tunnelId}.cfargotunnel.com`;
4141
}
42+
43+
export interface SweepTunnel {
44+
readonly id: string;
45+
readonly name?: string | null | undefined;
46+
}
47+
48+
export interface SweepRecord {
49+
readonly id: string;
50+
readonly name: string;
51+
readonly content?: string | null | undefined;
52+
}
53+
54+
// Records are matched through the tunnel they point at, not just by name, so a
55+
// record that happens to share the label is never deleted unless it targets one
56+
// of this stage's tunnels.
57+
export function previewSweepTargets(input: {
58+
readonly stage: string;
59+
readonly tunnelZoneName: string;
60+
readonly tunnels: ReadonlyArray<SweepTunnel>;
61+
readonly records: ReadonlyArray<SweepRecord>;
62+
}): { readonly tunnels: ReadonlyArray<SweepTunnel>; readonly records: ReadonlyArray<SweepRecord> } {
63+
const tunnels = input.tunnels.filter(
64+
(tunnel) => tunnel.name != null && isPreviewTunnelName(tunnel.name, input.stage),
65+
);
66+
const tunnelContents = new Set(tunnels.map((tunnel) => tunnelCnameContent(tunnel.id)));
67+
const records = input.records.filter(
68+
(record) =>
69+
isPreviewTunnelRecordName(record.name, input.stage, input.tunnelZoneName) &&
70+
record.content != null &&
71+
tunnelContents.has(record.content),
72+
);
73+
return { tunnels, records };
74+
}

0 commit comments

Comments
 (0)