sailfork / t3code-github / .repos/ alchemy-effect/ packages/ integration-tests/ test/ Cloudflare/ Vectorize/ SearchIndexBinding.test.ts

import * as Cloudflare from "@alchemy.run/cloudflare";
import { CloudflareEnvironment } from "@alchemy.run/cloudflare/CloudflareEnvironment";
import { CloudflareApiLive } from "@alchemy.run/cloudflare/Providers";
import { expect } from "@alchemy.run/test";
import * as Test from "@alchemy.run/test/Alchemy";
import * as Effect from "effect/Effect";
import { HttpClientResponse } from "effect/http";
import * as HttpClient from "effect/http/HttpClient";
import { MinimumLogLevel } from "effect/References";
import * as Schedule from "effect/Schedule";
import Stack from "./fixtures/stack.ts";
import { waitForMetadata, waitForVectorize } from "./Readiness.ts";

/**
 * End-to-end test of the `Cloudflare.Vectorize` native worker binding against a
 * real Cloudflare Worker + Vectorize index, covering BOTH invocation styles:
 *
 *  - effect-worker: `yield* Cloudflare.Vectorize.SearchIndex(index)` inside a
 *    `Cloudflare.Worker` init, binding provided via `SearchIndexBinding`.
 *  - async-worker:  the index declared on the Worker `env`, used as the native
 *    runtime `Vectorize` binding from a plain `async fetch`.
 *
 * Both workers share ONE index (vectors are id-prefixed by style so they stay
 * independent) and are driven by a single `exercise(label, baseUrl)` flow that
 * upserts → describes → queries → filtered-queries → getByIds. Vectorize
 * mutations are eventually consistent, so reads are polled until visible.
 */
const { test, beforeAll, afterAll, deploy, destroy } = Test.make({
  providers: Cloudflare.providers(),
});

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

// Fresh workers.dev URLs take a few seconds to start serving 200s, and edge
// propagation can still transiently 404/500 individual route hits after the
// script is resolvable. Bound both the retry count and the entire request.
const readinessRetry = {
  schedule: Schedule.max([Schedule.spaced("1 second"), Schedule.recurs(8)]),
} as const;

const getJson = (url: string) =>
  HttpClient.get(url).pipe(
    Effect.flatMap(HttpClientResponse.filterStatusOk),
    Effect.flatMap((res) => res.json),
    Effect.retry(readinessRetry),
    Effect.timeout("15 seconds"),
  );

const postJson = (url: string) =>
  HttpClient.post(url).pipe(
    Effect.flatMap(HttpClientResponse.filterStatusOk),
    Effect.flatMap((res) => res.json),
    Effect.retry(readinessRetry),
    Effect.timeout("15 seconds"),
  );

/** Drives the client surface using this worker's vector ID prefix. */
const exercise = (label: string, baseUrl: string) =>
  Effect.gen(function* () {
    // Gate on /health first to prove the script is resolvable.
    yield* HttpClient.get(`${baseUrl}/health`).pipe(
      Effect.flatMap(HttpClientResponse.filterStatusOk),
      Effect.timeout("5 seconds"),
      Effect.retry({ schedule: Schedule.max([Schedule.spaced("1 second"), Schedule.recurs(8)]) }),
      Effect.timeout("15 seconds"),
    );

    const upsertRes = yield* postJson(`${baseUrl}/upsert`);
    expect(upsertRes).toMatchObject({ mutationId: expect.any(String) });

    const describeRes = yield* getJson(`${baseUrl}/describe`);
    expect(describeRes).toMatchObject({ dimensions: 32 });

    // Observe all read surfaces under one readiness budget. Both workers
    // write to the shared index, so readiness is judged by this worker's
    // own vectors rather than the index-wide processed mutation.
    const { queryBody, getRes, filteredBody } = yield* waitForVectorize({
      description: `[${label}] upserted vectors visible to query, ID lookup and metadata filtering`,
      effect: Effect.all(
        {
          queryBody: getJson(`${baseUrl}/query`).pipe(
            Effect.map((body) => body as { count: number; ids: string[] }),
          ),
          getRes: getJson(`${baseUrl}/get`).pipe(Effect.map((body) => body as { ids: string[] })),
          filteredBody: getJson(`${baseUrl}/query-filtered`).pipe(
            Effect.map((body) => body as { count: number; ids: string[]; kinds: string[] }),
          ),
        },
        { concurrency: "unbounded" },
      ),
      predicate: ({ queryBody, getRes, filteredBody }) =>
        queryBody.count >= 3 &&
        getRes.ids.length === 2 &&
        filteredBody.ids.length === 1 &&
        filteredBody.kinds.length === 1,
    });
    expect(queryBody.count).toBeGreaterThanOrEqual(3);
    expect(queryBody.ids[0]).toBe(`${label}-a`);
    expect(getRes).toEqual({ ids: [`${label}-a`, `${label}-b`] });
    expect(filteredBody.ids).toEqual([`${label}-b`]);
    expect(filteredBody.kinds).toEqual(["second"]);
  }).pipe(logLevel);

const stack = beforeAll(
  Effect.gen(function* () {
    yield* destroy(Stack);
    const deployed = yield* deploy(Stack);
    const { accountId } = yield* yield* CloudflareEnvironment;
    yield* waitForMetadata(accountId, deployed.indexName, [
      { propertyName: "kind", indexType: "string" },
    ]);
    return deployed;
  }).pipe(Effect.provide(CloudflareApiLive())),
  { timeout: 210_000 },
);
afterAll.skipIf(!!process.env.NO_DESTROY)(destroy(Stack));

test(
  "effect-worker: SearchIndex(index) exercises the client surface",
  Effect.gen(function* () {
    const { effectWorkerUrl } = yield* stack;
    yield* exercise("effect", effectWorkerUrl);
  }),
  {
    tags: [
      "provider:cloudflare",
      "provider:cloudflare:vectorize",
      "provider:cloudflare:worker",
      "live",
    ],
    timeout: 210_000,
  },
);

test(
  "async-worker: env Vectorize binding exercises the client surface",
  Effect.gen(function* () {
    const { asyncWorkerUrl } = yield* stack;
    yield* exercise("async", asyncWorkerUrl);
  }),
  {
    tags: [
      "provider:cloudflare",
      "provider:cloudflare:vectorize",
      "provider:cloudflare:worker",
      "live",
    ],
    timeout: 210_000,
  },
);