sailfork / t3code-github / .repos/ alchemy-effect/ packages/ cloudflare/ src/ Ruleset/ Ruleset.ts

import * as rulesets from "@distilled.cloud/cloudflare/rulesets";
import { deepEqual, isResolved } from "alchemy/Diff";
import { createPhysicalName } from "alchemy/PhysicalName";
import * as Provider from "alchemy/Provider";
import { Resource } from "alchemy/Resource";
import * as Data from "effect/Data";
import * as Effect from "effect/Effect";
import * as Stream from "effect/Stream";
import { CloudflareEnvironment } from "../CloudflareEnvironment.ts";
import type { Providers } from "../Providers.ts";
import type { Attributes, Zone } from "../Zone/index.ts";
import { listAllZones } from "../Zone/lookup.ts";

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

export type Phase = NonNullable<rulesets.CreateRulesetForZoneRequest["phase"]>;
export type Rule = NonNullable<rulesets.PutPhasForZoneRequest["rules"]>[number];
export type OutputRule = Omit<
  NonNullable<rulesets.GetPhasResponse["rules"]>[number],
  "lastUpdated" | "version"
>;

export type RulesetProps = {
  /**
   * Zone to apply the ruleset to. Pass a `Cloudflare.Zone.Zone`.
   */
  zone: Zone;
  /**
   * Ruleset phase entrypoint to own.
   */
  phase: Phase;
  /**
   * Rules to apply to the phase entrypoint.
   */
  rules: Rule[];
  /**
   * Human-readable name for the ruleset.
   * @default ${app}-${stage}-${id}
   */
  name?: string;
  /**
   * Description for the ruleset.
   */
  description?: string;
};

export type Kind = "managed" | "custom" | "root" | "zone" | (string & {});

export type Ruleset = Resource<
  "Cloudflare.Ruleset.Ruleset",
  RulesetProps,
  {
    /** The unique ID of the ruleset (Cloudflare `id`). */
    rulesetId: string;
    /**
     * Zone the ruleset phase entrypoint belongs to. Alchemy-flattened
     * identifier — not part of Cloudflare's phase-entrypoint response.
     */
    zoneId: string;
    /** The kind of the ruleset. */
    kind: Kind;
    /** The human-readable name of the ruleset. */
    name: string;
    /** The phase of the ruleset. */
    phase: Phase;
    /** An informative description of the ruleset. */
    description: string | undefined;
    /** The list of rules in the ruleset. */
    rules: OutputRule[];
    /** The timestamp of when the ruleset was last modified. */
    lastUpdated: string;
    /** The version of the ruleset. */
    version: string;
  },
  never,
  Providers
>;

/**
 * A Cloudflare Ruleset phase entrypoint for a zone.
 *
 * This resource owns the entire ruleset for a phase entrypoint. Rules managed
 * elsewhere in the same phase can be overwritten on deploy. Destroying it
 * removes only the rules it deployed; the entrypoint and any rules added
 * since stay in place.
 * ### WAF Rules
 * **Example:** Block probes in the custom firewall phase
 * ```typescript
 * const zone = yield* Cloudflare.Zone.Zone("MyZone", { name: "example.com" });
 * const waf = yield* Cloudflare.Ruleset.Ruleset("WafRules", {
 *   zone,
 *   phase: "http_request_firewall_custom",
 *   rules: [
 *     {
 *       description: "Block exploit probes",
 *       expression: `lower(http.request.uri.path) contains "/.env"`,
 *       action: "block",
 *     },
 *   ],
 * });
 * ```
 *
 * @resource
 * @product Rulesets
 * @category Rules & Configuration
 */
export const Ruleset = Resource<Ruleset>("Cloudflare.Ruleset.Ruleset", {
  aliases: ["Cloudflare.Ruleset"],
})({});

