From da3f865450af07b8bda1d5abc12e682bd6590757 Mon Sep 17 00:00:00 2001 From: Varun Date: Mon, 6 Apr 2026 09:42:42 +0530 Subject: [PATCH] feat: api key fix and the import status and history dialog Signed-off-by: Varun --- .claude/settings.json | 6 + .../import/ImportJobDetailDialog.tsx | 164 ++++++++++++++++++ src/config/routes.ts | 3 + src/handlers/api/import-jobs.handler.ts | 18 ++ .../api/validate-permissions.handler.ts | 10 ++ src/pages/api/import-jobs/index.ts | 17 +- src/pages/api/validate-permissions.ts | 33 ++++ src/pages/assets/import-shared.tsx | 109 +++++++++++- .../import/processors/immich-shared-link.ts | 27 ++- src/workers/import/runner.ts | 13 +- 10 files changed, 384 insertions(+), 16 deletions(-) create mode 100644 .claude/settings.json create mode 100644 src/components/import/ImportJobDetailDialog.tsx create mode 100644 src/handlers/api/validate-permissions.handler.ts create mode 100644 src/pages/api/validate-permissions.ts diff --git a/.claude/settings.json b/.claude/settings.json new file mode 100644 index 0000000..671a084 --- /dev/null +++ b/.claude/settings.json @@ -0,0 +1,6 @@ +{ + "attribution": { + "commit": "", + "pr": "" + } +} diff --git a/src/components/import/ImportJobDetailDialog.tsx b/src/components/import/ImportJobDetailDialog.tsx new file mode 100644 index 0000000..e1abd74 --- /dev/null +++ b/src/components/import/ImportJobDetailDialog.tsx @@ -0,0 +1,164 @@ +import React from "react"; +import { useQuery } from "@tanstack/react-query"; +import { ExternalLink, Loader2 } from "lucide-react"; +import { + Dialog, + DialogContent, + DialogHeader, + DialogTitle, +} from "@/components/ui/dialog"; +import { getImportJob } from "@/handlers/api/import-jobs.handler"; +import { useConfig } from "@/contexts/ConfigContext"; + +const InfoRow = ({ label, value }: { label: string; value: React.ReactNode }) => ( +
+

{label}

+

{value ?? "โ€”"}

+
+); + +const statusBadge = (status: string) => { + const styles = + status === "uploaded" || status === "completed" + ? "bg-emerald-500/10 text-emerald-600" + : status === "skipped" + ? "bg-amber-500/10 text-amber-600" + : status === "failed" + ? "bg-destructive/10 text-destructive" + : "bg-muted text-muted-foreground"; + + return ( + + {status} + + ); +}; + +interface ImportJobDetailDialogProps { + jobId: string | null; + onClose: () => void; +} + +export default function ImportJobDetailDialog({ jobId, onClose }: ImportJobDetailDialogProps) { + const { exImmichUrl } = useConfig(); + + const { data: detailJob, isLoading } = useQuery({ + queryKey: ["import-job-detail", jobId], + queryFn: () => getImportJob(jobId!), + enabled: !!jobId, + }); + + let dImportData: Record = {}; + let dAlbumOpts: { createAlbum?: boolean; albumName?: string; addToAlbumId?: string } | undefined; + let dError: string | null = null; + let albumId: string | undefined; + + if (detailJob) { + try { + dImportData = JSON.parse(detailJob.job.importData); + } catch { /* ignore */ } + dAlbumOpts = dImportData.albumOptions as typeof dAlbumOpts; + dError = typeof dImportData.error === "string" ? dImportData.error : null; + albumId = typeof dImportData.albumId === "string" ? dImportData.albumId : undefined; + } + + return ( + { if (!open) onClose(); }}> + + {isLoading && ( +
+ +
+ )} + {detailJob && (() => { + const dJob = detailJob.job; + + return ( + <> + + {dAlbumOpts?.albumName || "Import details"} + + +
+ + + + + + + {albumId && ( + + {dAlbumOpts?.albumName || albumId} + + + } /> + )} + {!albumId && dAlbumOpts?.albumName && ( + + )} +
+ + {dError && ( +
+ {dError} +
+ )} + +
+ + + + + + + + + + {detailJob.items.map((item) => { + let itemData: Record = {}; + try { itemData = JSON.parse(item.itemData ?? "{}"); } catch { /* ignore */ } + const fileName = (itemData.originalFileName as string) || item.assetId; + + return ( + + + + + + ); + })} + +
AssetStatusDetails
+ {item.immichId ? ( + e.stopPropagation()} + > + {fileName} + + + ) : ( + fileName + )} + + {statusBadge(item.status)} + + {item.error || "โ€”"} +
+
+ + ); + })()} +
+
+ ); +} diff --git a/src/config/routes.ts b/src/config/routes.ts index 5aebadb..9067511 100644 --- a/src/config/routes.ts +++ b/src/config/routes.ts @@ -96,6 +96,9 @@ export const SHARE_KEY_PATH = BASE_API_ENDPOINT + "/share-key"; export const IMPORT_SHARED_PATH = BASE_API_ENDPOINT + "/import-shared"; export const IMPORT_SHARED_UPLOAD_ALL_PATH = BASE_API_ENDPOINT + "/import-shared/upload-all"; +// Permissions +export const VALIDATE_PERMISSIONS_PATH = BASE_API_ENDPOINT + "/validate-permissions"; + // Import Jobs (queue) export const IMPORT_JOBS_PATH = BASE_API_ENDPOINT + "/import-jobs"; export const IMPORT_JOB_PATH = (jobId: string) => BASE_API_ENDPOINT + "/import-jobs/" + jobId; \ No newline at end of file diff --git a/src/handlers/api/import-jobs.handler.ts b/src/handlers/api/import-jobs.handler.ts index f2c2690..3f27132 100644 --- a/src/handlers/api/import-jobs.handler.ts +++ b/src/handlers/api/import-jobs.handler.ts @@ -13,6 +13,23 @@ export const createImportJob = async (params: CreateImportJobParams): Promise<{ return API.post(IMPORT_JOBS_PATH, params); }; +export interface ImportJobSummary { + id: string; + platform: string; + status: string; + url: string; + importData: string; + totalCount: number; + uploadedCount: number; + skippedCount: number; + failedCount: number; + createdAt: string; +} + +export const listImportJobs = async (): Promise<{ jobs: ImportJobSummary[] }> => { + return API.get(IMPORT_JOBS_PATH); +}; + export interface ImportJobStatus { job: { id: string; @@ -28,6 +45,7 @@ export interface ImportJobStatus { id: string; assetId: string; status: string; + itemData: string; immichId: string | null; error: string | null; }[]; diff --git a/src/handlers/api/validate-permissions.handler.ts b/src/handlers/api/validate-permissions.handler.ts new file mode 100644 index 0000000..c37f59c --- /dev/null +++ b/src/handlers/api/validate-permissions.handler.ts @@ -0,0 +1,10 @@ +import { VALIDATE_PERMISSIONS_PATH } from "@/config/routes"; +import API from "@/lib/api"; + +export interface PermissionsResult { + canUpload: boolean; +} + +export const validatePermissions = async (): Promise => { + return API.get(VALIDATE_PERMISSIONS_PATH); +}; diff --git a/src/pages/api/import-jobs/index.ts b/src/pages/api/import-jobs/index.ts index a1dfe0e..b0c6590 100644 --- a/src/pages/api/import-jobs/index.ts +++ b/src/pages/api/import-jobs/index.ts @@ -1,4 +1,5 @@ import type { NextApiRequest, NextApiResponse } from "next"; +import { desc, eq } from "drizzle-orm"; import { appDb } from "@/db"; import { importJobs, importJobItems } from "@/db/schema"; import { getCurrentUser } from "@/handlers/serverUtils/user.utils"; @@ -7,8 +8,22 @@ import { runImportJob } from "@/workers/import/runner"; import { getProcessor } from "@/workers/import/registry"; export default async function handler(req: NextApiRequest, res: NextApiResponse) { + if (req.method === "GET") { + const currentUser = await getCurrentUser(req); + if (!currentUser) return res.status(401).json({ error: "Unauthorized" }); + + const jobs = await appDb + .select() + .from(importJobs) + .where(eq(importJobs.userId, currentUser.id)) + .orderBy(desc(importJobs.createdAt)) + .limit(20); + + return res.status(200).json({ jobs }); + } + if (req.method !== "POST") { - res.setHeader("Allow", "POST"); + res.setHeader("Allow", "GET, POST"); return res.status(405).json({ error: "Method Not Allowed" }); } diff --git a/src/pages/api/validate-permissions.ts b/src/pages/api/validate-permissions.ts new file mode 100644 index 0000000..37959f9 --- /dev/null +++ b/src/pages/api/validate-permissions.ts @@ -0,0 +1,33 @@ +import type { NextApiRequest, NextApiResponse } from "next"; +import { ENV } from "@/config/environment"; +import { getCurrentUser } from "@/handlers/serverUtils/user.utils"; +import { getUserHeaders } from "@/helpers/user.helper"; + +export default async function handler(req: NextApiRequest, res: NextApiResponse) { + if (req.method !== "GET") { + return res.status(405).json({ message: "Method not allowed" }); + } + + const currentUser = await getCurrentUser(req); + if (!currentUser) { + return res.status(401).json({ message: "Unauthorized" }); + } + + const headers = getUserHeaders(currentUser, { "Content-Type": "application/json" }); + + const result = { canUpload: false }; + + // Test asset upload permission by calling a no-op endpoint + try { + const response = await fetch(`${ENV.IMMICH_URL}/api/assets/exist`, { + method: "POST", + headers, + body: JSON.stringify({ deviceAssetIds: ["permission-check"], deviceId: "immich-power-tools-check" }), + }); + result.canUpload = response.ok; + } catch { + result.canUpload = false; + } + + return res.status(200).json(result); +} diff --git a/src/pages/assets/import-shared.tsx b/src/pages/assets/import-shared.tsx index 7241049..95289c2 100644 --- a/src/pages/assets/import-shared.tsx +++ b/src/pages/assets/import-shared.tsx @@ -1,5 +1,6 @@ import React, { FormEvent, useEffect, useRef, useState } from "react"; -import { Calendar, Loader2, Images, User, Clock } from "lucide-react"; +import { useQuery } from "@tanstack/react-query"; +import { Calendar, Loader2, Images, User, Clock, CheckCircle2, XCircle, Clock3 } from "lucide-react"; import PageLayout from "@/components/layouts/PageLayout"; import Header from "@/components/shared/Header"; import { Button } from "@/components/ui/button"; @@ -22,8 +23,11 @@ import { } from "@/components/ui/dialog"; import { listAlbums } from "@/handlers/api/album.handler"; import { importShared } from "@/handlers/api/import-shared.handler"; -import { createImportJob, getImportJob } from "@/handlers/api/import-jobs.handler"; +import { createImportJob, getImportJob, listImportJobs } from "@/handlers/api/import-jobs.handler"; +import ImportJobDetailDialog from "@/components/import/ImportJobDetailDialog"; +import { validatePermissions } from "@/handlers/api/validate-permissions.handler"; import { IAlbum } from "@/types/album"; +import { AlertTriangle } from "lucide-react"; interface IAlbumContributorCount { userId: string; @@ -165,6 +169,22 @@ export default function ImportSharedPage() { const [selectedAlbumId, setSelectedAlbumId] = useState(null); const [activeJobId, setActiveJobId] = useState(null); const [jobProgress, setJobProgress] = useState<{ uploaded: number; skipped: number; failed: number; total: number } | null>(null); + const [tagAssets, setTagAssets] = useState(true); + const [detailJobId, setDetailJobId] = useState(null); + + const { data: permissions } = useQuery({ + queryKey: ["validate-permissions"], + queryFn: validatePermissions, + staleTime: 5 * 60 * 1000, + retry: false, + }); + + const { data: importHistory, refetch: refetchHistory } = useQuery({ + queryKey: ["import-jobs"], + queryFn: listImportJobs, + staleTime: 30 * 1000, + }); + const albumNameRef = useRef(albumNameInput); @@ -215,10 +235,12 @@ export default function ImportSharedPage() { const failedCount = job.failedCount; const skippedCount = job.skippedCount; const uploadedCount = job.uploadedCount; - const bannerType: "success" | "error" = failedCount > 0 ? "error" : "success"; + const bannerType: "success" | "error" = (failedCount > 0 || job.status === "failed") ? "error" : "success"; let message: string; - if (!uploadedCount && skippedCount && !failedCount) { + if (job.status === "failed" && importData.error && typeof importData.error === "string") { + message = importData.error; + } else if (!uploadedCount && skippedCount && !failedCount) { message = `All ${skippedCount} assets already exist on Immich.`; } else if (failedCount) { const skippedSuffix = skippedCount ? `, ${skippedCount} skipped` : ""; @@ -234,6 +256,7 @@ export default function ImportSharedPage() { } setUploadBanner({ type: bannerType, message }); + refetchHistory(); } } catch (err) { console.error("Polling error", err); @@ -362,7 +385,7 @@ export default function ImportSharedPage() { platform: "immich", url: sharedData.origin, urlConfig: { key: sharedData.key }, - importData: { albumOptions }, + importData: { albumOptions, tagAssets }, assets: uploadableAssets.map((asset) => ({ id: asset.id, originalFileName: asset.originalFileName, @@ -428,7 +451,8 @@ export default function ImportSharedPage() { disabled={ importAllLoading || importableAssetCount === 0 || - (albumImportMode === "existing-album" && !selectedAlbumId) + (albumImportMode === "existing-album" && !selectedAlbumId) || + (permissions && !permissions.canUpload) } onClick={() => { if (importAllLoading) return; @@ -452,6 +476,12 @@ export default function ImportSharedPage() { />
+ {permissions?.canUpload === false && ( +
+ + Your API key does not have permission to upload assets. Import will not work until this is fixed. +
+ )} {!sharedData && ( @@ -488,6 +518,60 @@ export default function ImportSharedPage() { )} + {!sharedData && importHistory?.jobs && importHistory.jobs.length > 0 && ( + + + Previous imports + + +
+ {importHistory.jobs.map((job) => { + let jobImportData: Record = {}; + try { jobImportData = JSON.parse(job.importData); } catch { /* ignore */ } + const albumOpts = jobImportData.albumOptions as { albumName?: string } | undefined; + const albumName = albumOpts?.albumName; + const statusIcon = job.status === "completed" ? ( + + ) : job.status === "failed" ? ( + + ) : ( + + ); + + return ( +
setDetailJobId(job.id)} + > + {statusIcon} +
+

+ {albumName || job.url} +

+

+ {job.uploadedCount} uploaded + {job.skippedCount > 0 && `, ${job.skippedCount} skipped`} + {job.failedCount > 0 && `, ${job.failedCount} failed`} + {" ยท "} + {formatDate(job.createdAt)} +

+
+ + {job.status} + +
+ ); + })} +
+
+
+ )} + {sharedLinkDetails && sharedData && albumDetails && ( {/* Album identity */} @@ -579,6 +663,18 @@ export default function ImportSharedPage() { )} +
+ setTagAssets(!!checked)} + disabled={importAllLoading} + /> + +
+ {importAllLoading && jobProgress && (
@@ -800,6 +896,7 @@ export default function ImportSharedPage() { )} + setDetailJobId(null)} /> ); } diff --git a/src/workers/import/processors/immich-shared-link.ts b/src/workers/import/processors/immich-shared-link.ts index e3eb9a3..3784d3a 100644 --- a/src/workers/import/processors/immich-shared-link.ts +++ b/src/workers/import/processors/immich-shared-link.ts @@ -111,6 +111,9 @@ const createImmichAlbum = async (albumName: string, headers: HeadersRecord): Pro body: JSON.stringify({ albumName }), }); if (!response.ok) { + if (response.status === 403) { + throw new Error(`Your API key does not have permission to create albums. Try importing without creating an album, or use an API key with album.create permission.`); + } const body = await response.text().catch(() => ""); throw new Error(`Failed to create album "${albumName}" (status ${response.status}): ${body || "Unknown error"}`); } @@ -159,7 +162,7 @@ const uploadAssetBuffer = async ( payload: DownloadedAssetPayload, uploadHeaders: HeadersRecord, jsonHeaders: HeadersRecord, - tagId: string + tagId?: string ): Promise => { const fileType = asset.type ?? inferAssetTypeFromName(payload.fileName); const resolvedFileName = payload.fileName || asset.originalFileName || `${asset.id}.bin`; @@ -200,8 +203,10 @@ const uploadAssetBuffer = async ( throw new Error("Immich upload response did not include an asset id"); } - const { tagAssetWithPowerTools } = await import("@/pages/api/import-shared/helpers"); - await tagAssetWithPowerTools(tagId, uploadedId, jsonHeaders); + if (tagId) { + const { tagAssetWithPowerTools } = await import("@/pages/api/import-shared/helpers"); + await tagAssetWithPowerTools(tagId, uploadedId, jsonHeaders); + } return uploadedId; }; @@ -285,10 +290,19 @@ export class ImmichSharedLinkProcessor implements ImportProcessor { albumId = albumOptions.addToAlbumId.trim(); } - const tag = await ensurePowerToolsTag({ ...context.headers, "Content-Type": "application/json" } as HeadersRecord); const importDataPatch: Record = {}; if (albumId) importDataPatch.albumId = albumId; - importDataPatch.tagId = tag.id; + + // Tag assets with "immich-power-tools" if enabled + const tagAssets = importData.tagAssets !== false; // default true for backwards compat + if (tagAssets) { + try { + const tag = await ensurePowerToolsTag({ ...context.headers, "Content-Type": "application/json" } as HeadersRecord); + importDataPatch.tagId = tag.id; + } catch (err) { + console.warn("[ImmichSharedLinkProcessor] Failed to create power-tools tag, skipping tagging", err); + } + } return { skipAssetIds, albumId, importDataPatch }; } @@ -333,10 +347,9 @@ export class ImmichSharedLinkProcessor implements ImportProcessor { // Strip Content-Type for multipart upload (same pattern as upload-all.ts) const { ["Content-Type"]: _omit, ...uploadHeaders } = headers; - // Read tagId from importData set during setup() + // Read tagId from importData set during setup() (optional) const importData = JSON.parse(job.importData) as { albumId?: string; tagId?: string }; const tagId = importData.tagId; - if (!tagId) throw new Error("tagId missing from job importData โ€” setup() may not have completed"); const immichId = await uploadAssetBuffer(asset, downloaded, uploadHeaders as HeadersRecord, headers as HeadersRecord, tagId); diff --git a/src/workers/import/runner.ts b/src/workers/import/runner.ts index 476b38b..c3b7dcd 100644 --- a/src/workers/import/runner.ts +++ b/src/workers/import/runner.ts @@ -76,10 +76,12 @@ export async function runImportJob( if (importDataPatch) { const merged = { ...JSON.parse(job.importData), ...importDataPatch }; + const mergedStr = JSON.stringify(merged); await appDb .update(importJobs) - .set({ importData: JSON.stringify(merged) }) + .set({ importData: mergedStr }) .where(eq(importJobs.id, jobId)); + job.importData = mergedStr; } if (skipAssetIds.length > 0) { @@ -151,9 +153,16 @@ export async function runImportJob( .where(eq(importJobs.id, jobId)); } catch (err: any) { console.error(`Import job ${jobId} failed fatally:`, err); + // Store error message in importData so the UI can display it + let existingData: Record = {}; + try { + const [current] = await appDb.select({ importData: importJobs.importData }).from(importJobs).where(eq(importJobs.id, jobId)); + if (current) existingData = JSON.parse(current.importData); + } catch { /* ignore */ } + existingData.error = err?.message ?? "Unknown error"; await appDb .update(importJobs) - .set({ status: "failed" }) + .set({ status: "failed", importData: JSON.stringify(existingData) }) .where(eq(importJobs.id, jobId)); } finally { activeJobs.delete(jobId);