sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ CloudWatch/ CompositeAlarm.ts

import * as cloudwatch from "@distilled.cloud/aws/cloudwatch";
import { Unowned } from "alchemy/AdoptPolicy";
import { isResolved } from "alchemy/Diff";
import * as Provider from "alchemy/Provider";
import { Resource } from "alchemy/Resource";
import { hasAlchemyTags } from "alchemy/Tags";
import * as Data from "effect/Data";
import * as Effect from "effect/Effect";
import * as Stream from "effect/Stream";
import { AWSEnvironment } from "../Environment.ts";
import type { Providers } from "../Providers.ts";
import type { AlarmArn } from "./Alarm.ts";
import { createName, readResourceTags, retryConcurrent, updateResourceTags } from "./common.ts";

export class CompositeAlarmUnexpectedResponse extends Data.TaggedError(
  "CompositeAlarmUnexpectedResponse",
)<{
  readonly message: string;
  readonly cause?: unknown;
}> {}

export type CompositeAlarmName = string;

export interface CompositeAlarmProps extends Omit<
  cloudwatch.PutCompositeAlarmInput,
  "AlarmName" | "Tags"
> {
  /**
   * Name of the composite alarm. If omitted, a unique name is generated.
   */
  name?: CompositeAlarmName;
  /**
   * Optional tags to apply to the composite alarm.
   */
  tags?: Record<string, string>;
}

export interface CompositeAlarm extends Resource<
  "AWS.CloudWatch.CompositeAlarm",
  CompositeAlarmProps,
  {
    /** Physical name of the composite alarm. */
    alarmName: CompositeAlarmName;
    /** ARN of the composite alarm. */
    alarmArn: AlarmArn;
    /** Current state of the composite alarm (`OK`, `ALARM`, or `INSUFFICIENT_DATA`). */
    stateValue: cloudwatch.StateValue | undefined;
    /** Human-readable reason for the current state. */
    stateReason: string | undefined;
    /** The full CompositeAlarm description as last read from CloudWatch. */
    compositeAlarm: cloudwatch.CompositeAlarm;
    /** Tags on the composite alarm, including the internal Alchemy ownership tags. */
    tags: Record<string, string>;
  },
  never,
  Providers
> {}

/**
 * A CloudWatch composite alarm — combines the states of other alarms with
 * a boolean `AlarmRule` expression so a single alarm (and its actions)
 * reflects overall health.
 * ### Creating Composite Alarms
 * **Example:** Composite Rule
 * ```typescript
 * const composite = yield* CompositeAlarm("HighSeverity", {
 *   AlarmRule: 'ALARM("HighErrors") OR ALARM("HighLatency")',
 * });
 * ```
 *
 * **Example:** Compose Alarm Resources with Output.interpolate
 * ```typescript
 * const errors = yield* Alarm("HighErrors", {
 *   MetricName: "Errors",
 *   Namespace: "AWS/Lambda",
 *   Statistic: "Sum",
 *   Period: 60,
 *   EvaluationPeriods: 1,
 *   Threshold: 1,
 *   ComparisonOperator: "GreaterThanOrEqualToThreshold",
 * });
 *
 * const composite = yield* CompositeAlarm("HighSeverity", {
 *   AlarmRule: Output.interpolate`ALARM("${errors.alarmName}")`,
 * });
 * ```
 *
 * @resource
 */
export const CompositeAlarm = Resource<CompositeAlarm>("AWS.CloudWatch.CompositeAlarm");