export const RulesetProvider = () =>
  Provider.succeed(Ruleset, {
    stables: ["zoneId", "phase"],
    diff: Effect.fn(function* ({ id, olds, news, output }) {
      if (!isResolved(news)) return undefined;
      const desiredZoneId = zoneIdOf(news.zone);

      // The desired zone id may still be an unresolved Output (e.g. the
      // zone is being created in the same deploy). Only make a zone-change
      // replacement decision once we have a concrete id.
      if (desiredZoneId !== undefined) {
        if (output?.zoneId && desiredZoneId !== output.zoneId) {
          return { action: "replace" } as const;
        }
        const oldZoneId = olds.zone ? zoneIdOf(olds.zone) : undefined;
        if (oldZoneId !== undefined && oldZoneId !== desiredZoneId) {
          return { action: "replace" } as const;
        }
      }
      if (olds.phase !== news.phase) {
        return { action: "replace" } as const;
      }

      const oldName = output?.name ?? (yield* createRulesetName(id, olds.name));
      // Auto-generated names are engine-owned: the deployed name stays
      // authoritative even if the generator would name this id differently
      // today. Only an explicit user-provided name can force a rename.
      const name = news.name ?? oldName;
      if (
        oldName !== name ||
        olds.description !== news.description ||
        !deepEqual(olds.rules, news.rules)
      ) {
        return { action: "update" } as const;
      }
    }),
    reconcile: Effect.fn(function* ({ id, news, output }) {
      const zoneId = output?.zoneId ?? zoneIdOf(news.zone);
      if (zoneId === undefined) {
        return yield* new RulesetInvalidProps({
          message: "Cloudflare Ruleset: zone id is not resolved",
        });
      }
      const name = yield* createRulesetName(id, news.name ?? output?.name);
      const ruleset = yield* rulesets.putPhasForZone({
        zoneId,
        rulesetPhase: news.phase,
        name,
        description: news.description,
        rules: news.rules,
      });
      return toRulesetAttributes(zoneId, ruleset);
    }),
    delete: Effect.fn(function* ({ olds, output }) {
      // Remove only the rules this resource deployed. The entrypoint is the
      // zone's shared WAF phase — rules added elsewhere must survive.
      const entrypoint = yield* rulesets
        .getPhasForZone({
          zoneId: output.zoneId,
          rulesetPhase: output.phase ?? olds.phase,
        })
        .pipe(Effect.catchTag("RulesetNotFound", () => Effect.undefined));
      if (entrypoint === undefined) return;
      const owned = new Set(output.rules.map((rule) => rule.id));
      yield* Effect.forEach(
        (entrypoint.rules ?? []).filter((rule) => rule.id != null && owned.has(rule.id)),
        (rule) =>
          rulesets.deleteRuleForZone({
            zoneId: output.zoneId,
            rulesetId: entrypoint.id,
            ruleId: rule.id!,
          }),
        { discard: true },
      );
    }),
    read: Effect.fn(function* ({ olds, output }) {
      const zoneId = output?.zoneId ?? zoneIdOf(olds.zone);
      if (zoneId === undefined) return undefined;
      return yield* rulesets
        .getPhasForZone({
          zoneId,
          rulesetPhase: output?.phase ?? olds.phase,
        })
        .pipe(
          Effect.map((ruleset) => toRulesetAttributes(zoneId, ruleset)),
          Effect.catchTag("RulesetNotFound", () => Effect.undefined),
        );
    }),
    // A `Ruleset` is a zone phase entrypoint (kind: "zone"). There is no
    // account-wide enumeration for entrypoints, so fan out over every zone
    // via `listAllZones`, list that zone's rulesets, keep the entrypoints,
    // and hydrate each into the full Attributes shape (the list response
    // omits `rules`) via `getPhasForZone`.
    list: Effect.fn(function* () {
      const { accountId } = yield* yield* CloudflareEnvironment;
      const zones = yield* listAllZones(accountId);
      const rows = yield* Effect.forEach(
        zones,
        (zone) =>
          rulesets.listRulesetsForZone.pages({ zoneId: zone.id }).pipe(
            Stream.runCollect,
            Effect.map((chunk) =>
              Array.from(chunk).flatMap((page) =>
                (page.result ?? []).filter((r) => r.kind === "zone"),
              ),
            ),
            Effect.flatMap((entrypoints) =>
              Effect.forEach(
                entrypoints,
                (entry) =>
                  rulesets
                    .getPhasForZone({
                      zoneId: zone.id,
                      rulesetPhase: entry.phase,
                    })
                    .pipe(
                      Effect.map((ruleset) => toRulesetAttributes(zone.id, ruleset)),
                      // Per-item not-found / plan-gated entrypoints are
                      // skipped rather than failing the whole enumeration.
                      Effect.catchTag(["RulesetNotFound", "Forbidden"], () => Effect.undefined),
                    ),
                { concurrency: 10 },
              ),
            ),
            Effect.map((items) =>
              items.filter(
                (item): item is Ruleset["Attributes"] =>
                  // An entrypoint with zero rules is inert — it's what other
                  // owners (e.g. Worker redirect cleanup) leave behind after
                  // removing their rules. Don't surface it as a resource.
                  item !== undefined && item.rules.length > 0,
              ),
            ),
            // Plan-gated / partially-provisioned zones reject the route.
            Effect.catchTag("InvalidRoute", () => Effect.succeed([])),
          ),
        { concurrency: 10 },
      );
      return rows.flat();
    }),
  });

const createRulesetName = (id: string, name: string | undefined) =>
  Effect.gen(function* () {
    return name ?? (yield* createPhysicalName({ id }));
  });

export const toRulesetAttributes = (
  zoneId: string,
  ruleset: rulesets.GetPhasResponse | rulesets.PutPhasResponse,
): Ruleset["Attributes"] => ({
  rulesetId: ruleset.id,
  zoneId,
  kind: ruleset.kind,
  name: ruleset.name,
  phase: ruleset.phase,
  description: ruleset.description ?? undefined,
  rules: (ruleset.rules ?? []).map(
    ({ lastUpdated: _lastUpdated, version: _version, ...rule }) => rule,
  ),
  lastUpdated: ruleset.lastUpdated,
  version: ruleset.version,
});

// A `Zone` prop is resolved to its attributes before a lifecycle op runs, so
// `zone.zoneId` is normally a plain string even though the `Zone` resource
// type statically exposes it as an `Output`. During `diff` (plan time) the
// zone can still be unresolved — e.g. when it's being created in the same
// deploy — in which case `zoneId` is not yet a string. Callers must treat a
// non-string result as "not resolved yet". May also receive `undefined`:
// an Output-valued `zone` doesn't survive a `creating`-state round-trip
// (it deserializes as `undefined`), and recovery paths hand those props
// back as `olds`.
const zoneIdOf = (zone: Zone | undefined): string | undefined => {
  const zoneId = (zone as unknown as Partial<Attributes> | undefined)?.zoneId;
  return typeof zoneId === "string" ? zoneId : undefined;
};