import * as apim from "@distilled.cloud/gcp/apim_v1alpha";
import { createPhysicalName } from "alchemy/PhysicalName";
import * as Data from "effect/Data";
import * as Effect from "effect/Effect";
import * as Schedule from "effect/Schedule";
import * as Stream from "effect/Stream";
import { waitForOperation as waitForLongRunning } from "../Operation.ts";
export const MAX_NAME_LENGTH = 63;
export const MIN_NAME_LENGTH = 4;
export const ALCHEMY_ID_PREFIX = "alch-";
export type PscNetworkConfig = {
/** VPC network `projects/{project}/global/networks/{network}`. */
network: string;
/**
* Subnetwork
* `projects/{project}/regions/{region}/subnetworks/{subnet}`.
*/
subnetwork: string;
};
export type GclbObservationSource = {
/** VPC networks whose load balancers are observed. Currently one. */
pscNetworkConfigs: PscNetworkConfig[];
};
export class ResourceNotResolved extends Data.TaggedError("GCP.Apim.NotResolved")<{
resourceName: string;
}> {}
export class ResourceStillExists extends Data.TaggedError("GCP.Apim.StillExists")<{
resourceName: string;
}> {}
export class ResourceNotReady extends Data.TaggedError("GCP.Apim.NotReady")<{
resourceName: string;
state: string;
}> {}
export class ResourceFailed extends Data.TaggedError("GCP.Apim.Failed")<{
resourceName: string;
state: string;
}> {}
export const lastSegment = (value: string) => {
const trimmed = value.replace(/\/+$/, "");
const parts = trimmed.split("/");
return parts[parts.length - 1] || trimmed;
};
export const rfc1035 = (name: string, fallback = "apim"): string => {
let next = name
.toLowerCase()
.replace(/[^a-z0-9-]/g, "-")
.replace(/-+/g, "-")
.replace(/^-+|-+$/g, "");
if (!/^[a-z]/.test(next)) next = `${fallback[0] ?? "a"}${next}`;
next = next.slice(0, MAX_NAME_LENGTH).replace(/-+$/g, "");
if (next.length === 0) return fallback;
if (!/[a-z0-9]$/.test(next)) next = `${next.slice(0, MAX_NAME_LENGTH - 1)}0`;
if (next.length < MIN_NAME_LENGTH) {
next = `${next}${"x".repeat(MIN_NAME_LENGTH)}`.slice(0, MIN_NAME_LENGTH);
}
return next.slice(0, MAX_NAME_LENGTH);
};
export const normalizeLocation = (location: string) => lastSegment(location).toLowerCase();
export const parentOf = (project: string, location: string) =>
`projects/${project}/locations/${normalizeLocation(location)}`;
export const resourceName = (project: string, location: string, collection: string, id: string) =>
`${parentOf(project, location)}/${collection}/${id}`;
export const toPhysicalId = (
id: string,
explicit: string | undefined,
existing: string | undefined,
fallback = "apim",
) =>
Effect.gen(function* () {
if (explicit !== undefined) return rfc1035(explicit, fallback);
if (existing !== undefined) return existing;
const generated = rfc1035(
yield* createPhysicalName({
id,
maxLength: MAX_NAME_LENGTH - ALCHEMY_ID_PREFIX.length,
lowercase: true,
}),
fallback,
);
const prefixed = generated.startsWith(ALCHEMY_ID_PREFIX)
? generated
: `${ALCHEMY_ID_PREFIX}${generated}`;
return rfc1035(prefixed, fallback);
});
export const parseName = (name: string, collection: string) => {
const parts = name.split("/").filter((part) => part.length > 0);
const collectionAt = parts.lastIndexOf(collection);
const locationsAt = parts.lastIndexOf("locations");
const projectsAt = parts.lastIndexOf("projects");
return {
project: projectsAt >= 0 && parts[projectsAt + 1] ? parts[projectsAt + 1]! : "",
location: locationsAt >= 0 && parts[locationsAt + 1] ? parts[locationsAt + 1]! : "",
id: collectionAt >= 0 && parts[collectionAt + 1] ? parts[collectionAt + 1]! : lastSegment(name),
parent:
collectionAt > 0
? parts.slice(0, collectionAt).join("/")
: parts.slice(0, Math.max(0, parts.length - 1)).join("/"),
};
};
export const hasAlchemyId = (id: string | undefined) => (id ?? "").startsWith(ALCHEMY_ID_PREFIX);
export const projectIdOf = (value: string | undefined, fallback: string) => {
if (value === undefined || value.length === 0) return fallback;
const parts = value.split("/").filter((part) => part.length > 0);
const at = parts.lastIndexOf("projects");
if (at >= 0 && parts[at + 1]) return parts[at + 1]!;
return fallback;
};
export const expandNetwork = (value: string, project: string) => {
const trimmed = value.replace(/\/+$/, "");
if (trimmed.includes("/networks/")) {
const owner = projectIdOf(trimmed, project);
return `projects/${owner}/global/networks/${lastSegment(trimmed)}`;
}
return `projects/${project}/global/networks/${trimmed}`;
};
export const expandSubnetwork = (value: string, project: string, location: string) => {
const trimmed = value.replace(/\/+$/, "");
if (trimmed.includes("/subnetworks/")) {
const owner = projectIdOf(trimmed, project);
const parts = trimmed.split("/").filter((part) => part.length > 0);
const regionsAt = parts.lastIndexOf("regions");
const region = regionsAt >= 0 && parts[regionsAt + 1] ? parts[regionsAt + 1]! : location;
return `projects/${owner}/regions/${region}/subnetworks/${lastSegment(trimmed)}`;
}
return `projects/${project}/regions/${location}/subnetworks/${trimmed}`;
};
export const expandObservationSource = (value: string, project: string, location: string) => {
const trimmed = value.replace(/\/+$/, "");
if (trimmed.includes("/observationSources/")) return trimmed;
return resourceName(project, location, "observationSources", trimmed);
};
export const expandGclb = (
source: GclbObservationSource | undefined,
project: string,
location: string,
): apim.GclbObservationSource | undefined => {
if (source === undefined) return undefined;
return {
pscNetworkConfigs: (source.pscNetworkConfigs ?? []).map((config) => ({
network: expandNetwork(config.network, project),
subnetwork: expandSubnetwork(config.subnetwork, project, location),
})),
};
};
export const canonical = (value: unknown): unknown => {
if (value === undefined || value === null) return undefined;
if (typeof value === "boolean" || typeof value === "number") return value;
if (typeof value === "string") {
return value.length === 0 ? undefined : value;
}
if (Array.isArray(value)) {
const items = value.map(canonical).filter((item) => item !== undefined);
return items.length === 0 ? undefined : items;
}
if (typeof value === "object") {
const entries = Object.entries(value as Record<string, unknown>)
.map(([key, item]) => [key, canonical(item)] as const)
.filter(([, item]) => item !== undefined)
.sort(([left], [right]) => left.localeCompare(right));
if (entries.length === 0) return undefined;
return Object.fromEntries(entries);
}
return undefined;
};
export const fingerprint = (value: unknown): string => JSON.stringify(canonical(value) ?? null);
export const sameJson = (left: unknown, right: unknown) => fingerprint(left) === fingerprint(right);
export const sameStringList = (
left: readonly string[] | undefined,
right: readonly string[] | undefined,
) =>
fingerprint([...(left ?? [])].map(lastSegment).sort()) ===
fingerprint([...(right ?? [])].map(lastSegment).sort());
export const replaceOnIdentity = (input: {
previousId: string | undefined;
nextId: string | undefined;
previousLocation: string;
nextLocation: string;
extra?: boolean;
deleteFirst?: boolean;
}) => {
const replace =
(input.extra ?? false) ||
(input.previousId !== undefined &&
input.nextId !== undefined &&
input.nextId !== input.previousId) ||
input.previousLocation !== input.nextLocation;
if (!replace) return undefined;
const samePhysical =
input.previousLocation === input.nextLocation &&
input.previousId !== undefined &&
input.nextId === input.previousId;
return {
action: "replace" as const,
deleteFirst: input.deleteFirst ?? samePhysical,
};
};
/**
* Wait for a API Management long-running operation. Observation jobs and
* sources settle within minutes.
* `ALREADY_EXISTS` (a concurrent create won) always succeeds;
* `notFoundOk` also accepts a `NOT_FOUND` result or an operation that has
* already been garbage-collected (deletes).
*/
export const waitForOperation = (operation: apim.Operation, options?: { notFoundOk?: boolean }) =>
waitForLongRunning(operation, (name) => apim.getProjectsLocationsOperations({ name }), {
budget: "10 minutes",
}).pipe(
Effect.catchIf(
(error) =>
error._tag === "GCP.OperationFailed" &&
(error.code === 6 || (options?.notFoundOk === true && error.code === 5)),
() => Effect.void,
),
Effect.catchIf(
(error) => options?.notFoundOk === true && error._tag === "NotFound",
() => Effect.void,
),
);
export const waitUntilExists = <A, E, R>(
get: Effect.Effect<A, E, R>,
name: string,
): Effect.Effect<A & {}, E | ResourceNotResolved, R> =>
get.pipe(
Effect.filterOrFail(
(value): value is A & {} => value !== undefined,
() => new ResourceNotResolved({ resourceName: name }),
),
Effect.retry({
while: (error) => error instanceof ResourceNotResolved,
times: 8,
schedule: Schedule.spaced("1 second"),
}),
);
export const waitUntilGone = <A, E, R>(get: Effect.Effect<A, E, R>, name: string) =>
get.pipe(
Effect.filterOrFail(
(value) => value === undefined,
() => new ResourceStillExists({ resourceName: name }),
),
Effect.retry({
while: (error) => error instanceof ResourceStillExists,
times: 10,
schedule: Schedule.spaced("2 seconds"),
}),
Effect.asVoid,
);
const FAILED_STATES = new Set(["ERROR", "FAILED"]);
export const waitUntilReady = <A, E, R>(
get: Effect.Effect<A, E, R>,
name: string,
stateOf: (value: A & {}) => string | undefined,
ready: ReadonlySet<string>,
options?: {
times?: number;
interval?: `${number} seconds`;
},
): Effect.Effect<A & {}, E | ResourceNotResolved | ResourceNotReady | ResourceFailed, R> =>
get.pipe(
Effect.filterOrFail(
(value): value is A & {} => value !== undefined,
() => new ResourceNotResolved({ resourceName: name }),
),
Effect.filterOrFail(
(value) => !FAILED_STATES.has((stateOf(value) ?? "").toUpperCase()),
(value) =>
new ResourceFailed({
resourceName: name,
state: (stateOf(value) ?? "").toUpperCase(),
}),
),
Effect.filterOrFail(
(value) => ready.has((stateOf(value) ?? "").toUpperCase()),
(value) =>
new ResourceNotReady({
resourceName: name,
state: (stateOf(value) ?? "").toUpperCase(),
}),
),
Effect.retry({
while: (error) => error instanceof ResourceNotReady || error instanceof ResourceNotResolved,
times: options?.times ?? 10,
schedule: Schedule.spaced(options?.interval ?? "3 seconds"),
}),
);
export const collectPages = <Page, A, E, R>(
pages: Stream.Stream<Page, E, R>,
items: (page: Page) => readonly A[] | undefined,
) =>
pages.pipe(
Stream.flatMap((page) => Stream.fromIterable(items(page) ?? [])),
Stream.runCollect,
Effect.map((chunk) => Array.from(chunk)),
);
/**
* List across every location via the `locations/-` wildcard, falling back to
* the default region where the API rejects the wildcard. A missing parent
* (`NotFound`) lists as empty; any other error fails.
*/
export const listAtLocation = <A, E extends { readonly _tag: string }, R>(
project: string,
region: string,
list: (parent: string) => Effect.Effect<A[], E, R>,
) =>
list(`projects/${project}/locations/-`).pipe(
Effect.catchIf(
(error) => error._tag === "NotFound" || error._tag === "BadRequest",
() =>
list(`projects/${project}/locations/${region}`).pipe(
Effect.catchIf(
(error) => error._tag === "NotFound",
() => Effect.succeed<A[]>([]),
),
),
),
);