11 changed files with 337 additions and 67 deletions
+100
View File
@@ -0,0 +1,100 @@
name: release
on:
push:
branches: [main]
env:
SERVER_URL: https://git.arthurerlich.de
jobs:
release:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
token: ${{ secrets.RELEASE_TOKEN }}
- name: Determine version and guard against re-release
id: version
run: |
set -e
VERSION=$(grep -m1 '"version"' composer.json | sed -E 's/.*"version"[[:space:]]*:[[:space:]]*"([^"]+)".*/\1/')
TAG="v${VERSION}"
echo "version=${VERSION}" >> "$GITHUB_OUTPUT"
echo "tag=${TAG}" >> "$GITHUB_OUTPUT"
if git ls-remote --tags origin "refs/tags/${TAG}" | grep -q "${TAG}"; then
echo "skip=true" >> "$GITHUB_OUTPUT"
echo "Tag ${TAG} already exists, nothing to release."
else
echo "skip=false" >> "$GITHUB_OUTPUT"
fi
- name: Extract changelog section
if: steps.version.outputs.skip == 'false'
run: |
awk -v ver="${{ steps.version.outputs.version }}" '
BEGIN { found=0 }
/^## \[/ {
if (found) exit
if ($0 ~ "\[" ver "\]") { found=1; next }
}
found { print }
' CHANGELOG.md > release-notes.md
cat release-notes.md
- name: Create and push tag
if: steps.version.outputs.skip == 'false'
run: |
git config user.name "gitea-actions"
git config user.email "actions@git.arthurerlich.de"
git tag "${{ steps.version.outputs.tag }}"
git push origin "${{ steps.version.outputs.tag }}"
- name: Install shopware-cli
if: steps.version.outputs.skip == 'false'
run: |
curl -sL -o /tmp/shopware-cli.tar.gz \
https://github.com/shopware/shopware-cli/releases/latest/download/shopware-cli_Linux_x86_64.tar.gz
mkdir -p /tmp/swcli-extract
tar -xzf /tmp/shopware-cli.tar.gz -C /tmp/swcli-extract
cp /tmp/swcli-extract/shopware-cli /usr/local/bin/shopware-cli
- name: Validate extension (informational only, does not gate the release)
if: steps.version.outputs.skip == 'false'
run: shopware-cli extension validate . || true
- name: Package Store-style zip for the Gitea Release asset
if: steps.version.outputs.skip == 'false'
run: |
shopware-cli extension package . --output-directory .build \
--filename "AeonDumpManager-${{ steps.version.outputs.tag }}.zip"
- name: Build root-level zip for the Composer registry
if: steps.version.outputs.skip == 'false'
run: git archive --format=zip -o "composer-package-${{ steps.version.outputs.tag }}.zip" "${{ steps.version.outputs.tag }}"
- name: Create Gitea Release
if: steps.version.outputs.skip == 'false'
uses: akkuman/gitea-release-action@v1
with:
server_url: ${{ env.SERVER_URL }}
token: ${{ secrets.RELEASE_TOKEN }}
tag_name: ${{ steps.version.outputs.tag }}
name: ${{ steps.version.outputs.tag }}
body_path: release-notes.md
files: .build/AeonDumpManager-${{ steps.version.outputs.tag }}.zip
- name: Publish to Composer registry
if: steps.version.outputs.skip == 'false'
run: |
STATUS=$(curl -s -o /tmp/composer-publish.log -w "%{http_code}" \
-u "haylan:${{ secrets.RELEASE_TOKEN }}" \
-T "composer-package-${{ steps.version.outputs.tag }}.zip" \
"https://git.arthurerlich.de/api/packages/haylan/composer")
cat /tmp/composer-publish.log
if [ "$STATUS" != "201" ] && [ "$STATUS" != "409" ]; then
echo "Unexpected HTTP status $STATUS publishing to the Composer registry"
exit 1
fi
+5
View File
@@ -12,6 +12,11 @@ composer.phar
/custom/
/src/Shopware/Platform
# Frontend
*.vite/
**/public/administration/js/
**/public/static/js/
# Environment
.env
.env.local
View File
+29
View File
@@ -9,8 +9,11 @@ use AeonDumpManager\Service\DumpService;
use AeonDumpManager\Service\Exception\DumpNotFoundException;
use Shopware\Core\Framework\Routing\ApiRouteScope;
use Shopware\Core\PlatformRequest;
use Symfony\Component\HttpFoundation\HeaderUtils;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpFoundation\StreamedResponse;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
use Symfony\Component\Messenger\MessageBusInterface;
use Symfony\Component\Routing\Annotation\Route;
@@ -77,6 +80,32 @@ class DumpController
return new JsonResponse(null, Response::HTTP_NO_CONTENT);
}
#[Route(
path: '/api/_action/aeon-dump-manager/dumps/{filename}/download',
name: 'api.action.aeon_dump_manager.dumps.download',
defaults: [PlatformRequest::ATTRIBUTE_ACL => ['aeon_dump_manager.viewer']],
methods: ['GET']
)]
public function download(string $filename): StreamedResponse
{
try {
$stream = $this->dumpService->readStream($filename);
} catch (DumpNotFoundException $exception) {
throw new NotFoundHttpException($exception->getMessage());
}
$response = new StreamedResponse(static function () use ($stream): void {
fpassthru($stream);
});
$response->headers->set('Content-Type', 'application/gzip');
$response->headers->set(
'Content-Disposition',
HeaderUtils::makeDisposition(HeaderUtils::DISPOSITION_ATTACHMENT, $filename)
);
return $response;
}
#[Route(
path: '/api/_action/aeon-dump-manager/dumps/jobs/{jobId}',
name: 'api.action.aeon_dump_manager.dumps.jobs.status',
@@ -4,6 +4,7 @@
<sw-button
v-if="acl.can('aeon_dump_manager.creator')"
variant="primary"
:is-loading="pendingJob !== null"
:disabled="pendingJob !== null"
@click="onCreate"
>
@@ -12,22 +13,27 @@
</template>
<template #content>
<sw-card-view>
<sw-card>
<div class="aeon-dump-manager-list__content">
<sw-data-grid
:data-source="dumps"
:columns="columns"
:is-loading="isLoading"
:show-selection="false"
:show-selection="acl.can('aeon_dump_manager.deleter')"
:full-page="true"
identifier="filename"
@selection-change="onSelectionChange"
>
<template #before-item-list>
<tr v-if="pendingJob !== null" class="aeon-dump-manager-list__pending-row">
<td colspan="3">
<span>{{ $tc('aeon-dump-manager.list.creating') }}</span>
<sw-progress-bar :max-value="100" :value="pendingJob.percent || 0" />
</td>
</tr>
<template #bulk>
<a
v-if="acl.can('aeon_dump_manager.deleter')"
class="link link-danger aeon-dump-manager-list__bulk-delete"
role="button"
tabindex="0"
@click="onRequestBulkDelete"
@keydown.enter="onRequestBulkDelete"
>
{{ $tc('aeon-dump-manager.list.bulkDeleteButton', 0, { count: selectionCount }) }}
</a>
</template>
<template #column-datetime="{ item }">
@@ -39,6 +45,12 @@
</template>
<template #actions="{ item }">
<sw-context-menu-item
v-if="acl.can('aeon_dump_manager.viewer')"
@click="onDownload(item.filename)"
>
{{ $tc('aeon-dump-manager.list.buttonDownload') }}
</sw-context-menu-item>
<sw-context-menu-item
v-if="acl.can('aeon_dump_manager.deleter')"
variant="danger"
@@ -52,14 +64,48 @@
{{ $tc('aeon-dump-manager.list.empty') }}
</template>
</sw-data-grid>
</sw-card>
</sw-card-view>
</div>
</template>
{% block aeon_dump_manager_list_progress_modal %}
<sw-modal
v-if="pendingJob !== null"
:title="$tc('aeon-dump-manager.list.progressTitle')"
variant="small"
class="aeon-dump-manager-list__progress-modal"
@modal-close="onCloseProgressModal"
>
<div class="aeon-dump-manager-list__progress-wrapper">
<template v-if="pendingJob.status === 'done'">
<sw-alert variant="success">
{{ $tc('aeon-dump-manager.list.createSuccess') }}
</sw-alert>
</template>
<template v-else-if="pendingJob.status === 'failed'">
<sw-alert variant="error">
{{ $tc('aeon-dump-manager.list.createFailed', 0, { error: pendingJob.errorMessage || '' }) }}
</sw-alert>
</template>
<template v-else>
<sw-progress-bar
:value="pendingJob.percent || 0"
:max-value="100"
/>
<span class="aeon-dump-manager-list__progress-text">
{{ $tc('aeon-dump-manager.list.progressText') }}
</span>
</template>
</div>
</sw-modal>
{% endblock %}
<sw-confirm-modal
v-if="deleteFilename !== null"
v-if="deleteFilenames !== null"
:title="$tc('aeon-dump-manager.list.confirmDeleteTitle')"
:text="$tc('aeon-dump-manager.list.confirmDeleteText', 0, { filename: deleteFilename })"
:text="deleteFilenames.length > 1
? $tc('aeon-dump-manager.list.confirmDeleteTextMultiple', 0, { count: deleteFilenames.length })
: $tc('aeon-dump-manager.list.confirmDeleteText', 0, { filename: deleteFilenames[0] })"
type="delete"
@confirm="onConfirmDelete"
@cancel="onCancelDelete"
@close="onCancelDelete"
@@ -1,7 +1,7 @@
import template from './aeon-dump-manager-list.html.twig';
import type DumpApiService, { DumpFile, DumpJob } from '../../../../service/dump-api.service';
const { Component } = Shopware;
const { Component, Mixin } = Shopware;
interface PendingJob {
status: string;
@@ -9,11 +9,14 @@ interface PendingJob {
errorMessage?: string | null;
}
const CREATE_MODAL_AUTO_CLOSE_MS = 1500;
interface ComponentData {
dumps: DumpFile[];
isLoading: boolean;
pendingJob: PendingJob | null;
deleteFilename: string | null;
deleteFilenames: string[] | null;
selection: Record<string, DumpFile>;
pollTimer: number | null;
}
@@ -25,11 +28,15 @@ interface ComponentInstance extends ComponentData {
loadList: () => Promise<void>;
stopPolling: () => void;
pollJobStatus: (jobId: string) => void;
selectionCount: number;
}
Component.register('aeon-dump-manager-list', {
template,
// Provides createNotificationSuccess/createNotificationError, used below.
mixins: [Mixin.getByName('notification')],
inject: ['aeonDumpManagerApiService', 'acl'],
data(): ComponentData {
@@ -37,7 +44,8 @@ Component.register('aeon-dump-manager-list', {
dumps: [],
isLoading: false,
pendingJob: null,
deleteFilename: null,
deleteFilenames: null,
selection: {},
pollTimer: null,
};
},
@@ -63,6 +71,10 @@ Component.register('aeon-dump-manager-list', {
},
];
},
selectionCount(this: ComponentInstance): number {
return Object.keys(this.selection).length;
},
},
created(this: ComponentInstance) {
@@ -94,6 +106,10 @@ Component.register('aeon-dump-manager-list', {
return Shopware.Utils.format.fileSize(bytes);
},
onSelectionChange(this: ComponentInstance, selection: Record<string, DumpFile>) {
this.selection = selection;
},
onCreate(this: ComponentInstance) {
this.pendingJob = { percent: 0, status: 'pending' };
@@ -102,10 +118,9 @@ Component.register('aeon-dump-manager-list', {
this.pollJobStatus(response.jobId);
})
.catch((error: Error) => {
this.pendingJob = null;
this.createNotificationError({
message: this.$tc('aeon-dump-manager.list.createFailed', 0, { error: error.message }),
});
// Shown in the progress modal itself, not a notification —
// stays open so the user can actually read what went wrong.
this.pendingJob = { status: 'failed', percent: null, errorMessage: error.message };
});
},
@@ -114,24 +129,20 @@ Component.register('aeon-dump-manager-list', {
this.pollTimer = window.setInterval(() => {
this.aeonDumpManagerApiService.getJobStatus(jobId).then((job: DumpJob) => {
this.pendingJob = job;
if (job.status === 'done') {
this.stopPolling();
this.pendingJob = null;
this.createNotificationSuccess({ message: this.$tc('aeon-dump-manager.list.createSuccess') });
this.loadList();
window.setTimeout(() => {
this.pendingJob = null;
}, CREATE_MODAL_AUTO_CLOSE_MS);
return;
}
if (job.status === 'failed') {
this.stopPolling();
this.pendingJob = null;
this.createNotificationError({
message: this.$tc('aeon-dump-manager.list.createFailed', 0, { error: job.errorMessage ?? '' }),
});
return;
}
this.pendingJob = job;
});
}, 2000);
},
@@ -143,20 +154,62 @@ Component.register('aeon-dump-manager-list', {
}
},
onCloseProgressModal(this: ComponentInstance) {
this.stopPolling();
this.pendingJob = null;
},
onDownload(this: ComponentInstance, filename: string) {
this.aeonDumpManagerApiService.download(filename)
.then((blob) => {
const url = window.URL.createObjectURL(blob);
const link = document.createElement('a');
link.href = url;
link.download = filename;
document.body.appendChild(link);
link.click();
document.body.removeChild(link);
window.URL.revokeObjectURL(url);
})
.catch((error: Error) => {
this.createNotificationError({
message: this.$tc('aeon-dump-manager.list.downloadFailed', 0, { error: error.message }),
});
});
},
onRequestDelete(this: ComponentInstance, filename: string) {
this.deleteFilename = filename;
this.deleteFilenames = [filename];
},
onRequestBulkDelete(this: ComponentInstance) {
this.deleteFilenames = Object.keys(this.selection);
},
onCancelDelete(this: ComponentInstance) {
this.deleteFilename = null;
this.deleteFilenames = null;
},
onConfirmDelete(this: ComponentInstance): Promise<void> {
const filename = this.deleteFilename as string;
this.deleteFilename = null;
const filenames = this.deleteFilenames as string[];
this.deleteFilenames = null;
return this.aeonDumpManagerApiService.remove(filename)
.then(() => this.loadList());
// Optimistic UI update: pull the rows out immediately rather than
// waiting on a full reload, so the grid never looks stale even if
// loadList() is slow or a later delete in the batch fails.
this.dumps = this.dumps.filter((dumpFile) => !filenames.includes(dumpFile.filename));
this.selection = {};
return Promise.all(filenames.map((filename) => this.aeonDumpManagerApiService.remove(filename)))
.then(() => this.loadList())
.catch((error: Error) => {
this.createNotificationError({
message: this.$tc('aeon-dump-manager.list.deleteFailed', 0, { error: error.message }),
});
// A delete failed after the optimistic removal — reload to
// show the real state rather than leave a wrong guess on screen.
return this.loadList();
});
},
},
});
@@ -9,13 +9,19 @@
"columnDatetime": "Erstellt am",
"columnSize": "Größe",
"buttonCreate": "Dump erstellen",
"buttonDownload": "Herunterladen",
"buttonDelete": "Löschen",
"bulkDeleteButton": "Auswahl löschen ({count})",
"confirmDeleteTitle": "Dump löschen?",
"confirmDeleteText": "Möchten Sie \"{filename}\" wirklich löschen? Dies kann nicht rückgängig gemacht werden.",
"confirmDeleteTextMultiple": "Möchten Sie {count} Dumps wirklich löschen? Dies kann nicht rückgängig gemacht werden.",
"empty": "Keine Dumps gefunden.",
"creating": "Dump wird erstellt",
"progressTitle": "Dump wird erstellt",
"progressText": "Dump wird erstellt…",
"createFailed": "Dump konnte nicht erstellt werden: {error}",
"createSuccess": "Dump erstellt."
"createSuccess": "Dump erstellt.",
"deleteFailed": "Dump konnte nicht gelöscht werden: {error}",
"downloadFailed": "Dump konnte nicht heruntergeladen werden: {error}"
}
}
}
@@ -9,13 +9,19 @@
"columnDatetime": "Created at",
"columnSize": "Size",
"buttonCreate": "Create dump",
"buttonDownload": "Download",
"buttonDelete": "Delete",
"bulkDeleteButton": "Delete selected ({count})",
"confirmDeleteTitle": "Delete dump?",
"confirmDeleteText": "Are you sure you want to delete \"{filename}\"? This cannot be undone.",
"confirmDeleteTextMultiple": "Are you sure you want to delete {count} dumps? This cannot be undone.",
"empty": "No dumps found.",
"creating": "Creating dump",
"progressTitle": "Creating dump",
"progressText": "Creating dump…",
"createFailed": "Could not create dump: {error}",
"createSuccess": "Dump created."
"createSuccess": "Dump created.",
"deleteFailed": "Could not delete dump: {error}",
"downloadFailed": "Could not download dump: {error}"
}
}
}
@@ -66,4 +66,13 @@ export default class DumpApiService extends ApiService {
.get(`/_action/aeon-dump-manager/dumps/jobs/${encodeURIComponent(jobId)}`, { headers: this.getBasicHeaders() })
.then((response: unknown) => ApiService.handleResponse(response));
}
download(filename: string): Promise<Blob> {
return this.httpClient
.get(`/_action/aeon-dump-manager/dumps/${encodeURIComponent(filename)}/download`, {
headers: this.getBasicHeaders(),
responseType: 'blob',
})
.then((response: unknown) => ApiService.handleResponse(response) as Blob);
}
}
File diff suppressed because one or more lines are too long
+17
View File
@@ -71,6 +71,23 @@ class DumpService
$this->aeonDumpManagerFilesystemPrivate->delete($path);
}
/**
* @return resource
*/
public function readStream(string $filename)
{
if (!$this->filenameParser->isValid($filename)) {
throw DumpNotFoundException::create($filename);
}
$path = DumpLister::path($filename);
if (!$this->aeonDumpManagerFilesystemPrivate->fileExists($path)) {
throw DumpNotFoundException::create($filename);
}
return $this->aeonDumpManagerFilesystemPrivate->readStream($path);
}
public function enforceMaxDumps(): void
{
$maxDumps = $this->systemConfigService->getInt('AeonDumpManager.config.maxDumps');