import * as gkeonprem from "@distilled.cloud/gcp/gkeonprem_v1";
import type { GcpOpContext } from "@distilled.cloud/gcp/Protocol";
import { createPhysicalName } from "alchemy/PhysicalName";
import { tagRecord } from "alchemy/Tags";
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 {
alchemyLabelKeys,
createInternalLabels,
hasAlchemyLabels,
stripInternalLabels,
toLabels,
} from "../Labels.ts";
import { waitForOperation as waitForLongRunningOperation } from "../Operation.ts";
export const MAX_NAME_LENGTH = 63;
export const VMWARE_NAME_LENGTH = 40;
export { createInternalLabels, hasAlchemyLabels, stripInternalLabels, toLabels };
export class ResourceNotResolved extends Data.TaggedError("GCP.GKEOnPrem.ResourceNotResolved")<{
resourceName: string;
}> {}
export class ResourceStillExists extends Data.TaggedError("GCP.GKEOnPrem.ResourceStillExists")<{
resourceName: string;
}> {}
export class ResourceNotReady extends Data.TaggedError("GCP.GKEOnPrem.ResourceNotReady")<{
resourceName: string;
state: string;
}> {}
export class ResourceFailed extends Data.TaggedError("GCP.GKEOnPrem.ResourceFailed")<{
resourceName: string;
state: string;
details: string | undefined;
}> {}
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 = "gkeonprem",
maxLength = MAX_NAME_LENGTH,
): string => {
let next = name
.toLowerCase()
.replace(/[^a-z0-9-]/g, "-")
.replace(/-+/g, "-")
.replace(/^-+|-+$/g, "");
if (!/^[a-z]/.test(next)) next = `g${next}`;
next = next.slice(0, maxLength).replace(/-+$/g, "");
if (next.length === 0) return fallback.slice(0, maxLength);
if (!/[a-z0-9]$/.test(next)) next = `${next.slice(0, maxLength - 1)}0`;
return next.slice(0, maxLength);
};
export const normalizeLocation = (location: string | undefined, fallback: string) =>
lastSegment(location ?? fallback).toLowerCase();
export const parentOf = (project: string, location: string) =>
`projects/${project}/locations/${lastSegment(location).toLowerCase()}`;
export const toPhysicalId = (
id: string,
explicit: string | undefined,
existing: string | undefined,
fallback = "gkeonprem",
maxLength = MAX_NAME_LENGTH,
) =>
Effect.gen(function* () {
if (explicit !== undefined) return rfc1035(explicit, fallback, maxLength);
if (existing !== undefined) return existing;
return rfc1035(
yield* createPhysicalName({
id,
maxLength,
lowercase: true,
}),
fallback,
maxLength,
);
});
export const parseName = (name: string, collection: string, fallbackLocation: 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]! : fallbackLocation,
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 expandParent = (
value: string,
project: string,
location: string,
collection: string,
) => {
if (value.includes("/")) return value.replace(/\/+$/, "");
return `projects/${project}/locations/${location}/${collection}/${rfc1035(value, collection)}`;
};
export const membershipName = (value: string, project: string) => {
const next = value.replace(/\/+$/, "");
if (next.includes("/")) return next;
return `projects/${project}/locations/global/memberships/${rfc1035(next, "membership")}`;
};
export const stringMap = (
value: Record<string, string | undefined> | null | undefined,
): Record<string, string> =>
Object.fromEntries(
Object.entries(value ?? {}).filter(
(entry): entry is [string, string] => typeof entry[1] === "string" && entry[1].length > 0,
),
);
export const userLabels = (
labels: Record<string, string | undefined> | null | undefined,
): Record<string, string> => stripInternalLabels(tagRecord(labels));
export const hasAlchemyLabelMap = (labels: Record<string, string | undefined> | null | undefined) =>
Object.keys(labels ?? {}).some((key) => key.startsWith("alchemy-"));
export const encodeOwnership = (
labels: Record<string, string>,
text: string | undefined,
): string => {
const marker = `[alchemy ${alchemyLabelKeys.stack}=${labels[alchemyLabelKeys.stack]} ${alchemyLabelKeys.stage}=${labels[alchemyLabelKeys.stage]} ${alchemyLabelKeys.id}=${labels[alchemyLabelKeys.id]}]`;
const trimmed = text?.trim();
return trimmed && trimmed.length > 0 ? `${marker}\n${trimmed}` : marker;
};
export const parseOwnership = (
text: string | undefined,
): {
labels: Record<string, string>;
text: string | undefined;
} => {
if (!text?.startsWith("[alchemy ")) {
return { labels: {}, text };
}
const end = text.indexOf("]");
if (end < 0) return { labels: {}, text };
const labels: Record<string, string> = {};
for (const part of text.slice("[alchemy ".length, end).split(/\s+/)) {
const eq = part.indexOf("=");
if (eq > 0) {
labels[part.slice(0, eq)] = part.slice(eq + 1);
}
}
const rest = text.slice(end + 1).replace(/^\s+/, "");
return { labels, text: rest.length > 0 ? rest : undefined };
};
export const hasOwnershipMarker = (text: string | undefined) =>
Object.keys(parseOwnership(text).labels).some((key) => key.startsWith("alchemy-"));
export const isOwned = (
annotations: Record<string, string | undefined> | null | undefined,
text: string | undefined,
) => hasAlchemyLabelMap(annotations) || hasOwnershipMarker(text);
export const desiredAnnotations = (
ownership: Record<string, string>,
labels: Record<string, string> | undefined,
annotations: Record<string, string> | undefined,
): Record<string, string> => ({
...toLabels(labels),
...stringMap(annotations),
...ownership,
});
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);
const pickDefined = (observed: unknown, desired: unknown): unknown => {
if (desired === undefined || desired === null) return undefined;
if (Array.isArray(desired)) {
if (!Array.isArray(observed)) return observed;
return desired.map((item, index) => pickDefined(observed[index], item));
}
if (typeof desired === "object") {
if (typeof observed !== "object" || observed === null) return observed;
const rec = observed as Record<string, unknown>;
return Object.fromEntries(
Object.entries(desired as Record<string, unknown>).map(([key, item]) => [
key,
pickDefined(rec[key], item),
]),
);
}
return observed;
};
export const differs = (observed: unknown, desired: unknown): boolean => {
if (desired === undefined) return false;
return fingerprint(pickDefined(observed, desired)) !== fingerprint(desired);
};
export const fieldMask = (fields: Array<string | false | undefined>) =>
fields.filter((field): field is string => typeof field === "string").join(",");
export const sameText = (left: string | undefined, right: string | undefined) =>
(left ?? "") === (right ?? "");
export const textState = (state: string | undefined) =>
state === undefined ? undefined : `${state}`;
export const replaceOnIdentity = (input: {
previousId: string | undefined;
nextId: string | undefined;
previousLocation: string;
nextLocation: string;
extra?: boolean;
previousParent?: string;
nextParent?: string;
}) => {
const parentChanged =
(input.previousParent ?? "") !== "" &&
(input.nextParent ?? "") !== "" &&
(input.previousParent ?? "") !== (input.nextParent ?? "");
const replace =
(input.extra ?? false) ||
parentChanged ||
(input.previousId !== undefined &&
input.nextId !== undefined &&
input.nextId !== input.previousId) ||
input.previousLocation !== input.nextLocation;
if (!replace) return undefined;
const samePhysical =
input.previousLocation === input.nextLocation &&
!parentChanged &&
input.previousId !== undefined &&
input.nextId === input.previousId;
return {
action: "replace" as const,
deleteFirst: samePhysical,
};
};
const READY_STATES = new Set(["RUNNING", "READY", "DEGRADED"]);
const FAILED_STATES = new Set(["ERROR", "FAILED"]);
export const isReadyState = (state: string | undefined) =>
READY_STATES.has((state ?? "").toUpperCase());
export const isFailedState = (state: string | undefined) =>
FAILED_STATES.has((state ?? "").toUpperCase());
/**
* Wait on a GKE On-Prem long-running operation. Cluster and node-pool enrollment takes up to ~30 minutes.
* `ALREADY_EXISTS` (a create race) counts as success; so does `NOT_FOUND`
* when `notFoundOk` (deletes). Returns the final operation.
*/
export const waitForOperation = (
operation: gkeonprem.Operation,
options?: { notFoundOk?: boolean },
) =>
Effect.suspend(() => {
let latest = operation;
return waitForLongRunningOperation(
operation,
(name) => {
const get = gkeonprem.getProjectsLocationsOperations({ name }).pipe(
Effect.tap((current) =>
Effect.sync(() => {
latest = current;
}),
),
);
const observe: Effect.Effect<
gkeonprem.Operation,
gkeonprem.GetProjectsLocationsOperationsError,
GcpOpContext
> =
options?.notFoundOk === true
? get.pipe(
Effect.catchTag("NotFound", () =>
Effect.succeed<gkeonprem.Operation>({ name, done: true }),
),
)
: get.pipe(
// A just-returned operation can briefly 404 on read.
Effect.retry({
while: (error) => error._tag === "NotFound",
times: 5,
schedule: Schedule.exponential("250 millis"),
}),
);
return observe;
},
{ budget: "30 minutes", interval: "10 seconds" },
).pipe(
Effect.map(() => latest),
// google.rpc.Code ALREADY_EXISTS = 6, NOT_FOUND = 5.
Effect.catchTag("GCP.OperationFailed", (error) =>
error.code === 6 || (options?.notFoundOk === true && error.code === 5)
? Effect.succeed(latest)
: Effect.fail(error),
),
);
});
export const waitUntilExists = <A, E extends { readonly _tag: string }, R>(
get: Effect.Effect<A, E, R>,
name: string,
): Effect.Effect<Exclude<A, undefined>, E | ResourceNotResolved, R> =>
get.pipe(
Effect.filterOrFail(
(value): value is Exclude<A, undefined> => value !== undefined,
() => new ResourceNotResolved({ resourceName: name }),
),
Effect.retry({
while: (error) => error._tag === "GCP.GKEOnPrem.ResourceNotResolved",
times: 8,
schedule: Schedule.spaced("1 second"),
}),
);
export const waitUntilGone = <A, E extends { readonly _tag: string }, R>(
get: Effect.Effect<A, E, R>,
name: string,
): Effect.Effect<void, E | ResourceStillExists, R> =>
get.pipe(
Effect.filterOrFail(
(value) => value === undefined,
() => new ResourceStillExists({ resourceName: name }),
),
Effect.asVoid,
Effect.retry({
while: (error) => error._tag === "GCP.GKEOnPrem.ResourceStillExists",
times: 10,
schedule: Schedule.spaced("2 seconds"),
}),
);
export const waitUntilReady = <A, E extends { readonly _tag: string }, R>(
get: Effect.Effect<A, E, R>,
name: string,
stateOf: (value: Exclude<A, undefined>) => string | undefined,
detailsOf?: (value: Exclude<A, undefined>) => string | undefined,
options?: {
times?: number;
interval?: `${number} seconds`;
},
): Effect.Effect<
Exclude<A, undefined>,
E | ResourceNotResolved | ResourceFailed | ResourceNotReady,
R
> =>
get.pipe(
Effect.filterOrFail(
(value): value is Exclude<A, undefined> => value !== undefined,
() => new ResourceNotResolved({ resourceName: name }),
),
Effect.filterOrFail(
(value) => !isFailedState(stateOf(value)),
(value) =>
new ResourceFailed({
resourceName: name,
state: stateOf(value) ?? "",
details: detailsOf?.(value),
}),
),
Effect.filterOrFail(
(value) => {
const state = stateOf(value) ?? "";
return isReadyState(state) || state.length === 0;
},
(value) => new ResourceNotReady({ resourceName: name, state: stateOf(value) ?? "" }),
),
Effect.retry({
while: (error) =>
error._tag === "GCP.GKEOnPrem.ResourceNotReady" ||
error._tag === "GCP.GKEOnPrem.ResourceNotResolved",
// Cluster enrollment takes up to ~30 minutes.
times: options?.times ?? 180,
schedule: Schedule.spaced(options?.interval ?? "10 seconds"),
}),
);
export const collectPages = <Page, Item, E extends { readonly _tag: string }, R>(
stream: Stream.Stream<Page, E, R>,
pick: (page: Page) => readonly Item[] | undefined,
) =>
stream.pipe(
Stream.flatMap((page) => Stream.fromIterable(pick(page) ?? [])),
Stream.runCollect,
Effect.map((chunk) => Array.from(chunk)),
// A missing parent lists as empty.
Effect.catchIf(
(error) => error._tag === "NotFound",
() => Effect.succeed([] as Item[]),
),
);
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(
// Some collections reject the `-` location wildcard.
(error) => error._tag === "NotFound",
() => list(`projects/${project}/locations/${region}`),
),
);
export const listAtNested = <A, E extends { readonly _tag: string }, R>(
project: string,
region: string,
nested: string,
list: (parent: string) => Effect.Effect<A[], E, R>,
) =>
list(`projects/${project}/locations/-/${nested}`).pipe(
Effect.catchIf(
// Some collections reject the `-` location wildcard.
(error) => error._tag === "NotFound",
() => list(`projects/${project}/locations/${region}/${nested}`),
),
);
export const listChildrenOf = <Parent, Child, E1, E2, R>(
parents: Effect.Effect<Parent[], E1, R>,
nameOf: (parent: Parent) => string | undefined,
listChildren: (parent: string) => Effect.Effect<Child[], E2, R>,
) =>
parents.pipe(
Effect.flatMap((items) =>
Effect.forEach(
items,
(item) => {
const name = nameOf(item);
return name ? listChildren(name) : Effect.succeed([] as Child[]);
},
{ concurrency: 5 },
).pipe(Effect.map((chunks) => chunks.flat())),
),
);