export const CompositeAlarmProvider = () =>
  Provider.effect(
    CompositeAlarm,
    Effect.gen(function* () {
      const createAlarmName = (id: string, props: { name?: string } = {}) =>
        createName(id, props.name, 255);

      const alarmArn = (alarmName: string) =>
        AWSEnvironment.current.pipe(
          Effect.map(
            (env) =>
              `arn:aws:cloudwatch:${env.region}:${env.accountId}:alarm:${alarmName}` as AlarmArn,
          ),
        );

      const readCompositeAlarm = Effect.fn(function* (alarmName: string) {
        const described = yield* cloudwatch.describeAlarms({
          AlarmNames: [alarmName],
          AlarmTypes: ["CompositeAlarm"],
        });
        const compositeAlarm = described.CompositeAlarms?.find(
          (candidate) => candidate.AlarmName === alarmName,
        );

        if (!compositeAlarm?.AlarmName || !compositeAlarm.AlarmArn) {
          return undefined;
        }

        const tags = yield* readResourceTags(compositeAlarm.AlarmArn).pipe(
          Effect.catchTag("ResourceNotFoundException", () => Effect.succeed({})),
        );

        return {
          alarmName: compositeAlarm.AlarmName,
          alarmArn: compositeAlarm.AlarmArn as AlarmArn,
          stateValue: compositeAlarm.StateValue,
          stateReason: compositeAlarm.StateReason,
          compositeAlarm,
          tags,
        };
      });

      return {
        stables: ["alarmName", "alarmArn"],
        diff: Effect.fn(function* ({ id, olds = {}, news = {} }) {
          if (!isResolved(news)) return undefined;
          const oldName = yield* createAlarmName(id, olds);
          const newName = yield* createAlarmName(id, news);

          if (oldName !== newName) {
            return { action: "replace" } as const;
          }
        }),
        read: Effect.fn(function* ({ id, olds, output }) {
          const name = output?.alarmName ?? (yield* createAlarmName(id, olds ?? {}));
          const state = yield* readCompositeAlarm(name);
          if (!state) return undefined;
          return (yield* hasAlchemyTags(id, state.tags)) ? state : Unowned(state);
        }),
        reconcile: Effect.fn(function* ({ id, news, olds, output, session }) {
          // Observe — pin the physical name from `output` if present so we
          // never rename an existing alarm; otherwise derive from desired
          // props.
          const name = output?.alarmName ?? (yield* createAlarmName(id, news));
          const existing = yield* readCompositeAlarm(name);

          // Ensure — `putCompositeAlarm` is an upsert. We always send the
          // full desired config so the cloud converges to `news` whether
          // the alarm pre-existed or not.
          yield* retryConcurrent(
            cloudwatch.putCompositeAlarm({
              ...news,
              AlarmName: name,
            }),
          );

          // Sync tags — diff observed (or prior) tags against desired.
          // `olds` is undefined on adoption, so fall back to what we just
          // observed.
          const tags = yield* updateResourceTags({
            id,
            resourceArn: yield* alarmArn(name),
            olds: olds?.tags ?? existing?.tags,
            news: news.tags,
          });

          yield* session.note(yield* alarmArn(name));

          const state = yield* readCompositeAlarm(name);
          if (!state) {
            return yield* new CompositeAlarmUnexpectedResponse({
              message: `failed to read reconciled composite alarm '${name}'`,
            });
          }

          return {
            ...state,
            tags,
          };
        }),
        delete: Effect.fn(function* ({ output }) {
          yield* retryConcurrent(
            cloudwatch.deleteAlarms({
              AlarmNames: [output.alarmName],
            }),
          );
        }),
        list: () =>
          Effect.gen(function* () {
            // Enumerate every composite alarm in the account/region by
            // exhaustively paginating `describeAlarms` filtered to composite
            // alarms (items live under the `CompositeAlarms` field).
            const alarms = yield* cloudwatch.describeAlarms
              .pages({ AlarmTypes: ["CompositeAlarm"] })
              .pipe(
                Stream.runCollect,
                Effect.map((chunk) =>
                  Array.from(chunk).flatMap((page) =>
                    (page.CompositeAlarms ?? []).filter(
                      (
                        candidate,
                      ): candidate is cloudwatch.CompositeAlarm & {
                        AlarmName: string;
                        AlarmArn: string;
                      } => candidate.AlarmName != null && candidate.AlarmArn != null,
                    ),
                  ),
                ),
              );

            return yield* Effect.forEach(
              alarms,
              (compositeAlarm) =>
                readResourceTags(compositeAlarm.AlarmArn).pipe(
                  Effect.catchTag("ResourceNotFoundException", () => Effect.succeed({})),
                  Effect.map((tags) => ({
                    alarmName: compositeAlarm.AlarmName,
                    alarmArn: compositeAlarm.AlarmArn as AlarmArn,
                    stateValue: compositeAlarm.StateValue,
                    stateReason: compositeAlarm.StateReason,
                    compositeAlarm,
                    tags,
                  })),
                ),
              { concurrency: 10 },
            );
          }),
      };
    }),
  );