7 Commits
Author SHA1 Message Date
haylanandClaude Bot a551034442 ci: plugin-agnostic PR checks and package-then-release pipeline
version-changelog / version-changelog (pull_request) Successful in 50s
plugin-checks / package (pull_request) Failing after 1m50s
plugin-checks / validate (pull_request) Failing after 31m29s
plugin-checks / phpunit (pull_request) Canceled after 33m2s
- plugin-checks workflow: shopware-cli validate, package + built-JS assertion, phpunit
- release: validate, package from the merge commit, validate the zip, create the release
  via the Gitea API, publish the same zip to the Composer registry
- scripts/protect-main.sh sets required status checks via tea api
- bump to 0.1.0

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-03 23:28:15 +02:00
haylanandClaude Bot 8efaef2042 feat(plugin): align with Shopware plugin guidelines
- add dedicated monolog channel aeon_dump_manager and log dump jobs
- migrate services.xml/routes.php to YAML
- require PHP ^8.2
- add extension icon and .config/shopware-extension.yml
- drop empty lifecycle overrides

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-03 23:26:21 +02:00
haylanandClaude Bot 29974928d2 docs(spec): add Shopware guideline compliance spec
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-03 23:22:23 +02:00
haylan 36ef203797 Merge pull request 'chore:(composer): namespace fix' (!12) from namespace-fix into main
release / release (push) Successful in 54s
Reviewed-on: #12
2026-09-21 19:31:07 +00:00
haylan ba2d1ec1d6 chroe(changelog): version dump
version-changelog / version-changelog (pull_request) Successful in 18s
2026-09-21 21:30:19 +02:00
haylan d117444bae chore(bump): version
version-changelog / version-changelog (pull_request) Failing after 4s
2026-09-21 21:29:04 +02:00
haylan 58df03216d chore:(composer): namespace fix
version-changelog / version-changelog (pull_request) Failing after 5s
2026-09-21 21:27:58 +02:00
18 changed files with 439 additions and 193 deletions

No files matched your search

