import * as apigee from "@distilled.cloud/gcp/apigee_v1";
import { unownedUnlessPrevious } from "alchemy/AdoptPolicy";
import { isResolved } from "alchemy/Diff";
import * as Provider from "alchemy/Provider";
import { Resource } from "alchemy/Resource";
import * as Data from "effect/Data";
import * as Effect from "effect/Effect";
import { GcpEnvironment } from "../Environment.ts";
import type { Providers } from "../Providers.ts";
import { lastSegment, orgParent, organizationFromName, toResourceId } from "./names.ts";
const MAX_NAME_LENGTH = 255;
export type KeyvaluemapsEntryProps = {
/**
* Apigee organization id. Defaults to the current GCP project id.
* Immutable — changing it replaces the entry.
*/
organization?: string;
/**
* Parent key value map id or full name
* (`organizations/{org}/keyvaluemaps/{keyvaluemap}`). Immutable —
* changing it replaces the entry.
*/
map: string;
/**
* Entry key (the `{entry}` segment of
* `organizations/{org}/keyvaluemaps/{keyvaluemap}/entries/{entry}`).
* If omitted, a unique name is generated from the stack, stage, and
* logical id. Immutable — changing it replaces the entry. Must not be
* `__alchemy` (reserved by {@link Keyvaluemap} for ownership).
*/
entryId?: string;
/**
* Payload associated with the key, stored verbatim.
*/
value: string;
};
export type KeyvaluemapsEntry = Resource<
"GCP.Apigee.KeyvaluemapsEntry",
KeyvaluemapsEntryProps,
{
/** Full resource name `organizations/{org}/keyvaluemaps/{map}/entries/{entry}`. */
name: string;
/** Entry key (last path segment). */
entryId: string;
/** Parent map id. */
mapId: string;
/** Apigee organization id. */
organization: string;
/** Payload associated with the key. */
value: string;
},
never,
Providers
>;
/**
* An organization-scoped Apigee key value map entry.
*
* Entries have no labels field and the value is read by proxies, so
* Alchemy stores it verbatim and identifies its entries by the generated
* key: `read` reports an entry with an explicit `entryId` as unowned
* (adopt it with `--adopt`). Organization, map, and key are identity —
* changing them replaces the entry. `value` updates in place.
*
* ### Creating an Entry
* **Example:** Generated key on a map
* ```typescript
* const kv = yield* GCP.Apigee.Keyvaluemap("Config", {});
* const entry = yield* GCP.Apigee.KeyvaluemapsEntry("ApiKey", {
* map: kv.name,
* value: "secret-value",
* });
* ```
*
* **Example:** Explicit key
* ```typescript
* const entry = yield* GCP.Apigee.KeyvaluemapsEntry("ApiKey", {
* map: kv.name,
* entryId: "api-key",
* value: "secret-value",
* });
* ```
*
* @resource
* @category Apigee
*/
export const KeyvaluemapsEntry = Resource<KeyvaluemapsEntry>("GCP.Apigee.KeyvaluemapsEntry");
export class KeyvaluemapsEntryNotResolved extends Data.TaggedError(
"GCP.Apigee.KeyvaluemapsEntryNotResolved",
)<{
resourceName: string;
}> {}
const mapIdOf = (map: string) => lastSegment(map);
const mapName = (organization: string, map: string) =>
map.includes("/") ? map : `${orgParent(organization)}/keyvaluemaps/${map}`;
const resourceName = (organization: string, map: string, entryId: string) =>
`${mapName(organization, map)}/entries/${entryId}`;
const toAttrs = (
entry: apigee.GoogleCloudApigeeV1KeyValueEntry,
organization: string,
mapId: string,
) => {
const raw = entry.name ?? "";
const name = raw.includes("/") ? raw : resourceName(organization, mapId, raw);
return {
name,
entryId: lastSegment(name),
mapId,
organization: organizationFromName(name) ?? organization,
value: entry.value ?? "",
};
};
const getByName = (name: string) =>
apigee
.getOrganizationsKeyvaluemapsEntries({ name })
.pipe(Effect.catchTag(["NotFound", "ApigeeResourceNotFound"], () => Effect.undefined));
export const KeyvaluemapsEntryProvider = () =>
Provider.succeed(KeyvaluemapsEntry, {
stables: ["name", "entryId", "mapId", "organization"],
diff: Effect.fn(function* ({ news, olds, output }) {
if (!isResolved(news)) return undefined;
const previousId = olds?.entryId ?? output?.entryId;
const previousMap = olds?.map ?? output?.mapId;
const previousOrg = olds?.organization ?? output?.organization;
if (
(previousId !== undefined && news.entryId !== undefined && news.entryId !== previousId) ||
(previousMap !== undefined && mapIdOf(news.map) !== mapIdOf(previousMap)) ||
(previousOrg !== undefined &&
news.organization !== undefined &&
news.organization !== previousOrg)
) {
return { action: "replace" as const, deleteFirst: true };
}
return undefined;
}),
read: Effect.fn(function* ({ id, olds, output, previous }) {
const env = yield* GcpEnvironment.current;
const organization = organizationFromName(output?.name) ?? olds?.organization ?? env.project;
const mapId = mapIdOf(olds?.map ?? output?.mapId ?? "");
if (mapId.length === 0) return undefined;
const entryId = yield* toResourceId(id, olds?.entryId, output?.entryId, MAX_NAME_LENGTH);
const name = output?.name ?? resourceName(organization, mapId, entryId);
const existing = yield* getByName(name);
if (existing === undefined) return undefined;
const attrs = toAttrs(existing, organization, mapId);
const generated = yield* toResourceId(id, undefined, undefined, MAX_NAME_LENGTH);
return attrs.entryId === generated ? attrs : unownedUnlessPrevious(attrs, previous, "name");
}),
reconcile: Effect.fn(function* ({ id, news, output }) {
const env = yield* GcpEnvironment.current;
const organization = news.organization ?? output?.organization ?? env.project;
const mapId = mapIdOf(news.map);
const entryId = yield* toResourceId(id, news.entryId, output?.entryId, MAX_NAME_LENGTH);
const parent = mapName(organization, news.map);
const name = resourceName(organization, mapId, entryId);
const desiredValue = news.value;
let current = yield* getByName(output?.name ?? name);
if (current === undefined) {
const created = yield* apigee
.createOrganizationsKeyvaluemapsEntries({
parent,
body: { name: entryId, value: desiredValue },
})
.pipe(Effect.catchTag("Conflict", () => getByName(name)));
current = created ?? undefined;
}
if (current === undefined) {
return yield* new KeyvaluemapsEntryNotResolved({ resourceName: name });
}
if ((current.value ?? "") !== desiredValue) {
current = yield* apigee.updateOrganizationsKeyvaluemapsEntries({
name: current.name?.includes("/") ? current.name : name,
body: { name: entryId, value: desiredValue },
});
}
return toAttrs(current, organization, mapId);
}),
delete: Effect.fn(function* ({ output }) {
yield* apigee
.deleteOrganizationsKeyvaluemapsEntries({ name: output.name })
.pipe(Effect.catchTag(["NotFound", "ApigeeResourceNotFound"], () => Effect.void));
}),
});