import * as personalize from "@distilled.cloud/aws/personalize";
import { Unowned } from "alchemy/AdoptPolicy";
import { isResolved } from "alchemy/Diff";
import { createPhysicalName } from "alchemy/PhysicalName";
import * as Provider from "alchemy/Provider";
import { Resource } from "alchemy/Resource";
import { createInternalTags, hasAlchemyTags } 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 type { Providers } from "../Providers.ts";
import { readPersonalizeTags, syncPersonalizeTags } from "./internal.ts";
export class EventTrackerNotReady extends Data.TaggedError("EventTrackerNotReady")<{
readonly message: string;
readonly cause?: unknown;
}> {}
export interface EventTrackerProps {
/**
* Name of the event tracker. If omitted, a unique name is generated from
* the app, stage, and logical ID. Changing the name replaces the tracker.
*/
name?: string;
/**
* ARN of the dataset group the event tracker records events for. The
* dataset group should contain an Interactions dataset (events are recorded
* into it). Only one event tracker can exist per dataset group. Immutable —
* changing it replaces the tracker.
*/
datasetGroupArn: string;
/**
* User-defined tags for the event tracker.
*/
tags?: Record<string, string>;
}
export interface EventTracker extends Resource<
"AWS.Personalize.EventTracker",
EventTrackerProps,
{
/**
* ARN of the event tracker.
*/
eventTrackerArn: string;
/**
* The tracking ID passed as `trackingId` to the PutEvents /
* PutActionInteractions data-plane operations.
*/
trackingId: string;
/**
* Name of the event tracker.
*/
name: string;
/**
* Event tracker status (e.g. `ACTIVE`, `CREATE PENDING`).
*/
status: string;
/**
* ARN of the dataset group the tracker records events for.
*/
datasetGroupArn: string;
},
never,
Providers
> {}
/**
* An Amazon Personalize event tracker — the ingestion endpoint for streaming
* interaction events into a dataset group's Interactions dataset. Creating a
* tracker yields a `trackingId` that the {@link PutEvents} data-plane binding
* uses to record events in real time.
*
* ### Creating an Event Tracker
* **Example:** Track Events for a Dataset Group
* ```typescript
* const tracker = yield* Personalize.EventTracker("Tracker", {
* datasetGroupArn: group.datasetGroupArn,
* });
* ```
*
* ### Streaming Events
* **Example:** Record Click Events from a Lambda
* ```typescript
* // init
* const putEvents = yield* Personalize.PutEvents(tracker);
*
* // runtime
* yield* putEvents({
* sessionId: "session-1",
* userId: "user-1",
* eventList: [{ eventType: "click", itemId: "item-42", sentAt: new Date() }],
* });
* ```
*
* @resource
*/
export const EventTracker = Resource<EventTracker>("AWS.Personalize.EventTracker");
export const EventTrackerProvider = () =>
Provider.effect(
EventTracker,
Effect.gen(function* () {
const createName = Effect.fn(function* (id: string, props: EventTrackerProps) {
return props.name ?? (yield* createPhysicalName({ id, maxLength: 63 }));
});
const describe = Effect.fn(function* (eventTrackerArn: string) {
const response = yield* personalize
.describeEventTracker({ eventTrackerArn })
.pipe(Effect.catchTag("ResourceNotFoundException", () => Effect.undefined));
return response?.eventTracker;
});
/** Poll until the tracker reaches ACTIVE; fail fast on CREATE FAILED. */
const waitActive = Effect.fn(function* (eventTrackerArn: string) {
const tracker = yield* describe(eventTrackerArn).pipe(
Effect.repeat({
schedule: Schedule.max([Schedule.fixed("2 seconds"), Schedule.recurs(40)]),
until: (t) => t?.status === "ACTIVE" || (t?.status ?? "").includes("FAILED"),
}),
);
if (tracker?.status !== "ACTIVE") {
return yield* new EventTrackerNotReady({
message: `Personalize event tracker ${eventTrackerArn} did not become ACTIVE (status: ${tracker?.status})`,
});
}
return tracker;
});
/** Find an existing tracker's ARN by name within its dataset group. */
const findArnByName = Effect.fn(function* (name: string, datasetGroupArn: string) {
const pages = yield* personalize.listEventTrackers
.pages({ datasetGroupArn })
.pipe(Stream.runCollect);
return Array.from(pages)
.flatMap((page) => page.eventTrackers ?? [])
.find((summary) => summary.name === name)?.eventTrackerArn;
});
const toAttrs = (tracker: personalize.EventTracker) => ({
eventTrackerArn: tracker.eventTrackerArn!,
trackingId: tracker.trackingId!,
name: tracker.name!,
status: tracker.status!,
datasetGroupArn: tracker.datasetGroupArn!,
});
return {
stables: ["eventTrackerArn", "trackingId", "name"],
diff: Effect.fn(function* ({ id, olds, news }) {
if (!isResolved(news)) return undefined;
const oldName = yield* createName(id, olds);
const newName = yield* createName(id, news);
if (
oldName !== newName ||
(olds.datasetGroupArn ?? undefined) !== (news.datasetGroupArn ?? undefined)
) {
return { action: "replace" } as const;
}
}),
read: Effect.fn(function* ({ id, output }) {
if (!output?.eventTrackerArn) return undefined;
const tracker = yield* describe(output.eventTrackerArn);
if (tracker === undefined) return undefined;
const attrs = toAttrs(tracker);
const tags = yield* readPersonalizeTags(tracker.eventTrackerArn!);
return (yield* hasAlchemyTags(id, tags)) ? attrs : Unowned(attrs);
}),
reconcile: Effect.fn(function* ({ id, news, output, session }) {
const name = yield* createName(id, news);
const internalTags = yield* createInternalTags(id);
const desiredTags = { ...internalTags, ...news.tags };
// 1. Observe — cloud state is authoritative; output is an ARN cache.
let tracker =
output?.eventTrackerArn !== undefined
? yield* describe(output.eventTrackerArn)
: undefined;
// 2. Ensure — create if missing, then wait for ACTIVE. A crashed
// prior run may have left a same-named tracker behind with no
// persisted state — adopt it by name and converge.
if (tracker === undefined) {
const arn = yield* personalize
.createEventTracker({
name,
datasetGroupArn: news.datasetGroupArn,
tags: Object.entries(desiredTags).map(([tagKey, tagValue]) => ({
tagKey,
tagValue,
})),
})
.pipe(
Effect.map((created) => created.eventTrackerArn!),
Effect.catchTag("ResourceAlreadyExistsException", (error) =>
findArnByName(name, news.datasetGroupArn).pipe(
Effect.flatMap((existing) =>
existing === undefined ? Effect.fail(error) : Effect.succeed(existing),
),
),
),
);
tracker = yield* waitActive(arn);
}
// 3. Sync tags — diff against OBSERVED cloud tags (no-op after a
// fresh create; converges an adopted leftover).
yield* syncPersonalizeTags(tracker.eventTrackerArn!, desiredTags);
yield* session.note(tracker.eventTrackerArn!);
return toAttrs(tracker);
}),
delete: Effect.fn(function* ({ output }) {
yield* personalize.deleteEventTracker({ eventTrackerArn: output.eventTrackerArn }).pipe(
Effect.catchTag("ResourceNotFoundException", () => Effect.void),
Effect.retry({
while: (e) => e._tag === "ResourceInUseException",
schedule: Schedule.max([Schedule.fixed("3 seconds"), Schedule.recurs(20)]),
}),
);
// Deletion is asynchronous — wait until the tracker is actually gone
// so its dataset group can delete without ResourceInUse churn.
const remaining = yield* describe(output.eventTrackerArn).pipe(
Effect.repeat({
schedule: Schedule.max([Schedule.fixed("3 seconds"), Schedule.recurs(40)]),
until: (tracker): boolean => tracker === undefined,
}),
);
if (remaining !== undefined) {
return yield* new EventTrackerNotReady({
message: `Personalize event tracker ${output.eventTrackerArn} was not deleted (status: ${remaining.status})`,
});
}
}),
list: () =>
personalize.listEventTrackers.pages({}).pipe(
Stream.runCollect,
Effect.map((chunk) => Array.from(chunk).flatMap((page) => page.eventTrackers ?? [])),
Effect.flatMap(
Effect.forEach(
(summary) =>
describe(summary.eventTrackerArn!).pipe(
Effect.map((t) => (t ? toAttrs(t) : undefined)),
),
{ concurrency: 4 },
),
),
Effect.map((items) => items.filter((item) => item !== undefined)),
),
};
}),
);