feat: moderation modpack scan button (#6627)

* feat: moderation modpack scan button

* fix: ui

* fix: lint

---------

Co-authored-by: Calum H. (IMB11) <contact@cal.engineer>

apps/frontend/src/components/ui/moderation/ModpackScanModal.vue

@@ -0,0 +1,326 @@
+<script setup lang="ts">
+import type { Labrinth } from '@modrinth/api-client'
+import { FolderSearchIcon, StarIcon } from '@modrinth/assets'
+import {
+	ButtonStyled,
+	defineMessages,
+	injectModrinthClient,
+	NewModal,
+	Table,
+	type TableColumn,
+	useVIntl,
+} from '@modrinth/ui'
+import { computed, ref, useTemplateRef } from 'vue'
+
+const messages = defineMessages({
+	title: {
+		id: 'modpack-scan-modal.title',
+		defaultMessage: 'Modpack Scan ({scanned}/{total} Files)',
+	},
+	scanAllFiles: {
+		id: 'modpack-scan-modal.scan-all-files',
+		defaultMessage: 'Scan All Files',
+	},
+	packFileName: {
+		id: 'modpack-scan-modal.pack-file-name',
+		defaultMessage: 'Pack File Name',
+	},
+	newFiles: {
+		id: 'modpack-scan-modal.new-files',
+		defaultMessage: 'New Files',
+	},
+	newGroups: {
+		id: 'modpack-scan-modal.new-groups',
+		defaultMessage: 'New Groups',
+	},
+	loadingVersions: {
+		id: 'modpack-scan-modal.loading-versions',
+		defaultMessage: 'Loading versions...',
+	},
+	noFiles: {
+		id: 'modpack-scan-modal.no-files',
+		defaultMessage: 'No files found.',
+	},
+	notScanned: {
+		id: 'modpack-scan-modal.not-scanned',
+		defaultMessage: 'Not scanned',
+	},
+	scanning: {
+		id: 'modpack-scan-modal.scanning',
+		defaultMessage: 'Scanning...',
+	},
+	failed: {
+		id: 'modpack-scan-modal.failed',
+		defaultMessage: 'Failed',
+	},
+	overrideFiles: {
+		id: 'modpack-scan-modal.override-files',
+		defaultMessage: 'Override Files ({count})',
+	},
+	loadVersionsError: {
+		id: 'modpack-scan-modal.load-versions-error',
+		defaultMessage: 'Failed to load versions: {error}',
+	},
+	scanError: {
+		id: 'modpack-scan-modal.scan-error',
+		defaultMessage: 'Some files failed to scan: {error}',
+	},
+})
+
+type ScanTableColumn = 'filename' | 'newFiles' | 'newGroups'
+
+type ScanRow = {
+	id: string
+	filename: string
+	primary: boolean
+	scan?: Labrinth.Attribution.Internal.FileScanResponse
+	isScanning: boolean
+	error?: string
+	newFiles?: number
+	newGroups?: number
+}
+
+const props = defineProps<{
+	project_id: string
+}>()
+
+const client = injectModrinthClient()
+const modalRef = useTemplateRef<InstanceType<typeof NewModal>>('modalRef')
+const { formatMessage } = useVIntl()
+
+const rows = ref<ScanRow[]>([])
+const isLoadingVersions = ref(false)
+const isScanning = ref(false)
+const versionLoadError = ref<string | null>(null)
+const scanError = ref<string | null>(null)
+const requestId = ref(0)
+const scanRequestId = ref(0)
+
+const columns = computed<TableColumn<ScanTableColumn>[]>(() => [
+	{ key: 'filename', label: formatMessage(messages.packFileName), width: '60%' },
+	{ key: 'newFiles', label: formatMessage(messages.newFiles), align: 'center', width: '20%' },
+	{ key: 'newGroups', label: formatMessage(messages.newGroups), align: 'center', width: '20%' },
+])
+
+const scannedCount = computed(() => rows.value.filter((row) => row.scan || row.error).length)
+const isBusy = computed(() => isLoadingVersions.value || isScanning.value)
+
+function getErrorMessage(error: unknown) {
+	if (error instanceof Error) {
+		return error.message
+	}
+
+	if (typeof error === 'object' && error !== null && 'data' in error) {
+		const data = (error as { data?: { description?: string } }).data
+		if (data?.description) {
+			return data.description
+		}
+	}
+
+	return String(error)
+}
+
+async function fetchAllVersions() {
+	const currentRequestId = ++requestId.value
+	isLoadingVersions.value = true
+	versionLoadError.value = null
+	scanError.value = null
+	rows.value = []
+
+	try {
+		const versions = await client.labrinth.versions_v2.getProjectVersions(props.project_id)
+		if (currentRequestId !== requestId.value) {
+			return
+		}
+
+		rows.value = versions
+			.flatMap((version) => version.files)
+			.filter((file): file is Labrinth.Versions.v2.VersionFile & { id: string } => Boolean(file.id))
+			.map((file) => ({
+				id: file.id,
+				filename: file.filename,
+				primary: file.primary,
+				isScanning: false,
+				newFiles: undefined,
+				newGroups: undefined,
+			}))
+	} catch (error) {
+		if (currentRequestId === requestId.value) {
+			versionLoadError.value = formatMessage(messages.loadVersionsError, {
+				error: getErrorMessage(error),
+			})
+		}
+	} finally {
+		if (currentRequestId === requestId.value) {
+			isLoadingVersions.value = false
+		}
+	}
+}
+
+async function fetchAllScans() {
+	if (isBusy.value) {
+		return
+	}
+
+	const currentScanRequestId = ++scanRequestId.value
+	isScanning.value = true
+	scanError.value = null
+	rows.value = rows.value.map((row) => ({
+		...row,
+		scan: undefined,
+		isScanning: false,
+		error: undefined,
+		newFiles: undefined,
+		newGroups: undefined,
+	}))
+
+	try {
+		for (const row of rows.value) {
+			if (currentScanRequestId !== scanRequestId.value) {
+				return
+			}
+
+			row.isScanning = true
+			try {
+				const scan = await client.labrinth.attribution_internal.scanFile(row.id)
+				if (currentScanRequestId !== scanRequestId.value) {
+					return
+				}
+
+				row.scan = scan
+				row.newFiles = scan.new_attribution_files
+				row.newGroups = scan.new_attribution_groups
+			} catch (error) {
+				if (currentScanRequestId !== scanRequestId.value) {
+					return
+				}
+
+				row.error = getErrorMessage(error)
+				scanError.value = formatMessage(messages.scanError, { error: row.error })
+			} finally {
+				row.isScanning = false
+			}
+		}
+	} finally {
+		if (currentScanRequestId === scanRequestId.value) {
+			isScanning.value = false
+		}
+	}
+}
+
+function show() {
+	scanRequestId.value++
+	isScanning.value = false
+	rows.value = []
+	void fetchAllVersions()
+	modalRef.value?.show()
+}
+
+function hide() {
+	modalRef.value?.hide()
+}
+defineExpose({ show, hide })
+</script>
+
+<template>
+	<NewModal
+		ref="modalRef"
+		width="60vw"
+		:close-on-click-outside="false"
+		:close-on-esc="false"
+		:disable-close="isBusy"
+	>
+		<template #title>
+			<div class="flex w-full items-center justify-between gap-2">
+				<span class="text-2xl font-semibold text-contrast">
+					{{
+						formatMessage(messages.title, {
+							scanned: scannedCount,
+							total: rows.length,
+						})
+					}}
+				</span>
+				<div>
+					<ButtonStyled circular>
+						<button
+							v-tooltip="formatMessage(messages.scanAllFiles)"
+							:disabled="isBusy || rows.length === 0"
+							@click="fetchAllScans"
+						>
+							<FolderSearchIcon aria-hidden="true" />
+						</button>
+					</ButtonStyled>
+				</div>
+			</div>
+		</template>
+
+		<div class="w-full">
+			<div
+				v-if="versionLoadError || scanError"
+				class="mb-3 rounded-xl bg-highlight-red p-3 text-red"
+			>
+				{{ versionLoadError || scanError }}
+			</div>
+			<Table
+				:columns="columns"
+				:data="rows"
+				row-key="id"
+				:row-below-visible="
+					(row) => Boolean(row.scan?.scanned_file_names && row.scan.scanned_file_names.length > 0)
+				"
+				table-min-width="42rem"
+			>
+				<template #cell-filename="{ row }">
+					<div class="flex min-w-0 items-center gap-1 text-contrast">
+						<StarIcon v-if="row.primary" class="size-4 shrink-0" aria-hidden="true" />
+						<span class="min-w-0 truncate">{{ row.filename }}</span>
+					</div>
+				</template>
+				<template #cell-newFiles="{ row }">
+					<span v-if="row.isScanning">{{ formatMessage(messages.scanning) }}</span>
+					<span v-else-if="row.error" v-tooltip="row.error" class="text-red">
+						{{ formatMessage(messages.failed) }}
+					</span>
+					<span v-else-if="row.scan">{{ row.scan.new_attribution_files }}</span>
+					<span v-else>{{ formatMessage(messages.notScanned) }}</span>
+				</template>
+				<template #cell-newGroups="{ row }">
+					<span v-if="row.isScanning">{{ formatMessage(messages.scanning) }}</span>
+					<span v-else-if="row.error" v-tooltip="row.error" class="text-red">
+						{{ formatMessage(messages.failed) }}
+					</span>
+					<span v-else-if="row.scan">{{ row.scan.new_attribution_groups }}</span>
+					<span v-else>{{ formatMessage(messages.notScanned) }}</span>
+				</template>
+				<template #row-below="{ row }">
+					<div class="border-0 border-t border-solid border-surface-4 px-4 py-3">
+						<details>
+							<summary>
+								{{
+									formatMessage(messages.overrideFiles, {
+										count: row.scan?.scanned_file_names.length ?? 0,
+									})
+								}}
+							</summary>
+							<div class="flex flex-wrap gap-1 pt-2">
+								<span
+									v-for="name of row.scan?.scanned_file_names ?? []"
+									:key="name"
+									v-tooltip="name"
+									class="flex items-center gap-1 text-wrap rounded-full bg-button-bg px-2 py-0.5 text-xs font-medium text-contrast"
+								>
+									{{ name }}
+								</span>
+							</div>
+						</details>
+					</div>
+				</template>
+				<template #empty-state>
+					<div class="flex h-64 items-center justify-center text-secondary">
+						{{ formatMessage(isLoadingVersions ? messages.loadingVersions : messages.noFiles) }}
+					</div>
+				</template>
+			</Table>
+		</div>
+	</NewModal>
+</template>

apps/frontend/src/locales/en-US/index.json

@@ -2687,6 +2687,45 @@
   "moderation.page.technicalReview": {
     "message": "Tech review"
   },
+  "modpack-scan-modal.failed": {
+    "message": "Failed"
+  },
+  "modpack-scan-modal.load-versions-error": {
+    "message": "Failed to load versions: {error}"
+  },
+  "modpack-scan-modal.loading-versions": {
+    "message": "Loading versions..."
+  },
+  "modpack-scan-modal.new-files": {
+    "message": "New Files"
+  },
+  "modpack-scan-modal.new-groups": {
+    "message": "New Groups"
+  },
+  "modpack-scan-modal.no-files": {
+    "message": "No files found."
+  },
+  "modpack-scan-modal.not-scanned": {
+    "message": "Not scanned"
+  },
+  "modpack-scan-modal.override-files": {
+    "message": "Override Files ({count})"
+  },
+  "modpack-scan-modal.pack-file-name": {
+    "message": "Pack File Name"
+  },
+  "modpack-scan-modal.scan-all-files": {
+    "message": "Scan All Files"
+  },
+  "modpack-scan-modal.scan-error": {
+    "message": "Some files failed to scan: {error}"
+  },
+  "modpack-scan-modal.scanning": {
+    "message": "Scanning..."
+  },
+  "modpack-scan-modal.title": {
+    "message": "Modpack Scan ({scanned}/{total} Files)"
+  },
   "muralpay.account-type.checking": {
     "message": "Checking"
   },

apps/frontend/src/pages/[type]/[project].vue

@@ -95,6 +95,8 @@
 				@download="triggerDownloadAnimation"
 			/>
 			<CollectionCreateModal ref="modal_collection" :project-ids="[project.id]" />
+			<ModpackScanModal ref="scanModal" :project_id="project.id" />
+
 			<div
 				class="new-page sidebar"
 				:class="{
@@ -424,13 +426,6 @@
 												tags.staffRoles.includes(auth.user.role) &&
 												!showModerationChecklist,
 										},
