import * as firebasedataconnect from "@distilled.cloud/gcp/firebasedataconnect_v1";
import { Unowned } from "alchemy/AdoptPolicy";
import { isResolved } from "alchemy/Diff";
import * as Provider from "alchemy/Provider";
import { Resource } from "alchemy/Resource";
import { tagRecord } from "alchemy/Tags";
import * as Effect from "effect/Effect";
import * as Schedule from "effect/Schedule";
import { GcpEnvironment } from "../Environment.ts";
import { createInternalLabels, diffLabels, hasAlchemyLabels, toLabels } from "../Labels.ts";
import type { Providers } from "../Providers.ts";
import {
fieldMask,
fingerprint,
listAtLocation,
listLabeledPages,
normalizeLocation,
parentOf,
parseName,
replaceOnIdentity,
ResourceNotResolved,
retryStaleEtag,
sameText,
stringMap,
toPhysicalId,
userLabels,
waitForDeleteOperation,
waitForOperation,
waitUntilExists,
waitUntilGone,
waitUntilReady,
} from "./internal.ts";
export type ServiceProps = {
/**
* Service id (the `{service}` segment of
* `projects/{project}/locations/{location}/services/{service}`).
* If omitted, a unique RFC1035 name is generated from the stack,
* stage, and logical id. Immutable — changing it replaces the
* service. Must start with a letter, contain only lowercase letters,
* digits, and hyphens, and be at most 63 characters.
*/
serviceId?: string;
/**
* Region (`us-central1`, `us-east1`, …). Immutable — changing it
* replaces the service. `US-CENTRAL1` is accepted and normalized to
* `us-central1`.
* @default the stack's GCP region (`GCP.Region`, else the profile region, else `us-central1`)
*/
location?: string;
/**
* Human-readable name. 63 character limit.
*/
displayName?: string;
/**
* User annotations (preserved by external tools).
*/
annotations?: Record<string, string>;
/**
* User labels. Alchemy ownership labels are merged in automatically.
*/
labels?: Record<string, string>;
};
export type Service = Resource<
"GCP.FirebaseDataConnect.Service",
ServiceProps,
{
/** Full resource name. */
name: string;
/** Service id (last path segment). */
serviceId: string;
/** Project id. */
project: string;
/** Location id. */
location: string;
/** Human-readable name. */
displayName: string | undefined;
/** True while Data Connect is applying an LRO. */
reconciling: boolean;
/** User annotations. */
annotations: Record<string, string>;
/** User labels (Alchemy ownership labels stripped). */
labels: Record<string, string>;
/** Server-generated resource uid. */
uid: string | undefined;
/** RFC3339 creation timestamp. */
createTime: string | undefined;
/** RFC3339 last-update timestamp. */
updateTime: string | undefined;
/** Server-computed etag. */
etag: string | undefined;
},
never,
Providers
>;
/**
* A Firebase Data Connect service — the parent of a GraphQL schema and
* connectors.
*
* Changing `serviceId` or `location` replaces the service. Display
* name, labels, and annotations update in place.
*
* ### Creating a Service
* **Example:** Generated name
* ```typescript
* const service = yield* GCP.FirebaseDataConnect.Service("App", {
* labels: { env: "test" },
* });
* ```
*
* **Example:** Explicit id
* ```typescript
* const service = yield* GCP.FirebaseDataConnect.Service("App", {
* serviceId: "movies",
* displayName: "movie tracker",
* labels: { env: "prod" },
* });
* ```
*
* ### Updating a Service
* **Example:** Display name and labels
* ```typescript
* const service = yield* GCP.FirebaseDataConnect.Service("App", {
* displayName: "movie tracker v2",
* labels: { env: "prod", team: "data" },
* });
* ```
*
* @resource
* @category FirebaseDataConnect
*/
export const Service = Resource<Service>("GCP.FirebaseDataConnect.Service");
const resourceName = (project: string, location: string, serviceId: string) =>
`projects/${project}/locations/${location}/services/${serviceId}`;
const toAttrs = (
item: firebasedataconnect.Service,
project: string,
region: string,
): Service["Attributes"] => {
const name = item.name ?? "";
const parsed = parseName(name, "services", region);
return {
name,
serviceId: parsed.id,
project: parsed.project || project,
location: parsed.location,
displayName: item.displayName,
reconciling: item.reconciling === true,
annotations: stringMap(item.annotations),
labels: userLabels(item.labels),
uid: item.uid,
createTime: item.createTime,
updateTime: item.updateTime,
etag: item.etag,
};
};
const getByName = (name: string) =>
firebasedataconnect
.getProjectsLocationsServices({ name })
.pipe(Effect.catchTag("NotFound", () => Effect.undefined));
const listOwned = (project: string) =>
listAtLocation(project, (parent) =>
listLabeledPages(
firebasedataconnect.listProjectsLocationsServices.pages({
parent,
pageSize: 1000,
}),
(page) => page.services,
(item) => item.labels,
),
);
export const ServiceProvider = () =>
Provider.succeed(Service, {
stables: ["name", "serviceId", "project", "location", "uid", "createTime"],
diff: Effect.fn(function* ({ news, olds, output }) {
if (!isResolved(news)) return undefined;
const env = yield* GcpEnvironment.current;
return replaceOnIdentity({
previousId: olds?.serviceId ?? output?.serviceId,
nextId: news.serviceId ?? olds?.serviceId ?? output?.serviceId,
previousLocation: normalizeLocation(olds?.location ?? output?.location, env.region),
nextLocation: normalizeLocation(
news.location ?? olds?.location ?? output?.location,
env.region,
),
});
}),
read: Effect.fn(function* ({ id, olds, output }) {
const env = yield* GcpEnvironment.current;
const serviceId = yield* toPhysicalId(id, olds?.serviceId, output?.serviceId, "service");
const location = normalizeLocation(olds?.location ?? output?.location, env.region);
const name = output?.name ?? resourceName(env.project, location, serviceId);
const existing = yield* getByName(name);
if (existing === undefined) return undefined;
const attrs = toAttrs(existing, env.project, env.region);
return (yield* hasAlchemyLabels(id, tagRecord(existing.labels))) ? attrs : Unowned(attrs);
}),
list: () =>
Effect.gen(function* () {
const env = yield* GcpEnvironment.current;
const items = yield* listOwned(env.project);
return items.map((item) => toAttrs(item, env.project, env.region));
}),
reconcile: Effect.fn(function* ({ id, news, output }) {
const env = yield* GcpEnvironment.current;
const serviceId = yield* toPhysicalId(id, news.serviceId, output?.serviceId, "service");
const location = normalizeLocation(news.location ?? output?.location, env.region);
const name = resourceName(env.project, location, serviceId);
const desiredLabels = {
...toLabels(news.labels),
...(yield* createInternalLabels(id)),
};
const desiredAnnotations = news.annotations ?? {};
let current = yield* getByName(output?.name ?? name);
if (current === undefined) {
const created = yield* firebasedataconnect
.createProjectsLocationsServices({
parent: parentOf(env.project, location),
serviceId,
body: {
displayName: news.displayName,
annotations: desiredAnnotations,
labels: desiredLabels,
},
})
.pipe(Effect.catchTag("Conflict", () => Effect.undefined));
if (created !== undefined) {
yield* waitForOperation(created);
}
current = yield* waitUntilExists(getByName(name), name);
}
if (current === undefined) {
return yield* new ResourceNotResolved({ resourceName: name });
}
const observedLabels = tagRecord(current.labels);
const { upsert, removed } = diffLabels(observedLabels, desiredLabels);
const mask = fieldMask([
(upsert.length > 0 || removed.length > 0) && "labels",
fingerprint(stringMap(current.annotations)) !== fingerprint(desiredAnnotations) &&
"annotations",
!sameText(current.displayName, news.displayName) && "displayName",
]);
if (mask.length > 0) {
const serviceName = current.name ?? name;
// Child schema/connector updates bump the service etag while this
// patch is in flight: re-read the etag on each attempt.
yield* retryStaleEtag(
Effect.gen(function* () {
const latest = yield* getByName(serviceName);
const operation = yield* firebasedataconnect.patchProjectsLocationsServices({
name: serviceName,
updateMask: mask,
body: {
etag: latest?.etag,
displayName: news.displayName,
annotations: desiredAnnotations,
labels: desiredLabels,
},
});
yield* waitForOperation(operation);
}),
);
current = yield* waitUntilExists(getByName(current.name ?? name), current.name ?? name);
}
current = yield* waitUntilReady(getByName(current.name ?? name), current.name ?? name);
return toAttrs(current, env.project, env.region);
}),
delete: Effect.fn(function* ({ output }) {
const operation = yield* firebasedataconnect
.deleteProjectsLocationsServices({
name: output.name,
force: true,
})
.pipe(
Effect.retry({
while: (error) => error._tag === "Conflict",
times: 8,
schedule: Schedule.spaced("2 seconds"),
}),
Effect.catchTag("NotFound", () => Effect.undefined),
);
if (operation !== undefined) {
yield* waitForDeleteOperation(operation);
}
yield* waitUntilGone(getByName(output.name), output.name);
}),
});