Register Paddle sandbox webhooks

This commit is contained in:
Codex Agent
2026-01-02 22:25:11 +01:00
parent 3c0e7afeb2
commit dfdbf09bf8
4 changed files with 214 additions and 0 deletions

View File

@@ -0,0 +1,132 @@
<?php
namespace App\Console\Commands;
use App\Services\Paddle\PaddleClient;
use Illuminate\Console\Command;
use Illuminate\Support\Arr;
use Illuminate\Support\Facades\Log;
class PaddleRegisterWebhooks extends Command
{
/**
* The name and signature of the console command.
*
* @var string
*/
protected $signature = 'paddle:webhooks:register
{--url= : Destination URL for Paddle webhooks}
{--description= : Description for the webhook destination}
{--events=* : Override event types to subscribe}
{--traffic-source=all : platform|simulation|all}
{--include-sensitive : Include sensitive fields in webhook payloads}
{--show-secret : Output the endpoint secret key}
{--dry-run : Output payload without creating the destination}';
/**
* The console command description.
*
* @var string
*/
protected $description = 'Register Paddle webhook notification settings.';
/**
* Execute the console command.
*/
public function handle(PaddleClient $client): int
{
$destination = (string) ($this->option('url') ?: $this->defaultWebhookUrl());
if ($destination === '') {
$this->error('Webhook destination URL is required. Use --url=...');
return self::FAILURE;
}
$events = collect((array) $this->option('events'))
->filter()
->map(fn ($event) => trim((string) $event))
->filter()
->values()
->all();
if ($events === []) {
$events = config('paddle.webhook_events', []);
}
if ($events === [] || ! is_array($events)) {
$this->error('No webhook events configured. Set config(paddle.webhook_events) or pass --events.');
return self::FAILURE;
}
$trafficSource = (string) $this->option('traffic-source');
$allowedSources = ['platform', 'simulation', 'all'];
if (! in_array($trafficSource, $allowedSources, true)) {
$this->error(sprintf('Invalid traffic source. Use one of: %s', implode(', ', $allowedSources)));
return self::FAILURE;
}
$payload = [
'type' => 'url',
'destination' => $destination,
'description' => $this->resolveDescription(),
'subscribed_events' => $events,
'traffic_source' => $trafficSource,
'include_sensitive_fields' => (bool) $this->option('include-sensitive'),
];
if ((bool) $this->option('dry-run')) {
$this->line(json_encode($payload, JSON_PRETTY_PRINT));
return self::SUCCESS;
}
$response = $client->post('/notification-settings', $payload);
$data = Arr::get($response, 'data', $response);
$id = Arr::get($data, 'id');
$secret = Arr::get($data, 'endpoint_secret_key');
Log::channel('paddle-sync')->info('Paddle webhook registered', [
'notification_setting_id' => $id,
'destination' => $destination,
'traffic_source' => $trafficSource,
]);
$this->info('Paddle webhook registered.');
if ($id) {
$this->line('ID: '.$id);
}
if ($secret && $this->option('show-secret')) {
$this->line('Secret: '.$secret);
} elseif ($secret) {
$this->line('Secret returned (hidden). Use --show-secret to display.');
}
return self::SUCCESS;
}
protected function defaultWebhookUrl(): string
{
$base = rtrim((string) config('app.url'), '/');
return $base !== '' ? $base.'/paddle/webhook' : '';
}
protected function resolveDescription(): string
{
$description = (string) $this->option('description');
if ($description !== '') {
return $description;
}
$environment = (string) config('paddle.environment', 'production');
return sprintf('Fotospiel Paddle webhooks (%s)', $environment);
}
}

View File

@@ -32,4 +32,17 @@ return [
'console_url' => $consoleUrl, 'console_url' => $consoleUrl,
'webhook_secret' => $webhookSecret, 'webhook_secret' => $webhookSecret,
'public_key' => $publicKey, 'public_key' => $publicKey,
'webhook_events' => [
'transaction.created',
'transaction.processing',
'transaction.completed',
'transaction.failed',
'transaction.cancelled',
'subscription.created',
'subscription.updated',
'subscription.paused',
'subscription.resumed',
'subscription.cancelled',
'subscription.past_due',
],
]; ];

View File

@@ -107,6 +107,31 @@ Diese Sektion ist bewusst generisch gehalten, damit sie auch nach Implementation
- Bei `transaction.failed` / `transaction.cancelled`: - Bei `transaction.failed` / `transaction.cancelled`:
- Session wird auf `failed` gesetzt, Coupons werden als fehlgeschlagen markiert. - Session wird auf `failed` gesetzt, Coupons werden als fehlgeschlagen markiert.
### 6.2.1 SandboxWebhook registrieren
- Command (Sandbox-Umgebung aktiv):
- `php artisan paddle:webhooks:register --traffic-source=simulation`
- Optional mit URL-Override:
- `php artisan paddle:webhooks:register --url=https://staging.example.com/paddle/webhook --traffic-source=simulation`
- EventListe kommt aus `config/paddle.php` (`webhook_events`). Override möglich:
- `php artisan paddle:webhooks:register --events=transaction.completed --events=subscription.created`
### 6.2.2 Verarbeitete Paddle-Events
Die WebhookHandler erwarten mindestens diese Events:
- `transaction.created`
- `transaction.processing`
- `transaction.completed` (inkl. Add-ons/GiftVouchers)
- `transaction.failed`
- `transaction.cancelled`
- `subscription.created`
- `subscription.updated`
- `subscription.paused`
- `subscription.resumed`
- `subscription.cancelled`
- `subscription.past_due`
### 6.3 Subscriptions & TenantPackages ### 6.3 Subscriptions & TenantPackages
- SubscriptionEvents (`subscription.*`) werden ebenfalls von `CheckoutWebhookService` behandelt: - SubscriptionEvents (`subscription.*`) werden ebenfalls von `CheckoutWebhookService` behandelt:

View File

@@ -0,0 +1,44 @@
<?php
namespace Tests\Feature;
use App\Services\Paddle\PaddleClient;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Mockery;
use Tests\TestCase;
class PaddleRegisterWebhooksCommandTest extends TestCase
{
use RefreshDatabase;
protected function tearDown(): void
{
Mockery::close();
parent::tearDown();
}
public function test_registers_webhook_with_configured_events(): void
{
config([
'paddle.webhook_events' => ['transaction.completed', 'subscription.created'],
]);
$client = Mockery::mock(PaddleClient::class);
$client->shouldReceive('post')
->once()
->with('/notification-settings', Mockery::on(function (array $payload): bool {
return $payload['destination'] === 'https://example.test/paddle/webhook'
&& $payload['subscribed_events'] === ['transaction.completed', 'subscription.created']
&& $payload['traffic_source'] === 'simulation';
}))
->andReturn(['data' => ['id' => 'ntfset_123']]);
$this->app->instance(PaddleClient::class, $client);
$this->artisan('paddle:webhooks:register', [
'--url' => 'https://example.test/paddle/webhook',
'--traffic-source' => 'simulation',
])->assertExitCode(0);
}
}