sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ IAM/ InstanceProfile.ts

import * as iam from "@distilled.cloud/aws/iam";
import { isResolved } from "alchemy/Diff";
import type { Input } from "alchemy/Input";
import { createPhysicalName } from "alchemy/PhysicalName";
import * as Provider from "alchemy/Provider";
import { Resource } from "alchemy/Resource";
import { createInternalTags, createTagsList, diffTags, hasTags } from "alchemy/Tags";
import * as Data from "effect/Data";
import * as Effect from "effect/Effect";
import * as Stream from "effect/Stream";
import type { Providers } from "../Providers.ts";
import { toTagRecord } from "./common.ts";

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

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

export interface InstanceProfileProps {
  /**
   * Name of the instance profile. If omitted, a deterministic name is generated.
   */
  instanceProfileName?: string;
  /**
   * Optional IAM path prefix.
   * @default "/"
   */
  path?: string;
  /**
   * Optional role attached to the instance profile.
   */
  roleName?: Input<string>;
  /**
   * User-defined tags to apply to the instance profile.
   */
  tags?: Record<string, string>;
}

export interface InstanceProfile extends Resource<
  "AWS.IAM.InstanceProfile",
  InstanceProfileProps,
  {
    /** The ARN of the instance profile. */
    instanceProfileArn: string;
    /** The name of the instance profile. */
    instanceProfileName: string;
    /** The stable unique ID of the instance profile. */
    instanceProfileId: string | undefined;
    /** The IAM path of the instance profile. */
    path: string | undefined;
    /** The role attached to the instance profile, if any. */
    roleName: string | undefined;
    /** The tags applied to the instance profile. */
    tags: Record<string, string>;
  },
  never,
  Providers
> {}

/**
 * An IAM instance profile that can present a role to EC2 instances.
 *
 * `InstanceProfile` bridges IAM roles into EC2 so compute instances can assume
 * the attached role through the instance metadata service.
 * ### Attaching Roles to EC2
 * **Example:** Create an Instance Profile
 * ```typescript
 * const role = yield* Role("InstanceRole", {
 *   assumeRolePolicyDocument: {
 *     Version: "2012-10-17",
 *     Statement: [{
 *       Effect: "Allow",
 *       Principal: { Service: "ec2.amazonaws.com" },
 *       Action: ["sts:AssumeRole"],
 *     }],
 *   },
 * });
 *
 * const profile = yield* InstanceProfile("WebProfile", {
 *   roleName: role.roleName,
 * });
 * ```
 *
 * @resource
 */
export const InstanceProfile = Resource<InstanceProfile>("AWS.IAM.InstanceProfile");