+21
View File
@@ -0,0 +1,21 @@
# shopware-cli extension configuration (build/package/validate)
build:
zip:
pack:
excludes:
paths:
- tests
- docs
- scripts
- phpunit.xml
- docker-compose.yml
- skills-lock.json
- AGENTS.md
- CLAUDE.md
- QWEN.md
- .claude
- .scratch
- .wayfinder
- src/Resources/config/plugin-transparent.png
validation:
ignore: []
+100
View File
@@ -0,0 +1,100 @@
name: plugin-checks
# Plugin-agnostic: nothing below names this plugin. Name, version and paths come from composer.json.
# shopware-cli is intentionally unpinned (latest); a red build after a CLI release means fix the config.
on:
pull_request:
branches: [main]
permissions:
contents: read
jobs:
validate:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: shivammathur/setup-php@v2
with:
php-version: '8.3'
- uses: actions/setup-node@v4
with:
node-version: '20'
- name: Install shopware-cli
run: |
curl -sL https://github.com/shopware/shopware-cli/releases/latest/download/shopware-cli_Linux_x86_64.tar.gz | tar -xz -C /tmp shopware-cli
sudo install /tmp/shopware-cli /usr/local/bin/shopware-cli || install /tmp/shopware-cli /usr/local/bin/shopware-cli
- name: Validate extension
run: shopware-cli extension validate .
package:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-node@v4
with:
node-version: '20'
- name: Install shopware-cli
run: |
curl -sL https://github.com/shopware/shopware-cli/releases/latest/download/shopware-cli_Linux_x86_64.tar.gz | tar -xz -C /tmp shopware-cli
sudo install /tmp/shopware-cli /usr/local/bin/shopware-cli || install /tmp/shopware-cli /usr/local/bin/shopware-cli
- name: Package extension
run: shopware-cli extension package . --output-directory .build --filename package.zip --git-commit "$GITHUB_SHA"
- name: Validate packaged zip
run: shopware-cli extension validate .build/package.zip
- name: Assert built JS is in the zip
run: |
set -e
LIST=$(unzip -Z1 .build/package.zip)
if [ -f src/Resources/app/administration/src/main.js ] || [ -f src/Resources/app/administration/src/main.ts ]; then
echo "$LIST" | grep -q 'Resources/public/administration/js/' || { echo "::error::admin entry exists but the zip has no built admin JS"; exit 1; }
fi
if [ -f src/Resources/app/storefront/src/main.js ] || [ -f src/Resources/app/storefront/src/main.ts ]; then
echo "$LIST" | grep -q 'Resources/app/storefront/dist/' || { echo "::error::storefront entry exists but the zip has no built storefront JS"; exit 1; }
fi
phpunit:
runs-on: ubuntu-latest
services:
database:
image: mariadb:11.4
env:
MARIADB_ROOT_PASSWORD: root
options: >-
--health-cmd="healthcheck.sh --connect --innodb_initialized"
--health-interval=5s --health-timeout=5s --health-retries=20
env:
DATABASE_URL: mysql://root:root@database:3306/shopware
APP_ENV: test
APP_URL: http://localhost
steps:
- uses: actions/checkout@v4
with:
path: plugin-src
- uses: shivammathur/setup-php@v2
with:
php-version: '8.3'
extensions: gd, intl, pdo_mysql, zip, curl, mbstring, dom, xml, fileinfo, sodium, bcmath
tools: composer
- name: Resolve plugin name
run: |
# plugin directory name = short class name of extra.shopware-plugin-class
CLASS=$(jq -r '.extra["shopware-plugin-class"]' plugin-src/composer.json)
echo "PLUGIN_NAME=${CLASS##*\\}" >> "$GITHUB_ENV"
- name: Create Shopware 6.6 project
run: composer create-project shopware/production:6.6.* shopware --no-interaction --no-scripts
- name: Install Shopware and the plugin
working-directory: shopware
run: |
set -e
composer require --dev phpunit/phpunit:^10 --no-interaction
bin/console system:install --basic-setup --create-database --force --no-interaction
cp -r ../plugin-src "custom/plugins/${PLUGIN_NAME}"
bin/console plugin:refresh
bin/console plugin:install --activate "${PLUGIN_NAME}"
- name: Run phpunit
working-directory: shopware
run: vendor/bin/phpunit -c "custom/plugins/${PLUGIN_NAME}/phpunit.xml"
+3
View File
@@ -4,6 +4,9 @@ on:
pull_request:
branches: [main]
permissions:
contents: read
jobs:
version-changelog:
runs-on: ubuntu-latest
+68 -60
View File
@@ -1,11 +1,16 @@
name: release
# Plugin-agnostic: owner, repo, host, package name and version come from the `github` context
# and composer.json. shopware-cli is intentionally unpinned (latest).
# RELEASE_TOKEN is the single token used for releases, assets and the Composer registry.
on:
push:
branches: [main]
env:
SERVER_URL: https://git.arthurerlich.de
permissions:
contents: write
packages: write
jobs:
release:
@@ -17,15 +22,19 @@ jobs:
token: ${{ secrets.RELEASE_TOKEN }}
- name: Determine version and guard against re-release
id: version
id: meta
run: |
set -e
VERSION=$(grep -m1 '"version"' composer.json | sed -E 's/.*"version"[[:space:]]*:[[:space:]]*"([^"]+)".*/\1/')
PACKAGE_NAME=$(grep -m1 '"name"' composer.json | sed -E 's/.*"name"[[:space:]]*:[[:space:]]*"([^"]+)".*/\1/')
VERSION=$(jq -r .version composer.json)
PACKAGE_NAME=$(jq -r .name composer.json)
REPO_NAME="${GITHUB_REPOSITORY#*/}"
TAG="v${VERSION}"
echo "version=${VERSION}" >> "$GITHUB_OUTPUT"
echo "package_name=${PACKAGE_NAME}" >> "$GITHUB_OUTPUT"
echo "tag=${TAG}" >> "$GITHUB_OUTPUT"
{
echo "version=${VERSION}"
echo "package_name=${PACKAGE_NAME}"
echo "tag=${TAG}"
echo "zip=${REPO_NAME}-${TAG}.zip"
} >> "$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."
@@ -33,68 +42,66 @@ jobs:
echo "skip=false" >> "$GITHUB_OUTPUT"
fi
- name: Extract changelog section
if: steps.version.outputs.skip == 'false'
- uses: actions/setup-node@v4
if: steps.meta.outputs.skip == 'false'
with:
node-version: '20'
- name: Install shopware-cli
if: steps.meta.outputs.skip == 'false'
run: |
awk -v ver="${{ steps.version.outputs.version }}" '
curl -sL https://github.com/shopware/shopware-cli/releases/latest/download/shopware-cli_Linux_x86_64.tar.gz | tar -xz -C /tmp shopware-cli
sudo install /tmp/shopware-cli /usr/local/bin/shopware-cli || install /tmp/shopware-cli /usr/local/bin/shopware-cli
- name: Validate extension
if: steps.meta.outputs.skip == 'false'
run: shopware-cli extension validate .
- name: Package extension (prebuilt admin/storefront assets)
if: steps.meta.outputs.skip == 'false'
run: |
shopware-cli extension package . --output-directory .build \
--filename "${{ steps.meta.outputs.zip }}" --git-commit "$GITHUB_SHA"
- name: Validate packaged zip
if: steps.meta.outputs.skip == 'false'
run: shopware-cli extension validate ".build/${{ steps.meta.outputs.zip }}"
- name: Extract changelog section
if: steps.meta.outputs.skip == 'false'
run: |
awk -v ver="${{ steps.meta.outputs.version }}" '
BEGIN { found=0 }
/^## \[/ {
if (found) exit
if ($0 ~ "\[" ver "\]") { found=1; next }
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'
- name: Create Gitea release (creates the tag) and upload the zip
if: steps.meta.outputs.skip == 'false'
env:
TOKEN: ${{ secrets.RELEASE_TOKEN }}
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 }}"
set -e
API="${GITHUB_SERVER_URL}/api/v1/repos/${GITHUB_REPOSITORY}"
BODY=$(jq -n --arg tag "${{ steps.meta.outputs.tag }}" --arg sha "$GITHUB_SHA" --rawfile notes release-notes.md \
'{tag_name:$tag, target_commitish:$sha, name:$tag, body:$notes}')
RELEASE_ID=$(curl -sf -H "Authorization: token ${TOKEN}" -H "Content-Type: application/json" -d "$BODY" "${API}/releases" | jq -r .id)
echo "release id: ${RELEASE_ID}"
curl -sf -H "Authorization: token ${TOKEN}" \
-F "attachment=@.build/${{ steps.meta.outputs.zip }}" \
"${API}/releases/${RELEASE_ID}/assets?name=${{ steps.meta.outputs.zip }}" > /dev/null
- 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'
- name: Publish the same zip to the Composer registry
if: steps.meta.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")
-u "${GITHUB_REPOSITORY_OWNER}:${{ secrets.RELEASE_TOKEN }}" \
-T ".build/${{ steps.meta.outputs.zip }}" \
"${GITHUB_SERVER_URL}/api/packages/${GITHUB_REPOSITORY_OWNER}/composer")
cat /tmp/composer-publish.log
if [ "$STATUS" != "201" ] && [ "$STATUS" != "409" ]; then
echo "Unexpected HTTP status $STATUS publishing to the Composer registry"
@@ -102,10 +109,11 @@ jobs:
fi
- name: Link Composer package to this repository
if: steps.version.outputs.skip == 'false'
if: steps.meta.outputs.skip == 'false'
run: |
ENCODED_NAME=$(printf '%s' "${{ steps.version.outputs.package_name }}" | sed 's#/#%2F#g')
STATUS=$(curl -s -o /dev/null -w "%{http_code}" -u "haylan:${{ secrets.RELEASE_TOKEN }}" -X POST "https://git.arthurerlich.de/api/v1/packages/haylan/composer/${ENCODED_NAME}/-/link/AeonDumpManager")
ENCODED_NAME=$(printf '%s' "${{ steps.meta.outputs.package_name }}" | sed 's#/#%2F#g')
STATUS=$(curl -s -o /dev/null -w "%{http_code}" -u "${GITHUB_REPOSITORY_OWNER}:${{ secrets.RELEASE_TOKEN }}" -X POST \
"${GITHUB_SERVER_URL}/api/v1/packages/${GITHUB_REPOSITORY_OWNER}/composer/${ENCODED_NAME}/-/link/${GITHUB_REPOSITORY#*/}")
echo "link status: $STATUS"
if [ "$STATUS" != "201" ] && [ "$STATUS" != "400" ]; then
echo "::warning::Unexpected status linking the Composer package to this repository (HTTP $STATUS) - not fatal, release already published"
+23
View File
@@ -7,6 +7,29 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased]
## [0.1.0] - 2026-10-03
### Changed
- Services and routes are now configured in YAML; the plugin requires PHP `^8.2`.
- Release pipeline: the packaged `shopware-cli` zip (with prebuilt assets) is validated and used for both the Gitea Release and the Composer registry; the release is created through the Gitea API after packaging, so a failed build no longer leaves an orphan tag.
- New PR checks: `shopware-cli` validate, package build and phpunit.
### Added
- Dedicated `aeon_dump_manager` monolog channel; dump jobs, deletions and purges are logged.
- Extension icon and `.config/shopware-extension.yml`.
### Removed
- Empty plugin lifecycle overrides.
## [0.0.5] - 2026-09-21
### Fixed
- Changed namespace
## [0.0.4] - 2026-09-21
### Fixed
+2 -2
View File
@@ -14,7 +14,7 @@ the full build spec live under `.scratch/admin-dump-manager/` and `.scratch/dump
- Plugin bootstrap class: `src/AeonDumpManager.php` (extends `Shopware\Core\Framework\Plugin`) — this
is the entry point Shopware calls for install/uninstall/activate/deactivate/update lifecycle hooks.
- Plugin class name is wired via `composer.json` → `extra.shopware-plugin-class`.
- Services are registered manually in `src/Resources/config/services.xml` (Symfony DI, XML format,
- Services are registered manually in `src/Resources/config/services.yaml` (Symfony DI, YAML format,
autowiring is not configured — every new service/command/task must be added here explicitly with
its tag, e.g. `console.command` or `shopware.scheduled.task`).
- Plugin store-config UI fields (e.g. `maxDumps`, `retantionDays`) are defined in
@@ -66,7 +66,7 @@ vendor/bin/phpunit tests/SomeTest.php # single file
## Adding functionality
- New console commands go in `src/Command/`, new scheduled tasks in `src/ScheduledTask/` — both must
be registered in `src/Resources/config/services.xml` with the appropriate tag or Shopware will not
be registered in `src/Resources/config/services.yaml` with the appropriate tag or Shopware will not
discover them.
- Scheduled tasks need a matching handler (tagged `messenger.message_handler`) to actually run; a bare
`ScheduledTask` subclass like `ExampleTask` only defines the schedule, not the behavior.
+5 -5
View File
@@ -1,9 +1,9 @@
{
"name": "aeon/dump-manager",
"name": "arthurerlich/aeon-dump-manager",
"description": "Export database dumps for Shopware 6 environments.",
"type": "shopware-platform-plugin",
"license": "MIT",
"version": "0.0.4",
"version": "0.1.0",
"keywords": [
"shopware",
"shopware6",
@@ -25,7 +25,7 @@
"source": "https://git.arthurerlich.de/haylan/AeonDumpManager"
},
"require": {
"php": "^8.1",
"php": "^8.2",
"shopware/core": "~6.6.0"
},
"require-dev": {
@@ -35,8 +35,8 @@
"shopware-plugin-class": "AeonDumpManager\\AeonDumpManager",
"copyright": "(c) by Arthur Erlich",
"label": {
"de-DE": "Aeon Dump Manager",
"en-GB": "Aeon Dump Manager"
"de-DE": "Dump Manager",
"en-GB": "Dump Manager"
},
"description": {
"de-DE": "Verwaltet Datenbank-Dumps für Shopware 6 Entwicklungsumgebungen.",
@@ -0,0 +1,69 @@
# Spec: Shopware plugin guideline compliance (build/release pipeline)
Outcome of the Wayfinder map `.scratch/shopware-guideline-compliance/` (tickets 01-05; research evidence
on branches `research/shopware-guideline-checklist`, `research/shopware-cli-ci-behaviour`,
`research/gitea-28-pipeline-standards`). Target: **Store-ready** artifacts, published to Gitea only
(Gitea Release + Composer registry). Uploading to the Shopware Store is out of scope.
## 1. Principles
- Workflows are **plugin-agnostic**: no plugin name, package name, owner, repo or host is hard-coded;
all derive from `composer.json` and the `gitea` context. The same files must work unchanged for a
second plugin and be extractable to Gitea's shared-workflow repository later.
- One artifact: the `shopware-cli extension package` zip (prebuilt admin/storefront JS) is used for
both the Gitea Release asset and the Composer registry.
- `shopware-cli` is intentionally **unpinned** (`latest`). Known tradeoff: a CLI release can turn PRs
red without a repo change; treat that as a signal to fix config.
- `RELEASE_TOKEN` is the only token (release, assets, registry publish, link). Workflows still declare
`permissions:`.
## 2. Plugin changes
| # | Change |
|---|--------|
| P1 | Commit `src/Resources/config/plugin.png` (256x256). Do not ship `plugin-transparent.png`. |
| P2 | Logging: monolog channel `aeon_dump_manager` (`Resources/config/packages/monolog.yaml`, `build()` in the plugin class loading `packages/*.yaml`); inject `monolog.logger.aeon_dump_manager` into `PurgeDumpsTaskHandler`, `DumpService`, `CreateDumpHandler`; log dump job start/finish/failure. |
| P3 | Migrate `services.xml` -> `services.yaml` and `routes.php` -> `routes.yaml`. No validation ignore for this. Update the "XML services" rule in `CLAUDE.md`. |
| P4 | `composer.json`: `php` -> `^8.2`. Verify Shopware 6.6's own PHP requirement. |
| P5 | Delete the empty lifecycle overrides in `AeonDumpManager`; keep `uninstall`. |
| P6 | `.config/shopware-extension.yml` for build excludes and validation settings (add ignores only for real, accepted findings). |
| P7 | Keep Keep-a-Changelog `CHANGELOG.md`; verify with a local `shopware-cli extension package --release` how the changelog is read. |
## 3. Pipeline
### PR workflows
Jobs (all required checks on `main`):
`pr-version-check.yml` (job `version-changelog`) is unchanged apart from `permissions:`; its name keeps the existing required context. New `plugin-checks.yml`:
1. `validate` - install `shopware-cli`, `extension validate .` (hard gate, no `|| true`).
2. `package` - `extension package` with `--git-commit "$GITHUB_SHA"`, then assert the zip contains built admin JS (`Resources/public/administration/js`) when an admin entry exists.
3. `phpunit` - `composer create-project shopware/production` (6.6.x) + MariaDB service, copy the plugin into `custom/plugins`, install/activate, run phpunit. PHP 8.3.
### Release workflow (`.gitea/workflows/release.yml`)
On push to `main`, guarded against re-release by an existing tag:
validate -> `extension package --git-commit "$GITHUB_SHA"` -> **validate the zip** -> create the Gitea
release via API (`POST /repos/{owner}/{repo}/releases`, creates the tag) with the zip as asset ->
upload the same zip to the Composer registry -> link package to repository.
Removes the manual `git tag` step, the `akkuman` action and the `git archive` zip. Packaging happens
before the tag exists, so a failed build leaves no orphan tag.
### Branch protection (one-time, manual)
`scripts/protect-main.sh` using `tea api PATCH repos/{owner}/{repo}/branch_protections/main` to set the
required status-check contexts (current: `version-changelog / version-changelog (pull_request)`; add
the new PR jobs). `tea branches protect` cannot set status checks. Not run by the pipeline.
## 4. Open items to verify while implementing
- Release POST creates a missing tag (fallback: tag step after packaging).
- Meaning of HTTP 400 on the package-link endpoint.
- Whether bare `validate` runs PHPStan/ESLint (needs PHP/Node on the runner); Node availability on the runner image.
- Accepted size for `metadata.icon.size`; error-vs-warning rule list of validate.
- Whether `routes.php` is flagged by validate; `shopware-cli extension fix` correctness for the YAML migration.
- Exact status-check context names of the new jobs (set after the first run).
## 5. Out of scope / later
Shopware Store upload; Gitea shared-workflow repository; phpunit lowest-version matrix; Store listing metadata.
+17
View File
@@ -0,0 +1,17 @@
#!/usr/bin/env bash
# One-time (re-runnable) setup: require the PR checks on `main` using the Gitea `tea` CLI.
# `tea branches protect` cannot set status-check contexts, hence `tea api`.
# Usage: scripts/protect-main.sh [owner/repo] (default: derived from the git remote)
set -euo pipefail
REPO="${1:-$(git config --get remote.origin.url | sed -E 's#^.*[:/]([^/]+/[^/]+)$#\1#; s#\.git$##')}"
tea api -X PATCH "repos/${REPO}/branch_protections/main" -d '{
"enable_status_check": true,
"status_check_contexts": [
"version-changelog / version-changelog (pull_request)",
"plugin-checks / validate (pull_request)",
"plugin-checks / package (pull_request)",
"plugin-checks / phpunit (pull_request)"
]
}'
+22 -31
View File
@@ -4,17 +4,33 @@ namespace AeonDumpManager;
use Doctrine\DBAL\Connection;
use Shopware\Core\Framework\Plugin;
use Shopware\Core\Framework\Plugin\Context\ActivateContext;
use Shopware\Core\Framework\Plugin\Context\DeactivateContext;
use Shopware\Core\Framework\Plugin\Context\InstallContext;
use Shopware\Core\Framework\Plugin\Context\UninstallContext;
use Shopware\Core\Framework\Plugin\Context\UpdateContext;
use Symfony\Component\Config\FileLocator;
use Symfony\Component\Config\Loader\DelegatingLoader;
use Symfony\Component\Config\Loader\LoaderResolver;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Loader\DirectoryLoader;
use Symfony\Component\DependencyInjection\Loader\GlobFileLoader;
use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
class AeonDumpManager extends Plugin
{
public function install(InstallContext $installContext): void
public function build(ContainerBuilder $container): void
{
// Do stuff such as creating a new payment method
parent::build($container);
// Registers the dedicated monolog channel (Resources/config/packages/monolog.yaml)
$locator = new FileLocator('Resources/config');
$resolver = new LoaderResolver([
new YamlFileLoader($container, $locator),
new GlobFileLoader($container, $locator),
new DirectoryLoader($container, $locator),
]);
(new DelegatingLoader($resolver))->load(
\rtrim($this->getPath(), '/') . '/Resources/config/packages/*.yaml',
'glob'
);
}
public function uninstall(UninstallContext $uninstallContext): void
@@ -29,29 +45,4 @@ class AeonDumpManager extends Plugin
$connection = $this->container->get(Connection::class);
$connection->executeStatement('DROP TABLE IF EXISTS `aeon_dump_manager_job`');
}
public function activate(ActivateContext $activateContext): void
{
// Activate entities, such as a new payment method
// Or create new entities here, because now your plugin is installed and active for sure
}
public function deactivate(DeactivateContext $deactivateContext): void
{
// Deactivate entities, such as a new payment method
// Or remove previously created entities
}
public function update(UpdateContext $updateContext): void
{
// Update necessary stuff, mostly non-database related
}
public function postInstall(InstallContext $installContext): void
{
}
public function postUpdate(UpdateContext $updateContext): void
{
}
}
@@ -5,6 +5,7 @@ namespace AeonDumpManager\MessageQueue\Handler;
use AeonDumpManager\MessageQueue\Message\CreateDumpMessage;
use AeonDumpManager\Service\DumpJobStatusService;
use AeonDumpManager\Service\DumpService;
use Psr\Log\LoggerInterface;
use Symfony\Component\Messenger\Attribute\AsMessageHandler;
#[AsMessageHandler]
@@ -13,6 +14,7 @@ class CreateDumpHandler
public function __construct(
private readonly DumpService $dumpService,
private readonly DumpJobStatusService $jobStatus,
private readonly LoggerInterface $logger,
) {
}
@@ -20,10 +22,12 @@ class CreateDumpHandler
{
$jobId = $message->getJobId();
$this->jobStatus->markRunning($jobId);
$this->logger->info('Dump job started.', ['jobId' => $jobId]);
try {
$this->dumpService->createAsync($jobId, $this->jobStatus);
} catch (\Throwable $exception) {
$this->logger->error('Dump job failed.', ['jobId' => $jobId, 'exception' => $exception]);
$this->jobStatus->markFailed($jobId, $exception->getMessage());
}
}
@@ -0,0 +1,2 @@
monolog:
channels: ['aeon_dump_manager']
Binary file not shown.

After

Width:  |  Height:  |  Size: 48 KiB

-7
View File
@@ -1,7 +0,0 @@
<?php declare(strict_types=1);
use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator;
return function (RoutingConfigurator $routes): void {
$routes->import(__DIR__ . '/../../Controller/*Controller.php', 'attribute');
};
+3
View File
@@ -0,0 +1,3 @@
aeon_dump_manager_controllers:
resource: ../../Controller/*Controller.php
type: attribute
-88
View File
@@ -1,88 +0,0 @@
<?xml version="1.0" ?>
<container xmlns="http://symfony.com/schema/dic/services"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
<services>
<!-- Services -->
<service id="Symfony\Component\Process\ExecutableFinder"/>
<service id="aeon_dump_manager.dump_filename_parser" class="AeonDumpManager\Service\DumpFilenameParser"/>
<service id="aeon_dump_manager.dump_binary_locator" class="AeonDumpManager\Service\DumpBinaryLocator">
<argument type="service" id="Doctrine\DBAL\Connection"/>
<argument type="service" id="Shopware\Core\System\SystemConfig\SystemConfigService"/>
<argument type="service" id="Symfony\Component\Process\ExecutableFinder"/>
</service>
<service id="aeon_dump_manager.dump_job_status_service" class="AeonDumpManager\Service\DumpJobStatusService">
<argument type="service" id="Doctrine\DBAL\Connection"/>
</service>
<service id="aeon_dump_manager.dump_lister" class="AeonDumpManager\Service\DumpLister">
<argument type="service" id="aeon_dump_manager.filesystem.private"/>
<argument type="service" id="aeon_dump_manager.dump_filename_parser"/>
</service>
<service id="aeon_dump_manager.dump_service" class="AeonDumpManager\Service\DumpService">
<argument type="service" id="aeon_dump_manager.dump_lister"/>
<argument type="service" id="aeon_dump_manager.filesystem.private"/>
<argument type="service" id="aeon_dump_manager.dump_binary_locator"/>
<argument type="service" id="Doctrine\DBAL\Connection"/>
<argument type="service" id="Shopware\Core\System\SystemConfig\SystemConfigService"/>
<argument type="service" id="aeon_dump_manager.dump_filename_parser"/>
</service>
<!-- Async create job -->
<service id="aeon_dump_manager.message_queue.create_dump_handler" class="AeonDumpManager\MessageQueue\Handler\CreateDumpHandler">
<argument type="service" id="aeon_dump_manager.dump_service"/>
<argument type="service" id="aeon_dump_manager.dump_job_status_service"/>
<tag name="messenger.message_handler"/>
</service>
<!-- Retention -->
<service id="aeon_dump_manager.scheduled_task.purge_dumps_task" class="AeonDumpManager\ScheduledTask\PurgeDumpsTask">
<tag name="shopware.scheduled.task"/>
</service>
<service id="aeon_dump_manager.scheduled_task.purge_dumps_task_handler" class="AeonDumpManager\ScheduledTask\PurgeDumpsTaskHandler">
<argument type="service" id="scheduled_task.repository"/>
<argument type="service" id="logger"/>
<argument type="service" id="aeon_dump_manager.dump_service"/>
<argument type="service" id="aeon_dump_manager.dump_job_status_service"/>
<argument type="service" id="Shopware\Core\System\SystemConfig\SystemConfigService"/>
<tag name="messenger.message_handler" handles="AeonDumpManager\ScheduledTask\PurgeDumpsTask"/>
</service>
<!-- Console commands -->
<service id="aeon_dump_manager.command.dump_list" class="AeonDumpManager\Command\DumpListCommand">
<argument type="service" id="aeon_dump_manager.dump_lister"/>
<tag name="console.command"/>
</service>
<service id="aeon_dump_manager.command.dump_create" class="AeonDumpManager\Command\DumpCreateCommand">
<argument type="service" id="aeon_dump_manager.dump_service"/>
<tag name="console.command"/>
</service>
<service id="aeon_dump_manager.command.dump_remove" class="AeonDumpManager\Command\DumpRemoveCommand">
<argument type="service" id="aeon_dump_manager.dump_service"/>
<tag name="console.command"/>
</service>
<!-- Admin API controller -->
<service id="AeonDumpManager\Controller\DumpController" public="true">
<argument type="service" id="aeon_dump_manager.dump_lister"/>
<argument type="service" id="aeon_dump_manager.dump_service"/>
<argument type="service" id="aeon_dump_manager.dump_job_status_service"/>
<argument type="service" id="messenger.default_bus"/>
</service>
</services>
</container>
+92
View File
@@ -0,0 +1,92 @@
services:
Symfony\Component\Process\ExecutableFinder: ~
aeon_dump_manager.dump_filename_parser:
class: AeonDumpManager\Service\DumpFilenameParser
aeon_dump_manager.dump_binary_locator:
class: AeonDumpManager\Service\DumpBinaryLocator
arguments:
- '@Doctrine\DBAL\Connection'
- '@Shopware\Core\System\SystemConfig\SystemConfigService'
- '@Symfony\Component\Process\ExecutableFinder'
aeon_dump_manager.dump_job_status_service:
class: AeonDumpManager\Service\DumpJobStatusService
arguments:
- '@Doctrine\DBAL\Connection'
aeon_dump_manager.dump_lister:
class: AeonDumpManager\Service\DumpLister
arguments:
- '@aeon_dump_manager.filesystem.private'
- '@aeon_dump_manager.dump_filename_parser'
aeon_dump_manager.dump_service:
class: AeonDumpManager\Service\DumpService
arguments:
- '@aeon_dump_manager.dump_lister'
- '@aeon_dump_manager.filesystem.private'
- '@aeon_dump_manager.dump_binary_locator'
- '@Doctrine\DBAL\Connection'
- '@Shopware\Core\System\SystemConfig\SystemConfigService'
- '@aeon_dump_manager.dump_filename_parser'
- '@monolog.logger.aeon_dump_manager'
# Async create job
aeon_dump_manager.message_queue.create_dump_handler:
class: AeonDumpManager\MessageQueue\Handler\CreateDumpHandler
arguments:
- '@aeon_dump_manager.dump_service'
- '@aeon_dump_manager.dump_job_status_service'
- '@monolog.logger.aeon_dump_manager'
tags:
- { name: messenger.message_handler }
# Retention
aeon_dump_manager.scheduled_task.purge_dumps_task:
class: AeonDumpManager\ScheduledTask\PurgeDumpsTask
tags:
- { name: shopware.scheduled.task }
aeon_dump_manager.scheduled_task.purge_dumps_task_handler:
class: AeonDumpManager\ScheduledTask\PurgeDumpsTaskHandler
arguments:
- '@scheduled_task.repository'
- '@monolog.logger.aeon_dump_manager'
- '@aeon_dump_manager.dump_service'
- '@aeon_dump_manager.dump_job_status_service'
- '@Shopware\Core\System\SystemConfig\SystemConfigService'
tags:
- { name: messenger.message_handler, handles: AeonDumpManager\ScheduledTask\PurgeDumpsTask }
# Console commands
aeon_dump_manager.command.dump_list:
class: AeonDumpManager\Command\DumpListCommand
arguments:
- '@aeon_dump_manager.dump_lister'
tags:
- { name: console.command }
aeon_dump_manager.command.dump_create:
class: AeonDumpManager\Command\DumpCreateCommand
arguments:
- '@aeon_dump_manager.dump_service'
tags:
- { name: console.command }
aeon_dump_manager.command.dump_remove:
class: AeonDumpManager\Command\DumpRemoveCommand
arguments:
- '@aeon_dump_manager.dump_service'
tags:
- { name: console.command }
# Admin API controller
AeonDumpManager\Controller\DumpController:
public: true
arguments:
- '@aeon_dump_manager.dump_lister'
- '@aeon_dump_manager.dump_service'
- '@aeon_dump_manager.dump_job_status_service'
- '@messenger.default_bus'
+8
View File
@@ -6,6 +6,7 @@ use AeonDumpManager\Service\Exception\DumpNotFoundException;
use AeonDumpManager\Struct\DumpFile;
use Doctrine\DBAL\Connection;
use League\Flysystem\FilesystemOperator;
use Psr\Log\LoggerInterface;
use Shopware\Core\System\SystemConfig\SystemConfigService;
use Symfony\Component\Process\Exception\ProcessFailedException;
use Symfony\Component\Process\Process;
@@ -24,6 +25,7 @@ class DumpService
private readonly Connection $connection,
private readonly SystemConfigService $systemConfigService,
private readonly DumpFilenameParser $filenameParser,
private readonly LoggerInterface $logger,
) {
}
@@ -69,6 +71,7 @@ class DumpService
}
$this->aeonDumpManagerFilesystemPrivate->delete($path);
$this->logger->info('Dump deleted.', ['filename' => $filename]);
}
/**
@@ -100,6 +103,7 @@ class DumpService
foreach ($excess as $dumpFile) {
$this->aeonDumpManagerFilesystemPrivate->delete(DumpLister::path($dumpFile->filename));
$this->logger->info('Dump removed: maxDumps exceeded.', ['filename' => $dumpFile->filename]);
}
}
@@ -108,6 +112,7 @@ class DumpService
foreach ($this->dumpLister->list() as $dumpFile) {
if ($dumpFile->datetime < $threshold) {
$this->aeonDumpManagerFilesystemPrivate->delete(DumpLister::path($dumpFile->filename));
$this->logger->info('Dump removed: older than retention.', ['filename' => $dumpFile->filename]);
}
}
}
@@ -143,6 +148,7 @@ class DumpService
if (!$process->isSuccessful()) {
@unlink($tempPath);
$this->logger->error('Dump process failed.', ['exitCode' => $process->getExitCode()]);
throw new ProcessFailedException($process);
}
@@ -153,6 +159,8 @@ class DumpService
fclose($stream);
@unlink($tempPath);
$this->logger->info('Dump created.', ['filename' => $filename, 'sizeBytes' => $sizeBytes]);
return new DumpFile($filename, $dateTime, $sizeBytes);
}