-										{
-											divider: true,
-											shown:
-												auth.user &&
-												tags.staffRoles.includes(auth.user.role) &&
-												!showModerationChecklist,
-										},
 										{
 											id: 'tech-review',
 											link: `/moderation/technical-review/${project.id}`,
@@ -438,6 +433,16 @@
 											hoverOnly: true,
 											shown: auth.user && tags.staffRoles.includes(auth.user.role),
 										},
+										{
+											id: 'moderation-modpack-rescan',
+											action: () => scanModal.show(),
+											color: 'orange',
+											hoverOnly: true,
+											shown:
+												auth.user &&
+												tags.staffRoles.includes(auth.user.role) &&
+												project.actualProjectType === 'modpack',
+										},
 										{
 											divider: true,
 											shown: auth.user && tags.staffRoles.includes(auth.user.role),
@@ -469,6 +474,9 @@
 										<ScaleIcon aria-hidden="true" /> {{ formatMessage(messages.reviewProject) }}
 									</template>
 									<template #tech-review> <ScanEyeIcon aria-hidden="true" /> Tech review </template>
+									<template #moderation-modpack-rescan>
+										<FolderSearchIcon aria-hidden="true" /> Rescan modpack
+									</template>
 									<template #report>
 										<ReportIcon aria-hidden="true" />
 										{{ formatMessage(commonMessages.reportButton) }}
@@ -726,6 +734,7 @@ import {
 	ClipboardCopyIcon,
 	DownloadIcon,
 	ExternalIcon,
+	FolderSearchIcon,
 	HeartIcon,
 	ListIcon,
 	MoreVerticalIcon,
@@ -785,6 +794,7 @@ import CollectionCreateModal from '~/components/ui/create/CollectionCreateModal.
 import MessageBanner from '~/components/ui/MessageBanner.vue'
 import ModerationChecklist from '~/components/ui/moderation/checklist/ModerationChecklist.vue'
 import ModerationProjectNags from '~/components/ui/moderation/ModerationProjectNags.vue'
+import ModpackScanModal from '~/components/ui/moderation/ModpackScanModal.vue'
 import ProjectDownloadModal from '~/components/ui/ProjectDownloadModal/index.vue'
 import ProjectMemberHeader from '~/components/ui/ProjectMemberHeader.vue'
 import { getSignInRouteObj } from '~/composables/auth.ts'
@@ -852,6 +862,7 @@ const debug = useDebugLogger('DownloadModal')
 const downloadModal = ref()
 const openInAppModal = ref()
 const overTheTopDownloadAnimation = ref()
+const scanModal = ref()
 
 const projectV3Loaded = computed(() => !projectV3Pending.value || projectV3.value != null)
 const isServerProject = computed(() => projectV3.value?.minecraft_server != null)

packages/api-client/src/modules/labrinth/attribution/internal.ts

@@ -100,4 +100,21 @@ export class LabrinthAttributionInternalModule extends AbstractModule {
 			body,
 		})
 	}
