mirror of
https://github.com/nicotsx/ironmount.git
synced 2025-12-10 12:10:51 +01:00
* refactor: use short ids to allow changing the name of volumes & repos * refactor: address PR feedbacks * fix: make short_id non null after initial population
428 lines
11 KiB
TypeScript
428 lines
11 KiB
TypeScript
import * as fs from "node:fs/promises";
|
|
import * as os from "node:os";
|
|
import * as path from "node:path";
|
|
import Docker from "dockerode";
|
|
import { and, eq, ne } from "drizzle-orm";
|
|
import { ConflictError, InternalServerError, NotFoundError } from "http-errors-enhanced";
|
|
import slugify from "slugify";
|
|
import { getCapabilities } from "../../core/capabilities";
|
|
import { db } from "../../db/db";
|
|
import { volumesTable } from "../../db/schema";
|
|
import { toMessage } from "../../utils/errors";
|
|
import { generateShortId } from "../../utils/id";
|
|
import { getStatFs, type StatFs } from "../../utils/mountinfo";
|
|
import { withTimeout } from "../../utils/timeout";
|
|
import { createVolumeBackend } from "../backends/backend";
|
|
import type { UpdateVolumeBody } from "./volume.dto";
|
|
import { getVolumePath } from "./helpers";
|
|
import { logger } from "../../utils/logger";
|
|
import { serverEvents } from "../../core/events";
|
|
import type { BackendConfig } from "~/schemas/volumes";
|
|
|
|
const listVolumes = async () => {
|
|
const volumes = await db.query.volumesTable.findMany({});
|
|
|
|
return volumes;
|
|
};
|
|
|
|
const createVolume = async (name: string, backendConfig: BackendConfig) => {
|
|
const slug = slugify(name, { lower: true, strict: true });
|
|
|
|
const existing = await db.query.volumesTable.findFirst({
|
|
where: eq(volumesTable.name, slug),
|
|
});
|
|
|
|
if (existing) {
|
|
throw new ConflictError("Volume already exists");
|
|
}
|
|
|
|
const shortId = generateShortId();
|
|
|
|
const [created] = await db
|
|
.insert(volumesTable)
|
|
.values({
|
|
shortId,
|
|
name: slug,
|
|
config: backendConfig,
|
|
type: backendConfig.backend,
|
|
})
|
|
.returning();
|
|
|
|
if (!created) {
|
|
throw new InternalServerError("Failed to create volume");
|
|
}
|
|
|
|
const backend = createVolumeBackend(created);
|
|
const { error, status } = await backend.mount();
|
|
|
|
await db
|
|
.update(volumesTable)
|
|
.set({ status, lastError: error ?? null, lastHealthCheck: Date.now() })
|
|
.where(eq(volumesTable.name, slug));
|
|
|
|
return { volume: created, status: 201 };
|
|
};
|
|
|
|
const deleteVolume = async (name: string) => {
|
|
const volume = await db.query.volumesTable.findFirst({
|
|
where: eq(volumesTable.name, name),
|
|
});
|
|
|
|
if (!volume) {
|
|
throw new NotFoundError("Volume not found");
|
|
}
|
|
|
|
const backend = createVolumeBackend(volume);
|
|
await backend.unmount();
|
|
await db.delete(volumesTable).where(eq(volumesTable.name, name));
|
|
};
|
|
|
|
const mountVolume = async (name: string) => {
|
|
const volume = await db.query.volumesTable.findFirst({
|
|
where: eq(volumesTable.name, name),
|
|
});
|
|
|
|
if (!volume) {
|
|
throw new NotFoundError("Volume not found");
|
|
}
|
|
|
|
const backend = createVolumeBackend(volume);
|
|
const { error, status } = await backend.mount();
|
|
|
|
await db
|
|
.update(volumesTable)
|
|
.set({ status, lastError: error ?? null, lastHealthCheck: Date.now() })
|
|
.where(eq(volumesTable.name, name));
|
|
|
|
if (status === "mounted") {
|
|
serverEvents.emit("volume:mounted", { volumeName: name });
|
|
}
|
|
|
|
return { error, status };
|
|
};
|
|
|
|
const unmountVolume = async (name: string) => {
|
|
const volume = await db.query.volumesTable.findFirst({
|
|
where: eq(volumesTable.name, name),
|
|
});
|
|
|
|
if (!volume) {
|
|
throw new NotFoundError("Volume not found");
|
|
}
|
|
|
|
const backend = createVolumeBackend(volume);
|
|
const { status, error } = await backend.unmount();
|
|
|
|
await db.update(volumesTable).set({ status }).where(eq(volumesTable.name, name));
|
|
|
|
if (status === "unmounted") {
|
|
serverEvents.emit("volume:unmounted", { volumeName: name });
|
|
}
|
|
|
|
return { error, status };
|
|
};
|
|
|
|
const getVolume = async (name: string) => {
|
|
const volume = await db.query.volumesTable.findFirst({
|
|
where: eq(volumesTable.name, name),
|
|
});
|
|
|
|
if (!volume) {
|
|
throw new NotFoundError("Volume not found");
|
|
}
|
|
|
|
let statfs: Partial<StatFs> = {};
|
|
if (volume.status === "mounted") {
|
|
statfs = await withTimeout(getStatFs(getVolumePath(volume)), 1000, "getStatFs").catch((error) => {
|
|
logger.warn(`Failed to get statfs for volume ${name}: ${toMessage(error)}`);
|
|
return {};
|
|
});
|
|
}
|
|
|
|
return { volume, statfs };
|
|
};
|
|
|
|
const updateVolume = async (name: string, volumeData: UpdateVolumeBody) => {
|
|
const existing = await db.query.volumesTable.findFirst({
|
|
where: eq(volumesTable.name, name),
|
|
});
|
|
|
|
if (!existing) {
|
|
throw new NotFoundError("Volume not found");
|
|
}
|
|
|
|
let newName = existing.name;
|
|
if (volumeData.name !== undefined && volumeData.name !== existing.name) {
|
|
const newSlug = slugify(volumeData.name, { lower: true, strict: true });
|
|
|
|
const conflict = await db.query.volumesTable.findFirst({
|
|
where: and(eq(volumesTable.name, newSlug), ne(volumesTable.id, existing.id)),
|
|
});
|
|
|
|
if (conflict) {
|
|
throw new ConflictError("A volume with this name already exists");
|
|
}
|
|
|
|
newName = newSlug;
|
|
}
|
|
|
|
const configChanged =
|
|
JSON.stringify(existing.config) !== JSON.stringify(volumeData.config) && volumeData.config !== undefined;
|
|
|
|
if (configChanged) {
|
|
logger.debug("Unmounting existing volume before applying new config");
|
|
const backend = createVolumeBackend(existing);
|
|
await backend.unmount();
|
|
}
|
|
|
|
const [updated] = await db
|
|
.update(volumesTable)
|
|
.set({
|
|
name: newName,
|
|
config: volumeData.config,
|
|
type: volumeData.config?.backend,
|
|
autoRemount: volumeData.autoRemount,
|
|
updatedAt: Date.now(),
|
|
})
|
|
.where(eq(volumesTable.id, existing.id))
|
|
.returning();
|
|
|
|
if (!updated) {
|
|
throw new InternalServerError("Failed to update volume");
|
|
}
|
|
|
|
if (configChanged) {
|
|
const backend = createVolumeBackend(updated);
|
|
const { error, status } = await backend.mount();
|
|
await db
|
|
.update(volumesTable)
|
|
.set({ status, lastError: error ?? null, lastHealthCheck: Date.now() })
|
|
.where(eq(volumesTable.id, existing.id));
|
|
|
|
serverEvents.emit("volume:updated", { volumeName: updated.name });
|
|
}
|
|
|
|
return { volume: updated };
|
|
};
|
|
|
|
const testConnection = async (backendConfig: BackendConfig) => {
|
|
const tempDir = await fs.mkdtemp(path.join(os.tmpdir(), "zerobyte-test-"));
|
|
|
|
const mockVolume = {
|
|
id: 0,
|
|
shortId: "test",
|
|
name: "test-connection",
|
|
path: tempDir,
|
|
config: backendConfig,
|
|
createdAt: Date.now(),
|
|
updatedAt: Date.now(),
|
|
lastHealthCheck: Date.now(),
|
|
type: backendConfig.backend,
|
|
status: "unmounted" as const,
|
|
lastError: null,
|
|
autoRemount: true,
|
|
};
|
|
|
|
const backend = createVolumeBackend(mockVolume);
|
|
const { error } = await backend.mount();
|
|
|
|
await backend.unmount();
|
|
|
|
await fs.access(tempDir);
|
|
await fs.rm(tempDir, { recursive: true, force: true });
|
|
|
|
return {
|
|
success: !error,
|
|
message: error ? toMessage(error) : "Connection successful",
|
|
};
|
|
};
|
|
|
|
const checkHealth = async (name: string) => {
|
|
const volume = await db.query.volumesTable.findFirst({
|
|
where: eq(volumesTable.name, name),
|
|
});
|
|
|
|
if (!volume) {
|
|
throw new NotFoundError("Volume not found");
|
|
}
|
|
|
|
const backend = createVolumeBackend(volume);
|
|
const { error, status } = await backend.checkHealth();
|
|
|
|
if (status !== volume.status) {
|
|
serverEvents.emit("volume:status_changed", { volumeName: name, status });
|
|
}
|
|
|
|
await db
|
|
.update(volumesTable)
|
|
.set({ lastHealthCheck: Date.now(), status, lastError: error ?? null })
|
|
.where(eq(volumesTable.name, volume.name));
|
|
|
|
return { status, error };
|
|
};
|
|
|
|
const getContainersUsingVolume = async (name: string) => {
|
|
const volume = await db.query.volumesTable.findFirst({
|
|
where: eq(volumesTable.name, name),
|
|
});
|
|
|
|
if (!volume) {
|
|
throw new NotFoundError("Volume not found");
|
|
}
|
|
|
|
const { docker } = await getCapabilities();
|
|
if (!docker) {
|
|
logger.debug("Docker capability not available, returning empty containers list");
|
|
return { containers: [] };
|
|
}
|
|
|
|
try {
|
|
const docker = new Docker();
|
|
const containers = await docker.listContainers({ all: true });
|
|
|
|
const usingContainers = [];
|
|
for (const info of containers) {
|
|
const container = docker.getContainer(info.Id);
|
|
const inspect = await container.inspect();
|
|
const mounts = inspect.Mounts || [];
|
|
const usesVolume = mounts.some((mount) => mount.Type === "volume" && mount.Name === `zb-${volume.shortId}`);
|
|
if (usesVolume) {
|
|
usingContainers.push({
|
|
id: inspect.Id,
|
|
name: inspect.Name,
|
|
state: inspect.State.Status,
|
|
image: inspect.Config.Image,
|
|
});
|
|
}
|
|
}
|
|
|
|
return { containers: usingContainers };
|
|
} catch (error) {
|
|
logger.error(`Failed to get containers using volume: ${toMessage(error)}`);
|
|
return { containers: [] };
|
|
}
|
|
};
|
|
|
|
const listFiles = async (name: string, subPath?: string) => {
|
|
const volume = await db.query.volumesTable.findFirst({
|
|
where: eq(volumesTable.name, name),
|
|
});
|
|
|
|
if (!volume) {
|
|
throw new NotFoundError("Volume not found");
|
|
}
|
|
|
|
if (volume.status !== "mounted") {
|
|
throw new InternalServerError("Volume is not mounted");
|
|
}
|
|
|
|
// For directory volumes, use the configured path directly
|
|
const volumePath = getVolumePath(volume);
|
|
|
|
const requestedPath = subPath ? path.join(volumePath, subPath) : volumePath;
|
|
|
|
const normalizedPath = path.normalize(requestedPath);
|
|
if (!normalizedPath.startsWith(volumePath)) {
|
|
throw new InternalServerError("Invalid path");
|
|
}
|
|
|
|
try {
|
|
const entries = await fs.readdir(normalizedPath, { withFileTypes: true });
|
|
|
|
const files = await Promise.all(
|
|
entries.map(async (entry) => {
|
|
const fullPath = path.join(normalizedPath, entry.name);
|
|
const relativePath = path.relative(volumePath, fullPath);
|
|
|
|
try {
|
|
const stats = await fs.stat(fullPath);
|
|
return {
|
|
name: entry.name,
|
|
path: `/${relativePath}`,
|
|
type: entry.isDirectory() ? ("directory" as const) : ("file" as const),
|
|
size: entry.isFile() ? stats.size : undefined,
|
|
modifiedAt: stats.mtimeMs,
|
|
};
|
|
} catch {
|
|
return {
|
|
name: entry.name,
|
|
path: `/${relativePath}`,
|
|
type: entry.isDirectory() ? ("directory" as const) : ("file" as const),
|
|
size: undefined,
|
|
modifiedAt: undefined,
|
|
};
|
|
}
|
|
}),
|
|
);
|
|
|
|
return {
|
|
files: files.sort((a, b) => {
|
|
if (a.type !== b.type) {
|
|
return a.type === "directory" ? -1 : 1;
|
|
}
|
|
return a.name.localeCompare(b.name);
|
|
}),
|
|
path: subPath || "/",
|
|
};
|
|
} catch (error) {
|
|
throw new InternalServerError(`Failed to list files: ${toMessage(error)}`);
|
|
}
|
|
};
|
|
|
|
const browseFilesystem = async (browsePath: string) => {
|
|
const normalizedPath = path.normalize(browsePath);
|
|
|
|
try {
|
|
const entries = await fs.readdir(normalizedPath, { withFileTypes: true });
|
|
|
|
const directories = await Promise.all(
|
|
entries
|
|
.filter((entry) => entry.isDirectory())
|
|
.map(async (entry) => {
|
|
const fullPath = path.join(normalizedPath, entry.name);
|
|
|
|
try {
|
|
const stats = await fs.stat(fullPath);
|
|
return {
|
|
name: entry.name,
|
|
path: fullPath,
|
|
type: "directory" as const,
|
|
size: undefined,
|
|
modifiedAt: stats.mtimeMs,
|
|
};
|
|
} catch {
|
|
return {
|
|
name: entry.name,
|
|
path: fullPath,
|
|
type: "directory" as const,
|
|
size: undefined,
|
|
modifiedAt: undefined,
|
|
};
|
|
}
|
|
}),
|
|
);
|
|
|
|
return {
|
|
directories: directories.sort((a, b) => a.name.localeCompare(b.name)),
|
|
path: normalizedPath,
|
|
};
|
|
} catch (error) {
|
|
throw new InternalServerError(`Failed to browse filesystem: ${toMessage(error)}`);
|
|
}
|
|
};
|
|
|
|
export const volumeService = {
|
|
listVolumes,
|
|
createVolume,
|
|
mountVolume,
|
|
deleteVolume,
|
|
getVolume,
|
|
updateVolume,
|
|
testConnection,
|
|
unmountVolume,
|
|
checkHealth,
|
|
getContainersUsingVolume,
|
|
listFiles,
|
|
browseFilesystem,
|
|
};
|