1import * as GCP from "@/GCP";
2import * as Test from "@/Test/Alchemy";
3import * as observability from "@distilled.cloud/gcp/observability_v1";
4import { expect } from "alchemy-test";
5import * as Effect from "effect/Effect";
6import { MinimumLogLevel } from "effect/References";
7import * as Schedule from "effect/Schedule";
8import { GcpEnvironment } from "@/GCP/Environment";
9
10const { test } = Test.make({ providers: GCP.providers() });
11
12const logLevel = Effect.provideService(
13 MinimumLogLevel,
14 process.env.DEBUG ? "Debug" : "Info",
15);
16
17const waitUntilGone = (name: string) =>
18 observability.getProjectsLocationsTraceScopes({ name }).pipe(
19 Effect.as("found" as const),
20 Effect.catchTag("NotFound", () => Effect.succeed("gone" as const)),
21 Effect.repeat({
22 schedule: Schedule.spaced("1 second"),
23 until: (status) => status === "gone",
24 times: 10,
25 }),
26 );
27
28test.provider(
29 "getProjectsLocationsTraceScopes on a missing scope fails with a typed tag",
30 (stack) =>
31 Effect.gen(function* () {
32 const { project } = yield* GcpEnvironment.current;
33 yield* stack.destroy();
34
35 const error = yield* Effect.flip(
36 observability.getProjectsLocationsTraceScopes({
37 name: `projects/${project}/locations/global/traceScopes/alchemy-missing-scope`,
38 }),
39 );
40 expect(error._tag).toEqual("NotFound");
41
42 yield* stack.destroy();
43 }).pipe(logLevel),
44 {
45 tags: ["provider:gcp", "provider:gcp:observability", "live"],
46 timeout: 90_000,
47 },
48);
49
50test.provider(
51 "create, update, replace, and delete a trace scope",
52 (stack) =>
53 Effect.gen(function* () {
54 const { project } = yield* GcpEnvironment.current;
55 const projectName = `projects/${project}`;
56 yield* stack.destroy();
57
58 const created = yield* stack.deploy(
59 Effect.gen(function* () {
60 return yield* GCP.Observability.TraceScope("App", {
61 resourceNames: [projectName],
62 description: "application traces",
63 });
64 }),
65 );
66
67 expect(created.traceScopeId).toEqual(expect.any(String));
68 expect(created.traceScopeId).not.toEqual("_Default");
69 expect(created.location).toEqual("global");
70 expect(created.project).toEqual(project);
71 expect(created.name).toEqual(
72 `projects/${project}/locations/global/traceScopes/${created.traceScopeId}`,
73 );
74 expect(created.resourceNames).toEqual([projectName]);
75 expect(created.description).toEqual("application traces");
76
77 const fetched = yield* observability.getProjectsLocationsTraceScopes({
78 name: created.name,
79 });
80 expect(fetched.name).toEqual(created.name);
81 expect(fetched.resourceNames).toEqual([projectName]);
82 expect(fetched.description).toContain("alchemy-id=");
83 expect(fetched.description).toContain("application traces");
84
85 const updated = yield* stack.deploy(
86 Effect.gen(function* () {
87 return yield* GCP.Observability.TraceScope("App", {
88 traceScopeId: created.traceScopeId,
89 resourceNames: [projectName],
90 description: "all application traces",
91 });
92 }),
93 );
94
95 expect(updated.name).toEqual(created.name);
96 expect(updated.traceScopeId).toEqual(created.traceScopeId);
97 expect(updated.description).toEqual("all application traces");
98 expect(updated.createTime).toEqual(created.createTime);
99
100 const fetchedUpdate =
101 yield* observability.getProjectsLocationsTraceScopes({
102 name: created.name,
103 });
104 expect(fetchedUpdate.description).toContain("all application traces");
105
106 const last = created.traceScopeId.at(-1) ?? "a";
107 const nextTraceScopeId = `${created.traceScopeId.slice(0, -1)}${last === "z" ? "0" : "z"}`;
108
109 const replaced = yield* stack.deploy(
110 Effect.gen(function* () {
111 return yield* GCP.Observability.TraceScope("App", {
112 traceScopeId: nextTraceScopeId,
113 resourceNames: [projectName],
114 description: "replaced scope",
115 });
116 }),
117 );
118
119 expect(replaced.traceScopeId).not.toEqual(created.traceScopeId);
120 expect(replaced.name).toEqual(
121 `projects/${project}/locations/global/traceScopes/${replaced.traceScopeId}`,
122 );
123 expect(replaced.description).toEqual("replaced scope");
124
125 const fetchedReplacement =
126 yield* observability.getProjectsLocationsTraceScopes({
127 name: replaced.name,
128 });
129 expect(fetchedReplacement.name).toEqual(replaced.name);
130
131 const previousGone = yield* waitUntilGone(created.name);
132 expect(previousGone).toEqual("gone");
133
134 yield* stack.destroy();
135
136 const gone = yield* waitUntilGone(replaced.name);
137 expect(gone).toEqual("gone");
138 }).pipe(logLevel),
139 {
140 tags: ["provider:gcp", "provider:gcp:observability", "live"],
141 timeout: 90_000,
142 },
143);