sailfork / t3code-github / .repos/ alchemy-effect/ packages/ integration-tests/ test/ Railway/ Bucket.test.ts

import * as Railway from "@alchemy.run/railway";
import { projectBuckets } from "@alchemy.run/railway/GraphQL";
import { expect } from "@alchemy.run/test";
import * as Test from "@alchemy.run/test/Alchemy";
import { fromCredentials } from "@distilled.cloud/aws/Credentials";
import * as AwsEndpoint from "@distilled.cloud/aws/Endpoint";
import type { RegionName } from "@distilled.cloud/aws/Region";
import * as S3 from "@distilled.cloud/aws/s3";
import { Query } from "@distilled.cloud/core/query";
import { Railway as RailwayApi } from "@distilled.cloud/railway";
import * as Provider from "alchemy/Provider";
import * as Effect from "effect/Effect";
import * as Layer from "effect/Layer";
import * as Redacted from "effect/Redacted";
import { MinimumLogLevel } from "effect/References";
import * as Schedule from "effect/Schedule";
import * as Stream from "effect/Stream";
import { suitePartition } from "./suiteProject.ts";

const { test } = Test.make({ providers: Railway.providers() });

const logLevel = Effect.provideService(MinimumLogLevel, process.env.DEBUG ? "Debug" : "Info");

const OBJECT_KEY = "alchemy-marker.txt";
const OBJECT_BODY = "hello-from-railway";

const readBucketCredentials = Query.fn(
  (bucketId: string, environmentId: string, projectId: string) =>
    RailwayApi.bucketS3Credentials({ bucketId, environmentId, projectId }).pipe(
      Query.map((creds) => ({
        bucketName: creds.bucketName,
        endpoint: creds.endpoint,
        accessKeyId: creds.accessKeyId,
        secretAccessKey: creds.secretAccessKey,
        region: creds.region,
      })),
    ),
);

const readEnvironmentConfig = Query.fn((id: string, projectId: string) => ({
  config: RailwayApi.environment({ id, projectId }).config,
}));

const listProjectBuckets = (projectId: string) =>
  projectBuckets(projectId, (bucket) => ({
    id: bucket.id,
    name: bucket.name,
    projectId: bucket.projectId,
  })).pipe(Effect.catchTag("RailwayNotFound", () => Effect.succeed([])));

const findBucket = (projectId: string, bucketId: string, name: string) =>
  listProjectBuckets(projectId).pipe(
    Effect.map(
      (buckets) =>
        buckets.find((bucket) => bucket.id === bucketId) ??
        buckets.find((bucket) => bucket.name === name),
    ),
  );

const firstCredentials = (bucketId: string, environmentId: string, projectId: string) =>
  readBucketCredentials(bucketId, environmentId, projectId).pipe(
    Effect.flatMap((items) => {
      const first = items[0];
      return first !== undefined
        ? Effect.succeed(first)
        : Effect.fail(new Error("missing bucket credentials"));
    }),
    Effect.retry({ schedule: Schedule.spaced("2 seconds"), times: 8 }),
  );

const waitUntilBucketGone = (environmentId: string, projectId: string, bucketId: string) =>
  readEnvironmentConfig(environmentId, projectId).pipe(
    Effect.map((env) => {
      const buckets =
        env.config !== null && typeof env.config === "object" && !Array.isArray(env.config)
          ? (env.config as { buckets?: Record<string, { isDeleted?: boolean | null } | null> })
              .buckets
          : undefined;
      const row = buckets?.[bucketId];
      return row == null || row.isDeleted === true ? ("gone" as const) : ("found" as const);
    }),
    Effect.catchTag("RailwayNotFound", () => Effect.succeed("gone" as const)),
    Effect.repeat({
      schedule: Schedule.spaced("2 seconds"),
      until: (status) => status === "gone",
      times: 10,
    }),
  );

const withBucketS3 = <A, E, R>(
  creds: {
    accessKeyId: string;
    secretAccessKey: Redacted.Redacted<string>;
    endpoint: string;
    region: string;
  },
  operation: Effect.Effect<A, E, R>,
) =>
  operation.pipe(
    Effect.provide(
      Layer.mergeAll(
        fromCredentials(
          {
            accessKeyId: Redacted.make(creds.accessKeyId),
            secretAccessKey: creds.secretAccessKey,
          },
          creds.region as RegionName,
        ),
        AwsEndpoint.of(creds.endpoint),
      ),
    ),
  );

