Some checks failed
Release Workflow / checks (push) Has been cancelled
Release Workflow / e2e-tests (push) Has been cancelled
Release Workflow / determine-release-type (push) Has been cancelled
Release Workflow / build-images (push) Has been cancelled
Release Workflow / publish-release (push) Has been cancelled
480 lines
13 KiB
TypeScript
480 lines
13 KiB
TypeScript
import * as fs from "node:fs/promises";
|
|
import * as os from "node:os";
|
|
import * as path from "node:path";
|
|
import { and, eq } from "drizzle-orm";
|
|
import { BadRequestError, InternalServerError, NotFoundError } from "http-errors-enhanced";
|
|
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 "@zerobyte/core/node";
|
|
import { serverEvents } from "../../core/events";
|
|
import type { Volume } from "../../db/schema";
|
|
import { volumeConfigSchema, type BackendConfig } from "~/schemas/volumes";
|
|
import { getOrganizationId } from "~/server/core/request-context";
|
|
import { isNodeJSErrnoException } from "~/server/utils/fs";
|
|
import { asShortId, type ShortId } from "~/server/utils/branded";
|
|
import { encryptVolumeConfig } from "./volume-config-secrets";
|
|
|
|
type EnsureHealthyVolumeResult =
|
|
| {
|
|
ready: true;
|
|
volume: Volume;
|
|
remounted: boolean;
|
|
}
|
|
| {
|
|
ready: false;
|
|
volume: Volume;
|
|
reason: string;
|
|
};
|
|
|
|
const listVolumes = async () => {
|
|
const organizationId = getOrganizationId();
|
|
const volumes = await db.query.volumesTable.findMany({
|
|
where: { organizationId: organizationId },
|
|
orderBy: { id: "asc" },
|
|
});
|
|
|
|
return volumes;
|
|
};
|
|
|
|
const findVolume = async (shortId: ShortId) => {
|
|
const organizationId = getOrganizationId();
|
|
return await db.query.volumesTable.findFirst({
|
|
where: {
|
|
AND: [{ shortId: { eq: shortId } }, { organizationId: organizationId }],
|
|
},
|
|
});
|
|
};
|
|
|
|
const createVolume = async (name: string, backendConfig: BackendConfig) => {
|
|
const organizationId = getOrganizationId();
|
|
const trimmedName = name.trim();
|
|
|
|
if (trimmedName.length === 0) {
|
|
throw new BadRequestError("Volume name cannot be empty");
|
|
}
|
|
|
|
const shortId = generateShortId();
|
|
const encryptedConfig = await encryptVolumeConfig(backendConfig);
|
|
|
|
const [created] = await db
|
|
.insert(volumesTable)
|
|
.values({
|
|
shortId,
|
|
name: trimmedName,
|
|
config: encryptedConfig,
|
|
type: backendConfig.backend,
|
|
organizationId,
|
|
})
|
|
.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(and(eq(volumesTable.id, created.id), eq(volumesTable.organizationId, organizationId)));
|
|
|
|
return { volume: created, status: 201 };
|
|
};
|
|
|
|
const deleteVolume = async (shortId: ShortId) => {
|
|
const organizationId = getOrganizationId();
|
|
const volume = await findVolume(shortId);
|
|
|
|
if (!volume) {
|
|
throw new NotFoundError("Volume not found");
|
|
}
|
|
|
|
const backend = createVolumeBackend(volume);
|
|
await backend.unmount();
|
|
await db
|
|
.delete(volumesTable)
|
|
.where(and(eq(volumesTable.id, volume.id), eq(volumesTable.organizationId, organizationId)));
|
|
};
|
|
|
|
const mountVolume = async (shortId: ShortId) => {
|
|
const organizationId = getOrganizationId();
|
|
const volume = await findVolume(shortId);
|
|
|
|
if (!volume) {
|
|
throw new NotFoundError("Volume not found");
|
|
}
|
|
|
|
const backend = createVolumeBackend(volume);
|
|
await backend.unmount();
|
|
const { error, status } = await backend.mount();
|
|
|
|
await db
|
|
.update(volumesTable)
|
|
.set({ status, lastError: error ?? null, lastHealthCheck: Date.now() })
|
|
.where(and(eq(volumesTable.id, volume.id), eq(volumesTable.organizationId, organizationId)));
|
|
|
|
if (status === "mounted") {
|
|
serverEvents.emit("volume:mounted", { organizationId, volumeName: volume.name });
|
|
}
|
|
|
|
return { error, status };
|
|
};
|
|
|
|
const unmountVolume = async (shortId: ShortId) => {
|
|
const organizationId = getOrganizationId();
|
|
const volume = await findVolume(shortId);
|
|
|
|
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(and(eq(volumesTable.id, volume.id), eq(volumesTable.organizationId, organizationId)));
|
|
|
|
if (status === "unmounted") {
|
|
serverEvents.emit("volume:unmounted", { organizationId, volumeName: volume.name });
|
|
}
|
|
|
|
return { error, status };
|
|
};
|
|
|
|
const getVolume = async (shortId: ShortId) => {
|
|
const volume = await findVolume(shortId);
|
|
|
|
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 ${volume.name}: ${toMessage(error)}`);
|
|
return {};
|
|
});
|
|
}
|
|
|
|
return { volume, statfs };
|
|
};
|
|
|
|
const updateVolume = async (shortId: ShortId, volumeData: UpdateVolumeBody) => {
|
|
const organizationId = getOrganizationId();
|
|
const existing = await findVolume(shortId);
|
|
|
|
if (!existing) {
|
|
throw new NotFoundError("Volume not found");
|
|
}
|
|
|
|
const newName = volumeData.name !== undefined ? volumeData.name.trim() : existing.name;
|
|
|
|
if (newName.length === 0) {
|
|
throw new BadRequestError("Volume name cannot be empty");
|
|
}
|
|
|
|
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 newConfigResult = volumeConfigSchema.safeParse(volumeData.config || existing.config);
|
|
if (!newConfigResult.success) {
|
|
throw new BadRequestError("Invalid volume configuration");
|
|
}
|
|
const newConfig = newConfigResult.data;
|
|
|
|
const encryptedConfig = await encryptVolumeConfig(newConfig);
|
|
|
|
const [updated] = await db
|
|
.update(volumesTable)
|
|
.set({
|
|
name: newName,
|
|
config: encryptedConfig,
|
|
type: volumeData.config?.backend,
|
|
autoRemount: volumeData.autoRemount,
|
|
updatedAt: Date.now(),
|
|
})
|
|
.where(and(eq(volumesTable.id, existing.id), eq(volumesTable.organizationId, organizationId)))
|
|
.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(and(eq(volumesTable.id, existing.id), eq(volumesTable.organizationId, organizationId)));
|
|
|
|
serverEvents.emit("volume:updated", { organizationId, volumeName: updated.name });
|
|
}
|
|
|
|
return { volume: updated };
|
|
};
|
|
|
|
const testConnection = async (backendConfig: BackendConfig) => {
|
|
const tempDir = await fs.mkdtemp(path.join(os.tmpdir(), "zerobyte-test-"));
|
|
try {
|
|
const encryptedConfig = await encryptVolumeConfig(backendConfig);
|
|
|
|
const mockVolume = {
|
|
id: 0,
|
|
shortId: asShortId("test"),
|
|
name: "test-connection",
|
|
config: encryptedConfig,
|
|
createdAt: Date.now(),
|
|
updatedAt: Date.now(),
|
|
lastHealthCheck: Date.now(),
|
|
type: encryptedConfig.backend,
|
|
status: "unmounted" as const,
|
|
lastError: null,
|
|
provisioningId: null,
|
|
autoRemount: true,
|
|
organizationId: "test-org",
|
|
};
|
|
|
|
const backend = createVolumeBackend(mockVolume, tempDir);
|
|
const { error } = await backend.mount();
|
|
|
|
await backend.unmount();
|
|
|
|
return {
|
|
success: !error,
|
|
message: error ? toMessage(error) : "Connection successful",
|
|
};
|
|
} finally {
|
|
await fs.rm(tempDir, { recursive: true, force: true });
|
|
}
|
|
};
|
|
|
|
const checkHealth = async (shortId: ShortId) => {
|
|
const organizationId = getOrganizationId();
|
|
const volume = await findVolume(shortId);
|
|
|
|
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", { organizationId, volumeName: volume.name, status });
|
|
}
|
|
|
|
await db
|
|
.update(volumesTable)
|
|
.set({ lastHealthCheck: Date.now(), status, lastError: error ?? null })
|
|
.where(and(eq(volumesTable.id, volume.id), eq(volumesTable.organizationId, organizationId)));
|
|
|
|
return { status, error };
|
|
};
|
|
|
|
const ensureHealthyVolume = async (shortId: ShortId): Promise<EnsureHealthyVolumeResult> => {
|
|
const volume = await findVolume(shortId);
|
|
|
|
if (!volume) {
|
|
throw new NotFoundError("Volume not found");
|
|
}
|
|
|
|
if (volume.status === "unmounted") {
|
|
return { ready: false, volume, reason: volume.lastError ?? "Volume is not mounted" };
|
|
}
|
|
|
|
let failureReason = volume.lastError ?? "Volume health check failed";
|
|
let failedVolume = volume;
|
|
|
|
if (volume.status !== "error") {
|
|
const health = await checkHealth(shortId);
|
|
|
|
if (health.status === "mounted") {
|
|
return {
|
|
ready: true,
|
|
volume: { ...volume, status: "mounted", lastError: null },
|
|
remounted: false,
|
|
};
|
|
}
|
|
|
|
failureReason = health.error ?? failureReason;
|
|
failedVolume = { ...volume, status: "error", lastError: health.error ?? null };
|
|
}
|
|
|
|
if (!volume.autoRemount) {
|
|
return { ready: false, volume: failedVolume, reason: failureReason };
|
|
}
|
|
|
|
logger.warn(
|
|
`${volume.name} is not healthy. Auto-remount is enabled, attempting to remount. Reason: ${failureReason}`,
|
|
);
|
|
const remount = await mountVolume(shortId);
|
|
|
|
if (remount.status !== "mounted") {
|
|
return {
|
|
ready: false,
|
|
volume: { ...volume, status: remount.status, lastError: remount.error ?? null },
|
|
reason: remount.error ?? failureReason,
|
|
};
|
|
}
|
|
|
|
return {
|
|
ready: true,
|
|
volume: { ...volume, status: "mounted", lastError: null },
|
|
remounted: true,
|
|
};
|
|
};
|
|
|
|
const DEFAULT_PAGE_SIZE = 500;
|
|
const MAX_PAGE_SIZE = 500;
|
|
|
|
const listFiles = async (shortId: ShortId, subPath?: string, offset: number = 0, limit: number = DEFAULT_PAGE_SIZE) => {
|
|
const volume = await findVolume(shortId);
|
|
|
|
if (!volume) {
|
|
throw new NotFoundError("Volume not found");
|
|
}
|
|
|
|
if (volume.status !== "mounted") {
|
|
throw new InternalServerError("Volume is not mounted");
|
|
}
|
|
|
|
const volumePath = getVolumePath(volume);
|
|
const requestedPath = subPath ? path.join(volumePath, subPath) : volumePath;
|
|
const normalizedPath = path.normalize(requestedPath);
|
|
const relative = path.relative(volumePath, normalizedPath);
|
|
|
|
if (relative.startsWith("..") || path.isAbsolute(relative)) {
|
|
throw new BadRequestError("Invalid path");
|
|
}
|
|
|
|
const pageSize = Math.min(Math.max(limit, 1), MAX_PAGE_SIZE);
|
|
const startOffset = Math.max(offset, 0);
|
|
|
|
try {
|
|
const dirents = await fs.readdir(normalizedPath, { withFileTypes: true });
|
|
|
|
dirents.sort((a, b) => {
|
|
const aIsDir = a.isDirectory();
|
|
const bIsDir = b.isDirectory();
|
|
|
|
if (aIsDir === bIsDir) {
|
|
return a.name.localeCompare(b.name);
|
|
}
|
|
return aIsDir ? -1 : 1;
|
|
});
|
|
|
|
const total = dirents.length;
|
|
const paginatedDirents = dirents.slice(startOffset, startOffset + pageSize);
|
|
|
|
const entries = (
|
|
await Promise.all(
|
|
paginatedDirents.map(async (dirent) => {
|
|
const fullPath = path.join(normalizedPath, dirent.name);
|
|
|
|
try {
|
|
const stats = await fs.stat(fullPath);
|
|
const relativePath = path.relative(volumePath, fullPath);
|
|
|
|
return {
|
|
name: dirent.name,
|
|
path: `/${relativePath}`,
|
|
type: dirent.isDirectory() ? ("directory" as const) : ("file" as const),
|
|
size: dirent.isFile() ? stats.size : undefined,
|
|
modifiedAt: stats.mtimeMs,
|
|
};
|
|
} catch {
|
|
return null;
|
|
}
|
|
}),
|
|
)
|
|
).filter((e) => e !== null);
|
|
|
|
return {
|
|
files: entries,
|
|
path: subPath || "/",
|
|
offset: startOffset,
|
|
limit: pageSize,
|
|
total,
|
|
hasMore: startOffset + pageSize < total,
|
|
};
|
|
} catch (error) {
|
|
if (isNodeJSErrnoException(error) && error.code === "ENOENT") {
|
|
throw new NotFoundError("Directory not found");
|
|
}
|
|
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,
|
|
ensureHealthyVolume,
|
|
listFiles,
|
|
browseFilesystem,
|
|
};
|