UNPKG

the-moby-effect

Version:
617 lines (580 loc) 29.5 kB
import type * as HttpBody from "@effect/platform/HttpBody"; import type * as HttpClientError from "@effect/platform/HttpClientError"; import type * as Layer from "effect/Layer"; import type * as ParseResult from "effect/ParseResult"; import * as PlatformError from "@effect/platform/Error"; import * as HttpClient from "@effect/platform/HttpClient"; import * as HttpClientRequest from "@effect/platform/HttpClientRequest"; import * as HttpClientResponse from "@effect/platform/HttpClientResponse"; import * as Socket from "@effect/platform/Socket"; import * as Effect from "effect/Effect"; import * as Function from "effect/Function"; import * as Option from "effect/Option"; import * as Predicate from "effect/Predicate"; import * as Schema from "effect/Schema"; import * as Stream from "effect/Stream"; import * as Tuple from "effect/Tuple"; import * as MobyDemux from "../../MobyDemux.js"; import { ContainerChange, ContainerConfig, ContainerCreateRequest, ContainerCreateResponse, ContainerInspectResponse, ContainerListResponseItem, ContainerPruneResponse, ContainerStatsResponse, ContainerTopResponse, ContainerUpdateResponse, ContainerWaitResponse, } from "../generated/index.js"; import { websocketRequest } from "../platforms/agnostic.js"; import { maybeAddFilters, maybeAddQueryParameter } from "./common.js"; /** * @since 1.0.0 * @category Errors */ export const ContainersErrorTypeId: unique symbol = Symbol.for( "@the-moby-effect/endpoints/ContainersError" ) as ContainersErrorTypeId; /** * @since 1.0.0 * @category Errors */ export type ContainersErrorTypeId = typeof ContainersErrorTypeId; /** * @since 1.0.0 * @category Errors */ export const isContainersError = (u: unknown): u is ContainersError => Predicate.hasProperty(u, ContainersErrorTypeId); /** * @since 1.0.0 * @category Errors */ export class ContainersError extends PlatformError.TypeIdError(ContainersErrorTypeId, "ContainersError")<{ method: string; cause: | ParseResult.ParseError | HttpClientError.HttpClientError | HttpBody.HttpBodyError | Socket.SocketError | unknown; }> { get message() { return `${this.method}`; } } /** * @since 1.0.0 * @category Services * @see https://docs.docker.com/reference/api/engine/latest/#tag/Container */ export class Containers extends Effect.Service<Containers>()("@the-moby-effect/endpoints/Containers", { accessors: false, dependencies: [], effect: Effect.gen(function* () { const contextClient = yield* HttpClient.HttpClient; const client = contextClient.pipe(HttpClient.filterStatusOk); const maybeUpgradedClient = contextClient.pipe( HttpClient.filterStatus((status) => (status >= 200 && status < 300) || status === 101) ); const websocketConstructor = yield* Socket.WebSocketConstructor; /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/ContainerList */ const list_ = ( options?: | { readonly all?: boolean | undefined; readonly limit?: number | undefined; readonly size?: boolean | undefined; readonly filters?: | { ancestor?: string | undefined; before?: string | undefined; expose?: `${number}/${string}` | `${number}-${number}/${string}` | undefined; exited?: number | undefined; health?: "starting" | "healthy" | "unhealthy" | "none" | undefined; id?: string | undefined; isolation?: "default" | "process" | "hyperv" | undefined; "is-task"?: true | false | undefined; label?: Record<string, string> | undefined; name?: string | undefined; network?: string | undefined; publish?: `${number}/${string}` | `${number}-${number}/${string}` | undefined; since?: string | undefined; status?: | "created" | "restarting" | "running" | "removing" | "paused" | "exited" | "dead" | undefined; volume?: string | undefined; } | undefined; } | undefined ): Effect.Effect<ReadonlyArray<ContainerListResponseItem>, ContainersError, never> => Function.pipe( HttpClientRequest.get("/containers/json"), maybeAddQueryParameter("all", Option.fromNullable(options?.all)), maybeAddQueryParameter("limit", Option.fromNullable(options?.limit)), maybeAddQueryParameter("size", Option.fromNullable(options?.size)), maybeAddFilters(options?.filters), client.execute, Effect.flatMap(HttpClientResponse.schemaBodyJson(Schema.Array(ContainerListResponseItem))), Effect.mapError((cause) => new ContainersError({ method: "list", cause })) ); /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/ContainerCreate */ const create_ = (options: { readonly name?: string | undefined; readonly platform?: string | undefined; readonly spec: typeof ContainerCreateRequest.Encoded; }): Effect.Effect<ContainerCreateResponse, ContainersError, never> => Function.pipe( Schema.decode(ContainerCreateRequest)(options.spec), Effect.map((body) => Tuple.make(HttpClientRequest.post("/containers/create"), body)), Effect.map(Tuple.mapFirst(maybeAddQueryParameter("name", Option.fromNullable(options.name)))), Effect.map(Tuple.mapFirst(maybeAddQueryParameter("platform", Option.fromNullable(options.platform)))), Effect.flatMap(Function.tupled(HttpClientRequest.schemaBodyJson(ContainerCreateRequest))), Effect.flatMap(client.execute), Effect.flatMap(HttpClientResponse.schemaBodyJson(ContainerCreateResponse)), Effect.mapError((cause) => new ContainersError({ method: "create", cause })) ); /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/ContainerInspect */ const inspect_ = ( id: string, options?: | { readonly size?: boolean | undefined; } | undefined ): Effect.Effect<ContainerInspectResponse, ContainersError, never> => Function.pipe( HttpClientRequest.get(`/containers/${encodeURIComponent(id)}/json`), maybeAddQueryParameter("size", Option.fromNullable(options?.size)), client.execute, Effect.flatMap(HttpClientResponse.schemaBodyJson(ContainerInspectResponse)), Effect.mapError((cause) => new ContainersError({ method: "inspect", cause })) ); /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/ContainerTop */ const top_ = ( id: string, options?: | { readonly ps_args?: string | undefined; } | undefined ): Effect.Effect<ContainerTopResponse, ContainersError, never> => Function.pipe( HttpClientRequest.get(`/containers/${encodeURIComponent(id)}/top`), maybeAddQueryParameter("ps_args", Option.fromNullable(options?.ps_args)), client.execute, Effect.flatMap(HttpClientResponse.schemaBodyJson(ContainerTopResponse)), Effect.mapError((cause) => new ContainersError({ method: "top", cause })) ); /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/ContainerLogs */ const logs_ = ( id: string, options?: | { readonly follow?: boolean | undefined; readonly stdout?: boolean | undefined; readonly stderr?: boolean | undefined; readonly since?: number | undefined; readonly until?: number | undefined; readonly timestamps?: boolean | undefined; readonly tail?: string | undefined; } | undefined ): Stream.Stream<string, ContainersError, never> => Function.pipe( HttpClientRequest.get(`/containers/${encodeURIComponent(id)}/logs`), maybeAddQueryParameter("follow", Option.fromNullable(options?.follow)), maybeAddQueryParameter("stdout", Option.fromNullable(options?.stdout)), maybeAddQueryParameter("stderr", Option.fromNullable(options?.stderr)), maybeAddQueryParameter("since", Option.fromNullable(options?.since)), maybeAddQueryParameter("until", Option.fromNullable(options?.until)), maybeAddQueryParameter("timestamps", Option.fromNullable(options?.timestamps)), maybeAddQueryParameter("tail", Option.fromNullable(options?.tail)), client.execute, HttpClientResponse.stream, Stream.decodeText(), Stream.mapError((cause) => new ContainersError({ method: "logs", cause })) ); /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/ContainerChanges */ const changes_ = (id: string): Effect.Effect<ReadonlyArray<ContainerChange> | null, ContainersError> => Function.pipe( HttpClientRequest.get(`/containers/${encodeURIComponent(id)}/changes`), client.execute, Effect.flatMap(HttpClientResponse.schemaBodyJson(Schema.NullOr(Schema.Array(ContainerChange)))), Effect.mapError((cause) => new ContainersError({ method: "changes", cause })) ); /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/ContainerExport */ const export_ = (id: string): Stream.Stream<Uint8Array, ContainersError, never> => Function.pipe( HttpClientRequest.get(`/containers/${encodeURIComponent(id)}/export`), client.execute, HttpClientResponse.stream, Stream.mapError((cause) => new ContainersError({ method: "export", cause })) ); /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/ContainerStats */ const stats_ = ( id: string, options?: | { readonly stream?: boolean | undefined; readonly "one-shot"?: boolean | undefined; } | undefined ): Stream.Stream<ContainerStatsResponse, ContainersError, never> => Function.pipe( HttpClientRequest.get(`/containers/${encodeURIComponent(id)}/stats`), maybeAddQueryParameter("stream", Option.fromNullable(options?.stream)), maybeAddQueryParameter("one-shot", Option.fromNullable(options?.["one-shot"])), client.execute, HttpClientResponse.stream, Stream.decodeText(), Stream.mapEffect(Schema.decode(Schema.parseJson(ContainerStatsResponse))), Stream.mapError((cause) => new ContainersError({ method: "stats", cause })) ); /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/ContainerResize */ const resize_ = ( id: string, options?: | { readonly h?: number | undefined; readonly w?: number | undefined; } | undefined ): Effect.Effect<void, ContainersError, never> => Function.pipe( HttpClientRequest.post(`/containers/${encodeURIComponent(id)}/resize`), maybeAddQueryParameter("h", Option.fromNullable(options?.h)), maybeAddQueryParameter("w", Option.fromNullable(options?.w)), client.execute, Effect.asVoid, Effect.mapError((cause) => new ContainersError({ method: "resize", cause })) ); /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/ContainerStart */ const start_ = ( id: string, options?: | { readonly detachKeys?: string | undefined; } | undefined ): Effect.Effect<void, ContainersError, never> => Function.pipe( HttpClientRequest.post(`/containers/${encodeURIComponent(id)}/start`), maybeAddQueryParameter("detachKeys", Option.fromNullable(options?.detachKeys)), client.execute, Effect.asVoid, Effect.mapError((cause) => new ContainersError({ method: "start", cause })) ); /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/ContainerStop */ const stop_ = ( id: string, options?: | { readonly signal?: string | undefined; readonly t?: number | undefined; } | undefined ): Effect.Effect<void, ContainersError, never> => Function.pipe( HttpClientRequest.post(`/containers/${encodeURIComponent(id)}/stop`), maybeAddQueryParameter("signal", Option.fromNullable(options?.signal)), maybeAddQueryParameter("t", Option.fromNullable(options?.t)), client.execute, Effect.asVoid, Effect.mapError((cause) => new ContainersError({ method: "stop", cause })) ); /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/ContainerRestart */ const restart_ = ( id: string, options?: | { readonly signal?: string | undefined; readonly t?: number | undefined; } | undefined ): Effect.Effect<void, ContainersError, never> => Function.pipe( HttpClientRequest.post(`/containers/${encodeURIComponent(id)}/restart`), maybeAddQueryParameter("signal", Option.fromNullable(options?.signal)), maybeAddQueryParameter("t", Option.fromNullable(options?.t)), client.execute, Effect.asVoid, Effect.mapError((cause) => new ContainersError({ method: "restart", cause })) ); /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/ContainerKill */ const kill_ = ( id: string, options?: | { readonly signal?: string | undefined; } | undefined ): Effect.Effect<void, ContainersError, never> => Function.pipe( HttpClientRequest.post(`/containers/${encodeURIComponent(id)}/kill`), maybeAddQueryParameter("signal", Option.fromNullable(options?.signal)), client.execute, Effect.asVoid, Effect.mapError((cause) => new ContainersError({ method: "kill", cause })) ); /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/ContainerUpdate */ const update_ = ( id: string, options: { readonly spec: ContainerConfig; } ): Effect.Effect<ContainerUpdateResponse, ContainersError, never> => Function.pipe( HttpClientRequest.post(`/containers/${encodeURIComponent(id)}/update`), HttpClientRequest.schemaBodyJson(ContainerConfig)(options.spec), Effect.flatMap(client.execute), Effect.flatMap(HttpClientResponse.schemaBodyJson(ContainerUpdateResponse)), Effect.mapError((cause) => new ContainersError({ method: "update", cause })) ); /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/ContainerRename */ const rename_ = ( id: string, options: { readonly name: string; } ): Effect.Effect<void, ContainersError, never> => Function.pipe( HttpClientRequest.post(`/containers/${encodeURIComponent(id)}/rename`), maybeAddQueryParameter("name", Option.fromNullable(options.name)), client.execute, Effect.asVoid, Effect.mapError((cause) => new ContainersError({ method: "rename", cause })) ); /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/ContainerPause */ const pause_ = (id: string): Effect.Effect<void, ContainersError, never> => Function.pipe( HttpClientRequest.post(`/containers/${encodeURIComponent(id)}/pause`), client.execute, Effect.asVoid, Effect.mapError((cause) => new ContainersError({ method: "pause", cause })) ); /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/ContainerUnpause */ const unpause_ = (id: string): Effect.Effect<void, ContainersError, never> => Function.pipe( HttpClientRequest.post(`/containers/${encodeURIComponent(id)}/unpause`), client.execute, Effect.asVoid, Effect.mapError((cause) => new ContainersError({ method: "unpause", cause })) ); /** * Attach to a container * * @param options.id - ID or name of the container * @param detachKeys - Override the key sequence for detaching a * container.Format is a single character `[a-Z]` or `ctrl-<value>` * where `<value>` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. * @param logs - Replay previous logs from the container. * * This is useful for attaching to a container that has started and you * want to output everything since the container started. * * If `stream` is also enabled, once all the previous output has been * returned, it will seamlessly transition into streaming current * output. * @param stream - Stream attached streams from the time the request was * made onwards. * @param stdin - Attach to `stdin` * @param stdout - Attach to `stdout` * @param stderr - Attach to `stderr` * @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/ContainerAttach */ const attach_ = ( id: string, options?: | { readonly detachKeys?: string | undefined; readonly logs?: boolean | undefined; readonly stream?: boolean | undefined; readonly stdin?: boolean | undefined; readonly stdout?: boolean | undefined; readonly stderr?: boolean | undefined; } | undefined ): Effect.Effect<MobyDemux.RawSocket | MobyDemux.MultiplexedSocket, ContainersError, never> => Function.pipe( HttpClientRequest.post(`/containers/${encodeURIComponent(id)}/attach`), HttpClientRequest.setHeader("Upgrade", "tcp"), HttpClientRequest.setHeader("Connection", "Upgrade"), maybeAddQueryParameter("detachKeys", Option.fromNullable(options?.detachKeys)), maybeAddQueryParameter("logs", Option.fromNullable(options?.logs)), maybeAddQueryParameter("stream", Option.fromNullable(options?.stream)), maybeAddQueryParameter("stdin", Option.fromNullable(options?.stdin)), maybeAddQueryParameter("stdout", Option.fromNullable(options?.stdout)), maybeAddQueryParameter("stderr", Option.fromNullable(options?.stderr)), maybeUpgradedClient.execute, Effect.flatMap(MobyDemux.responseToStreamingSocketOrFailUnsafe), Effect.mapError((cause) => new ContainersError({ method: "attach", cause })) ); /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/ContainerAttachWebsocket */ const attachWebsocket_ = ( id: string, options?: | { readonly detachKeys?: string | undefined; readonly logs?: boolean | undefined; readonly stream?: boolean | undefined; readonly stdin?: boolean | undefined; readonly stdout?: boolean | undefined; readonly stderr?: boolean | undefined; } | undefined ): Effect.Effect<MobyDemux.RawSocket, ContainersError, never> => Function.pipe( HttpClientRequest.get(`/containers/${encodeURIComponent(id)}/attach/ws`), maybeAddQueryParameter("detachKeys", Option.fromNullable(options?.detachKeys)), maybeAddQueryParameter("logs", Option.fromNullable(options?.logs)), maybeAddQueryParameter("stream", Option.fromNullable(options?.stream)), maybeAddQueryParameter("stdin", Option.fromNullable(options?.stdin)), maybeAddQueryParameter("stdout", Option.fromNullable(options?.stdout)), maybeAddQueryParameter("stderr", Option.fromNullable(options?.stderr)), websocketRequest, Effect.map(MobyDemux.makeRawSocket), Effect.provideService(HttpClient.HttpClient, contextClient), Effect.provideService(Socket.WebSocketConstructor, websocketConstructor), Effect.mapError((cause) => new ContainersError({ method: "attachWebsocket", cause })) ); /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/ContainerWait */ const wait_ = ( id: string, options?: { readonly condition?: string | undefined } | undefined ): Effect.Effect<ContainerWaitResponse, ContainersError, never> => Function.pipe( HttpClientRequest.post(`/containers/${encodeURIComponent(id)}/wait`), maybeAddQueryParameter("condition", Option.fromNullable(options?.condition)), client.execute, Effect.flatMap(HttpClientResponse.schemaBodyJson(ContainerWaitResponse)), Effect.mapError((cause) => new ContainersError({ method: "wait", cause })) ); /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/ContainerDelete */ const delete_ = ( id: string, options?: | { readonly v?: boolean | undefined; readonly force?: boolean | undefined; readonly link?: boolean | undefined; } | undefined ): Effect.Effect<void, ContainersError, never> => Function.pipe( HttpClientRequest.del(`/containers/${encodeURIComponent(id)}`), maybeAddQueryParameter("v", Option.fromNullable(options?.v)), maybeAddQueryParameter("force", Option.fromNullable(options?.force)), maybeAddQueryParameter("link", Option.fromNullable(options?.link)), client.execute, Effect.asVoid, Effect.mapError((cause) => new ContainersError({ method: "delete", cause })) ); /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/ContainerArchive */ const archive_ = ( id: string, options: { readonly path: string } ): Stream.Stream<Uint8Array, ContainersError, never> => Function.pipe( HttpClientRequest.get(`/containers/${encodeURIComponent(id)}/archive`), maybeAddQueryParameter("path", Option.some(options.path)), client.execute, HttpClientResponse.stream, Stream.mapError((cause) => new ContainersError({ method: "archive", cause })) ); /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/ContainerArchiveInfo */ const archiveInfo_ = ( id: string, options: { readonly path: string } ): Effect.Effect<void, ContainersError, never> => Function.pipe( HttpClientRequest.head(`/containers/${encodeURIComponent(id)}/archive`), maybeAddQueryParameter("path", Option.some(options.path)), client.execute, Effect.asVoid, Effect.mapError((cause) => new ContainersError({ method: "archiveInfo", cause })) ); /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/PutContainerArchive */ const putArchive_ = <E1>( id: string, options: { readonly path: string; readonly noOverwriteDirNonDir?: string | undefined; readonly copyUIDGID?: string | undefined; readonly stream: Stream.Stream<Uint8Array, E1, never>; } ): Effect.Effect<void, ContainersError, never> => Function.pipe( HttpClientRequest.put(`/containers/${encodeURIComponent(id)}/archive`), maybeAddQueryParameter("path", Option.some(options.path)), maybeAddQueryParameter("noOverwriteDirNonDir", Option.fromNullable(options.noOverwriteDirNonDir)), maybeAddQueryParameter("copyUIDGID", Option.fromNullable(options.copyUIDGID)), HttpClientRequest.bodyStream(options.stream), client.execute, Effect.asVoid, Effect.mapError((cause) => new ContainersError({ method: "putArchive", cause })) ); /** @see https://docs.docker.com/reference/api/engine/latest/#tag/Container/operation/ContainerPrune */ const prune_ = ( options?: | { readonly filters?: | { until?: string; label?: Record<string, string> | undefined; } | undefined; } | undefined ): Effect.Effect<ContainerPruneResponse, ContainersError, never> => Function.pipe( HttpClientRequest.post("/containers/prune"), maybeAddFilters(options?.filters), client.execute, Effect.flatMap(HttpClientResponse.schemaBodyJson(ContainerPruneResponse)), Effect.mapError((cause) => new ContainersError({ method: "prune", cause })) ); return { list: list_, create: create_, inspect: inspect_, top: top_, logs: logs_, changes: changes_, export: export_, stats: stats_, resize: resize_, start: start_, stop: stop_, restart: restart_, kill: kill_, update: update_, rename: rename_, pause: pause_, unpause: unpause_, attach: attach_, attachWebsocket: attachWebsocket_, wait: wait_, delete: delete_, archive: archive_, archiveInfo: archiveInfo_, putArchive: putArchive_, prune: prune_, }; }), }) {} /** * @since 1.0.0 * @category Layers * @see https://docs.docker.com/reference/api/engine/latest/#tag/Container */ export const ContainersLayer: Layer.Layer<Containers, never, HttpClient.HttpClient | Socket.WebSocketConstructor> = Containers.Default;