t3-code-android-nightly/.repos/effect-smol/packages/effect/test/Migrator.test.ts

import { assert, describe, it } from "@effect/vitest"
import { Effect, FileSystem, Layer, Path, PlatformError } from "effect"
import * as Migrator from "effect/sql/Migrator"

const migrationNames = (
  migrations: ReadonlyArray<Migrator.ResolvedMigration>
): ReadonlyArray<readonly [id: number, name: string]> => migrations.map(([id, name]) => [id, name] as const)

describe("Migrator", () => {
  describe("loaders", () => {
    it.effect("fromGlob accepts js, ts, mjs, and mts files", () =>
      Effect.gen(function*() {
        const migrations = yield* Migrator.fromGlob({
          "./migrations/0004_fourth.mts": () => Promise.resolve(Effect.void),
          "./migrations/0002_second.ts": () => Promise.resolve(Effect.void),
          "./migrations/0003_third.mjs": () => Promise.resolve(Effect.void),
          "./migrations/0001_first.js": () => Promise.resolve(Effect.void),
          "./migrations/0005_ignored.cjs": () => Promise.resolve(Effect.void)
        })

        assert.deepStrictEqual(migrationNames(migrations), [
          [1, "first"],
          [2, "second"],
          [3, "third"],
          [4, "fourth"]
        ])
      }))

    it.effect("fromBabelGlob accepts Js, Ts, Mjs, and Mts suffixes", () =>
      Effect.gen(function*() {
        const migrations = yield* Migrator.fromBabelGlob({
          _0004_fourthMts: Effect.void,
          _0002_secondTs: Effect.void,
          _0003_thirdMjs: Effect.void,
          _0001_firstJs: Effect.void
        })

        assert.deepStrictEqual(migrationNames(migrations), [
          [1, "first"],
          [2, "second"],
          [3, "third"],
          [4, "fourth"]
        ])
      }))

    it.effect("fromFileSystem accepts js, ts, mjs, and mts files", () =>
      Effect.gen(function*() {
        const migrations = yield* Migrator.fromFileSystem("/migrations").pipe(
          Effect.provide(FileSystem.layerNoop({
            readDirectory: () =>
              Effect.succeed([
                "0004_fourth.mts",
                "0002_second.ts",
                "0003_third.mjs",
                "0001_first.js",
                "0005_ignored.cjs"
              ])
          })),
          Effect.provide(Path.layer)
        )

        assert.deepStrictEqual(migrationNames(migrations), [
          [1, "first"],
          [2, "second"],
          [3, "third"],
          [4, "fourth"]
        ])
      }))

    it.effect("fromFileSystem imports migrations through the file URL the platform resolves", () =>
      Effect.gen(function*() {
        const posix = yield* Effect.provide(Path.Path, Path.layer)
        const migrationUrl = new URL("./fixtures/migrator/0001_first.js", import.meta.url)
        let resolvedPath: string | undefined
        // stand in for a Windows platform layer, which core has no implementation of
        const windowsLike = Layer.succeed(Path.Path)({
          ...posix,
          join: (...segments: ReadonlyArray<string>) => segments.join("\\"),
          toFileUrl: (path: string) => {
            resolvedPath = path
            return Effect.succeed(migrationUrl)
          }
        })

        const migrations = yield* Migrator.fromFileSystem("C:\\migrations").pipe(
          Effect.provide(FileSystem.layerNoop({
            readDirectory: () => Effect.succeed(["0001_first.js"])
          })),
          Effect.provide(windowsLike)
        )

        // the loader is lazy, and `ResolvedMigration` declares a `SqlClient`
        // requirement this loader never uses
        const load = migrations[0]![2] as Effect.Effect<unknown, unknown>
        const imported = yield* load

        assert.strictEqual(resolvedPath, "C:\\migrations\\0001_first.js")
        assert.strictEqual((imported as { readonly marker: string }).marker, "loaded")
      }))

    it.effect("fromFileSystem surfaces file URL failures as import errors", () =>
      Effect.gen(function*() {
        const posix = yield* Effect.provide(Path.Path, Path.layer)
        const failingPath = Layer.succeed(Path.Path)({
          ...posix,
          toFileUrl: () => Effect.fail(new PlatformError.BadArgument({ module: "Path", method: "toFileUrl" }))
        })

        const migrations = yield* Migrator.fromFileSystem("/migrations").pipe(
          Effect.provide(FileSystem.layerNoop({
            readDirectory: () => Effect.succeed(["0001_first.js"])
          })),
          Effect.provide(failingPath)
        )

        const load = migrations[0]![2] as Effect.Effect<unknown, unknown>
        const outcome = yield* load.pipe(
          Effect.catchDefect((defect) => Effect.succeed(`defect: ${defect}`)),
          Effect.orElseSucceed(() => "no defect")
        )

        // a typed failure here would escape `make`'s MigrationError | SqlError channel
        assert.include(outcome, "defect:")
      }))
  })
})