refactor: use short ids to allow changing the name of volumes & repos (#67)

* 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

app/server/modules/repositories/repositories.controller.ts

@@ -16,6 +16,8 @@ import {
 	listSnapshotsFilters,
 	restoreSnapshotBody,
 	restoreSnapshotDto,
+	updateRepositoryBody,
+	updateRepositoryDto,
 	type DeleteRepositoryDto,
 	type DeleteSnapshotDto,
 	type DoctorRepositoryDto,
@@ -25,6 +27,7 @@ import {
 	type ListSnapshotFilesDto,
 	type ListSnapshotsDto,
 	type RestoreSnapshotDto,
+	type UpdateRepositoryDto,
 } from "./repositories.dto";
 import { repositoriesService } from "./repositories.service";
 import { getRcloneRemoteInfo, listRcloneRemotes } from "../../utils/rclone";
@@ -152,4 +155,12 @@ export const repositoriesController = new Hono()
 		await repositoriesService.deleteSnapshot(name, snapshotId);
 
 		return c.json<DeleteSnapshotDto>({ message: "Snapshot deleted" }, 200);
+	})
+	.patch("/:name", updateRepositoryDto, validator("json", updateRepositoryBody), async (c) => {
+		const { name } = c.req.param();
+		const body = c.req.valid("json");
+
+		const res = await repositoriesService.updateRepository(name, body);
+
+		return c.json<UpdateRepositoryDto>(res.repository, 200);
 	});

app/server/modules/repositories/repositories.dto.ts

@@ -4,6 +4,7 @@ import { COMPRESSION_MODES, REPOSITORY_BACKENDS, REPOSITORY_STATUS, repositoryCo
 
 export const repositorySchema = type({
 	id: "string",
+	shortId: "string",
 	name: "string",
 	type: type.valueOf(REPOSITORY_BACKENDS),
 	config: repositoryConfigSchema,
@@ -123,6 +124,41 @@ export const deleteRepositoryDto = describeRoute({
 	},
 });
 
+/**
+ * Update a repository
+ */
+export const updateRepositoryBody = type({
+	name: "string?",
+	compressionMode: type.valueOf(COMPRESSION_MODES).optional(),
+});
+
+export type UpdateRepositoryBody = typeof updateRepositoryBody.infer;
+
+export const updateRepositoryResponse = repositorySchema;
+export type UpdateRepositoryDto = typeof updateRepositoryResponse.infer;
+
+export const updateRepositoryDto = describeRoute({
+	description: "Update a repository's name or settings",
+	tags: ["Repositories"],
+	operationId: "updateRepository",
+	responses: {
+		200: {
+			description: "Repository updated successfully",
+			content: {
+				"application/json": {
+					schema: resolver(updateRepositoryResponse),
+				},
+			},
+		},
+		404: {
+			description: "Repository not found",
+		},
+		409: {
+			description: "Repository with this name already exists",
+		},
+	},
+});
+
 /**
  * List snapshots in a repository
  */

app/server/modules/repositories/repositories.service.ts

@@ -1,10 +1,11 @@
 import crypto from "node:crypto";
-import { eq } from "drizzle-orm";
+import { and, eq, ne } from "drizzle-orm";
 import { ConflictError, InternalServerError, NotFoundError } from "http-errors-enhanced";
 import slugify from "slugify";
 import { db } from "../../db/db";
 import { repositoriesTable } from "../../db/schema";
 import { toMessage } from "../../utils/errors";
+import { generateShortId } from "../../utils/id";
 import { restic } from "../../utils/restic";
 import { cryptoUtils } from "../../utils/crypto";
 import type { CompressionMode, RepositoryConfig } from "~/schemas/restic";
@@ -61,13 +62,20 @@ const createRepository = async (name: string, config: RepositoryConfig, compress
 	}
 
 	const id = crypto.randomUUID();
+	const shortId = generateShortId();
 
-	const encryptedConfig = await encryptConfig(config);
+	let processedConfig = config;
+	if (config.backend === "local") {
+		processedConfig = { ...config, name: shortId };
+	}
+
+	const encryptedConfig = await encryptConfig(processedConfig);
 
 	const [created] = await db
 		.insert(repositoriesTable)
 		.values({
 			id,
+			shortId,
 			name: slug,
 			type: config.backend,
 			config: encryptedConfig,
@@ -350,11 +358,53 @@ const deleteSnapshot = async (name: string, snapshotId: string) => {
 	await restic.deleteSnapshot(repository.config, snapshotId);
 };
 
+const updateRepository = async (name: string, updates: { name?: string; compressionMode?: CompressionMode }) => {
+	const existing = await db.query.repositoriesTable.findFirst({
+		where: eq(repositoriesTable.name, name),
+	});
+
+	if (!existing) {
+		throw new NotFoundError("Repository not found");
+	}
+
+	let newName = existing.name;
+	if (updates.name !== undefined && updates.name !== existing.name) {
+		const newSlug = slugify(updates.name, { lower: true, strict: true });
+
+		const conflict = await db.query.repositoriesTable.findFirst({
+			where: and(eq(repositoriesTable.name, newSlug), ne(repositoriesTable.id, existing.id)),
+		});
+
+		if (conflict) {
+			throw new ConflictError("A repository with this name already exists");
+		}
+
+		newName = newSlug;
+	}
+
+	const [updated] = await db
+		.update(repositoriesTable)
+		.set({
+			name: newName,
+			compressionMode: updates.compressionMode ?? existing.compressionMode,
+			updatedAt: Math.floor(Date.now() / 1000),
+		})
+		.where(eq(repositoriesTable.id, existing.id))
+		.returning();
+
+	if (!updated) {
+		throw new InternalServerError("Failed to update repository");
+	}
+
+	return { repository: updated };
+};
+
 export const repositoriesService = {
 	listRepositories,
 	createRepository,
 	getRepository,
 	deleteRepository,
+	updateRepository,
 	listSnapshots,
 	listSnapshotFiles,
 	restoreSnapshot,