aboutsummaryrefslogtreecommitdiffstats
path: root/packages/trpc/routers/admin.ts
diff options
context:
space:
mode:
authorMohamed Bassem <me@mbassem.com>2026-01-11 09:27:35 +0000
committerGitHub <noreply@github.com>2026-01-11 09:27:35 +0000
commit0f9132b5a9186accd991492b73b9ef904342df29 (patch)
tree4050d433cddc5092dc4dcfc2fae29deef4f0028f /packages/trpc/routers/admin.ts
parent0e938c14044f66f7ad0ffe3eeda5fa8969a83849 (diff)
downloadkarakeep-0f9132b5a9186accd991492b73b9ef904342df29.tar.zst
feat: privacy-respecting bookmark debugger admin tool (#2373)
* fix: parallelize queue enqueues in bookmark routes * fix: guard meilisearch client init with mutex * feat: add bookmark debugging admin tool * more fixes * more fixes * more fixes
Diffstat (limited to 'packages/trpc/routers/admin.ts')
-rw-r--r--packages/trpc/routers/admin.ts172
1 files changed, 172 insertions, 0 deletions
diff --git a/packages/trpc/routers/admin.ts b/packages/trpc/routers/admin.ts
index 44a51cad..3236529d 100644
--- a/packages/trpc/routers/admin.ts
+++ b/packages/trpc/routers/admin.ts
@@ -17,6 +17,7 @@ import {
zAdminMaintenanceTaskSchema,
} from "@karakeep/shared-server";
import serverConfig from "@karakeep/shared/config";
+import logger from "@karakeep/shared/logger";
import { PluginManager, PluginType } from "@karakeep/shared/plugins";
import { getSearchClient } from "@karakeep/shared/search";
import {
@@ -24,9 +25,11 @@ import {
updateUserSchema,
zAdminCreateUserSchema,
} from "@karakeep/shared/types/admin";
+import { BookmarkTypes } from "@karakeep/shared/types/bookmarks";
import { generatePasswordSalt, hashPassword } from "../auth";
import { adminProcedure, router } from "../index";
+import { Bookmark } from "../models/bookmarks";
import { User } from "../models/users";
export const adminAppRouter = router({
@@ -558,4 +561,173 @@ export const adminAppRouter = router({
queue: queueStatus,
};
}),
+ getBookmarkDebugInfo: adminProcedure
+ .input(z.object({ bookmarkId: z.string() }))
+ .output(
+ z.object({
+ id: z.string(),
+ type: z.enum([
+ BookmarkTypes.LINK,
+ BookmarkTypes.TEXT,
+ BookmarkTypes.ASSET,
+ ]),
+ source: z
+ .enum([
+ "api",
+ "web",
+ "extension",
+ "cli",
+ "mobile",
+ "singlefile",
+ "rss",
+ "import",
+ ])
+ .nullable(),
+ createdAt: z.date(),
+ modifiedAt: z.date().nullable(),
+ title: z.string().nullable(),
+ summary: z.string().nullable(),
+ taggingStatus: z.enum(["pending", "failure", "success"]).nullable(),
+ summarizationStatus: z
+ .enum(["pending", "failure", "success"])
+ .nullable(),
+ userId: z.string(),
+ linkInfo: z
+ .object({
+ url: z.string(),
+ crawlStatus: z.enum(["pending", "failure", "success"]),
+ crawlStatusCode: z.number().nullable(),
+ crawledAt: z.date().nullable(),
+ hasHtmlContent: z.boolean(),
+ hasContentAsset: z.boolean(),
+ htmlContentPreview: z.string().nullable(),
+ })
+ .nullable(),
+ textInfo: z
+ .object({
+ hasText: z.boolean(),
+ sourceUrl: z.string().nullable(),
+ })
+ .nullable(),
+ assetInfo: z
+ .object({
+ assetType: z.enum(["image", "pdf"]),
+ hasContent: z.boolean(),
+ fileName: z.string().nullable(),
+ })
+ .nullable(),
+ tags: z.array(
+ z.object({
+ id: z.string(),
+ name: z.string(),
+ attachedBy: z.enum(["ai", "human"]),
+ }),
+ ),
+ assets: z.array(
+ z.object({
+ id: z.string(),
+ assetType: z.string(),
+ size: z.number(),
+ url: z.string().nullable(),
+ }),
+ ),
+ }),
+ )
+ .query(async ({ input, ctx }) => {
+ logger.info(
+ `[admin] Admin ${ctx.user.id} accessed debug info for bookmark ${input.bookmarkId}`,
+ );
+
+ return await Bookmark.buildDebugInfo(ctx, input.bookmarkId);
+ }),
+ adminRecrawlBookmark: adminProcedure
+ .input(z.object({ bookmarkId: z.string() }))
+ .mutation(async ({ input, ctx }) => {
+ // Verify bookmark exists and is a link
+ const bookmark = await ctx.db.query.bookmarks.findFirst({
+ where: eq(bookmarks.id, input.bookmarkId),
+ });
+
+ if (!bookmark) {
+ throw new TRPCError({
+ code: "NOT_FOUND",
+ message: "Bookmark not found",
+ });
+ }
+
+ if (bookmark.type !== BookmarkTypes.LINK) {
+ throw new TRPCError({
+ code: "BAD_REQUEST",
+ message: "Only link bookmarks can be recrawled",
+ });
+ }
+
+ await LinkCrawlerQueue.enqueue({
+ bookmarkId: input.bookmarkId,
+ });
+ }),
+ adminReindexBookmark: adminProcedure
+ .input(z.object({ bookmarkId: z.string() }))
+ .mutation(async ({ input, ctx }) => {
+ // Verify bookmark exists
+ const bookmark = await ctx.db.query.bookmarks.findFirst({
+ where: eq(bookmarks.id, input.bookmarkId),
+ });
+
+ if (!bookmark) {
+ throw new TRPCError({
+ code: "NOT_FOUND",
+ message: "Bookmark not found",
+ });
+ }
+
+ await triggerSearchReindex(input.bookmarkId);
+ }),
+ adminRetagBookmark: adminProcedure
+ .input(z.object({ bookmarkId: z.string() }))
+ .mutation(async ({ input, ctx }) => {
+ // Verify bookmark exists
+ const bookmark = await ctx.db.query.bookmarks.findFirst({
+ where: eq(bookmarks.id, input.bookmarkId),
+ });
+
+ if (!bookmark) {
+ throw new TRPCError({
+ code: "NOT_FOUND",
+ message: "Bookmark not found",
+ });
+ }
+
+ await OpenAIQueue.enqueue({
+ bookmarkId: input.bookmarkId,
+ type: "tag",
+ });
+ }),
+ adminResummarizeBookmark: adminProcedure
+ .input(z.object({ bookmarkId: z.string() }))
+ .mutation(async ({ input, ctx }) => {
+ // Verify bookmark exists and is a link
+ const bookmark = await ctx.db.query.bookmarks.findFirst({
+ where: eq(bookmarks.id, input.bookmarkId),
+ });
+
+ if (!bookmark) {
+ throw new TRPCError({
+ code: "NOT_FOUND",
+ message: "Bookmark not found",
+ });
+ }
+
+ if (bookmark.type !== BookmarkTypes.LINK) {
+ throw new TRPCError({
+ code: "BAD_REQUEST",
+ message: "Only link bookmarks can be summarized",
+ });
+ }
+
+ await OpenAIQueue.enqueue({
+ bookmarkId: input.bookmarkId,
+ type: "summarize",
+ });
+ }),
});