@usine/executor 0.3.0 → 0.4.1-next.240.g158c84b

package/dist/ssh/provisioner/http.js

@@ -0,0 +1,72 @@
+import { Data, Effect, Option, Schema } from "effect";
+import { HttpClient, HttpClientError, HttpClientRequest } from "effect/http";
+/** The timeout for one provider API request. */
+const REQUEST_TIMEOUT = "30 seconds";
+/** A provider API request that got no response or an unreadable one. */
+export class ProviderUnanswered extends Data.TaggedError("ProviderUnanswered") {
+}
+/** A provider API response with an error status, with the provider's error code and message. */
+class ProviderRefused extends Data.TaggedError("ProviderRefused") {
+}
+const ErrorFields = Schema.Struct({
+    code: Schema.optionalKey(Schema.String),
+    message: Schema.optionalKey(Schema.String),
+});
+/** Hetzner's error body, `{ error: { code, message } }`. */
+const NestedErrorBody = Schema.Struct({ error: ErrorFields });
+const decodeNestedError = Schema.decodeUnknownOption(NestedErrorBody);
+const decodeFlatError = Schema.decodeUnknownOption(ErrorFields);
+const decodeJson = Schema.decodeEffect(Schema.fromJsonString(Schema.Json));
+/** Returns the code and message of Hetzner's or Boat's error body (Boat's are top-level). */
+const errorOf = (response) => {
+    const fields = Option.orElse(Option.map(decodeNestedError(response.body), ({ error }) => error), () => decodeFlatError(response.body));
+    return {
+        code: Option.flatMap(fields, ({ code }) => Option.fromNullishOr(code)),
+        message: Option.getOrElse(Option.flatMap(fields, ({ message }) => Option.fromNullishOr(message)), () => "no message"),
+    };
+};
+/**
+ * Returns a client for a provider's JSON API at `base` with `token` as its bearer token. Each
+ * request has a timeout, and an error status fails with the provider's code and message. The
+ * token and request body never appear in a failure.
+ */
+export const providerApiFor = (provider, base, token) => Effect.gen(function* () {
+    const http = yield* HttpClient.HttpClient;
+    const send = Effect.fn("ProviderApi.send")(function* (method, path, options = {}) {
+        yield* Effect.annotateCurrentSpan({ provider, method, path });
+        const url = new URL(`${base}${path}`);
+        for (const [key, value] of Object.entries(options.query ?? {}))
+            url.searchParams.set(key, value);
+        const request = HttpClientRequest.make(method)(url).pipe(HttpClientRequest.bearerToken(token), HttpClientRequest.acceptJson, HttpClientRequest.setHeaders(options.headers ?? {}), options.body === undefined
+            ? (unchanged) => unchanged
+            : HttpClientRequest.bodyJsonUnsafe(options.body));
+        const response = yield* http.execute(request).pipe(Effect.timeout(REQUEST_TIMEOUT), Effect.mapError((cause) => HttpClientError.isHttpClientError(cause)
+            ? new ProviderUnanswered({ detail: `no response (${cause.reason._tag})` })
+            : new ProviderUnanswered({ detail: `no response within ${REQUEST_TIMEOUT}` })));
+        const text = yield* response.text.pipe(Effect.mapError(() => new ProviderUnanswered({ detail: "the response body can't be read" })));
+        const body = text === ""
+            ? null
+            : yield* decodeJson(text).pipe(Effect.mapError(() => new ProviderUnanswered({
+                detail: `the response with status ${String(response.status)} isn't JSON`,
+            })));
+        const answer = { status: response.status, body };
+        if (response.status >= 400) {
+            const { code, message } = errorOf(answer);
+            return yield* new ProviderRefused({ status: response.status, code, message });
+        }
+        return answer;
+    });
+    /** Decodes a response body with `schema`; an unexpected shape counts as unanswered. */
+    const decode = (schema, operation) => (response) => Schema.decodeUnknownEffect(schema)(response.body).pipe(Effect.mapError(() => new ProviderUnanswered({
+        detail: `the response to ${operation} doesn't have the documented shape`,
+    })));
+    return { send, decode };
+});
+/** Returns a failure as an operator-facing clause. */
+export const failureText = (failure) => failure._tag === "ProviderUnanswered"
+    ? failure.detail
+    : `status ${String(failure.status)}${Option.match(failure.code, {
+        onNone: () => "",
+        onSome: (code) => ` ${code}`,
+    })}: ${failure.message}`;
+//# sourceMappingURL=http.js.map