export const InstanceProfileProvider = () =>
  Provider.effect(
    InstanceProfile,
    Effect.gen(function* () {
      const toName = (id: string, props: InstanceProfileProps) =>
        props.instanceProfileName
          ? Effect.succeed(props.instanceProfileName)
          : createPhysicalName({ id, maxLength: 128 });

      const readInstanceProfile = Effect.fn(function* (name: string) {
        const response = yield* iam
          .getInstanceProfile({
            InstanceProfileName: name,
          })
          .pipe(Effect.catchTag("NoSuchEntityException", () => Effect.undefined));
        return response?.InstanceProfile;
      });

      const syncRole = Effect.fn(function* ({
        profileName,
        currentRoleName,
        nextRoleName,
      }: {
        profileName: string;
        currentRoleName: string | undefined;
        nextRoleName: string | undefined;
      }) {
        if (currentRoleName && currentRoleName !== nextRoleName) {
          yield* iam
            .removeRoleFromInstanceProfile({
              InstanceProfileName: profileName,
              RoleName: currentRoleName,
            })
            .pipe(Effect.catchTag("NoSuchEntityException", () => Effect.void));
        }
        if (nextRoleName && currentRoleName !== nextRoleName) {
          yield* iam.addRoleToInstanceProfile({
            InstanceProfileName: profileName,
            RoleName: nextRoleName,
          });
        }
      });

      return {
        stables: ["instanceProfileArn", "instanceProfileName", "instanceProfileId"],
        diff: Effect.fn(function* ({ id, olds, news }) {
          if (!isResolved(news)) return;
          if (
            (yield* toName(id, olds ?? ({} as InstanceProfileProps))) !== (yield* toName(id, news))
          ) {
            return { action: "replace" } as const;
          }
          if ((olds?.path ?? "/") !== (news.path ?? "/")) {
            return { action: "replace" } as const;
          }
        }),
        // IAM is global; `listInstanceProfiles` enumerates every instance
        // profile in the account. Paginate exhaustively and map each item to
        // the same Attributes shape `read` produces.
        list: () =>
          iam.listInstanceProfiles.pages({}).pipe(
            Stream.runCollect,
            Effect.map((chunk) =>
              Array.from(chunk).flatMap((page) =>
                (page.InstanceProfiles ?? []).map((profile) => ({
                  instanceProfileArn: profile.Arn,
                  instanceProfileName: profile.InstanceProfileName,
                  instanceProfileId: profile.InstanceProfileId as string | undefined,
                  path: profile.Path as string | undefined,
                  roleName: profile.Roles?.[0]?.RoleName,
                  tags: toTagRecord(profile.Tags),
                })),
              ),
            ),
          ),
        read: Effect.fn(function* ({ id, olds, output }) {
          const name =
            output?.instanceProfileName ??
            (yield* toName(id, olds ?? ({} as InstanceProfileProps)));
          const profile = yield* readInstanceProfile(name);
          if (!profile?.Arn || !profile.InstanceProfileName) {
            return undefined;
          }
          return {
            instanceProfileArn: profile.Arn,
            instanceProfileName: profile.InstanceProfileName,
            instanceProfileId: profile.InstanceProfileId,
            path: profile.Path,
            roleName: profile.Roles?.[0]?.RoleName,
            tags: toTagRecord(profile.Tags),
          };
        }),
        reconcile: Effect.fn(function* ({ id, news, output, session }) {
          const name = output?.instanceProfileName ?? (yield* toName(id, news));
          const desiredTags = {
            ...(yield* createInternalTags(id)),
            ...news.tags,
          };

          // Observe — fetch the live instance profile (or absence).
          let profile = yield* readInstanceProfile(name);

          // Ensure — create the profile when it is missing. Tolerate races
          // and surface a clear error when an unrelated foreign profile
          // already owns the name.
          if (!profile?.Arn) {
            yield* iam
              .createInstanceProfile({
                InstanceProfileName: name,
                Path: news.path,
                Tags: createTagsList(desiredTags),
              })
              .pipe(
                Effect.catchTag("EntityAlreadyExistsException", () =>
                  Effect.gen(function* () {
                    const existing = yield* readInstanceProfile(name);
                    if (!existing?.Arn) {
                      return yield* new InstanceProfileConflict({
                        message: `Instance profile '${name}' already exists but could not be described`,
                      });
                    }
                    if (!hasTags(desiredTags, existing.Tags)) {
                      return yield* new InstanceProfileConflict({
                        message: `Instance profile '${name}' already exists and is not managed by alchemy`,
                      });
                    }
                  }),
                ),
              );
            profile = yield* readInstanceProfile(name);
            if (!profile?.Arn || !profile.InstanceProfileName) {
              return yield* new InstanceProfileUnexpectedResponse({
                message: `Instance profile '${name}' was not readable after create`,
              });
            }
          }

          // Sync role attachment — diff the observed role on the profile
          // against the desired role and only swap when they differ.
          const observedRoleName = profile.Roles?.[0]?.RoleName;
          const desiredRoleName = news.roleName as string | undefined;
          yield* syncRole({
            profileName: name,
            currentRoleName: observedRoleName,
            nextRoleName: desiredRoleName,
          });

          // Sync tags — use the cloud's actual tags as the baseline so
          // adoption / out-of-band tag changes converge correctly.
          const observedTags = toTagRecord(profile.Tags);
          const { removed, upsert } = diffTags(observedTags, desiredTags);
          if (upsert.length > 0) {
            yield* iam.tagInstanceProfile({
              InstanceProfileName: name,
              Tags: upsert,
            });
          }
          if (removed.length > 0) {
            yield* iam.untagInstanceProfile({
              InstanceProfileName: name,
              TagKeys: removed,
            });
          }

          // Re-read for fresh attributes (the profile's `Roles` array
          // changes after `syncRole`).
          const fresh = yield* readInstanceProfile(name);
          if (!fresh?.Arn || !fresh.InstanceProfileName) {
            return yield* new InstanceProfileUnexpectedResponse({
              message: `Instance profile '${name}' was not readable after sync`,
            });
          }

          yield* session.note(fresh.Arn);
          return {
            instanceProfileArn: fresh.Arn,
            instanceProfileName: fresh.InstanceProfileName,
            instanceProfileId: fresh.InstanceProfileId,
            path: fresh.Path,
            roleName: fresh.Roles?.[0]?.RoleName,
            tags: desiredTags,
          };
        }),
        delete: Effect.fn(function* ({ output }) {
          const profile = yield* readInstanceProfile(output.instanceProfileName);
          for (const role of profile?.Roles ?? []) {
            if (role.RoleName) {
              yield* iam
                .removeRoleFromInstanceProfile({
                  InstanceProfileName: output.instanceProfileName,
                  RoleName: role.RoleName,
                })
                .pipe(Effect.catchTag("NoSuchEntityException", () => Effect.void));
            }
          }
          yield* iam
            .deleteInstanceProfile({
              InstanceProfileName: output.instanceProfileName,
            })
            .pipe(Effect.catchTag("NoSuchEntityException", () => Effect.void));
        }),
      };
    }),
  );