test.provider(
  "create, update, list, put/get/delete objects, and delete a bucket",
  (stack) =>
    Effect.gen(function* () {
      yield* stack.destroy();

      const created = yield* stack.deploy(
        Effect.gen(function* () {
          const { project, environment } = yield* suitePartition;
          const bucket = yield* Railway.Bucket("Data", { project, environment });
          return { project, environment, bucket };
        }),
      );

      expect(created.bucket.bucketId).toEqual(expect.any(String));
      expect(created.bucket.bucketId.length).toBeGreaterThan(0);
      expect(created.bucket.projectId).toEqual(created.project.projectId);
      expect(created.bucket.environmentId).toEqual(created.environment.environmentId);
      expect(created.bucket.name).toEqual(expect.any(String));
      expect(created.bucket.name.length).toBeGreaterThan(0);
      expect(created.bucket.name.length).toBeLessThanOrEqual(32);
      expect(created.bucket.name).toMatch(/^[a-z][a-z0-9-]*$/);
      expect(created.bucket.region).toEqual("sjc");
      expect(created.bucket.s3BucketName).toEqual(expect.any(String));
      expect((created.bucket.s3BucketName ?? "").length).toBeGreaterThan(0);
      expect(created.bucket.endpoint).toEqual(expect.any(String));
      expect(created.bucket.createdAt).toEqual(expect.any(String));

      const fetched = yield* findBucket(
        created.project.projectId,
        created.bucket.bucketId,
        created.bucket.name,
      );
      expect(fetched).toBeDefined();
      expect(fetched?.id).toEqual(created.bucket.bucketId);
      expect(fetched?.name).toEqual(created.bucket.name);
      expect(fetched?.projectId).toEqual(created.project.projectId);

      const provider = yield* Provider.findProvider(Railway.Bucket);
      const listed = yield* provider.list();
      const found = listed.find((bucket) => bucket.bucketId === created.bucket.bucketId);
      expect(found).toBeDefined();
      expect(found?.name).toEqual(created.bucket.name);
      expect(found?.projectId).toEqual(created.project.projectId);
      expect(found?.environmentId).toEqual(created.bucket.environmentId);

      const creds = yield* firstCredentials(
        created.bucket.bucketId,
        created.bucket.environmentId,
        created.project.projectId,
      );
      expect(creds.bucketName.length).toBeGreaterThan(0);
      expect(creds.endpoint.length).toBeGreaterThan(0);
      expect(creds.accessKeyId.length).toBeGreaterThan(0);
      expect(Redacted.value(creds.secretAccessKey).length).toBeGreaterThan(0);

      yield* withBucketS3(
        creds,
        S3.putObject({
          Bucket: creds.bucketName,
          Key: OBJECT_KEY,
          Body: OBJECT_BODY,
          ContentType: "text/plain",
        }),
      );

      const got = yield* withBucketS3(
        creds,
        S3.getObject({ Bucket: creds.bucketName, Key: OBJECT_KEY }),
      );
      const text =
        got.Body === undefined ? "" : yield* Stream.mkString(Stream.decodeText(got.Body));
      expect(text).toEqual(OBJECT_BODY);

      const listedObjects = yield* withBucketS3(
        creds,
        S3.listObjectsV2({ Bucket: creds.bucketName, Prefix: OBJECT_KEY }),
      );
      expect((listedObjects.Contents ?? []).some((item) => item.Key === OBJECT_KEY)).toEqual(true);

      yield* withBucketS3(creds, S3.deleteObject({ Bucket: creds.bucketName, Key: OBJECT_KEY }));

      const nextName =
        created.bucket.name.slice(0, -1) + (created.bucket.name.endsWith("z") ? "y" : "z");

      const updated = yield* stack.deploy(
        Effect.gen(function* () {
          const { project, environment } = yield* suitePartition;
          const bucket = yield* Railway.Bucket("Data", { project, environment, name: nextName });
          return { project, environment, bucket };
        }),
      );

      expect(updated.bucket.bucketId).toEqual(created.bucket.bucketId);
      expect(updated.bucket.name).toEqual(nextName);
      expect(updated.bucket.projectId).toEqual(created.project.projectId);
      expect(updated.bucket.environmentId).toEqual(created.bucket.environmentId);

      const fetchedUpdate = yield* findBucket(
        updated.project.projectId,
        updated.bucket.bucketId,
        updated.bucket.name,
      );
      expect(fetchedUpdate).toBeDefined();
      expect(fetchedUpdate?.id).toEqual(created.bucket.bucketId);
      expect(fetchedUpdate?.name).toEqual(nextName);

      yield* stack.destroy();

      const gone = yield* waitUntilBucketGone(
        created.bucket.environmentId,
        created.project.projectId,
        created.bucket.bucketId,
      );
      expect(gone).toEqual("gone");
    }).pipe(logLevel),
  {
    tags: [
      "provider:aws",
      "provider:aws:s3",
      "provider:railway",
      "provider:railway:bucket",
      "provider:railway:project",
      "provider:railway:projectenvironment",
      "live",
    ],
    timeout: 120_000,
  },
);