+
+	/**
+	 * Scan a file for attribution information.
+	 * POST /_internal/attribution/file/{file_id}/scan
+	 *
+	 * @param fileId - The file ID to scan.
+	 */
+	public async scanFile(fileId: string): Promise<Labrinth.Attribution.Internal.FileScanResponse> {
+		return this.client.request<Labrinth.Attribution.Internal.FileScanResponse>(
+			`/attribution/file/${fileId}/scan`,
+			{
+				api: 'labrinth',
+				version: 'internal',
+				method: 'POST',
+			},
+		)
+	}
 }

packages/api-client/src/modules/labrinth/types.ts

@@ -397,6 +397,12 @@ export namespace Labrinth {
 				sha1: string
 				project_id: string
 			}
+
+			export type FileScanResponse = {
+				new_attribution_groups: number
+				new_attribution_files: number
+				scanned_file_names: string[]
+			}
 		}
 	}
 
@@ -1333,6 +1339,7 @@ export namespace Labrinth {
 			}
 
 			export type VersionFile = {
+				id?: string
 				hashes: VersionFileHash
 				url: string
 				filename: string
@@ -1454,6 +1461,7 @@ export namespace Labrinth {
 			}
 
 			export interface VersionFile {
+				id?: string
 				hashes: VersionFileHash
 				url: string
 				filename: string