|
| 1 | +import { NodeContext } from "@effect/platform-node" |
| 2 | +import * as FileSystem from "@effect/platform/FileSystem" |
| 3 | +import * as Path from "@effect/platform/Path" |
| 4 | +import { describe, expect, it } from "@effect/vitest" |
| 5 | +import { Effect } from "effect" |
| 6 | +import * as fc from "fast-check" |
| 7 | + |
| 8 | +import { |
| 9 | + controllerBuildSkillerEnvKey, |
| 10 | + controllerGpuModeEnvKey, |
| 11 | + ensureSkillerSubmoduleInitialized, |
| 12 | + prepareControllerRevision |
| 13 | +} from "../../src/docker-git/controller-compose.js" |
| 14 | +import { controllerRevisionEnvKey } from "../../src/docker-git/controller-revision.js" |
| 15 | +import type { TestCommandResult } from "./fixtures/command-executor.js" |
| 16 | +import { commandExecutorLayer, emptyCommandResult } from "./fixtures/command-executor.js" |
| 17 | + |
| 18 | +const expectedSkillerSubmoduleCommand = |
| 19 | + "git submodule update --init --checkout third_party/skiller-desktop-skills-manager" |
| 20 | +const skillerPackageRelativePath = "third_party/skiller-desktop-skills-manager/package.json" |
| 21 | + |
| 22 | +const recordedCommandExecutorLayer = ( |
| 23 | + startedCommands: Array<string>, |
| 24 | + result: TestCommandResult |
| 25 | +) => |
| 26 | + commandExecutorLayer((command) => { |
| 27 | + startedCommands.push([command.command, ...command.args].join(" ")) |
| 28 | + return result |
| 29 | + }) |
| 30 | + |
| 31 | +const temporaryControllerRoot = Effect.gen(function*(_) { |
| 32 | + const fs = yield* _(FileSystem.FileSystem) |
| 33 | + return yield* _(fs.makeTempDirectoryScoped({ prefix: "docker-git-controller-compose-" })) |
| 34 | +}) |
| 35 | + |
| 36 | +const writeRootFile = ( |
| 37 | + rootDir: string, |
| 38 | + relativePath: string, |
| 39 | + contents: string |
| 40 | +) => |
| 41 | + Effect.all({ |
| 42 | + fs: FileSystem.FileSystem, |
| 43 | + path: Path.Path |
| 44 | + }).pipe( |
| 45 | + Effect.flatMap(({ fs, path }) => { |
| 46 | + const absolutePath = path.join(rootDir, relativePath) |
| 47 | + return fs.makeDirectory(path.dirname(absolutePath), { recursive: true }).pipe( |
| 48 | + Effect.zipRight(fs.writeFileString(absolutePath, contents)) |
| 49 | + ) |
| 50 | + }) |
| 51 | + ) |
| 52 | + |
| 53 | +const writeMinimalCompose = (rootDir: string) => |
| 54 | + writeRootFile(rootDir, "docker-compose.yml", "services:\n api:\n image: docker-git-api\n") |
| 55 | + |
| 56 | +const writeSkillerPackage = (rootDir: string) => |
| 57 | + writeRootFile(rootDir, skillerPackageRelativePath, "{\"name\":\"skiller-desktop-skills-manager\"}\n") |
| 58 | + |
| 59 | +const withWorkingDirectory = (nextCwd: string) => |
| 60 | + Effect.acquireRelease( |
| 61 | + Effect.sync(() => { |
| 62 | + const previousCwd = process.cwd() |
| 63 | + process.chdir(nextCwd) |
| 64 | + return previousCwd |
| 65 | + }), |
| 66 | + (previousCwd) => |
| 67 | + Effect.sync(() => { |
| 68 | + process.chdir(previousCwd) |
| 69 | + }) |
| 70 | + ) |
| 71 | + |
| 72 | +const setOptionalEnv = (key: string, value: string | undefined): void => { |
| 73 | + if (value === undefined) { |
| 74 | + Reflect.deleteProperty(process.env, key) |
| 75 | + return |
| 76 | + } |
| 77 | + process.env[key] = value |
| 78 | +} |
| 79 | + |
| 80 | +const withControllerEnv = (entries: ReadonlyArray<readonly [string, string | undefined]>) => |
| 81 | + Effect.acquireRelease( |
| 82 | + Effect.sync(() => { |
| 83 | + const previousEntries: Array<readonly [string, string | undefined]> = entries.map(([ |
| 84 | + key |
| 85 | + ]) => [key, process.env[key]]) |
| 86 | + for (const [key, value] of entries) { |
| 87 | + setOptionalEnv(key, value) |
| 88 | + } |
| 89 | + return previousEntries |
| 90 | + }), |
| 91 | + (previousEntries) => |
| 92 | + Effect.sync(() => { |
| 93 | + for (const [key, value] of previousEntries) { |
| 94 | + setOptionalEnv(key, value) |
| 95 | + } |
| 96 | + }) |
| 97 | + ) |
| 98 | + |
| 99 | +type PreparedRevision = { |
| 100 | + readonly persistedRevision: string | undefined |
| 101 | + readonly revision: string |
| 102 | +} |
| 103 | + |
| 104 | +type ControllerBuildSkillerFixtureMode = "0" | "1" | undefined |
| 105 | + |
| 106 | +type PrepareRevisionFixture = { |
| 107 | + readonly buildSkillerMode: ControllerBuildSkillerFixtureMode |
| 108 | + readonly includeSkillerPackage: boolean |
| 109 | +} |
| 110 | + |
| 111 | +const controllerBuildSkillerFixtureModeArbitrary = fc.constantFrom<ControllerBuildSkillerFixtureMode>( |
| 112 | + undefined, |
| 113 | + "0", |
| 114 | + "1" |
| 115 | +) |
| 116 | +const prepareRevisionFixtureArbitrary: fc.Arbitrary<PrepareRevisionFixture> = fc |
| 117 | + .record({ |
| 118 | + buildSkillerMode: controllerBuildSkillerFixtureModeArbitrary, |
| 119 | + includeSkillerPackage: fc.boolean() |
| 120 | + }) |
| 121 | + .filter(({ buildSkillerMode, includeSkillerPackage }) => buildSkillerMode === "0" || includeSkillerPackage) |
| 122 | +const controllerRevisionPattern = /^[a-f0-9]{16}-none-skiller[01]$/u |
| 123 | + |
| 124 | +const prepareRevisionInTemporaryRoot = ({ |
| 125 | + buildSkillerMode, |
| 126 | + includeSkillerPackage |
| 127 | +}: PrepareRevisionFixture) => |
| 128 | + Effect.scoped( |
| 129 | + Effect.gen(function*(_) { |
| 130 | + const rootDir = yield* _(temporaryControllerRoot) |
| 131 | + yield* _(writeMinimalCompose(rootDir)) |
| 132 | + if (includeSkillerPackage) { |
| 133 | + yield* _(writeSkillerPackage(rootDir)) |
| 134 | + } |
| 135 | + yield* _(withWorkingDirectory(rootDir)) |
| 136 | + yield* _( |
| 137 | + withControllerEnv([ |
| 138 | + [controllerBuildSkillerEnvKey, buildSkillerMode], |
| 139 | + [controllerGpuModeEnvKey, undefined], |
| 140 | + [controllerRevisionEnvKey, undefined] |
| 141 | + ]) |
| 142 | + ) |
| 143 | + |
| 144 | + const revision = yield* _(prepareControllerRevision()) |
| 145 | + return { persistedRevision: process.env[controllerRevisionEnvKey], revision } |
| 146 | + }) |
| 147 | + ).pipe(Effect.provide(NodeContext.layer)) |
| 148 | + |
| 149 | +const expectPreparedRevision = (prepared: PreparedRevision, pattern: RegExp): void => { |
| 150 | + expect(prepared.revision).toMatch(pattern) |
| 151 | + expect(prepared.persistedRevision).toBe(prepared.revision) |
| 152 | +} |
| 153 | + |
| 154 | +const expectedSkillerSuffixForMode = (buildSkillerMode: ControllerBuildSkillerFixtureMode): string => |
| 155 | + buildSkillerMode === "0" ? "skiller0" : "skiller1" |
| 156 | + |
| 157 | +const expectPreparedRevisionInvariants = (fixture: PrepareRevisionFixture, prepared: PreparedRevision): void => { |
| 158 | + expectPreparedRevision(prepared, controllerRevisionPattern) |
| 159 | + expect(prepared.revision.endsWith(expectedSkillerSuffixForMode(fixture.buildSkillerMode))).toBe(true) |
| 160 | +} |
| 161 | + |
| 162 | +const assertControllerComposeProperty = <PropertyArgs>(property: fc.IAsyncProperty<PropertyArgs>) => |
| 163 | + Effect.tryPromise({ |
| 164 | + catch: (cause) => cause, |
| 165 | + try: () => fc.assert(property, { numRuns: 25 }) |
| 166 | + }) |
| 167 | + |
| 168 | +describe("controller compose preparation", () => { |
| 169 | + it.effect("does not initialize the Skiller submodule when package metadata already exists", () => { |
| 170 | + const startedCommands: Array<string> = [] |
| 171 | + |
| 172 | + return Effect.scoped( |
| 173 | + temporaryControllerRoot.pipe( |
| 174 | + Effect.tap(writeSkillerPackage), |
| 175 | + Effect.flatMap((rootDir) => |
| 176 | + ensureSkillerSubmoduleInitialized(rootDir).pipe( |
| 177 | + Effect.provide(recordedCommandExecutorLayer(startedCommands, emptyCommandResult)) |
| 178 | + ) |
| 179 | + ), |
| 180 | + Effect.tap(() => |
| 181 | + Effect.sync(() => { |
| 182 | + expect(startedCommands).toEqual([]) |
| 183 | + }) |
| 184 | + ) |
| 185 | + ) |
| 186 | + ).pipe(Effect.provide(NodeContext.layer)) |
| 187 | + }) |
| 188 | + |
| 189 | + it.effect("reports a typed failure when submodule initialization cannot provide package metadata", () => |
| 190 | + Effect.scoped( |
| 191 | + Effect.gen(function*(_) { |
| 192 | + const rootDir = yield* _(temporaryControllerRoot) |
| 193 | + const startedCommands: Array<string> = [] |
| 194 | + |
| 195 | + const error = yield* _( |
| 196 | + ensureSkillerSubmoduleInitialized(rootDir).pipe( |
| 197 | + Effect.provide( |
| 198 | + recordedCommandExecutorLayer( |
| 199 | + startedCommands, |
| 200 | + { exitCode: 128, stderr: "fatal: no submodule mapping found", stdout: "" } |
| 201 | + ) |
| 202 | + ), |
| 203 | + Effect.provide(NodeContext.layer), |
| 204 | + Effect.flip |
| 205 | + ) |
| 206 | + ) |
| 207 | + |
| 208 | + expect(error._tag).toBe("ControllerBootstrapError") |
| 209 | + expect(error.message).toContain(expectedSkillerSubmoduleCommand) |
| 210 | + expect(startedCommands).toEqual([expectedSkillerSubmoduleCommand]) |
| 211 | + }) |
| 212 | + ).pipe(Effect.provide(NodeContext.layer))) |
| 213 | + |
| 214 | + it.effect("prepares and persists host controller revisions for Skiller build modes", () => |
| 215 | + assertControllerComposeProperty( |
| 216 | + fc.asyncProperty(prepareRevisionFixtureArbitrary, (fixture) => |
| 217 | + Effect.runPromise( |
| 218 | + prepareRevisionInTemporaryRoot(fixture).pipe( |
| 219 | + Effect.tap((prepared) => |
| 220 | + Effect.sync(() => { |
| 221 | + expectPreparedRevisionInvariants(fixture, prepared) |
| 222 | + }) |
| 223 | + ), |
| 224 | + Effect.asVoid |
| 225 | + ) |
| 226 | + )) |
| 227 | + )) |
| 228 | +}) |
0 commit comments