package/dist/ssh/provisioner/http.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"http.js","sourceRoot":"","sources":["../../../src/ssh/provisioner/http.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAiB,MAAM,EAAE,MAAM,QAAQ,CAAC;AACrE,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAE7E,gDAAgD;AAChD,MAAM,eAAe,GAAG,YAAY,CAAC;AAErC,wEAAwE;AACxE,MAAM,OAAO,kBAAmB,SAAQ,IAAI,CAAC,WAAW,CAAC,oBAAoB,CAE3E;CAAG;AAEL,gGAAgG;AAChG,MAAM,eAAgB,SAAQ,IAAI,CAAC,WAAW,CAAC,iBAAiB,CAI9D;CAAG;AAiBL,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC;IAChC,IAAI,EAAE,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC;IACvC,OAAO,EAAE,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC;CAC3C,CAAC,CAAC;AAEH,4DAA4D;AAC5D,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC,CAAC;AAE9D,MAAM,iBAAiB,GAAG,MAAM,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;AACtE,MAAM,eAAe,GAAG,MAAM,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC;AAChE,MAAM,UAAU,GAAG,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;AAE3E,6FAA6F;AAC7F,MAAM,OAAO,GAAG,CAAC,QAA0B,EAAiB,EAAE;IAC5D,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAC1B,MAAM,CAAC,GAAG,CAAC,iBAAiB,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,EAClE,GAAG,EAAE,CAAC,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,CACrC,CAAC;IACF,OAAO;QACL,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QACtE,OAAO,EAAE,MAAM,CAAC,SAAS,CACvB,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,EACtE,GAAG,EAAE,CAAC,YAAY,CACnB;KACF,CAAC;AACJ,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAC5B,QAAyB,EACzB,IAAY,EACZ,KAAgC,EAChC,EAAE,CACF,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;IAClB,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC;IAC1C,MAAM,IAAI,GAAG,MAAM,CAAC,EAAE,CAAC,kBAAkB,CAAC,CAAC,QAAQ,CAAC,EAClD,MAAmD,EACnD,IAAY,EACZ,OAAO,GAIH,EAAE;QAEN,KAAK,CAAC,CAAC,MAAM,CAAC,mBAAmB,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;QAC9D,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,IAAI,GAAG,IAAI,EAAE,CAAC,CAAC;QACtC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC;YAC5D,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACnC,MAAM,OAAO,GAAG,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CACtD,iBAAiB,CAAC,WAAW,CAAC,KAAK,CAAC,EACpC,iBAAiB,CAAC,UAAU,EAC5B,iBAAiB,CAAC,UAAU,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC,EACnD,OAAO,CAAC,IAAI,KAAK,SAAS;YACxB,CAAC,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS;YAC1B,CAAC,CAAC,iBAAiB,CAAC,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,CACnD,CAAC;QACF,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,IAAI,CAChD,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,EAC/B,MAAM,CAAC,QAAQ,CAAC,CAAC,KAAK,EAAE,EAAE,CACxB,eAAe,CAAC,iBAAiB,CAAC,KAAK,CAAC;YACtC,CAAC,CAAC,IAAI,kBAAkB,CAAC,EAAE,MAAM,EAAE,gBAAgB,KAAK,CAAC,MAAM,CAAC,IAAI,GAAG,EAAE,CAAC;YAC1E,CAAC,CAAC,IAAI,kBAAkB,CAAC,EAAE,MAAM,EAAE,sBAAsB,eAAe,EAAE,EAAE,CAAC,CAChF,CACF,CAAC;QACF,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CACpC,MAAM,CAAC,QAAQ,CACb,GAAG,EAAE,CAAC,IAAI,kBAAkB,CAAC,EAAE,MAAM,EAAE,iCAAiC,EAAE,CAAC,CAC5E,CACF,CAAC;QACF,MAAM,IAAI,GACR,IAAI,KAAK,EAAE;YACT,CAAC,CAAC,IAAI;YACN,CAAC,CAAC,KAAK,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,CAC1B,MAAM,CAAC,QAAQ,CACb,GAAG,EAAE,CACH,IAAI,kBAAkB,CAAC;gBACrB,MAAM,EAAE,4BAA4B,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,aAAa;aACzE,CAAC,CACL,CACF,CAAC;QACR,MAAM,MAAM,GAAqB,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC;QACnE,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC;YAC3B,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;YAC1C,OAAO,KAAK,CAAC,CAAC,IAAI,eAAe,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;QAChF,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC,CAAC;IAEH,uFAAuF;IACvF,MAAM,MAAM,GACV,CAA8B,MAAS,EAAE,SAAiB,EAAE,EAAE,CAC9D,CACE,QAA0B,EAC2C,EAAE,CACvE,MAAM,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,CACpD,MAAM,CAAC,QAAQ,CACb,GAAG,EAAE,CACH,IAAI,kBAAkB,CAAC;QACrB,MAAM,EAAE,mBAAmB,SAAS,oCAAoC;KACzE,CAAC,CACL,CACF,CAAC;IAEN,OAAO,EAAE,IAAI,EAAE,MAAM,EAAW,CAAC;AACnC,CAAC,CAAC,CAAC;AAEL,sDAAsD;AACtD,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,OAAwB,EAAU,EAAE,CAC9D,OAAO,CAAC,IAAI,KAAK,oBAAoB;IACnC,CAAC,CAAC,OAAO,CAAC,MAAM;IAChB,CAAC,CAAC,UAAU,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE;QAC5D,MAAM,EAAE,GAAG,EAAE,CAAC,EAAE;QAChB,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,IAAI,EAAE;KAC7B,CAAC,KAAK,OAAO,CAAC,OAAO,EAAE,CAAC"}

