import * as discoveryengine from "@distilled.cloud/gcp/discoveryengine_v1";
import { Unowned } 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 { parentBefore, parseResourceName, sameStringList, toResourceId } from "./internal.ts";
export type CollectionsEnginesSessionProps = {
/**
* Parent Engine resource name
* `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`.
* Immutable — changing it replaces the session.
*/
engine: string;
/**
* Session id. If omitted, a unique id is generated. Immutable —
* changing it replaces the session.
*/
sessionId?: string;
/**
* User-facing display name.
*/
displayName?: string;
/**
* User tracking id.
*/
userPseudoId?: string;
/**
* Session state.
*/
state?: discoveryengine.GoogleCloudDiscoveryengineV1SessionStateEnum;
/**
* Pin the session to the top of the session list.
* @default false
*/
isPinned?: boolean;
/**
* Free-form session labels.
*/
labels?: string[];
};
export type CollectionsEnginesSession = Resource<
"GCP.DiscoveryEngine.CollectionsEnginesSession",
CollectionsEnginesSessionProps,
{
/** Full resource name. */
name: string;
/** Session id (last path segment). */
sessionId: string;
/** Parent engine resource name. */
engine: string;
/** Project id. */
project: string;
/** Location id. */
location: string;
/** Collection id. */
collectionId: string;
/** Display name. */
displayName: string | undefined;
/** User tracking id. */
userPseudoId: string | undefined;
/** Session state. */
state: string | undefined;
/** Whether the session is pinned. */
isPinned: boolean;
/** Labels. */
labels: string[];
/** RFC3339 start timestamp. */
startTime: string | undefined;
/** RFC3339 end timestamp. */
endTime: string | undefined;
},
never,
Providers
>;
/**
* A Discovery Engine Session on a collection Engine.
*
* Without labels, ownership rests on the deterministic id: `read` reports a
* resource it finds without prior state as unowned (adopt it with `--adopt`).
* Parent engine and session id are immutable; display name, pin, and labels
* update in place.
*
* ### Creating a Session
* **Example:** Named session
* ```typescript
* const session = yield* GCP.DiscoveryEngine.CollectionsEnginesSession(
* "Chat",
* {
* engine: engine.name,
* displayName: "support",
* },
* );
* ```
*
* ### Updating a Session
* **Example:** Pin and rename
* ```typescript
* // Same logical id as before; only the changed props differ.
* const session = yield* GCP.DiscoveryEngine.CollectionsEnginesSession(
* "Chat",
* {
* engine: engine.name,
* displayName: "support-prod",
* isPinned: true,
* },
* );
* ```
*
* @resource
* @category DiscoveryEngine
*/
export const CollectionsEnginesSession = Resource<CollectionsEnginesSession>(
"GCP.DiscoveryEngine.CollectionsEnginesSession",
);
export class CollectionsEnginesSessionNotResolved extends Data.TaggedError(
"GCP.DiscoveryEngine.CollectionsEnginesSessionNotResolved",
)<{
resourceName: string;
}> {}
const resourceName = (engine: string, sessionId: string) => `${engine}/sessions/${sessionId}`;
const getByName = (name: string) =>
discoveryengine
.getProjectsLocationsCollectionsEnginesSessions({ name })
.pipe(Effect.catchTag("NotFound", () => Effect.undefined));
const userLabels = (labels: readonly string[] | undefined) => [...(labels ?? [])];
const toAttrs = (session: discoveryengine.GoogleCloudDiscoveryengineV1Session, project: string) => {
const name = session.name ?? "";
const parsed = parseResourceName(name, "sessions");
return {
name,
sessionId: parsed.id,
engine: parentBefore(name, "sessions"),
project: parsed.project || project,
location: parsed.location,
collectionId: parsed.collectionId,
displayName: session.displayName,
userPseudoId: session.userPseudoId,
state: session.state,
isPinned: session.isPinned === true,
labels: userLabels(session.labels),
startTime: session.startTime,
endTime: session.endTime,
};
};
export const CollectionsEnginesSessionProvider = () =>
Provider.succeed(CollectionsEnginesSession, {
stables: ["name", "sessionId", "engine", "project", "location", "collectionId", "startTime"],
diff: Effect.fn(function* ({ news, olds, output }) {
if (!isResolved(news)) return undefined;
const previousEngine = olds?.engine ?? output?.engine;
const previousId = olds?.sessionId ?? output?.sessionId;
const nextId = news.sessionId ?? previousId;
if (
(previousEngine !== undefined && news.engine !== previousEngine) ||
(previousId !== undefined && nextId !== undefined && nextId !== previousId)
) {
return { action: "replace" as const, deleteFirst: false };
}
return undefined;
}),
read: Effect.fn(function* ({ id, olds, output }) {
const env = yield* GcpEnvironment.current;
const parent = olds?.engine ?? output?.engine;
const childId = yield* toResourceId(id, olds?.sessionId, output?.sessionId);
const name =
output?.name ?? (parent !== undefined ? resourceName(parent, childId) : undefined);
if (name === undefined) return undefined;
const existing = yield* getByName(name);
if (existing === undefined) return undefined;
const attrs = toAttrs(existing, env.project);
// No labels field: without prior state it may not be ours.
return output !== undefined ? attrs : Unowned(attrs);
}),
reconcile: Effect.fn(function* ({ id, news, output }) {
const env = yield* GcpEnvironment.current;
const sessionId = yield* toResourceId(id, news.sessionId, output?.sessionId);
const displayName = news.displayName;
const isPinned = news.isPinned === true;
const labels = news.labels;
const fallbackName = output?.name ?? resourceName(news.engine, sessionId);
let current = yield* getByName(fallbackName);
if (current === undefined) {
const created = yield* discoveryengine
.createProjectsLocationsCollectionsEnginesSessions({
parent: news.engine,
sessionId,
body: {
displayName,
userPseudoId: news.userPseudoId,
state: news.state,
isPinned: isPinned ? true : undefined,
labels,
},
})
.pipe(Effect.catchTag("Conflict", () => getByName(fallbackName)));
current = created ?? undefined;
}
if (current === undefined) {
return yield* new CollectionsEnginesSessionNotResolved({
resourceName: fallbackName,
});
}
const name = current.name ?? fallbackName;
const displayNameChanged = (current.displayName ?? "") !== (displayName ?? "");
const userChanged = (current.userPseudoId ?? "") !== (news.userPseudoId ?? "");
const stateChanged = (current.state ?? "") !== (news.state ?? "");
const pinnedChanged = (current.isPinned === true) !== isPinned;
const labelsChanged = !sameStringList(userLabels(current.labels), labels);
if (displayNameChanged || userChanged || stateChanged || pinnedChanged || labelsChanged) {
current = yield* discoveryengine.patchProjectsLocationsCollectionsEnginesSessions({
name,
updateMask: [
displayNameChanged ? "display_name" : undefined,
userChanged ? "user_pseudo_id" : undefined,
stateChanged ? "state" : undefined,
pinnedChanged ? "is_pinned" : undefined,
labelsChanged ? "labels" : undefined,
]
.filter((field): field is string => field !== undefined)
.join(","),
body: {
name,
displayName,
userPseudoId: news.userPseudoId,
state: news.state,
isPinned,
labels,
},
});
}
return toAttrs(current, env.project);
}),
delete: Effect.fn(function* ({ output }) {
const existing = yield* getByName(output.name);
if (existing === undefined) return;
yield* discoveryengine
.deleteProjectsLocationsCollectionsEnginesSessions({
name: output.name,
})
.pipe(Effect.catchTag("NotFound", () => Effect.void));
}),
});