Merge pull request 'feat(dump): date-range filter, sortable columns, native date formatting' (!10) from feat/dump-list-view into main
release / release (push) Successful in 1m1s

This commit was merged in pull request #10.
This commit is contained in:
2026-09-21 18:00:42 +00:00
11 changed files with 175 additions and 38 deletions
+17 -12
View File
@@ -5,6 +5,15 @@ All notable changes to AeonDumpManager will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
## [0.0.3] - 2026-09-17
### Added
- Filter the dump list by date range and sort by date or size; dates use Shopware's locale-aware
formatting.
## [0.0.2] - 2026-09-21 ## [0.0.2] - 2026-09-21
### Added ### Added
@@ -16,18 +25,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- `main` is now a protected branch: no direct pushes, merges require the version/changelog check - `main` is now a protected branch: no direct pushes, merges require the version/changelog check
to pass. to pass.
## [Unreleased] ## [0.0.1] - 2026-09-15
### Added ### Added
- List, create, and delete SQL database dumps from a Settings admin page (nested under Settings, per - List, create, delete, and download gzip-compressed SQL dumps from a Settings admin page (async
Shopware's [Add Menu Entry](https://developer.shopware.com/docs/v6.6/guides/plugins/plugins/administration/routing-navigation/add-menu-entry.html) creation with a polling progress bar) or via the `aeon:dump:list`, `aeon:dump:create`, and
guide) and via `aeon:dump:list`/`aeon:dump:create`/`aeon:dump:remove` console commands. `aeon:dump:remove` console commands (sync). Dumps are produced with `mysqldump`/`mariadb-dump`
- Dumps are created with `mysqldump`/`mariadb-dump` (auto-detected, with an optional `dumpBinaryName` (auto-detected, overridable via `dumpBinaryName`) and stored in the plugin's private filesystem.
override), gzip-compressed, and stored in the plugin's private Flysystem mount. - Retention controls: `maxDumps` purges the oldest dump when the limit is reached; `retantionDays`
- `maxDumps` auto-purges the oldest dump on creation; `retantionDays` purges dumps and stale job rows purges expired dumps and stale job rows via a scheduled task.
on a recurring scheduled task. - ACL-gated by `aeon_dump_manager.viewer`/`.creator`/`.deleter`, enforced client- and server-side.
- Admin UI dump creation runs asynchronously via Symfony Messenger with a polling progress bar; console
creation runs synchronously.
- ACL-gated (`aeon_dump_manager.viewer`/`.creator`/`.deleter`), enforced both client-side and
server-side.
+1 -1
View File
@@ -3,7 +3,7 @@
"description": "Export database dumps for Shopware 6 environments.", "description": "Export database dumps for Shopware 6 environments.",
"type": "shopware-platform-plugin", "type": "shopware-platform-plugin",
"license": "MIT", "license": "MIT",
"version": "0.0.2", "version": "0.0.3",
"keywords": [ "keywords": [
"shopware", "shopware",
"shopware6", "shopware6",
+33 -2
View File
@@ -11,6 +11,7 @@ use Shopware\Core\Framework\Routing\ApiRouteScope;
use Shopware\Core\PlatformRequest; use Shopware\Core\PlatformRequest;
use Symfony\Component\HttpFoundation\HeaderUtils; use Symfony\Component\HttpFoundation\HeaderUtils;
use Symfony\Component\HttpFoundation\JsonResponse; use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response; use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpFoundation\StreamedResponse; use Symfony\Component\HttpFoundation\StreamedResponse;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
@@ -39,16 +40,46 @@ class DumpController
defaults: [PlatformRequest::ATTRIBUTE_ACL => ['aeon_dump_manager.viewer']], defaults: [PlatformRequest::ATTRIBUTE_ACL => ['aeon_dump_manager.viewer']],
methods: ['GET'] methods: ['GET']
)] )]
public function list(): JsonResponse public function list(Request $request): JsonResponse
{ {
$dumps = array_map( $dumps = array_map(
static fn ($dumpFile) => $dumpFile->jsonSerialize(), static fn ($dumpFile) => $dumpFile->jsonSerialize(),
$this->dumpLister->list() $this->dumpLister->list(
$this->parseBoundDate($request->query->get('from'), false),
$this->parseBoundDate($request->query->get('to'), true),
)
); );
return new JsonResponse(['dumps' => $dumps]); return new JsonResponse(['dumps' => $dumps]);
} }
/**
* The admin's date filter sends mixed shapes: the "from" bound is a naive local
* date string with no timezone marker (e.g. "2026-03-01T00:00:00"), while
* sw-date-filter widens "to" to end-of-day client-side via `Date#toISOString()`,
* which is always UTC (e.g. "2026-03-01T23:59:59.000Z"). Re-expressing both in
* PHP's default timezone (the same one DumpFilenameParser uses) before applying
* our own day-boundary keeps the calendar day the user actually picked, regardless
* of which shape arrived. An empty bound (no date set) stays null so the range is
* open on that side.
*/
private function parseBoundDate(?string $value, bool $endOfDay): ?\DateTimeImmutable
{
if ($value === null || trim($value) === '') {
return null;
}
try {
$dateTime = (new \DateTimeImmutable($value))->setTimezone(new \DateTimeZone(date_default_timezone_get()));
} catch (\Exception) {
return null;
}
return $endOfDay
? $dateTime->setTime(23, 59, 59)
: $dateTime->setTime(0, 0, 0);
}
#[Route( #[Route(
path: '/api/_action/aeon-dump-manager/dumps', path: '/api/_action/aeon-dump-manager/dumps',
name: 'api.action.aeon_dump_manager.dumps.create', name: 'api.action.aeon_dump_manager.dumps.create',
@@ -14,14 +14,24 @@
<template #content> <template #content>
<div class="aeon-dump-manager-list__content"> <div class="aeon-dump-manager-list__content">
<sw-filter-panel
:filters="listFilters"
:defaults="defaultFilters"
:store-key="storeKey"
@criteria-changed="onCriteriaChanged"
/>
<sw-data-grid <sw-data-grid
:data-source="dumps" :data-source="sortedDumps"
:columns="columns" :columns="columns"
:is-loading="isLoading" :is-loading="isLoading"
:show-selection="acl.can('aeon_dump_manager.deleter')" :show-selection="acl.can('aeon_dump_manager.deleter')"
:full-page="true" :full-page="true"
:sort-by="sortBy"
:sort-direction="sortDirection"
identifier="filename" identifier="filename"
@selection-change="onSelectionChange" @selection-change="onSelectionChange"
@column-sort="onSortColumn"
> >
<template #bulk> <template #bulk>
<a <a
@@ -11,6 +11,12 @@ interface PendingJob {
const CREATE_MODAL_AUTO_CLOSE_MS = 1500; const CREATE_MODAL_AUTO_CLOSE_MS = 1500;
interface DateRangeCriteria {
type: string;
field: string;
parameters?: { gte?: string; lte?: string };
}
interface ComponentData { interface ComponentData {
dumps: DumpFile[]; dumps: DumpFile[];
isLoading: boolean; isLoading: boolean;
@@ -18,6 +24,12 @@ interface ComponentData {
deleteFilenames: string[] | null; deleteFilenames: string[] | null;
selection: Record<string, DumpFile>; selection: Record<string, DumpFile>;
pollTimer: number | null; pollTimer: number | null;
dateFrom: string | null;
dateTo: string | null;
sortBy: string;
sortDirection: string;
storeKey: string;
defaultFilters: string[];
} }
interface ComponentInstance extends ComponentData { interface ComponentInstance extends ComponentData {
@@ -25,17 +37,25 @@ interface ComponentInstance extends ComponentData {
$tc: (key: string, count?: number, values?: Record<string, unknown>) => string; $tc: (key: string, count?: number, values?: Record<string, unknown>) => string;
createNotificationError: (options: { message: string }) => void; createNotificationError: (options: { message: string }) => void;
createNotificationSuccess: (options: { message: string }) => void; createNotificationSuccess: (options: { message: string }) => void;
loadList: () => Promise<void>; getList: () => Promise<void>;
stopPolling: () => void; stopPolling: () => void;
pollJobStatus: (jobId: string) => void; pollJobStatus: (jobId: string) => void;
selectionCount: number; selectionCount: number;
sortedDumps: DumpFile[];
listFilters: Record<string, unknown>[];
} }
Component.register('aeon-dump-manager-list', { Component.register('aeon-dump-manager-list', {
template, template,
mixins: [
// Provides createNotificationSuccess/createNotificationError, used below. // Provides createNotificationSuccess/createNotificationError, used below.
mixins: [Mixin.getByName('notification')], Mixin.getByName('notification'),
// Provides sortBy/sortDirection state, onSortColumn(), and route-query
// persistence for them (same mixin sw-product-list etc. use) — our own
// data() below overrides the defaults to keep "newest first".
Mixin.getByName('listing'),
],
inject: ['aeonDumpManagerApiService', 'acl'], inject: ['aeonDumpManagerApiService', 'acl'],
@@ -47,27 +67,56 @@ Component.register('aeon-dump-manager-list', {
deleteFilenames: null, deleteFilenames: null,
selection: {}, selection: {},
pollTimer: null, pollTimer: null,
dateFrom: null,
dateTo: null,
sortBy: 'datetime',
sortDirection: 'DESC',
storeKey: 'grid.filter.aeon-dump-manager',
defaultFilters: ['datetime'],
}; };
}, },
computed: { computed: {
listFilters(this: ComponentInstance) {
return [
{
name: 'datetime',
type: 'date-filter',
property: 'datetime',
label: this.$tc('aeon-dump-manager.list.columnDatetime'),
dateType: 'date',
fromFieldLabel: this.$tc('aeon-dump-manager.list.filterFromLabel'),
toFieldLabel: this.$tc('aeon-dump-manager.list.filterToLabel'),
fromPlaceholder: this.$tc('aeon-dump-manager.list.filterFromPlaceholder'),
toPlaceholder: this.$tc('aeon-dump-manager.list.filterToPlaceholder'),
showTimeframe: false,
},
];
},
columns() { columns() {
return [ return [
{ {
property: 'datetime', property: 'datetime',
dataIndex: 'datetime',
label: this.$tc('aeon-dump-manager.list.columnDatetime'), label: this.$tc('aeon-dump-manager.list.columnDatetime'),
allowResize: true, allowResize: true,
sortable: true,
}, },
{ {
property: 'filename', property: 'filename',
dataIndex: 'filename',
label: this.$tc('aeon-dump-manager.list.columnFilename'), label: this.$tc('aeon-dump-manager.list.columnFilename'),
allowResize: true, allowResize: true,
sortable: true,
}, },
{ {
property: 'sizeBytes', property: 'sizeBytes',
dataIndex: 'sizeBytes',
label: this.$tc('aeon-dump-manager.list.columnSize'), label: this.$tc('aeon-dump-manager.list.columnSize'),
align: 'right', align: 'right',
allowResize: true, allowResize: true,
sortable: true,
}, },
]; ];
}, },
@@ -75,10 +124,27 @@ Component.register('aeon-dump-manager-list', {
selectionCount(this: ComponentInstance): number { selectionCount(this: ComponentInstance): number {
return Object.keys(this.selection).length; return Object.keys(this.selection).length;
}, },
},
created(this: ComponentInstance) { sortedDumps(this: ComponentInstance): DumpFile[] {
this.loadList(); const direction = this.sortDirection === 'ASC' ? 1 : -1;
return [...this.dumps].sort((a, b) => {
let compareVal: number;
switch (this.sortBy) {
case 'sizeBytes':
compareVal = a.sizeBytes - b.sizeBytes;
break;
case 'datetime':
compareVal = new Date(a.datetime).getTime() - new Date(b.datetime).getTime();
break;
default:
compareVal = a.filename.localeCompare(b.filename, undefined, { numeric: true });
}
return compareVal * direction;
});
},
}, },
beforeDestroy(this: ComponentInstance) { beforeDestroy(this: ComponentInstance) {
@@ -86,10 +152,10 @@ Component.register('aeon-dump-manager-list', {
}, },
methods: { methods: {
loadList(this: ComponentInstance): Promise<void> { getList(this: ComponentInstance): Promise<void> {
this.isLoading = true; this.isLoading = true;
return this.aeonDumpManagerApiService.getList() return this.aeonDumpManagerApiService.getList({ from: this.dateFrom, to: this.dateTo })
.then((response) => { .then((response) => {
this.dumps = response.dumps; this.dumps = response.dumps;
}) })
@@ -99,7 +165,15 @@ Component.register('aeon-dump-manager-list', {
}, },
formatDatetime(value: string): string { formatDatetime(value: string): string {
return new Date(value).toLocaleString(); return Shopware.Utils.format.date(value);
},
onCriteriaChanged(this: ComponentInstance, criteria: DateRangeCriteria[]) {
const range = criteria.find((filter) => filter.type === 'range' && filter.field === 'datetime');
this.dateFrom = range?.parameters?.gte ?? null;
this.dateTo = range?.parameters?.lte ?? null;
this.getList();
}, },
formatSize(bytes: number): string { formatSize(bytes: number): string {
@@ -133,7 +207,7 @@ Component.register('aeon-dump-manager-list', {
if (job.status === 'done') { if (job.status === 'done') {
this.stopPolling(); this.stopPolling();
this.loadList(); this.getList();
window.setTimeout(() => { window.setTimeout(() => {
this.pendingJob = null; this.pendingJob = null;
}, CREATE_MODAL_AUTO_CLOSE_MS); }, CREATE_MODAL_AUTO_CLOSE_MS);
@@ -196,19 +270,19 @@ Component.register('aeon-dump-manager-list', {
// Optimistic UI update: pull the rows out immediately rather than // Optimistic UI update: pull the rows out immediately rather than
// waiting on a full reload, so the grid never looks stale even if // waiting on a full reload, so the grid never looks stale even if
// loadList() is slow or a later delete in the batch fails. // getList() is slow or a later delete in the batch fails.
this.dumps = this.dumps.filter((dumpFile) => !filenames.includes(dumpFile.filename)); this.dumps = this.dumps.filter((dumpFile) => !filenames.includes(dumpFile.filename));
this.selection = {}; this.selection = {};
return Promise.all(filenames.map((filename) => this.aeonDumpManagerApiService.remove(filename))) return Promise.all(filenames.map((filename) => this.aeonDumpManagerApiService.remove(filename)))
.then(() => this.loadList()) .then(() => this.getList())
.catch((error: Error) => { .catch((error: Error) => {
this.createNotificationError({ this.createNotificationError({
message: this.$tc('aeon-dump-manager.list.deleteFailed', 0, { error: error.message }), message: this.$tc('aeon-dump-manager.list.deleteFailed', 0, { error: error.message }),
}); });
// A delete failed after the optimistic removal — reload to // A delete failed after the optimistic removal — reload to
// show the real state rather than leave a wrong guess on screen. // show the real state rather than leave a wrong guess on screen.
return this.loadList(); return this.getList();
}); });
}, },
}, },
@@ -8,6 +8,10 @@
"columnFilename": "Name", "columnFilename": "Name",
"columnDatetime": "Erstellt am", "columnDatetime": "Erstellt am",
"columnSize": "Größe", "columnSize": "Größe",
"filterFromLabel": "Von",
"filterFromPlaceholder": "Startdatum auswählen...",
"filterToLabel": "Bis",
"filterToPlaceholder": "Enddatum auswählen...",
"buttonCreate": "Dump erstellen", "buttonCreate": "Dump erstellen",
"buttonDownload": "Herunterladen", "buttonDownload": "Herunterladen",
"buttonDelete": "Löschen", "buttonDelete": "Löschen",
@@ -8,6 +8,10 @@
"columnFilename": "Name", "columnFilename": "Name",
"columnDatetime": "Created at", "columnDatetime": "Created at",
"columnSize": "Size", "columnSize": "Size",
"filterFromLabel": "From",
"filterFromPlaceholder": "Select start date...",
"filterToLabel": "To",
"filterToPlaceholder": "Select end date...",
"buttonCreate": "Create dump", "buttonCreate": "Create dump",
"buttonDownload": "Download", "buttonDownload": "Download",
"buttonDelete": "Delete", "buttonDelete": "Delete",
@@ -43,9 +43,12 @@ export default class DumpApiService extends ApiService {
super(httpClient, loginService, apiEndpoint); super(httpClient, loginService, apiEndpoint);
} }
getList(): Promise<DumpList> { getList(filter: { from?: string | null; to?: string | null } = {}): Promise<DumpList> {
return this.httpClient return this.httpClient
.get('/_action/aeon-dump-manager/dumps', { headers: this.getBasicHeaders() }) .get('/_action/aeon-dump-manager/dumps', {
headers: this.getBasicHeaders(),
params: { from: filter.from ?? undefined, to: filter.to ?? undefined },
})
.then((response: unknown) => ApiService.handleResponse(response)); .then((response: unknown) => ApiService.handleResponse(response));
} }
+9 -1
View File
@@ -18,7 +18,7 @@ class DumpLister
/** /**
* @return DumpFile[] newest first * @return DumpFile[] newest first
*/ */
public function list(): array public function list(?\DateTimeImmutable $from = null, ?\DateTimeImmutable $to = null): array
{ {
$dumps = []; $dumps = [];
@@ -33,6 +33,14 @@ class DumpLister
continue; continue;
} }
if ($from !== null && $datetime < $from) {
continue;
}
if ($to !== null && $datetime > $to) {
continue;
}
$dumps[] = new DumpFile($filename, $datetime, $item->fileSize()); $dumps[] = new DumpFile($filename, $datetime, $item->fileSize());
} }
+2 -3
View File
@@ -3,6 +3,7 @@
namespace AeonDumpManager\Tests\Service; namespace AeonDumpManager\Tests\Service;
use AeonDumpManager\Service\DumpFilenameParser; use AeonDumpManager\Service\DumpFilenameParser;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\TestCase; use PHPUnit\Framework\TestCase;
class DumpFilenameParserTest extends TestCase class DumpFilenameParserTest extends TestCase
@@ -29,9 +30,7 @@ class DumpFilenameParserTest extends TestCase
self::assertEquals($dateTime, $this->parser->parse($filename)); self::assertEquals($dateTime, $this->parser->parse($filename));
} }
/** #[DataProvider('invalidFilenameProvider')]
* @dataProvider invalidFilenameProvider
*/
public function testParseRejectsInvalidFilenames(string $filename): void public function testParseRejectsInvalidFilenames(string $filename): void
{ {
self::assertNull($this->parser->parse($filename)); self::assertNull($this->parser->parse($filename));
+2 -3
View File
@@ -3,13 +3,12 @@
namespace AeonDumpManager\Tests\Service; namespace AeonDumpManager\Tests\Service;
use AeonDumpManager\Service\MySqlVariant; use AeonDumpManager\Service\MySqlVariant;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\TestCase; use PHPUnit\Framework\TestCase;
class MySqlVariantTest extends TestCase class MySqlVariantTest extends TestCase
{ {
/** #[DataProvider('versionProvider')]
* @dataProvider versionProvider
*/
public function testIsMariaDb(string $version, bool $expected): void public function testIsMariaDb(string $version, bool $expected): void
{ {
self::assertSame($expected, MySqlVariant::isMariaDb($version)); self::assertSame($expected, MySqlVariant::isMariaDb($version));