Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
a411e6bbc1 | ||
|
|
910fa94395 | ||
|
|
fdd1899c34 | ||
|
|
3ad3a1b4d6 | ||
|
|
68233f43ef | ||
|
|
027f7e8982 | ||
|
|
c084eb47cb | ||
|
|
58d165acc3 | ||
|
|
44ad943eec | ||
|
|
e7784364fd | ||
|
|
59303cf25f | ||
|
|
af380a7fa0 | ||
|
|
9f540cbaa4 |
@@ -4,6 +4,63 @@ All notable changes to this project will be documented in this file.
|
||||
|
||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
|
||||
|
||||
## [0.18.1] - 2026-09-16
|
||||
|
||||
### Added
|
||||
- `Modules\Core\Payment\Privacy\PaymentDataProvider` — `lunar_transactions` (`card_type`/
|
||||
`last_four`) and `stripe_payment_intents` were previously uncovered by any Privacy provider.
|
||||
Pseudonymizes card metadata on erasure (same tax/accounting retention reasoning as
|
||||
`OrderDataProvider`); deletes the Stripe correlation rows outright, since their only purpose
|
||||
(resolving an async webhook callback) has already been served by the time an erasure request
|
||||
runs. No Stripe Customer object exists anywhere in this app to also request deletion of — see
|
||||
`docs/payments.md` "Reconciliation".
|
||||
- `Modules\Core\Auth\Privacy\UserSessionDataProvider` — `user_sessions` (`ip_address`,
|
||||
`user_agent`) was previously uncovered. User-scope only; deleted outright on erasure, no legal
|
||||
retention argument applies to login-session metadata.
|
||||
- `Modules\Core\Logging\Privacy\ActivityLogDataProvider` — Spatie's `activity_log` table
|
||||
(`Modules\Core\Logging\ActivityLogService`, plus several Lunar models' native `LogsActivity`)
|
||||
durably retained full PII snapshots in `properties` even after the real row was erased
|
||||
elsewhere. Redacts `properties` by subject (`Customer`/`Address`/`CartAddress`/`OrderAddress`/
|
||||
`Transaction`) on erasure; deliberately never touches `causer_id`, which is an actor reference,
|
||||
not PII content. Must run before `AddressDataProvider` in `config('core.privacy.providers')` —
|
||||
see the class's own docblock.
|
||||
- `ErasureOutcome::Failed` — a provider throwing an exception is now a genuine, distinct outcome
|
||||
from `Skipped` (a deliberate no-op), surfaced in the erasure report rather than silently
|
||||
aborting the request.
|
||||
|
||||
### Fixed
|
||||
- `PrivacyService::completeErasure()` and `ExportDataSubjectJob::handle()` ran every registered
|
||||
provider through a plain `array_map()` with no per-provider error handling — one provider
|
||||
throwing aborted the entire request, discarding every other provider's already-computed
|
||||
result and leaving the request stuck `Pending`/`Failed` with no report at all. Both now catch
|
||||
per-provider (`PrivacyService::safeErase()`, `ExportDataSubjectJob::safeExport()`), logging the
|
||||
exception and recording `ErasureOutcome::Failed`/`ProviderExportResult::$error` for that one
|
||||
provider while every other provider's result is still recorded normally. Verified live:
|
||||
simulating a throwing provider mid-erasure now correctly completes the request with a mixed
|
||||
`erased`/`failed`/`erased` report instead of leaving it `Pending` forever.
|
||||
- `CartDataProvider`/`OrderDataProvider` never covered PII-adjacent keys living in `Cart.meta`/
|
||||
`Order.meta`/`OrderAddress.meta` — `recovery_consent*`, `payment_method`, `checkout_fingerprint`
|
||||
(Cart), `terms_accepted*` (Order), and `box_now_locker` (OrderAddress) all survived an erasure
|
||||
request untouched. Both providers now clear these keys alongside their existing address/
|
||||
free-text field erasure.
|
||||
- `CustomerDataProvider::eraseForUser()` left `otp_code`/`otp_expires_at`/`otp_attempts` on an
|
||||
otherwise-erased `User` row. Now cleared alongside name/email.
|
||||
- `Modules\Core\Privacy\Filament\Resources\DataErasureRequestResource`'s "Outcome" section
|
||||
referenced `docs/privacy.md` directly in staff-facing UI text (meaningless to a user with no
|
||||
repo access) and rendered the per-provider report as raw JSON strings via a `KeyValueEntry`
|
||||
(the wrong component for a list of structured rows). Replaced with a plain-language
|
||||
description and a proper `RepeatableEntry` table (Data category / Outcome badge / Reason).
|
||||
|
||||
### Changed
|
||||
- The 5 existing Privacy providers (`CustomerDataProvider`, `AddressDataProvider`,
|
||||
`OrderDataProvider`, `CartDataProvider`, `ReviewDataProvider`) moved out of
|
||||
`Modules\Core\Privacy\Providers` into their owning domain module's own `Privacy/` subdirectory
|
||||
(e.g. `Modules\Core\Order\Privacy\OrderDataProvider`) — `Modules\Core\Privacy` now owns only
|
||||
the shared contract, request lifecycle, and DTOs/enums. Matters concretely if a module is ever
|
||||
extracted into its own composer package: the provider that knows how to erase that module's
|
||||
data now travels with it, rather than being stranded in `Privacy` depending on a package that
|
||||
no longer ships in this repo. See `docs/privacy.md` for the full reasoning.
|
||||
|
||||
## [0.18.0] - 2026-09-16
|
||||
|
||||
### Added
|
||||
|
||||
@@ -1,6 +1,9 @@
|
||||
# Core Module
|
||||
|
||||
A Laravel module providing authentication, notifications, activity logging, CLI tooling, and functional types on top of the [Lunar](https://lunarphp.io) admin panel. Designed to be consumed as a standalone Composer package.
|
||||
A Laravel module providing authentication, localization, product search/catalog, privacy/GDPR
|
||||
tooling, notifications, activity logging, CLI tooling, and functional types on top of the
|
||||
[Lunar](https://lunarphp.io) e-commerce package. Designed to be consumed as a standalone Composer
|
||||
package by any Lunar-based e-shop.
|
||||
|
||||
---
|
||||
|
||||
@@ -8,13 +11,83 @@ A Laravel module providing authentication, notifications, activity logging, CLI
|
||||
|
||||
### OTP Authentication
|
||||
|
||||
Passwordless login for both staff (Lunar panel) and customers via 6-digit codes delivered by email. Codes expire after 10 minutes. The Lunar panel login page is a two-step flow: email → OTP. Rate-limited to 5 attempts.
|
||||
Passwordless login for both staff (Lunar panel) and customers via 6-digit codes delivered by
|
||||
email. Codes expire after 10 minutes, rate-limited to 5 attempts. The Lunar panel login page is a
|
||||
two-step flow (email → OTP) with a back button to return from the code step to the email step.
|
||||
|
||||
See [`docs/otp-auth.md`](docs/otp-auth.md).
|
||||
|
||||
### Localization
|
||||
|
||||
Locale-prefixed routing (`Modules\Core\Localization\LocaleMiddleware`) — a `locale` route
|
||||
middleware, opt-in per shop, that resolves and redirects to the correct language segment
|
||||
(`/el/...`, `/en/...`) based on Lunar's own language list, with caching and rename-safe
|
||||
translation migration. Also brings in storefront UI label translations
|
||||
(`spatie/laravel-translation-loader`) with an admin-editable `LanguageLine` resource.
|
||||
|
||||
See [`docs/localization.md`](docs/localization.md).
|
||||
|
||||
### Product Search & Catalog
|
||||
|
||||
Two complementary services on top of Meilisearch:
|
||||
|
||||
- **`Modules\Core\Search\ProductSearchService`** — locale-aware full-text product search.
|
||||
- **`Modules\Core\Catalog\ProductService`** — listing/filtering (by collection, brand, price
|
||||
range) and single-product lookup by id or slug, reading directly from the Meilisearch index
|
||||
rather than the database.
|
||||
|
||||
Both are backed by `Modules\Core\Search\ProductIndexer`, which extends Lunar's own indexer with
|
||||
collections, price, variants, media, tags, and reviews — everything needed for both a listing
|
||||
page and a full product detail page from one index.
|
||||
|
||||
See [`docs/product-search.md`](docs/product-search.md) and
|
||||
[`docs/product-listing.md`](docs/product-listing.md).
|
||||
|
||||
### Product Reviews
|
||||
|
||||
`Modules\Core\Review\ProductReview` — ratings/reviews with staff replies, a Filament sub-navigation
|
||||
page on the product edit screen, and automatic re-indexing (via `ReviewServiceProvider`) whenever
|
||||
a review is created, updated, or deleted, so a product's Meilisearch document never goes stale.
|
||||
|
||||
### Privacy / GDPR Data-Subject Requests
|
||||
|
||||
Right of access (export) and right of erasure, built as an extensible contract
|
||||
(`Modules\Core\Privacy\Contracts\PersonalDataProvider`) rather than a fixed table list — any
|
||||
module can register its own data without core knowing it exists.
|
||||
|
||||
- **Two independent scopes**: erasing/exporting a Lunar `Customer` (business account) is never
|
||||
the same operation as erasing/exporting a `User` (individual login) — a `Customer` erasure
|
||||
never touches any linked `User`'s login, and a `User` erasure never touches a `Customer`
|
||||
account's own data. See `docs/privacy.md` "User-scope vs Customer-scope".
|
||||
- **Cancellable grace period** (default 30 days, configurable) before anything is actually
|
||||
erased — logging back in during the window automatically reverts the request, mirroring
|
||||
Shopify's own account-deletion flow. Immediate erasure exists but is staff-only by type, never
|
||||
reachable from a self-service flow.
|
||||
- **Sole-owner cascade**: erasing the last remaining `User` on a `Customer` also opens a (grace
|
||||
period) erasure request for that now-orphaned `Customer`, so its PII doesn't sit unreachable
|
||||
forever — traced back to the triggering request so login-reactivation can revert exactly that
|
||||
cascade.
|
||||
- **Queued export**: gathering data and writing a CSV-per-provider zip (via the generic,
|
||||
reusable `Modules\Core\Export\CsvWriter`) runs as a background job; a consuming app hooks its
|
||||
own notification onto the completion event via the Notification Registry (below).
|
||||
|
||||
See [`docs/privacy.md`](docs/privacy.md).
|
||||
|
||||
### Shopify Migration
|
||||
|
||||
`Modules\Core\MigrateImport\Shopify\ShopifyExportImporter` — imports a Shopify CSV product export
|
||||
(products, variants, images, collections, tags, prices) into Lunar, idempotently re-runnable via
|
||||
an `import_mappings` table. Part of a source-agnostic import framework
|
||||
(`boboko:migrate:import`) designed to support additional sources later.
|
||||
|
||||
See [`docs/shopify-import.md`](docs/shopify-import.md).
|
||||
|
||||
### Notification Registry
|
||||
|
||||
An event-driven notification system. Each notification class declares which event it listens to and who to notify — the registry wires up the listener automatically. All notifications extend `BaseNotification` which implements `ShouldQueue`, so delivery is async. Supports optional delays.
|
||||
An event-driven notification system. Each notification class declares which event it listens to
|
||||
and who to notify — the registry wires up the listener automatically. All notifications extend
|
||||
`BaseNotification`, which implements `ShouldQueue`, so delivery is async. Supports optional
|
||||
delays.
|
||||
|
||||
**Creating a notification:**
|
||||
|
||||
@@ -33,9 +106,13 @@ class MyNotification extends BaseNotification
|
||||
NotificationRegistry::get()->register([MyNotification::class]);
|
||||
```
|
||||
|
||||
See [`docs/notifications.md`](docs/notifications.md).
|
||||
|
||||
### Activity Logging
|
||||
|
||||
Thin wrapper around [Spatie Laravel Activity Log](https://github.com/spatie/laravel-activitylog). Four standardized methods: `created()`, `updated()`, `failed()`, `deleted()`. Logs to the `lunar` channel and auto-resolves the actor from the staff session.
|
||||
Thin wrapper around [Spatie Laravel Activity Log](https://github.com/spatie/laravel-activitylog).
|
||||
Four standardized methods: `created()`, `updated()`, `failed()`, `deleted()`. Logs to the `lunar`
|
||||
channel and auto-resolves the actor from the staff session.
|
||||
|
||||
See [`docs/activity-log.md`](docs/activity-log.md).
|
||||
|
||||
@@ -43,8 +120,11 @@ See [`docs/activity-log.md`](docs/activity-log.md).
|
||||
|
||||
- Custom OTP login page replacing the default Lunar panel login
|
||||
- `StaffResourceExtension` — removes password field from Lunar's staff resource
|
||||
- `CustomerResourceExtension` — replaces default address relation manager with a custom implementation
|
||||
- `CorePlugin` — configures panel path, branding, logos, navigation items, and activity log field exclusions for staff
|
||||
- `CustomerResourceExtension` — replaces default address relation manager with a custom
|
||||
implementation
|
||||
- Table-rate shipping (`ShippingPlugin`) registered by default
|
||||
- `CorePlugin` — configures panel path, branding, logos, navigation items, and activity log
|
||||
field exclusions for staff
|
||||
|
||||
Register the plugin in your Lunar panel provider:
|
||||
|
||||
@@ -52,30 +132,36 @@ Register the plugin in your Lunar panel provider:
|
||||
->plugin(\Modules\Core\CorePlugin::make())
|
||||
```
|
||||
|
||||
See [`docs/lunar.md`](docs/lunar.md) for the full Lunar reference and non-obvious gotchas hit
|
||||
while building against it.
|
||||
|
||||
### CLI Commands
|
||||
|
||||
| Command | Description |
|
||||
|---|---|
|
||||
| `core:create-admin` | Create a Lunar admin user |
|
||||
| `core:anonymize` | GDPR anonymization of users and customers (local only) |
|
||||
| `core:export` | Dump database + storage files to a timestamped zip |
|
||||
| `core:import` | Restore from a zip export (runs anonymize automatically, local only) |
|
||||
| `core:export-cleanup` | Delete old export zips, keep N most recent |
|
||||
| `boboko:anonymize` | Dummy-scrub personal data in `users`/`lunar_customers` for local dev safety (local environment only — **not** the GDPR erasure tool; see Privacy above for that) |
|
||||
| `boboko:export` | Dump database + storage files to a timestamped zip |
|
||||
| `boboko:import` | Restore from a `boboko:export` zip archive |
|
||||
| `boboko:export:cleanup` | Delete old export zips, keep N most recent |
|
||||
| `boboko:migrate:import` | Import a vendor product catalog (Shopify, etc.) into Lunar |
|
||||
| `boboko:privacy:process-erasure-requests` | Dispatch an erasure job for every due GDPR erasure request (wire into your own scheduler) |
|
||||
| `lunar:create-admin` | Create a Lunar admin user (overrides Lunar's own command) |
|
||||
| `lunar:install` | Seed default Lunar store data — countries, channel, currency, tax zone, attributes, product type (overrides Lunar's own command) |
|
||||
|
||||
### Functional Types
|
||||
|
||||
Result and Option monads for explicit error handling without exceptions.
|
||||
Result and Option types for explicit error handling without exceptions.
|
||||
|
||||
```php
|
||||
// Result<T, E>
|
||||
$result = Success::of($value);
|
||||
$result = Error::of('something went wrong');
|
||||
$result = Success::create($value);
|
||||
$result = Error::create('something went wrong');
|
||||
$result->map(fn($v) => ...)->flatMap(fn($v) => ...);
|
||||
|
||||
// Option<T>
|
||||
$option = Option::fromValue($nullableValue);
|
||||
$option->getOrElse('default');
|
||||
$option->map(fn($v) => ...)->filter(fn($v) => $v > 0);
|
||||
$option = Some::create($value);
|
||||
$option = None::create();
|
||||
$option->map(fn($v) => ...);
|
||||
```
|
||||
|
||||
---
|
||||
@@ -102,17 +188,22 @@ Then run:
|
||||
|
||||
```bash
|
||||
composer require boboko/core
|
||||
php artisan vendor:publish --tag=core-config
|
||||
php artisan vendor:publish --tag=core-assets
|
||||
php artisan migrate
|
||||
```
|
||||
|
||||
For local core development alongside a consuming app (path-repo symlink + Docker mount), see
|
||||
[`docs/modules.md`](docs/modules.md) "Docker Compose: the local-core mount".
|
||||
|
||||
---
|
||||
|
||||
## Requirements
|
||||
|
||||
- PHP 8.2+
|
||||
- Laravel 11+
|
||||
- Lunar (lunarphp/lunar + lunarphp/admin)
|
||||
- PHP 8.5+
|
||||
- Laravel 12+
|
||||
- Lunar 1.3 (`lunarphp/lunar`)
|
||||
- Meilisearch (for product search/listing/catalog)
|
||||
- Spatie Laravel Activity Log
|
||||
|
||||
---
|
||||
@@ -120,7 +211,12 @@ php artisan migrate
|
||||
## Documentation
|
||||
|
||||
- [`docs/otp-auth.md`](docs/otp-auth.md) — OTP authentication flow
|
||||
- [`docs/localization.md`](docs/localization.md) — Locale-prefixed routing and storefront translations
|
||||
- [`docs/product-search.md`](docs/product-search.md) — Full-text product search
|
||||
- [`docs/product-listing.md`](docs/product-listing.md) — Product listing/filtering/detail catalog service
|
||||
- [`docs/privacy.md`](docs/privacy.md) — GDPR right of access/erasure, User-scope vs Customer-scope
|
||||
- [`docs/shopify-import.md`](docs/shopify-import.md) — Shopify CSV → Lunar field mapping and import design
|
||||
- [`docs/activity-log.md`](docs/activity-log.md) — Activity logging
|
||||
- [`docs/lunar.md`](docs/lunar.md) — Lunar framework reference
|
||||
- [`docs/notifications.md`](docs/notifications.md) — Notification registry
|
||||
- [`docs/lunar.md`](docs/lunar.md) — Lunar framework reference and gotchas
|
||||
- [`docs/modules.md`](docs/modules.md) — Module architecture, Customer/User pairing, provider registration pitfalls
|
||||
|
||||
+3
-2
@@ -2,7 +2,7 @@
|
||||
"name": "boboko/core",
|
||||
"description": "Core module — authentication and shared panel behaviour",
|
||||
"type": "library",
|
||||
"version": "0.18.0",
|
||||
"version": "0.18.1",
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
"Modules\\Core\\": "src/"
|
||||
@@ -44,7 +44,8 @@
|
||||
"Modules\\Core\\Providers\\CartServiceProvider",
|
||||
"Modules\\Core\\Providers\\ReviewServiceProvider",
|
||||
"Modules\\Core\\Providers\\ShippingServiceProvider",
|
||||
"Modules\\Core\\Providers\\OrderServiceProvider"
|
||||
"Modules\\Core\\Providers\\OrderServiceProvider",
|
||||
"Modules\\Core\\Providers\\PrivacyServiceProvider"
|
||||
]
|
||||
}
|
||||
},
|
||||
|
||||
@@ -16,6 +16,43 @@ return [
|
||||
|
||||
'auto_create_customer_for_user' => true,
|
||||
|
||||
/*
|
||||
|--------------------------------------------------------------------------
|
||||
| Privacy / GDPR data-subject requests
|
||||
|--------------------------------------------------------------------------
|
||||
|
|
||||
| 'providers' lists every Modules\Core\Privacy\Contracts\PersonalDataProvider
|
||||
| that should be consulted for right-of-access/right-of-erasure requests. A
|
||||
| module never needs to be known to core in advance — it just adds its own
|
||||
| provider class here, the same way config('lunar.search.indexers') maps a
|
||||
| model to its indexer. See docs/privacy.md.
|
||||
|
|
||||
| 'grace_period_days' is how long an erasure request stays cancellable
|
||||
| (account deactivated, not yet erased) before it's actually processed by
|
||||
| the privacy:process-erasure-requests scheduled command.
|
||||
|
|
||||
*/
|
||||
|
||||
'privacy' => [
|
||||
'providers' => [
|
||||
// ActivityLogDataProvider MUST run before AddressDataProvider —
|
||||
// it resolves which activity_log rows belong to this customer
|
||||
// (including ones keyed by an Address id) before
|
||||
// AddressDataProvider hard-deletes those Address rows. See that
|
||||
// provider's own class docblock.
|
||||
\Modules\Core\Logging\Privacy\ActivityLogDataProvider::class,
|
||||
\Modules\Core\Customer\Privacy\CustomerDataProvider::class,
|
||||
\Modules\Core\Customer\Privacy\AddressDataProvider::class,
|
||||
\Modules\Core\Order\Privacy\OrderDataProvider::class,
|
||||
\Modules\Core\Cart\Privacy\CartDataProvider::class,
|
||||
\Modules\Core\Review\Privacy\ReviewDataProvider::class,
|
||||
\Modules\Core\Payment\Privacy\PaymentDataProvider::class,
|
||||
\Modules\Core\Auth\Privacy\UserSessionDataProvider::class,
|
||||
],
|
||||
|
||||
'grace_period_days' => 30,
|
||||
],
|
||||
|
||||
/*
|
||||
|--------------------------------------------------------------------------
|
||||
| Cart Abandonment Threshold
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
<?php
|
||||
|
||||
use Illuminate\Database\Migrations\Migration;
|
||||
use Illuminate\Database\Schema\Blueprint;
|
||||
use Illuminate\Support\Facades\Schema;
|
||||
|
||||
return new class extends Migration
|
||||
{
|
||||
public function up(): void
|
||||
{
|
||||
Schema::table('users', function (Blueprint $table) {
|
||||
$table->timestamp('deactivated_at')->nullable()->after('otp_expires_at');
|
||||
});
|
||||
}
|
||||
|
||||
public function down(): void
|
||||
{
|
||||
Schema::table('users', function (Blueprint $table) {
|
||||
$table->dropColumn('deactivated_at');
|
||||
});
|
||||
}
|
||||
};
|
||||
@@ -0,0 +1,56 @@
|
||||
<?php
|
||||
|
||||
use Illuminate\Database\Migrations\Migration;
|
||||
use Illuminate\Database\Schema\Blueprint;
|
||||
use Illuminate\Support\Facades\Schema;
|
||||
|
||||
return new class extends Migration
|
||||
{
|
||||
public function up(): void
|
||||
{
|
||||
Schema::create('data_erasure_requests', function (Blueprint $table) {
|
||||
$table->id();
|
||||
// Polymorphic, not a fixed customer_id — a request targets either a
|
||||
// Lunar Customer (business account) or a User (individual), never
|
||||
// both at once. See docs/privacy.md "User-scope vs Customer-scope".
|
||||
$table->string('subject_type');
|
||||
$table->unsignedBigInteger('subject_id');
|
||||
// Snapshot, not a live-looked-up value — the subject's email may
|
||||
// change or the record may be gone by the time this is read.
|
||||
$table->string('email')->nullable();
|
||||
// Who asked for this: the subject themselves (self-service deletion)
|
||||
// or a staff member acting on their behalf. Plain nullable type+id
|
||||
// columns rather than morphs() — only ever one of two concrete actor
|
||||
// types, not an open-ended polymorphic set.
|
||||
$table->string('requested_by_type');
|
||||
$table->unsignedBigInteger('requested_by_id');
|
||||
$table->string('status')->default('pending');
|
||||
// Set only on a Customer-scoped request that was auto-created because
|
||||
// erasing a User left them as the sole remaining user on that Customer
|
||||
// (see Modules\Core\Privacy\Listeners\CascadeCustomerErasureListener).
|
||||
// Null for every normal, directly-requested erasure. Lets login-
|
||||
// reactivation find and revert exactly the Customer request THIS
|
||||
// User's cancellation caused, without touching an unrelated,
|
||||
// independently-requested Customer erasure the User happens to be
|
||||
// linked to.
|
||||
$table->foreignId('caused_by_request_id')->nullable()->constrained('data_erasure_requests')->nullOnDelete();
|
||||
// now() + config('core.privacy.grace_period_days') at creation time —
|
||||
// when privacy:process-erasure-requests will actually run this.
|
||||
$table->timestamp('scheduled_for');
|
||||
$table->timestamp('cancelled_at')->nullable();
|
||||
$table->timestamp('completed_at')->nullable();
|
||||
// Every provider's outcome, written once the request completes —
|
||||
// see Modules\Core\Privacy\ErasureReport. Null until then.
|
||||
$table->json('report')->nullable();
|
||||
$table->timestamps();
|
||||
|
||||
$table->index(['status', 'scheduled_for']);
|
||||
$table->index(['subject_type', 'subject_id']);
|
||||
});
|
||||
}
|
||||
|
||||
public function down(): void
|
||||
{
|
||||
Schema::dropIfExists('data_erasure_requests');
|
||||
}
|
||||
};
|
||||
@@ -0,0 +1,36 @@
|
||||
<?php
|
||||
|
||||
use Illuminate\Database\Migrations\Migration;
|
||||
use Illuminate\Database\Schema\Blueprint;
|
||||
use Illuminate\Support\Facades\Schema;
|
||||
|
||||
return new class extends Migration
|
||||
{
|
||||
public function up(): void
|
||||
{
|
||||
Schema::create('data_export_requests', function (Blueprint $table) {
|
||||
$table->id();
|
||||
// Polymorphic, not a fixed customer_id — see data_erasure_requests
|
||||
// for the same shape and reasoning.
|
||||
$table->string('subject_type');
|
||||
$table->unsignedBigInteger('subject_id');
|
||||
// Snapshot, not a live lookup — same reasoning as
|
||||
// data_erasure_requests.email (see that migration).
|
||||
$table->string('email')->nullable();
|
||||
$table->string('status')->default('pending');
|
||||
// Storage path of the assembled export .zip, set once the queued job
|
||||
// finishes. Null while pending.
|
||||
$table->string('file_path')->nullable();
|
||||
$table->timestamp('completed_at')->nullable();
|
||||
$table->timestamps();
|
||||
|
||||
$table->index('status');
|
||||
$table->index(['subject_type', 'subject_id']);
|
||||
});
|
||||
}
|
||||
|
||||
public function down(): void
|
||||
{
|
||||
Schema::dropIfExists('data_export_requests');
|
||||
}
|
||||
};
|
||||
+55
-16
@@ -145,23 +145,20 @@ produced had it resolved synchronously.
|
||||
with no memory of the request that started the payment. Something has to persist enough to
|
||||
answer "which order/cart does gateway reference X belong to?" between the two calls.
|
||||
|
||||
**Read directly from `lunarphp/stripe`'s own source** (`StripePaymentType::authorize()`,
|
||||
`ProcessStripeWebhook`, `WebhookController`) to see how Lunar itself solves this — confirmed
|
||||
it does **not** stash a generic opaque blob. It writes the correlating ids as real, typed
|
||||
columns on `Lunar\Stripe\Models\StripePaymentIntent` (`cart_id`, `order_id`) at the moment the
|
||||
intent is created/first seen, then reads them back the same way when the webhook arrives:
|
||||
The precedent for this originally came from reading `lunarphp/stripe`'s own source
|
||||
(`StripePaymentType::authorize()`, `ProcessStripeWebhook`, `WebhookController`) — that package
|
||||
solved this the same way, writing the correlating ids as real, typed columns on its own
|
||||
`StripePaymentIntent` model rather than a generic opaque blob. **`lunarphp/stripe` has since
|
||||
been removed from this project** in favour of depending on `stripe/stripe-php` directly (see
|
||||
CHANGELOG.md) — `Modules\Core\Payment\Models\StripePaymentIntent` is now a first-party model
|
||||
over the same table shape, kept for exactly the same reason.
|
||||
|
||||
```php
|
||||
// ProcessStripeWebhook::handle() — falls back through two real lookups,
|
||||
// neither of them a generic context blob:
|
||||
$cart = StripePaymentIntent::where('intent_id', $this->paymentIntentId)->first()?->cart
|
||||
?: Cart::where('meta->payment_intent', '=', $this->paymentIntentId)->first();
|
||||
```
|
||||
|
||||
**`StripePaymentDriver` follows this exact precedent**: it reads `cart_id`/`order_id` out of
|
||||
`$context` at `pay()`/`authorize()` time and writes them onto its own `StripePaymentIntent`
|
||||
row (a table already owned by `lunarphp/stripe`, already shaped for exactly this), then reads
|
||||
them back the same way in `handleCallback()`. No generic `context` json column, no new table.
|
||||
**`StripePaymentDriver` follows this pattern**: it reads `cart_id`/`order_id` out of `$context`
|
||||
at `pay()`/`authorize()` time and writes them onto its own `StripePaymentIntent` row (`src/
|
||||
Payment/Models/StripePaymentIntent.php`, table `stripe_payment_intents`), then reads them back
|
||||
the same way in `handleCallback()`. No generic `context` json column beyond what that table
|
||||
already carries (`context`, added for a different purpose — see that migration's own
|
||||
docblock), no new table.
|
||||
|
||||
### This pattern is per-driver, not a shared table
|
||||
|
||||
@@ -176,6 +173,48 @@ a shared generic one.
|
||||
|
||||
---
|
||||
|
||||
## Reconciliation — a charge that succeeds on Stripe but is never written locally
|
||||
|
||||
This app never creates or reuses a Stripe **Customer** object — every PaymentIntent is a
|
||||
one-off (`StripePaymentDriver::createAndConfirm()`'s own `$params` never includes a `customer`
|
||||
key), and nothing calls Stripe's Customer API anywhere in this codebase. That's a deliberate
|
||||
choice, not an oversight: a Customer object only earns its keep if something actually needs it
|
||||
(saved/reusable payment methods, subscriptions, Stripe-side lifetime-value grouping across
|
||||
orders) — none of which exist in this checkout flow today. Creating one anyway would just be
|
||||
more PII sitting on a third party's servers for no functional benefit, and it would become
|
||||
another cross-reference a future Payment privacy provider has to account for (detaching/
|
||||
deleting the Customer on erasure, not just the local PaymentIntent row). If a real feature
|
||||
needs it later (e.g. "save my card"), add it then, scoped to that feature.
|
||||
|
||||
The gap this creates: with no Customer object and no other identifying field previously sent
|
||||
to Stripe, a PaymentIntent that succeeds on Stripe's side but is never written to our own DB
|
||||
(e.g. a database outage at exactly the wrong moment, between Stripe confirming the charge and
|
||||
`rememberIntent()`'s insert) would be **untraceable** back to a cart or order — nothing to
|
||||
search Stripe's dashboard by except amount, timestamp, and card last-4.
|
||||
|
||||
**Fix**: `createAndConfirm()` now sets `metadata: ['cart_id' => ..., 'order_id' => ...]`
|
||||
(`array_filter()`-ed, since `order_id` isn't known yet at initial `pay()`/`authorize()` time —
|
||||
same null-coalesce `rememberIntent()` already does) on every PaymentIntent. This is metadata
|
||||
only, visible on Stripe's own dashboard/API for manual reconciliation — it does not create a
|
||||
Customer object and does not change anything about how `handleCallback()`/webhook correlation
|
||||
works (that still goes through `stripe_payment_intents`, per "Async resolution" above). It's
|
||||
purely a recovery aid for the case where our own write never happened at all.
|
||||
|
||||
---
|
||||
|
||||
## GDPR erasure/export
|
||||
|
||||
`Modules\Core\Payment\Privacy\PaymentDataProvider` covers `lunar_transactions`
|
||||
(`card_type`/`last_four`) and `stripe_payment_intents` — see `docs/privacy.md` for the full
|
||||
right-of-erasure/right-of-access design. Pseudonymizes card metadata on erasure (same
|
||||
tax/accounting retention reasoning `Order`'s own provider uses) and deletes the Stripe
|
||||
correlation rows outright, since their only purpose — resolving an async webhook callback, see
|
||||
"Async resolution" above — has already been served by the time an erasure request runs. No
|
||||
Stripe Customer object exists anywhere in this app (see "Reconciliation" above) for this
|
||||
provider to also request deletion of.
|
||||
|
||||
---
|
||||
|
||||
## Explicitly out of scope for this pass
|
||||
|
||||
- **`Checkout`/`Order` wiring** — how `Checkout` calls into `Payment`, how `Order`/`Checkout`
|
||||
|
||||
+417
@@ -0,0 +1,417 @@
|
||||
# Privacy / GDPR Data-Subject Requests
|
||||
|
||||
`Modules\Core\Privacy` implements the right of access (export) and right of erasure for
|
||||
customers, as an extensible contract rather than a fixed list of tables — any module (core,
|
||||
or a future ERP/banking/etc. module) can register its own data without core knowing it exists.
|
||||
|
||||
---
|
||||
|
||||
## User-scope vs Customer-scope — two genuinely different operations
|
||||
|
||||
A Lunar `Customer` (business account: orders, addresses, buyer record) and a `User` (individual
|
||||
login identity) are linked many-to-many via the `customer_user` pivot (see `docs/modules.md`
|
||||
"Customer/User Pairing") — **one User can belong to many Customer accounts, and one Customer
|
||||
account can have many linked Users.** This is the real shape of B2B multi-seat access: a person
|
||||
can have login access to several separate business accounts, and a business account can have
|
||||
several employees each with their own login.
|
||||
|
||||
That means "delete my personal data" and "delete this business account" are not the same request,
|
||||
and conflating them is actively wrong:
|
||||
|
||||
- **Erasing a Customer must never touch any linked User's login or identity.** Erasing "Acme
|
||||
Corp" must not deactivate or destroy access for the employees who work there — and must not
|
||||
touch any *other* Customer account, even one sharing some of the same Users.
|
||||
- **Erasing a User must never touch any Customer account's own data.** John asking to delete
|
||||
*his* account must clear his name/email/login wherever it appears — and correctly end his
|
||||
membership on every Customer he's linked to (detach the pivot) — but must not erase Acme Corp's
|
||||
orders or addresses, and must not affect any other employee still linked to Acme Corp.
|
||||
|
||||
Every part of this module is split along that line — a `PersonalDataProvider`, a `PrivacyService`
|
||||
method, a request record — is always explicitly **for a Customer** or **for a User**, never both
|
||||
at once, and never one with an implicit cascade into the other.
|
||||
|
||||
---
|
||||
|
||||
## Why an extensible contract, not a hardcoded script
|
||||
|
||||
A GDPR erasure/export request has to touch every module that holds personal data, but core can't
|
||||
know in advance what future modules will exist or what data they'll hold — and different data
|
||||
needs fundamentally different handling (freely erasable PII vs. financial records that must be
|
||||
pseudonymized-not-deleted for legal retention vs. data that must be retained outright). There's
|
||||
deliberately no central taxonomy for this in the contract — each module owns its own retention
|
||||
judgment, since only the module that owns a table actually knows its legal requirements.
|
||||
|
||||
`Modules\Core\Privacy\Contracts\PersonalDataProvider` is the whole contract:
|
||||
|
||||
```php
|
||||
interface PersonalDataProvider
|
||||
{
|
||||
public function name(): string;
|
||||
|
||||
public function exportForUser(UserSubject $subject): ProviderExportResult;
|
||||
public function exportForCustomer(CustomerSubject $subject): ProviderExportResult;
|
||||
|
||||
public function eraseForUser(UserSubject $subject): ProviderErasureResult;
|
||||
public function eraseForCustomer(CustomerSubject $subject): ProviderErasureResult;
|
||||
}
|
||||
```
|
||||
|
||||
Every provider implements all four methods. A provider with nothing relevant to one scope
|
||||
implements that method as a no-op — `ErasureOutcome::Skipped` with a reason for erase, an empty
|
||||
payload for export (e.g. `AddressDataProvider::eraseForUser()`, since addresses belong to a
|
||||
Customer, not an individual).
|
||||
|
||||
A provider implementation lives inside the module that owns the data it erases/exports, under
|
||||
that module's own `Privacy/` subdirectory (e.g. `Modules\Core\Order\Privacy\OrderDataProvider`,
|
||||
`Modules\Core\Customer\Privacy\CustomerDataProvider`) — never inside `Modules\Core\Privacy`
|
||||
itself, which only owns the shared contract (`Contracts\PersonalDataProvider`), the request
|
||||
lifecycle (`Services\PrivacyManager`/`PrivacyService`), and the DTOs/enums every provider
|
||||
returns. This mirrors how this codebase already handles other cross-cutting-but-domain-specific
|
||||
code (e.g. a resource's own `Filament/Extensions/` subdirectory) — and matters concretely if a
|
||||
module is ever extracted into its own composer package (see `docs/modules.md`): the provider
|
||||
that knows how to erase that module's data must travel with it, not get stranded in `Privacy`
|
||||
depending on a package that no longer ships in this repo.
|
||||
|
||||
A module registers by adding its provider class to `config('core.privacy.providers')` — the
|
||||
same shape as Lunar's own `config('lunar.search.indexers')` model→indexer map:
|
||||
|
||||
```php
|
||||
// config/core.php
|
||||
'privacy' => [
|
||||
'providers' => [
|
||||
\Modules\Core\Customer\Privacy\CustomerDataProvider::class,
|
||||
\Modules\Core\Customer\Privacy\AddressDataProvider::class,
|
||||
\Modules\Core\Order\Privacy\OrderDataProvider::class,
|
||||
\Modules\Core\Cart\Privacy\CartDataProvider::class,
|
||||
\Modules\Core\Review\Privacy\ReviewDataProvider::class,
|
||||
// A future module just adds its own provider here.
|
||||
],
|
||||
],
|
||||
```
|
||||
|
||||
`PrivacyManager` resolves each class via the container and asserts every `name()` is unique —
|
||||
two providers registering the same name throws, so a naming collision fails loudly at
|
||||
resolution time rather than silently overwriting one provider's data in an export/report.
|
||||
|
||||
---
|
||||
|
||||
## `UserSubject` and `CustomerSubject` — identifying "the person" vs "the account"
|
||||
|
||||
Two separate value objects, not one — each deliberately carries only what its own scope needs, so
|
||||
a provider can't accidentally reach across the boundary:
|
||||
|
||||
```php
|
||||
class CustomerSubject
|
||||
{
|
||||
public readonly int $customerId;
|
||||
// No userIds, no email — Customer-scope has no business knowing about logins.
|
||||
}
|
||||
|
||||
class UserSubject
|
||||
{
|
||||
public readonly int $userId;
|
||||
public readonly ?string $email;
|
||||
// No customerId — one User can be linked to many Customers; a provider that
|
||||
// needs to know which ones looks that up itself (e.g. to detach the pivot),
|
||||
// rather than this value object assuming or privileging any single one.
|
||||
}
|
||||
```
|
||||
|
||||
`CustomerSubject::forCustomer(Customer $customer)` and `UserSubject::forUser($user)` build one
|
||||
from the record staff (or the person themselves) look up.
|
||||
|
||||
---
|
||||
|
||||
## Providers shipped in core
|
||||
|
||||
| Provider | `name()` | Lives in | Covers | Customer-scope | User-scope |
|
||||
|---|---|---|---|---|---|
|
||||
| `ActivityLogDataProvider` | `activity_log` | `Modules\Core\Logging\Privacy` | `activity_log` (Spatie) for subject types `Customer`/`Address`/`CartAddress`/`OrderAddress`/`Transaction` | **Pseudonymized** — `properties` redacted, who/what/when metadata kept | Skipped — `causer_id` is an actor reference, not PII content; see below |
|
||||
| `CustomerDataProvider` | `customer` | `Modules\Core\Customer\Privacy` | `lunar_customers`, and separately the `User`'s own name/email/OTP fields | Erases the account's own fields only | Erases that User's name/email/OTP fields only, and detaches them from every linked Customer |
|
||||
| `AddressDataProvider` | `addresses` | `Modules\Core\Customer\Privacy` | `lunar_addresses` | Erased (deleted outright) | Skipped — belongs to a Customer, not an individual |
|
||||
| `OrderDataProvider` | `orders` | `Modules\Core\Order\Privacy` | `lunar_orders`, `lunar_order_addresses`, and their `meta` (`terms_accepted*`, `payment_method`, `box_now_locker`) | **Pseudonymized, not erased** — see below | Skipped — belongs to a Customer, not an individual |
|
||||
| `CartDataProvider` | `carts` | `Modules\Core\Cart\Privacy` | `lunar_cart_addresses`, and `lunar_carts.meta` (`recovery_consent*`, `payment_method`, `checkout_fingerprint`) | Erased | Skipped — belongs to a Customer, not an individual |
|
||||
| `ReviewDataProvider` | `reviews` | `Modules\Core\Review\Privacy` | `product_reviews` | Skipped — authored by an individual, not a business account | Pseudonymized by matching `reviewer_email`; rating/title/body text kept |
|
||||
| `PaymentDataProvider` | `payments` | `Modules\Core\Payment\Privacy` | `lunar_transactions` (`card_type`/`last_four`), `stripe_payment_intents` | **Pseudonymized** — card metadata cleared, correlation rows deleted, amounts/statuses kept | Skipped — belongs to Customer-owned orders, not individual users |
|
||||
| `UserSessionDataProvider` | `sessions` | `Modules\Core\Auth\Privacy` | `user_sessions` (`ip_address`, `user_agent`) | Skipped — belongs to an individual User, not a business account | Erased (deleted outright) |
|
||||
|
||||
`CustomerDataProvider` is the one provider that implements both scopes meaningfully, and keeps
|
||||
them from touching each other — see the class docblock for the full reasoning.
|
||||
|
||||
### `activity_log` is redacted by subject, never by causer
|
||||
|
||||
`Modules\Core\Logging\ActivityLogService` (plus several Lunar models' own native `use
|
||||
LogsActivity` — `Customer`, `CartAddress`, `OrderAddress`, `Transaction`) durably retains a full
|
||||
snapshot of whatever it logged in `properties`, completely independent of the real row it
|
||||
describes — erasing/pseudonymizing a `Customer`/`Address`/`Order`/etc. elsewhere does nothing to
|
||||
this table on its own. `ActivityLogDataProvider::eraseForCustomer()` redacts `properties` on
|
||||
every row whose **subject** (not causer) resolves back to that customer, across all five
|
||||
PII-bearing subject types.
|
||||
|
||||
It deliberately never touches `causer_id` — the causer is "who performed this action," not PII
|
||||
content, and erasing it would defeat the audit trail's own purpose. `eraseForUser()` is
|
||||
therefore a no-op: a `User` appears in this table only as a causer, never as subject content, so
|
||||
there's nothing to redact from the User side alone.
|
||||
|
||||
**Ordering dependency**: `ActivityLogDataProvider` must run *before* `AddressDataProvider` in
|
||||
`config('core.privacy.providers')` — it resolves which `activity_log` rows are keyed by an
|
||||
`Address` id while those Address rows still exist; `AddressDataProvider` then hard-deletes them.
|
||||
Reversing the order would make matching those rows impossible once the addresses are gone.
|
||||
|
||||
**`ReviewDataProvider` needs review.** It moved from Customer-scope to User-scope on the
|
||||
reasoning that authorship is a personal attribute, not a business-account attribute — but this
|
||||
hasn't been fully validated against how reviews are actually attributed in this codebase. The
|
||||
class carries a `NEEDS REVIEW` note; revisit before relying on it for a real request.
|
||||
|
||||
### Orders are pseudonymized, not deleted
|
||||
|
||||
GDPR Art. 17(3)(b) explicitly allows retaining data an erasure request would otherwise cover,
|
||||
when a legal obligation requires it — tax/accounting law generally requires invoices be kept for
|
||||
several years. `OrderDataProvider::eraseForCustomer()` clears the free-text PII fields on `Order`/
|
||||
`OrderAddress` (`customer_reference`, `notes`, name/address/contact fields) but leaves the order
|
||||
row, totals, line items, and tax data fully intact. Its `ProviderErasureResult` reports
|
||||
`ErasureOutcome::Pseudonymized`, not `Erased` — a compliance report or admin UI can see exactly
|
||||
why an order wasn't deleted without reading `OrderDataProvider`'s source.
|
||||
|
||||
### Reviews are matched by email — a real, documented limitation
|
||||
|
||||
`ProductReview` has no FK to Customer/User at all (see `docs/product-listing.md` "Reviews") —
|
||||
it's deliberately anonymous, just free-text `reviewer_name`/`reviewer_email`. `ReviewDataProvider`
|
||||
matches by `reviewer_email` against `UserSubject::$email`; a review submitted under a different
|
||||
email than the one on file simply won't be found. There's no stronger signal available without
|
||||
changing `ProductReview`'s schema.
|
||||
|
||||
### Staff/employee data is out of scope
|
||||
|
||||
`Staff` (admin/panel employees) is never a `UserSubject`/`CustomerSubject` at all — this feature
|
||||
is scoped to customer-initiated and staff-initiated-on-a-customer's-behalf requests. An employee's
|
||||
own data (a different HR/access-management concern) isn't reachable through this flow.
|
||||
|
||||
---
|
||||
|
||||
## Erasure isn't immediate — a cancellable grace period
|
||||
|
||||
`PrivacyService` has parallel methods for each scope: `requestErasureForCustomer()` /
|
||||
`requestErasureForUser()`. Neither erases anything immediately. Each opens a `DataErasureRequest`
|
||||
(`pending`, `scheduled_for` = now + `config('core.privacy.grace_period_days')`, default 30). This
|
||||
mirrors Shopify's own account-deletion flow: a window where the subject can change their mind
|
||||
before anything is actually erased.
|
||||
|
||||
**Only the User-scoped request deactivates a login.** `requestErasureForCustomer()` deactivates
|
||||
no one — a business-account erasure must never block anyone's access.
|
||||
`requestErasureForUser()` deactivates that one User's login (blocks it — see
|
||||
`Modules\Core\Auth\Services\UserOtpService` — nothing else changes).
|
||||
|
||||
```php
|
||||
use Modules\Core\Privacy\Services\PrivacyService;
|
||||
|
||||
$service = app(PrivacyService::class);
|
||||
|
||||
// Customer-scoped: either the Customer itself (self-service) or a Staff member.
|
||||
$request = $service->requestErasureForCustomer($customer, $requestedBy);
|
||||
|
||||
// User-scoped: either the User itself (self-service) or a Staff member.
|
||||
$request = $service->requestErasureForUser($user, $requestedBy);
|
||||
|
||||
// Cancel before scheduled_for — for a User-scoped request, reactivates the
|
||||
// account. A Customer-scoped request never deactivated anything, so there's
|
||||
// nothing to reactivate for it.
|
||||
$service->cancelErasure($request);
|
||||
```
|
||||
|
||||
### Logging back in during the grace period cancels the request automatically
|
||||
|
||||
Authentication is never blocked by deactivation — `UserOtpService::validate()` still requires
|
||||
the correct OTP code. Once validated, it dispatches `Modules\Core\Auth\Events\UserAuthenticated`;
|
||||
`Modules\Core\Privacy\Listeners\CancelErasureOnLoginListener` (registered in
|
||||
`PrivacyServiceProvider`, **queued** — see below) looks for a pending request keyed on *that
|
||||
User's own id* — never a Customer-scoped one, since Customer-scope never deactivates a login in
|
||||
the first place — and calls `cancelErasure()` on it, then reverts every Customer erasure request
|
||||
it caused (see "The sole-owner cascade" below). Logging back in **is** the "I changed my mind"
|
||||
action — no separate UI/flow needed for reactivation.
|
||||
|
||||
This listener is queued rather than synchronous, so login returns to the browser without waiting
|
||||
on the bookkeeping. Nothing else in this codebase currently reads `deactivated_at` besides this
|
||||
listener and `PrivacyService` itself — `UserOtpService::validate()` never gates the login on it —
|
||||
so the brief window between the login response and the job actually running has no other consumer
|
||||
to observe it as stale.
|
||||
|
||||
### The sole-owner cascade — erasing the last User on a Customer also erases the Customer
|
||||
|
||||
If a User is erased and they were the **only** User linked to a given Customer, that Customer's
|
||||
data (orders, addresses, buyer record) becomes permanently unreachable through any login the
|
||||
moment the User's identity is gone — nobody could ever again log in to exercise a data-subject
|
||||
right over it. GDPR's data minimization principle (Art. 5(1)(c)) means it shouldn't just sit
|
||||
there indefinitely with no legitimate purpose.
|
||||
|
||||
`requestErasureForUser()` and `requestImmediateErasureForUser()` both fire
|
||||
`Modules\Core\Privacy\Events\UserErasureRequested` right after the request is created (and, for
|
||||
the immediate path, before `completeErasure()` runs — see below).
|
||||
`Modules\Core\Privacy\Listeners\CascadeCustomerErasureListener` (**queued**, registered in
|
||||
`PrivacyServiceProvider`) handles it: for every Customer the User is linked to, if that User is
|
||||
currently the *sole* linked User (count is 1, and that one User is this one — not just count ===
|
||||
1, to be explicit rather than relying on an assumption), it opens a second, independent
|
||||
grace-period request via `requestErasureForCustomer($customer, $user, causedByRequestId: ...)`.
|
||||
Both requests then run through their own separate 30-day windows.
|
||||
|
||||
```
|
||||
User erasure requested
|
||||
│
|
||||
▼
|
||||
UserErasureRequested event ──▶ CascadeCustomerErasureListener (queued)
|
||||
│
|
||||
▼
|
||||
for each linked Customer: sole owner?
|
||||
│ yes
|
||||
▼
|
||||
requestErasureForCustomer(..., causedByRequestId: <user request id>)
|
||||
```
|
||||
|
||||
**Tracing the cascade — `caused_by_request_id`.** A cascade-created Customer request's
|
||||
`caused_by_request_id` points back at the User request that triggered it. This is what lets
|
||||
`CancelErasureOnLoginListener` revert *exactly* the cascade a User's own cancellation should
|
||||
undo (via `DataErasureRequest::caused()`) without ever touching an unrelated, independently
|
||||
staff-requested Customer erasure the User happens to still be linked to.
|
||||
|
||||
**Why this is queued, not synchronous.** `CascadeCustomerErasureListener` runs as an independent,
|
||||
separately-retryable job rather than inline inside `requestErasureForUser()` — a failure in the
|
||||
cascade check never rolls back or blocks the User's own request, and there's no
|
||||
`DB::transaction()` wrapping needed, since the two writes (the User's request, and any cascaded
|
||||
Customer request) aren't required to be atomic with each other.
|
||||
|
||||
**A known, accepted race on the immediate-erasure path only.** Because the listener is queued,
|
||||
Eloquent re-fetches its models fresh when the job actually runs (see
|
||||
`Illuminate\Queue\SerializesModels`) — so `$event->request->subject->customers` reflects the
|
||||
*real* state at execution time, not a stale snapshot from dispatch time. For
|
||||
`requestImmediateErasureForUser()`, that job may run before or after `completeErasure()` detaches
|
||||
the User's memberships in the same call. If the detach happens first, the User is simply no
|
||||
longer linked to anything by the time the cascade job runs, and nothing cascades — an accepted
|
||||
race for that rare, staff-only path (see "Immediate erasure" below), not a concern for the
|
||||
everyday `requestErasureForUser()` grace-period path, where nothing detaches until its own later,
|
||||
separate `completeErasure()` run — well after the cascade job has had time to fire.
|
||||
|
||||
### Processing due requests — one job per request
|
||||
|
||||
`php artisan boboko:privacy:process-erasure-requests` finds every `pending` request whose
|
||||
`scheduled_for` has passed and dispatches one `Modules\Core\Privacy\Jobs\EraseDataSubjectJob` per
|
||||
request — it does not run `completeErasure()` inline itself. Each job independently calls
|
||||
`PrivacyService::completeErasure()`, which checks the request's polymorphic `subject` and calls
|
||||
either every registered provider's `eraseForCustomer()` or `eraseForUser()`, writing the full
|
||||
per-provider outcome onto the request's `report` column and marking it `completed`. One job per
|
||||
request means one request's failure (a provider throwing, a DB error) doesn't block or crash
|
||||
processing of the others, and Laravel's normal per-job retry/failure handling applies to each
|
||||
request independently. This package doesn't register a schedule itself; each consuming app wires
|
||||
the command into its own scheduler (daily is reasonable), the same way it owns any other
|
||||
scheduled task.
|
||||
|
||||
### Immediate erasure — staff-only, not self-service
|
||||
|
||||
`requestImmediateErasureForCustomer(Customer $customer, Staff $requestedBy): ErasureReport` and
|
||||
`requestImmediateErasureForUser($user, Staff $requestedBy): ErasureReport` bypass the grace
|
||||
period entirely and erase right away. Both are `Staff`-only **by type**, not just by convention —
|
||||
their signatures take `Staff $requestedBy` specifically (not the union type the grace-period
|
||||
methods accept), so a self-service/customer-facing code path can't reach either one even by
|
||||
accident; calling with a `Customer`/`User` actor is a compile-time type error, not a runtime
|
||||
check to remember.
|
||||
|
||||
This exists for a formal legal request or regulator inquiry that genuinely requires immediate
|
||||
action, not as a convenience for an impatient customer. GDPR Art. 17 requires erasure "without
|
||||
undue delay," but doesn't set a maximum number of days for a grace period, and a short, disclosed,
|
||||
cancellable hold before executing a self-service request is a widely-used, generally accepted
|
||||
pattern (the same one Shopify and most major platforms use) — it is **not** offered as a
|
||||
same-click alternative on the self-service deletion flow, since doing so would mostly defeat the
|
||||
grace period's purpose (protecting an impulsive requester from themselves). If a subject
|
||||
explicitly insists on immediate deletion, that's a staff/support decision to make on the record
|
||||
via one of these methods, not a checkbox exposed to every customer.
|
||||
|
||||
```php
|
||||
$report = $service->requestImmediateErasureForCustomer($customer, $staffMember);
|
||||
$report = $service->requestImmediateErasureForUser($user, $staffMember);
|
||||
// Both run synchronously — no queueing, no grace period. $report is the same
|
||||
// ErasureReport completeErasure() would produce.
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Export — queued, not synchronous
|
||||
|
||||
Export gathers real data across every registered provider — potentially slow, and there's no
|
||||
reason to block whatever request triggered it (a customer clicking "export my data," an API
|
||||
call). `requestExportForCustomer()`/`requestExportForUser()` are fast synchronous calls that only
|
||||
create a `DataExportRequest` row and dispatch the actual work:
|
||||
|
||||
```php
|
||||
$request = $service->requestExportForCustomer($customer);
|
||||
$request = $service->requestExportForUser($user);
|
||||
// $request->status is 'pending'; nothing has been gathered yet.
|
||||
```
|
||||
|
||||
### The event chain
|
||||
|
||||
1. **`ExportDataSubjectJob`** (queued) checks the request's polymorphic `subject` and calls every
|
||||
registered provider's `exportForCustomer()` or `exportForUser()` — all sequentially, in this
|
||||
one job, not fanned out into one job per provider. Per-subject export work is small (a handful
|
||||
of indexed queries per provider), so there's no real parallelism win, and one job means
|
||||
"finished" is just "`handle()` returned," with no `Bus::batch()`/completion-counting needed. If
|
||||
a future provider ever does something genuinely slow (an external API call, a generated PDF),
|
||||
that's the point to reconsider a per-provider batch — not before.
|
||||
2. Once every provider's data is gathered, the job fires **`PersonalDataGathered`**
|
||||
(carries the request and the assembled `ExportReport`) — no file exists yet.
|
||||
3. **`Modules\Core\Privacy\Listeners\WriteExportToCsvListener`** (registered in
|
||||
`PrivacyServiceProvider`) handles that event: turns each provider's data into its own CSV (via
|
||||
the generic `Modules\Core\Export\CsvWriter` — see below), zips them together, writes the zip to
|
||||
`storage/app/exports/privacy/`, and updates the request (`status: completed`, `file_path`).
|
||||
This is its own listener — not inline in the job — so the export *format* is swappable (an app
|
||||
could unregister this and register a JSON-only listener instead) without touching how data is
|
||||
gathered.
|
||||
4. Once the file exists, that listener fires **`PersonalDataExportFileWritten`**.
|
||||
5. Core has no opinion on how the subject is told. A consuming app registers its own notification
|
||||
against `PersonalDataExportFileWritten` via `Modules\Core\Notification\NotificationRegistry` —
|
||||
the same pattern as `App\Notifications\QuestionnaireResultsSentNotification` listening on
|
||||
`App\Events\QuestionnaireResultsSent` (see `boboko-test` for a working example). Core
|
||||
deliberately does not send an email itself.
|
||||
|
||||
### CSV shape
|
||||
|
||||
Every provider's `data` is either a list of associative arrays (addresses, orders, reviews — each
|
||||
item becomes a row) or a single associative array (customer — becomes one row). Any nested array
|
||||
value within a row (e.g. an order's `addresses` sub-array) is JSON-encoded into that one cell
|
||||
rather than exploded into further columns — a generic, provider-agnostic rule in
|
||||
`WriteExportToCsvListener`, not something each provider has to think about.
|
||||
|
||||
### `Modules\Core\Export\CsvWriter` — a generic, reusable piece
|
||||
|
||||
`CsvWriter::write(array $columns, iterable $rows, string $path)` has no knowledge of GDPR,
|
||||
customers, or Lunar at all — a caller supplies a schema (`CsvColumn[]`, each just a header plus a
|
||||
closure that pulls that column's value out of one record) and any iterable data source. It's used
|
||||
here by `WriteExportToCsvListener`, but is equally usable for an unrelated future need — an admin
|
||||
bulk catalog export, an accounting handoff — by supplying a different schema and row source;
|
||||
nothing about it is GDPR-specific.
|
||||
|
||||
---
|
||||
|
||||
## Audit trail
|
||||
|
||||
`DataErasureRequest` (`data_erasure_requests`) and `DataExportRequest` (`data_export_requests`)
|
||||
are the audit records for erasure and export respectively. Both have a polymorphic `subject`
|
||||
(`subject_type`/`subject_id`, pointing at either a Lunar `Customer` or a `User` — never both) —
|
||||
`subject_type`/`subject_id`/`email` are stored as a **snapshot**, not looked up live, since the
|
||||
whole point is for these tables to remain readable after the record they're about has been
|
||||
erased. `DataErasureRequest::isForCustomer()` tells you which scope a given request is.
|
||||
|
||||
`DataErasureRequest.requested_by_type`/`requested_by_id` capture who asked for it (the subject
|
||||
themselves, self-service; `Staff` acting on their behalf; or, for a cascade-created Customer
|
||||
request, the User whose erasure caused it — see "The sole-owner cascade") at request time.
|
||||
`DataErasureRequest.caused_by_request_id` is set only on a cascade-created Customer request,
|
||||
pointing back at the User request that triggered it; null on every normal, directly-requested
|
||||
erasure — see `DataErasureRequest::causedBy()`/`::caused()`.
|
||||
`DataErasureRequest.report` holds the full per-provider outcome once `completeErasure()` runs;
|
||||
`DataExportRequest.file_path` points at the generated zip once `WriteExportToCsvListener`
|
||||
finishes.
|
||||
|
||||
**Not yet built**: a standalone "leave/remove from a Customer account" action — unlinking a User
|
||||
from a Customer without any erasure involved (e.g. a teammate leaving a project, or an account
|
||||
admin removing someone) — is a related but separate, smaller feature, deliberately out of scope
|
||||
for this module so far. It shares the same pivot-detach primitive `CustomerDataProvider::
|
||||
eraseForUser()` already uses as part of a full erasure, but as a standalone action it doesn't
|
||||
exist yet.
|
||||
@@ -1,18 +0,0 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Auth\Events;
|
||||
|
||||
use Illuminate\Contracts\Auth\Authenticatable;
|
||||
|
||||
/**
|
||||
* Dispatched by Modules\Core\Auth\Services\UserOtpService::validate() on a
|
||||
* successful OTP login — distinct from UserCreated (which only fires for
|
||||
* a genuinely first-time email); this fires on every successful login,
|
||||
* new user or returning one.
|
||||
*/
|
||||
class CustomerLoggedIn
|
||||
{
|
||||
public function __construct(
|
||||
public readonly Authenticatable $user,
|
||||
) {}
|
||||
}
|
||||
@@ -0,0 +1,25 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Auth\Events;
|
||||
|
||||
use Illuminate\Contracts\Auth\Authenticatable;
|
||||
use Lunar\Base\LunarUser;
|
||||
|
||||
/**
|
||||
* Dispatched by UserOtpService::validate() on every successful OTP login, not just
|
||||
* a first-time one. Modules\Core\Privacy listens on this to auto-cancel a pending
|
||||
* DataErasureRequest — logging back in during the grace period is the "I changed
|
||||
* my mind" action (see Modules\Core\Privacy\Listeners\CancelErasureOnLoginListener),
|
||||
* which needs $user->customers to resolve any pending request. Typed as
|
||||
* Authenticatable&LunarUser rather than plain Authenticatable (unlike the sibling
|
||||
* UserCreated event) specifically because that listener depends on it — every real
|
||||
* User in this codebase implements LunarUser (see docs/lunar.md "LunarUser trait"),
|
||||
* and User is the only Authenticatable entity in this project (Customer is not —
|
||||
* see docs/modules.md "Customer/User Pairing").
|
||||
*/
|
||||
class UserAuthenticated
|
||||
{
|
||||
public function __construct(
|
||||
public readonly Authenticatable&LunarUser $user,
|
||||
) {}
|
||||
}
|
||||
@@ -0,0 +1,68 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Auth\Privacy;
|
||||
|
||||
use Modules\Core\Auth\Models\UserSession;
|
||||
use Modules\Core\Privacy\Contracts\PersonalDataProvider;
|
||||
use Modules\Core\Privacy\DTOs\CustomerSubject;
|
||||
use Modules\Core\Privacy\Enums\ErasureOutcome;
|
||||
use Modules\Core\Privacy\DTOs\ProviderErasureResult;
|
||||
use Modules\Core\Privacy\DTOs\ProviderExportResult;
|
||||
use Modules\Core\Privacy\DTOs\UserSubject;
|
||||
|
||||
/**
|
||||
* Login-session device/location metadata (user_sessions) — ip_address and
|
||||
* user_agent are device/location fingerprinting data tied 1:1 to a User via
|
||||
* user_id, never to a Customer (business account), so this is User-scope
|
||||
* only. No legal retention requirement applies to session metadata the way
|
||||
* it does to Order (there's no tax/accounting reason to keep old login IPs
|
||||
* around), so rows are deleted outright rather than pseudonymized.
|
||||
*
|
||||
* A hard delete here is safe regardless of whether the User row itself has
|
||||
* already been erased — CustomerDataProvider::eraseForUser() nulls the
|
||||
* User's own name/email but never touches user_sessions, and the table's
|
||||
* own user_id FK is cascadeOnDelete() only if the User row itself were
|
||||
* hard-deleted, which it never is (erasure here means "identity nulled,"
|
||||
* not "row removed" — see docs/modules.md "Customer/User Pairing").
|
||||
*/
|
||||
class UserSessionDataProvider implements PersonalDataProvider
|
||||
{
|
||||
public function name(): string
|
||||
{
|
||||
return 'sessions';
|
||||
}
|
||||
|
||||
public function exportForCustomer(CustomerSubject $subject): ProviderExportResult
|
||||
{
|
||||
return new ProviderExportResult('sessions', []);
|
||||
}
|
||||
|
||||
public function exportForUser(UserSubject $subject): ProviderExportResult
|
||||
{
|
||||
$sessions = UserSession::where('user_id', $subject->userId)->get();
|
||||
|
||||
return new ProviderExportResult('sessions', $sessions->map(fn (UserSession $session) => [
|
||||
'id' => $session->id,
|
||||
'ip_address' => $session->ip_address,
|
||||
'user_agent' => $session->user_agent,
|
||||
'last_used_at' => $session->last_used_at?->toIso8601String(),
|
||||
'revoked_at' => $session->revoked_at?->toIso8601String(),
|
||||
])->all());
|
||||
}
|
||||
|
||||
public function eraseForCustomer(CustomerSubject $subject): ProviderErasureResult
|
||||
{
|
||||
return new ProviderErasureResult('sessions', ErasureOutcome::Skipped, 'Login sessions belong to individual Users, not Customer accounts.');
|
||||
}
|
||||
|
||||
public function eraseForUser(UserSubject $subject): ProviderErasureResult
|
||||
{
|
||||
$deleted = UserSession::where('user_id', $subject->userId)->delete();
|
||||
|
||||
if ($deleted === 0) {
|
||||
return new ProviderErasureResult('sessions', ErasureOutcome::Skipped, 'No login sessions for this user.');
|
||||
}
|
||||
|
||||
return new ProviderErasureResult('sessions', ErasureOutcome::Erased);
|
||||
}
|
||||
}
|
||||
@@ -9,7 +9,7 @@ use Illuminate\Support\Facades\DB;
|
||||
use Illuminate\Support\Facades\Event;
|
||||
use Illuminate\Support\Facades\Mail;
|
||||
use Illuminate\Support\Facades\RateLimiter;
|
||||
use Modules\Core\Auth\Events\CustomerLoggedIn;
|
||||
use Modules\Core\Auth\Events\UserAuthenticated;
|
||||
use Modules\Core\Auth\Exceptions\OtpThrottledException;
|
||||
use Modules\Core\Auth\Mail\UserOtpMail;
|
||||
|
||||
@@ -144,7 +144,7 @@ class UserOtpService
|
||||
|
||||
$this->sessions->record($result, $request);
|
||||
|
||||
Event::dispatch(new CustomerLoggedIn($result));
|
||||
Event::dispatch(new UserAuthenticated($result));
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,108 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Cart\Privacy;
|
||||
|
||||
use Lunar\Models\Cart;
|
||||
use Lunar\Models\CartAddress;
|
||||
use Modules\Core\Privacy\Contracts\PersonalDataProvider;
|
||||
use Modules\Core\Privacy\DTOs\CustomerSubject;
|
||||
use Modules\Core\Privacy\Enums\ErasureOutcome;
|
||||
use Modules\Core\Privacy\DTOs\ProviderErasureResult;
|
||||
use Modules\Core\Privacy\DTOs\ProviderExportResult;
|
||||
use Modules\Core\Privacy\DTOs\UserSubject;
|
||||
|
||||
/**
|
||||
* Carts and cart addresses (lunar_carts, lunar_cart_addresses) belong to the
|
||||
* Customer (business account) via customer_id, not to an individual User, so this
|
||||
* is Customer-scope only. Unlike Order/OrderAddress, an abandoned cart has no
|
||||
* legal retention requirement, so its addresses are freely deleted. The Cart row
|
||||
* itself is left alone (any completed order it produced is handled separately by
|
||||
* OrderDataProvider, which is what retention law actually cares about) — only its
|
||||
* address PII is removed.
|
||||
*
|
||||
* Also covers Cart.meta's own PII-adjacent keys — Modules\Core\Checkout\Services\
|
||||
* CheckoutService::setRecoveryConsent()/selectPaymentMethod() write
|
||||
* recovery_consent/recovery_consent_at/recovery_consent_policy_version and
|
||||
* payment_method/checkout_fingerprint directly onto this same Cart row, which the
|
||||
* address-only erase above never touched. Kept Customer-scope, consistent with
|
||||
* how Cart itself is already classified — see docs/privacy.md for the
|
||||
* User-vs-Customer discussion this raised.
|
||||
*/
|
||||
class CartDataProvider implements PersonalDataProvider
|
||||
{
|
||||
private const META_KEYS = [
|
||||
'recovery_consent',
|
||||
'recovery_consent_at',
|
||||
'recovery_consent_policy_version',
|
||||
'payment_method',
|
||||
'checkout_fingerprint',
|
||||
];
|
||||
|
||||
public function name(): string
|
||||
{
|
||||
return 'carts';
|
||||
}
|
||||
|
||||
public function exportForCustomer(CustomerSubject $subject): ProviderExportResult
|
||||
{
|
||||
$carts = Cart::where('customer_id', $subject->customerId)->get();
|
||||
|
||||
$addresses = CartAddress::whereIn('cart_id', $carts->pluck('id'))->get();
|
||||
|
||||
return new ProviderExportResult('carts', [
|
||||
'addresses' => $addresses->map(fn (CartAddress $address) => [
|
||||
'type' => $address->type,
|
||||
'first_name' => $address->first_name,
|
||||
'last_name' => $address->last_name,
|
||||
'line_one' => $address->line_one,
|
||||
'city' => $address->city,
|
||||
'postcode' => $address->postcode,
|
||||
'contact_email' => $address->contact_email,
|
||||
'contact_phone' => $address->contact_phone,
|
||||
])->all(),
|
||||
'carts' => $carts->map(fn (Cart $cart) => [
|
||||
'id' => $cart->id,
|
||||
'meta' => $this->metaOnly($cart),
|
||||
])->all(),
|
||||
]);
|
||||
}
|
||||
|
||||
public function exportForUser(UserSubject $subject): ProviderExportResult
|
||||
{
|
||||
return new ProviderExportResult('carts', []);
|
||||
}
|
||||
|
||||
public function eraseForCustomer(CustomerSubject $subject): ProviderErasureResult
|
||||
{
|
||||
$carts = Cart::where('customer_id', $subject->customerId)->get();
|
||||
|
||||
CartAddress::whereIn('cart_id', $carts->pluck('id'))->delete();
|
||||
|
||||
foreach ($carts as $cart) {
|
||||
$meta = (array) $cart->meta;
|
||||
|
||||
foreach (self::META_KEYS as $key) {
|
||||
unset($meta[$key]);
|
||||
}
|
||||
|
||||
$cart->update(['meta' => $meta]);
|
||||
}
|
||||
|
||||
return new ProviderErasureResult('carts', ErasureOutcome::Erased);
|
||||
}
|
||||
|
||||
public function eraseForUser(UserSubject $subject): ProviderErasureResult
|
||||
{
|
||||
return new ProviderErasureResult('carts', ErasureOutcome::Skipped, 'Carts belong to Customer accounts, not individual users.');
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array<string, mixed>
|
||||
*/
|
||||
private function metaOnly(Cart $cart): array
|
||||
{
|
||||
$meta = (array) $cart->meta;
|
||||
|
||||
return array_intersect_key($meta, array_flip(self::META_KEYS));
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,47 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Command;
|
||||
|
||||
use Illuminate\Console\Command;
|
||||
use Modules\Core\Privacy\Enums\ErasureRequestStatus;
|
||||
use Modules\Core\Privacy\Jobs\EraseDataSubjectJob;
|
||||
use Modules\Core\Privacy\Models\DataErasureRequest;
|
||||
|
||||
/**
|
||||
* Finds every erasure request whose grace period (config('core.privacy.
|
||||
* grace_period_days')) has passed and dispatches one EraseDataSubjectJob per
|
||||
* request — see docs/privacy.md. This command itself just finds due requests and
|
||||
* dispatches; the actual erasure work happens in the queue, one job per request,
|
||||
* so one failing request doesn't block the others. Meant to run daily via the
|
||||
* scheduler; each consuming app wires that in its own Console\Kernel (or
|
||||
* bootstrap/app.php schedule closure on Laravel 11+), the same way it owns any
|
||||
* other scheduled task — this package doesn't register schedules itself.
|
||||
*/
|
||||
class ProcessErasureRequestsCommand extends Command
|
||||
{
|
||||
protected $signature = 'boboko:privacy:process-erasure-requests';
|
||||
|
||||
protected $description = 'Dispatch an erasure job for every pending data-erasure request whose grace period has passed';
|
||||
|
||||
public function handle(): void
|
||||
{
|
||||
$due = DataErasureRequest::where('status', ErasureRequestStatus::Pending)
|
||||
->where('scheduled_for', '<=', now())
|
||||
->get();
|
||||
|
||||
if ($due->isEmpty()) {
|
||||
$this->info('No due erasure requests.');
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
foreach ($due as $request) {
|
||||
EraseDataSubjectJob::dispatch($request);
|
||||
|
||||
$scope = $request->isForCustomer() ? 'customer' : 'user';
|
||||
$this->info("Dispatched erasure job for {$scope} #{$request->subject_id} (request #{$request->id})");
|
||||
}
|
||||
|
||||
$this->info('Dispatched '.$due->count().' erasure job(s).');
|
||||
}
|
||||
}
|
||||
+69
-3
@@ -7,7 +7,11 @@ use Lunar\Admin\Filament\Resources\OrderResource\Pages\Components\OrderItemsTabl
|
||||
use Filament\Contracts\Plugin;
|
||||
use Filament\Panel;
|
||||
use Illuminate\Database\Eloquent\Relations\HasMany;
|
||||
use Illuminate\Database\Eloquent\Relations\MorphMany;
|
||||
use Illuminate\Support\Facades\Mail;
|
||||
use Lunar\Admin\Filament\Resources\CustomerResource;
|
||||
use Lunar\Admin\Filament\Resources\CustomerResource\Pages\EditCustomer;
|
||||
use Lunar\Admin\Filament\Resources\CustomerResource\Pages\ViewCustomer;
|
||||
use Lunar\Admin\Filament\Resources\ProductOptionResource;
|
||||
use Lunar\Admin\Filament\Resources\ProductOptionResource\RelationManagers\ValuesRelationManager;
|
||||
use Lunar\Admin\Filament\Resources\OrderResource;
|
||||
@@ -15,6 +19,7 @@ use Lunar\Admin\Filament\Resources\ProductResource;
|
||||
use Lunar\Admin\Filament\Resources\StaffResource;
|
||||
use Lunar\Admin\Models\Staff as LunarStaff;
|
||||
use Lunar\Admin\Support\Facades\LunarPanel;
|
||||
use Lunar\Models\Customer;
|
||||
use Lunar\Models\Product;
|
||||
use Lunar\Shipping\Filament\Resources\ShippingMethodResource;
|
||||
use Lunar\Shipping\Filament\Resources\ShippingMethodResource\Pages\ListShippingMethod;
|
||||
@@ -31,6 +36,12 @@ use Modules\Core\Order\Filament\Extensions\OrderPaymentMethodSummaryExtension;
|
||||
use Modules\Core\Order\Filament\Extensions\OrderActionsExtension;
|
||||
use Modules\Core\Order\Filament\Extensions\OrderTransactionsExtension;
|
||||
use Modules\Core\Payment\Filament\Resources\PaymentMethodResource;
|
||||
use Modules\Core\Privacy\Filament\Extensions\CustomerErasureActionsExtension;
|
||||
use Modules\Core\Privacy\Filament\Extensions\CustomerErasureRelationsExtension;
|
||||
use Modules\Core\Privacy\Filament\Resources\DataErasureRequestResource;
|
||||
use Modules\Core\Privacy\Filament\Resources\DataExportRequestResource;
|
||||
use Modules\Core\Privacy\Models\DataErasureRequest;
|
||||
use Modules\Core\Privacy\Models\DataExportRequest;
|
||||
use Modules\Core\Review\Filament\Extensions\ProductResourceExtension;
|
||||
use Modules\Core\Review\Models\ProductReview;
|
||||
use Modules\Core\Shipping\Extensions\OrderShipmentsExtension;
|
||||
@@ -56,6 +67,8 @@ class CorePlugin implements Plugin
|
||||
->login(Login::class)
|
||||
->resources([
|
||||
LanguageLineResource::class,
|
||||
DataErasureRequestResource::class,
|
||||
DataExportRequestResource::class,
|
||||
CartResource::class,
|
||||
PaymentMethodResource::class,
|
||||
ShipmentResource::class,
|
||||
@@ -72,11 +85,64 @@ class CorePlugin implements Plugin
|
||||
ListShippingMethod::class => ShippingMethodListExtension::class,
|
||||
ManageOrder::class => [OrderViewExtension::class, OrderActionsExtension::class, OrderTransactionsExtension::class, OrderPaymentMethodSummaryExtension::class, OrderShipmentsExtension::class],
|
||||
OrderItemsTable::class => OrderItemsTableExtension::class,
|
||||
// headerActions() is resolved per PAGE class, not per resource class —
|
||||
// unlike extendForm()/extendTable(), which really are resource-keyed
|
||||
// (called statically from the Resource class itself). Registering this
|
||||
// under CustomerResource::class would silently never fire; it has to be
|
||||
// keyed by each concrete page it should appear on. Layered with
|
||||
// whatever extension the consuming app registers for the same page —
|
||||
// LunarPanel::extensions() merges per key, and this one only touches
|
||||
// headerActions(), so it never conflicts with an app's own extension
|
||||
// (see docs/modules.md "Layering Module and App Configuration").
|
||||
EditCustomer::class => CustomerErasureActionsExtension::class,
|
||||
ViewCustomer::class => CustomerErasureActionsExtension::class,
|
||||
// getRelations(), unlike headerActions(), genuinely is resolved
|
||||
// statically from the Resource class itself — CustomerResource::class
|
||||
// is the correct key here.
|
||||
CustomerResource::class => CustomerErasureRelationsExtension::class,
|
||||
]);
|
||||
|
||||
Product::macro('reviews', function (): HasMany {
|
||||
/** @var Product $this */
|
||||
return $this->hasMany(ProductReview::class);
|
||||
// resolveRelationUsing(), not macro() — Illuminate\Database\Eloquent\
|
||||
// Model does not use the Macroable trait in this Laravel version, so
|
||||
// Product::macro(...)/Customer::macro(...)/$userModel::macro(...)
|
||||
// silently fall through to Model::__callStatic(), which instantiates
|
||||
// the model and tries to call the method as a real one, hitting
|
||||
// newQuery()->getConnection() — this crashes every console command
|
||||
// and every request, since CorePlugin::register() runs during
|
||||
// provider registration, before the DB connection is configured
|
||||
// ("Call to a member function connection() on null"). This bit us
|
||||
// once already; resolveRelationUsing() is Eloquent's real, intended,
|
||||
// connection-free extension point for exactly this (Order::
|
||||
// resolveRelationUsing('shipments', ...) in ShippingServiceProvider
|
||||
// already uses it correctly).
|
||||
Product::resolveRelationUsing('reviews', function (Product $product): HasMany {
|
||||
return $product->hasMany(ProductReview::class);
|
||||
});
|
||||
|
||||
// Customer::erasureRequests()/exportRequests() and the User-model
|
||||
// equivalents below let a relation manager scope
|
||||
// DataErasureRequest/DataExportRequest to one specific subject — both
|
||||
// tables use a plain subject_type/subject_id pair rather than Laravel's
|
||||
// usual morphs() convention, since one column pair identifies either a
|
||||
// Customer or a User (see docs/privacy.md "User-scope vs Customer-scope"),
|
||||
// so this is a MorphMany built by hand rather than a bare Eloquent
|
||||
// convention lookup.
|
||||
Customer::resolveRelationUsing('erasureRequests', function (Customer $customer): MorphMany {
|
||||
return $customer->morphMany(DataErasureRequest::class, 'subject', 'subject_type', 'subject_id');
|
||||
});
|
||||
|
||||
Customer::resolveRelationUsing('exportRequests', function (Customer $customer): MorphMany {
|
||||
return $customer->morphMany(DataExportRequest::class, 'subject', 'subject_type', 'subject_id');
|
||||
});
|
||||
|
||||
$userModel = config('auth.providers.users.model');
|
||||
|
||||
$userModel::resolveRelationUsing('erasureRequests', function ($user): MorphMany {
|
||||
return $user->morphMany(DataErasureRequest::class, 'subject', 'subject_type', 'subject_id');
|
||||
});
|
||||
|
||||
$userModel::resolveRelationUsing('exportRequests', function ($user): MorphMany {
|
||||
return $user->morphMany(DataExportRequest::class, 'subject', 'subject_type', 'subject_id');
|
||||
});
|
||||
|
||||
LunarStaff::addActivitylogExcept([
|
||||
|
||||
@@ -0,0 +1,63 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Customer\Privacy;
|
||||
|
||||
use Lunar\Models\Address;
|
||||
use Modules\Core\Privacy\Contracts\PersonalDataProvider;
|
||||
use Modules\Core\Privacy\DTOs\CustomerSubject;
|
||||
use Modules\Core\Privacy\Enums\ErasureOutcome;
|
||||
use Modules\Core\Privacy\DTOs\ProviderErasureResult;
|
||||
use Modules\Core\Privacy\DTOs\ProviderExportResult;
|
||||
use Modules\Core\Privacy\DTOs\UserSubject;
|
||||
|
||||
/**
|
||||
* A customer's saved addresses (lunar_addresses) — belong to the Customer
|
||||
* (business account) via customer_id, not to an individual User, so this is
|
||||
* Customer-scope only. No legal retention requirement of their own (unlike
|
||||
* OrderAddress, handled by OrderDataProvider), so they're freely deleted outright
|
||||
* rather than pseudonymized in place.
|
||||
*/
|
||||
class AddressDataProvider implements PersonalDataProvider
|
||||
{
|
||||
public function name(): string
|
||||
{
|
||||
return 'addresses';
|
||||
}
|
||||
|
||||
public function exportForCustomer(CustomerSubject $subject): ProviderExportResult
|
||||
{
|
||||
$addresses = Address::where('customer_id', $subject->customerId)->get();
|
||||
|
||||
return new ProviderExportResult('addresses', $addresses->map(fn (Address $address) => [
|
||||
'id' => $address->id,
|
||||
'first_name' => $address->first_name,
|
||||
'last_name' => $address->last_name,
|
||||
'company_name' => $address->company_name,
|
||||
'line_one' => $address->line_one,
|
||||
'line_two' => $address->line_two,
|
||||
'line_three' => $address->line_three,
|
||||
'city' => $address->city,
|
||||
'state' => $address->state,
|
||||
'postcode' => $address->postcode,
|
||||
'contact_email' => $address->contact_email,
|
||||
'contact_phone' => $address->contact_phone,
|
||||
])->all());
|
||||
}
|
||||
|
||||
public function exportForUser(UserSubject $subject): ProviderExportResult
|
||||
{
|
||||
return new ProviderExportResult('addresses', []);
|
||||
}
|
||||
|
||||
public function eraseForCustomer(CustomerSubject $subject): ProviderErasureResult
|
||||
{
|
||||
Address::where('customer_id', $subject->customerId)->delete();
|
||||
|
||||
return new ProviderErasureResult('addresses', ErasureOutcome::Erased);
|
||||
}
|
||||
|
||||
public function eraseForUser(UserSubject $subject): ProviderErasureResult
|
||||
{
|
||||
return new ProviderErasureResult('addresses', ErasureOutcome::Skipped, 'Addresses belong to Customer accounts, not individual users.');
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,122 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Customer\Privacy;
|
||||
|
||||
use Lunar\Models\Customer;
|
||||
use Modules\Core\Privacy\Contracts\PersonalDataProvider;
|
||||
use Modules\Core\Privacy\DTOs\CustomerSubject;
|
||||
use Modules\Core\Privacy\Enums\ErasureOutcome;
|
||||
use Modules\Core\Privacy\DTOs\ProviderErasureResult;
|
||||
use Modules\Core\Privacy\DTOs\ProviderExportResult;
|
||||
use Modules\Core\Privacy\DTOs\UserSubject;
|
||||
|
||||
/**
|
||||
* The Customer record itself (lunar_customers) and, on the User side, the User's
|
||||
* own name/email. This is the one provider that implements both scopes
|
||||
* meaningfully, and they are deliberately kept from touching each other's data:
|
||||
*
|
||||
* - eraseForCustomer() clears the account's own fields (name, company, tax id)
|
||||
* only — it never touches any linked User's login or identity, even though
|
||||
* $customer->users exists. Erasing a business account must not destroy the
|
||||
* login access of every person who works there.
|
||||
* - eraseForUser() clears that one person's name/email only — it never touches
|
||||
* the Customer record's own fields, and it also detaches the User from every
|
||||
* Customer they're linked to (the customer_user pivot — see docs/modules.md
|
||||
* "Customer/User Pairing"), since erasing a person's identity should end
|
||||
* their membership everywhere, without erasing the business accounts
|
||||
* themselves or any other User still linked to them.
|
||||
*
|
||||
* No legal retention requirement applies to this table on its own, so both
|
||||
* directions are freely erased — Order/OrderAddress, which DO have a retention
|
||||
* requirement, are handled separately by OrderDataProvider.
|
||||
*/
|
||||
class CustomerDataProvider implements PersonalDataProvider
|
||||
{
|
||||
public function name(): string
|
||||
{
|
||||
return 'customer';
|
||||
}
|
||||
|
||||
public function exportForCustomer(CustomerSubject $subject): ProviderExportResult
|
||||
{
|
||||
$customer = Customer::find($subject->customerId);
|
||||
|
||||
return new ProviderExportResult('customer', $customer ? [
|
||||
'id' => $customer->id,
|
||||
'title' => $customer->title,
|
||||
'first_name' => $customer->first_name,
|
||||
'last_name' => $customer->last_name,
|
||||
'company_name' => $customer->company_name,
|
||||
'tax_identifier' => $customer->tax_identifier,
|
||||
'meta' => $customer->meta,
|
||||
'users' => $customer->users->map(fn ($user) => [
|
||||
'id' => $user->id,
|
||||
'name' => $user->name,
|
||||
'email' => $user->email,
|
||||
])->all(),
|
||||
] : []);
|
||||
}
|
||||
|
||||
public function exportForUser(UserSubject $subject): ProviderExportResult
|
||||
{
|
||||
$model = config('auth.providers.users.model');
|
||||
$user = $model::find($subject->userId);
|
||||
|
||||
return new ProviderExportResult('customer', $user ? [
|
||||
'id' => $user->id,
|
||||
'name' => $user->name,
|
||||
'email' => $user->email,
|
||||
'customers' => $user->customers->map(fn (Customer $customer) => [
|
||||
'id' => $customer->id,
|
||||
'company_name' => $customer->company_name,
|
||||
])->all(),
|
||||
] : []);
|
||||
}
|
||||
|
||||
public function eraseForCustomer(CustomerSubject $subject): ProviderErasureResult
|
||||
{
|
||||
$customer = Customer::find($subject->customerId);
|
||||
|
||||
if (! $customer) {
|
||||
return new ProviderErasureResult('customer', ErasureOutcome::Skipped, 'Customer record not found.');
|
||||
}
|
||||
|
||||
$customer->update([
|
||||
'title' => null,
|
||||
'first_name' => 'Erased',
|
||||
'last_name' => "Customer #{$customer->id}",
|
||||
'company_name' => null,
|
||||
'tax_identifier' => null,
|
||||
'account_ref' => null,
|
||||
'meta' => null,
|
||||
]);
|
||||
|
||||
return new ProviderErasureResult('customer', ErasureOutcome::Erased);
|
||||
}
|
||||
|
||||
public function eraseForUser(UserSubject $subject): ProviderErasureResult
|
||||
{
|
||||
$model = config('auth.providers.users.model');
|
||||
$user = $model::find($subject->userId);
|
||||
|
||||
if (! $user) {
|
||||
return new ProviderErasureResult('customer', ErasureOutcome::Skipped, 'User record not found.');
|
||||
}
|
||||
|
||||
$user->customers()->detach();
|
||||
|
||||
$user->update([
|
||||
'name' => null,
|
||||
'email' => "erased-user-{$user->id}@example.invalid",
|
||||
// A live OTP code left on an otherwise-erased row is a residual
|
||||
// secret tied to an identity that no longer exists here — clear
|
||||
// it alongside name/email rather than leaving it to expire on
|
||||
// its own 10-minute window.
|
||||
'otp_code' => null,
|
||||
'otp_expires_at' => null,
|
||||
'otp_attempts' => 0,
|
||||
]);
|
||||
|
||||
return new ProviderErasureResult('customer', ErasureOutcome::Erased);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,23 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Export;
|
||||
|
||||
use Closure;
|
||||
|
||||
/**
|
||||
* One column in a CsvWriter schema: a header label plus a closure that pulls this
|
||||
* column's value out of one record. The closure doesn't care what shape a record
|
||||
* is — an array, an Eloquent model, a DTO — so the same CsvWriter serves any
|
||||
* domain (GDPR export, an admin catalog export, an accounting export) by simply
|
||||
* being handed a different column schema and a different row source.
|
||||
*/
|
||||
final class CsvColumn
|
||||
{
|
||||
/**
|
||||
* @param Closure(mixed):((string|int|float|null)) $value
|
||||
*/
|
||||
public function __construct(
|
||||
public readonly string $header,
|
||||
public readonly Closure $value,
|
||||
) {}
|
||||
}
|
||||
@@ -0,0 +1,45 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Export;
|
||||
|
||||
/**
|
||||
* A generic columns + rows -> CSV file writer. No knowledge of any domain (GDPR,
|
||||
* catalog, accounting, ...) — a caller supplies the schema (CsvColumn[]) and the
|
||||
* data source (any iterable of records), and this writes one CSV. Reusable for
|
||||
* any future bulk-export need without modification.
|
||||
*/
|
||||
class CsvWriter
|
||||
{
|
||||
/**
|
||||
* @param array<int, CsvColumn> $columns
|
||||
* @param iterable<mixed> $rows
|
||||
*/
|
||||
public function write(array $columns, iterable $rows, string $path): void
|
||||
{
|
||||
$handle = fopen($path, 'w');
|
||||
|
||||
fputcsv($handle, array_map(fn (CsvColumn $column) => $column->header, $columns));
|
||||
|
||||
foreach ($rows as $row) {
|
||||
fputcsv($handle, array_map(
|
||||
fn (CsvColumn $column) => $this->stringify(($column->value)($row)),
|
||||
$columns
|
||||
));
|
||||
}
|
||||
|
||||
fclose($handle);
|
||||
}
|
||||
|
||||
private function stringify(mixed $value): string
|
||||
{
|
||||
if ($value === null) {
|
||||
return '';
|
||||
}
|
||||
|
||||
if (is_array($value)) {
|
||||
return json_encode($value);
|
||||
}
|
||||
|
||||
return (string) $value;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,148 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Logging\Privacy;
|
||||
|
||||
use Lunar\Models\Address;
|
||||
use Lunar\Models\Cart;
|
||||
use Lunar\Models\CartAddress;
|
||||
use Lunar\Models\Customer;
|
||||
use Lunar\Models\Order;
|
||||
use Lunar\Models\OrderAddress;
|
||||
use Lunar\Models\Transaction;
|
||||
use Modules\Core\Privacy\Contracts\PersonalDataProvider;
|
||||
use Modules\Core\Privacy\DTOs\CustomerSubject;
|
||||
use Modules\Core\Privacy\Enums\ErasureOutcome;
|
||||
use Modules\Core\Privacy\DTOs\ProviderErasureResult;
|
||||
use Modules\Core\Privacy\DTOs\ProviderExportResult;
|
||||
use Modules\Core\Privacy\DTOs\UserSubject;
|
||||
use Spatie\Activitylog\Models\Activity;
|
||||
|
||||
/**
|
||||
* Spatie's own activity_log table (Modules\Core\Logging\ActivityLogService,
|
||||
* plus several Lunar models' native `use LogsActivity` — Customer,
|
||||
* CartAddress, OrderAddress, Transaction) durably retains a full snapshot
|
||||
* of whatever it logged in `properties` (created/updated/deleted
|
||||
* attributes, including a before/after diff on update), completely
|
||||
* independent of the real row it describes. Erasing/pseudonymizing
|
||||
* Customer/Address/CartAddress/OrderAddress/Transaction elsewhere (see
|
||||
* Customer\Privacy\CustomerDataProvider, Customer\Privacy\
|
||||
* AddressDataProvider, Cart\Privacy\CartDataProvider, Order\Privacy\
|
||||
* OrderDataProvider, Payment\Privacy\PaymentDataProvider) does nothing to
|
||||
* this table — a full copy of the old PII survives here regardless.
|
||||
*
|
||||
* Redacts by SUBJECT only, never by `causer_id` — the causer is "who did
|
||||
* this," not PII content, and erasing it would erode the audit trail's own
|
||||
* purpose (see this provider's own eraseForUser(), which is a deliberate
|
||||
* no-op). Genuinely Customer-scope only: every subject type here
|
||||
* (Customer, Address, CartAddress, OrderAddress, Transaction) resolves to
|
||||
* a business account via its own chain (Address/Customer directly;
|
||||
* CartAddress via cart_id -> Cart.customer_id; OrderAddress/Transaction
|
||||
* via order_id -> Order.customer_id) — none of it is a User's own data on
|
||||
* its own.
|
||||
*
|
||||
* MUST run before Customer\Privacy\AddressDataProvider in
|
||||
* config('core.privacy.providers') — that provider hard-deletes Address
|
||||
* rows, and once gone there is no way to re-derive which activity_log
|
||||
* rows (subject_type = Address) belonged to this customer. This provider
|
||||
* resolves that address id list itself, before anything deletes it.
|
||||
*/
|
||||
class ActivityLogDataProvider implements PersonalDataProvider
|
||||
{
|
||||
private const REDACTED = '[redacted]';
|
||||
|
||||
public function name(): string
|
||||
{
|
||||
return 'activity_log';
|
||||
}
|
||||
|
||||
public function exportForCustomer(CustomerSubject $subject): ProviderExportResult
|
||||
{
|
||||
$activities = Activity::query()
|
||||
->where(fn ($query) => $this->scopeToCustomer($query, $subject->customerId))
|
||||
->get();
|
||||
|
||||
return new ProviderExportResult('activity_log', $activities->map(fn (Activity $activity) => [
|
||||
'id' => $activity->id,
|
||||
'log_name' => $activity->log_name,
|
||||
'description' => $activity->description,
|
||||
'subject_type' => $activity->subject_type,
|
||||
'subject_id' => $activity->subject_id,
|
||||
'event' => $activity->event,
|
||||
'properties' => $activity->properties?->toArray(),
|
||||
'created_at' => $activity->created_at?->toIso8601String(),
|
||||
])->all());
|
||||
}
|
||||
|
||||
public function exportForUser(UserSubject $subject): ProviderExportResult
|
||||
{
|
||||
return new ProviderExportResult('activity_log', []);
|
||||
}
|
||||
|
||||
public function eraseForCustomer(CustomerSubject $subject): ProviderErasureResult
|
||||
{
|
||||
$affected = Activity::query()
|
||||
->where(fn ($query) => $this->scopeToCustomer($query, $subject->customerId))
|
||||
->get();
|
||||
|
||||
if ($affected->isEmpty()) {
|
||||
return new ProviderErasureResult('activity_log', ErasureOutcome::Skipped, 'No activity log entries for this customer.');
|
||||
}
|
||||
|
||||
foreach ($affected as $activity) {
|
||||
$activity->update(['properties' => $this->redact($activity->properties?->toArray() ?? [])]);
|
||||
}
|
||||
|
||||
return new ProviderErasureResult(
|
||||
'activity_log',
|
||||
ErasureOutcome::Pseudonymized,
|
||||
'PII-bearing properties redacted on matching audit log entries; who/what/when metadata (log_name, subject, event, timestamp, causer) retained for audit integrity.'
|
||||
);
|
||||
}
|
||||
|
||||
public function eraseForUser(UserSubject $subject): ProviderErasureResult
|
||||
{
|
||||
return new ProviderErasureResult(
|
||||
'activity_log',
|
||||
ErasureOutcome::Skipped,
|
||||
'A User only ever appears here as causer_id (who performed an action), not as the PII content of a log entry — redacting that would erode the audit trail\'s own record of who acted.'
|
||||
);
|
||||
}
|
||||
|
||||
private function scopeToCustomer($query, int $customerId): void
|
||||
{
|
||||
$customerMorph = (new Customer)->getMorphClass();
|
||||
$addressMorph = (new Address)->getMorphClass();
|
||||
$cartAddressMorph = (new CartAddress)->getMorphClass();
|
||||
$orderAddressMorph = (new OrderAddress)->getMorphClass();
|
||||
$transactionMorph = (new Transaction)->getMorphClass();
|
||||
|
||||
$addressIds = Address::where('customer_id', $customerId)->pluck('id');
|
||||
$cartIds = Cart::where('customer_id', $customerId)->pluck('id');
|
||||
$cartAddressIds = CartAddress::whereIn('cart_id', $cartIds)->pluck('id');
|
||||
$orderIds = Order::where('customer_id', $customerId)->pluck('id');
|
||||
$orderAddressIds = OrderAddress::whereIn('order_id', $orderIds)->pluck('id');
|
||||
$transactionIds = Transaction::whereIn('order_id', $orderIds)->pluck('id');
|
||||
|
||||
$query
|
||||
->where(fn ($q) => $q->where('subject_type', $customerMorph)->where('subject_id', $customerId))
|
||||
->orWhere(fn ($q) => $q->where('subject_type', $addressMorph)->whereIn('subject_id', $addressIds))
|
||||
->orWhere(fn ($q) => $q->where('subject_type', $cartAddressMorph)->whereIn('subject_id', $cartAddressIds))
|
||||
->orWhere(fn ($q) => $q->where('subject_type', $orderAddressMorph)->whereIn('subject_id', $orderAddressIds))
|
||||
->orWhere(fn ($q) => $q->where('subject_type', $transactionMorph)->whereIn('subject_id', $transactionIds));
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<string, mixed> $properties
|
||||
* @return array<string, mixed>
|
||||
*/
|
||||
private function redact(array $properties): array
|
||||
{
|
||||
return array_map(function ($value) {
|
||||
if (is_array($value)) {
|
||||
return array_map(fn () => self::REDACTED, $value);
|
||||
}
|
||||
|
||||
return self::REDACTED;
|
||||
}, $properties);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,148 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Order\Privacy;
|
||||
|
||||
use Lunar\Models\Order;
|
||||
use Lunar\Models\OrderAddress;
|
||||
use Modules\Core\Privacy\Contracts\PersonalDataProvider;
|
||||
use Modules\Core\Privacy\DTOs\CustomerSubject;
|
||||
use Modules\Core\Privacy\Enums\ErasureOutcome;
|
||||
use Modules\Core\Privacy\DTOs\ProviderErasureResult;
|
||||
use Modules\Core\Privacy\DTOs\ProviderExportResult;
|
||||
use Modules\Core\Privacy\DTOs\UserSubject;
|
||||
|
||||
/**
|
||||
* Orders and order addresses (lunar_orders, lunar_order_addresses) belong to the
|
||||
* Customer (business account) via customer_id, not to an individual User, so this
|
||||
* is Customer-scope only. They're also subject to legal retention (tax/accounting
|
||||
* law generally requires invoices be kept for several years — GDPR Art. 17(3)(b)
|
||||
* explicitly allows this to override an erasure request). eraseForCustomer()
|
||||
* therefore pseudonymizes the PII-bearing free-text fields in place rather than
|
||||
* deleting the order: totals, line items, tax data, and the order itself all
|
||||
* remain intact and auditable.
|
||||
*
|
||||
* Also covers PII-adjacent keys living in Order.meta and OrderAddress.meta —
|
||||
* Modules\Core\Checkout\Services\CheckoutService::initiatePayment() writes
|
||||
* terms_accepted/terms_accepted_at/terms_accepted_policy_version/payment_method
|
||||
* onto Order.meta, and Modules\Core\Shipping\Carriers\BoxNow\
|
||||
* BoxNowFulfillmentService writes the shopper's chosen box_now_locker onto
|
||||
* OrderAddress.meta — neither of which the free-text column erase above ever
|
||||
* touched. Kept Customer-scope, consistent with Order/OrderAddress themselves.
|
||||
*/
|
||||
class OrderDataProvider implements PersonalDataProvider
|
||||
{
|
||||
private const ORDER_META_KEYS = [
|
||||
'terms_accepted',
|
||||
'terms_accepted_at',
|
||||
'terms_accepted_policy_version',
|
||||
'payment_method',
|
||||
];
|
||||
|
||||
private const ADDRESS_META_KEYS = [
|
||||
'box_now_locker',
|
||||
];
|
||||
|
||||
public function name(): string
|
||||
{
|
||||
return 'orders';
|
||||
}
|
||||
|
||||
public function exportForCustomer(CustomerSubject $subject): ProviderExportResult
|
||||
{
|
||||
$orders = Order::where('customer_id', $subject->customerId)->with('addresses')->get();
|
||||
|
||||
return new ProviderExportResult('orders', $orders->map(fn (Order $order) => [
|
||||
'id' => $order->id,
|
||||
'reference' => $order->reference,
|
||||
'status' => $order->status,
|
||||
'total' => $order->total?->decimal(),
|
||||
'placed_at' => $order->placed_at?->toIso8601String(),
|
||||
'meta' => $this->onlyKeys((array) $order->meta, self::ORDER_META_KEYS),
|
||||
'addresses' => $order->addresses->map(fn (OrderAddress $address) => [
|
||||
'type' => $address->type,
|
||||
'first_name' => $address->first_name,
|
||||
'last_name' => $address->last_name,
|
||||
'line_one' => $address->line_one,
|
||||
'city' => $address->city,
|
||||
'postcode' => $address->postcode,
|
||||
'contact_email' => $address->contact_email,
|
||||
'contact_phone' => $address->contact_phone,
|
||||
'meta' => $this->onlyKeys((array) $address->meta, self::ADDRESS_META_KEYS),
|
||||
])->all(),
|
||||
])->all());
|
||||
}
|
||||
|
||||
public function exportForUser(UserSubject $subject): ProviderExportResult
|
||||
{
|
||||
return new ProviderExportResult('orders', []);
|
||||
}
|
||||
|
||||
public function eraseForCustomer(CustomerSubject $subject): ProviderErasureResult
|
||||
{
|
||||
$orders = Order::where('customer_id', $subject->customerId)->with('addresses')->get();
|
||||
|
||||
if ($orders->isEmpty()) {
|
||||
return new ProviderErasureResult('orders', ErasureOutcome::Skipped, 'No orders for this customer.');
|
||||
}
|
||||
|
||||
foreach ($orders as $order) {
|
||||
$order->update([
|
||||
'customer_reference' => null,
|
||||
'notes' => null,
|
||||
'meta' => $this->withoutKeys((array) $order->meta, self::ORDER_META_KEYS),
|
||||
]);
|
||||
|
||||
foreach ($order->addresses as $address) {
|
||||
$address->update([
|
||||
'title' => null,
|
||||
'first_name' => 'Erased',
|
||||
'last_name' => 'Customer',
|
||||
'company_name' => null,
|
||||
'tax_identifier' => null,
|
||||
'line_one' => null,
|
||||
'line_two' => null,
|
||||
'line_three' => null,
|
||||
'delivery_instructions' => null,
|
||||
'contact_email' => null,
|
||||
'contact_phone' => null,
|
||||
'meta' => $this->withoutKeys((array) $address->meta, self::ADDRESS_META_KEYS),
|
||||
]);
|
||||
}
|
||||
}
|
||||
|
||||
return new ProviderErasureResult(
|
||||
'orders',
|
||||
ErasureOutcome::Pseudonymized,
|
||||
'Order and address free-text fields and PII-bearing meta keys cleared; order records, totals, and line items retained for legal/tax record-keeping.'
|
||||
);
|
||||
}
|
||||
|
||||
public function eraseForUser(UserSubject $subject): ProviderErasureResult
|
||||
{
|
||||
return new ProviderErasureResult('orders', ErasureOutcome::Skipped, 'Orders belong to Customer accounts, not individual users.');
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<string, mixed> $meta
|
||||
* @param array<int, string> $keys
|
||||
* @return array<string, mixed>
|
||||
*/
|
||||
private function onlyKeys(array $meta, array $keys): array
|
||||
{
|
||||
return array_intersect_key($meta, array_flip($keys));
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<string, mixed> $meta
|
||||
* @param array<int, string> $keys
|
||||
* @return array<string, mixed>
|
||||
*/
|
||||
private function withoutKeys(array $meta, array $keys): array
|
||||
{
|
||||
foreach ($keys as $key) {
|
||||
unset($meta[$key]);
|
||||
}
|
||||
|
||||
return $meta;
|
||||
}
|
||||
}
|
||||
@@ -115,6 +115,25 @@ class StripePaymentDriver implements
|
||||
$params['payment_method'] = $data['payment_method'];
|
||||
}
|
||||
|
||||
// Reconciliation safety net: this app never creates a Stripe Customer
|
||||
// object and attaches no other identifying info to the PaymentIntent
|
||||
// (see docs/payments.md "Reconciliation" for the full reasoning), so
|
||||
// without this, a charge that succeeds on Stripe's side but is never
|
||||
// written to our own DB (e.g. a DB outage at exactly the wrong
|
||||
// moment) would be untraceable back to a cart/order — nothing to
|
||||
// search Stripe's dashboard by except amount/time/card last-4.
|
||||
// array_filter() drops order_id when it's not yet known (still null
|
||||
// in $context at initial pay()/authorize() time — see
|
||||
// rememberIntent()'s own null-coalesce for the same case).
|
||||
$metadata = array_filter([
|
||||
'cart_id' => $context['cart_id'] ?? null,
|
||||
'order_id' => $context['order_id'] ?? null,
|
||||
]);
|
||||
|
||||
if ($metadata !== []) {
|
||||
$params['metadata'] = $metadata;
|
||||
}
|
||||
|
||||
try {
|
||||
$paymentIntent = $this->stripe->getClient()->paymentIntents->create($params);
|
||||
} catch (ApiErrorException $e) {
|
||||
|
||||
@@ -60,9 +60,9 @@ class PaymentMethodResource extends Resource
|
||||
{
|
||||
protected static ?string $model = PaymentMethod::class;
|
||||
|
||||
protected static string|\BackedEnum|null $navigationIcon = 'heroicon-o-credit-card';
|
||||
protected static string | \BackedEnum | null $navigationIcon = 'heroicon-o-credit-card';
|
||||
|
||||
protected static string|\UnitEnum|null $navigationGroup = 'Settings';
|
||||
protected static string | \UnitEnum | null $navigationGroup = 'Settings';
|
||||
|
||||
protected static ?string $modelLabel = 'Payment Method';
|
||||
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
|
||||
namespace Modules\Core\Payment\Filament\Resources\PaymentMethodResource\Pages;
|
||||
|
||||
use Filament\Actions\CreateAction;
|
||||
use Filament\Actions;
|
||||
use Filament\Resources\Pages\ListRecords;
|
||||
use Modules\Core\Payment\Filament\Resources\PaymentMethodResource;
|
||||
@@ -15,7 +16,7 @@ class ListPaymentMethods extends ListRecords
|
||||
protected function getHeaderActions(): array
|
||||
{
|
||||
return [
|
||||
Actions\CreateAction::make()
|
||||
CreateAction::make()
|
||||
->schema(PaymentMethodResource::getFormComponents())
|
||||
->fillForm(fn () => [
|
||||
'position' => (PaymentMethod::max('position') ?? 0) + 1,
|
||||
|
||||
@@ -0,0 +1,108 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Payment\Privacy;
|
||||
|
||||
use Lunar\Models\Order;
|
||||
use Lunar\Models\Transaction;
|
||||
use Modules\Core\Payment\Models\StripePaymentIntent;
|
||||
use Modules\Core\Privacy\Contracts\PersonalDataProvider;
|
||||
use Modules\Core\Privacy\DTOs\CustomerSubject;
|
||||
use Modules\Core\Privacy\Enums\ErasureOutcome;
|
||||
use Modules\Core\Privacy\DTOs\ProviderErasureResult;
|
||||
use Modules\Core\Privacy\DTOs\ProviderExportResult;
|
||||
use Modules\Core\Privacy\DTOs\UserSubject;
|
||||
|
||||
/**
|
||||
* Payment records (lunar_transactions, stripe_payment_intents) belong to the
|
||||
* Customer (business account) via the Order they're attached to, not to an
|
||||
* individual User, so this is Customer-scope only — same chain
|
||||
* OrderDataProvider already uses (Order.customer_id).
|
||||
*
|
||||
* Like Order itself, payment/transaction records are subject to the same
|
||||
* tax/accounting legal retention argument (GDPR Art. 17(3)(b)) — a payment
|
||||
* record is part of the same financial audit trail as the order it settled,
|
||||
* so this pseudonymizes the card-identifying fields in place rather than
|
||||
* deleting the transaction: amount, status, and the transaction/order link
|
||||
* all remain intact and auditable.
|
||||
*
|
||||
* No Stripe Customer object exists anywhere in this app (see docs/
|
||||
* payments.md "Reconciliation") — there is nothing to request deletion of
|
||||
* on Stripe's side. The only local, erasable PII is the card brand/last-4
|
||||
* on Transaction and the cart_id/order_id/context correlation row on
|
||||
* stripe_payment_intents, which is deleted outright once its Order is
|
||||
* settled (its only purpose was resolving an async webhook callback — see
|
||||
* docs/payments.md "Async resolution" — which has already happened by the
|
||||
* time an erasure request would run).
|
||||
*/
|
||||
class PaymentDataProvider implements PersonalDataProvider
|
||||
{
|
||||
public function name(): string
|
||||
{
|
||||
return 'payments';
|
||||
}
|
||||
|
||||
public function exportForCustomer(CustomerSubject $subject): ProviderExportResult
|
||||
{
|
||||
$orderIds = Order::where('customer_id', $subject->customerId)->pluck('id');
|
||||
|
||||
$transactions = Transaction::whereIn('order_id', $orderIds)->get();
|
||||
$intents = StripePaymentIntent::whereIn('order_id', $orderIds)->get();
|
||||
|
||||
return new ProviderExportResult('payments', [
|
||||
'transactions' => $transactions->map(fn (Transaction $transaction) => [
|
||||
'id' => $transaction->id,
|
||||
'order_id' => $transaction->order_id,
|
||||
'type' => $transaction->type,
|
||||
'status' => $transaction->status,
|
||||
'amount' => $transaction->amount,
|
||||
'card_type' => $transaction->card_type,
|
||||
'last_four' => $transaction->last_four,
|
||||
'reference' => $transaction->reference,
|
||||
])->all(),
|
||||
'stripe_payment_intents' => $intents->map(fn (StripePaymentIntent $intent) => [
|
||||
'id' => $intent->id,
|
||||
'order_id' => $intent->order_id,
|
||||
'intent_id' => $intent->intent_id,
|
||||
'status' => $intent->status,
|
||||
])->all(),
|
||||
]);
|
||||
}
|
||||
|
||||
public function exportForUser(UserSubject $subject): ProviderExportResult
|
||||
{
|
||||
return new ProviderExportResult('payments', []);
|
||||
}
|
||||
|
||||
public function eraseForCustomer(CustomerSubject $subject): ProviderErasureResult
|
||||
{
|
||||
$orderIds = Order::where('customer_id', $subject->customerId)->pluck('id');
|
||||
|
||||
if ($orderIds->isEmpty()) {
|
||||
return new ProviderErasureResult('payments', ErasureOutcome::Skipped, 'No orders, and therefore no payment records, for this customer.');
|
||||
}
|
||||
|
||||
Transaction::whereIn('order_id', $orderIds)->update([
|
||||
'card_type' => null,
|
||||
'last_four' => null,
|
||||
]);
|
||||
|
||||
// stripe_payment_intents only ever existed to correlate a webhook
|
||||
// callback back to a cart/order (see docs/payments.md "Async
|
||||
// resolution") — that correlation has already served its purpose by
|
||||
// the time an erasure request runs, so these rows are deleted
|
||||
// outright rather than pseudonymized, unlike Transaction, which is
|
||||
// the actual audit-trail record.
|
||||
StripePaymentIntent::whereIn('order_id', $orderIds)->delete();
|
||||
|
||||
return new ProviderErasureResult(
|
||||
'payments',
|
||||
ErasureOutcome::Pseudonymized,
|
||||
'Card brand/last-four cleared from transaction records; amounts, statuses, and references retained for legal/tax record-keeping. Stripe correlation rows (no longer needed post-settlement) deleted.'
|
||||
);
|
||||
}
|
||||
|
||||
public function eraseForUser(UserSubject $subject): ProviderErasureResult
|
||||
{
|
||||
return new ProviderErasureResult('payments', ErasureOutcome::Skipped, 'Payments belong to Customer-owned orders, not individual users.');
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,55 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Privacy\Contracts;
|
||||
|
||||
use Modules\Core\Privacy\DTOs\CustomerSubject;
|
||||
use Modules\Core\Privacy\DTOs\ProviderErasureResult;
|
||||
use Modules\Core\Privacy\DTOs\ProviderExportResult;
|
||||
use Modules\Core\Privacy\DTOs\UserSubject;
|
||||
|
||||
/**
|
||||
* Implemented by any module that holds personal data and wants it included in
|
||||
* right-of-access/right-of-erasure requests — core, or a future ERP/banking/etc.
|
||||
* module. Core has no knowledge of what a provider actually stores or how; it only
|
||||
* calls these four methods and collects the results (see PrivacyManager).
|
||||
*
|
||||
* Two independent scopes, not one — see docs/privacy.md "User-scope vs
|
||||
* Customer-scope". A Customer (business account, per Lunar's model) can have many
|
||||
* linked Users, and one User can be linked to many Customer accounts (B2B
|
||||
* multi-seat access — see docs/modules.md "Customer/User Pairing"), so "erase this
|
||||
* person's identity" and "erase this business account's data" are genuinely
|
||||
* different operations with different blast radii:
|
||||
* - *ForUser(): erase/export one individual — their login, name, email —
|
||||
* wherever it appears, without touching any Customer account's own data
|
||||
* (orders, addresses) or any other User linked to those accounts.
|
||||
* - *ForCustomer(): erase/export one business account's own data, without
|
||||
* touching any linked User's login or personal identity.
|
||||
* A provider with nothing relevant to one scope implements that method as a
|
||||
* no-op returning ErasureOutcome::Skipped (for erase) or an empty payload (for
|
||||
* export) — see e.g. AddressDataProvider::eraseForUser().
|
||||
*
|
||||
* A provider owns its own retention judgment. There's no central taxonomy of "PII
|
||||
* vs financial data" in this contract on purpose — only the module that owns a
|
||||
* given table actually knows whether its data is freely erasable, must be
|
||||
* pseudonymized (e.g. financial records under a legal retention requirement), or
|
||||
* must be retained outright (e.g. fraud/security records). erase*() expresses
|
||||
* that by returning a ProviderErasureResult with the outcome that actually
|
||||
* happened.
|
||||
*/
|
||||
interface PersonalDataProvider
|
||||
{
|
||||
/**
|
||||
* A short, stable, unique machine name for this provider (e.g. 'customer',
|
||||
* 'orders', 'reviews') — used as the export payload's top-level key and in
|
||||
* erasure reports. Must not collide with another registered provider's name.
|
||||
*/
|
||||
public function name(): string;
|
||||
|
||||
public function exportForUser(UserSubject $subject): ProviderExportResult;
|
||||
|
||||
public function exportForCustomer(CustomerSubject $subject): ProviderExportResult;
|
||||
|
||||
public function eraseForUser(UserSubject $subject): ProviderErasureResult;
|
||||
|
||||
public function eraseForCustomer(CustomerSubject $subject): ProviderErasureResult;
|
||||
}
|
||||
@@ -0,0 +1,28 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Privacy\DTOs;
|
||||
|
||||
use Lunar\Models\Customer;
|
||||
|
||||
/**
|
||||
* Identifies "the business account" for a Customer-scoped data-subject request —
|
||||
* erasing/exporting a Customer's own data (orders, addresses, the account record
|
||||
* itself). Deliberately carries no userIds/email: Customer-scope must never touch
|
||||
* any linked User's login or personal identity, only the account's own data — see
|
||||
* docs/privacy.md "User-scope vs Customer-scope". A provider that needs to know
|
||||
* which Users are linked (e.g. to export their names as account contacts, without
|
||||
* erasing their logins) looks that up itself via the Customer model, rather than
|
||||
* this value object handing it out — keeping "erase a Customer" structurally
|
||||
* incapable of touching a User row is the whole point of the split.
|
||||
*/
|
||||
class CustomerSubject
|
||||
{
|
||||
public function __construct(
|
||||
public readonly int $customerId,
|
||||
) {}
|
||||
|
||||
public static function forCustomer(Customer $customer): self
|
||||
{
|
||||
return new self(customerId: $customer->id);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,33 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Privacy\DTOs;
|
||||
|
||||
use Modules\Core\Privacy\Enums\ErasureOutcome;
|
||||
|
||||
/**
|
||||
* Every registered provider's outcome, assembled into one right-of-erasure response
|
||||
* — the audit trail proving what happened and, for anything not fully erased, why.
|
||||
* $subject is whichever scope the request was for — see docs/privacy.md
|
||||
* "User-scope vs Customer-scope".
|
||||
*/
|
||||
class ErasureReport
|
||||
{
|
||||
/**
|
||||
* @param array<int, ProviderErasureResult> $results
|
||||
*/
|
||||
public function __construct(
|
||||
public readonly UserSubject|CustomerSubject $subject,
|
||||
public readonly array $results,
|
||||
) {}
|
||||
|
||||
/**
|
||||
* @return array<int, ProviderErasureResult>
|
||||
*/
|
||||
public function retained(): array
|
||||
{
|
||||
return array_values(array_filter(
|
||||
$this->results,
|
||||
fn (ProviderErasureResult $result) => $result->outcome === ErasureOutcome::Retained
|
||||
));
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,39 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Privacy\DTOs;
|
||||
|
||||
/**
|
||||
* Every registered provider's export, assembled into one right-of-access response.
|
||||
* $subject is whichever scope the request was for — see docs/privacy.md
|
||||
* "User-scope vs Customer-scope".
|
||||
*/
|
||||
class ExportReport
|
||||
{
|
||||
/**
|
||||
* @param array<int, ProviderExportResult> $results
|
||||
*/
|
||||
public function __construct(
|
||||
public readonly UserSubject|CustomerSubject $subject,
|
||||
public readonly array $results,
|
||||
) {}
|
||||
|
||||
/**
|
||||
* @return array<string, array<string, mixed>> keyed by provider name
|
||||
*/
|
||||
public function toArray(): array
|
||||
{
|
||||
$data = [];
|
||||
|
||||
foreach ($this->results as $result) {
|
||||
// A provider that threw (ProviderExportResult::$error set — see
|
||||
// Modules\Core\Privacy\Jobs\ExportDataSubjectJob::safeExport())
|
||||
// surfaces as an explicit error marker rather than an empty
|
||||
// array indistinguishable from "genuinely nothing to export."
|
||||
$data[$result->provider] = $result->error !== null
|
||||
? ['error' => $result->error]
|
||||
: $result->data;
|
||||
}
|
||||
|
||||
return $data;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,20 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Privacy\DTOs;
|
||||
|
||||
use Modules\Core\Privacy\Enums\ErasureOutcome;
|
||||
|
||||
/**
|
||||
* One provider's outcome on an erasure request. `reason` is required whenever
|
||||
* outcome isn't Erased, so a compliance report or admin UI can show *why* something
|
||||
* wasn't deleted (e.g. "orders retained per tax law for 7 years from placement")
|
||||
* without reading that module's source.
|
||||
*/
|
||||
class ProviderErasureResult
|
||||
{
|
||||
public function __construct(
|
||||
public readonly string $provider,
|
||||
public readonly ErasureOutcome $outcome,
|
||||
public readonly ?string $reason = null,
|
||||
) {}
|
||||
}
|
||||
@@ -0,0 +1,26 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Privacy\DTOs;
|
||||
|
||||
/**
|
||||
* One provider's contribution to a right-of-access export. `provider` is a short,
|
||||
* stable machine name (e.g. 'customer', 'orders', 'reviews') used as the top-level
|
||||
* key when PrivacyService assembles every provider's data into one export payload.
|
||||
*
|
||||
* `error` is set only when the provider threw an exception instead of returning
|
||||
* normally — see Modules\Core\Privacy\Jobs\ExportDataSubjectJob, which catches
|
||||
* per-provider so one provider throwing doesn't discard every other provider's
|
||||
* already-gathered data for the same request. `data` is empty whenever `error` is
|
||||
* set, never a partial/best-effort payload.
|
||||
*/
|
||||
class ProviderExportResult
|
||||
{
|
||||
/**
|
||||
* @param array<string, mixed> $data
|
||||
*/
|
||||
public function __construct(
|
||||
public readonly string $provider,
|
||||
public readonly array $data,
|
||||
public readonly ?string $error = null,
|
||||
) {}
|
||||
}
|
||||
@@ -0,0 +1,30 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Privacy\DTOs;
|
||||
|
||||
use Illuminate\Contracts\Auth\Authenticatable;
|
||||
use Lunar\Base\LunarUser;
|
||||
|
||||
/**
|
||||
* Identifies "the person" for a User-scoped data-subject request — erasing/
|
||||
* exporting one individual's own identity (login, name, email) wherever it
|
||||
* appears, regardless of how many Customer (business) accounts they're linked to.
|
||||
* Deliberately carries no customerId: a provider that needs to know which
|
||||
* Customer accounts this User is linked to (e.g. to detach them, or to find data
|
||||
* keyed by a shared email) looks that up itself, rather than this value object
|
||||
* assuming one fixed Customer — the whole point is that one User can belong to
|
||||
* many Customer accounts (B2B multi-seat access) and erasing the User must not
|
||||
* assume or privilege any single one of them.
|
||||
*/
|
||||
class UserSubject
|
||||
{
|
||||
public function __construct(
|
||||
public readonly int $userId,
|
||||
public readonly ?string $email = null,
|
||||
) {}
|
||||
|
||||
public static function forUser(Authenticatable&LunarUser $user): self
|
||||
{
|
||||
return new self(userId: $user->id, email: $user->email);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,22 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Privacy\Enums;
|
||||
|
||||
/**
|
||||
* What actually happened to a provider's data on an erasure request. Erased/
|
||||
* Pseudonymized/Retained/Skipped are never failures — Retained is a valid, often
|
||||
* legally-required outcome (e.g. an Order kept intact for tax retention), distinct
|
||||
* from a provider erroring out. Failed is the one genuine failure case: a provider
|
||||
* threw an exception instead of returning normally — see Modules\Core\Privacy\
|
||||
* Services\PrivacyService::completeErasure(), which catches per-provider so one
|
||||
* provider throwing doesn't discard every other provider's already-computed
|
||||
* result for the same request.
|
||||
*/
|
||||
enum ErasureOutcome: string
|
||||
{
|
||||
case Erased = 'erased';
|
||||
case Pseudonymized = 'pseudonymized';
|
||||
case Retained = 'retained';
|
||||
case Skipped = 'skipped';
|
||||
case Failed = 'failed';
|
||||
}
|
||||
@@ -0,0 +1,10 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Privacy\Enums;
|
||||
|
||||
enum ErasureRequestStatus: string
|
||||
{
|
||||
case Pending = 'pending';
|
||||
case Cancelled = 'cancelled';
|
||||
case Completed = 'completed';
|
||||
}
|
||||
@@ -0,0 +1,10 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Privacy\Enums;
|
||||
|
||||
enum ExportRequestStatus: string
|
||||
{
|
||||
case Pending = 'pending';
|
||||
case Completed = 'completed';
|
||||
case Failed = 'failed';
|
||||
}
|
||||
@@ -0,0 +1,20 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Privacy\Events;
|
||||
|
||||
use Modules\Core\Privacy\Models\DataExportRequest;
|
||||
|
||||
/**
|
||||
* Fired once the export file exists and $request has been marked completed. Core
|
||||
* has no opinion on how the customer should be told — a consuming app registers
|
||||
* its own notification against this event via Modules\Core\Notification\
|
||||
* NotificationRegistry, the same pattern as App\Notifications\
|
||||
* QuestionnaireResultsSentNotification listening on App\Events\
|
||||
* QuestionnaireResultsSent.
|
||||
*/
|
||||
class PersonalDataExportFileWritten
|
||||
{
|
||||
public function __construct(
|
||||
public readonly DataExportRequest $request,
|
||||
) {}
|
||||
}
|
||||
@@ -0,0 +1,22 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Privacy\Events;
|
||||
|
||||
use Modules\Core\Privacy\DTOs\ExportReport;
|
||||
use Modules\Core\Privacy\Models\DataExportRequest;
|
||||
|
||||
/**
|
||||
* Fired once ExportDataSubjectJob has gathered every registered provider's data —
|
||||
* no file exists yet at this point. Modules\Core\Privacy\Listeners\
|
||||
* WriteExportToCsvListener (registered in PrivacyServiceProvider) is what actually
|
||||
* turns this into a file, kept as its own listener rather than inline in the job
|
||||
* so the export *format* (CSV today) is swappable without touching how the data
|
||||
* is gathered.
|
||||
*/
|
||||
class PersonalDataGathered
|
||||
{
|
||||
public function __construct(
|
||||
public readonly DataExportRequest $request,
|
||||
public readonly ExportReport $report,
|
||||
) {}
|
||||
}
|
||||
@@ -0,0 +1,19 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Privacy\Events;
|
||||
|
||||
use Modules\Core\Privacy\Models\DataErasureRequest;
|
||||
|
||||
/**
|
||||
* Fired by PrivacyService::requestErasureForUser() right after the grace-period
|
||||
* request is created (not at completeErasure() time — see
|
||||
* Modules\Core\Privacy\Listeners\CascadeCustomerErasureListener, which needs to
|
||||
* act while the User is still linked to their Customers, before any detach has
|
||||
* happened).
|
||||
*/
|
||||
class UserErasureRequested
|
||||
{
|
||||
public function __construct(
|
||||
public readonly DataErasureRequest $request,
|
||||
) {}
|
||||
}
|
||||
@@ -0,0 +1,85 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Privacy\Filament\Extensions;
|
||||
|
||||
use Filament\Actions\Action;
|
||||
use Filament\Forms\Components\Checkbox;
|
||||
use Filament\Notifications\Notification;
|
||||
use Lunar\Admin\Support\Extending\BaseExtension;
|
||||
use Lunar\Models\Customer;
|
||||
use Modules\Core\Auth\Models\Staff;
|
||||
use Modules\Core\Privacy\Services\PrivacyService;
|
||||
|
||||
/**
|
||||
* Adds "Request erasure" / "Request export" header actions to the Customer
|
||||
* resource's edit/view page — the panel entry point for a staff member handling
|
||||
* "a customer emailed asking to be forgotten/for their data" without needing
|
||||
* tinker/code access. Registered centrally in CorePlugin, layered alongside
|
||||
* whatever CustomerResourceExtension a consuming app registers for its own
|
||||
* form/table/relations — LunarPanel::extensions() merges per resource (see
|
||||
* docs/modules.md "Layering Module and App Configuration"), and this extension
|
||||
* deliberately only implements headerActions(), so it never conflicts with an
|
||||
* app's own extension for the same resource.
|
||||
*/
|
||||
class CustomerErasureActionsExtension extends BaseExtension
|
||||
{
|
||||
public function headerActions(array $actions): array
|
||||
{
|
||||
return [
|
||||
...$actions,
|
||||
Action::make('requestErasure')
|
||||
->label('Request Erasure')
|
||||
->icon('heroicon-o-shield-exclamation')
|
||||
->color('danger')
|
||||
->requiresConfirmation()
|
||||
->modalDescription('Opens a cancellable grace-period erasure request for this Customer account. No linked User\'s login is affected.')
|
||||
->schema([
|
||||
Checkbox::make('immediate')
|
||||
->label('Erase immediately (skip the 30-day grace period)')
|
||||
->helperText('Staff-only, for a formal legal request or regulator inquiry that genuinely requires urgency — not a routine deletion. Runs synchronously, cannot be cancelled once submitted.')
|
||||
->default(false),
|
||||
])
|
||||
->action(function (Customer $record, array $data) {
|
||||
$privacyService = app(PrivacyService::class);
|
||||
|
||||
if ($data['immediate']) {
|
||||
$privacyService->requestImmediateErasureForCustomer($record, $this->currentStaff());
|
||||
|
||||
Notification::make()
|
||||
->title('Customer erased')
|
||||
->body('Erasure ran immediately — see the Erasure Requests list for the outcome.')
|
||||
->success()
|
||||
->send();
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
$privacyService->requestErasureForCustomer($record, $this->currentStaff());
|
||||
|
||||
Notification::make()
|
||||
->title('Erasure requested')
|
||||
->body('The grace period starts now — see the Erasure Requests list.')
|
||||
->success()
|
||||
->send();
|
||||
}),
|
||||
Action::make('requestExport')
|
||||
->label('Request Export')
|
||||
->icon('heroicon-o-arrow-down-tray')
|
||||
->requiresConfirmation()
|
||||
->action(function (Customer $record) {
|
||||
app(PrivacyService::class)->requestExportForCustomer($record);
|
||||
|
||||
Notification::make()
|
||||
->title('Export requested')
|
||||
->body('Generating in the background — see the Export Requests list once it completes.')
|
||||
->success()
|
||||
->send();
|
||||
}),
|
||||
];
|
||||
}
|
||||
|
||||
private function currentStaff(): Staff
|
||||
{
|
||||
return auth('staff')->user();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,41 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Privacy\Filament\Extensions;
|
||||
|
||||
use Lunar\Admin\Filament\Resources\CustomerResource\RelationManagers\UserRelationManager as BaseUserRelationManager;
|
||||
use Lunar\Admin\Support\Extending\BaseExtension;
|
||||
use Modules\Core\Privacy\RelationManagers\ErasureRequestsRelationManager;
|
||||
use Modules\Core\Privacy\RelationManagers\ExportRequestsRelationManager;
|
||||
use Modules\Core\Privacy\RelationManagers\UserRelationManager;
|
||||
|
||||
/**
|
||||
* Adds the erasureRequests/exportRequests relation managers (see CorePlugin's
|
||||
* Customer::erasureRequests()/exportRequests() macros) to the Customer resource's
|
||||
* relation tabs — separate from CustomerErasureActionsExtension (headerActions)
|
||||
* so each extension stays single-purpose. Unlike headerActions(), getRelations()
|
||||
* genuinely is resource-keyed (called statically from the Resource class, not a
|
||||
* page instance), so this is registered under CustomerResource::class itself in
|
||||
* CorePlugin, not a page class.
|
||||
*
|
||||
* Also swaps Lunar's base UserRelationManager for Modules\Core\Privacy\
|
||||
* RelationManagers\UserRelationManager, which adds a "Privacy Requests" row
|
||||
* action per user — see that class's docblock for why this can't be a nested
|
||||
* relation manager instead. Compares against Lunar's own base class, not any
|
||||
* intermediate override, per docs/lunar.md "Overriding Lunar Relation Managers".
|
||||
*/
|
||||
class CustomerErasureRelationsExtension extends BaseExtension
|
||||
{
|
||||
public function getRelations(array $relations): array
|
||||
{
|
||||
$relations = array_map(
|
||||
fn ($relation) => $relation === BaseUserRelationManager::class ? UserRelationManager::class : $relation,
|
||||
$relations
|
||||
);
|
||||
|
||||
return [
|
||||
...$relations,
|
||||
ErasureRequestsRelationManager::class,
|
||||
ExportRequestsRelationManager::class,
|
||||
];
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,231 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Privacy\Filament\Resources;
|
||||
|
||||
use Filament\Schemas\Schema;
|
||||
use Filament\Actions\ViewAction;
|
||||
use Filament\Actions\Action;
|
||||
use Filament\Infolists\Components\RepeatableEntry;
|
||||
use Filament\Infolists\Components\RepeatableEntry\TableColumn;
|
||||
use Filament\Infolists\Components\TextEntry;
|
||||
use Filament\Schemas\Components\Section;
|
||||
use Modules\Core\Privacy\Enums\ErasureOutcome;
|
||||
use Modules\Core\Privacy\Filament\Resources\DataErasureRequestResource\Pages\ListDataErasureRequests;
|
||||
use Modules\Core\Privacy\Filament\Resources\DataErasureRequestResource\Pages\ViewDataErasureRequest;
|
||||
use Filament\Resources\Resource;
|
||||
use Filament\Tables\Columns\TextColumn;
|
||||
use Filament\Tables\Filters\SelectFilter;
|
||||
use Filament\Tables\Table;
|
||||
use Lunar\Models\Customer;
|
||||
use Modules\Core\Privacy\Enums\ErasureRequestStatus;
|
||||
use Modules\Core\Privacy\Filament\Resources\DataErasureRequestResource\Pages;
|
||||
use Modules\Core\Privacy\Models\DataErasureRequest;
|
||||
use Modules\Core\Privacy\Services\PrivacyService;
|
||||
|
||||
/**
|
||||
* Read-mostly audit view over data_erasure_requests — staff can see every request
|
||||
* (who/what/when/status), inspect the per-provider outcome report once completed,
|
||||
* and cancel a pending one. Requests themselves are created via PrivacyService
|
||||
* (see Modules\Core\Privacy\Filament\Extensions\CustomerErasureActionsExtension
|
||||
* for the Customer-resource entry point) — this resource has no create/edit page,
|
||||
* since a request's lifecycle is owned by PrivacyService, not free-form editing.
|
||||
*/
|
||||
class DataErasureRequestResource extends Resource
|
||||
{
|
||||
protected static ?string $model = DataErasureRequest::class;
|
||||
|
||||
protected static string | \BackedEnum | null $navigationIcon = 'heroicon-o-shield-exclamation';
|
||||
|
||||
protected static string | \UnitEnum | null $navigationGroup = 'Privacy';
|
||||
|
||||
protected static ?string $modelLabel = 'Erasure Request';
|
||||
|
||||
protected static ?string $pluralModelLabel = 'Erasure Requests';
|
||||
|
||||
/**
|
||||
* A real infolist, not form()'s disabled inputs/Placeholders — ViewRecord
|
||||
* falls back to rendering form() in read-only mode when a resource has no
|
||||
* infolist() at all (Filament\Resources\Pages\ViewRecord::hasInfolist()),
|
||||
* which is what this resource did before: every field rendered as a
|
||||
* plain, unstyled label/value pair with no grouping, badges, or icons.
|
||||
*/
|
||||
public static function infolist(Schema $schema): Schema
|
||||
{
|
||||
return $schema->components([
|
||||
Section::make('Request')
|
||||
->icon('heroicon-o-shield-exclamation')
|
||||
->columns(4)
|
||||
->components([
|
||||
TextEntry::make('subject')
|
||||
->label('Subject')
|
||||
->state(fn (DataErasureRequest $record) => DataErasureRequest::displayNameFor($record->subject))
|
||||
->weight('bold')
|
||||
->size('lg'),
|
||||
TextEntry::make('subject_type')
|
||||
->label('Scope')
|
||||
->formatStateUsing(fn (DataErasureRequest $record) => $record->isForCustomer() ? 'Customer account' : 'Individual user')
|
||||
->badge()
|
||||
->icon(fn (DataErasureRequest $record) => $record->isForCustomer() ? 'heroicon-o-building-office' : 'heroicon-o-user')
|
||||
->color(fn (DataErasureRequest $record) => $record->isForCustomer() ? 'info' : 'warning'),
|
||||
TextEntry::make('email')
|
||||
->label('Email (snapshot at request time)')
|
||||
->icon('heroicon-o-envelope')
|
||||
->copyable(),
|
||||
TextEntry::make('requested_by')
|
||||
->label('Requested by')
|
||||
->state(fn (DataErasureRequest $record) => DataErasureRequest::displayNameFor($record->requestedBy))
|
||||
->icon('heroicon-o-user-circle'),
|
||||
TextEntry::make('status')
|
||||
->badge()
|
||||
->formatStateUsing(fn (ErasureRequestStatus $state) => ucfirst($state->value))
|
||||
->color(fn (ErasureRequestStatus $state) => match ($state) {
|
||||
ErasureRequestStatus::Pending => 'warning',
|
||||
ErasureRequestStatus::Cancelled => 'gray',
|
||||
ErasureRequestStatus::Completed => 'success',
|
||||
}),
|
||||
TextEntry::make('created_at')
|
||||
->label('Requested at')
|
||||
->dateTime()
|
||||
->icon('heroicon-o-calendar'),
|
||||
TextEntry::make('scheduled_for')
|
||||
->label('Scheduled for')
|
||||
->dateTime()
|
||||
->icon('heroicon-o-calendar-days'),
|
||||
TextEntry::make('completed_at')
|
||||
->label('Completed at')
|
||||
->dateTime()
|
||||
->placeholder('—')
|
||||
->icon('heroicon-o-check-circle')
|
||||
->color(fn (DataErasureRequest $record) => $record->completed_at ? 'success' : 'gray'),
|
||||
TextEntry::make('cancelled_at')
|
||||
->label('Cancelled at')
|
||||
->dateTime()
|
||||
->placeholder('—')
|
||||
->icon('heroicon-o-x-circle')
|
||||
->color(fn (DataErasureRequest $record) => $record->cancelled_at ? 'danger' : 'gray')
|
||||
->visible(fn (DataErasureRequest $record) => $record->cancelled_at !== null),
|
||||
TextEntry::make('caused_by')
|
||||
->label('Cascade')
|
||||
->icon('heroicon-o-arrow-turn-down-right')
|
||||
->state(fn (DataErasureRequest $record) => $record->causedBy
|
||||
? "From request #{$record->causedBy->id} (".DataErasureRequest::displayNameFor($record->causedBy->subject).')'
|
||||
: 'Directly requested')
|
||||
->color(fn (DataErasureRequest $record) => $record->caused_by_request_id !== null ? 'info' : 'gray'),
|
||||
]),
|
||||
|
||||
Section::make('Outcome')
|
||||
->description('What happened to each data category once the erasure ran. "Retained"/"Pseudonymized" usually means the data is kept in an anonymized form for legal or accounting reasons.')
|
||||
->icon('heroicon-o-document-check')
|
||||
->visible(fn (DataErasureRequest $record) => $record->report !== null)
|
||||
->components([
|
||||
RepeatableEntry::make('report')
|
||||
->hiddenLabel()
|
||||
->table([
|
||||
TableColumn::make('Data category'),
|
||||
TableColumn::make('Outcome'),
|
||||
TableColumn::make('Reason'),
|
||||
])
|
||||
->components([
|
||||
TextEntry::make('provider'),
|
||||
TextEntry::make('outcome')
|
||||
->badge()
|
||||
->formatStateUsing(fn (string $state) => ucfirst($state))
|
||||
->color(fn (string $state) => match ($state) {
|
||||
ErasureOutcome::Erased->value => 'success',
|
||||
ErasureOutcome::Pseudonymized->value, ErasureOutcome::Retained->value => 'info',
|
||||
ErasureOutcome::Skipped->value => 'gray',
|
||||
ErasureOutcome::Failed->value => 'danger',
|
||||
default => 'gray',
|
||||
}),
|
||||
TextEntry::make('reason')
|
||||
->placeholder('—'),
|
||||
]),
|
||||
]),
|
||||
]);
|
||||
}
|
||||
|
||||
public static function table(Table $table): Table
|
||||
{
|
||||
return $table
|
||||
->columns([
|
||||
TextColumn::make('id')
|
||||
->label('#')
|
||||
->sortable(),
|
||||
TextColumn::make('subject_type')
|
||||
->label('Scope')
|
||||
->formatStateUsing(fn (DataErasureRequest $record) => $record->isForCustomer() ? 'Customer' : 'User')
|
||||
->badge()
|
||||
->color(fn (DataErasureRequest $record) => $record->isForCustomer() ? 'info' : 'warning'),
|
||||
TextColumn::make('subject')
|
||||
->label('Subject')
|
||||
->state(fn (DataErasureRequest $record) => DataErasureRequest::displayNameFor($record->subject))
|
||||
->searchable(query: fn ($query, string $search) => $query->where('email', 'like', "%{$search}%")),
|
||||
TextColumn::make('requestedBy')
|
||||
->label('Requested by')
|
||||
->state(fn (DataErasureRequest $record) => DataErasureRequest::displayNameFor($record->requestedBy)),
|
||||
TextColumn::make('status')
|
||||
->badge()
|
||||
->formatStateUsing(fn (ErasureRequestStatus $state) => ucfirst($state->value))
|
||||
->color(fn (ErasureRequestStatus $state) => match ($state) {
|
||||
ErasureRequestStatus::Pending => 'warning',
|
||||
ErasureRequestStatus::Cancelled => 'gray',
|
||||
ErasureRequestStatus::Completed => 'success',
|
||||
}),
|
||||
TextColumn::make('scheduled_for')
|
||||
->label('Scheduled for')
|
||||
->dateTime()
|
||||
->sortable(),
|
||||
TextColumn::make('caused_by_request_id')
|
||||
->label('Cascade')
|
||||
->formatStateUsing(fn (?int $state) => $state ? "from #{$state}" : '—')
|
||||
->toggleable(isToggledHiddenByDefault: true),
|
||||
TextColumn::make('created_at')
|
||||
->label('Requested at')
|
||||
->dateTime()
|
||||
->sortable()
|
||||
->toggleable(isToggledHiddenByDefault: true),
|
||||
])
|
||||
->defaultSort('created_at', 'desc')
|
||||
->filters([
|
||||
SelectFilter::make('status')
|
||||
->options([
|
||||
ErasureRequestStatus::Pending->value => 'Pending',
|
||||
ErasureRequestStatus::Cancelled->value => 'Cancelled',
|
||||
ErasureRequestStatus::Completed->value => 'Completed',
|
||||
]),
|
||||
SelectFilter::make('subject_type')
|
||||
->label('Scope')
|
||||
->options(function () {
|
||||
$userModel = config('auth.providers.users.model');
|
||||
|
||||
return [
|
||||
(new Customer)->getMorphClass() => 'Customer',
|
||||
(new $userModel)->getMorphClass() => 'User',
|
||||
];
|
||||
}),
|
||||
])
|
||||
->recordActions([
|
||||
ViewAction::make(),
|
||||
Action::make('cancel')
|
||||
->label('Cancel')
|
||||
->icon('heroicon-o-x-circle')
|
||||
->color('danger')
|
||||
->requiresConfirmation()
|
||||
->visible(fn (DataErasureRequest $record) => $record->isPending())
|
||||
->action(fn (DataErasureRequest $record, PrivacyService $privacyService) => $privacyService->cancelErasure($record)),
|
||||
]);
|
||||
}
|
||||
|
||||
public static function getPages(): array
|
||||
{
|
||||
return [
|
||||
'index' => ListDataErasureRequests::route('/'),
|
||||
'view' => ViewDataErasureRequest::route('/{record}'),
|
||||
];
|
||||
}
|
||||
|
||||
public static function canCreate(): bool
|
||||
{
|
||||
return false;
|
||||
}
|
||||
}
|
||||
+11
@@ -0,0 +1,11 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Privacy\Filament\Resources\DataErasureRequestResource\Pages;
|
||||
|
||||
use Filament\Resources\Pages\ListRecords;
|
||||
use Modules\Core\Privacy\Filament\Resources\DataErasureRequestResource;
|
||||
|
||||
class ListDataErasureRequests extends ListRecords
|
||||
{
|
||||
protected static string $resource = DataErasureRequestResource::class;
|
||||
}
|
||||
+11
@@ -0,0 +1,11 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Privacy\Filament\Resources\DataErasureRequestResource\Pages;
|
||||
|
||||
use Filament\Resources\Pages\ViewRecord;
|
||||
use Modules\Core\Privacy\Filament\Resources\DataErasureRequestResource;
|
||||
|
||||
class ViewDataErasureRequest extends ViewRecord
|
||||
{
|
||||
protected static string $resource = DataErasureRequestResource::class;
|
||||
}
|
||||
@@ -0,0 +1,172 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Privacy\Filament\Resources;
|
||||
|
||||
use Filament\Schemas\Schema;
|
||||
use Filament\Actions\ViewAction;
|
||||
use Filament\Actions\Action;
|
||||
use Filament\Infolists\Components\TextEntry;
|
||||
use Filament\Schemas\Components\Section;
|
||||
use Modules\Core\Privacy\Filament\Resources\DataExportRequestResource\Pages\ListDataExportRequests;
|
||||
use Modules\Core\Privacy\Filament\Resources\DataExportRequestResource\Pages\ViewDataExportRequest;
|
||||
use Filament\Resources\Resource;
|
||||
use Filament\Tables\Columns\TextColumn;
|
||||
use Filament\Tables\Filters\SelectFilter;
|
||||
use Filament\Tables\Table;
|
||||
use Modules\Core\Privacy\Enums\ExportRequestStatus;
|
||||
use Modules\Core\Privacy\Filament\Resources\DataExportRequestResource\Pages;
|
||||
use Modules\Core\Privacy\Models\DataErasureRequest;
|
||||
use Modules\Core\Privacy\Models\DataExportRequest;
|
||||
|
||||
/**
|
||||
* Read-only audit view over data_export_requests — see DataErasureRequestResource
|
||||
* for the erasure-side equivalent and the shared reasoning (no create/edit page,
|
||||
* requests are created via PrivacyService::requestExport*()).
|
||||
*/
|
||||
class DataExportRequestResource extends Resource
|
||||
{
|
||||
protected static ?string $model = DataExportRequest::class;
|
||||
|
||||
protected static string | \BackedEnum | null $navigationIcon = 'heroicon-o-arrow-down-tray';
|
||||
|
||||
protected static string | \UnitEnum | null $navigationGroup = 'Privacy';
|
||||
|
||||
protected static ?string $modelLabel = 'Export Request';
|
||||
|
||||
protected static ?string $pluralModelLabel = 'Export Requests';
|
||||
|
||||
/**
|
||||
* A real infolist, not form()'s disabled inputs/Placeholders — see
|
||||
* DataErasureRequestResource::infolist()'s own docblock for why.
|
||||
*/
|
||||
public static function infolist(Schema $schema): Schema
|
||||
{
|
||||
return $schema->components([
|
||||
Section::make('Request')
|
||||
->icon('heroicon-o-arrow-down-tray')
|
||||
->columns(4)
|
||||
->components([
|
||||
TextEntry::make('subject')
|
||||
->label('Subject')
|
||||
->state(fn (DataExportRequest $record) => DataErasureRequest::displayNameFor($record->subject))
|
||||
->weight('bold')
|
||||
->size('lg'),
|
||||
TextEntry::make('subject_type')
|
||||
->label('Scope')
|
||||
->formatStateUsing(fn (DataExportRequest $record) => $record->isForCustomer() ? 'Customer account' : 'Individual user')
|
||||
->badge()
|
||||
->icon(fn (DataExportRequest $record) => $record->isForCustomer() ? 'heroicon-o-building-office' : 'heroicon-o-user')
|
||||
->color(fn (DataExportRequest $record) => $record->isForCustomer() ? 'info' : 'warning'),
|
||||
TextEntry::make('email')
|
||||
->label('Email (snapshot at request time)')
|
||||
->icon('heroicon-o-envelope')
|
||||
->copyable(),
|
||||
TextEntry::make('status')
|
||||
->badge()
|
||||
->formatStateUsing(fn (ExportRequestStatus $state) => ucfirst($state->value))
|
||||
->color(fn (ExportRequestStatus $state) => match ($state) {
|
||||
ExportRequestStatus::Pending => 'warning',
|
||||
ExportRequestStatus::Failed => 'danger',
|
||||
ExportRequestStatus::Completed => 'success',
|
||||
}),
|
||||
TextEntry::make('created_at')
|
||||
->label('Requested at')
|
||||
->dateTime()
|
||||
->icon('heroicon-o-calendar'),
|
||||
TextEntry::make('completed_at')
|
||||
->label('Completed at')
|
||||
->dateTime()
|
||||
->placeholder('Not generated yet')
|
||||
->icon('heroicon-o-check-circle')
|
||||
->color(fn (DataExportRequest $record) => $record->completed_at ? 'success' : 'gray'),
|
||||
TextEntry::make('file_path')
|
||||
->label('File')
|
||||
// Just the filename, not the full server path — a raw
|
||||
// filesystem path (/var/www/.../export_2_....zip) isn't
|
||||
// actionable for staff and previously rendered as if it
|
||||
// were a clickable link. The actual download is the
|
||||
// "Download" header action below (self::downloadAction()),
|
||||
// shared with the table's row action.
|
||||
->state(fn (DataExportRequest $record) => $record->file_path ? basename($record->file_path) : 'Not generated yet')
|
||||
->icon('heroicon-o-document')
|
||||
->color(fn (DataExportRequest $record) => $record->file_path ? 'success' : 'gray'),
|
||||
]),
|
||||
]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Shared by the table's row action and the view page's header action
|
||||
* (ViewDataExportRequest::getHeaderActions()) so "is this downloadable"
|
||||
* and the download itself are defined in exactly one place.
|
||||
*/
|
||||
public static function downloadAction(): Action
|
||||
{
|
||||
return Action::make('download')
|
||||
->label('Download')
|
||||
->icon('heroicon-o-arrow-down-tray')
|
||||
->visible(fn (DataExportRequest $record) => $record->status === ExportRequestStatus::Completed && $record->file_path && file_exists($record->file_path))
|
||||
->action(fn (DataExportRequest $record) => response()->download($record->file_path));
|
||||
}
|
||||
|
||||
public static function table(Table $table): Table
|
||||
{
|
||||
return $table
|
||||
->columns([
|
||||
TextColumn::make('id')
|
||||
->label('#')
|
||||
->sortable(),
|
||||
TextColumn::make('subject_type')
|
||||
->label('Scope')
|
||||
->formatStateUsing(fn (DataExportRequest $record) => $record->isForCustomer() ? 'Customer' : 'User')
|
||||
->badge()
|
||||
->color(fn (DataExportRequest $record) => $record->isForCustomer() ? 'info' : 'warning'),
|
||||
TextColumn::make('subject')
|
||||
->label('Subject')
|
||||
->state(fn (DataExportRequest $record) => DataErasureRequest::displayNameFor($record->subject))
|
||||
->searchable(query: fn ($query, string $search) => $query->where('email', 'like', "%{$search}%")),
|
||||
TextColumn::make('status')
|
||||
->badge()
|
||||
->formatStateUsing(fn (ExportRequestStatus $state) => ucfirst($state->value))
|
||||
->color(fn (ExportRequestStatus $state) => match ($state) {
|
||||
ExportRequestStatus::Pending => 'warning',
|
||||
ExportRequestStatus::Failed => 'danger',
|
||||
ExportRequestStatus::Completed => 'success',
|
||||
}),
|
||||
TextColumn::make('created_at')
|
||||
->label('Requested at')
|
||||
->dateTime()
|
||||
->sortable(),
|
||||
TextColumn::make('completed_at')
|
||||
->label('Completed at')
|
||||
->dateTime()
|
||||
->sortable()
|
||||
->toggleable(isToggledHiddenByDefault: true),
|
||||
])
|
||||
->defaultSort('created_at', 'desc')
|
||||
->filters([
|
||||
SelectFilter::make('status')
|
||||
->options([
|
||||
ExportRequestStatus::Pending->value => 'Pending',
|
||||
ExportRequestStatus::Completed->value => 'Completed',
|
||||
ExportRequestStatus::Failed->value => 'Failed',
|
||||
]),
|
||||
])
|
||||
->recordActions([
|
||||
ViewAction::make(),
|
||||
self::downloadAction(),
|
||||
]);
|
||||
}
|
||||
|
||||
public static function getPages(): array
|
||||
{
|
||||
return [
|
||||
'index' => ListDataExportRequests::route('/'),
|
||||
'view' => ViewDataExportRequest::route('/{record}'),
|
||||
];
|
||||
}
|
||||
|
||||
public static function canCreate(): bool
|
||||
{
|
||||
return false;
|
||||
}
|
||||
}
|
||||
+11
@@ -0,0 +1,11 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Privacy\Filament\Resources\DataExportRequestResource\Pages;
|
||||
|
||||
use Filament\Resources\Pages\ListRecords;
|
||||
use Modules\Core\Privacy\Filament\Resources\DataExportRequestResource;
|
||||
|
||||
class ListDataExportRequests extends ListRecords
|
||||
{
|
||||
protected static string $resource = DataExportRequestResource::class;
|
||||
}
|
||||
+18
@@ -0,0 +1,18 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Privacy\Filament\Resources\DataExportRequestResource\Pages;
|
||||
|
||||
use Filament\Resources\Pages\ViewRecord;
|
||||
use Modules\Core\Privacy\Filament\Resources\DataExportRequestResource;
|
||||
|
||||
class ViewDataExportRequest extends ViewRecord
|
||||
{
|
||||
protected static string $resource = DataExportRequestResource::class;
|
||||
|
||||
protected function getHeaderActions(): array
|
||||
{
|
||||
return [
|
||||
DataExportRequestResource::downloadAction(),
|
||||
];
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,36 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Privacy\Jobs;
|
||||
|
||||
use Illuminate\Bus\Queueable;
|
||||
use Illuminate\Contracts\Queue\ShouldQueue;
|
||||
use Illuminate\Foundation\Bus\Dispatchable;
|
||||
use Illuminate\Queue\InteractsWithQueue;
|
||||
use Illuminate\Queue\SerializesModels;
|
||||
use Modules\Core\Privacy\Models\DataErasureRequest;
|
||||
use Modules\Core\Privacy\Services\PrivacyService;
|
||||
|
||||
/**
|
||||
* Runs PrivacyService::completeErasure() for one due DataErasureRequest, dispatched
|
||||
* per-request by ProcessErasureRequestsCommand rather than looping over
|
||||
* completeErasure() calls inline in the command. One job per request means one
|
||||
* request's failure (a provider throwing, a DB error) doesn't block or crash
|
||||
* processing of the others, and Laravel's normal per-job retry/failure handling
|
||||
* applies to each request independently.
|
||||
*/
|
||||
class EraseDataSubjectJob implements ShouldQueue
|
||||
{
|
||||
use Dispatchable;
|
||||
use InteractsWithQueue;
|
||||
use Queueable;
|
||||
use SerializesModels;
|
||||
|
||||
public function __construct(
|
||||
public readonly DataErasureRequest $request,
|
||||
) {}
|
||||
|
||||
public function handle(PrivacyService $privacyService): void
|
||||
{
|
||||
$privacyService->completeErasure($this->request);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,102 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Privacy\Jobs;
|
||||
|
||||
use Throwable;
|
||||
use Illuminate\Bus\Queueable;
|
||||
use Illuminate\Contracts\Queue\ShouldQueue;
|
||||
use Illuminate\Foundation\Bus\Dispatchable;
|
||||
use Illuminate\Queue\InteractsWithQueue;
|
||||
use Illuminate\Queue\SerializesModels;
|
||||
use Illuminate\Support\Facades\Event;
|
||||
use Illuminate\Support\Facades\Log;
|
||||
use Modules\Core\Privacy\Contracts\PersonalDataProvider;
|
||||
use Modules\Core\Privacy\DTOs\CustomerSubject;
|
||||
use Modules\Core\Privacy\Events\PersonalDataGathered;
|
||||
use Modules\Core\Privacy\DTOs\ExportReport;
|
||||
use Modules\Core\Privacy\DTOs\ProviderExportResult;
|
||||
use Modules\Core\Privacy\Enums\ExportRequestStatus;
|
||||
use Modules\Core\Privacy\Models\DataExportRequest;
|
||||
use Modules\Core\Privacy\Services\PrivacyManager;
|
||||
use Modules\Core\Privacy\DTOs\UserSubject;
|
||||
|
||||
/**
|
||||
* Gathers every registered PersonalDataProvider's export data for one request, all
|
||||
* sequentially in this single job — deliberately not fanned out into one job per
|
||||
* provider. Per-subject export work is small (a handful of indexed queries per
|
||||
* provider), so there's no real parallelism win, and one job means "finished" is
|
||||
* just "handle() returned," with no Bus::batch()/completion-counting needed. If a
|
||||
* future provider ever does something genuinely slow (an external API call, a
|
||||
* generated PDF), that's the point to reconsider — not before.
|
||||
*
|
||||
* Calls each provider's *ForCustomer() or *ForUser() method depending on the
|
||||
* request's polymorphic subject — see Modules\Core\Privacy\Services\PrivacyService and
|
||||
* docs/privacy.md "User-scope vs Customer-scope".
|
||||
*
|
||||
* Writing the gathered data to a file is intentionally NOT done here — see
|
||||
* PersonalDataGathered and Modules\Core\Privacy\Listeners\WriteExportToCsvListener,
|
||||
* which keeps the export *format* swappable without touching how data is gathered.
|
||||
*/
|
||||
class ExportDataSubjectJob implements ShouldQueue
|
||||
{
|
||||
use Dispatchable;
|
||||
use InteractsWithQueue;
|
||||
use Queueable;
|
||||
use SerializesModels;
|
||||
|
||||
public function __construct(
|
||||
public readonly DataExportRequest $request,
|
||||
) {}
|
||||
|
||||
public function handle(PrivacyManager $manager): void
|
||||
{
|
||||
if ($this->request->isForCustomer()) {
|
||||
$subject = new CustomerSubject(customerId: $this->request->subject_id);
|
||||
$results = array_map(
|
||||
fn (PersonalDataProvider $provider) => $this->safeExport($provider, 'exportForCustomer', $subject),
|
||||
$manager->providers()
|
||||
);
|
||||
} else {
|
||||
$subject = new UserSubject(userId: $this->request->subject_id, email: $this->request->email);
|
||||
$results = array_map(
|
||||
fn (PersonalDataProvider $provider) => $this->safeExport($provider, 'exportForUser', $subject),
|
||||
$manager->providers()
|
||||
);
|
||||
}
|
||||
|
||||
Event::dispatch(new PersonalDataGathered(
|
||||
$this->request,
|
||||
new ExportReport($subject, $results)
|
||||
));
|
||||
}
|
||||
|
||||
public function failed(Throwable $exception): void
|
||||
{
|
||||
$this->request->update(['status' => ExportRequestStatus::Failed]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Catches per-provider so one provider throwing doesn't discard every
|
||||
* other provider's already-gathered export data for this same request —
|
||||
* without this, the whole array_map aborts, handle() never reaches
|
||||
* Event::dispatch(), and failed() marks the ENTIRE request Failed even
|
||||
* though most providers may have already gathered their data
|
||||
* successfully. Logged via Log::error() so a thrown provider is still
|
||||
* visible to staff, not just an empty/missing section in the export.
|
||||
*
|
||||
* @param 'exportForCustomer'|'exportForUser' $method
|
||||
*/
|
||||
private function safeExport(PersonalDataProvider $provider, string $method, CustomerSubject|UserSubject $subject): ProviderExportResult
|
||||
{
|
||||
try {
|
||||
return $provider->{$method}($subject);
|
||||
} catch (Throwable $e) {
|
||||
Log::error("Privacy provider {$provider->name()}::{$method}() threw during export", [
|
||||
'provider' => $provider->name(),
|
||||
'exception' => $e,
|
||||
]);
|
||||
|
||||
return new ProviderExportResult($provider->name(), [], $e->getMessage());
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,61 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Privacy\Listeners;
|
||||
|
||||
use Illuminate\Contracts\Queue\ShouldQueue;
|
||||
use Modules\Core\Auth\Events\UserAuthenticated;
|
||||
use Modules\Core\Privacy\Enums\ErasureRequestStatus;
|
||||
use Modules\Core\Privacy\Models\DataErasureRequest;
|
||||
use Modules\Core\Privacy\Services\PrivacyService;
|
||||
|
||||
/**
|
||||
* Logging back in during a pending erasure request's grace period IS the "I
|
||||
* changed my mind" action (same pattern as Shopify's own account-deletion flow).
|
||||
* Authentication itself is never blocked by deactivation — the OTP check in
|
||||
* UserOtpService::validate() already passed by the time this fires — only what
|
||||
* happens to the account afterward: any pending request is cancelled and the
|
||||
* login block lifted (see PrivacyService::cancelErasure()).
|
||||
*
|
||||
* Only checks this User's own erasure request, not any Customer-scoped one
|
||||
* directly — a Customer-scoped erasure never deactivates a User's login at all
|
||||
* (see docs/privacy.md "User-scope vs Customer-scope"), so there is nothing for a
|
||||
* login to reactivate on that side. Only a User-scoped request (keyed on this
|
||||
* User's own id) can have deactivated this login in the first place.
|
||||
*
|
||||
* If cancelling that request undoes it, this also reverts every Customer
|
||||
* erasure request it caused (via Modules\Core\Privacy\Listeners\
|
||||
* CascadeCustomerErasureListener — see DataErasureRequest::caused()). Those are
|
||||
* traced by caused_by_request_id specifically so only the cascade THIS User's
|
||||
* own request triggered is reverted, never an unrelated, independently-requested
|
||||
* Customer erasure the User happens to be linked to.
|
||||
*
|
||||
* Queued (ShouldQueue) — login should return to the browser quickly, without
|
||||
* waiting on this bookkeeping. Nothing else in this codebase currently reads
|
||||
* deactivated_at except this listener and PrivacyService itself (grep before
|
||||
* assuming otherwise, if that ever changes) — UserOtpService::validate() never
|
||||
* gates the login on it — so a brief window between the login response and this
|
||||
* job actually running has no other consumer to observe it as stale.
|
||||
*/
|
||||
class CancelErasureOnLoginListener implements ShouldQueue
|
||||
{
|
||||
public function __construct(private readonly PrivacyService $privacyService) {}
|
||||
|
||||
public function handle(UserAuthenticated $event): void
|
||||
{
|
||||
$request = DataErasureRequest::where('subject_type', $event->user->getMorphClass())
|
||||
->where('subject_id', $event->user->id)
|
||||
->where('status', ErasureRequestStatus::Pending)
|
||||
->latest()
|
||||
->first();
|
||||
|
||||
if (! $request) {
|
||||
return;
|
||||
}
|
||||
|
||||
$this->privacyService->cancelErasure($request);
|
||||
|
||||
foreach ($request->caused as $causedRequest) {
|
||||
$this->privacyService->cancelErasure($causedRequest);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,64 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Privacy\Listeners;
|
||||
|
||||
use Illuminate\Contracts\Auth\Authenticatable;
|
||||
use Illuminate\Contracts\Queue\ShouldQueue;
|
||||
use Lunar\Base\LunarUser;
|
||||
use Lunar\Models\Customer;
|
||||
use Modules\Core\Privacy\Events\UserErasureRequested;
|
||||
use Modules\Core\Privacy\Services\PrivacyService;
|
||||
|
||||
/**
|
||||
* When a User's erasure leaves a Customer account with no remaining User at all,
|
||||
* that Customer's PII (name, addresses, order history) becomes permanently
|
||||
* unreachable through any login — GDPR data minimization (Art. 5(1)(c)) means it
|
||||
* shouldn't just sit there. This listener checks every Customer the User is
|
||||
* linked to: if this User is currently the SOLE user on that Customer (count ===
|
||||
* 1 and that one user is this user — not just count === 1, in case of a
|
||||
* stale/unexpected read), it also opens a grace-period Customer erasure request
|
||||
* for that Customer, tagged via caused_by_request_id so
|
||||
* CancelErasureOnLoginListener can revert exactly this cascade — and only this
|
||||
* cascade — if the User logs back in and changes their mind.
|
||||
*
|
||||
* Queued (ShouldQueue), not synchronous — this runs as an independent,
|
||||
* separately-retryable unit of work rather than inline inside
|
||||
* PrivacyService::requestErasureForUser(), so a failure here never rolls back or
|
||||
* blocks the User's own request. Because Eloquent models on a queued event are
|
||||
* re-fetched fresh when the job actually runs (not a stale snapshot from dispatch
|
||||
* time — see Illuminate\Queue\SerializesModels), $event->request->subject and its
|
||||
* ->customers reflect the real, current state at execution time. That matters
|
||||
* specifically for the immediate-erasure path (requestImmediateErasureForUser()):
|
||||
* this job may run before or after completeErasure() detaches the User's
|
||||
* memberships — if the detach happens first, ->customers is simply empty by the
|
||||
* time this runs and nothing cascades, which is an accepted, understood race for
|
||||
* that rare staff-triggered path (see docs/privacy.md). The everyday grace-period
|
||||
* path (requestErasureForUser()) has no such race, since nothing detaches the
|
||||
* User's memberships until its own later, separate completeErasure() run.
|
||||
*
|
||||
* Both requests then run through their own independent grace periods.
|
||||
*/
|
||||
class CascadeCustomerErasureListener implements ShouldQueue
|
||||
{
|
||||
public function __construct(private readonly PrivacyService $privacyService) {}
|
||||
|
||||
public function handle(UserErasureRequested $event): void
|
||||
{
|
||||
$user = $event->request->subject;
|
||||
|
||||
if (! $user) {
|
||||
return;
|
||||
}
|
||||
|
||||
foreach ($user->customers as $customer) {
|
||||
if ($this->isSoleUser($customer, $user)) {
|
||||
$this->privacyService->requestErasureForCustomer($customer, $user, causedByRequestId: $event->request->id);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private function isSoleUser(Customer $customer, Authenticatable&LunarUser $user): bool
|
||||
{
|
||||
return $customer->users->count() === 1 && $customer->users->first()->id === $user->id;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,94 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Privacy\Listeners;
|
||||
|
||||
use Illuminate\Support\Facades\Event;
|
||||
use Illuminate\Support\Facades\Storage;
|
||||
use Modules\Core\Export\CsvColumn;
|
||||
use Modules\Core\Export\CsvWriter;
|
||||
use Modules\Core\Privacy\Events\PersonalDataExportFileWritten;
|
||||
use Modules\Core\Privacy\Events\PersonalDataGathered;
|
||||
use Modules\Core\Privacy\Enums\ExportRequestStatus;
|
||||
use ZipArchive;
|
||||
|
||||
/**
|
||||
* Turns a PersonalDataGathered event's ExportReport into one CSV per
|
||||
* provider, zipped together, using the generic Modules\Core\Export\CsvWriter — kept
|
||||
* as its own listener (not inline in ExportDataSubjectJob) so the export *format*
|
||||
* is swappable (e.g. an app could unregister this and register its own JSON-only
|
||||
* listener) without touching how the data is gathered.
|
||||
*
|
||||
* Column schema: every provider's data is either a list of associative arrays
|
||||
* (rows directly) or a single associative array (one row) — see the providers
|
||||
* registered in config('core.privacy.providers'), each living in its own owning
|
||||
* module's Privacy/ subdirectory (e.g. Modules\Core\Order\Privacy\
|
||||
* OrderDataProvider), all of which return exactly one of those two shapes. Any
|
||||
* nested array value within a row (e.g. an order's `addresses`) is
|
||||
* JSON-encoded into that one cell rather than exploded into further columns —
|
||||
* CsvWriter's generic stringify() behavior, not special-cased here.
|
||||
*/
|
||||
class WriteExportToCsvListener
|
||||
{
|
||||
public function __construct(private readonly CsvWriter $writer) {}
|
||||
|
||||
public function handle(PersonalDataGathered $event): void
|
||||
{
|
||||
$disk = Storage::disk('local');
|
||||
$exportDir = $disk->path('exports/privacy');
|
||||
|
||||
if (! is_dir($exportDir)) {
|
||||
mkdir($exportDir, 0755, true);
|
||||
}
|
||||
|
||||
$stamp = now()->format('Y_m_d_His');
|
||||
$zipPath = "{$exportDir}/export_{$event->request->id}_{$stamp}.zip";
|
||||
|
||||
$zip = new ZipArchive;
|
||||
$zip->open($zipPath, ZipArchive::CREATE | ZipArchive::OVERWRITE);
|
||||
|
||||
foreach ($event->report->results as $result) {
|
||||
$csvPath = "{$exportDir}/{$result->provider}_{$stamp}.csv";
|
||||
|
||||
$this->writer->write($this->columnsFor($result->data), $this->rowsFor($result->data), $csvPath);
|
||||
|
||||
$zip->addFile($csvPath, "{$result->provider}.csv");
|
||||
}
|
||||
|
||||
$zip->close();
|
||||
|
||||
foreach ($event->report->results as $result) {
|
||||
@unlink("{$exportDir}/{$result->provider}_{$stamp}.csv");
|
||||
}
|
||||
|
||||
$event->request->update([
|
||||
'status' => ExportRequestStatus::Completed,
|
||||
'file_path' => $zipPath,
|
||||
'completed_at' => now(),
|
||||
]);
|
||||
|
||||
Event::dispatch(new PersonalDataExportFileWritten($event->request));
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array<int, mixed>
|
||||
*/
|
||||
private function rowsFor(array $data): array
|
||||
{
|
||||
// A list of records (addresses, orders, reviews) -> those are the rows.
|
||||
// A single associative record (customer) -> one row.
|
||||
return array_is_list($data) ? $data : [$data];
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array<int, CsvColumn>
|
||||
*/
|
||||
private function columnsFor(array $data): array
|
||||
{
|
||||
$sample = array_is_list($data) ? ($data[0] ?? []) : $data;
|
||||
|
||||
return array_map(
|
||||
fn (string $key) => new CsvColumn($key, fn (array $row) => $row[$key] ?? null),
|
||||
array_keys($sample)
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,104 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Privacy\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
use Illuminate\Database\Eloquent\Relations\BelongsTo;
|
||||
use Illuminate\Database\Eloquent\Relations\HasMany;
|
||||
use Illuminate\Database\Eloquent\Relations\MorphTo;
|
||||
use Lunar\Models\Customer;
|
||||
use Modules\Core\Privacy\Enums\ErasureRequestStatus;
|
||||
|
||||
/**
|
||||
* A pending, cancelled, or completed right-of-erasure request — the grace-period
|
||||
* record between "subject/staff asked for this" and "providers actually erased
|
||||
* their data" (see Modules\Core\Privacy\Services\PrivacyService, which creates/processes
|
||||
* these).
|
||||
*
|
||||
* `subject` is polymorphic — either a Lunar Customer (business account) or a User
|
||||
* (individual), never both. See docs/privacy.md "User-scope vs Customer-scope" for
|
||||
* why these are two genuinely different operations with different blast radii,
|
||||
* not one "erase this customer and cascade to their users" flow.
|
||||
*
|
||||
* `requestedBy` is separately polymorphic (the subject themselves, self-service,
|
||||
* or Staff acting on their behalf), stored as plain type+id columns rather than
|
||||
* morphs() since it's always exactly one of those two concrete actor types.
|
||||
*/
|
||||
class DataErasureRequest extends Model
|
||||
{
|
||||
protected $guarded = [];
|
||||
|
||||
protected $casts = [
|
||||
'status' => ErasureRequestStatus::class,
|
||||
'scheduled_for' => 'datetime',
|
||||
'cancelled_at' => 'datetime',
|
||||
'completed_at' => 'datetime',
|
||||
'report' => 'array',
|
||||
];
|
||||
|
||||
public function subject(): MorphTo
|
||||
{
|
||||
return $this->morphTo(__FUNCTION__, 'subject_type', 'subject_id');
|
||||
}
|
||||
|
||||
public function requestedBy(): MorphTo
|
||||
{
|
||||
return $this->morphTo(__FUNCTION__, 'requested_by_type', 'requested_by_id');
|
||||
}
|
||||
|
||||
/**
|
||||
* The User erasure request that caused this one to be auto-created, if any —
|
||||
* see Modules\Core\Privacy\Listeners\CascadeCustomerErasureListener.
|
||||
*/
|
||||
public function causedBy(): BelongsTo
|
||||
{
|
||||
return $this->belongsTo(self::class, 'caused_by_request_id');
|
||||
}
|
||||
|
||||
/**
|
||||
* Every Customer erasure request THIS request caused (see causedBy()) —
|
||||
* used by CancelErasureOnLoginListener to revert exactly the cascade this
|
||||
* User's own cancellation should undo.
|
||||
*/
|
||||
public function caused(): HasMany
|
||||
{
|
||||
return $this->hasMany(self::class, 'caused_by_request_id');
|
||||
}
|
||||
|
||||
public function isForCustomer(): bool
|
||||
{
|
||||
return $this->subject_type === (new Customer)->getMorphClass();
|
||||
}
|
||||
|
||||
public function isPending(): bool
|
||||
{
|
||||
return $this->status === ErasureRequestStatus::Pending;
|
||||
}
|
||||
|
||||
public function isDue(): bool
|
||||
{
|
||||
return $this->isPending() && $this->scheduled_for->isPast();
|
||||
}
|
||||
|
||||
/**
|
||||
* A human-readable label for whichever record `$morphable` resolves to
|
||||
* (Customer, User, or Staff — the three concrete types that appear across
|
||||
* subject/requestedBy), since each uses a different name field and there's
|
||||
* no shared interface for it. Falls back to "#id" if the record is gone
|
||||
* (e.g. a Customer erased since this request completed) or the relation is
|
||||
* simply empty.
|
||||
*/
|
||||
public static function displayNameFor(mixed $morphable): string
|
||||
{
|
||||
if (! $morphable) {
|
||||
return '—';
|
||||
}
|
||||
|
||||
return match (true) {
|
||||
isset($morphable->full_name) => $morphable->full_name,
|
||||
isset($morphable->name) => $morphable->name,
|
||||
isset($morphable->first_name) => trim("{$morphable->first_name} {$morphable->last_name}"),
|
||||
default => "#{$morphable->getKey()}",
|
||||
};
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,37 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Privacy\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
use Illuminate\Database\Eloquent\Relations\MorphTo;
|
||||
use Lunar\Models\Customer;
|
||||
use Modules\Core\Privacy\Enums\ExportRequestStatus;
|
||||
|
||||
/**
|
||||
* A right-of-access export request. Created synchronously (fast — one insert), then
|
||||
* ExportDataSubjectJob (queued) does the actual work of gathering every registered
|
||||
* provider's data and, via Modules\Core\Privacy\Listeners\WriteExportToCsvListener,
|
||||
* writing it to a file. file_path is null until that completes.
|
||||
*
|
||||
* `subject` is polymorphic — either a Lunar Customer (business account) or a User
|
||||
* (individual), never both. See docs/privacy.md "User-scope vs Customer-scope".
|
||||
*/
|
||||
class DataExportRequest extends Model
|
||||
{
|
||||
protected $guarded = [];
|
||||
|
||||
protected $casts = [
|
||||
'status' => ExportRequestStatus::class,
|
||||
'completed_at' => 'datetime',
|
||||
];
|
||||
|
||||
public function subject(): MorphTo
|
||||
{
|
||||
return $this->morphTo(__FUNCTION__, 'subject_type', 'subject_id');
|
||||
}
|
||||
|
||||
public function isForCustomer(): bool
|
||||
{
|
||||
return $this->subject_type === (new Customer)->getMorphClass();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,80 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Privacy\RelationManagers;
|
||||
|
||||
use Filament\Actions\ViewAction;
|
||||
use Filament\Actions\Action;
|
||||
use Filament\Resources\RelationManagers\RelationManager;
|
||||
use Filament\Tables\Columns\TextColumn;
|
||||
use Filament\Tables\Filters\SelectFilter;
|
||||
use Filament\Tables\Table;
|
||||
use Modules\Core\Privacy\Enums\ErasureRequestStatus;
|
||||
use Modules\Core\Privacy\Filament\Resources\DataErasureRequestResource;
|
||||
use Modules\Core\Privacy\Models\DataErasureRequest;
|
||||
use Modules\Core\Privacy\Services\PrivacyService;
|
||||
|
||||
/**
|
||||
* Lists erasure requests where the record being viewed (Customer or User) is the
|
||||
* subject — scoped via the Customer::erasureRequests()/{User}::erasureRequests()
|
||||
* morphMany macros registered in CorePlugin. Read-mostly, same as
|
||||
* DataErasureRequestResource itself — no create here either, requests are opened
|
||||
* via PrivacyService (see CustomerErasureActionsExtension for the Customer-page
|
||||
* entry point).
|
||||
*/
|
||||
class ErasureRequestsRelationManager extends RelationManager
|
||||
{
|
||||
protected static string $relationship = 'erasureRequests';
|
||||
|
||||
protected static ?string $title = 'Erasure Requests';
|
||||
|
||||
public function table(Table $table): Table
|
||||
{
|
||||
return $table
|
||||
->recordTitleAttribute('id')
|
||||
->columns([
|
||||
TextColumn::make('id')
|
||||
->label('#'),
|
||||
TextColumn::make('status')
|
||||
->badge()
|
||||
->formatStateUsing(fn (ErasureRequestStatus $state) => ucfirst($state->value))
|
||||
->color(fn (ErasureRequestStatus $state) => match ($state) {
|
||||
ErasureRequestStatus::Pending => 'warning',
|
||||
ErasureRequestStatus::Cancelled => 'gray',
|
||||
ErasureRequestStatus::Completed => 'success',
|
||||
}),
|
||||
TextColumn::make('requestedBy')
|
||||
->label('Requested by')
|
||||
->state(fn (DataErasureRequest $record) => DataErasureRequest::displayNameFor($record->requestedBy)),
|
||||
TextColumn::make('scheduled_for')
|
||||
->label('Scheduled for')
|
||||
->dateTime(),
|
||||
TextColumn::make('caused_by_request_id')
|
||||
->label('Cascade')
|
||||
->formatStateUsing(fn (?int $state) => $state ? "from #{$state}" : '—'),
|
||||
TextColumn::make('created_at')
|
||||
->label('Requested at')
|
||||
->dateTime(),
|
||||
])
|
||||
->defaultSort('created_at', 'desc')
|
||||
->filters([
|
||||
SelectFilter::make('status')
|
||||
->options([
|
||||
ErasureRequestStatus::Pending->value => 'Pending',
|
||||
ErasureRequestStatus::Cancelled->value => 'Cancelled',
|
||||
ErasureRequestStatus::Completed->value => 'Completed',
|
||||
]),
|
||||
])
|
||||
->headerActions([])
|
||||
->recordActions([
|
||||
ViewAction::make()
|
||||
->url(fn (DataErasureRequest $record) => DataErasureRequestResource::getUrl('view', ['record' => $record])),
|
||||
Action::make('cancel')
|
||||
->label('Cancel')
|
||||
->icon('heroicon-o-x-circle')
|
||||
->color('danger')
|
||||
->requiresConfirmation()
|
||||
->visible(fn (DataErasureRequest $record) => $record->isPending())
|
||||
->action(fn (DataErasureRequest $record, PrivacyService $privacyService) => $privacyService->cancelErasure($record)),
|
||||
]);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,69 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Privacy\RelationManagers;
|
||||
|
||||
use Filament\Actions\ViewAction;
|
||||
use Filament\Actions\Action;
|
||||
use Filament\Resources\RelationManagers\RelationManager;
|
||||
use Filament\Tables\Columns\TextColumn;
|
||||
use Filament\Tables\Filters\SelectFilter;
|
||||
use Filament\Tables\Table;
|
||||
use Modules\Core\Privacy\Enums\ExportRequestStatus;
|
||||
use Modules\Core\Privacy\Filament\Resources\DataExportRequestResource;
|
||||
use Modules\Core\Privacy\Models\DataExportRequest;
|
||||
|
||||
/**
|
||||
* Lists export requests where the record being viewed (Customer or User) is the
|
||||
* subject — scoped via the Customer::exportRequests()/{User}::exportRequests()
|
||||
* morphMany macros registered in CorePlugin. See
|
||||
* ErasureRequestsRelationManager for the erasure-side equivalent.
|
||||
*/
|
||||
class ExportRequestsRelationManager extends RelationManager
|
||||
{
|
||||
protected static string $relationship = 'exportRequests';
|
||||
|
||||
protected static ?string $title = 'Export Requests';
|
||||
|
||||
public function table(Table $table): Table
|
||||
{
|
||||
return $table
|
||||
->recordTitleAttribute('id')
|
||||
->columns([
|
||||
TextColumn::make('id')
|
||||
->label('#'),
|
||||
TextColumn::make('status')
|
||||
->badge()
|
||||
->formatStateUsing(fn (ExportRequestStatus $state) => ucfirst($state->value))
|
||||
->color(fn (ExportRequestStatus $state) => match ($state) {
|
||||
ExportRequestStatus::Pending => 'warning',
|
||||
ExportRequestStatus::Failed => 'danger',
|
||||
ExportRequestStatus::Completed => 'success',
|
||||
}),
|
||||
TextColumn::make('created_at')
|
||||
->label('Requested at')
|
||||
->dateTime(),
|
||||
TextColumn::make('completed_at')
|
||||
->label('Completed at')
|
||||
->dateTime(),
|
||||
])
|
||||
->defaultSort('created_at', 'desc')
|
||||
->filters([
|
||||
SelectFilter::make('status')
|
||||
->options([
|
||||
ExportRequestStatus::Pending->value => 'Pending',
|
||||
ExportRequestStatus::Completed->value => 'Completed',
|
||||
ExportRequestStatus::Failed->value => 'Failed',
|
||||
]),
|
||||
])
|
||||
->headerActions([])
|
||||
->recordActions([
|
||||
ViewAction::make()
|
||||
->url(fn (DataExportRequest $record) => DataExportRequestResource::getUrl('view', ['record' => $record])),
|
||||
Action::make('download')
|
||||
->label('Download')
|
||||
->icon('heroicon-o-arrow-down-tray')
|
||||
->visible(fn (DataExportRequest $record) => $record->status === ExportRequestStatus::Completed && $record->file_path && file_exists($record->file_path))
|
||||
->action(fn (DataExportRequest $record) => response()->download($record->file_path)),
|
||||
]);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,112 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Privacy\RelationManagers;
|
||||
|
||||
use Filament\Actions\Action;
|
||||
use Filament\Forms\Components\Checkbox;
|
||||
use Filament\Infolists\Components\RepeatableEntry;
|
||||
use Filament\Infolists\Components\TextEntry;
|
||||
use Filament\Notifications\Notification;
|
||||
use Filament\Tables\Table;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
use Modules\Core\Customer\RelationManagers\UserRelationManager as CoreUserRelationManager;
|
||||
use Modules\Core\Privacy\Models\DataErasureRequest;
|
||||
use Modules\Core\Privacy\Services\PrivacyService;
|
||||
|
||||
/**
|
||||
* Extends core's own Customer -> User relation manager to add:
|
||||
* - a "Privacy Requests" row action, since a User's erasure/export requests
|
||||
* can't be shown as a nested relation manager two levels deep (Customer ->
|
||||
* User -> Requests isn't a shape Filament relation managers support) — a
|
||||
* modal listing that specific User's requests is the practical alternative.
|
||||
* - a "Request Erasure" row action — the User-scoped panel entry point,
|
||||
* mirroring Modules\Core\Privacy\Filament\Extensions\
|
||||
* CustomerErasureActionsExtension on the Customer side, including the same
|
||||
* "erase immediately" checkbox for a staff-triggered urgent request.
|
||||
* See docs/privacy.md "User-scope vs Customer-scope".
|
||||
*/
|
||||
class UserRelationManager extends CoreUserRelationManager
|
||||
{
|
||||
public function getDefaultTable(Table $table): Table
|
||||
{
|
||||
$table = parent::getDefaultTable($table);
|
||||
|
||||
return $table->recordActions([
|
||||
...$table->getActions(),
|
||||
Action::make('privacyRequests')
|
||||
->label('Privacy Requests')
|
||||
->icon('heroicon-o-shield-exclamation')
|
||||
->modalHeading(fn (Model $record) => "Privacy requests for {$record->name}")
|
||||
->modalSubmitAction(false)
|
||||
->modalCancelActionLabel('Close')
|
||||
->schema(fn (Model $record) => $this->requestsInfolist($record)),
|
||||
Action::make('requestErasure')
|
||||
->label('Request Erasure')
|
||||
->icon('heroicon-o-shield-exclamation')
|
||||
->color('danger')
|
||||
->requiresConfirmation()
|
||||
->modalDescription('Opens a cancellable grace-period erasure request for this individual — deactivates their login and detaches them from every linked Customer account once it completes. No Customer account\'s own data is affected.')
|
||||
->schema([
|
||||
Checkbox::make('immediate')
|
||||
->label('Erase immediately (skip the 30-day grace period)')
|
||||
->helperText('Staff-only, for a formal legal request or regulator inquiry that genuinely requires urgency — not a routine deletion. Runs synchronously, cannot be cancelled once submitted.')
|
||||
->default(false),
|
||||
])
|
||||
->action(function (Model $record, array $data) {
|
||||
$privacyService = app(PrivacyService::class);
|
||||
$staff = auth('staff')->user();
|
||||
|
||||
if ($data['immediate']) {
|
||||
$privacyService->requestImmediateErasureForUser($record, $staff);
|
||||
|
||||
Notification::make()
|
||||
->title('User erased')
|
||||
->body('Erasure ran immediately — see the Erasure Requests list for the outcome.')
|
||||
->success()
|
||||
->send();
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
$privacyService->requestErasureForUser($record, $staff);
|
||||
|
||||
Notification::make()
|
||||
->title('Erasure requested')
|
||||
->body('The grace period starts now, and this user\'s login is deactivated immediately — see the Erasure Requests list.')
|
||||
->success()
|
||||
->send();
|
||||
}),
|
||||
]);
|
||||
}
|
||||
|
||||
private function requestsInfolist(Model $record): array
|
||||
{
|
||||
return [
|
||||
TextEntry::make('erasure_heading')
|
||||
->label('')
|
||||
->state('Erasure Requests'),
|
||||
RepeatableEntry::make('erasureRequests')
|
||||
->label('')
|
||||
->state(fn () => $record->erasureRequests()->latest()->get())
|
||||
->schema([
|
||||
TextEntry::make('status')->formatStateUsing(fn ($state) => ucfirst($state->value)),
|
||||
TextEntry::make('scheduled_for')->dateTime(),
|
||||
TextEntry::make('requestedBy')->label('Requested by')->state(
|
||||
fn (DataErasureRequest $record) => DataErasureRequest::displayNameFor($record->requestedBy)
|
||||
),
|
||||
])
|
||||
->columns(3),
|
||||
TextEntry::make('export_heading')
|
||||
->label('')
|
||||
->state('Export Requests'),
|
||||
RepeatableEntry::make('exportRequests')
|
||||
->label('')
|
||||
->state(fn () => $record->exportRequests()->latest()->get())
|
||||
->schema([
|
||||
TextEntry::make('status')->formatStateUsing(fn ($state) => ucfirst($state->value)),
|
||||
TextEntry::make('created_at')->label('Requested at')->dateTime(),
|
||||
])
|
||||
->columns(2),
|
||||
];
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,51 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Privacy\Services;
|
||||
|
||||
use LogicException;
|
||||
use Illuminate\Contracts\Container\Container;
|
||||
use Modules\Core\Privacy\Contracts\PersonalDataProvider;
|
||||
|
||||
/**
|
||||
* The registry every PersonalDataProvider is collected through. A module registers
|
||||
* by adding its provider's class name to config('core.privacy.providers') — the
|
||||
* same shape as Lunar's own config('lunar.search.indexers') model->indexer map, just
|
||||
* a plain list since a provider isn't keyed to one model. Core never references a
|
||||
* specific provider class; a future ERP/banking/etc. module just adds its own
|
||||
* provider class to that config array and PrivacyService picks it up automatically.
|
||||
*/
|
||||
class PrivacyManager
|
||||
{
|
||||
public function __construct(private readonly Container $container) {}
|
||||
|
||||
/**
|
||||
* @return array<int, PersonalDataProvider>
|
||||
*/
|
||||
public function providers(): array
|
||||
{
|
||||
$providers = array_map(
|
||||
fn (string $class) => $this->container->make($class),
|
||||
config('core.privacy.providers', [])
|
||||
);
|
||||
|
||||
$this->assertUniqueNames($providers);
|
||||
|
||||
return $providers;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<int, PersonalDataProvider> $providers
|
||||
*/
|
||||
private function assertUniqueNames(array $providers): void
|
||||
{
|
||||
$names = array_map(fn (PersonalDataProvider $provider) => $provider->name(), $providers);
|
||||
$duplicates = array_diff_assoc($names, array_unique($names));
|
||||
|
||||
if ($duplicates !== []) {
|
||||
throw new LogicException(
|
||||
'Duplicate Modules\Core\Privacy provider name(s): '.implode(', ', array_unique($duplicates))
|
||||
.'. Each provider registered in config(\'core.privacy.providers\') must return a unique name().'
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,321 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Privacy\Services;
|
||||
|
||||
use Illuminate\Contracts\Auth\Authenticatable;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
use Illuminate\Support\Facades\Event;
|
||||
use Illuminate\Support\Facades\Log;
|
||||
use Lunar\Base\LunarUser;
|
||||
use Lunar\Models\Customer;
|
||||
use Modules\Core\Auth\Models\Staff;
|
||||
use Modules\Core\Privacy\Contracts\PersonalDataProvider;
|
||||
use Modules\Core\Privacy\DTOs\CustomerSubject;
|
||||
use Modules\Core\Privacy\DTOs\ErasureReport;
|
||||
use Modules\Core\Privacy\DTOs\ProviderErasureResult;
|
||||
use Modules\Core\Privacy\DTOs\UserSubject;
|
||||
use Modules\Core\Privacy\Enums\ErasureOutcome;
|
||||
use Modules\Core\Privacy\Enums\ErasureRequestStatus;
|
||||
use Modules\Core\Privacy\Enums\ExportRequestStatus;
|
||||
use Modules\Core\Privacy\Events\UserErasureRequested;
|
||||
use Modules\Core\Privacy\Jobs\ExportDataSubjectJob;
|
||||
use Modules\Core\Privacy\Models\DataErasureRequest;
|
||||
use Modules\Core\Privacy\Models\DataExportRequest;
|
||||
use Throwable;
|
||||
|
||||
/**
|
||||
* Entry point for right-of-access and right-of-erasure requests, split into two
|
||||
* independent scopes — see docs/privacy.md "User-scope vs Customer-scope":
|
||||
*
|
||||
* - *ForCustomer(): erases/exports one business account's own data (orders,
|
||||
* addresses, the account record itself). Never touches any linked User's
|
||||
* login or personal identity — a Customer erasure request must not deactivate
|
||||
* or destroy access for anyone who works there.
|
||||
* - *ForUser(): erases/exports one individual's own identity (login, name,
|
||||
* email) wherever it appears, and detaches them from every Customer account
|
||||
* they're linked to as part of erasure — without touching any Customer
|
||||
* account's own data or any other User still linked to it.
|
||||
*
|
||||
* A Customer (business account) can have many linked Users, and one User can be
|
||||
* linked to many Customer accounts (B2B multi-seat access — see docs/modules.md
|
||||
* "Customer/User Pairing"), so these are genuinely different operations with
|
||||
* different blast radii, not one flow with an optional cascade.
|
||||
*
|
||||
* Both directions are handled as requests, not immediate synchronous actions:
|
||||
* requestExport*() queues the (potentially slow) work of gathering every
|
||||
* provider's data and writing a file, rather than blocking whatever triggered it.
|
||||
* requestErasure*() opens a cancellable grace-period request (deactivating the
|
||||
* account for a User-scoped request only — see below) — the same shape as
|
||||
* Shopify's own account-deletion flow: a window where the subject can change
|
||||
* their mind before anything is actually erased.
|
||||
*/
|
||||
class PrivacyService
|
||||
{
|
||||
public function __construct(private readonly PrivacyManager $manager) {}
|
||||
|
||||
/**
|
||||
* Creates a DataExportRequest (fast — one insert) and dispatches
|
||||
* ExportDataSubjectJob to do the actual gathering/writing work. The job fires
|
||||
* PersonalDataGathered once every provider's data is collected;
|
||||
* Modules\Core\Privacy\Listeners\WriteExportToCsvListener turns that into a file
|
||||
* and fires PersonalDataExportFileWritten — a consuming app registers its own
|
||||
* notification against that event (see docs/privacy.md).
|
||||
*/
|
||||
public function requestExportForCustomer(Customer $customer): DataExportRequest
|
||||
{
|
||||
return $this->createExportRequest($customer->getMorphClass(), $customer->id, null);
|
||||
}
|
||||
|
||||
public function requestExportForUser(Authenticatable&LunarUser $user): DataExportRequest
|
||||
{
|
||||
return $this->createExportRequest($user->getMorphClass(), $user->id, $user->email);
|
||||
}
|
||||
|
||||
private function createExportRequest(string $subjectType, int $subjectId, ?string $email): DataExportRequest
|
||||
{
|
||||
$request = DataExportRequest::create([
|
||||
'subject_type' => $subjectType,
|
||||
'subject_id' => $subjectId,
|
||||
'email' => $email,
|
||||
'status' => ExportRequestStatus::Pending,
|
||||
]);
|
||||
|
||||
ExportDataSubjectJob::dispatch($request);
|
||||
|
||||
return $request;
|
||||
}
|
||||
|
||||
/**
|
||||
* Opens a grace-period erasure request for the Customer's own data. Deactivates
|
||||
* NO User — erasing a business account must not destroy anyone's login access,
|
||||
* even the account's own primary contact. Nothing is actually erased until
|
||||
* privacy:process-erasure-requests picks this up once scheduled_for has
|
||||
* passed, unless cancelErasure() is called first.
|
||||
*
|
||||
* $requestedBy is the Customer themselves (self-service deletion), a Staff
|
||||
* member acting on their behalf, or a User — the User case is for
|
||||
* Modules\Core\Privacy\Listeners\CascadeCustomerErasureListener, where erasing
|
||||
* a User leaves a Customer with no remaining user: the User is a real,
|
||||
* meaningful "who caused this," even though they didn't directly request the
|
||||
* Customer's own erasure. $causedByRequestId links a cascade-created request
|
||||
* back to the User erasure request that triggered it, so
|
||||
* CancelErasureOnLoginListener can revert exactly that cascade on login,
|
||||
* without touching an unrelated, independently-requested Customer erasure.
|
||||
*/
|
||||
public function requestErasureForCustomer(
|
||||
Customer $customer,
|
||||
Customer|Staff|(Authenticatable&LunarUser) $requestedBy,
|
||||
?int $causedByRequestId = null,
|
||||
): DataErasureRequest {
|
||||
return DataErasureRequest::create([
|
||||
'subject_type' => $customer->getMorphClass(),
|
||||
'subject_id' => $customer->id,
|
||||
'email' => null,
|
||||
'requested_by_type' => $requestedBy->getMorphClass(),
|
||||
'requested_by_id' => $requestedBy->getKey(),
|
||||
'status' => ErasureRequestStatus::Pending,
|
||||
'scheduled_for' => now()->addDays(config('core.privacy.grace_period_days', 30)),
|
||||
'caused_by_request_id' => $causedByRequestId,
|
||||
]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Opens a grace-period erasure request for one individual and deactivates
|
||||
* their login immediately (blocks it — see Modules\Core\Auth\Services\
|
||||
* UserOtpService — without touching any Customer account's data). $requestedBy
|
||||
* is either the User themselves (self-service deletion) or a Staff member
|
||||
* acting on their behalf.
|
||||
*/
|
||||
public function requestErasureForUser(Authenticatable&LunarUser $user, (Authenticatable&LunarUser)|Staff $requestedBy): DataErasureRequest
|
||||
{
|
||||
$request = DataErasureRequest::create([
|
||||
'subject_type' => $user->getMorphClass(),
|
||||
'subject_id' => $user->id,
|
||||
'email' => $user->email,
|
||||
'requested_by_type' => $requestedBy->getMorphClass(),
|
||||
'requested_by_id' => $requestedBy->getKey(),
|
||||
'status' => ErasureRequestStatus::Pending,
|
||||
'scheduled_for' => now()->addDays(config('core.privacy.grace_period_days', 30)),
|
||||
]);
|
||||
|
||||
$this->setUserDeactivated($user->id, true);
|
||||
|
||||
// CascadeCustomerErasureListener implements ShouldQueue, so this just
|
||||
// enqueues a job rather than running inline — no transaction wrapping
|
||||
// needed here, since the cascade check happens as an independent,
|
||||
// separately-retryable unit of work after this request is already
|
||||
// committed, not as part of this same call.
|
||||
Event::dispatch(new UserErasureRequested($request));
|
||||
|
||||
return $request;
|
||||
}
|
||||
|
||||
/**
|
||||
* Erases a Customer's data right now, bypassing the grace period entirely.
|
||||
* Staff-only by construction — $requestedBy is typed to Staff specifically,
|
||||
* so a self-service/customer-facing code path cannot reach this method at
|
||||
* all, only accidentally call it with the wrong actor type and get a
|
||||
* compile-time error. This exists for a formal legal request or regulator
|
||||
* inquiry that genuinely requires immediate action — not a convenience
|
||||
* option for an impatient customer. The grace period is deliberately not
|
||||
* skippable from any customer-facing flow; see docs/privacy.md.
|
||||
*/
|
||||
public function requestImmediateErasureForCustomer(Customer $customer, Staff $requestedBy): ErasureReport
|
||||
{
|
||||
$request = DataErasureRequest::create([
|
||||
'subject_type' => $customer->getMorphClass(),
|
||||
'subject_id' => $customer->id,
|
||||
'email' => null,
|
||||
'requested_by_type' => $requestedBy->getMorphClass(),
|
||||
'requested_by_id' => $requestedBy->getKey(),
|
||||
'status' => ErasureRequestStatus::Pending,
|
||||
'scheduled_for' => now(),
|
||||
]);
|
||||
|
||||
return $this->completeErasure($request);
|
||||
}
|
||||
|
||||
/**
|
||||
* Erases a User's data right now, bypassing the grace period entirely.
|
||||
* Staff-only by construction — see requestImmediateErasureForCustomer().
|
||||
*
|
||||
* Still fires UserErasureRequested — and deliberately BEFORE completeErasure()
|
||||
* runs, not after — so Modules\Core\Privacy\Listeners\
|
||||
* CascadeCustomerErasureListener sees the User still linked to their Customers
|
||||
* (completeErasure() -> CustomerDataProvider::eraseForUser() is what detaches
|
||||
* the pivot). The User's own erasure is immediate, but any Customer left
|
||||
* orphaned by it still gets a normal grace-period erasure request, not an
|
||||
* immediate one — an orphaned Customer isn't itself the subject of the
|
||||
* original urgent request.
|
||||
*/
|
||||
public function requestImmediateErasureForUser(Authenticatable&LunarUser $user, Staff $requestedBy): ErasureReport
|
||||
{
|
||||
$request = DataErasureRequest::create([
|
||||
'subject_type' => $user->getMorphClass(),
|
||||
'subject_id' => $user->id,
|
||||
'email' => $user->email,
|
||||
'requested_by_type' => $requestedBy->getMorphClass(),
|
||||
'requested_by_id' => $requestedBy->getKey(),
|
||||
'status' => ErasureRequestStatus::Pending,
|
||||
'scheduled_for' => now(),
|
||||
]);
|
||||
|
||||
$this->setUserDeactivated($user->id, true);
|
||||
|
||||
// Queued (see requestErasureForUser()) — the cascade job may run before
|
||||
// or after completeErasure() below detaches the pivot. Either is fine:
|
||||
// CascadeCustomerErasureListener re-reads $user->customers fresh when it
|
||||
// runs, so it only cascades if this User is still linked at that point.
|
||||
// If completeErasure() detaches first, the queued job simply finds no
|
||||
// Customers left to check and no-ops — never a wrong cascade, at worst a
|
||||
// missed one on a race that immediate (staff-triggered, rare) erasure
|
||||
// doesn't need to guard against as tightly as the grace-period path.
|
||||
Event::dispatch(new UserErasureRequested($request));
|
||||
|
||||
return $this->completeErasure($request);
|
||||
}
|
||||
|
||||
/**
|
||||
* Cancels a pending request. For a User-scoped request, reactivates the
|
||||
* account (see requestErasureForUser()). A Customer-scoped request never
|
||||
* deactivated anything, so there's nothing to reactivate for it. No-op
|
||||
* (returns false) if the request isn't pending — e.g. already completed or
|
||||
* cancelled.
|
||||
*/
|
||||
public function cancelErasure(DataErasureRequest $request): bool
|
||||
{
|
||||
if (! $request->isPending()) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$request->update([
|
||||
'status' => ErasureRequestStatus::Cancelled,
|
||||
'cancelled_at' => now(),
|
||||
]);
|
||||
|
||||
if (! $request->isForCustomer()) {
|
||||
$this->setUserDeactivated($request->subject_id, false);
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Actually erases the data for a due request: runs every registered
|
||||
* provider's *ForCustomer() or *ForUser() method (whichever matches the
|
||||
* request's subject), records the outcome on the request, and marks it
|
||||
* completed. Called by privacy:process-erasure-requests — not meant to be
|
||||
* called directly for a request that hasn't passed its grace period, since
|
||||
* that defeats the point of the window; ProcessErasureRequestsCommand
|
||||
* enforces isDue() before calling this.
|
||||
*
|
||||
* Each provider call is caught individually — a provider throwing (a bug,
|
||||
* an unexpected DB state) converts to ErasureOutcome::Failed rather than
|
||||
* aborting the whole array_map, so one broken provider never discards
|
||||
* every OTHER provider's already-completed erasure for this same request.
|
||||
* Without this, the $request->update() below would never run at all on a
|
||||
* throw, silently leaving providers that already succeeded unrecorded and
|
||||
* the request stuck Pending forever. Logged via Log::error() so a thrown
|
||||
* provider is still visible to staff, not just swallowed into "Failed."
|
||||
*/
|
||||
public function completeErasure(DataErasureRequest $request): ErasureReport
|
||||
{
|
||||
if ($request->isForCustomer()) {
|
||||
$subject = new CustomerSubject(customerId: $request->subject_id);
|
||||
$results = array_map(
|
||||
fn (PersonalDataProvider $provider) => $this->safeErase($provider, 'eraseForCustomer', $subject),
|
||||
$this->manager->providers()
|
||||
);
|
||||
} else {
|
||||
$subject = new UserSubject(userId: $request->subject_id, email: $request->email);
|
||||
$results = array_map(
|
||||
fn (PersonalDataProvider $provider) => $this->safeErase($provider, 'eraseForUser', $subject),
|
||||
$this->manager->providers()
|
||||
);
|
||||
}
|
||||
|
||||
$report = new ErasureReport($subject, $results);
|
||||
|
||||
$request->update([
|
||||
'status' => ErasureRequestStatus::Completed,
|
||||
'completed_at' => now(),
|
||||
'report' => array_map(
|
||||
fn (ProviderErasureResult $result) => [
|
||||
'provider' => $result->provider,
|
||||
'outcome' => $result->outcome->value,
|
||||
'reason' => $result->reason,
|
||||
],
|
||||
$results
|
||||
),
|
||||
]);
|
||||
|
||||
return $report;
|
||||
}
|
||||
|
||||
private function setUserDeactivated(int $userId, bool $deactivated): void
|
||||
{
|
||||
$model = config('auth.providers.users.model');
|
||||
|
||||
/** @var class-string<Model> $model */
|
||||
$model::where('id', $userId)->update([
|
||||
'deactivated_at' => $deactivated ? now() : null,
|
||||
]);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param 'eraseForCustomer'|'eraseForUser' $method
|
||||
*/
|
||||
private function safeErase(PersonalDataProvider $provider, string $method, CustomerSubject|UserSubject $subject): ProviderErasureResult
|
||||
{
|
||||
try {
|
||||
return $provider->{$method}($subject);
|
||||
} catch (Throwable $e) {
|
||||
Log::error("Privacy provider {$provider->name()}::{$method}() threw during erasure", [
|
||||
'provider' => $provider->name(),
|
||||
'exception' => $e,
|
||||
]);
|
||||
|
||||
return new ProviderErasureResult($provider->name(), ErasureOutcome::Failed, $e->getMessage());
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -11,6 +11,7 @@ use Modules\Core\Command\ExportCommand;
|
||||
use Modules\Core\Command\ImportCommand;
|
||||
use Modules\Core\Command\InstallLunarCommand;
|
||||
use Modules\Core\Command\MigrateImportCommand;
|
||||
use Modules\Core\Command\ProcessErasureRequestsCommand;
|
||||
use Modules\Core\Command\TuneProductSearchCommand;
|
||||
|
||||
class CoreServiceProvider extends ServiceProvider
|
||||
@@ -38,10 +39,10 @@ class CoreServiceProvider extends ServiceProvider
|
||||
], 'core-assets');
|
||||
|
||||
if ($this->app->runningInConsole()) {
|
||||
$this->commands([AnonymizeCommand::class, ExportCommand::class, ExportCleanupCommand::class, ImportCommand::class, MigrateImportCommand::class, TuneProductSearchCommand::class, BackfillMissingSkusCommand::class]);
|
||||
$this->commands([AnonymizeCommand::class, ExportCommand::class, ExportCleanupCommand::class, ImportCommand::class, MigrateImportCommand::class, TuneProductSearchCommand::class, BackfillMissingSkusCommand::class, ProcessErasureRequestsCommand::class]);
|
||||
|
||||
//Overriding lunar:install
|
||||
$this->app->booted(fn () => $this->commands([InstallLunarCommand::class]));
|
||||
$this->app->booted(fn() => $this->commands([InstallLunarCommand::class]));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Providers;
|
||||
|
||||
use Illuminate\Support\Facades\Event;
|
||||
use Illuminate\Support\ServiceProvider;
|
||||
use Modules\Core\Auth\Events\UserAuthenticated;
|
||||
use Modules\Core\Privacy\Events\PersonalDataGathered;
|
||||
use Modules\Core\Privacy\Events\UserErasureRequested;
|
||||
use Modules\Core\Privacy\Listeners\CancelErasureOnLoginListener;
|
||||
use Modules\Core\Privacy\Listeners\CascadeCustomerErasureListener;
|
||||
use Modules\Core\Privacy\Listeners\WriteExportToCsvListener;
|
||||
|
||||
class PrivacyServiceProvider extends ServiceProvider
|
||||
{
|
||||
public function boot(): void
|
||||
{
|
||||
Event::listen(UserAuthenticated::class, CancelErasureOnLoginListener::class);
|
||||
Event::listen(PersonalDataGathered::class, WriteExportToCsvListener::class);
|
||||
Event::listen(UserErasureRequested::class, CascadeCustomerErasureListener::class);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,99 @@
|
||||
<?php
|
||||
|
||||
namespace Modules\Core\Review\Privacy;
|
||||
|
||||
use Illuminate\Database\Eloquent\Builder;
|
||||
use Modules\Core\Privacy\Contracts\PersonalDataProvider;
|
||||
use Modules\Core\Privacy\DTOs\CustomerSubject;
|
||||
use Modules\Core\Privacy\Enums\ErasureOutcome;
|
||||
use Modules\Core\Privacy\DTOs\ProviderErasureResult;
|
||||
use Modules\Core\Privacy\DTOs\ProviderExportResult;
|
||||
use Modules\Core\Privacy\DTOs\UserSubject;
|
||||
use Modules\Core\Review\Models\ProductReview;
|
||||
|
||||
/**
|
||||
* ProductReview (product_reviews) has no FK to Customer/User at all — it's
|
||||
* deliberately anonymous, just free-text reviewer_name/reviewer_email (see
|
||||
* docs/product-listing.md "Reviews"). A review is authored by an individual, not a
|
||||
* business account, so this is User-scope only — matched best-effort by email
|
||||
* against UserSubject::$email.
|
||||
*
|
||||
* NEEDS REVIEW: moved from Customer-scope to User-scope during the User/Customer
|
||||
* split (see docs/privacy.md "User-scope vs Customer-scope") on the reasoning that
|
||||
* authorship is a personal attribute — but this hasn't been fully validated against
|
||||
* how reviews are actually attributed in this codebase; revisit before relying on
|
||||
* it for a real erasure/export request.
|
||||
*
|
||||
* Matching by email is itself a real, documented limitation regardless of scope: a
|
||||
* review submitted under a different email than the one on file won't be found.
|
||||
* There's no stronger signal available without changing ProductReview's schema.
|
||||
*/
|
||||
class ReviewDataProvider implements PersonalDataProvider
|
||||
{
|
||||
public function name(): string
|
||||
{
|
||||
return 'reviews';
|
||||
}
|
||||
|
||||
public function exportForCustomer(CustomerSubject $subject): ProviderExportResult
|
||||
{
|
||||
return new ProviderExportResult('reviews', []);
|
||||
}
|
||||
|
||||
public function exportForUser(UserSubject $subject): ProviderExportResult
|
||||
{
|
||||
if (! $subject->email) {
|
||||
return new ProviderExportResult('reviews', []);
|
||||
}
|
||||
|
||||
$reviews = $this->matchingReviews($subject->email)->get();
|
||||
|
||||
return new ProviderExportResult('reviews', $reviews->map(fn (ProductReview $review) => [
|
||||
'id' => $review->id,
|
||||
'product_id' => $review->product_id,
|
||||
'title' => $review->title,
|
||||
'body' => $review->body,
|
||||
'rating' => $review->rating,
|
||||
'reviewer_name' => $review->reviewer_name,
|
||||
'reviewer_email' => $review->reviewer_email,
|
||||
'reviewed_at' => $review->reviewed_at?->toIso8601String(),
|
||||
])->all());
|
||||
}
|
||||
|
||||
public function eraseForCustomer(CustomerSubject $subject): ProviderErasureResult
|
||||
{
|
||||
return new ProviderErasureResult('reviews', ErasureOutcome::Skipped, 'Reviews are authored by individuals, not Customer accounts.');
|
||||
}
|
||||
|
||||
public function eraseForUser(UserSubject $subject): ProviderErasureResult
|
||||
{
|
||||
if (! $subject->email) {
|
||||
return new ProviderErasureResult('reviews', ErasureOutcome::Skipped, 'No email on this subject to match reviews by.');
|
||||
}
|
||||
|
||||
$matched = $this->matchingReviews($subject->email)->count();
|
||||
|
||||
if ($matched === 0) {
|
||||
return new ProviderErasureResult('reviews', ErasureOutcome::Skipped, 'No reviews matched this email.');
|
||||
}
|
||||
|
||||
// The review content itself (rating/title/body) is kept — it's the
|
||||
// reviewer's own product feedback, not identity data on its own — only
|
||||
// the identifying fields are cleared.
|
||||
$this->matchingReviews($subject->email)->update([
|
||||
'reviewer_name' => 'Anonymous',
|
||||
'reviewer_email' => null,
|
||||
]);
|
||||
|
||||
return new ProviderErasureResult(
|
||||
'reviews',
|
||||
ErasureOutcome::Pseudonymized,
|
||||
'Reviewer name/email cleared on reviews matched by email; rating/title/body text retained.'
|
||||
);
|
||||
}
|
||||
|
||||
private function matchingReviews(string $email): Builder
|
||||
{
|
||||
return ProductReview::where('reviewer_email', $email);
|
||||
}
|
||||
}
|
||||
@@ -47,7 +47,7 @@ class ShippingMethodResourceExtension extends ResourceExtension
|
||||
}
|
||||
|
||||
if (in_array(HasChildComponents::class, class_uses_recursive($component), true)) {
|
||||
$component->schema($this->replaceNameField($component->getChildComponents()));
|
||||
$component->schema($this->replaceNameField($component->getDefaultChildComponents()));
|
||||
}
|
||||
|
||||
return $component;
|
||||
@@ -158,7 +158,7 @@ class ShippingMethodResourceExtension extends ResourceExtension
|
||||
|
||||
if (in_array(HasChildComponents::class, class_uses_recursive($component), true)) {
|
||||
$component->schema(
|
||||
$this->replaceChargeByField($component->getChildComponents())
|
||||
$this->replaceChargeByField($component->getDefaultChildComponents())
|
||||
);
|
||||
}
|
||||
|
||||
@@ -269,7 +269,7 @@ class ShippingMethodResourceExtension extends ResourceExtension
|
||||
|
||||
if (in_array(HasChildComponents::class, class_uses_recursive($component), true)) {
|
||||
$component->schema(
|
||||
$this->replaceDriverField($component->getChildComponents())
|
||||
$this->replaceDriverField($component->getDefaultChildComponents())
|
||||
);
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user