Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
970fd76190 |
@@ -1,115 +0,0 @@
|
||||
# r9t Frontend
|
||||
|
||||
Web-UI für unseren S3-kompatiblen Object Storage (r9t). Rein clientseitiges Nuxt/Vue-Frontend, das Buckets und Objekte auflistet, Objekte anzeigt/hochlädt/löscht und dafür Requests direkt per AWS SigV4 signiert.
|
||||
|
||||
## Tech-Stack
|
||||
|
||||
- [Nuxt 4](https://nuxt.com/) (Vue 3, TypeScript)
|
||||
- [Tailwind CSS 4](https://tailwindcss.com/) (via `@tailwindcss/vite`)
|
||||
- Kein State-Management-Framework, kein Backend-Code hier — nur UI + ein schlanker S3-Client
|
||||
|
||||
## Setup
|
||||
|
||||
Voraussetzung: Node.js (siehe `Dockerfile`, dort läuft `node:22.9.0-alpine`).
|
||||
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
|
||||
`.env` aus der Vorlage anlegen:
|
||||
|
||||
```bash
|
||||
cp .env.example .env
|
||||
```
|
||||
|
||||
Relevante Variablen (siehe `nuxt.config.ts` → `runtimeConfig.public`):
|
||||
|
||||
| Variable | Zweck | Default (Beispiel) |
|
||||
|-------------------------------|---------------------------------------------|---------------------|
|
||||
| `NUXT_PUBLIC_S3_ACCESS_KEY` | Access Key für SigV4-Signierung der Requests | `devkey` |
|
||||
| `NUXT_PUBLIC_S3_SECRET_KEY` | Secret Key für SigV4-Signierung | `devsecret` |
|
||||
|
||||
Wichtig: Diese Keys landen im Public Runtime Config, sind also im Client-Bundle sichtbar. Für den Dev-Betrieb gegen einen lokalen/Test-Storage okay, für produktive Zugangsdaten nicht geeignet — das müsste über einen Backend-Proxy laufen, der Requests serverseitig signiert.
|
||||
|
||||
## Entwicklung
|
||||
|
||||
```bash
|
||||
npm run dev
|
||||
```
|
||||
|
||||
Läuft auf `http://localhost:3000`. Requests an `/api/*` werden per Vite-Dev-Proxy (siehe `nuxt.config.ts`) an `http://localhost:8080` weitergeleitet und dort landet der eigentliche S3-Server. Heißt: Für lokale Entwicklung muss der Storage-Server separat auf Port 8080 laufen.
|
||||
|
||||
## Build & Produktion
|
||||
|
||||
```bash
|
||||
npm run build # Produktions-Build (.output/)
|
||||
npm run preview # lokal den Produktions-Build testen
|
||||
npm run generate # statischer Export, falls mal gebraucht
|
||||
```
|
||||
|
||||
### Docker
|
||||
|
||||
```bash
|
||||
docker build --build-arg VERSION=<version> -t r9t-frontend .
|
||||
docker run -p 3000:3000 r9t-frontend
|
||||
```
|
||||
|
||||
Das Dockerfile baut mit `npx nuxi build` und startet den Nitro-Server via `node .output/server/index.mjs`.
|
||||
|
||||
### CI/CD
|
||||
|
||||
`Jenkinsfile` baut das Image, pusht es nach `harbor.dinauer.dev/r9t/frontend:<BUILD_NUMBER>` und räumt danach den lokalen Build-Agent wieder auf. Kein automatischer Deploy-Schritt enthalten — Image landet nur in der Registry.
|
||||
|
||||
## Projektstruktur
|
||||
|
||||
```
|
||||
app/
|
||||
├── app.vue # Root-Komponente, App-Layout, State-Orchestrierung
|
||||
├── assets/css/main.css # Tailwind-Einstieg
|
||||
├── components/
|
||||
│ ├── BucketList.vue # Sidebar mit Bucket-Auswahl
|
||||
│ ├── ObjectTable.vue # Objektliste im gewählten Bucket
|
||||
│ ├── ObjectDetail.vue # Detail-/Aktions-Panel für ein Objekt
|
||||
│ ├── PathBreadcrumb.vue
|
||||
│ ├── SortHeader.vue
|
||||
│ ├── ChunkBar.vue
|
||||
│ ├── CopyField.vue
|
||||
│ ├── FieldLabel.vue
|
||||
│ ├── FileTypeBadge.vue
|
||||
│ ├── AppToast.vue # Toast-Benachrichtigungen
|
||||
│ └── popup/
|
||||
│ ├── PopupSlot.vue # Rendert die aktuell offene Popup-Instanz
|
||||
│ ├── ConfirmPopup.vue
|
||||
│ ├── UploadPopup.vue
|
||||
│ └── TextPreviewPopup.vue
|
||||
├── composables/
|
||||
│ ├── useS3Client.ts # High-Level S3-Operationen (list/get/put/delete)
|
||||
│ └── usePopup.ts # Globaler Popup-Store
|
||||
└── utils/
|
||||
├── sigv4.ts # AWS SigV4 Request-Signierung (browserseitig, WebCrypto)
|
||||
├── s3xml.ts # Parsen der S3 List-XML-Responses
|
||||
├── popup.ts # Popup-Klasse/Config-Typen
|
||||
└── format.ts # Formatierungs-Helper (Größen, Daten, o.ä.)
|
||||
```
|
||||
|
||||
Sonstige relevante Dateien:
|
||||
|
||||
- `nuxt.config.ts` — Runtime-Config, Tailwind-Plugin, Dev-Proxy nach `/api`
|
||||
- `Dockerfile` — Produktions-Image
|
||||
- `Jenkinsfile` — Build-Pipeline (Image bauen + nach Harbor pushen)
|
||||
- `.env.example` — Vorlage für lokale Env-Variablen
|
||||
|
||||
## Funktionsweise (Kurzfassung)
|
||||
|
||||
1. `app.vue` lädt beim Mount die Bucket-Liste (`useS3Client().listBuckets()`).
|
||||
2. Bei Bucket-Auswahl werden die Objekte geladen (`listObjects`), gefiltert per Suchfeld (Client-seitig, kein Server-Filter).
|
||||
3. Jeder Request wird vorher in `sigv4.ts` per AWS4-HMAC-SHA256 signiert (Access/Secret Key aus der Runtime-Config) und läuft über den `/api`-Proxy zum eigentlichen S3-Server.
|
||||
4. Objekt-Aktionen (Download, Upload, Löschen, Text-Vorschau) laufen über Popups (`usePopup`/`PopupSlot`), die dynamisch eine Vue-Komponente rendern.
|
||||
5. Bucket-Erstellung ist aktuell nur gemockt (`mockAction` in `app.vue`) — das UI unterstützt bislang keinen echten Bucket-Create/Delete.
|
||||
|
||||
## Bekannte Einschränkungen
|
||||
|
||||
- Keine Authentifizierung im UI selbst — Access/Secret Key liegen statisch in der Config.
|
||||
- Kein serverseitiger Proxy für die Signierung, SigV4 läuft komplett im Browser.
|
||||
- Bucket-Erstellung ist nicht implementiert, nur ein Platzhalter-Toast.
|
||||
- Kein automatisierter Test-Runner im Repo vorhanden (kein `test`-Script in `package.json`).
|
||||
+36
-1
@@ -53,6 +53,7 @@
|
||||
</p>
|
||||
|
||||
<ObjectTable
|
||||
ref="objectTableRef"
|
||||
:objects="filteredObjects"
|
||||
:loading="loadingObjects"
|
||||
:has-search="search.length > 0"
|
||||
@@ -61,6 +62,7 @@
|
||||
@select="selectedObject = $event"
|
||||
@upload="openUploadPopup"
|
||||
@retry="retryLoadObjects"
|
||||
@bulk-delete="openBulkDeletePopup"
|
||||
/>
|
||||
</main>
|
||||
|
||||
@@ -81,6 +83,7 @@
|
||||
import { ref, computed, watch, onMounted } from 'vue'
|
||||
import { Popup, PopupSize } from '~/utils/popup'
|
||||
import UploadPopup from '~/components/popup/UploadPopup.vue'
|
||||
import ConfirmPopup, { type ConfirmPayload } from '~/components/popup/ConfirmPopup.vue'
|
||||
import type { S3Bucket, S3Object } from '~/utils/s3xml'
|
||||
|
||||
useHead({ title: 'r9t · Object Storage' })
|
||||
@@ -88,7 +91,7 @@ useHead({ title: 'r9t · Object Storage' })
|
||||
const config = useRuntimeConfig()
|
||||
const accessKey = config.public.s3AccessKey
|
||||
|
||||
const { listBuckets, listObjects } = useS3Client()
|
||||
const { listBuckets, listObjects, deleteObjects } = useS3Client()
|
||||
|
||||
const buckets = ref<S3Bucket[]>([])
|
||||
const objects = ref<S3Object[]>([])
|
||||
@@ -99,6 +102,7 @@ const loadingObjects = ref(false)
|
||||
const errorMessage = ref<string | null>(null)
|
||||
const objectsError = ref<string | null>(null)
|
||||
const toastMessage = ref<string | null>(null)
|
||||
const objectTableRef = ref<{ clearSelection: () => void } | null>(null)
|
||||
|
||||
const filteredObjects = computed(() => {
|
||||
if (!search.value) {
|
||||
@@ -130,6 +134,37 @@ function handleObjectDeleted() {
|
||||
}
|
||||
}
|
||||
|
||||
function openBulkDeletePopup(objectsToDelete: S3Object[]) {
|
||||
if (!selectedBucket.value || !objectsToDelete.length) {
|
||||
return
|
||||
}
|
||||
const bucket = selectedBucket.value
|
||||
const keys = objectsToDelete.map((object) => object.key)
|
||||
|
||||
usePopup().open(
|
||||
Popup.component<ConfirmPayload>(ConfirmPopup)
|
||||
.setConfig({ heading: `${keys.length} Objekte löschen`, size: PopupSize.SMALL, closeOnOverlayClick: true, callback: () => handleBulkDeleted(bucket, keys) })
|
||||
.setPayload({
|
||||
message: `${keys.length} ausgewählte Objekte werden unwiderruflich aus "${bucket}" gelöscht.`,
|
||||
confirmLabel: 'Löschen',
|
||||
onConfirm: async () => {
|
||||
const { failed } = await deleteObjects(bucket, keys)
|
||||
if (failed.length) {
|
||||
throw new Error(`${failed.length} von ${keys.length} Objekten konnten nicht gelöscht werden.`)
|
||||
}
|
||||
},
|
||||
}),
|
||||
)
|
||||
}
|
||||
|
||||
function handleBulkDeleted(bucket: string, keys: string[]) {
|
||||
objectTableRef.value?.clearSelection()
|
||||
notify(`${keys.length} Objekte gelöscht.`)
|
||||
if (selectedBucket.value === bucket) {
|
||||
loadObjects(bucket)
|
||||
}
|
||||
}
|
||||
|
||||
function openUploadPopup() {
|
||||
if (!selectedBucket.value) {
|
||||
return
|
||||
|
||||
@@ -1,8 +1,41 @@
|
||||
<template>
|
||||
<div class="flex-1 overflow-auto">
|
||||
<div
|
||||
v-if="selected.size"
|
||||
class="sticky top-0 z-10 flex items-center justify-between gap-3 border-b border-border bg-surface px-4 py-2 text-sm"
|
||||
>
|
||||
<span class="text-text">{{ selected.size }} ausgewählt</span>
|
||||
<div class="flex items-center gap-2">
|
||||
<button
|
||||
type="button"
|
||||
class="rounded-md border border-border px-2.5 py-1 text-xs font-medium text-text transition-colors hover:bg-surface-raised"
|
||||
@click="clearSelection"
|
||||
>
|
||||
Auswahl aufheben
|
||||
</button>
|
||||
<button
|
||||
type="button"
|
||||
class="flex items-center gap-1.5 rounded-md bg-red-500 px-3 py-1.5 text-xs font-medium text-white transition-opacity hover:opacity-90"
|
||||
@click="$emit('bulk-delete', selectedObjects)"
|
||||
>
|
||||
<span class="material-symbols-outlined !text-[16px]">delete</span>
|
||||
Löschen
|
||||
</button>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<table v-if="loading || objects.length" class="w-full border-collapse text-sm">
|
||||
<thead class="sticky top-0 bg-bg">
|
||||
<tr class="border-b border-border text-left text-xs tracking-[0.08em] text-muted">
|
||||
<th class="w-10 px-4 py-2.5 font-medium">
|
||||
<input
|
||||
type="checkbox"
|
||||
class="size-3.5 cursor-pointer accent-accent"
|
||||
:checked="allSelected"
|
||||
:disabled="!sortedObjects.length"
|
||||
@change="toggleSelectAll"
|
||||
>
|
||||
</th>
|
||||
<th class="px-4 py-2.5 font-medium">
|
||||
<SortHeader :active="sortKey === 'key' ? sortDir : null" @click="toggleSort('key')">KEY</SortHeader>
|
||||
</th>
|
||||
@@ -17,7 +50,7 @@
|
||||
<tbody>
|
||||
<template v-if="loading">
|
||||
<tr v-for="n in 5" :key="n" class="border-b border-border/60">
|
||||
<td class="px-4 py-3" colspan="3">
|
||||
<td class="px-4 py-3" colspan="4">
|
||||
<div class="h-4 w-2/3 animate-pulse rounded bg-surface-raised" />
|
||||
</td>
|
||||
</tr>
|
||||
@@ -27,8 +60,17 @@
|
||||
v-else
|
||||
:key="object.key"
|
||||
class="cursor-pointer border-b border-border/60 transition-colors hover:bg-surface-raised/35"
|
||||
:class="{ 'bg-surface-raised/50': selected.has(object.key) }"
|
||||
@click="$emit('select', object)"
|
||||
>
|
||||
<td class="px-4 py-[5px]" @click.stop>
|
||||
<input
|
||||
type="checkbox"
|
||||
class="size-3.5 cursor-pointer accent-accent"
|
||||
:checked="selected.has(object.key)"
|
||||
@change="toggleSelected(object.key)"
|
||||
>
|
||||
</td>
|
||||
<td class="px-4 py-[5px]">
|
||||
<div class="flex items-center gap-2.5">
|
||||
<FileTypeBadge :filename="object.key" />
|
||||
@@ -86,7 +128,7 @@
|
||||
</template>
|
||||
|
||||
<script setup lang="ts">
|
||||
import { ref, computed } from 'vue'
|
||||
import { ref, computed, watch } from 'vue'
|
||||
import { formatBytes, formatTime, formatDate, isToday } from '~/utils/format'
|
||||
import type { S3Object } from '~/utils/s3xml'
|
||||
|
||||
@@ -97,10 +139,49 @@ const props = defineProps<{
|
||||
searchTerm: string
|
||||
error?: string | null
|
||||
}>()
|
||||
defineEmits<{ select: [object: S3Object]; upload: []; retry: [] }>()
|
||||
defineEmits<{ select: [object: S3Object]; upload: []; retry: []; 'bulk-delete': [objects: S3Object[]] }>()
|
||||
|
||||
type SortKey = 'key' | 'size' | 'lastModified'
|
||||
|
||||
const selected = ref<Set<string>>(new Set())
|
||||
|
||||
const selectedObjects = computed(() => props.objects.filter((object) => selected.value.has(object.key)))
|
||||
|
||||
const allSelected = computed(() => sortedObjects.value.length > 0 && sortedObjects.value.every((object) => selected.value.has(object.key)))
|
||||
|
||||
function toggleSelected(key: string) {
|
||||
const next = new Set(selected.value)
|
||||
if (next.has(key)) {
|
||||
next.delete(key)
|
||||
}
|
||||
else {
|
||||
next.add(key)
|
||||
}
|
||||
selected.value = next
|
||||
}
|
||||
|
||||
function toggleSelectAll() {
|
||||
if (allSelected.value) {
|
||||
selected.value = new Set()
|
||||
return
|
||||
}
|
||||
selected.value = new Set(sortedObjects.value.map((object) => object.key))
|
||||
}
|
||||
|
||||
function clearSelection() {
|
||||
selected.value = new Set()
|
||||
}
|
||||
|
||||
defineExpose({ clearSelection })
|
||||
|
||||
watch(() => props.objects, (objects) => {
|
||||
const keys = new Set(objects.map((object) => object.key))
|
||||
const next = new Set([...selected.value].filter((key) => keys.has(key)))
|
||||
if (next.size !== selected.value.size) {
|
||||
selected.value = next
|
||||
}
|
||||
})
|
||||
|
||||
const sortKey = ref<SortKey>('lastModified')
|
||||
const sortDir = ref<'asc' | 'desc'>('desc')
|
||||
|
||||
|
||||
@@ -43,5 +43,28 @@ export function useS3Client() {
|
||||
await $fetch(`/api${encodeCanonicalPath(path)}`, { method: 'DELETE', headers })
|
||||
}
|
||||
|
||||
return { listBuckets, listObjects, downloadObject, getObjectText, uploadObject, deleteObject }
|
||||
interface BulkDeleteResult {
|
||||
deleted: string[]
|
||||
failed: { key: string; error: unknown }[]
|
||||
}
|
||||
|
||||
async function deleteObjects(bucket: string, keys: string[]): Promise<BulkDeleteResult> {
|
||||
const results = await Promise.allSettled(keys.map((key) => deleteObject(bucket, key)))
|
||||
|
||||
const deleted: string[] = []
|
||||
const failed: { key: string; error: unknown }[] = []
|
||||
results.forEach((result, index) => {
|
||||
const key = keys[index]!
|
||||
if (result.status === 'fulfilled') {
|
||||
deleted.push(key)
|
||||
}
|
||||
else {
|
||||
failed.push({ key, error: result.reason })
|
||||
}
|
||||
})
|
||||
|
||||
return { deleted, failed }
|
||||
}
|
||||
|
||||
return { listBuckets, listObjects, downloadObject, getObjectText, uploadObject, deleteObject, deleteObjects }
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user