package/dist/ssh/provisioner/machines.d.ts

@@ -0,0 +1,48 @@
+import type { BrainSpec } from "@usine/core/agent/brain";
+import type { AttemptId } from "@usine/core/attempt";
+import type { RunId } from "@usine/core/run";
+import type { MachineId, WorkerName } from "@usine/core/worker";
+import { Effect, FileSystem, Option, Path } from "effect";
+import { type ExecutorError, ExecutorOperationError, MachineGrant, MachineHold, MachineStatus, MachineUnavailableError, type PreflightReport, WorkerCapabilityError } from "../../executor.ts";
+import type { RemoteCommands } from "../../remote/commands.ts";
+import type { MachineGateway, SshExecutorOptions, SshMachine } from "../model.ts";
+import { type PinnedHostKey, type SshWorkerEntry } from "../workers.ts";
+import { type MachineEndpoint } from "./model.ts";
+export interface ProvisionedMachinesOptions {
+    readonly instance: string;
+    readonly commands: RemoteCommands;
+    readonly workerFor: (worker: WorkerName) => Effect.Effect<SshWorkerEntry, ExecutorError>;
+    readonly entries: Effect.Effect<ReadonlyArray<SshWorkerEntry>>;
+    readonly machineAt: (entry: SshWorkerEntry, id: MachineId, endpoint: MachineEndpoint, hostKey: PinnedHostKey) => SshMachine;
+    /** The machine preflight of `sshMachinePreflightFor`. */
+    readonly verifyMachine: (machine: SshMachine, brains: ReadonlyArray<BrainSpec>, maxConcurrentAttempts: number) => Effect.Effect<PreflightReport, ExecutorError>;
+    readonly verifyGatewayAdmin: (worker: WorkerName, gateway: MachineGateway) => Effect.Effect<void, WorkerCapabilityError>;
+    readonly settings: Pick<SshExecutorOptions, "knownHostsDirectory" | "providerEndpoints" | "machineReadyTimeout" | "machinePollInterval">;
+}
+/**
+ * Returns the machines of the SSH executor's provisioned Workers: the `WorkerMachines` port for
+ * the scheduler, the machine of each Attempt for preparation and recovery, and the provisioned
+ * Workers' preflight. Requires Node for the key and host key files.
+ */
+export declare const provisionedMachinesFor: (options: ProvisionedMachinesOptions) => Effect.Effect<{
+    port: {
+        readonly provisions: (worker: WorkerName) => Effect.Effect<boolean>;
+        readonly create: (worker: WorkerName, runId: RunId, brains: ReadonlyArray<BrainSpec>) => Effect.Effect<MachineGrant, MachineUnavailableError | WorkerCapabilityError>;
+        readonly assign: (hold: MachineHold, attemptId: AttemptId) => Effect.Effect<void, ExecutorOperationError>;
+        readonly adopt: (worker: WorkerName, attemptId: AttemptId) => Effect.Effect<Option.Option<MachineHold>>;
+        readonly release: (hold: MachineHold) => Effect.Effect<void>;
+        readonly sweep: Effect.Effect<void>;
+        readonly machines: Effect.Effect<ReadonlyArray<MachineStatus>>;
+    };
+    attemptMachine: (worker: string & import("effect/Brand").Brand<"WorkerName">, attemptId: string & import("effect/Brand").Brand<"AttemptId">) => Effect.Effect<SshMachine, ExecutorOperationError, never>;
+    recoveryMachine: (worker: WorkerName, attemptId: AttemptId) => Effect.Effect<Option.Option<SshMachine>, ExecutorOperationError, never>;
+    recovered: (attemptId: string & import("effect/Brand").Brand<"AttemptId">, succeeded: boolean) => Effect.Effect<void, never, never>;
+    checkoutHeld: (attemptId: string & import("effect/Brand").Brand<"AttemptId">, held: boolean) => Effect.Effect<void, never, never>;
+    verifyProvisioned: (entry: SshWorkerEntry, brains: readonly BrainSpec[], maxConcurrentAttempts: number) => Effect.Effect<{
+        degraded: Option.Option<string>;
+        deferred: Option.Option<string>;
+        containerLimits: Option.Option<import("@usine/core/worker").ContainerLimits>;
+    }, import("../../executor.ts").CredentialUnavailableError | ExecutorOperationError | WorkerCapabilityError, never>;
+    provisions: (worker: WorkerName) => Effect.Effect<boolean, never, never>;
+}, import("effect/PlatformError").PlatformError, FileSystem.FileSystem | import("effect/http/HttpClient").HttpClient | Path.Path | import("effect/Scope").Scope>;
+//# sourceMappingURL=machines.d.ts.map

