the-moby-effect
Version:
Moby/Docker API client built using effect-ts
172 lines (171 loc) • 7.71 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.connectionOptionsFromUserSocketDefault = exports.connectionOptionsFromUrl = exports.connectionOptionsFromPlatformSystemSocketDefault = exports.connectionOptionsFromDockerHostEnvironmentVariable = exports.SshConnectionOptions = exports.SocketConnectionOptions = exports.MobyConnectionOptions = exports.HttpsConnectionOptions = exports.HttpConnectionOptions = void 0;
var Path = _interopRequireWildcard(require("@effect/platform/Path"));
var Config = _interopRequireWildcard(require("effect/Config"));
var ConfigError = _interopRequireWildcard(require("effect/ConfigError"));
var Data = _interopRequireWildcard(require("effect/Data"));
var Effect = _interopRequireWildcard(require("effect/Effect"));
var Function = _interopRequireWildcard(require("effect/Function"));
var Match = _interopRequireWildcard(require("effect/Match"));
var Redacted = _interopRequireWildcard(require("effect/Redacted"));
function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
/**
* Connection options for how to connect to your moby/docker instance. Can be a
* unix socket on the current machine. Can be an ssh connection to a remote
* machine with a remote user, remote machine, remote port, and remote socket
* path. Can be an http connection to a remote machine with a host, port, and
* path. Or it can be an https connection to a remote machine with a host, port,
* path, cert, ca, key, and passphrase.
*
* @since 1.0.0
* @category Connection Types
*/
const MobyConnectionOptions = exports.MobyConnectionOptions = /*#__PURE__*/Data.taggedEnum();
/**
* @since 1.0.0
* @category Connection Constructors
*/
const SocketConnectionOptions = exports.SocketConnectionOptions = MobyConnectionOptions.socket;
/**
* Connects to a remote machine over ssh. This specific ssh implementation uses
* the OpenSSH extension "ForwardOutLocalStream" (so you must being running an
* OpenSSH server or something that implements the "ForwardOutLocalStream"
* extension) that opens a connection to a UNIX domain socket at socketPath on
* the server.
*
* @since 1.0.0
* @category Connection Constructors
*/
const SshConnectionOptions = exports.SshConnectionOptions = MobyConnectionOptions.ssh;
/**
* @since 1.0.0
* @category Connection Constructors
*/
const HttpConnectionOptions = exports.HttpConnectionOptions = MobyConnectionOptions.http;
/**
* @since 1.0.0
* @category Connection Constructors
*/
const HttpsConnectionOptions = exports.HttpsConnectionOptions = MobyConnectionOptions.https;
/**
* From
* https://docs.docker.com/engine/reference/commandline/dockerd/#daemon-socket-option
*
* "The Docker client will honor the DOCKER_HOST environment variable to set the
* -H flag for the client"
*
* And then from
* https://docs.docker.com/engine/reference/commandline/dockerd/#bind-docker-to-another-hostport-or-a-unix-socket
*
* "-H accepts host and port assignment in the following format:
* `tcp://[host]:[port][path]` or `unix://path`
*
* For example:
*
* - `unix://path/to/socket` -> Unix socket located at path/to/socket
* - When -H is empty, it will default to the same value as when no -H was passed
* in
* - `http://host:port/path` -> HTTP connection on host:port and prepend path to
* all requests
* - `https://host:port/path` -> HTTPS connection on host:port and prepend path to
* all requests
* - `ssh://me@example.com:22/var/run/docker.sock` -> SSH connection to
* example.com on port 22
*
* @since 1.0.0
* @category Constructors
*/
const connectionOptionsFromUrl = dockerHost => {
const url = new URL(dockerHost);
if (url.protocol === "unix:") {
return Effect.succeed(SocketConnectionOptions({
socketPath: url.pathname
}));
}
if (url.protocol === "ssh:") {
return Effect.succeed(SshConnectionOptions({
host: url.hostname,
username: url.username,
password: url.password,
remoteSocketPath: url.pathname,
port: url.port ? Number.parseInt(url.port) : 22
}));
}
if (url.protocol === "http:") {
return Effect.succeed(HttpConnectionOptions({
host: url.hostname ?? "127.0.0.1",
port: url.port ? Number.parseInt(url.port) : 2375,
path: url.pathname
}));
}
if (url.protocol === "https:") {
return Effect.succeed(HttpConnectionOptions({
host: url.hostname ?? "127.0.0.1",
port: url.port ? Number.parseInt(url.port) : 2376,
path: url.pathname
}));
}
if (url.protocol === "tcp:") {
const path = url.pathname;
const host = url.hostname ?? "127.0.0.0.1";
const port = url.port ? Number.parseInt(url.port) : 2375;
if (port === 2376) {
return Effect.succeed(HttpsConnectionOptions({
host,
port,
path
}));
} else {
return Effect.succeed(HttpConnectionOptions({
host,
port,
path
}));
}
}
// Any other protocols are not supported
return Effect.fail(ConfigError.InvalidData([], `Unsupported protocol ${url.protocol}`));
};
/**
* Creates a MobyApi layer from the DOCKER_HOST environment variable as a url.
*
* @since 1.0.0
* @category Constructors
*/
exports.connectionOptionsFromUrl = connectionOptionsFromUrl;
const connectionOptionsFromDockerHostEnvironmentVariable = exports.connectionOptionsFromDockerHostEnvironmentVariable = /*#__PURE__*/Config.redacted("DOCKER_HOST").pipe(Config.withDefault(Redacted.make("unix:///var/run/docker.sock"))).pipe(Config.map(Redacted.value)).pipe(/*#__PURE__*/Effect.flatMap(connectionOptionsFromUrl));
/**
* Creates a MobyApi layer from the platform default system socket location.
*
* @since 1.0.0
* @category Constructors
*/
const connectionOptionsFromPlatformSystemSocketDefault = exports.connectionOptionsFromPlatformSystemSocketDefault = /*#__PURE__*/Function.pipe(/*#__PURE__*/Match.value(process.platform), /*#__PURE__*/Match.when("linux", () => Effect.succeed(SocketConnectionOptions({
socketPath: "/var/run/docker.sock"
}))), /*#__PURE__*/Match.when("darwin", () => Effect.succeed(SocketConnectionOptions({
socketPath: "/var/run/docker.sock"
}))), /*#__PURE__*/Match.when("win32", () => Effect.succeed(SocketConnectionOptions({
socketPath: "//./pipe/docker_engine"
}))), /*#__PURE__*/Match.orElse(() => Effect.fail(ConfigError.InvalidData([], `Unsupported platform ${process.platform}`))));
/**
* Creates a MobyApi layer from the platform default system socket location.
*
* @since 1.0.0
* @category Constructors
*/
const connectionOptionsFromUserSocketDefault = exports.connectionOptionsFromUserSocketDefault = /*#__PURE__*/Function.pipe(/*#__PURE__*/Effect.all({
pathLazy: Path.Path,
osLazy: /*#__PURE__*/Effect.promise(() => import("node:os"))
}, {
concurrency: 2
}), /*#__PURE__*/Effect.map(({
osLazy,
pathLazy
}) => SocketConnectionOptions({
socketPath: pathLazy.join(osLazy.homedir(), ".docker", "run", "docker.sock")
})));
//# sourceMappingURL=connection.js.map