Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
8d2e60126e |
@@ -0,0 +1,115 @@
|
|||||||
|
# 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`).
|
||||||
+1
-36
@@ -53,7 +53,6 @@
|
|||||||
</p>
|
</p>
|
||||||
|
|
||||||
<ObjectTable
|
<ObjectTable
|
||||||
ref="objectTableRef"
|
|
||||||
:objects="filteredObjects"
|
:objects="filteredObjects"
|
||||||
:loading="loadingObjects"
|
:loading="loadingObjects"
|
||||||
:has-search="search.length > 0"
|
:has-search="search.length > 0"
|
||||||
@@ -62,7 +61,6 @@
|
|||||||
@select="selectedObject = $event"
|
@select="selectedObject = $event"
|
||||||
@upload="openUploadPopup"
|
@upload="openUploadPopup"
|
||||||
@retry="retryLoadObjects"
|
@retry="retryLoadObjects"
|
||||||
@bulk-delete="openBulkDeletePopup"
|
|
||||||
/>
|
/>
|
||||||
</main>
|
</main>
|
||||||
|
|
||||||
@@ -83,7 +81,6 @@
|
|||||||
import { ref, computed, watch, onMounted } from 'vue'
|
import { ref, computed, watch, onMounted } from 'vue'
|
||||||
import { Popup, PopupSize } from '~/utils/popup'
|
import { Popup, PopupSize } from '~/utils/popup'
|
||||||
import UploadPopup from '~/components/popup/UploadPopup.vue'
|
import UploadPopup from '~/components/popup/UploadPopup.vue'
|
||||||
import ConfirmPopup, { type ConfirmPayload } from '~/components/popup/ConfirmPopup.vue'
|
|
||||||
import type { S3Bucket, S3Object } from '~/utils/s3xml'
|
import type { S3Bucket, S3Object } from '~/utils/s3xml'
|
||||||
|
|
||||||
useHead({ title: 'r9t · Object Storage' })
|
useHead({ title: 'r9t · Object Storage' })
|
||||||
@@ -91,7 +88,7 @@ useHead({ title: 'r9t · Object Storage' })
|
|||||||
const config = useRuntimeConfig()
|
const config = useRuntimeConfig()
|
||||||
const accessKey = config.public.s3AccessKey
|
const accessKey = config.public.s3AccessKey
|
||||||
|
|
||||||
const { listBuckets, listObjects, deleteObjects } = useS3Client()
|
const { listBuckets, listObjects } = useS3Client()
|
||||||
|
|
||||||
const buckets = ref<S3Bucket[]>([])
|
const buckets = ref<S3Bucket[]>([])
|
||||||
const objects = ref<S3Object[]>([])
|
const objects = ref<S3Object[]>([])
|
||||||
@@ -102,7 +99,6 @@ const loadingObjects = ref(false)
|
|||||||
const errorMessage = ref<string | null>(null)
|
const errorMessage = ref<string | null>(null)
|
||||||
const objectsError = ref<string | null>(null)
|
const objectsError = ref<string | null>(null)
|
||||||
const toastMessage = ref<string | null>(null)
|
const toastMessage = ref<string | null>(null)
|
||||||
const objectTableRef = ref<{ clearSelection: () => void } | null>(null)
|
|
||||||
|
|
||||||
const filteredObjects = computed(() => {
|
const filteredObjects = computed(() => {
|
||||||
if (!search.value) {
|
if (!search.value) {
|
||||||
@@ -134,37 +130,6 @@ 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() {
|
function openUploadPopup() {
|
||||||
if (!selectedBucket.value) {
|
if (!selectedBucket.value) {
|
||||||
return
|
return
|
||||||
|
|||||||
@@ -1,41 +1,8 @@
|
|||||||
<template>
|
<template>
|
||||||
<div class="flex-1 overflow-auto">
|
<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">
|
<table v-if="loading || objects.length" class="w-full border-collapse text-sm">
|
||||||
<thead class="sticky top-0 bg-bg">
|
<thead class="sticky top-0 bg-bg">
|
||||||
<tr class="border-b border-border text-left text-xs tracking-[0.08em] text-muted">
|
<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">
|
<th class="px-4 py-2.5 font-medium">
|
||||||
<SortHeader :active="sortKey === 'key' ? sortDir : null" @click="toggleSort('key')">KEY</SortHeader>
|
<SortHeader :active="sortKey === 'key' ? sortDir : null" @click="toggleSort('key')">KEY</SortHeader>
|
||||||
</th>
|
</th>
|
||||||
@@ -50,7 +17,7 @@
|
|||||||
<tbody>
|
<tbody>
|
||||||
<template v-if="loading">
|
<template v-if="loading">
|
||||||
<tr v-for="n in 5" :key="n" class="border-b border-border/60">
|
<tr v-for="n in 5" :key="n" class="border-b border-border/60">
|
||||||
<td class="px-4 py-3" colspan="4">
|
<td class="px-4 py-3" colspan="3">
|
||||||
<div class="h-4 w-2/3 animate-pulse rounded bg-surface-raised" />
|
<div class="h-4 w-2/3 animate-pulse rounded bg-surface-raised" />
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
@@ -60,17 +27,8 @@
|
|||||||
v-else
|
v-else
|
||||||
:key="object.key"
|
:key="object.key"
|
||||||
class="cursor-pointer border-b border-border/60 transition-colors hover:bg-surface-raised/35"
|
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)"
|
@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]">
|
<td class="px-4 py-[5px]">
|
||||||
<div class="flex items-center gap-2.5">
|
<div class="flex items-center gap-2.5">
|
||||||
<FileTypeBadge :filename="object.key" />
|
<FileTypeBadge :filename="object.key" />
|
||||||
@@ -128,7 +86,7 @@
|
|||||||
</template>
|
</template>
|
||||||
|
|
||||||
<script setup lang="ts">
|
<script setup lang="ts">
|
||||||
import { ref, computed, watch } from 'vue'
|
import { ref, computed } from 'vue'
|
||||||
import { formatBytes, formatTime, formatDate, isToday } from '~/utils/format'
|
import { formatBytes, formatTime, formatDate, isToday } from '~/utils/format'
|
||||||
import type { S3Object } from '~/utils/s3xml'
|
import type { S3Object } from '~/utils/s3xml'
|
||||||
|
|
||||||
@@ -139,49 +97,10 @@ const props = defineProps<{
|
|||||||
searchTerm: string
|
searchTerm: string
|
||||||
error?: string | null
|
error?: string | null
|
||||||
}>()
|
}>()
|
||||||
defineEmits<{ select: [object: S3Object]; upload: []; retry: []; 'bulk-delete': [objects: S3Object[]] }>()
|
defineEmits<{ select: [object: S3Object]; upload: []; retry: [] }>()
|
||||||
|
|
||||||
type SortKey = 'key' | 'size' | 'lastModified'
|
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 sortKey = ref<SortKey>('lastModified')
|
||||||
const sortDir = ref<'asc' | 'desc'>('desc')
|
const sortDir = ref<'asc' | 'desc'>('desc')
|
||||||
|
|
||||||
|
|||||||
@@ -43,28 +43,5 @@ export function useS3Client() {
|
|||||||
await $fetch(`/api${encodeCanonicalPath(path)}`, { method: 'DELETE', headers })
|
await $fetch(`/api${encodeCanonicalPath(path)}`, { method: 'DELETE', headers })
|
||||||
}
|
}
|
||||||
|
|
||||||
interface BulkDeleteResult {
|
return { listBuckets, listObjects, downloadObject, getObjectText, uploadObject, deleteObject }
|
||||||
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