package/dist/ssh/provisioner/machines.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"machines.d.ts","sourceRoot":"","sources":["../../../src/ssh/provisioner/machines.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAEzD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,KAAK,EAEV,SAAS,EAET,UAAU,EACX,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAKL,MAAM,EAEN,UAAU,EACV,MAAM,EACN,IAAI,EAIL,MAAM,QAAQ,CAAC;AAEhB,OAAO,EACL,KAAK,aAAa,EAClB,sBAAsB,EAEtB,YAAY,EACZ,WAAW,EACX,aAAa,EACb,uBAAuB,EACvB,KAAK,eAAe,EACpB,qBAAqB,EAEtB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAE/D,OAAO,KAAK,EAAE,cAAc,EAAE,kBAAkB,EAAE,UAAU,EAAkB,MAAM,aAAa,CAAC;AAClG,OAAO,EAGL,KAAK,aAAa,EAClB,KAAK,cAAc,EACpB,MAAM,eAAe,CAAC;AAGvB,OAAO,EAKL,KAAK,eAAe,EAGrB,MAAM,YAAY,CAAC;AA+FpB,MAAM,WAAW,0BAA0B;IACzC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,QAAQ,EAAE,cAAc,CAAC;IAClC,QAAQ,CAAC,SAAS,EAAE,CAAC,MAAM,EAAE,UAAU,KAAK,MAAM,CAAC,MAAM,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC;IACzF,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC,CAAC;IAC/D,QAAQ,CAAC,SAAS,EAAE,CAClB,KAAK,EAAE,cAAc,EACrB,EAAE,EAAE,SAAS,EACb,QAAQ,EAAE,eAAe,EACzB,OAAO,EAAE,aAAa,KACnB,UAAU,CAAC;IAChB,yDAAyD;IACzD,QAAQ,CAAC,aAAa,EAAE,CACtB,OAAO,EAAE,UAAU,EACnB,MAAM,EAAE,aAAa,CAAC,SAAS,CAAC,EAChC,qBAAqB,EAAE,MAAM,KAC1B,MAAM,CAAC,MAAM,CAAC,eAAe,EAAE,aAAa,CAAC,CAAC;IACnD,QAAQ,CAAC,kBAAkB,EAAE,CAC3B,MAAM,EAAE,UAAU,EAClB,OAAO,EAAE,cAAc,KACpB,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,qBAAqB,CAAC,CAAC;IAChD,QAAQ,CAAC,QAAQ,EAAE,IAAI,CACrB,kBAAkB,EAClB,qBAAqB,GAAG,mBAAmB,GAAG,qBAAqB,GAAG,qBAAqB,CAC5F,CAAC;CACH;AAqBD;;;;GAIG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;8BA+vBA,UAAU,aAAa,SAAS;;;;;;;;yBAuErC,UAAU;gKAuBtC,CAAC"}