Compare commits
49
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
621381beaa | ||
|
|
8f4156cfe8 | ||
|
|
a9b993182b | ||
|
|
5a7fcd9f51 | ||
|
|
b4e9b8a4a9 | ||
|
|
c7035d6782 | ||
|
|
4c0974bf84 | ||
|
|
4e15d8ef8c | ||
|
|
1c7efc6e4d | ||
|
|
59c57b37fc | ||
|
|
37b49963f6 | ||
|
|
050204f063 | ||
|
|
c0ae9d8996 | ||
|
|
cc1cf6ea7f | ||
|
|
0437057e5d | ||
|
|
0c169daf55 | ||
|
|
609a63c2f4 | ||
|
|
12aaa43f10 | ||
|
|
dcdc998eee | ||
|
|
a55697ce82 | ||
|
|
a411e6bbc1 | ||
|
|
910fa94395 | ||
|
|
fdd1899c34 | ||
|
|
3ad3a1b4d6 | ||
|
|
68233f43ef | ||
|
|
027f7e8982 | ||
|
|
c084eb47cb | ||
|
|
58d165acc3 | ||
|
|
44ad943eec | ||
|
|
2cc6f5e5f0 | ||
|
|
0babc6a96d | ||
|
|
89a3d4bbad | ||
|
|
ccb2666495 | ||
|
|
97004234f0 | ||
|
|
ea73cc3562 | ||
|
|
02816fb9e7 | ||
|
|
910ce0205d | ||
|
|
e532c32cab | ||
|
|
6a51b672c8 | ||
|
|
956e9e88a6 | ||
|
|
4489475840 | ||
|
|
e4e008167a | ||
|
|
a5f3008ce2 | ||
|
|
d9fb3bbde6 | ||
|
|
26b4c5bfd7 | ||
|
|
e7784364fd | ||
|
|
59303cf25f | ||
|
|
af380a7fa0 | ||
|
|
9f540cbaa4 |
+554
-56
File diff suppressed because it is too large
Load Diff
@@ -1,6 +1,9 @@
|
|||||||
# Core Module
|
# 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
|
### 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).
|
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
|
### 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:**
|
**Creating a notification:**
|
||||||
|
|
||||||
@@ -33,9 +106,13 @@ class MyNotification extends BaseNotification
|
|||||||
NotificationRegistry::get()->register([MyNotification::class]);
|
NotificationRegistry::get()->register([MyNotification::class]);
|
||||||
```
|
```
|
||||||
|
|
||||||
|
See [`docs/notifications.md`](docs/notifications.md).
|
||||||
|
|
||||||
### Activity Logging
|
### 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).
|
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
|
- Custom OTP login page replacing the default Lunar panel login
|
||||||
- `StaffResourceExtension` — removes password field from Lunar's staff resource
|
- `StaffResourceExtension` — removes password field from Lunar's staff resource
|
||||||
- `CustomerResourceExtension` — replaces default address relation manager with a custom implementation
|
- `CustomerResourceExtension` — replaces default address relation manager with a custom
|
||||||
- `CorePlugin` — configures panel path, branding, logos, navigation items, and activity log field exclusions for staff
|
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:
|
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())
|
->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
|
### CLI Commands
|
||||||
|
|
||||||
| Command | Description |
|
| Command | Description |
|
||||||
|---|---|
|
|---|---|
|
||||||
| `core:create-admin` | Create a Lunar admin user |
|
| `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) |
|
||||||
| `core:anonymize` | GDPR anonymization of users and customers (local only) |
|
| `boboko:export` | Dump database + storage files to a timestamped zip |
|
||||||
| `core:export` | Dump database + storage files to a timestamped zip |
|
| `boboko:import` | Restore from a `boboko:export` zip archive |
|
||||||
| `core:import` | Restore from a zip export (runs anonymize automatically, local only) |
|
| `boboko:export:cleanup` | Delete old export zips, keep N most recent |
|
||||||
| `core: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
|
### Functional Types
|
||||||
|
|
||||||
Result and Option monads for explicit error handling without exceptions.
|
Result and Option types for explicit error handling without exceptions.
|
||||||
|
|
||||||
```php
|
```php
|
||||||
// Result<T, E>
|
// Result<T, E>
|
||||||
$result = Success::of($value);
|
$result = Success::create($value);
|
||||||
$result = Error::of('something went wrong');
|
$result = Error::create('something went wrong');
|
||||||
$result->map(fn($v) => ...)->flatMap(fn($v) => ...);
|
$result->map(fn($v) => ...)->flatMap(fn($v) => ...);
|
||||||
|
|
||||||
// Option<T>
|
// Option<T>
|
||||||
$option = Option::fromValue($nullableValue);
|
$option = Some::create($value);
|
||||||
$option->getOrElse('default');
|
$option = None::create();
|
||||||
$option->map(fn($v) => ...)->filter(fn($v) => $v > 0);
|
$option->map(fn($v) => ...);
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
@@ -102,17 +188,22 @@ Then run:
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
composer require boboko/core
|
composer require boboko/core
|
||||||
|
php artisan vendor:publish --tag=core-config
|
||||||
php artisan vendor:publish --tag=core-assets
|
php artisan vendor:publish --tag=core-assets
|
||||||
php artisan migrate
|
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
|
## Requirements
|
||||||
|
|
||||||
- PHP 8.2+
|
- PHP 8.5+
|
||||||
- Laravel 11+
|
- Laravel 12+
|
||||||
- Lunar (lunarphp/lunar + lunarphp/admin)
|
- Lunar 1.3 (`lunarphp/lunar`)
|
||||||
|
- Meilisearch (for product search/listing/catalog)
|
||||||
- Spatie Laravel Activity Log
|
- Spatie Laravel Activity Log
|
||||||
|
|
||||||
---
|
---
|
||||||
@@ -120,7 +211,12 @@ php artisan migrate
|
|||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
- [`docs/otp-auth.md`](docs/otp-auth.md) — OTP authentication flow
|
- [`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/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/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
|
- [`docs/modules.md`](docs/modules.md) — Module architecture, Customer/User pairing, provider registration pitfalls
|
||||||
|
|||||||
+4
-3
@@ -2,7 +2,7 @@
|
|||||||
"name": "boboko/core",
|
"name": "boboko/core",
|
||||||
"description": "Core module — authentication and shared panel behaviour",
|
"description": "Core module — authentication and shared panel behaviour",
|
||||||
"type": "library",
|
"type": "library",
|
||||||
"version": "0.17.0",
|
"version": "0.20.1",
|
||||||
"autoload": {
|
"autoload": {
|
||||||
"psr-4": {
|
"psr-4": {
|
||||||
"Modules\\Core\\": "src/"
|
"Modules\\Core\\": "src/"
|
||||||
@@ -18,7 +18,7 @@
|
|||||||
"lunarphp/search": "*",
|
"lunarphp/search": "*",
|
||||||
"lunarphp/meilisearch": "*",
|
"lunarphp/meilisearch": "*",
|
||||||
"spatie/laravel-translation-loader": "^2.8",
|
"spatie/laravel-translation-loader": "^2.8",
|
||||||
"lunarphp/stripe": "^1.5"
|
"stripe/stripe-php": "^16.6"
|
||||||
},
|
},
|
||||||
"require-dev": {
|
"require-dev": {
|
||||||
"fakerphp/faker": "^1.23",
|
"fakerphp/faker": "^1.23",
|
||||||
@@ -44,7 +44,8 @@
|
|||||||
"Modules\\Core\\Providers\\CartServiceProvider",
|
"Modules\\Core\\Providers\\CartServiceProvider",
|
||||||
"Modules\\Core\\Providers\\ReviewServiceProvider",
|
"Modules\\Core\\Providers\\ReviewServiceProvider",
|
||||||
"Modules\\Core\\Providers\\ShippingServiceProvider",
|
"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,
|
'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
|
| Cart Abandonment Threshold
|
||||||
|
|||||||
@@ -13,12 +13,25 @@
|
|||||||
|
|
|
|
||||||
| Set these via environment variables — never commit real values.
|
| Set these via environment variables — never commit real values.
|
||||||
|
|
|
|
||||||
|
| Box Now has two environments (see their Partner API manual, section 2):
|
||||||
|
| Stage/Sandbox for testing, Production once live. Each has its own
|
||||||
|
| client_id/client_secret pair and its own base_url/location_api_url —
|
||||||
|
| there is no shared "switch an env var" flag, since stage credentials
|
||||||
|
| don't work against the production host or vice versa.
|
||||||
|
|
|
||||||
| BOXNOW_BASE_URL Root REST endpoint for delivery-requests/parcels.
|
| BOXNOW_BASE_URL Root REST endpoint for delivery-requests/parcels.
|
||||||
| BOXNOW_LOCATION_API_URL Separate, faster endpoint for origins/destinations
|
| BOXNOW_LOCATION_API_URL Separate, faster endpoint for origins/destinations
|
||||||
| lookups (Box Now recommends this over the main
|
| lookups (Box Now recommends this over the main
|
||||||
| base URL for those two calls specifically).
|
| base URL for those two calls specifically).
|
||||||
| BOXNOW_CLIENT_ID OAuth2 client id.
|
| BOXNOW_CLIENT_ID OAuth2 client id.
|
||||||
| BOXNOW_CLIENT_SECRET OAuth2 client secret.
|
| BOXNOW_CLIENT_SECRET OAuth2 client secret.
|
||||||
|
| BOXNOW_PARTNER_ID Numeric partnerId Box Now issues alongside your
|
||||||
|
| credentials. NOT used for REST API authentication
|
||||||
|
| (BoxNowClient authenticates with client_id/
|
||||||
|
| client_secret alone) — this is only consumed by
|
||||||
|
| the client-side Destination Map widget config
|
||||||
|
| (_bn_map_widget_config.partnerId), confirmed
|
||||||
|
| against Box Now's own WooCommerce plugin source.
|
||||||
| BOXNOW_ORIGIN_LOCATION_ID Your warehouse's Box Now locationId, used as
|
| BOXNOW_ORIGIN_LOCATION_ID Your warehouse's Box Now locationId, used as
|
||||||
| the pickup origin on every delivery request.
|
| the pickup origin on every delivery request.
|
||||||
| BOXNOW_SENDER_* Static sender contact details reused on every
|
| BOXNOW_SENDER_* Static sender contact details reused on every
|
||||||
@@ -33,6 +46,7 @@ return [
|
|||||||
|
|
||||||
'client_id' => env('BOXNOW_CLIENT_ID'),
|
'client_id' => env('BOXNOW_CLIENT_ID'),
|
||||||
'client_secret' => env('BOXNOW_CLIENT_SECRET'),
|
'client_secret' => env('BOXNOW_CLIENT_SECRET'),
|
||||||
|
'partner_id' => env('BOXNOW_PARTNER_ID'),
|
||||||
|
|
||||||
'origin_location_id' => env('BOXNOW_ORIGIN_LOCATION_ID'),
|
'origin_location_id' => env('BOXNOW_ORIGIN_LOCATION_ID'),
|
||||||
|
|
||||||
|
|||||||
@@ -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');
|
||||||
|
}
|
||||||
|
};
|
||||||
@@ -0,0 +1,46 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
use Illuminate\Database\Schema\Blueprint;
|
||||||
|
use Illuminate\Support\Facades\Schema;
|
||||||
|
use Lunar\Base\Migration;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* First-party copy of lunarphp/stripe's own create_stripe_payment_intents_table
|
||||||
|
* migration (package removed in favour of depending on stripe/stripe-php
|
||||||
|
* directly — see Modules\Core\Payment\Support\StripeManager and
|
||||||
|
* Modules\Core\Payment\Models\StripePaymentIntent, which replace the
|
||||||
|
* package's own classes over this same table). Timestamped to run just
|
||||||
|
* before this app's own add_context_to_stripe_payment_intents migration,
|
||||||
|
* which already alters this table.
|
||||||
|
*
|
||||||
|
* Guarded with hasTable(): on any environment that already ran
|
||||||
|
* lunarphp/stripe's own copy of this migration before the package was
|
||||||
|
* removed, the table already exists — this migration is only the one that
|
||||||
|
* actually creates it on a fresh install/database from now on.
|
||||||
|
*/
|
||||||
|
return new class extends Migration
|
||||||
|
{
|
||||||
|
public function up(): void
|
||||||
|
{
|
||||||
|
if (Schema::hasTable($this->prefix.'stripe_payment_intents')) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
Schema::create($this->prefix.'stripe_payment_intents', function (Blueprint $table) {
|
||||||
|
$table->id();
|
||||||
|
$table->foreignId('cart_id')->constrained($this->prefix.'carts');
|
||||||
|
$table->foreignId('order_id')->nullable()->constrained($this->prefix.'orders');
|
||||||
|
$table->string('intent_id')->index();
|
||||||
|
$table->string('status')->nullable();
|
||||||
|
$table->string('event_id')->index()->nullable();
|
||||||
|
$table->timestamp('processing_at')->nullable();
|
||||||
|
$table->timestamp('processed_at')->nullable();
|
||||||
|
$table->timestamps();
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
public function down(): void
|
||||||
|
{
|
||||||
|
Schema::dropIfExists($this->prefix.'stripe_payment_intents');
|
||||||
|
}
|
||||||
|
};
|
||||||
@@ -0,0 +1,65 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
use Illuminate\Database\Migrations\Migration;
|
||||||
|
use Illuminate\Support\Facades\DB;
|
||||||
|
use Lunar\Models\Language;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* PaymentMethod.name becomes a locale-keyed JSON array (e.g.
|
||||||
|
* {"en": "Cash On Delivery", "el": "Αντικαταβολή"}), rendered in Filament
|
||||||
|
* via Lunar's own Lunar\Admin\Support\Forms\Components\TranslatedText —
|
||||||
|
* the same reusable component/data-shape Product/Collection names already
|
||||||
|
* use (Lunar\Base\Traits\HasTranslations), just applied directly to a
|
||||||
|
* plain column here rather than through attribute_data, since
|
||||||
|
* PaymentMethod is a merchant-configured settings row, not a translatable
|
||||||
|
* catalog attribute.
|
||||||
|
*
|
||||||
|
* Existing plain-string rows are preserved under the store's default
|
||||||
|
* Language code (falls back to 'en' if no Language row exists yet — this
|
||||||
|
* migration can run before lunar:install seeds one) rather than dropped,
|
||||||
|
* so an already-configured payment method's name isn't blanked out.
|
||||||
|
*
|
||||||
|
* Uses a raw `ALTER COLUMN ... TYPE` rather than Blueprint::change()
|
||||||
|
* (which requires doctrine/dbal — not installed in this project) —
|
||||||
|
* Postgres-specific (this project runs on `pgsql`, per its own docker
|
||||||
|
* setup), with an explicit USING clause since json isn't implicitly
|
||||||
|
* castable from varchar.
|
||||||
|
*/
|
||||||
|
return new class extends Migration
|
||||||
|
{
|
||||||
|
public function up(): void
|
||||||
|
{
|
||||||
|
$defaultLocale = Language::where('default', true)->value('code') ?? 'en';
|
||||||
|
|
||||||
|
$existing = DB::table('payment_methods')->pluck('name', 'id');
|
||||||
|
|
||||||
|
DB::statement('ALTER TABLE payment_methods ALTER COLUMN name DROP DEFAULT');
|
||||||
|
DB::statement("ALTER TABLE payment_methods ALTER COLUMN name TYPE json USING NULL");
|
||||||
|
|
||||||
|
foreach ($existing as $id => $name) {
|
||||||
|
if ($name === null) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
DB::table('payment_methods')
|
||||||
|
->where('id', $id)
|
||||||
|
->update(['name' => json_encode([$defaultLocale => $name])]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public function down(): void
|
||||||
|
{
|
||||||
|
$defaultLocale = Language::where('default', true)->value('code') ?? 'en';
|
||||||
|
|
||||||
|
$existing = DB::table('payment_methods')->pluck('name', 'id');
|
||||||
|
|
||||||
|
DB::statement('ALTER TABLE payment_methods ALTER COLUMN name TYPE varchar(255) USING NULL');
|
||||||
|
|
||||||
|
foreach ($existing as $id => $name) {
|
||||||
|
$decoded = json_decode((string) $name, true);
|
||||||
|
$flat = is_array($decoded) ? ($decoded[$defaultLocale] ?? reset($decoded) ?: null) : $name;
|
||||||
|
|
||||||
|
DB::table('payment_methods')->where('id', $id)->update(['name' => $flat]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
@@ -0,0 +1,74 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
use Illuminate\Support\Facades\DB;
|
||||||
|
use Lunar\Base\Migration;
|
||||||
|
use Lunar\Models\Language;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* ShippingMethod.name becomes a locale-keyed JSON array (e.g.
|
||||||
|
* {"en": "Standard Delivery", "el": "Κανονική Παράδοση"}), rendered in
|
||||||
|
* Filament via Lunar's own Lunar\Admin\Support\Forms\Components\
|
||||||
|
* TranslatedText (Modules\Core\Shipping\Extensions\
|
||||||
|
* ShippingMethodResourceExtension::replaceNameField()) — same shape/
|
||||||
|
* resolution as PaymentMethod.name (see its own migration,
|
||||||
|
* 2026_09_15_000001_make_payment_methods_name_translatable.php) and
|
||||||
|
* Product/Collection names (Lunar\Base\Traits\HasTranslations).
|
||||||
|
*
|
||||||
|
* ShippingMethod is a vendor (lunarphp/table-rate-shipping) table, but
|
||||||
|
* converting a vendor column's type via a migration is no different from
|
||||||
|
* any other schema change this project already makes against a vendor
|
||||||
|
* table (see database/migrations/2026_08_31_000001_create_payment_methods_table.php's
|
||||||
|
* sibling migrations for the same pattern against PaymentMethod) — there
|
||||||
|
* was no good reason to route this through `data.name` instead, unlike
|
||||||
|
* `data.fulfillment_type` which is a genuinely NEW field the vendor table
|
||||||
|
* never had at all.
|
||||||
|
*
|
||||||
|
* Existing plain-string rows are preserved under the store's default
|
||||||
|
* Language code (falls back to 'en' if no Language row exists yet)
|
||||||
|
* rather than dropped.
|
||||||
|
*
|
||||||
|
* Uses a raw `ALTER COLUMN ... TYPE` rather than Blueprint::change()
|
||||||
|
* (requires doctrine/dbal — not installed in this project) — Postgres-
|
||||||
|
* specific (this project runs on `pgsql`), with an explicit USING clause
|
||||||
|
* since json isn't implicitly castable from varchar.
|
||||||
|
*/
|
||||||
|
return new class extends Migration
|
||||||
|
{
|
||||||
|
public function up(): void
|
||||||
|
{
|
||||||
|
$table = $this->prefix.'shipping_methods';
|
||||||
|
$defaultLocale = Language::where('default', true)->value('code') ?? 'en';
|
||||||
|
|
||||||
|
// The column is NOT NULL (vendor migration never marked it
|
||||||
|
// nullable) — converting via `USING NULL` first, then
|
||||||
|
// backfilling with a second UPDATE, violates that constraint
|
||||||
|
// before the backfill ever runs. json_build_object() converts
|
||||||
|
// each existing string in place, in the same statement, so the
|
||||||
|
// column is never transiently NULL. $defaultLocale is inlined
|
||||||
|
// (not bound) — parameter binding inside an ALTER TABLE ... USING
|
||||||
|
// expression isn't reliable across drivers; it's a Language::code
|
||||||
|
// value we control, not user input, so quote_literal-safe
|
||||||
|
// interpolation here is fine.
|
||||||
|
$quotedLocale = DB::getPdo()->quote($defaultLocale);
|
||||||
|
|
||||||
|
DB::statement("ALTER TABLE {$table} ALTER COLUMN name TYPE json USING json_build_object({$quotedLocale}, name)");
|
||||||
|
}
|
||||||
|
|
||||||
|
public function down(): void
|
||||||
|
{
|
||||||
|
$table = $this->prefix.'shipping_methods';
|
||||||
|
$defaultLocale = Language::where('default', true)->value('code') ?? 'en';
|
||||||
|
|
||||||
|
// Same NOT NULL constraint applies going back — ->>'{locale}'
|
||||||
|
// extracts the default locale's text value directly in the
|
||||||
|
// USING clause, falling back to the first key present via
|
||||||
|
// COALESCE for any row missing that locale (e.g. one only ever
|
||||||
|
// filled in via a non-default language).
|
||||||
|
$quotedLocale = DB::getPdo()->quote($defaultLocale);
|
||||||
|
|
||||||
|
DB::statement(
|
||||||
|
"ALTER TABLE {$table} ALTER COLUMN name TYPE varchar(255) ".
|
||||||
|
"USING COALESCE(name->>{$quotedLocale}, (SELECT value FROM json_each_text(name) LIMIT 1))"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
};
|
||||||
@@ -0,0 +1,40 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
use Illuminate\Database\Migrations\Migration;
|
||||||
|
use Illuminate\Database\Schema\Blueprint;
|
||||||
|
use Illuminate\Support\Facades\Schema;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Per-product, customer-authored input fields — a personalized-statue
|
||||||
|
* product needing a reference photo upload and an optional engraving
|
||||||
|
* textarea, for example. Deliberately NOT modeled as a Lunar ProductOption
|
||||||
|
* (see Modules\Core\Catalog\Contracts\ProductOptionTypeInterface's own
|
||||||
|
* docblock): an option's values are a fixed, admin-authored list that
|
||||||
|
* define variants (Red/Green/Blue) — a photo upload has no such list, it's
|
||||||
|
* unique per order, and creates no variant at all. This is a genuinely
|
||||||
|
* different concept that happens to configure on the same product page.
|
||||||
|
*
|
||||||
|
* Array of {key, type: 'text'|'textarea'|'file', label, required} — `key`
|
||||||
|
* is what a submitted answer is keyed by in CartLine/OrderLine.meta (both
|
||||||
|
* already have a `meta` json column — see Modules\Core\Cart\Services\
|
||||||
|
* CartService::addLine()'s own $meta parameter), not a new table, since
|
||||||
|
* this is small, rarely-queried per-product config, the same reasoning
|
||||||
|
* ShippingMethod.data/PaymentMethod.data already follow for their own
|
||||||
|
* per-row settings.
|
||||||
|
*/
|
||||||
|
return new class extends Migration
|
||||||
|
{
|
||||||
|
public function up(): void
|
||||||
|
{
|
||||||
|
Schema::table(config('lunar.database.table_prefix').'products', function (Blueprint $table) {
|
||||||
|
$table->json('custom_fields')->nullable()->after('attribute_data');
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
public function down(): void
|
||||||
|
{
|
||||||
|
Schema::table(config('lunar.database.table_prefix').'products', function (Blueprint $table) {
|
||||||
|
$table->dropColumn('custom_fields');
|
||||||
|
});
|
||||||
|
}
|
||||||
|
};
|
||||||
+10
-2
@@ -49,7 +49,8 @@ boboko-test/
|
|||||||
app/
|
app/
|
||||||
Models/
|
Models/
|
||||||
Customer.php ← app-level model, extends Modules\Core\Customer\Models\Customer
|
Customer.php ← app-level model, extends Modules\Core\Customer\Models\Customer
|
||||||
User.php ← app-level model, dispatches Modules\Core\Auth\Events\UserCreated
|
User.php ← app-level model, no $dispatchesEvents needed — core dispatches
|
||||||
|
UserCreated itself (Modules\Core\Auth\Services\UserOtpService)
|
||||||
Staff.php ← app-level model, extends Modules\Core\Auth\Models\Staff
|
Staff.php ← app-level model, extends Modules\Core\Auth\Models\Staff
|
||||||
Lunar/
|
Lunar/
|
||||||
Extensions/ ← app's own Filament resource extensions (source of truth, wired in PanelServiceProvider)
|
Extensions/ ← app's own Filament resource extensions (source of truth, wired in PanelServiceProvider)
|
||||||
@@ -264,7 +265,14 @@ php artisan vendor:publish --tag=core-config
|
|||||||
'auto_create_customer_for_user' => false,
|
'auto_create_customer_for_user' => false,
|
||||||
```
|
```
|
||||||
|
|
||||||
Both listeners guard against the other direction re-triggering: they call `User::withoutEvents(...)` around `firstOrCreate`/save, so pairing a `Customer` never spuriously fires `UserCreated` (and vice versa) even if both directions are somehow active at once.
|
A guard against the other direction re-triggering is only needed where a real risk exists:
|
||||||
|
`App\Listeners\CreateUserForCustomerListener` (`boboko-test`, app-level) wraps its
|
||||||
|
`firstOrCreate` in `User::withoutEvents(...)`, since finding-or-creating a `User` there could
|
||||||
|
itself fire `UserCreated` and loop back into `CreateCustomerForUser`. `Modules\Core\Customer\
|
||||||
|
Listeners\CreateCustomerForUser` (core) needs no such guard — it calls a plain
|
||||||
|
`$model::create([])` on `Customer`, which has no `$dispatchesEvents`/model hooks of its own in
|
||||||
|
core that could re-trigger anything; the guard belongs only on the side that actually creates a
|
||||||
|
`User`.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
+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
|
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.
|
answer "which order/cart does gateway reference X belong to?" between the two calls.
|
||||||
|
|
||||||
**Read directly from `lunarphp/stripe`'s own source** (`StripePaymentType::authorize()`,
|
The precedent for this originally came from reading `lunarphp/stripe`'s own source
|
||||||
`ProcessStripeWebhook`, `WebhookController`) to see how Lunar itself solves this — confirmed
|
(`StripePaymentType::authorize()`, `ProcessStripeWebhook`, `WebhookController`) — that package
|
||||||
it does **not** stash a generic opaque blob. It writes the correlating ids as real, typed
|
solved this the same way, writing the correlating ids as real, typed columns on its own
|
||||||
columns on `Lunar\Stripe\Models\StripePaymentIntent` (`cart_id`, `order_id`) at the moment the
|
`StripePaymentIntent` model rather than a generic opaque blob. **`lunarphp/stripe` has since
|
||||||
intent is created/first seen, then reads them back the same way when the webhook arrives:
|
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
|
**`StripePaymentDriver` follows this pattern**: it reads `cart_id`/`order_id` out of `$context`
|
||||||
// ProcessStripeWebhook::handle() — falls back through two real lookups,
|
at `pay()`/`authorize()` time and writes them onto its own `StripePaymentIntent` row (`src/
|
||||||
// neither of them a generic context blob:
|
Payment/Models/StripePaymentIntent.php`, table `stripe_payment_intents`), then reads them back
|
||||||
$cart = StripePaymentIntent::where('intent_id', $this->paymentIntentId)->first()?->cart
|
the same way in `handleCallback()`. No generic `context` json column beyond what that table
|
||||||
?: Cart::where('meta->payment_intent', '=', $this->paymentIntentId)->first();
|
already carries (`context`, added for a different purpose — see that migration's own
|
||||||
```
|
docblock), no new table.
|
||||||
|
|
||||||
**`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.
|
|
||||||
|
|
||||||
### This pattern is per-driver, not a shared 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
|
## Explicitly out of scope for this pass
|
||||||
|
|
||||||
- **`Checkout`/`Order` wiring** — how `Checkout` calls into `Payment`, how `Order`/`Checkout`
|
- **`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.
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Greek translations for Lunar\Models\Country::name, keyed by the exact
|
||||||
|
* English spelling Lunar's own installer seeds (`lunar:import:address-data`
|
||||||
|
* fetches http://data.lunarphp.io/countries+states.json — see
|
||||||
|
* vendor/lunarphp/core/src/Console/Commands/Import/AddressData.php).
|
||||||
|
* `Country`/`State` have no i18n support of their own (plain string
|
||||||
|
* columns, no translatable trait) — this is a plain Laravel lang file, not
|
||||||
|
* Modules\Core\Localization's DB-backed TranslationService, since these
|
||||||
|
* names are fixed reference data seeded once, not editable UI copy (see
|
||||||
|
* docs/localization.md). A consuming app's storefront looks this up
|
||||||
|
* itself, e.g. __('core::countries.'.$country->name) — core has no
|
||||||
|
* storefront UI of its own to wire this into (see docs/lunar.md).
|
||||||
|
*
|
||||||
|
* Only Greece is covered — this store operates within Greece; add further
|
||||||
|
* countries here as needed.
|
||||||
|
*/
|
||||||
|
return [
|
||||||
|
'Greece' => 'Ελλάδα',
|
||||||
|
];
|
||||||
@@ -0,0 +1,52 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Greek translations for Lunar\Models\State::name, keyed by the exact
|
||||||
|
* English spelling Lunar's own installer seeds for Greece
|
||||||
|
* (`lunar:import:address-data` — see lang/el/countries.php's own docblock
|
||||||
|
* for the full explanation of why this is a plain lang file, not
|
||||||
|
* Modules\Core\Localization's TranslationService).
|
||||||
|
*
|
||||||
|
* Covers every Greek state/regional-unit row in Lunar's seed dataset —
|
||||||
|
* scoped to Greece only, matching this store's operating country.
|
||||||
|
*/
|
||||||
|
return [
|
||||||
|
'Achaea Regional Unit' => 'Περιφερειακή Ενότητα Αχαΐας',
|
||||||
|
'Aetolia-Acarnania Regional Unit' => 'Περιφερειακή Ενότητα Αιτωλοακαρνανίας',
|
||||||
|
'Arcadia Prefecture' => 'Νομός Αρκαδίας',
|
||||||
|
'Argolis Regional Unit' => 'Περιφερειακή Ενότητα Αργολίδας',
|
||||||
|
'Attica Region' => 'Περιφέρεια Αττικής',
|
||||||
|
'Boeotia Regional Unit' => 'Περιφερειακή Ενότητα Βοιωτίας',
|
||||||
|
'Central Greece Region' => 'Περιφέρεια Στερεάς Ελλάδας',
|
||||||
|
'Central Macedonia' => 'Κεντρική Μακεδονία',
|
||||||
|
'Chania Regional Unit' => 'Περιφερειακή Ενότητα Χανίων',
|
||||||
|
'Corfu Prefecture' => 'Νομός Κέρκυρας',
|
||||||
|
'Corinthia Regional Unit' => 'Περιφερειακή Ενότητα Κορινθίας',
|
||||||
|
'Crete Region' => 'Περιφέρεια Κρήτης',
|
||||||
|
'Drama Regional Unit' => 'Περιφερειακή Ενότητα Δράμας',
|
||||||
|
'East Attica Regional Unit' => 'Περιφερειακή Ενότητα Ανατολικής Αττικής',
|
||||||
|
'East Macedonia and Thrace' => 'Ανατολική Μακεδονία και Θράκη',
|
||||||
|
'Epirus Region' => 'Περιφέρεια Ηπείρου',
|
||||||
|
'Euboea' => 'Εύβοια',
|
||||||
|
'Grevena Prefecture' => 'Νομός Γρεβενών',
|
||||||
|
'Imathia Regional Unit' => 'Περιφερειακή Ενότητα Ημαθίας',
|
||||||
|
'Ioannina Regional Unit' => 'Περιφερειακή Ενότητα Ιωαννίνων',
|
||||||
|
'Ionian Islands Region' => 'Περιφέρεια Ιονίων Νήσων',
|
||||||
|
'Karditsa Regional Unit' => 'Περιφερειακή Ενότητα Καρδίτσας',
|
||||||
|
'Kastoria Regional Unit' => 'Περιφερειακή Ενότητα Καστοριάς',
|
||||||
|
'Kefalonia Prefecture' => 'Νομός Κεφαλληνίας',
|
||||||
|
'Kilkis Regional Unit' => 'Περιφερειακή Ενότητα Κιλκίς',
|
||||||
|
'Kozani Prefecture' => 'Νομός Κοζάνης',
|
||||||
|
'Laconia' => 'Λακωνία',
|
||||||
|
'Larissa Prefecture' => 'Νομός Λάρισας',
|
||||||
|
'Lefkada Regional Unit' => 'Περιφερειακή Ενότητα Λευκάδας',
|
||||||
|
'Pella Regional Unit' => 'Περιφερειακή Ενότητα Πέλλας',
|
||||||
|
'Peloponnese Region' => 'Περιφέρεια Πελοποννήσου',
|
||||||
|
'Phthiotis Prefecture' => 'Νομός Φθιώτιδας',
|
||||||
|
'Preveza Prefecture' => 'Νομός Πρέβεζας',
|
||||||
|
'Serres Prefecture' => 'Νομός Σερρών',
|
||||||
|
'South Aegean' => 'Νότιο Αιγαίο',
|
||||||
|
'Thessaloniki Regional Unit' => 'Περιφερειακή Ενότητα Θεσσαλονίκης',
|
||||||
|
'West Greece Region' => 'Περιφέρεια Δυτικής Ελλάδας',
|
||||||
|
'West Macedonia Region' => 'Περιφέρεια Δυτικής Μακεδονίας',
|
||||||
|
];
|
||||||
@@ -1,5 +1,5 @@
|
|||||||
<p>Hi {{ $name }},</p>
|
<p>Hi {{ $name }},</p>
|
||||||
|
|
||||||
<p>Your login code is:</p>
|
<p>{{ $intro }}</p>
|
||||||
|
|
||||||
<p style="font-size: 2rem; font-weight: bold; letter-spacing: 0.25rem;">{{ $code }}</p>
|
<p style="font-size: 2rem; font-weight: bold; letter-spacing: 0.25rem;">{{ $code }}</p>
|
||||||
@@ -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,
|
||||||
|
) {}
|
||||||
|
}
|
||||||
@@ -6,20 +6,47 @@ use Illuminate\Mail\Mailable;
|
|||||||
use Illuminate\Mail\Mailables\Content;
|
use Illuminate\Mail\Mailables\Content;
|
||||||
use Illuminate\Mail\Mailables\Envelope;
|
use Illuminate\Mail\Mailables\Envelope;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The one OTP email template for every use of Auth\Services\OtpService —
|
||||||
|
* not just admin login. A code confirming a destructive Artisan command
|
||||||
|
* (e.g. Command\WipeCatalogCommand) reuses the exact same generation/
|
||||||
|
* validation mechanism as login, but "Your login code" as the subject
|
||||||
|
* would be actively misleading for that — the recipient never initiated a
|
||||||
|
* login. $purpose is a small, fixed set of known keys (see
|
||||||
|
* COPY_BY_PURPOSE), not free text — a typo'd/unknown purpose falls back
|
||||||
|
* to 'login' rather than rendering a blank subject/intro.
|
||||||
|
*/
|
||||||
class OtpMail extends Mailable
|
class OtpMail extends Mailable
|
||||||
{
|
{
|
||||||
|
private const COPY_BY_PURPOSE = [
|
||||||
|
'login' => [
|
||||||
|
'subject' => 'Your login code',
|
||||||
|
'intro' => 'Your login code is:',
|
||||||
|
],
|
||||||
|
'wipe-catalog' => [
|
||||||
|
'subject' => 'Confirm: Wipe Catalog',
|
||||||
|
'intro' => 'Someone requested to permanently delete every product in the catalog. If this was you, enter this code to confirm:',
|
||||||
|
],
|
||||||
|
];
|
||||||
|
|
||||||
public function __construct(
|
public function __construct(
|
||||||
public readonly string $name,
|
public readonly string $name,
|
||||||
public readonly string $code,
|
public readonly string $code,
|
||||||
|
public readonly string $purpose = 'login',
|
||||||
) {}
|
) {}
|
||||||
|
|
||||||
public function envelope(): Envelope
|
public function envelope(): Envelope
|
||||||
{
|
{
|
||||||
return new Envelope(subject: 'Your login code');
|
return new Envelope(subject: $this->copy()['subject']);
|
||||||
}
|
}
|
||||||
|
|
||||||
public function content(): Content
|
public function content(): Content
|
||||||
{
|
{
|
||||||
return new Content(view: 'core::auth.mail.otp');
|
return new Content(view: 'core::auth.mail.otp', with: ['intro' => $this->copy()['intro']]);
|
||||||
|
}
|
||||||
|
|
||||||
|
private function copy(): array
|
||||||
|
{
|
||||||
|
return self::COPY_BY_PURPOSE[$this->purpose] ?? self::COPY_BY_PURPOSE['login'];
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -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);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -11,7 +11,13 @@ class OtpService
|
|||||||
private const EXPIRY_MINUTES = 10;
|
private const EXPIRY_MINUTES = 10;
|
||||||
private const CODE_LENGTH = 6;
|
private const CODE_LENGTH = 6;
|
||||||
|
|
||||||
public function generateAndSend(string $email): bool
|
/**
|
||||||
|
* $purpose is forwarded as-is to OtpMail, which only recognizes a
|
||||||
|
* fixed set of keys (see its own COPY_BY_PURPOSE) — an unrecognized
|
||||||
|
* value there just falls back to 'login' rather than failing here, so
|
||||||
|
* this method has nothing of its own to validate.
|
||||||
|
*/
|
||||||
|
public function generateAndSend(string $email, string $purpose = 'login'): bool
|
||||||
{
|
{
|
||||||
$staff = Staff::where('email', $email)->first();
|
$staff = Staff::where('email', $email)->first();
|
||||||
|
|
||||||
@@ -25,7 +31,7 @@ class OtpService
|
|||||||
$staff->otp_expires_at = now()->addMinutes(self::EXPIRY_MINUTES);
|
$staff->otp_expires_at = now()->addMinutes(self::EXPIRY_MINUTES);
|
||||||
$staff->save();
|
$staff->save();
|
||||||
|
|
||||||
Mail::to($staff->email)->send(new OtpMail($staff->first_name, $code));
|
Mail::to($staff->email)->send(new OtpMail($staff->first_name, $code, $purpose));
|
||||||
|
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -5,10 +5,12 @@ namespace Modules\Core\Auth\Services;
|
|||||||
use Illuminate\Contracts\Auth\Authenticatable;
|
use Illuminate\Contracts\Auth\Authenticatable;
|
||||||
use Illuminate\Http\Request;
|
use Illuminate\Http\Request;
|
||||||
use Illuminate\Support\Facades\Auth;
|
use Illuminate\Support\Facades\Auth;
|
||||||
|
use Illuminate\Support\Facades\DB;
|
||||||
use Illuminate\Support\Facades\Event;
|
use Illuminate\Support\Facades\Event;
|
||||||
use Illuminate\Support\Facades\Mail;
|
use Illuminate\Support\Facades\Mail;
|
||||||
use Illuminate\Support\Facades\RateLimiter;
|
use Illuminate\Support\Facades\RateLimiter;
|
||||||
use Modules\Core\Auth\Events\CustomerLoggedIn;
|
use Modules\Core\Auth\Events\UserAuthenticated;
|
||||||
|
use Modules\Core\Auth\Events\UserCreated;
|
||||||
use Modules\Core\Auth\Exceptions\OtpThrottledException;
|
use Modules\Core\Auth\Exceptions\OtpThrottledException;
|
||||||
use Modules\Core\Auth\Mail\UserOtpMail;
|
use Modules\Core\Auth\Mail\UserOtpMail;
|
||||||
|
|
||||||
@@ -74,6 +76,18 @@ class UserOtpService
|
|||||||
$model = config('auth.providers.users.model');
|
$model = config('auth.providers.users.model');
|
||||||
$user = $model::firstOrCreate(['email' => $email]);
|
$user = $model::firstOrCreate(['email' => $email]);
|
||||||
|
|
||||||
|
// wasRecentlyCreated is Eloquent's own "did firstOrCreate() just
|
||||||
|
// INSERT, or did it find an existing row" flag — the only reliable
|
||||||
|
// way to tell them apart from firstOrCreate()'s return value alone.
|
||||||
|
// Without this check, a genuinely new signup never fired
|
||||||
|
// UserCreated at all (this class's own docblock claimed the
|
||||||
|
// Customer/User pairing cascade "already triggers" here, which was
|
||||||
|
// false as written — see Modules\Core\Customer\Listeners\
|
||||||
|
// CreateCustomerForUser, which depends entirely on this event).
|
||||||
|
if ($user->wasRecentlyCreated) {
|
||||||
|
Event::dispatch(new UserCreated($user));
|
||||||
|
}
|
||||||
|
|
||||||
$code = str_pad((string) random_int(0, 999999), self::CODE_LENGTH, '0', STR_PAD_LEFT);
|
$code = str_pad((string) random_int(0, 999999), self::CODE_LENGTH, '0', STR_PAD_LEFT);
|
||||||
|
|
||||||
$user->otp_code = $code;
|
$user->otp_code = $code;
|
||||||
@@ -97,40 +111,55 @@ class UserOtpService
|
|||||||
public function validate(string $email, string $code, ?Request $request = null): ?Authenticatable
|
public function validate(string $email, string $code, ?Request $request = null): ?Authenticatable
|
||||||
{
|
{
|
||||||
$model = config('auth.providers.users.model');
|
$model = config('auth.providers.users.model');
|
||||||
$user = $model::where('email', $email)->first();
|
|
||||||
|
|
||||||
if (! $user || ! $user->otp_expires_at || now()->isAfter($user->otp_expires_at)) {
|
// lockForUpdate() + a transaction make the read-check-increment-save
|
||||||
return null;
|
// below atomic across concurrent requests for the same user — without
|
||||||
}
|
// it, two guesses fired in parallel can each read the same
|
||||||
|
// pre-increment otp_attempts value and both save past
|
||||||
|
// max_attempts, letting an attacker exceed the lockout by
|
||||||
|
// parallelizing requests instead of sending them serially.
|
||||||
|
$result = DB::transaction(function () use ($model, $email, $code) {
|
||||||
|
$user = $model::where('email', $email)->lockForUpdate()->first();
|
||||||
|
|
||||||
if ($user->otp_code != $code) {
|
if (! $user || ! $user->otp_expires_at || now()->isAfter($user->otp_expires_at)) {
|
||||||
$user->otp_attempts++;
|
return null;
|
||||||
|
|
||||||
if ($user->otp_attempts >= (int) config('core.auth.otp.max_attempts', 5)) {
|
|
||||||
$user->otp_code = null;
|
|
||||||
$user->otp_expires_at = null;
|
|
||||||
$user->otp_attempts = 0;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (! hash_equals((string) $user->otp_code, $code)) {
|
||||||
|
$user->otp_attempts++;
|
||||||
|
|
||||||
|
if ($user->otp_attempts >= (int) config('core.auth.otp.max_attempts', 5)) {
|
||||||
|
$user->otp_code = null;
|
||||||
|
$user->otp_expires_at = null;
|
||||||
|
$user->otp_attempts = 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
$user->save();
|
||||||
|
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
$user->otp_code = null;
|
||||||
|
$user->otp_expires_at = null;
|
||||||
|
$user->otp_attempts = 0;
|
||||||
$user->save();
|
$user->save();
|
||||||
|
|
||||||
|
return $user;
|
||||||
|
});
|
||||||
|
|
||||||
|
if (! $result) {
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
$user->otp_code = null;
|
|
||||||
$user->otp_expires_at = null;
|
|
||||||
$user->otp_attempts = 0;
|
|
||||||
$user->save();
|
|
||||||
|
|
||||||
RateLimiter::clear($this->generationLimiterKey($email));
|
RateLimiter::clear($this->generationLimiterKey($email));
|
||||||
|
|
||||||
Auth::login($user);
|
Auth::login($result);
|
||||||
|
|
||||||
$this->sessions->record($user, $request);
|
$this->sessions->record($result, $request);
|
||||||
|
|
||||||
Event::dispatch(new CustomerLoggedIn($user));
|
Event::dispatch(new UserAuthenticated($result));
|
||||||
|
|
||||||
return $user;
|
return $result;
|
||||||
}
|
}
|
||||||
|
|
||||||
private function generationLimiterKey(string $email): string
|
private function generationLimiterKey(string $email): string
|
||||||
|
|||||||
@@ -14,6 +14,7 @@ use Illuminate\Database\Eloquent\Collection as EloquentCollection;
|
|||||||
use Illuminate\Support\Facades\Blade;
|
use Illuminate\Support\Facades\Blade;
|
||||||
use Lunar\Admin\Filament\Resources\CustomerResource;
|
use Lunar\Admin\Filament\Resources\CustomerResource;
|
||||||
use Lunar\Admin\Filament\Resources\ProductResource\Pages\EditProduct;
|
use Lunar\Admin\Filament\Resources\ProductResource\Pages\EditProduct;
|
||||||
|
use Lunar\Exceptions\MissingCurrencyPriceException;
|
||||||
use Lunar\Models\Cart;
|
use Lunar\Models\Cart;
|
||||||
use Lunar\Models\CartLine;
|
use Lunar\Models\CartLine;
|
||||||
use Lunar\Models\ProductVariant;
|
use Lunar\Models\ProductVariant;
|
||||||
@@ -47,6 +48,17 @@ class ViewCart extends ViewRecord
|
|||||||
* own OrderItemsTable loads for an order's line items (`with(['purchasable'])`,
|
* own OrderItemsTable loads for an order's line items (`with(['purchasable'])`,
|
||||||
* see vendor/lunarphp/lunar/.../OrderItemsTable::getDefaultTable()) — so
|
* see vendor/lunarphp/lunar/.../OrderItemsTable::getDefaultTable()) — so
|
||||||
* rendering the product grid doesn't N+1 per line.
|
* rendering the product grid doesn't N+1 per line.
|
||||||
|
*
|
||||||
|
* calculate() throws Lunar\Exceptions\MissingCurrencyPriceException
|
||||||
|
* (vendor PricingManager) the moment ANY line's purchasable has no
|
||||||
|
* price row for the cart's currency — including a line whose
|
||||||
|
* purchasable no longer exists at all (a deleted ProductVariant still
|
||||||
|
* referenced by cart_lines.purchasable_id), which 500'd this whole
|
||||||
|
* page rather than just leaving that one line unpriced. The Lines
|
||||||
|
* section below already guards every purchasable-derived field with
|
||||||
|
* `instanceof ProductVariant` and renders fine with $cart left
|
||||||
|
* uncalculated — subTotal/total/etc. simply won't be populated, which
|
||||||
|
* reads as a stale/pending state rather than a broken page.
|
||||||
*/
|
*/
|
||||||
protected function resolveRecord(int|string $key): Cart
|
protected function resolveRecord(int|string $key): Cart
|
||||||
{
|
{
|
||||||
@@ -58,7 +70,11 @@ class ViewCart extends ViewRecord
|
|||||||
EloquentCollection::make($cart->lines->pluck('purchasable')->filter(fn ($p) => $p instanceof ProductVariant))
|
EloquentCollection::make($cart->lines->pluck('purchasable')->filter(fn ($p) => $p instanceof ProductVariant))
|
||||||
->loadMissing(['product.thumbnail', 'images', 'values']);
|
->loadMissing(['product.thumbnail', 'images', 'values']);
|
||||||
|
|
||||||
return $cart->calculate();
|
try {
|
||||||
|
return $cart->calculate();
|
||||||
|
} catch (MissingCurrencyPriceException) {
|
||||||
|
return $cart;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
public function infolist(Schema $schema): Schema
|
public function infolist(Schema $schema): Schema
|
||||||
|
|||||||
@@ -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));
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -14,6 +14,7 @@ enum ProductSort: string
|
|||||||
case PriceAsc = 'price_asc';
|
case PriceAsc = 'price_asc';
|
||||||
case PriceDesc = 'price_desc';
|
case PriceDesc = 'price_desc';
|
||||||
case Newest = 'newest';
|
case Newest = 'newest';
|
||||||
|
case Popularity = 'popularity';
|
||||||
|
|
||||||
public function toMeilisearchSort(): string
|
public function toMeilisearchSort(): string
|
||||||
{
|
{
|
||||||
@@ -21,6 +22,12 @@ enum ProductSort: string
|
|||||||
self::PriceAsc => 'price:asc',
|
self::PriceAsc => 'price:asc',
|
||||||
self::PriceDesc => 'price:desc',
|
self::PriceDesc => 'price:desc',
|
||||||
self::Newest => 'created_at:desc',
|
self::Newest => 'created_at:desc',
|
||||||
|
// order_count — see Modules\Core\Catalog\Services\
|
||||||
|
// ProductIndexer::toSearchableArray()'s own docblock: the same
|
||||||
|
// trailing-year, physical-order-line-count definition Lunar's
|
||||||
|
// own admin dashboard "Popular Products" widget already uses,
|
||||||
|
// aggregated per product rather than per variant.
|
||||||
|
self::Popularity => 'order_count:desc',
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,11 +2,17 @@
|
|||||||
|
|
||||||
namespace Modules\Core\Catalog\Listeners;
|
namespace Modules\Core\Catalog\Listeners;
|
||||||
|
|
||||||
|
use Illuminate\Contracts\Queue\ShouldQueue;
|
||||||
use Lunar\Models\Product;
|
use Lunar\Models\Product;
|
||||||
use Modules\Core\Catalog\Events\ProductDeleted;
|
use Modules\Core\Catalog\Events\ProductDeleted;
|
||||||
use Modules\Core\Catalog\Events\ProductSaved;
|
use Modules\Core\Catalog\Events\ProductSaved;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* Queued — a Meilisearch filter query plus N reindex calls with no
|
||||||
|
* same-request reader; a few seconds of stale `recommendations` on a
|
||||||
|
* referencing product's storefront page is a cosmetic, not correctness,
|
||||||
|
* concern (see the class's own docblock below).
|
||||||
|
*
|
||||||
* Keeps every product's embedded `recommendations` field (see
|
* Keeps every product's embedded `recommendations` field (see
|
||||||
* ProductIndexer) in sync when a product they recommend changes or is
|
* ProductIndexer) in sync when a product they recommend changes or is
|
||||||
* removed. Unlike Modules\Core\Catalog\Observers\ProductOptionReindexObserver's
|
* removed. Unlike Modules\Core\Catalog\Observers\ProductOptionReindexObserver's
|
||||||
@@ -27,7 +33,7 @@ use Modules\Core\Catalog\Events\ProductSaved;
|
|||||||
* SCOUT_QUEUE is configured) reindex job per matched product — this
|
* SCOUT_QUEUE is configured) reindex job per matched product — this
|
||||||
* listener itself does no synchronous Meilisearch writing.
|
* listener itself does no synchronous Meilisearch writing.
|
||||||
*/
|
*/
|
||||||
class ReindexProductsRecommendingProduct
|
class ReindexProductsRecommendingProduct implements ShouldQueue
|
||||||
{
|
{
|
||||||
public function handleSaved(ProductSaved $event): void
|
public function handleSaved(ProductSaved $event): void
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -0,0 +1,52 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Modules\Core\Catalog\Models;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registered via Lunar\Facades\ModelManifest::replace(Lunar\Models\
|
||||||
|
* Product::class, self::class) — see Providers\CatalogServiceProvider —
|
||||||
|
* purely to add a cast AND fillable entry for `custom_fields` (see the
|
||||||
|
* migration adding that column: database/migrations/
|
||||||
|
* ..._add_custom_fields_to_products_table.php). Without the fillable
|
||||||
|
* entry, Lunar\Models\Product's own $fillable allowlist (attribute_data,
|
||||||
|
* product_type_id, status, brand_id — custom_fields isn't in it) silently
|
||||||
|
* drops the field on every mass-assignment save (Filament's own
|
||||||
|
* $record->update($data)) — no error, no exception, the admin form shows
|
||||||
|
* the repeater's rows as saved right up until the next page load, when
|
||||||
|
* they're simply gone. Caught in practice.
|
||||||
|
*
|
||||||
|
* ModelManifest::replace() only changes what code resolving Product
|
||||||
|
* through the CONTRACT (app(Contracts\Product::class), Filament's own
|
||||||
|
* ProductResource — its $model is ProductContract::class, not the
|
||||||
|
* concrete class) or the morph map receives — it does NOT retroactively
|
||||||
|
* change what a hardcoded `Lunar\Models\Product::query()`/`::find()`
|
||||||
|
* elsewhere in this codebase (or Lunar's own internals, e.g. the
|
||||||
|
* scheduled Meilisearch reindex command — see CatalogServiceProvider,
|
||||||
|
* which references this subclass by name specifically so that path picks
|
||||||
|
* it up too) resolves to. Most of this codebase's existing Product
|
||||||
|
* references are plain type-hints (they accept whichever instance is
|
||||||
|
* handed to them, subclass included) or don't touch `custom_fields` at
|
||||||
|
* all, so they're unaffected either way.
|
||||||
|
*/
|
||||||
|
class Product extends \Lunar\Models\Product
|
||||||
|
{
|
||||||
|
// NOT `protected $casts = [...]` — that property assignment REPLACES
|
||||||
|
// the parent's own $casts array wholesale rather than merging with
|
||||||
|
// it (PHP class property redeclaration has no merge semantics), which
|
||||||
|
// would silently drop every cast Lunar\Models\Product already
|
||||||
|
// defines (attribute_data, status, etc.). mergeCasts() is Eloquent's
|
||||||
|
// own documented mechanism for a subclass adding to, not replacing,
|
||||||
|
// its parent's casts.
|
||||||
|
public function __construct(array $attributes = [])
|
||||||
|
{
|
||||||
|
parent::__construct($attributes);
|
||||||
|
|
||||||
|
$this->mergeCasts([
|
||||||
|
'custom_fields' => 'array',
|
||||||
|
]);
|
||||||
|
|
||||||
|
$this->mergeFillable([
|
||||||
|
'custom_fields',
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -5,6 +5,7 @@ namespace Modules\Core\Catalog\Services;
|
|||||||
use Illuminate\Database\Eloquent\Builder;
|
use Illuminate\Database\Eloquent\Builder;
|
||||||
use Illuminate\Database\Eloquent\Model;
|
use Illuminate\Database\Eloquent\Model;
|
||||||
use Lunar\Models\Currency;
|
use Lunar\Models\Currency;
|
||||||
|
use Lunar\Models\OrderLine;
|
||||||
use Lunar\Models\Price;
|
use Lunar\Models\Price;
|
||||||
use Lunar\Models\Product;
|
use Lunar\Models\Product;
|
||||||
use Lunar\Models\ProductVariant;
|
use Lunar\Models\ProductVariant;
|
||||||
@@ -103,6 +104,7 @@ class ProductIndexer extends BaseProductIndexer
|
|||||||
return [
|
return [
|
||||||
...parent::getSortableFields(),
|
...parent::getSortableFields(),
|
||||||
'price',
|
'price',
|
||||||
|
'order_count',
|
||||||
];
|
];
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -139,6 +141,12 @@ class ProductIndexer extends BaseProductIndexer
|
|||||||
->all();
|
->all();
|
||||||
$data['slugs'] = $model->urls->pluck('slug')->unique()->values()->all();
|
$data['slugs'] = $model->urls->pluck('slug')->unique()->values()->all();
|
||||||
$data['skus'] = $model->variants->pluck('sku')->filter()->unique()->values()->all();
|
$data['skus'] = $model->variants->pluck('sku')->filter()->unique()->values()->all();
|
||||||
|
// Only decoded correctly when $model is an instance of
|
||||||
|
// Modules\Core\Catalog\Models\Product (the custom_fields cast
|
||||||
|
// lives there, not on the base Lunar\Models\Product) — see
|
||||||
|
// CatalogServiceProvider's own comment on why the scheduled
|
||||||
|
// reindex command references that subclass by name specifically.
|
||||||
|
$data['custom_fields'] = $model->custom_fields ?? [];
|
||||||
$data['tags'] = $model->tags->pluck('value')->all();
|
$data['tags'] = $model->tags->pluck('value')->all();
|
||||||
$data['media'] = $model->media->map(fn (Media $media) => $this->mapMedia($media))->all();
|
$data['media'] = $model->media->map(fn (Media $media) => $this->mapMedia($media))->all();
|
||||||
$data['variants'] = $model->variants->map(fn (ProductVariant $variant) => $this->mapVariant($variant, $currency))->all();
|
$data['variants'] = $model->variants->map(fn (ProductVariant $variant) => $this->mapVariant($variant, $currency))->all();
|
||||||
@@ -155,6 +163,24 @@ class ProductIndexer extends BaseProductIndexer
|
|||||||
$data['in_stock'] = $model->variants->contains(
|
$data['in_stock'] = $model->variants->contains(
|
||||||
fn (ProductVariant $variant) => $variant->canBeFulfilledAtQuantity(1)
|
fn (ProductVariant $variant) => $variant->canBeFulfilledAtQuantity(1)
|
||||||
);
|
);
|
||||||
|
// Same "popular" definition as Lunar's own admin dashboard widget
|
||||||
|
// (Lunar\Admin\Filament\Widgets\Dashboard\Orders\
|
||||||
|
// PopularProductsTable) — order-line COUNT, not summed quantity,
|
||||||
|
// over the trailing year, physical lines only — just aggregated
|
||||||
|
// per PRODUCT here (across all its variants) rather than per
|
||||||
|
// variant/identifier, since a storefront "sort by popularity"
|
||||||
|
// ranks products, not individual variant SKUs. Necessarily as
|
||||||
|
// stale as any other reindex-time field here (in_stock, price) —
|
||||||
|
// there's no live equivalent without a query per page load.
|
||||||
|
$data['order_count'] = OrderLine::query()
|
||||||
|
->whereIn('purchasable_id', $model->variants->pluck('id'))
|
||||||
|
->where('purchasable_type', 'product_variant')
|
||||||
|
->where('type', 'physical')
|
||||||
|
->whereHas('order', fn ($query) => $query->whereBetween('placed_at', [
|
||||||
|
now()->subYear()->startOfDay(),
|
||||||
|
now()->endOfDay(),
|
||||||
|
]))
|
||||||
|
->count();
|
||||||
$data['recommendations'] = app(RecommendationService::class)
|
$data['recommendations'] = app(RecommendationService::class)
|
||||||
->recommend($model)
|
->recommend($model)
|
||||||
->load(['media', 'variants.prices'])
|
->load(['media', 'variants.prices'])
|
||||||
|
|||||||
@@ -254,7 +254,10 @@ class ProductService
|
|||||||
public function random(int $limit): array
|
public function random(int $limit): array
|
||||||
{
|
{
|
||||||
$raw = Product::search('')
|
$raw = Product::search('')
|
||||||
->options(['attributesToRetrieve' => ['id']])
|
->options([
|
||||||
|
'attributesToRetrieve' => ['id'],
|
||||||
|
'filter' => $this->filterBuilder->withVisibility(),
|
||||||
|
])
|
||||||
->raw();
|
->raw();
|
||||||
|
|
||||||
$ids = collect($raw['hits'] ?? [])->pluck('id')->shuffle()->take($limit)->values();
|
$ids = collect($raw['hits'] ?? [])->pluck('id')->shuffle()->take($limit)->values();
|
||||||
@@ -287,7 +290,7 @@ class ProductService
|
|||||||
private function findAllWhere(string $filter, int $limit = 1000): array
|
private function findAllWhere(string $filter, int $limit = 1000): array
|
||||||
{
|
{
|
||||||
$paginator = Product::search('')
|
$paginator = Product::search('')
|
||||||
->options(['filter' => $filter])
|
->options(['filter' => $this->filterBuilder->withVisibility($filter)])
|
||||||
->paginateRaw(perPage: $limit, page: 1);
|
->paginateRaw(perPage: $limit, page: 1);
|
||||||
|
|
||||||
return collect($this->localizer->hitsFrom($paginator))
|
return collect($this->localizer->hitsFrom($paginator))
|
||||||
|
|||||||
@@ -0,0 +1,57 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Modules\Core\Catalog\Services;
|
||||||
|
|
||||||
|
use Lunar\Models\ProductVariant;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Generates a SKU for every ProductVariant missing one — extracted out of
|
||||||
|
* Command\BackfillMissingSkusCommand (which becomes a thin CLI wrapper
|
||||||
|
* around this, keeping --dry-run/progress-bar concerns out of the
|
||||||
|
* reusable logic) so MigrateImport\Shopify\Services\ShopifyExportImporter can
|
||||||
|
* also call it directly, once every product job in its import batch has
|
||||||
|
* finished (see that class's own import()), with no CLI concerns at all.
|
||||||
|
*
|
||||||
|
* Format is "SKU-P{product_id}-V{variant_id}": deterministic and
|
||||||
|
* guaranteed unique without a uniqueness check, since product_id/
|
||||||
|
* variant_id already are. Only variants with a null `sku` are touched —
|
||||||
|
* not an importer bug when one shows up after a Shopify import, the
|
||||||
|
* source CSV rows genuinely had no `Variant SKU` value (see
|
||||||
|
* MigrateImport\Shopify\Services\ShopifyExportImporter).
|
||||||
|
*/
|
||||||
|
class SkuBackfillService
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* @param ?callable(ProductVariant, string): void $onEach invoked
|
||||||
|
* once per variant with the sku about to be written (or, when
|
||||||
|
* $dryRun is true, that WOULD be written) — the command's own
|
||||||
|
* --dry-run listing and progress bar hook in here without this
|
||||||
|
* service knowing anything about console output.
|
||||||
|
* @return int the number of variants processed
|
||||||
|
*/
|
||||||
|
public function backfill(bool $dryRun = false, ?callable $onEach = null): int
|
||||||
|
{
|
||||||
|
$query = ProductVariant::query()->whereNull('sku');
|
||||||
|
$total = $query->count();
|
||||||
|
|
||||||
|
if ($total === 0) {
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
$query->chunkById(500, function ($variants) use ($dryRun, $onEach) {
|
||||||
|
foreach ($variants as $variant) {
|
||||||
|
$sku = "SKU-P{$variant->product_id}-V{$variant->id}";
|
||||||
|
|
||||||
|
if (! $dryRun) {
|
||||||
|
$variant->update(['sku' => $sku]);
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($onEach !== null) {
|
||||||
|
$onEach($variant, $sku);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
return $total;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,71 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Modules\Core\Catalog\Services;
|
||||||
|
|
||||||
|
use Illuminate\Support\Facades\DB;
|
||||||
|
use Lunar\Models\Order;
|
||||||
|
use Lunar\Models\Product;
|
||||||
|
use Lunar\Models\ProductVariant;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The one place ProductVariant::stock is written as a result of an order —
|
||||||
|
* previously this lived entirely inside Modules\Core\Order\Listeners\
|
||||||
|
* DecrementStockOnOrderPlaced, a listener with no Service behind it at
|
||||||
|
* all, even though stock (the column, its invariants — "never negative",
|
||||||
|
* "only in_stock variants") is fundamentally a Catalog concern, not an
|
||||||
|
* Order one. That listener is now a thin caller of this class, matching
|
||||||
|
* how every other module's event reaction delegates its actual write to
|
||||||
|
* a Service (e.g. Modules\Core\Order\Listeners\RecordPaymentTransaction
|
||||||
|
* -> Modules\Core\Order\Services\TransactionRecorder).
|
||||||
|
*
|
||||||
|
* Only decrements for `purchasable === 'in_stock'` variants — 'always' and
|
||||||
|
* 'backorder' variants are deliberately allowed to sell past (or without
|
||||||
|
* regard to) their stock count already (see ProductVariant::
|
||||||
|
* canBeFulfilledAtQuantity()), so decrementing their stock would just make
|
||||||
|
* that column an inaccurate, decreasingly-negative number with no purchasing
|
||||||
|
* consequence. Only `OrderLine::type === 'physical'` lines are considered —
|
||||||
|
* a digital line has no stock to decrement (ProductVariant::getType()).
|
||||||
|
*
|
||||||
|
* A single UPDATE per variant (`DB::table(...)->update()` with a raw
|
||||||
|
* expression), not a read-then-write on the Eloquent model — avoids a
|
||||||
|
* lost-update race between two orders decrementing the same variant
|
||||||
|
* concurrently, and skips Modules\Core\Catalog\Services\ProductIndexer::
|
||||||
|
* stock's staleness gap for the DB value itself even though the search
|
||||||
|
* index still only refreshes on the next reindex event/nightly job (see
|
||||||
|
* that class's own docblock).
|
||||||
|
*
|
||||||
|
* Never lets stock go negative (`GREATEST(stock - qty, 0)` via a raw
|
||||||
|
* expression) — an order can still be placed against a variant whose stock
|
||||||
|
* was already fully consumed by another concurrent order (Lunar has no
|
||||||
|
* stock-reservation step at cart/checkout time), so this is a best-effort
|
||||||
|
* count, not a hard inventory guarantee.
|
||||||
|
*/
|
||||||
|
class StockService
|
||||||
|
{
|
||||||
|
public function decrementForOrder(Order $order): void
|
||||||
|
{
|
||||||
|
$lines = $order->lines()
|
||||||
|
->where('type', 'physical')
|
||||||
|
->where('purchasable_type', ProductVariant::morphName())
|
||||||
|
->get(['purchasable_id', 'quantity']);
|
||||||
|
|
||||||
|
if ($lines->isEmpty()) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
foreach ($lines as $line) {
|
||||||
|
DB::table((new ProductVariant())->getTable())
|
||||||
|
->where('id', $line->purchasable_id)
|
||||||
|
->where('purchasable', 'in_stock')
|
||||||
|
->update([
|
||||||
|
'stock' => DB::raw('GREATEST(stock - '.(int) $line->quantity.', 0)'),
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
|
||||||
|
$productIds = ProductVariant::whereIn('id', $lines->pluck('purchasable_id'))
|
||||||
|
->pluck('product_id')
|
||||||
|
->unique();
|
||||||
|
|
||||||
|
Product::whereIn('id', $productIds)->get()->each->searchable();
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -51,7 +51,15 @@ class ProductDocumentLocalizer
|
|||||||
$availableLocales = $this->languages->availableLocales();
|
$availableLocales = $this->languages->availableLocales();
|
||||||
|
|
||||||
foreach ($this->translatedAttributeHandles() as $handle) {
|
foreach ($this->translatedAttributeHandles() as $handle) {
|
||||||
$product[$handle] = $product[$handle.'_'.$locale] ?? $product[$handle.'_'.$fallbackLocale] ?? null;
|
// filled(), not ?? - a translated attribute saved blank for
|
||||||
|
// the current locale still has that {handle}_{locale} key in
|
||||||
|
// the document, just set to '' rather than absent. ?? only
|
||||||
|
// falls back on a missing/null key, so it kept the empty
|
||||||
|
// string instead of falling through to a locale that actually
|
||||||
|
// has content.
|
||||||
|
$product[$handle] = filled($product[$handle.'_'.$locale] ?? null)
|
||||||
|
? $product[$handle.'_'.$locale]
|
||||||
|
: ($product[$handle.'_'.$fallbackLocale] ?? null);
|
||||||
|
|
||||||
foreach ($availableLocales as $availableLocale) {
|
foreach ($availableLocales as $availableLocale) {
|
||||||
unset($product[$handle.'_'.$availableLocale]);
|
unset($product[$handle.'_'.$availableLocale]);
|
||||||
|
|||||||
@@ -10,6 +10,13 @@ use Modules\Core\Catalog\DTOs\ProductFilters;
|
|||||||
* out of ProductService (where it originated, scoped to browsing/filtering
|
* out of ProductService (where it originated, scoped to browsing/filtering
|
||||||
* without a search term) so ProductSearchService can apply the exact same
|
* without a search term) so ProductSearchService can apply the exact same
|
||||||
* filter semantics to a text query too, rather than reimplementing it.
|
* filter semantics to a text query too, rather than reimplementing it.
|
||||||
|
*
|
||||||
|
* Also the single place that composes the draft-visibility clause (see
|
||||||
|
* withVisibility()) — every Meilisearch `filter` string ProductService
|
||||||
|
* constructs, including the handful of ad-hoc ones that don't call build()
|
||||||
|
* at all (getById()/getBySlug()'s id lookup, random()'s id-only fetch),
|
||||||
|
* goes through this class so none of them can silently omit it the way a
|
||||||
|
* status filter was missing everywhere until now.
|
||||||
*/
|
*/
|
||||||
class ProductFilterBuilder
|
class ProductFilterBuilder
|
||||||
{
|
{
|
||||||
@@ -19,10 +26,10 @@ class ProductFilterBuilder
|
|||||||
* ProductService::priceRange() excludes 'price' so a price slider's own
|
* ProductService::priceRange() excludes 'price' so a price slider's own
|
||||||
* bounds don't shrink to whatever range is already selected on it.
|
* bounds don't shrink to whatever range is already selected on it.
|
||||||
*/
|
*/
|
||||||
public function build(?ProductFilters $filters, array $exclude = []): ?string
|
public function build(?ProductFilters $filters, array $exclude = []): string
|
||||||
{
|
{
|
||||||
if ($filters === null) {
|
if ($filters === null) {
|
||||||
return null;
|
return $this->withVisibility();
|
||||||
}
|
}
|
||||||
|
|
||||||
$clauses = Collection::make([
|
$clauses = Collection::make([
|
||||||
@@ -36,6 +43,27 @@ class ProductFilterBuilder
|
|||||||
'inStockOnly' => $filters->inStockOnly ? 'in_stock = true' : null,
|
'inStockOnly' => $filters->inStockOnly ? 'in_stock = true' : null,
|
||||||
])->except($exclude)->filter();
|
])->except($exclude)->filter();
|
||||||
|
|
||||||
return $clauses->isEmpty() ? null : $clauses->join(' AND ');
|
return $this->withVisibility($clauses->isEmpty() ? null : $clauses->join(' AND '));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A draft product (status = 'draft', see Lunar\Filament\Resources\
|
||||||
|
* ProductResource's own status Select) is only ever visible while
|
||||||
|
* APP_DEBUG is true — a merchant/developer previewing an unfinished
|
||||||
|
* product locally or on a staging box, never a real storefront
|
||||||
|
* visitor. Every ProductService method that builds a Meilisearch
|
||||||
|
* `filter` string, build() included, calls this rather than passing
|
||||||
|
* $rawClause straight to Product::search() — the one seam that
|
||||||
|
* guarantees none of them can omit the visibility rule.
|
||||||
|
*
|
||||||
|
* Always returns a non-empty string (never null) — a bare
|
||||||
|
* 'status = "published"' is itself a complete, valid Meilisearch
|
||||||
|
* filter on its own when $rawClause is null.
|
||||||
|
*/
|
||||||
|
public function withVisibility(?string $rawClause = null): string
|
||||||
|
{
|
||||||
|
$visibility = config('app.debug') ? null : 'status = "published"';
|
||||||
|
|
||||||
|
return Collection::make([$visibility, $rawClause])->filter()->join(' AND ');
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,18 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Modules\Core\Checkout\Exceptions;
|
||||||
|
|
||||||
|
use RuntimeException;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Thrown by CheckoutService::selectBoxNowLocker() when the cart has no
|
||||||
|
* shipping address yet to attach the chosen locker's meta to — the
|
||||||
|
* storefront must call setShippingAddress() first.
|
||||||
|
*/
|
||||||
|
class NoShippingAddressException extends RuntimeException
|
||||||
|
{
|
||||||
|
public function __construct()
|
||||||
|
{
|
||||||
|
parent::__construct('Cannot select a Box Now locker before a shipping address is set.');
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -10,6 +10,7 @@ use Lunar\Base\Addressable;
|
|||||||
use Lunar\DataTypes\ShippingOption;
|
use Lunar\DataTypes\ShippingOption;
|
||||||
use Lunar\Facades\ShippingManifest;
|
use Lunar\Facades\ShippingManifest;
|
||||||
use Lunar\Models\Cart;
|
use Lunar\Models\Cart;
|
||||||
|
use Lunar\Shipping\Models\ShippingMethod;
|
||||||
use Modules\Core\Cart\Services\CartService;
|
use Modules\Core\Cart\Services\CartService;
|
||||||
use Modules\Core\Checkout\Events\BillingAddressSet;
|
use Modules\Core\Checkout\Events\BillingAddressSet;
|
||||||
use Modules\Core\Checkout\Events\PaymentMethodSelected;
|
use Modules\Core\Checkout\Events\PaymentMethodSelected;
|
||||||
@@ -17,12 +18,15 @@ use Modules\Core\Checkout\Events\RecoveryConsentSet;
|
|||||||
use Modules\Core\Checkout\Events\ShippingAddressSet;
|
use Modules\Core\Checkout\Events\ShippingAddressSet;
|
||||||
use Modules\Core\Checkout\Events\ShippingOptionSelected;
|
use Modules\Core\Checkout\Events\ShippingOptionSelected;
|
||||||
use Modules\Core\Checkout\Exceptions\InvalidShippingOptionException;
|
use Modules\Core\Checkout\Exceptions\InvalidShippingOptionException;
|
||||||
|
use Modules\Core\Checkout\Exceptions\NoShippingAddressException;
|
||||||
use Modules\Core\Checkout\Exceptions\TermsNotAcceptedException;
|
use Modules\Core\Checkout\Exceptions\TermsNotAcceptedException;
|
||||||
use Modules\Core\Checkout\Exceptions\UnknownPaymentTypeException;
|
use Modules\Core\Checkout\Exceptions\UnknownPaymentTypeException;
|
||||||
|
use Modules\Core\Payment\Contracts\RequiresFulfillmentType;
|
||||||
use Modules\Core\Payment\DTOs\PaymentResult;
|
use Modules\Core\Payment\DTOs\PaymentResult;
|
||||||
use Modules\Core\Payment\Models\PaymentMethod;
|
use Modules\Core\Payment\Models\PaymentMethod;
|
||||||
use Modules\Core\Payment\Services\PaymentDriverRegistry;
|
use Modules\Core\Payment\Services\PaymentDriverRegistry;
|
||||||
use Modules\Core\Payment\Services\PaymentMethodCache;
|
use Modules\Core\Payment\Services\PaymentMethodCache;
|
||||||
|
use Modules\Core\Shipping\Support\FulfillmentType;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Storefront-facing checkout operations, mirroring
|
* Storefront-facing checkout operations, mirroring
|
||||||
@@ -49,9 +53,35 @@ class CheckoutService
|
|||||||
private readonly PaymentMethodCache $paymentMethods,
|
private readonly PaymentMethodCache $paymentMethods,
|
||||||
) {}
|
) {}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Lunar\Actions\Carts\AddAddress (behind Cart::setShippingAddress())
|
||||||
|
* always deletes the cart's existing shipping address row and inserts
|
||||||
|
* a brand new one — it has no notion of "update in place." Every field
|
||||||
|
* on the new row therefore starts blank, including `meta`, which is
|
||||||
|
* where selectBoxNowLocker() stores the shopper's chosen locker. Since
|
||||||
|
* the checkout page autosaves the address form on every field change
|
||||||
|
* (not just once), any edit made after picking a locker — even an
|
||||||
|
* unrelated one, like delivery instructions — silently wiped the
|
||||||
|
* locker choice by recreating the row out from under it.
|
||||||
|
*
|
||||||
|
* Carries the previous row's box_now_locker forward onto the new one
|
||||||
|
* so the two features don't stomp on each other, without needing
|
||||||
|
* Lunar's own AddAddress action to change. The old row's meta is read
|
||||||
|
* BEFORE Lunar deletes it, since afterward there's nothing left to
|
||||||
|
* read.
|
||||||
|
*/
|
||||||
public function setShippingAddress(array|Addressable $address): Cart
|
public function setShippingAddress(array|Addressable $address): Cart
|
||||||
{
|
{
|
||||||
$cart = $this->cart->currentOrCreate()->setShippingAddress($address);
|
$cartBefore = $this->cart->currentOrCreate();
|
||||||
|
$boxNowLocker = $cartBefore->shippingAddress?->meta['box_now_locker'] ?? null;
|
||||||
|
|
||||||
|
$cart = $cartBefore->setShippingAddress($address);
|
||||||
|
|
||||||
|
if ($boxNowLocker !== null) {
|
||||||
|
$newAddress = $cart->shippingAddress;
|
||||||
|
$newAddress->meta = [...($newAddress->meta?->toArray() ?? []), 'box_now_locker' => $boxNowLocker];
|
||||||
|
$newAddress->save();
|
||||||
|
}
|
||||||
|
|
||||||
Event::dispatch(new ShippingAddressSet($cart, $address));
|
Event::dispatch(new ShippingAddressSet($cart, $address));
|
||||||
|
|
||||||
@@ -141,15 +171,71 @@ class CheckoutService
|
|||||||
|
|
||||||
$cart = $cartBefore->setShippingOption($option);
|
$cart = $cartBefore->setShippingOption($option);
|
||||||
|
|
||||||
|
// Switching away from Box Now leaves a stale box_now_locker on the
|
||||||
|
// address's meta (see setShippingAddress()'s own docblock for why
|
||||||
|
// it survives address-row recreation) — irrelevant while a
|
||||||
|
// different method is selected, but wrong if the shopper later
|
||||||
|
// switches BACK to Box Now and it resurfaces as if still chosen,
|
||||||
|
// possibly for a locker that no longer exists/fits. Cleared here,
|
||||||
|
// the one place that knows the method just changed.
|
||||||
|
if ($identifier !== 'box-now') {
|
||||||
|
$address = $cart->shippingAddress;
|
||||||
|
|
||||||
|
if ($address && isset($address->meta['box_now_locker'])) {
|
||||||
|
$meta = $address->meta->toArray();
|
||||||
|
unset($meta['box_now_locker']);
|
||||||
|
$address->meta = $meta;
|
||||||
|
$address->save();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
Event::dispatch(new ShippingOptionSelected($cart, $option));
|
Event::dispatch(new ShippingOptionSelected($cart, $option));
|
||||||
|
|
||||||
return $cart;
|
return $cart;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Records the shopper's chosen Box Now locker on the cart's shipping
|
||||||
|
* address (Cart\Addresses::shippingAddress()->meta['box_now_locker']),
|
||||||
|
* not on the cart itself — Lunar\Pipelines\Order\Creation\
|
||||||
|
* CreateOrderAddresses copies every cart address's full attributes
|
||||||
|
* (meta included) onto the new order address when the order is placed,
|
||||||
|
* so this is what Modules\Core\Shipping\Carriers\BoxNow\
|
||||||
|
* BoxNowFulfillmentService and Modules\Core\Shipping\Extensions\
|
||||||
|
* OrderViewExtension already expect to find at
|
||||||
|
* $order->shippingAddress->meta['box_now_locker']['locationId'].
|
||||||
|
*
|
||||||
|
* No validation against Box Now's own /destinations list here — this
|
||||||
|
* mirrors setShippingAddress()'s leniency (see its own docblock/the
|
||||||
|
* class-level note on required-field enforcement happening at the
|
||||||
|
* payment gate, not mid-checkout). An invalid/stale locationId still
|
||||||
|
* surfaces later, at BoxNowFulfillmentService::createShipment() time.
|
||||||
|
*
|
||||||
|
* @throws NoShippingAddressException if the cart has no shipping
|
||||||
|
* address yet
|
||||||
|
*/
|
||||||
|
public function selectBoxNowLocker(array $locker): Cart
|
||||||
|
{
|
||||||
|
$cart = $this->cart->currentOrCreate();
|
||||||
|
$address = $cart->shippingAddress;
|
||||||
|
|
||||||
|
if (! $address) {
|
||||||
|
throw new NoShippingAddressException();
|
||||||
|
}
|
||||||
|
|
||||||
|
$address->meta = [
|
||||||
|
...($address->meta?->toArray() ?? []),
|
||||||
|
'box_now_locker' => $locker,
|
||||||
|
];
|
||||||
|
$address->save();
|
||||||
|
|
||||||
|
return $cart;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Every payment method currently offered to the storefront, ordered by
|
* Every payment method currently offered to the storefront, ordered by
|
||||||
* Modules\Core\Payment\Models\PaymentMethod::position — a row is
|
* Modules\Core\Payment\Models\PaymentMethod::position — a row is
|
||||||
* offered only when ALL three checks pass, each meaning something
|
* offered only when ALL four checks pass, each meaning something
|
||||||
* different to an admin diagnosing why a method isn't showing up (see
|
* different to an admin diagnosing why a method isn't showing up (see
|
||||||
* docs/payments.md):
|
* docs/payments.md):
|
||||||
* 1. `enabled` — an admin turned it on.
|
* 1. `enabled` — an admin turned it on.
|
||||||
@@ -160,17 +246,61 @@ class CheckoutService
|
|||||||
* vanished driver can never silently look "available").
|
* vanished driver can never silently look "available").
|
||||||
* 3. the resolved driver reports Configurable::isConfigured() — its
|
* 3. the resolved driver reports Configurable::isConfigured() — its
|
||||||
* own runtime requirements (e.g. an API key) are met.
|
* own runtime requirements (e.g. an API key) are met.
|
||||||
|
* 4. its driver's RequiresFulfillmentType (if it declares one)
|
||||||
|
* agrees with the cart's currently selected shipping method's own
|
||||||
|
* fulfillment type (Modules\Core\Shipping\Support\
|
||||||
|
* FulfillmentType::resolve()) — "Pay in store" offered alongside
|
||||||
|
* a courier delivery makes no sense (no staff member present at
|
||||||
|
* handoff to take cash), and cash-on-delivery alongside store
|
||||||
|
* pickup is equally meaningless (OfflinePaymentDriver already
|
||||||
|
* covers that in-person moment). A cart with no shipping option
|
||||||
|
* selected yet imposes no constraint here — every method is
|
||||||
|
* offered until a fulfillment type is actually known, the same
|
||||||
|
* leniency setShippingAddress()'s own docblock describes for
|
||||||
|
* required-field enforcement happening at the payment gate, not
|
||||||
|
* mid-checkout.
|
||||||
*
|
*
|
||||||
* @return Collection<int, PaymentMethod>
|
* @return Collection<int, PaymentMethod>
|
||||||
*/
|
*/
|
||||||
public function getPaymentMethods(): Collection
|
public function getPaymentMethods(): Collection
|
||||||
{
|
{
|
||||||
|
$fulfillmentType = $this->currentFulfillmentType();
|
||||||
|
|
||||||
return $this->paymentMethods->all()
|
return $this->paymentMethods->all()
|
||||||
->filter(fn (PaymentMethod $method) => $method->enabled && $method->driver_missing_at === null)
|
->filter(fn (PaymentMethod $method) => $method->enabled && $method->driver_missing_at === null)
|
||||||
->filter(fn (PaymentMethod $method) => $this->paymentDrivers->resolve($method->driver)?->isConfigured() ?? false)
|
->filter(function (PaymentMethod $method) use ($fulfillmentType) {
|
||||||
|
$driver = $this->paymentDrivers->resolve($method->driver);
|
||||||
|
|
||||||
|
if (! $driver?->isConfigured()) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($fulfillmentType === null || ! $driver instanceof RequiresFulfillmentType) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
return $driver->requiredFulfillmentType() === $fulfillmentType;
|
||||||
|
})
|
||||||
->values();
|
->values();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return 'carrier'|'store_pickup'|null null when the cart has no
|
||||||
|
* shipping option selected yet
|
||||||
|
*/
|
||||||
|
private function currentFulfillmentType(): ?string
|
||||||
|
{
|
||||||
|
$identifier = $this->cart->currentOrCreate()->shippingAddress?->shipping_option;
|
||||||
|
|
||||||
|
if ($identifier === null) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
$method = ShippingMethod::where('code', $identifier)->first();
|
||||||
|
|
||||||
|
return $method ? FulfillmentType::resolve($method) : null;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Records which payment type the shopper picked (Cart::meta
|
* Records which payment type the shopper picked (Cart::meta
|
||||||
* ['payment_method']) — read by Modules\Core\Payment\Pipelines\
|
* ['payment_method']) — read by Modules\Core\Payment\Pipelines\
|
||||||
|
|||||||
@@ -0,0 +1,51 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Modules\Core\Command;
|
||||||
|
|
||||||
|
use Illuminate\Console\Command;
|
||||||
|
use Lunar\Models\ProductVariant;
|
||||||
|
use Modules\Core\Catalog\Services\SkuBackfillService;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* CLI wrapper (--dry-run, a progress bar) around Catalog\Services\
|
||||||
|
* SkuBackfillService — see that class's own docblock for the actual
|
||||||
|
* backfill logic, also called automatically after a Shopify import (see
|
||||||
|
* MigrateImport\Jobs\RunMigrateImportJob).
|
||||||
|
*/
|
||||||
|
class BackfillMissingSkusCommand extends Command
|
||||||
|
{
|
||||||
|
protected $signature = 'boboko:catalog:backfill-skus {--dry-run : List what would change without writing}';
|
||||||
|
|
||||||
|
protected $description = 'Generate a SKU for every product variant that is missing one';
|
||||||
|
|
||||||
|
public function handle(SkuBackfillService $backfill): void
|
||||||
|
{
|
||||||
|
$dryRun = (bool) $this->option('dry-run');
|
||||||
|
|
||||||
|
$total = ProductVariant::query()->whereNull('sku')->count();
|
||||||
|
|
||||||
|
if ($total === 0) {
|
||||||
|
$this->info('No variants are missing a SKU.');
|
||||||
|
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->info(($dryRun ? '[dry-run] ' : '') . "Backfilling SKUs for {$total} variant(s)...");
|
||||||
|
|
||||||
|
$bar = $this->output->createProgressBar($total);
|
||||||
|
$bar->start();
|
||||||
|
|
||||||
|
$backfill->backfill($dryRun, function (ProductVariant $variant, string $sku) use ($dryRun, $bar) {
|
||||||
|
if ($dryRun) {
|
||||||
|
$this->newLine();
|
||||||
|
$this->line("Variant {$variant->id}: sku => {$sku}");
|
||||||
|
}
|
||||||
|
|
||||||
|
$bar->advance();
|
||||||
|
});
|
||||||
|
|
||||||
|
$bar->finish();
|
||||||
|
$this->newLine();
|
||||||
|
$this->info($dryRun ? 'Dry run complete — no changes were written.' : 'Done.');
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -66,6 +66,16 @@ class InstallLunarCommand extends Command
|
|||||||
]);
|
]);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (! Language::where('code', 'el')->exists()) {
|
||||||
|
$this->components->info('Adding Greek language');
|
||||||
|
|
||||||
|
Language::create([
|
||||||
|
'code' => 'el',
|
||||||
|
'name' => 'Greek',
|
||||||
|
'default' => false,
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
|
||||||
if (! Currency::whereDefault(true)->exists()) {
|
if (! Currency::whereDefault(true)->exists()) {
|
||||||
$this->components->info('Adding a default currency (USD)');
|
$this->components->info('Adding a default currency (USD)');
|
||||||
|
|
||||||
@@ -310,7 +320,10 @@ class InstallLunarCommand extends Command
|
|||||||
|
|
||||||
PaymentMethod::create([
|
PaymentMethod::create([
|
||||||
'type' => 'cash-on-delivery',
|
'type' => 'cash-on-delivery',
|
||||||
'name' => 'Cash on Delivery',
|
'name' => [
|
||||||
|
'en' => 'Cash on Delivery',
|
||||||
|
'el' => 'Αντικαταβολή',
|
||||||
|
],
|
||||||
'driver' => 'cash-on-delivery',
|
'driver' => 'cash-on-delivery',
|
||||||
'capture_mode' => 'pay',
|
'capture_mode' => 'pay',
|
||||||
'position' => 0,
|
'position' => 0,
|
||||||
|
|||||||
@@ -3,8 +3,9 @@
|
|||||||
namespace Modules\Core\Command;
|
namespace Modules\Core\Command;
|
||||||
|
|
||||||
use Illuminate\Console\Command;
|
use Illuminate\Console\Command;
|
||||||
use Modules\Core\MigrateImport\ImportSpec;
|
use Lunar\Models\Language;
|
||||||
use Modules\Core\MigrateImport\RunMigrateImportJob;
|
use Modules\Core\MigrateImport\DTOs\ImportSpec;
|
||||||
|
use Modules\Core\MigrateImport\Jobs\RunMigrateImportJob;
|
||||||
|
|
||||||
class MigrateImportCommand extends Command
|
class MigrateImportCommand extends Command
|
||||||
{
|
{
|
||||||
@@ -62,11 +63,29 @@ class MigrateImportCommand extends Command
|
|||||||
$credentials = null;
|
$credentials = null;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Shopify's own product export is a flat CSV — one Title/Body
|
||||||
|
// (HTML)/etc. column per row, no per-locale columns at all — so
|
||||||
|
// its text is necessarily written in exactly one language, and
|
||||||
|
// there is no reliable way to detect which one from the file
|
||||||
|
// itself. Modules\Core\MigrateImport\Services\ImportLocale::code() used to
|
||||||
|
// (as its former name, DefaultLocale, admits) assume it always
|
||||||
|
// matched this store's own Lunar\Models\
|
||||||
|
// Language::getDefault(), which is often wrong (a store's default
|
||||||
|
// admin/storefront language and the language a given export
|
||||||
|
// happens to be written in are two independent facts) — every
|
||||||
|
// imported product's name/description then saved silently under
|
||||||
|
// the wrong language, invisible unless that language happened to
|
||||||
|
// also be selected when viewing/editing the product afterward.
|
||||||
|
$locale = $source === 'shopify' && $type === 'export'
|
||||||
|
? $this->askImportLocale()
|
||||||
|
: null;
|
||||||
|
|
||||||
$spec = new ImportSpec(
|
$spec = new ImportSpec(
|
||||||
source: $source,
|
source: $source,
|
||||||
type: $type,
|
type: $type,
|
||||||
filePath: $filePath,
|
filePath: $filePath,
|
||||||
credentials: $credentials,
|
credentials: $credentials,
|
||||||
|
locale: $locale,
|
||||||
);
|
);
|
||||||
|
|
||||||
RunMigrateImportJob::dispatch($spec);
|
RunMigrateImportJob::dispatch($spec);
|
||||||
@@ -74,6 +93,26 @@ class MigrateImportCommand extends Command
|
|||||||
$this->info('Import queued.');
|
$this->info('Import queued.');
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Choices come from Language::all() — the same list an admin manages
|
||||||
|
* from the Filament panel (Settings > Languages) — not a hardcoded
|
||||||
|
* set, so a language this store doesn't have yet simply isn't
|
||||||
|
* offered here; the hint below says where to add it instead of this
|
||||||
|
* command silently accepting an arbitrary code Lunar has no row for.
|
||||||
|
*/
|
||||||
|
private function askImportLocale(): string
|
||||||
|
{
|
||||||
|
$languages = Language::orderBy('default', 'desc')->get(['code', 'name']);
|
||||||
|
|
||||||
|
return $this->choice(
|
||||||
|
"Which language is the export file's own text (product titles, descriptions, etc.) written in?\n".
|
||||||
|
' (Not necessarily this store\'s default language — the two are independent. '.
|
||||||
|
"If the language you need isn't listed, add it first from the admin panel under Languages.)",
|
||||||
|
$languages->mapWithKeys(fn (Language $language) => [$language->code => "{$language->name} ({$language->code})"])->all(),
|
||||||
|
$languages->first()?->code,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
// Answers are relative to storage/app/private/imports (e.g. "shopify" or
|
// Answers are relative to storage/app/private/imports (e.g. "shopify" or
|
||||||
// "shopify/products_export.csv"); absolute paths are used as-is. A
|
// "shopify/products_export.csv"); absolute paths are used as-is. A
|
||||||
// directory answer picks the first CSV file found inside it.
|
// directory answer picks the first CSV file found inside it.
|
||||||
|
|||||||
@@ -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).');
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,213 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Modules\Core\Command;
|
||||||
|
|
||||||
|
use Illuminate\Console\Command;
|
||||||
|
use Lunar\Models\CartLine;
|
||||||
|
use Lunar\Models\Product;
|
||||||
|
use Modules\Core\Auth\Models\Staff;
|
||||||
|
use Modules\Core\Auth\Services\OtpService;
|
||||||
|
use Modules\Core\MigrateImport\Models\ImportMapping;
|
||||||
|
|
||||||
|
use function Laravel\Prompts\password;
|
||||||
|
use function Laravel\Prompts\text;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Irreversibly deletes every Product and everything that only exists
|
||||||
|
* because of a product — variants, variant prices, product-option value
|
||||||
|
* assignments, product images/media, product associations, the
|
||||||
|
* ImportMapping rows tying them back to an external source, product-
|
||||||
|
* variant CartLine rows (line items only — Cart records themselves are
|
||||||
|
* left alone), and the Meilisearch product index. Deliberately does NOT
|
||||||
|
* touch catalog STRUCTURE other products could still reference: ProductOption/
|
||||||
|
* ProductOptionValue definitions ("Size", "Color" as reusable option
|
||||||
|
* types), Brands, Collections, Tags, Customer Groups — none of those are
|
||||||
|
* products, they're config a merchant would otherwise have to rebuild
|
||||||
|
* from scratch.
|
||||||
|
*
|
||||||
|
* Two gates a destructive, whole-catalog, irreversible operation
|
||||||
|
* warrants — deliberately NOT restricted to non-production on top of
|
||||||
|
* these; a real, legitimate use case is wiping a client's demo/seed
|
||||||
|
* catalog on a production database right before real launch, and the OTP
|
||||||
|
* below already proves the operator has real staff access, not just
|
||||||
|
* shell access to wherever `php artisan` happens to be runnable:
|
||||||
|
* 1. An OTP emailed to a real Staff account (reusing Auth\Services\
|
||||||
|
* OtpService — the exact mechanism admin login already uses).
|
||||||
|
* 2. Typing the literal product count back, not just "yes" — a plain
|
||||||
|
* confirm() is too easy to reflexively accept; forcing the operator
|
||||||
|
* to read and retype the actual number they're about to delete is a
|
||||||
|
* last check against running this against the wrong environment/
|
||||||
|
* database by mistake.
|
||||||
|
*
|
||||||
|
* Deletes via Eloquent model instances, not DB::table()->delete() —
|
||||||
|
* Product/ProductVariant use Spatie's InteractsWithMedia (see Lunar\Base\
|
||||||
|
* Traits\HasMedia), which only cleans up media files/rows on a real model
|
||||||
|
* `deleted` event, never on a raw query-builder delete.
|
||||||
|
*/
|
||||||
|
class WipeCatalogCommand extends Command
|
||||||
|
{
|
||||||
|
protected $signature = 'boboko:wipe-catalog {--email= : Staff email to send the confirmation code to}';
|
||||||
|
|
||||||
|
protected $description = 'Irreversibly delete every product, variant, and related catalog data';
|
||||||
|
|
||||||
|
public function handle(OtpService $otp): int
|
||||||
|
{
|
||||||
|
// withTrashed() — a prior soft-delete-only bug in this command
|
||||||
|
// (fixed in wipe() below) could leave ghost rows a plain count()
|
||||||
|
// would never see, silently reporting "nothing to do" while they
|
||||||
|
// sit there breaking other things (e.g. the admin's own global
|
||||||
|
// search, which assumes every returned product has variants).
|
||||||
|
$productCount = Product::withTrashed()->count();
|
||||||
|
|
||||||
|
if ($productCount === 0) {
|
||||||
|
$this->info('No products exist — nothing to do.');
|
||||||
|
|
||||||
|
return self::SUCCESS;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (! $this->authorize($otp)) {
|
||||||
|
return self::FAILURE;
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->warn("This will PERMANENTLY delete {$productCount} product(s) and everything that only exists because of them (variants, prices, images, product-option assignments, associations). This cannot be undone.");
|
||||||
|
|
||||||
|
$typed = text(label: "Type the product count ({$productCount}) to confirm");
|
||||||
|
|
||||||
|
if ($typed !== (string) $productCount) {
|
||||||
|
$this->error('Count did not match — aborted, nothing was deleted.');
|
||||||
|
|
||||||
|
return self::FAILURE;
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->wipe();
|
||||||
|
|
||||||
|
$this->info("Deleted {$productCount} product(s) and all related data.");
|
||||||
|
|
||||||
|
return self::SUCCESS;
|
||||||
|
}
|
||||||
|
|
||||||
|
private function authorize(OtpService $otp): bool
|
||||||
|
{
|
||||||
|
$email = $this->option('email') ?? text(
|
||||||
|
label: 'Staff email to send a confirmation code to',
|
||||||
|
validate: fn (string $value) => Staff::where('email', $value)->exists()
|
||||||
|
? null
|
||||||
|
: 'No staff account with that email exists.',
|
||||||
|
);
|
||||||
|
|
||||||
|
if (! $otp->generateAndSend($email, purpose: 'wipe-catalog')) {
|
||||||
|
$this->error('Could not send a confirmation code to that email.');
|
||||||
|
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->info("A confirmation code was sent to {$email}.");
|
||||||
|
|
||||||
|
$code = password(label: 'Enter the confirmation code');
|
||||||
|
|
||||||
|
if ($otp->validate($email, $code) === null) {
|
||||||
|
$this->error('Invalid or expired code — aborted, nothing was deleted.');
|
||||||
|
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Every step below goes through a real Eloquent relation, never a raw
|
||||||
|
* table name — Lunar's own table prefix is configurable
|
||||||
|
* (config('lunar.database.table_prefix'), applied in BaseModel's
|
||||||
|
* constructor), so a hardcoded 'lunar_...' string would silently
|
||||||
|
* no-op on an install using a different one.
|
||||||
|
*
|
||||||
|
* Order matters: product_associations and the product/product_option
|
||||||
|
* pivot have a real FK to `products` but no ON DELETE CASCADE (both
|
||||||
|
* RESTRICT, Laravel's own default), so they're detached before the
|
||||||
|
* product/variant rows they reference — deleting a product that
|
||||||
|
* still has either would throw. ProductVariant's own `prices` (a
|
||||||
|
* plain morph, HasPrices trait — no FK constraint at all) would
|
||||||
|
* otherwise silently orphan rather than throw, so it's cleared the
|
||||||
|
* same way regardless. media_variant and product_option_value_
|
||||||
|
* product_variant DO cascade at the DB level (see their own
|
||||||
|
* migrations), so deleting the variant itself is enough for those two.
|
||||||
|
*
|
||||||
|
* Deliberately NOT chunkById() — that re-queries "id > lastSeenId"
|
||||||
|
* every iteration, but deleting rows inside the loop shrinks the
|
||||||
|
* table out from under it: any product whose id fell in a range
|
||||||
|
* chunkById() had already stepped past could be silently skipped and
|
||||||
|
* never actually deleted at all. Caught in practice — the first real
|
||||||
|
* run of this command left orphaned Media rows (Spatie's own
|
||||||
|
* deleteAllMedia(), fired from Product's `deleting` event, never ran
|
||||||
|
* for the skipped products) whose 'image' ImportMapping rows then
|
||||||
|
* caused a LATER Shopify re-import to silently reuse those now-
|
||||||
|
* orphaned Media objects instead of importing fresh ones — see
|
||||||
|
* MigrateImport\Shopify\Services\ShopifyExportImporter::resolveOrImportImage()'s
|
||||||
|
* own docblock for that half of the same incident. Always re-querying
|
||||||
|
* the first N remaining rows (never advancing an id cursor) guarantees
|
||||||
|
* every product is actually visited exactly once, however many are
|
||||||
|
* deleted out from under the query as it goes.
|
||||||
|
*/
|
||||||
|
private function wipe(): void
|
||||||
|
{
|
||||||
|
ImportMapping::whereIn('source_type', ['product', 'variant', 'image'])->delete();
|
||||||
|
|
||||||
|
// Only the line items — not the parent Cart rows. This command is
|
||||||
|
// meant for early-stage/setup use where no real customer carts
|
||||||
|
// matter yet, but a customer's Cart record also anchors their
|
||||||
|
// session/coupon/address state; deleting it outright is more than
|
||||||
|
// "the catalog is gone" calls for. Leaving every variant a cart
|
||||||
|
// line could reference about to be force-deleted below would
|
||||||
|
// otherwise reproduce the exact storefront crash this step exists
|
||||||
|
// to prevent: CartLine::purchasable() resolves to null,
|
||||||
|
// PricingManager::for() throws a TypeError on every page load that
|
||||||
|
// renders the cart drawer.
|
||||||
|
CartLine::where('purchasable_type', 'product_variant')->delete();
|
||||||
|
|
||||||
|
while (true) {
|
||||||
|
// withTrashed(): Product/ProductVariant both use SoftDeletes
|
||||||
|
// — a plain query would stop seeing a product the moment
|
||||||
|
// forceDelete() below actually removes it, which is fine, but
|
||||||
|
// WITHOUT withTrashed() here this loop would never even
|
||||||
|
// fetch a row that a previous, buggy run of this command
|
||||||
|
// (or any other code) had already soft-deleted without
|
||||||
|
// force-deleting it. Ghost rows like that are exactly what
|
||||||
|
// this command exists to remove.
|
||||||
|
$products = Product::withTrashed()
|
||||||
|
->with(['variants' => fn ($query) => $query->withTrashed(), 'associations', 'inverseAssociations'])
|
||||||
|
->limit(100)
|
||||||
|
->get();
|
||||||
|
|
||||||
|
if ($products->isEmpty()) {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
foreach ($products as $product) {
|
||||||
|
$product->associations()->delete();
|
||||||
|
$product->inverseAssociations()->delete();
|
||||||
|
$product->productOptions()->detach();
|
||||||
|
|
||||||
|
foreach ($product->variants as $variant) {
|
||||||
|
$variant->prices()->delete();
|
||||||
|
// NOT delete() — Product/ProductVariant both use
|
||||||
|
// SoftDeletes, and a plain delete() only sets
|
||||||
|
// deleted_at, leaving the row (and, for Product, its
|
||||||
|
// media) sitting in the table. This command's whole
|
||||||
|
// purpose is an irreversible wipe; a soft-deleted
|
||||||
|
// ghost row is the opposite of that. Caught in
|
||||||
|
// practice — a prior run's plain delete() left 185
|
||||||
|
// ghost Product rows with zero real variants, which
|
||||||
|
// then crashed the admin's own global search
|
||||||
|
// (Lunar\Admin\Filament\Resources\ProductResource::
|
||||||
|
// getGlobalSearchResultDetails() assumes
|
||||||
|
// $record->variants->first() is never null).
|
||||||
|
$variant->forceDelete();
|
||||||
|
}
|
||||||
|
|
||||||
|
$product->forceDelete();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Product::removeAllFromSearch();
|
||||||
|
}
|
||||||
|
}
|
||||||
+71
-5
@@ -7,7 +7,11 @@ use Lunar\Admin\Filament\Resources\OrderResource\Pages\Components\OrderItemsTabl
|
|||||||
use Filament\Contracts\Plugin;
|
use Filament\Contracts\Plugin;
|
||||||
use Filament\Panel;
|
use Filament\Panel;
|
||||||
use Illuminate\Database\Eloquent\Relations\HasMany;
|
use Illuminate\Database\Eloquent\Relations\HasMany;
|
||||||
|
use Illuminate\Database\Eloquent\Relations\MorphMany;
|
||||||
use Illuminate\Support\Facades\Mail;
|
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;
|
||||||
use Lunar\Admin\Filament\Resources\ProductOptionResource\RelationManagers\ValuesRelationManager;
|
use Lunar\Admin\Filament\Resources\ProductOptionResource\RelationManagers\ValuesRelationManager;
|
||||||
use Lunar\Admin\Filament\Resources\OrderResource;
|
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\Filament\Resources\StaffResource;
|
||||||
use Lunar\Admin\Models\Staff as LunarStaff;
|
use Lunar\Admin\Models\Staff as LunarStaff;
|
||||||
use Lunar\Admin\Support\Facades\LunarPanel;
|
use Lunar\Admin\Support\Facades\LunarPanel;
|
||||||
|
use Lunar\Models\Customer;
|
||||||
use Lunar\Models\Product;
|
use Lunar\Models\Product;
|
||||||
use Lunar\Shipping\Filament\Resources\ShippingMethodResource;
|
use Lunar\Shipping\Filament\Resources\ShippingMethodResource;
|
||||||
use Lunar\Shipping\Filament\Resources\ShippingMethodResource\Pages\ListShippingMethod;
|
use Lunar\Shipping\Filament\Resources\ShippingMethodResource\Pages\ListShippingMethod;
|
||||||
@@ -28,9 +33,15 @@ use Modules\Core\Catalog\Filament\Extensions\ValuesRelationManagerExtension;
|
|||||||
use Modules\Core\Localization\Filament\Resources\LanguageLineResource;
|
use Modules\Core\Localization\Filament\Resources\LanguageLineResource;
|
||||||
use Modules\Core\Order\Filament\Extensions\OrderItemsTableExtension;
|
use Modules\Core\Order\Filament\Extensions\OrderItemsTableExtension;
|
||||||
use Modules\Core\Order\Filament\Extensions\OrderPaymentMethodSummaryExtension;
|
use Modules\Core\Order\Filament\Extensions\OrderPaymentMethodSummaryExtension;
|
||||||
use Modules\Core\Order\Filament\Extensions\OrderRefundActionsExtension;
|
use Modules\Core\Order\Filament\Extensions\OrderActionsExtension;
|
||||||
use Modules\Core\Order\Filament\Extensions\OrderTransactionsExtension;
|
use Modules\Core\Order\Filament\Extensions\OrderTransactionsExtension;
|
||||||
use Modules\Core\Payment\Filament\Resources\PaymentMethodResource;
|
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\Filament\Extensions\ProductResourceExtension;
|
||||||
use Modules\Core\Review\Models\ProductReview;
|
use Modules\Core\Review\Models\ProductReview;
|
||||||
use Modules\Core\Shipping\Extensions\OrderShipmentsExtension;
|
use Modules\Core\Shipping\Extensions\OrderShipmentsExtension;
|
||||||
@@ -56,6 +67,8 @@ class CorePlugin implements Plugin
|
|||||||
->login(Login::class)
|
->login(Login::class)
|
||||||
->resources([
|
->resources([
|
||||||
LanguageLineResource::class,
|
LanguageLineResource::class,
|
||||||
|
DataErasureRequestResource::class,
|
||||||
|
DataExportRequestResource::class,
|
||||||
CartResource::class,
|
CartResource::class,
|
||||||
PaymentMethodResource::class,
|
PaymentMethodResource::class,
|
||||||
ShipmentResource::class,
|
ShipmentResource::class,
|
||||||
@@ -70,13 +83,66 @@ class CorePlugin implements Plugin
|
|||||||
ValuesRelationManager::class => ValuesRelationManagerExtension::class,
|
ValuesRelationManager::class => ValuesRelationManagerExtension::class,
|
||||||
ShippingMethodResource::class => ShippingMethodResourceExtension::class,
|
ShippingMethodResource::class => ShippingMethodResourceExtension::class,
|
||||||
ListShippingMethod::class => ShippingMethodListExtension::class,
|
ListShippingMethod::class => ShippingMethodListExtension::class,
|
||||||
ManageOrder::class => [OrderViewExtension::class, OrderRefundActionsExtension::class, OrderTransactionsExtension::class, OrderPaymentMethodSummaryExtension::class, OrderShipmentsExtension::class],
|
ManageOrder::class => [OrderViewExtension::class, OrderActionsExtension::class, OrderTransactionsExtension::class, OrderPaymentMethodSummaryExtension::class, OrderShipmentsExtension::class],
|
||||||
OrderItemsTable::class => OrderItemsTableExtension::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 {
|
// resolveRelationUsing(), not macro() — Illuminate\Database\Eloquent\
|
||||||
/** @var Product $this */
|
// Model does not use the Macroable trait in this Laravel version, so
|
||||||
return $this->hasMany(ProductReview::class);
|
// 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([
|
LunarStaff::addActivitylogExcept([
|
||||||
|
|||||||
@@ -6,6 +6,19 @@ use Lunar\Facades\ModelManifest;
|
|||||||
use Lunar\Models\Contracts\Customer as CustomerContract;
|
use Lunar\Models\Contracts\Customer as CustomerContract;
|
||||||
use Modules\Core\Auth\Events\UserCreated;
|
use Modules\Core\Auth\Events\UserCreated;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Deliberately NOT queued, even though UserCreated (requesting an OTP
|
||||||
|
* code) and the login that follows it (submitting the code) are normally
|
||||||
|
* separate requests with a real time gap between them — that gap is not
|
||||||
|
* a guarantee this code controls. A busy/backed-up queue (a deploy in
|
||||||
|
* progress, a crashed worker, a traffic spike) could make this job run
|
||||||
|
* AFTER the shopper has already logged in and something has read
|
||||||
|
* $user->latestCustomer() (Modules\Core\Customer\Services\
|
||||||
|
* CustomerAccountService), silently returning null for a legitimately
|
||||||
|
* paired user with no retry anywhere to catch it. Kept synchronous so the
|
||||||
|
* Customer always exists by the time UserCreated's dispatch call returns,
|
||||||
|
* regardless of queue health.
|
||||||
|
*/
|
||||||
class CreateCustomerForUser
|
class CreateCustomerForUser
|
||||||
{
|
{
|
||||||
public function handle(UserCreated $event): void
|
public function handle(UserCreated $event): void
|
||||||
|
|||||||
@@ -2,6 +2,7 @@
|
|||||||
|
|
||||||
namespace Modules\Core\Customer\Listeners;
|
namespace Modules\Core\Customer\Listeners;
|
||||||
|
|
||||||
|
use Illuminate\Contracts\Queue\ShouldQueue;
|
||||||
use Lunar\Models\Address;
|
use Lunar\Models\Address;
|
||||||
use Modules\Core\Customer\Events\CustomerAddressCreated;
|
use Modules\Core\Customer\Events\CustomerAddressCreated;
|
||||||
use Modules\Core\Customer\Events\CustomerAddressDeleted;
|
use Modules\Core\Customer\Events\CustomerAddressDeleted;
|
||||||
@@ -18,8 +19,11 @@ use Modules\Core\Logging\ActivityLogService;
|
|||||||
* passed through explicitly on every call, since these events are
|
* passed through explicitly on every call, since these events are
|
||||||
* `web`-guard-caused, not `staff`-guard — see ActivityLogService's own
|
* `web`-guard-caused, not `staff`-guard — see ActivityLogService's own
|
||||||
* docblock for why that parameter exists.
|
* docblock for why that parameter exists.
|
||||||
|
*
|
||||||
|
* Queued — a pure audit-log write with no same-request reader; the
|
||||||
|
* shopper's own request doesn't need this to complete before responding.
|
||||||
*/
|
*/
|
||||||
class LogCustomerAccountActivity
|
class LogCustomerAccountActivity implements ShouldQueue
|
||||||
{
|
{
|
||||||
public function __construct(
|
public function __construct(
|
||||||
private readonly ActivityLogService $activityLog,
|
private readonly ActivityLogService $activityLog,
|
||||||
|
|||||||
@@ -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;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -2,12 +2,21 @@
|
|||||||
|
|
||||||
namespace Modules\Core\Localization\Listeners;
|
namespace Modules\Core\Localization\Listeners;
|
||||||
|
|
||||||
|
use Illuminate\Contracts\Queue\ShouldQueue;
|
||||||
use Modules\Core\Localization\Events\LanguageCreated;
|
use Modules\Core\Localization\Events\LanguageCreated;
|
||||||
use Modules\Core\Localization\Events\LanguageDeleted;
|
use Modules\Core\Localization\Events\LanguageDeleted;
|
||||||
use Modules\Core\Localization\Events\LanguageUpdated;
|
use Modules\Core\Localization\Events\LanguageUpdated;
|
||||||
use Modules\Core\Localization\Services\LanguageCache;
|
use Modules\Core\Localization\Services\LanguageCache;
|
||||||
|
|
||||||
class FlushLanguageCache
|
/**
|
||||||
|
* Queued — the only reader of this cache is Modules\Core\Localization\
|
||||||
|
* Middleware\LocaleMiddleware on a LATER storefront request, never the
|
||||||
|
* same admin request that edited/created/deleted the Language row (that
|
||||||
|
* request redirects to a fresh page read straight from the DB, not this
|
||||||
|
* cache). A few seconds of eventual consistency before the queue worker
|
||||||
|
* picks this up is an acceptable trade for not blocking the admin save.
|
||||||
|
*/
|
||||||
|
class FlushLanguageCache implements ShouldQueue
|
||||||
{
|
{
|
||||||
public function __construct(private readonly LanguageCache $languages) {}
|
public function __construct(private readonly LanguageCache $languages) {}
|
||||||
|
|
||||||
|
|||||||
@@ -2,6 +2,7 @@
|
|||||||
|
|
||||||
namespace Modules\Core\Localization\Listeners;
|
namespace Modules\Core\Localization\Listeners;
|
||||||
|
|
||||||
|
use Illuminate\Contracts\Queue\ShouldQueue;
|
||||||
use Illuminate\Support\Facades\Cache;
|
use Illuminate\Support\Facades\Cache;
|
||||||
use Modules\Core\Localization\Events\TranslationCreated;
|
use Modules\Core\Localization\Events\TranslationCreated;
|
||||||
use Modules\Core\Localization\Events\TranslationDeleted;
|
use Modules\Core\Localization\Events\TranslationDeleted;
|
||||||
@@ -15,8 +16,13 @@ use Spatie\TranslationLoader\LanguageLine;
|
|||||||
* `group`/`key` (the old group's cached array never gets told a row left it).
|
* `group`/`key` (the old group's cached array never gets told a row left it).
|
||||||
* This listener flushes every group+locale combination touched by either the
|
* This listener flushes every group+locale combination touched by either the
|
||||||
* old or new state so nothing can remain stale.
|
* old or new state so nothing can remain stale.
|
||||||
|
*
|
||||||
|
* Queued — this cache backs `__('storefront.*')` lookups on a LATER
|
||||||
|
* storefront request, never the same admin request that just edited the
|
||||||
|
* translation (Filament redirects to a fresh index read straight from the
|
||||||
|
* DB, not this cache). Safe to let a queue worker pick up.
|
||||||
*/
|
*/
|
||||||
class FlushTranslationCache
|
class FlushTranslationCache implements ShouldQueue
|
||||||
{
|
{
|
||||||
public function handle(TranslationCreated|TranslationUpdated|TranslationDeleted $event): void
|
public function handle(TranslationCreated|TranslationUpdated|TranslationDeleted $event): void
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -2,6 +2,7 @@
|
|||||||
|
|
||||||
namespace Modules\Core\Localization\Listeners;
|
namespace Modules\Core\Localization\Listeners;
|
||||||
|
|
||||||
|
use Illuminate\Contracts\Queue\ShouldQueue;
|
||||||
use Illuminate\Support\Arr;
|
use Illuminate\Support\Arr;
|
||||||
use Modules\Core\Localization\Events\TranslationCreated;
|
use Modules\Core\Localization\Events\TranslationCreated;
|
||||||
use Modules\Core\Localization\Events\TranslationDeleted;
|
use Modules\Core\Localization\Events\TranslationDeleted;
|
||||||
@@ -9,7 +10,12 @@ use Modules\Core\Localization\Events\TranslationUpdated;
|
|||||||
use Modules\Core\Logging\ActivityLogService;
|
use Modules\Core\Logging\ActivityLogService;
|
||||||
use Spatie\TranslationLoader\LanguageLine;
|
use Spatie\TranslationLoader\LanguageLine;
|
||||||
|
|
||||||
class LogTranslationActivity
|
/**
|
||||||
|
* Queued — a pure audit-log write with no same-request reader (Filament
|
||||||
|
* redirects to a fresh index page after save, which doesn't read the
|
||||||
|
* activity log at all).
|
||||||
|
*/
|
||||||
|
class LogTranslationActivity implements ShouldQueue
|
||||||
{
|
{
|
||||||
public function __construct(
|
public function __construct(
|
||||||
private readonly ActivityLogService $activityLog,
|
private readonly ActivityLogService $activityLog,
|
||||||
|
|||||||
@@ -2,6 +2,7 @@
|
|||||||
|
|
||||||
namespace Modules\Core\Localization\Listeners;
|
namespace Modules\Core\Localization\Listeners;
|
||||||
|
|
||||||
|
use Illuminate\Contracts\Queue\ShouldQueue;
|
||||||
use Illuminate\Support\Facades\Cache;
|
use Illuminate\Support\Facades\Cache;
|
||||||
use Modules\Core\Localization\Events\LanguageUpdated;
|
use Modules\Core\Localization\Events\LanguageUpdated;
|
||||||
use Spatie\TranslationLoader\LanguageLine;
|
use Spatie\TranslationLoader\LanguageLine;
|
||||||
@@ -12,8 +13,15 @@ use Spatie\TranslationLoader\LanguageLine;
|
|||||||
* getTranslationsForGroup($newCode, ...) would silently return nothing for
|
* getTranslationsForGroup($newCode, ...) would silently return nothing for
|
||||||
* that locale even though the translated content still exists. Move the
|
* that locale even though the translated content still exists. Move the
|
||||||
* text.{oldCode} key to text.{newCode} on every affected row instead.
|
* text.{oldCode} key to text.{newCode} on every affected row instead.
|
||||||
|
*
|
||||||
|
* Queued — this walks every LanguageLine row containing the old locale key
|
||||||
|
* with no upper bound, and nothing in the same request needs the migration
|
||||||
|
* to have completed before responding (a rename is a rare admin action;
|
||||||
|
* the affected storefront locale is briefly unavailable until the queue
|
||||||
|
* worker finishes, the same window that already exists before this
|
||||||
|
* listener runs at all).
|
||||||
*/
|
*/
|
||||||
class MigrateTranslationsForRenamedLanguage
|
class MigrateTranslationsForRenamedLanguage implements ShouldQueue
|
||||||
{
|
{
|
||||||
public function handle(LanguageUpdated $event): void
|
public function handle(LanguageUpdated $event): void
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -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,10 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Modules\Core\MigrateImport\Contracts;
|
||||||
|
|
||||||
|
use Modules\Core\MigrateImport\DTOs\ImportSpec;
|
||||||
|
|
||||||
|
interface Importer
|
||||||
|
{
|
||||||
|
public function import(ImportSpec $spec): void;
|
||||||
|
}
|
||||||
@@ -0,0 +1,25 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Modules\Core\MigrateImport\DTOs;
|
||||||
|
|
||||||
|
class ImportSpec
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* @param ?string $locale The language the export file's own text
|
||||||
|
* (product titles, descriptions, option names, ...) is actually
|
||||||
|
* written in — asked of the operator at import time (see
|
||||||
|
* Command\MigrateImportCommand), since an export has no reliable
|
||||||
|
* way to declare its own language and it does not necessarily match
|
||||||
|
* this store's Lunar\Models\Language::getDefault(). Null for a
|
||||||
|
* source/type this doesn't apply to (e.g. an API-based import with
|
||||||
|
* no free-text file to attribute a single language to).
|
||||||
|
*/
|
||||||
|
public function __construct(
|
||||||
|
public readonly string $source,
|
||||||
|
public readonly string $type,
|
||||||
|
public readonly ?string $filePath = null,
|
||||||
|
public readonly ?array $credentials = null,
|
||||||
|
public readonly ?string $locale = null,
|
||||||
|
) {
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
namespace Modules\Core\MigrateImport;
|
|
||||||
|
|
||||||
use Lunar\Models\Language;
|
|
||||||
|
|
||||||
class DefaultLocale
|
|
||||||
{
|
|
||||||
public static function code(): string
|
|
||||||
{
|
|
||||||
return Language::getDefault()->code;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
namespace Modules\Core\MigrateImport;
|
|
||||||
|
|
||||||
class ImportSpec
|
|
||||||
{
|
|
||||||
public function __construct(
|
|
||||||
public readonly string $source,
|
|
||||||
public readonly string $type,
|
|
||||||
public readonly ?string $filePath = null,
|
|
||||||
public readonly ?array $credentials = null,
|
|
||||||
) {
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
namespace Modules\Core\MigrateImport;
|
|
||||||
|
|
||||||
interface Importer
|
|
||||||
{
|
|
||||||
public function import(ImportSpec $spec): void;
|
|
||||||
}
|
|
||||||
@@ -0,0 +1,45 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Modules\Core\MigrateImport\Jobs;
|
||||||
|
|
||||||
|
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\Log;
|
||||||
|
use Modules\Core\MigrateImport\DTOs\ImportSpec;
|
||||||
|
use Modules\Core\MigrateImport\Services\ImporterFactory;
|
||||||
|
|
||||||
|
class RunMigrateImportJob implements ShouldQueue
|
||||||
|
{
|
||||||
|
use Dispatchable;
|
||||||
|
use InteractsWithQueue;
|
||||||
|
use Queueable;
|
||||||
|
use SerializesModels;
|
||||||
|
|
||||||
|
public function __construct(
|
||||||
|
public readonly ImportSpec $spec,
|
||||||
|
) {
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Just hands off to the right Importer and returns — for Shopify,
|
||||||
|
* that importer dispatches a job batch instead of importing inline
|
||||||
|
* (see Shopify\ShopifyExportImporter::import()) and this job's own
|
||||||
|
* work is done the moment that batch is queued, well before the
|
||||||
|
* batch's jobs actually run. The SKU backfill that used to happen
|
||||||
|
* right here, after import() returned, now happens in that batch's
|
||||||
|
* own then() callback instead — running it here would fire before a
|
||||||
|
* single product had actually been imported.
|
||||||
|
*/
|
||||||
|
public function handle(): void
|
||||||
|
{
|
||||||
|
Log::info('Import started', ['source' => $this->spec->source, 'type' => $this->spec->type, 'file' => $this->spec->filePath]);
|
||||||
|
|
||||||
|
$importer = ImporterFactory::make($this->spec);
|
||||||
|
$importer->import($this->spec);
|
||||||
|
|
||||||
|
Log::info('Import job complete', ['source' => $this->spec->source]);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -3,7 +3,6 @@
|
|||||||
namespace Modules\Core\MigrateImport\JudgeMe\Resolvers;
|
namespace Modules\Core\MigrateImport\JudgeMe\Resolvers;
|
||||||
|
|
||||||
use Lunar\Models\Product;
|
use Lunar\Models\Product;
|
||||||
use Lunar\Models\Url;
|
|
||||||
|
|
||||||
class ProductResolver
|
class ProductResolver
|
||||||
{
|
{
|
||||||
|
|||||||
+1
-1
@@ -1,6 +1,6 @@
|
|||||||
<?php
|
<?php
|
||||||
|
|
||||||
namespace Modules\Core\MigrateImport\JudgeMe;
|
namespace Modules\Core\MigrateImport\JudgeMe\Services;
|
||||||
|
|
||||||
use RuntimeException;
|
use RuntimeException;
|
||||||
|
|
||||||
+17
-4
@@ -1,12 +1,12 @@
|
|||||||
<?php
|
<?php
|
||||||
|
|
||||||
namespace Modules\Core\MigrateImport\JudgeMe;
|
namespace Modules\Core\MigrateImport\JudgeMe\Services;
|
||||||
|
|
||||||
use Throwable;
|
use Throwable;
|
||||||
use Illuminate\Support\Carbon;
|
use Illuminate\Support\Carbon;
|
||||||
use Illuminate\Support\Facades\Log;
|
use Illuminate\Support\Facades\Log;
|
||||||
use Modules\Core\MigrateImport\Importer;
|
use Modules\Core\MigrateImport\Contracts\Importer;
|
||||||
use Modules\Core\MigrateImport\ImportSpec;
|
use Modules\Core\MigrateImport\DTOs\ImportSpec;
|
||||||
use Modules\Core\MigrateImport\JudgeMe\Resolvers\ProductResolver;
|
use Modules\Core\MigrateImport\JudgeMe\Resolvers\ProductResolver;
|
||||||
use Modules\Core\MigrateImport\Models\ImportMapping;
|
use Modules\Core\MigrateImport\Models\ImportMapping;
|
||||||
use Modules\Core\Review\Models\ProductReview;
|
use Modules\Core\Review\Models\ProductReview;
|
||||||
@@ -22,9 +22,22 @@ class JudgeMeExportImporter implements Importer
|
|||||||
|
|
||||||
public function import(ImportSpec $spec): void
|
public function import(ImportSpec $spec): void
|
||||||
{
|
{
|
||||||
foreach ($this->csvReader->read($spec->filePath) as $row) {
|
$rows = $this->csvReader->read($spec->filePath);
|
||||||
|
$total = count($rows);
|
||||||
|
$imported = 0;
|
||||||
|
|
||||||
|
Log::info('JudgeMe import: starting', ['total' => $total]);
|
||||||
|
|
||||||
|
foreach ($rows as $row) {
|
||||||
$this->importReview($row);
|
$this->importReview($row);
|
||||||
|
$imported++;
|
||||||
|
|
||||||
|
if ($imported % 100 === 0) {
|
||||||
|
Log::info('JudgeMe import: progress', ['imported' => $imported, 'total' => $total]);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
Log::info('JudgeMe import: finished', ['imported' => $imported, 'total' => $total]);
|
||||||
}
|
}
|
||||||
|
|
||||||
private function importReview(array $row): void
|
private function importReview(array $row): void
|
||||||
@@ -1,28 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
namespace Modules\Core\MigrateImport;
|
|
||||||
|
|
||||||
use Illuminate\Bus\Queueable;
|
|
||||||
use Illuminate\Contracts\Queue\ShouldQueue;
|
|
||||||
use Illuminate\Foundation\Bus\Dispatchable;
|
|
||||||
use Illuminate\Queue\InteractsWithQueue;
|
|
||||||
use Illuminate\Queue\SerializesModels;
|
|
||||||
|
|
||||||
class RunMigrateImportJob implements ShouldQueue
|
|
||||||
{
|
|
||||||
use Dispatchable;
|
|
||||||
use InteractsWithQueue;
|
|
||||||
use Queueable;
|
|
||||||
use SerializesModels;
|
|
||||||
|
|
||||||
public function __construct(
|
|
||||||
public readonly ImportSpec $spec,
|
|
||||||
) {
|
|
||||||
}
|
|
||||||
|
|
||||||
public function handle(): void
|
|
||||||
{
|
|
||||||
$importer = ImporterFactory::make($this->spec);
|
|
||||||
$importer->import($this->spec);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -0,0 +1,52 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Modules\Core\MigrateImport\Services;
|
||||||
|
|
||||||
|
use Lunar\Models\Language;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The language every resolver in an import run writes product-facing text
|
||||||
|
* under (name, description, option names, ...) — NOT necessarily this
|
||||||
|
* store's own Lunar\Models\Language::getDefault(). An export file has no
|
||||||
|
* reliable way to declare its own language, and a store's default admin/
|
||||||
|
* storefront language is an independent fact from whatever language a
|
||||||
|
* given export happens to be written in — conflating the two (this
|
||||||
|
* class's own former name, DefaultLocale, said as much) used to silently
|
||||||
|
* save every imported product's text under the wrong language, invisible
|
||||||
|
* unless that language was also the one selected while viewing/editing
|
||||||
|
* the product afterward.
|
||||||
|
*
|
||||||
|
* Set once per import run from the operator's own answer (see
|
||||||
|
* Command\MigrateImportCommand::askImportLocale(), threaded through
|
||||||
|
* ImportSpec::$locale) at the top of Importer::import() — every resolver
|
||||||
|
* downstream (ProductAttributeResolver, ProductOptionResolver,
|
||||||
|
* CollectionResolver, ImportAttributeResolver) calls code() exactly as
|
||||||
|
* before, unaware anything changed. Falls back to Language::getDefault()
|
||||||
|
* only when nothing was ever set (e.g. an import path with no locale
|
||||||
|
* concept of its own — JudgeMe's reviews-only export never calls set()).
|
||||||
|
*/
|
||||||
|
class ImportLocale
|
||||||
|
{
|
||||||
|
private static ?string $code = null;
|
||||||
|
|
||||||
|
public static function set(string $code): void
|
||||||
|
{
|
||||||
|
self::$code = $code;
|
||||||
|
}
|
||||||
|
|
||||||
|
public static function code(): string
|
||||||
|
{
|
||||||
|
return self::$code ?? Language::getDefault()->code;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A static property outlives a single request only inside a
|
||||||
|
* long-running worker process, where a queued job for one import
|
||||||
|
* must not leak its locale into the next — called at the end of
|
||||||
|
* every Importer::import() run, success or failure.
|
||||||
|
*/
|
||||||
|
public static function reset(): void
|
||||||
|
{
|
||||||
|
self::$code = null;
|
||||||
|
}
|
||||||
|
}
|
||||||
+5
-3
@@ -1,10 +1,12 @@
|
|||||||
<?php
|
<?php
|
||||||
|
|
||||||
namespace Modules\Core\MigrateImport;
|
namespace Modules\Core\MigrateImport\Services;
|
||||||
|
|
||||||
use InvalidArgumentException;
|
use InvalidArgumentException;
|
||||||
use Modules\Core\MigrateImport\JudgeMe\JudgeMeExportImporter;
|
use Modules\Core\MigrateImport\DTOs\ImportSpec;
|
||||||
use Modules\Core\MigrateImport\Shopify\ShopifyExportImporter;
|
use Modules\Core\MigrateImport\Contracts\Importer;
|
||||||
|
use Modules\Core\MigrateImport\JudgeMe\Services\JudgeMeExportImporter;
|
||||||
|
use Modules\Core\MigrateImport\Shopify\Services\ShopifyExportImporter;
|
||||||
|
|
||||||
class ImporterFactory
|
class ImporterFactory
|
||||||
{
|
{
|
||||||
+1
-1
@@ -1,6 +1,6 @@
|
|||||||
<?php
|
<?php
|
||||||
|
|
||||||
namespace Modules\Core\MigrateImport\Shopify;
|
namespace Modules\Core\MigrateImport\Shopify\DTOs;
|
||||||
|
|
||||||
class ProductGroup
|
class ProductGroup
|
||||||
{
|
{
|
||||||
@@ -0,0 +1,65 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Modules\Core\MigrateImport\Shopify\Jobs;
|
||||||
|
|
||||||
|
use Illuminate\Bus\Batchable;
|
||||||
|
use Illuminate\Bus\Queueable;
|
||||||
|
use Illuminate\Contracts\Queue\ShouldQueue;
|
||||||
|
use Illuminate\Foundation\Bus\Dispatchable;
|
||||||
|
use Illuminate\Queue\InteractsWithQueue;
|
||||||
|
use Illuminate\Queue\SerializesModels;
|
||||||
|
use Lunar\Models\CollectionGroup;
|
||||||
|
use Lunar\Models\Currency;
|
||||||
|
use Modules\Core\MigrateImport\Services\ImportLocale;
|
||||||
|
use Modules\Core\MigrateImport\Shopify\DTOs\ProductGroup;
|
||||||
|
use Modules\Core\MigrateImport\Shopify\Services\ShopifyExportImporter;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* One product per job — ShopifyExportImporter::import() used to loop over
|
||||||
|
* every ProductGroup inline, inside RunMigrateImportJob's own single
|
||||||
|
* process. A large export (hundreds of products, each with variants,
|
||||||
|
* media downloads and conversions) grew that one process's memory past
|
||||||
|
* queue:work's --memory limit (see docker-compose.yml), which kills the
|
||||||
|
* worker mid-job; the container then restarts and the WHOLE import
|
||||||
|
* re-runs from row one, never actually finishing. Splitting into one
|
||||||
|
* job per product means memory resets between jobs (a fresh worker
|
||||||
|
* process picks up each one), and a restart only repeats whichever
|
||||||
|
* single product was in flight — ImportMapping's own per-handle
|
||||||
|
* resolve()/record() already makes re-importing the same product cheap
|
||||||
|
* and idempotent.
|
||||||
|
*/
|
||||||
|
class ImportShopifyProductJob implements ShouldQueue
|
||||||
|
{
|
||||||
|
use Batchable;
|
||||||
|
use Dispatchable;
|
||||||
|
use InteractsWithQueue;
|
||||||
|
use Queueable;
|
||||||
|
use SerializesModels;
|
||||||
|
|
||||||
|
public int $tries = 3;
|
||||||
|
|
||||||
|
public function __construct(
|
||||||
|
private readonly ProductGroup $group,
|
||||||
|
private readonly string $imagesPath,
|
||||||
|
private readonly CollectionGroup $collectionGroup,
|
||||||
|
private readonly Currency $currency,
|
||||||
|
private readonly ?string $locale,
|
||||||
|
) {
|
||||||
|
}
|
||||||
|
|
||||||
|
public function handle(ShopifyExportImporter $importer): void
|
||||||
|
{
|
||||||
|
if ($this->locale !== null) {
|
||||||
|
ImportLocale::set($this->locale);
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
$importer->importProduct($this->group, $this->imagesPath, $this->collectionGroup, $this->currency);
|
||||||
|
} finally {
|
||||||
|
// A queue worker process outlives a single job — this must
|
||||||
|
// not leak into whichever product the same worker picks up
|
||||||
|
// next.
|
||||||
|
ImportLocale::reset();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -7,7 +7,7 @@ use Lunar\FieldTypes\TranslatedText;
|
|||||||
use Lunar\Models\Collection;
|
use Lunar\Models\Collection;
|
||||||
use Lunar\Models\CollectionGroup;
|
use Lunar\Models\CollectionGroup;
|
||||||
use Lunar\Models\Product;
|
use Lunar\Models\Product;
|
||||||
use Modules\Core\MigrateImport\DefaultLocale;
|
use Modules\Core\MigrateImport\Services\ImportLocale;
|
||||||
|
|
||||||
class CollectionResolver
|
class CollectionResolver
|
||||||
{
|
{
|
||||||
@@ -45,7 +45,7 @@ class CollectionResolver
|
|||||||
'collection_group_id' => $group->id,
|
'collection_group_id' => $group->id,
|
||||||
'attribute_data' => [
|
'attribute_data' => [
|
||||||
'name' => new TranslatedText(collect([
|
'name' => new TranslatedText(collect([
|
||||||
DefaultLocale::code() => new Text($name),
|
ImportLocale::code() => new Text($name),
|
||||||
])),
|
])),
|
||||||
],
|
],
|
||||||
]);
|
]);
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ use Lunar\Models\Attribute;
|
|||||||
use Lunar\Models\AttributeGroup;
|
use Lunar\Models\AttributeGroup;
|
||||||
use Lunar\Models\Product;
|
use Lunar\Models\Product;
|
||||||
use Lunar\Models\ProductType;
|
use Lunar\Models\ProductType;
|
||||||
use Modules\Core\MigrateImport\DefaultLocale;
|
use Modules\Core\MigrateImport\Services\ImportLocale;
|
||||||
|
|
||||||
class ImportAttributeResolver
|
class ImportAttributeResolver
|
||||||
{
|
{
|
||||||
@@ -40,7 +40,7 @@ class ImportAttributeResolver
|
|||||||
[
|
[
|
||||||
'attribute_group_id' => $group->id,
|
'attribute_group_id' => $group->id,
|
||||||
'position' => $nextPosition++,
|
'position' => $nextPosition++,
|
||||||
'name' => [DefaultLocale::code() => $definition['label']],
|
'name' => [ImportLocale::code() => $definition['label']],
|
||||||
'section' => 'main',
|
'section' => 'main',
|
||||||
'type' => $definition['type'],
|
'type' => $definition['type'],
|
||||||
'required' => false,
|
'required' => false,
|
||||||
@@ -49,7 +49,7 @@ class ImportAttributeResolver
|
|||||||
? ['richtext' => false]
|
? ['richtext' => false]
|
||||||
: [],
|
: [],
|
||||||
'system' => false,
|
'system' => false,
|
||||||
'description' => [DefaultLocale::code() => ''],
|
'description' => [ImportLocale::code() => ''],
|
||||||
],
|
],
|
||||||
);
|
);
|
||||||
|
|
||||||
@@ -62,7 +62,7 @@ class ImportAttributeResolver
|
|||||||
return AttributeGroup::firstOrCreate(
|
return AttributeGroup::firstOrCreate(
|
||||||
['attributable_type' => Product::morphName(), 'handle' => 'import'],
|
['attributable_type' => Product::morphName(), 'handle' => 'import'],
|
||||||
[
|
[
|
||||||
'name' => [DefaultLocale::code() => 'Additional Details'],
|
'name' => [ImportLocale::code() => 'Additional Details'],
|
||||||
'position' => 100,
|
'position' => 100,
|
||||||
],
|
],
|
||||||
);
|
);
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ use Lunar\FieldTypes\Number;
|
|||||||
use Lunar\FieldTypes\Text;
|
use Lunar\FieldTypes\Text;
|
||||||
use Lunar\FieldTypes\TranslatedText;
|
use Lunar\FieldTypes\TranslatedText;
|
||||||
use Lunar\Models\ProductType;
|
use Lunar\Models\ProductType;
|
||||||
use Modules\Core\MigrateImport\DefaultLocale;
|
use Modules\Core\MigrateImport\Services\ImportLocale;
|
||||||
|
|
||||||
class ProductAttributeResolver
|
class ProductAttributeResolver
|
||||||
{
|
{
|
||||||
@@ -43,7 +43,7 @@ class ProductAttributeResolver
|
|||||||
}
|
}
|
||||||
|
|
||||||
return new TranslatedText(collect([
|
return new TranslatedText(collect([
|
||||||
DefaultLocale::code() => new Text($value),
|
ImportLocale::code() => new Text($value),
|
||||||
]));
|
]));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ namespace Modules\Core\MigrateImport\Shopify\Resolvers;
|
|||||||
use Illuminate\Support\Str;
|
use Illuminate\Support\Str;
|
||||||
use Lunar\Models\ProductOption;
|
use Lunar\Models\ProductOption;
|
||||||
use Lunar\Models\ProductOptionValue;
|
use Lunar\Models\ProductOptionValue;
|
||||||
use Modules\Core\MigrateImport\DefaultLocale;
|
use Modules\Core\MigrateImport\Services\ImportLocale;
|
||||||
|
|
||||||
class ProductOptionResolver
|
class ProductOptionResolver
|
||||||
{
|
{
|
||||||
@@ -24,8 +24,8 @@ class ProductOptionResolver
|
|||||||
return ProductOption::query()->firstOrCreate(
|
return ProductOption::query()->firstOrCreate(
|
||||||
['handle' => $handle],
|
['handle' => $handle],
|
||||||
[
|
[
|
||||||
'name' => [DefaultLocale::code() => $name],
|
'name' => [ImportLocale::code() => $name],
|
||||||
'label' => [DefaultLocale::code() => $name],
|
'label' => [ImportLocale::code() => $name],
|
||||||
'shared' => true,
|
'shared' => true,
|
||||||
],
|
],
|
||||||
);
|
);
|
||||||
@@ -46,7 +46,7 @@ class ProductOptionResolver
|
|||||||
|
|
||||||
return $existing ?? ProductOptionValue::create([
|
return $existing ?? ProductOptionValue::create([
|
||||||
'product_option_id' => $option->id,
|
'product_option_id' => $option->id,
|
||||||
'name' => [DefaultLocale::code() => $value],
|
'name' => [ImportLocale::code() => $value],
|
||||||
]);
|
]);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
+2
-1
@@ -1,8 +1,9 @@
|
|||||||
<?php
|
<?php
|
||||||
|
|
||||||
namespace Modules\Core\MigrateImport\Shopify;
|
namespace Modules\Core\MigrateImport\Shopify\Services;
|
||||||
|
|
||||||
use RuntimeException;
|
use RuntimeException;
|
||||||
|
use Modules\Core\MigrateImport\Shopify\DTOs\ProductGroup;
|
||||||
|
|
||||||
class ShopifyCsvReader
|
class ShopifyCsvReader
|
||||||
{
|
{
|
||||||
+71
-9
@@ -1,9 +1,10 @@
|
|||||||
<?php
|
<?php
|
||||||
|
|
||||||
namespace Modules\Core\MigrateImport\Shopify;
|
namespace Modules\Core\MigrateImport\Shopify\Services;
|
||||||
|
|
||||||
use Lunar\Models\TaxClass;
|
use Lunar\Models\TaxClass;
|
||||||
use Lunar\Models\ProductOption;
|
use Lunar\Models\ProductOption;
|
||||||
|
use Illuminate\Support\Facades\Bus;
|
||||||
use Illuminate\Support\Facades\Log;
|
use Illuminate\Support\Facades\Log;
|
||||||
use Lunar\Models\Collection;
|
use Lunar\Models\Collection;
|
||||||
use Lunar\Models\CollectionGroup;
|
use Lunar\Models\CollectionGroup;
|
||||||
@@ -12,9 +13,13 @@ use Lunar\Models\Language;
|
|||||||
use Lunar\Models\Product;
|
use Lunar\Models\Product;
|
||||||
use Lunar\Models\ProductVariant;
|
use Lunar\Models\ProductVariant;
|
||||||
use Lunar\Models\Url;
|
use Lunar\Models\Url;
|
||||||
use Modules\Core\MigrateImport\ImportSpec;
|
use Modules\Core\Catalog\Services\SkuBackfillService;
|
||||||
use Modules\Core\MigrateImport\Importer;
|
use Modules\Core\MigrateImport\Services\ImportLocale;
|
||||||
|
use Modules\Core\MigrateImport\DTOs\ImportSpec;
|
||||||
|
use Modules\Core\MigrateImport\Shopify\DTOs\ProductGroup;
|
||||||
|
use Modules\Core\MigrateImport\Contracts\Importer;
|
||||||
use Modules\Core\MigrateImport\Models\ImportMapping;
|
use Modules\Core\MigrateImport\Models\ImportMapping;
|
||||||
|
use Modules\Core\MigrateImport\Shopify\Jobs\ImportShopifyProductJob;
|
||||||
use Modules\Core\MigrateImport\Shopify\Resolvers\AssetResolver;
|
use Modules\Core\MigrateImport\Shopify\Resolvers\AssetResolver;
|
||||||
use Modules\Core\MigrateImport\Shopify\Resolvers\BrandResolver;
|
use Modules\Core\MigrateImport\Shopify\Resolvers\BrandResolver;
|
||||||
use Modules\Core\MigrateImport\Shopify\Resolvers\CollectionResolver;
|
use Modules\Core\MigrateImport\Shopify\Resolvers\CollectionResolver;
|
||||||
@@ -46,9 +51,21 @@ class ShopifyExportImporter implements Importer
|
|||||||
) {
|
) {
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Dispatches one ImportShopifyProductJob per ProductGroup instead of
|
||||||
|
* importing them inline — see that job's own docblock for why (a
|
||||||
|
* single process holding every group in memory for the whole run
|
||||||
|
* kept exceeding queue:work's --memory limit on a large export,
|
||||||
|
* which kills the worker mid-run and restarts the entire import from
|
||||||
|
* scratch). Bus::batch()'s then() is what SkuBackfillService used to
|
||||||
|
* run right after this loop — now deferred until every product job
|
||||||
|
* in the batch has actually finished, since dispatching a batch
|
||||||
|
* itself returns immediately.
|
||||||
|
*/
|
||||||
public function import(ImportSpec $spec): void
|
public function import(ImportSpec $spec): void
|
||||||
{
|
{
|
||||||
$groups = $this->csvReader->read($spec->filePath);
|
$groups = $this->csvReader->read($spec->filePath);
|
||||||
|
$total = count($groups);
|
||||||
$imagesPath = dirname($spec->filePath).'/files';
|
$imagesPath = dirname($spec->filePath).'/files';
|
||||||
$collectionGroup = CollectionGroup::firstOrCreate(
|
$collectionGroup = CollectionGroup::firstOrCreate(
|
||||||
['handle' => 'shopify'],
|
['handle' => 'shopify'],
|
||||||
@@ -56,12 +73,30 @@ class ShopifyExportImporter implements Importer
|
|||||||
);
|
);
|
||||||
$currency = Currency::getDefault();
|
$currency = Currency::getDefault();
|
||||||
|
|
||||||
foreach ($groups as $group) {
|
Log::info('Shopify import: dispatching product jobs', ['total' => $total]);
|
||||||
$this->importProduct($group, $imagesPath, $collectionGroup, $currency);
|
|
||||||
}
|
$jobs = collect($groups)->map(fn (ProductGroup $group) => new ImportShopifyProductJob(
|
||||||
|
$group,
|
||||||
|
$imagesPath,
|
||||||
|
$collectionGroup,
|
||||||
|
$currency,
|
||||||
|
$spec->locale,
|
||||||
|
))->all();
|
||||||
|
|
||||||
|
Bus::batch($jobs)
|
||||||
|
->name("Shopify import: {$spec->filePath}")
|
||||||
|
->then(function () use ($total) {
|
||||||
|
Log::info('Shopify import: all product jobs finished, backfilling missing SKUs', ['total' => $total]);
|
||||||
|
app(SkuBackfillService::class)->backfill();
|
||||||
|
Log::info('Shopify import: finished', ['total' => $total]);
|
||||||
|
})
|
||||||
|
->catch(function ($batch, $e) {
|
||||||
|
Log::error('Shopify import: batch failed', ['error' => $e->getMessage()]);
|
||||||
|
})
|
||||||
|
->dispatch();
|
||||||
}
|
}
|
||||||
|
|
||||||
private function importProduct(
|
public function importProduct(
|
||||||
ProductGroup $group,
|
ProductGroup $group,
|
||||||
string $imagesPath,
|
string $imagesPath,
|
||||||
CollectionGroup $collectionGroup,
|
CollectionGroup $collectionGroup,
|
||||||
@@ -100,7 +135,12 @@ class ShopifyExportImporter implements Importer
|
|||||||
[
|
[
|
||||||
'element_type' => $product->getMorphClass(),
|
'element_type' => $product->getMorphClass(),
|
||||||
'element_id' => $product->id,
|
'element_id' => $product->id,
|
||||||
'language_id' => Language::getDefault()->id,
|
// ImportLocale, not Language::getDefault() — same
|
||||||
|
// reasoning as ProductAttributeResolver et al.: this
|
||||||
|
// product's handle/slug came from the export, written in
|
||||||
|
// whatever language the operator said the file is in,
|
||||||
|
// not necessarily this store's own default language.
|
||||||
|
'language_id' => Language::where('code', ImportLocale::code())->value('id'),
|
||||||
],
|
],
|
||||||
[
|
[
|
||||||
'slug' => $group->handle,
|
'slug' => $group->handle,
|
||||||
@@ -163,6 +203,12 @@ class ShopifyExportImporter implements Importer
|
|||||||
$variant->sku = trim((string) ($row['Variant SKU'] ?? '')) ?: null;
|
$variant->sku = trim((string) ($row['Variant SKU'] ?? '')) ?: null;
|
||||||
$variant->stock = (int) ($row['Variant Inventory Qty'] ?? 0);
|
$variant->stock = (int) ($row['Variant Inventory Qty'] ?? 0);
|
||||||
$variant->shippable = filter_var($row['Variant Requires Shipping'] ?? 'true', FILTER_VALIDATE_BOOLEAN);
|
$variant->shippable = filter_var($row['Variant Requires Shipping'] ?? 'true', FILTER_VALIDATE_BOOLEAN);
|
||||||
|
// Lunar's own column default is 'always' (purchasable regardless of
|
||||||
|
// stock) — wrong for an imported catalogue, whose Variant Inventory
|
||||||
|
// Qty is real, meaningful stock data. 'in_stock' makes purchasability
|
||||||
|
// actually respect it (see Modules\Core\Catalog\Services\
|
||||||
|
// StockService's own docblock on the three purchasable values).
|
||||||
|
$variant->purchasable = 'in_stock';
|
||||||
$variant->save();
|
$variant->save();
|
||||||
|
|
||||||
ImportMapping::record(self::SOURCE, 'variant', $externalId, $variant);
|
ImportMapping::record(self::SOURCE, 'variant', $externalId, $variant);
|
||||||
@@ -239,7 +285,23 @@ class ShopifyExportImporter implements Importer
|
|||||||
|
|
||||||
$existing = ImportMapping::resolve(self::SOURCE, 'image', $externalId);
|
$existing = ImportMapping::resolve(self::SOURCE, 'image', $externalId);
|
||||||
|
|
||||||
if ($existing instanceof Media) {
|
// ImportMapping is a durable record of "we already imported this,"
|
||||||
|
// but the Media row it points at can go stale — e.g. Command\
|
||||||
|
// WipeCatalogCommand deletes every Product (media included, via
|
||||||
|
// Spatie's own model-delete cleanup) without knowing this mapping
|
||||||
|
// exists, since the mapping ISN'T scoped to a single Product to
|
||||||
|
// clean up alongside it. Re-running an import afterward used to
|
||||||
|
// trust the cached Media object unconditionally — it still existed
|
||||||
|
// as a PHP object even though its underlying row (and file) were
|
||||||
|
// long gone, so every re-imported product silently got zero
|
||||||
|
// media, no error, no warning. Falls through to a fresh import
|
||||||
|
// whenever the mapping doesn't resolve to a real, still-attached
|
||||||
|
// Media row.
|
||||||
|
if ($existing instanceof Media
|
||||||
|
&& Media::whereKey($existing->getKey())->exists()
|
||||||
|
&& $existing->model_type === $product->getMorphClass()
|
||||||
|
&& (int) $existing->model_id === $product->id
|
||||||
|
) {
|
||||||
return $existing;
|
return $existing;
|
||||||
}
|
}
|
||||||
|
|
||||||
+50
-39
@@ -32,10 +32,6 @@ use ReflectionProperty;
|
|||||||
* could return a real, honest failure — see Payment\Support\
|
* could return a real, honest failure — see Payment\Support\
|
||||||
* TransactionDriverAdapter's own docblock for that history.
|
* TransactionDriverAdapter's own docblock for that history.
|
||||||
*
|
*
|
||||||
* Fix, for capture: wrap the action's own action() closure so that, on
|
|
||||||
* Halt, we call $action->sendFailureNotification() ourselves before letting
|
|
||||||
* the Halt continue propagating — everything else is untouched.
|
|
||||||
*
|
|
||||||
* Fix, for refund: same notification fix, but the action() closure is
|
* Fix, for refund: same notification fix, but the action() closure is
|
||||||
* replaced outright (not wrapped) rather than reused, because refund also
|
* replaced outright (not wrapped) rather than reused, because refund also
|
||||||
* needs a "Refund via" driver Select added to the modal (see
|
* needs a "Refund via" driver Select added to the modal (see
|
||||||
@@ -43,15 +39,28 @@ use ReflectionProperty;
|
|||||||
* Payment\Support\TransactionDriverAdapter::refundVia() instead of
|
* Payment\Support\TransactionDriverAdapter::refundVia() instead of
|
||||||
* Lunar\Models\Transaction::refund() — see fixRefundAction()'s own
|
* Lunar\Models\Transaction::refund() — see fixRefundAction()'s own
|
||||||
* docblock.
|
* docblock.
|
||||||
|
*
|
||||||
|
* Fix, for capture: same notification fix, but the action() closure is
|
||||||
|
* also replaced outright — the actual call is routed through
|
||||||
|
* Payment\Support\TransactionDriverAdapter::capture() instead of
|
||||||
|
* Lunar\Models\Transaction::capture() (see fixCaptureAction()), so a
|
||||||
|
* manual backoffice capture goes through the app's own payment driver
|
||||||
|
* registry and dispatches Payment\Events\PaymentCaptured exactly like a
|
||||||
|
* checkout-time capture does — the vendor path resolved
|
||||||
|
* Lunar\Facades\Payments (an entirely separate, unused driver registry)
|
||||||
|
* and never dispatched that event, which is why Order::status used to
|
||||||
|
* stay stuck on 'awaiting_payment' after a manual capture even though
|
||||||
|
* Modules\Core\Order\Listeners\ApplyResolvedPaymentStatus now advances it
|
||||||
|
* on PaymentCaptured.
|
||||||
*/
|
*/
|
||||||
class OrderRefundActionsExtension extends ViewPageExtension
|
class OrderActionsExtension extends ViewPageExtension
|
||||||
{
|
{
|
||||||
public function headerActions(array $actions): array
|
public function headerActions(array $actions): array
|
||||||
{
|
{
|
||||||
return array_map(
|
return array_map(
|
||||||
fn (Action $action) => match ($action->getName()) {
|
fn (Action $action) => match ($action->getName()) {
|
||||||
'refund' => $this->fixRefundAction($action),
|
'refund' => $this->fixRefundAction($action),
|
||||||
'capture' => $this->fixFailureNotification($action),
|
'capture' => $this->fixCaptureAction($action),
|
||||||
default => $action,
|
default => $action,
|
||||||
},
|
},
|
||||||
$actions,
|
$actions,
|
||||||
@@ -123,6 +132,41 @@ class OrderRefundActionsExtension extends ViewPageExtension
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Mirrors fixRefundAction()'s notification fix, but for the "amount"
|
||||||
|
* field already on the vendor schema — no extra field needed, since
|
||||||
|
* capture always goes back through the transaction's own original
|
||||||
|
* driver (there's no equivalent to refunding via a different driver).
|
||||||
|
*/
|
||||||
|
private function fixCaptureAction(Action $action): Action
|
||||||
|
{
|
||||||
|
return $action->action(function (array $data, Action $action) {
|
||||||
|
$transaction = Transaction::find($data['transaction']);
|
||||||
|
|
||||||
|
if (! $transaction instanceof CoreTransaction) {
|
||||||
|
$action->failureNotification(fn () => Notification::make('capture_failure')->danger()->title('Transaction not found.'))
|
||||||
|
->sendFailureNotification();
|
||||||
|
|
||||||
|
throw new Halt;
|
||||||
|
}
|
||||||
|
|
||||||
|
$response = app(TransactionDriverAdapter::class)->capture(
|
||||||
|
$transaction,
|
||||||
|
(int) bcmul((string) $data['amount'], (string) $transaction->order->currency->factor),
|
||||||
|
);
|
||||||
|
|
||||||
|
if (! $response->success) {
|
||||||
|
$action->failureNotification(
|
||||||
|
fn () => Notification::make('capture_failure')->color('danger')->title($response->message)
|
||||||
|
)->sendFailureNotification();
|
||||||
|
|
||||||
|
throw new Halt;
|
||||||
|
}
|
||||||
|
|
||||||
|
$action->success();
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return array<string, string>
|
* @return array<string, string>
|
||||||
*/
|
*/
|
||||||
@@ -163,37 +207,4 @@ class OrderRefundActionsExtension extends ViewPageExtension
|
|||||||
|
|
||||||
return $reflected->getValue($object);
|
return $reflected->getValue($object);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Wraps the action's own configured action() closure so that, if it
|
|
||||||
* halts (Lunar's closures throw via $action->halt() to signal failure —
|
|
||||||
* see this class's own docblock for why that alone never sends the
|
|
||||||
* notification queued via failureNotification()), we send that
|
|
||||||
* notification ourselves before letting the Halt continue propagating
|
|
||||||
* (still needed — it's what stops callMountedAction() from treating
|
|
||||||
* this as a success and closing the modal/committing the DB transaction).
|
|
||||||
*
|
|
||||||
* $this->evaluate() (not a plain call) matches exactly how Action::call()
|
|
||||||
* itself invokes the closure — Lunar's closures type-hint $data/$record/
|
|
||||||
* $action and rely on Filament's own container-style parameter
|
|
||||||
* resolution, not positional arguments.
|
|
||||||
*/
|
|
||||||
private function fixFailureNotification(Action $action): Action
|
|
||||||
{
|
|
||||||
$originalAction = $action->getActionFunction();
|
|
||||||
|
|
||||||
if ($originalAction === null) {
|
|
||||||
return $action;
|
|
||||||
}
|
|
||||||
|
|
||||||
return $action->action(function (array $arguments) use ($action, $originalAction) {
|
|
||||||
try {
|
|
||||||
return $action->evaluate($originalAction, $arguments);
|
|
||||||
} catch (Halt $exception) {
|
|
||||||
$action->sendFailureNotification();
|
|
||||||
|
|
||||||
throw $exception;
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
@@ -8,7 +8,7 @@ use Filament\Tables\Table;
|
|||||||
use Lunar\Admin\Support\Extending\BaseExtension;
|
use Lunar\Admin\Support\Extending\BaseExtension;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Same fix as OrderRefundActionsExtension, applied to the order lines
|
* Same fix as OrderActionsExtension, applied to the order lines
|
||||||
* table's "bulk_refund" toolbar action (Lunar\Admin\...\OrderItemsTable::
|
* table's "bulk_refund" toolbar action (Lunar\Admin\...\OrderItemsTable::
|
||||||
* getBulkRefundAction()) — see that class's docblock for the underlying
|
* getBulkRefundAction()) — see that class's docblock for the underlying
|
||||||
* Filament bug (failureNotification()+failure()+halt() never actually
|
* Filament bug (failureNotification()+failure()+halt() never actually
|
||||||
|
|||||||
@@ -42,6 +42,8 @@ class OrderPaymentMethodSummaryExtension extends ViewPageExtension
|
|||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
return PaymentMethod::where('type', $type)->value('name') ?? $type;
|
$method = PaymentMethod::where('type', $type)->first();
|
||||||
|
|
||||||
|
return $method?->translate('name') ?? $type;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,12 +2,19 @@
|
|||||||
|
|
||||||
namespace Modules\Core\Order\Listeners;
|
namespace Modules\Core\Order\Listeners;
|
||||||
|
|
||||||
|
use Illuminate\Contracts\Queue\ShouldQueue;
|
||||||
use Modules\Core\Order\Events\OrderDispatched;
|
use Modules\Core\Order\Events\OrderDispatched;
|
||||||
|
use Modules\Core\Order\Services\OrderStatusFlow;
|
||||||
use Modules\Core\Order\Services\OrderStatusWriter;
|
use Modules\Core\Order\Services\OrderStatusWriter;
|
||||||
use Modules\Core\Shipping\Enums\TrackingStatus;
|
use Modules\Core\Shipping\Enums\TrackingStatus;
|
||||||
use Modules\Core\Shipping\Events\ShipmentStatusUpdatedByCarrier;
|
use Modules\Core\Shipping\Events\ShipmentStatusUpdatedByCarrier;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* Queued — see Modules\Core\Order\Listeners\DeriveOrderDeliveredFromShipment's
|
||||||
|
* own docblock: ShipmentStatusUpdatedByCarrier comes from a scheduled
|
||||||
|
* polling job, not a webhook, so nothing needs this to complete before a
|
||||||
|
* request returns.
|
||||||
|
*
|
||||||
* The automatic half of "Dispatched" — the manual fallback is the staff
|
* The automatic half of "Dispatched" — the manual fallback is the staff
|
||||||
* "Update Status" action (Modules\Core\Shipping\Extensions\
|
* "Update Status" action (Modules\Core\Shipping\Extensions\
|
||||||
* OrderViewExtension). Listens to ShipmentStatusUpdatedByCarrier directly,
|
* OrderViewExtension). Listens to ShipmentStatusUpdatedByCarrier directly,
|
||||||
@@ -19,14 +26,17 @@ use Modules\Core\Shipping\Events\ShipmentStatusUpdatedByCarrier;
|
|||||||
* carrier that skips straight there without a distinct collection
|
* carrier that skips straight there without a distinct collection
|
||||||
* checkpoint.
|
* checkpoint.
|
||||||
*
|
*
|
||||||
* Guarded to only fire from 'ready_for_dispatch' — a late/duplicate
|
* Guarded by OrderStatusFlow::isValidTransition() rather than a hardcoded
|
||||||
* checkpoint, or an order the manual action already advanced, is a
|
* "only fire from 'ready_for_dispatch'" comparison — the single source of
|
||||||
* silent no-op.
|
* truth for the status graph lives there, not duplicated here. A
|
||||||
|
* late/duplicate checkpoint, or an order the manual action already
|
||||||
|
* advanced, is a silent no-op either way.
|
||||||
*/
|
*/
|
||||||
class AdvanceFulfillmentOnCarrierCheckpoint
|
class AdvanceFulfillmentOnCarrierCheckpoint implements ShouldQueue
|
||||||
{
|
{
|
||||||
public function __construct(
|
public function __construct(
|
||||||
private readonly OrderStatusWriter $writer,
|
private readonly OrderStatusWriter $writer,
|
||||||
|
private readonly OrderStatusFlow $flow,
|
||||||
) {}
|
) {}
|
||||||
|
|
||||||
public function handle(ShipmentStatusUpdatedByCarrier $event): void
|
public function handle(ShipmentStatusUpdatedByCarrier $event): void
|
||||||
@@ -38,7 +48,7 @@ class AdvanceFulfillmentOnCarrierCheckpoint
|
|||||||
|
|
||||||
$order = $event->shipmentInfo->shipment->order;
|
$order = $event->shipmentInfo->shipment->order;
|
||||||
|
|
||||||
if (! $order || $order->status !== 'ready_for_dispatch') {
|
if (! $order || ! $this->flow->isValidTransition($order, 'dispatched')) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -2,10 +2,18 @@
|
|||||||
|
|
||||||
namespace Modules\Core\Order\Listeners;
|
namespace Modules\Core\Order\Listeners;
|
||||||
|
|
||||||
|
use Illuminate\Contracts\Queue\ShouldQueue;
|
||||||
use Modules\Core\Order\Events\OrderDelivered;
|
use Modules\Core\Order\Events\OrderDelivered;
|
||||||
|
use Modules\Core\Order\Services\OrderStatusFlow;
|
||||||
use Modules\Core\Order\Services\OrderStatusWriter;
|
use Modules\Core\Order\Services\OrderStatusWriter;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* Queued — OrderDelivered is only ever dispatched from Modules\Core\Order\
|
||||||
|
* Listeners\DeriveOrderDeliveredFromShipment, itself queued (see that
|
||||||
|
* class's own docblock: the triggering ShipmentStatusUpdatedByCarrier
|
||||||
|
* comes from a scheduled polling job, not a request with a page waiting
|
||||||
|
* on the result).
|
||||||
|
*
|
||||||
* Writes `status` to 'delivered' once a carrier confirms delivery, rather
|
* Writes `status` to 'delivered' once a carrier confirms delivery, rather
|
||||||
* than jumping straight to 'completed'. Carrier orders get a return
|
* than jumping straight to 'completed'. Carrier orders get a return
|
||||||
* window between delivery and completion (see Modules\Core\Order\
|
* window between delivery and completion (see Modules\Core\Order\
|
||||||
@@ -20,21 +28,23 @@ use Modules\Core\Order\Services\OrderStatusWriter;
|
|||||||
* OrderDelivered — deriving "was this delivered" and acting on it by
|
* OrderDelivered — deriving "was this delivered" and acting on it by
|
||||||
* writing `status` are deliberately two different listeners.
|
* writing `status` are deliberately two different listeners.
|
||||||
*
|
*
|
||||||
* Guarded to only fire from 'dispatched' — a duplicate/late Delivered
|
* Guarded by OrderStatusFlow::isValidTransition() rather than a hardcoded
|
||||||
|
* "only fire from 'dispatched'" comparison. A duplicate/late Delivered
|
||||||
* checkpoint, or an order a manual action already moved past, is a
|
* checkpoint, or an order a manual action already moved past, is a
|
||||||
* silent no-op.
|
* silent no-op either way.
|
||||||
*/
|
*/
|
||||||
class AdvanceFulfillmentOnDelivered
|
class AdvanceFulfillmentOnDelivered implements ShouldQueue
|
||||||
{
|
{
|
||||||
public function __construct(
|
public function __construct(
|
||||||
private readonly OrderStatusWriter $writer,
|
private readonly OrderStatusWriter $writer,
|
||||||
|
private readonly OrderStatusFlow $flow,
|
||||||
) {}
|
) {}
|
||||||
|
|
||||||
public function handle(OrderDelivered $event): void
|
public function handle(OrderDelivered $event): void
|
||||||
{
|
{
|
||||||
$order = $event->order;
|
$order = $event->order;
|
||||||
|
|
||||||
if ($order->status !== 'dispatched') {
|
if (! $this->flow->isValidTransition($order, 'delivered')) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -2,12 +2,8 @@
|
|||||||
|
|
||||||
namespace Modules\Core\Order\Listeners;
|
namespace Modules\Core\Order\Listeners;
|
||||||
|
|
||||||
use Illuminate\Support\Facades\Event;
|
|
||||||
use Lunar\Models\Order;
|
use Lunar\Models\Order;
|
||||||
use Modules\Core\Checkout\Events\OrderPlaced;
|
use Modules\Core\Order\Services\OrderPaymentResolutionService;
|
||||||
use Modules\Core\Order\Enums\PaymentStatus;
|
|
||||||
use Modules\Core\Order\Services\OrderStatusWriter;
|
|
||||||
use Modules\Core\Order\Support\OrderStatus;
|
|
||||||
use Modules\Core\Payment\Events\PaymentAuthorized;
|
use Modules\Core\Payment\Events\PaymentAuthorized;
|
||||||
use Modules\Core\Payment\Events\PaymentCaptured;
|
use Modules\Core\Payment\Events\PaymentCaptured;
|
||||||
use Modules\Core\Payment\Events\PaymentRefunded;
|
use Modules\Core\Payment\Events\PaymentRefunded;
|
||||||
@@ -16,34 +12,24 @@ use Modules\Core\Payment\Events\PaymentRefunded;
|
|||||||
* Registered against PaymentCaptured, PaymentAuthorized, AND
|
* Registered against PaymentCaptured, PaymentAuthorized, AND
|
||||||
* PaymentRefunded (see OrderServiceProvider).
|
* PaymentRefunded (see OrderServiceProvider).
|
||||||
*
|
*
|
||||||
* A capture/authorization only ever writes Order::paid/paid_at (via
|
* A thin reactor — resolves which Order this outcome belongs to (Payment
|
||||||
* OrderStatusWriter::markPaid()) — never `status`. Confirmed with the
|
* has no concept of an Order, so this reads $event->context['order_id'])
|
||||||
* user: status leaving 'awaiting_payment' is always a staff-driven
|
* and hands off to Modules\Core\Order\Services\
|
||||||
* "Update Status" click, regardless of payment method — no special-casing
|
* OrderPaymentResolutionService for the actual decisions: whether to mark
|
||||||
* prepaid vs. cash-on-delivery. A prepaid order briefly sitting at
|
* the order paid, whether/how far to advance `status`, and what a refund
|
||||||
* 'awaiting_payment' with paid = true (until staff notice and advance it)
|
* does to it. See that service's own docblock, and its methods' own
|
||||||
* is expected, not a bug.
|
* docblocks, for the full business reasoning (re-confirmed with the
|
||||||
*
|
* user): a captured payment, manual or via Stripe's webhook, should
|
||||||
* A refund still moves `status` (returned -> refunded/partially_refunded)
|
* never leave an order sitting at 'awaiting_payment'; an authorization
|
||||||
* — refunds are a normal step in Modules\Core\Order\Services\
|
* only marks paid, since it isn't yet captured funds; a refund is a
|
||||||
* OrderStatusFlow's own sequence, unlike captures. Derives
|
* normal step in the order's own status sequence, unlike a capture.
|
||||||
* Refunded/PartialRefund from Modules\Core\Order\Support\OrderStatus::
|
|
||||||
* payment() — the existing, unchanged derived-enum logic, reused rather
|
|
||||||
* than reimplemented.
|
|
||||||
*
|
|
||||||
* Reads $event->context['order_id'] to find which Order this outcome
|
|
||||||
* belongs to — Payment has no concept of an Order.
|
|
||||||
*
|
|
||||||
* Dispatches Checkout\Events\OrderPlaced itself, once placed_at is set.
|
|
||||||
* Never fires from the PaymentRefunded path — a refund can only ever
|
|
||||||
* happen after an order was already placed.
|
|
||||||
*
|
*
|
||||||
* Deliberately does NOT react to PaymentVoided.
|
* Deliberately does NOT react to PaymentVoided.
|
||||||
*/
|
*/
|
||||||
class ApplyResolvedPaymentStatus
|
class ApplyResolvedPaymentStatus
|
||||||
{
|
{
|
||||||
public function __construct(
|
public function __construct(
|
||||||
private readonly OrderStatusWriter $writer,
|
private readonly OrderPaymentResolutionService $resolution,
|
||||||
) {}
|
) {}
|
||||||
|
|
||||||
public function handle(PaymentCaptured|PaymentAuthorized|PaymentRefunded $event): void
|
public function handle(PaymentCaptured|PaymentAuthorized|PaymentRefunded $event): void
|
||||||
@@ -57,40 +43,11 @@ class ApplyResolvedPaymentStatus
|
|||||||
$order = Order::findOrFail($orderId);
|
$order = Order::findOrFail($orderId);
|
||||||
|
|
||||||
if ($event instanceof PaymentRefunded) {
|
if ($event instanceof PaymentRefunded) {
|
||||||
$this->applyRefund($order, $event);
|
$this->resolution->resolveRefund($order, $event::class);
|
||||||
|
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
$wasPlaced = ! blank($order->placed_at);
|
$this->resolution->resolveCaptureOrAuthorization($order, $event::class, isCapture: $event instanceof PaymentCaptured);
|
||||||
|
|
||||||
$this->writer->markPaid($order, $event::class);
|
|
||||||
|
|
||||||
if (! $wasPlaced) {
|
|
||||||
$order->update(['placed_at' => $order->placed_at ?? now()]);
|
|
||||||
Event::dispatch(new OrderPlaced($order));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Requires the refund Transaction row to already exist (Modules\Core\
|
|
||||||
* Order\Listeners\RecordPaymentTransaction must run first — see
|
|
||||||
* OrderServiceProvider's listener registration order for
|
|
||||||
* PaymentRefunded), so the relation is refreshed here rather than
|
|
||||||
* trusted from a possibly-stale $order instance.
|
|
||||||
*/
|
|
||||||
private function applyRefund(Order $order, PaymentRefunded $event): void
|
|
||||||
{
|
|
||||||
$order->load('transactions');
|
|
||||||
|
|
||||||
$target = match (OrderStatus::payment($order)) {
|
|
||||||
PaymentStatus::Refunded => 'refunded',
|
|
||||||
PaymentStatus::PartialRefund => 'partially_refunded',
|
|
||||||
default => null,
|
|
||||||
};
|
|
||||||
|
|
||||||
if ($target !== null && $order->status !== $target) {
|
|
||||||
$this->writer->write($order, $target, $event::class);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -4,9 +4,19 @@ namespace Modules\Core\Order\Listeners;
|
|||||||
|
|
||||||
use Modules\Core\Order\Events\OrderCompleted;
|
use Modules\Core\Order\Events\OrderCompleted;
|
||||||
use Modules\Core\Order\Events\OrderPickedUp;
|
use Modules\Core\Order\Events\OrderPickedUp;
|
||||||
|
use Modules\Core\Order\Services\OrderStatusFlow;
|
||||||
use Modules\Core\Order\Services\OrderStatusWriter;
|
use Modules\Core\Order\Services\OrderStatusWriter;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* Deliberately NOT queued — OrderPickedUp is dispatched from a staff
|
||||||
|
* Filament action (see OrderFulfillmentService::markPickedUp()), and the
|
||||||
|
* page staff are looking at needs to show `status` as 'completed'
|
||||||
|
* immediately after they click, not still 'picked_up' until a queue
|
||||||
|
* worker catches up. Unlike ShipmentStatusUpdatedByCarrier's listeners
|
||||||
|
* (queued — dispatched from a scheduled polling job with no page waiting
|
||||||
|
* on the result), this one has a real same-request/same-page-load
|
||||||
|
* dependency.
|
||||||
|
*
|
||||||
* The store-pickup mirror of AdvanceFulfillmentOnDelivered — reacts to
|
* The store-pickup mirror of AdvanceFulfillmentOnDelivered — reacts to
|
||||||
* OrderPickedUp (dispatched by Modules\Core\Order\Services\
|
* OrderPickedUp (dispatched by Modules\Core\Order\Services\
|
||||||
* OrderFulfillmentService::markPickedUp() the moment staff confirm the
|
* OrderFulfillmentService::markPickedUp() the moment staff confirm the
|
||||||
@@ -15,20 +25,22 @@ use Modules\Core\Order\Services\OrderStatusWriter;
|
|||||||
* business design — unlike the carrier branch, there is no 'delivered'
|
* business design — unlike the carrier branch, there is no 'delivered'
|
||||||
* intermediate value on this path.
|
* intermediate value on this path.
|
||||||
*
|
*
|
||||||
* Guarded to only fire from 'picked_up' — a duplicate dispatch (e.g. a
|
* Guarded by OrderStatusFlow::isValidTransition() rather than a hardcoded
|
||||||
* stale page re-submitting the action) is a silent no-op.
|
* "only fire from 'picked_up'" comparison. A duplicate dispatch (e.g. a
|
||||||
|
* stale page re-submitting the action) is a silent no-op either way.
|
||||||
*/
|
*/
|
||||||
class CompleteOrderOnPickedUp
|
class CompleteOrderOnPickedUp
|
||||||
{
|
{
|
||||||
public function __construct(
|
public function __construct(
|
||||||
private readonly OrderStatusWriter $writer,
|
private readonly OrderStatusWriter $writer,
|
||||||
|
private readonly OrderStatusFlow $flow,
|
||||||
) {}
|
) {}
|
||||||
|
|
||||||
public function handle(OrderPickedUp $event): void
|
public function handle(OrderPickedUp $event): void
|
||||||
{
|
{
|
||||||
$order = $event->order;
|
$order = $event->order;
|
||||||
|
|
||||||
if ($order->status !== 'picked_up') {
|
if (! $this->flow->isValidTransition($order, 'completed')) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -2,63 +2,38 @@
|
|||||||
|
|
||||||
namespace Modules\Core\Order\Listeners;
|
namespace Modules\Core\Order\Listeners;
|
||||||
|
|
||||||
use Illuminate\Support\Facades\DB;
|
use Modules\Core\Catalog\Services\StockService;
|
||||||
use Lunar\Models\Product;
|
|
||||||
use Lunar\Models\ProductVariant;
|
|
||||||
use Modules\Core\Checkout\Events\OrderPlaced;
|
use Modules\Core\Checkout\Events\OrderPlaced;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The only place ProductVariant::stock is written as a result of an order —
|
* Deliberately NOT queued — unlike this codebase's other queued side
|
||||||
* fires once per order regardless of capture_mode/driver, same reasoning as
|
* effects (cache flushes, audit logs, search reindexes), a stalled queue
|
||||||
* Modules\Core\Order\Notifications\OrderPlacedNotification: OrderPlaced is
|
* here isn't just cosmetic staleness: it widens the window in which
|
||||||
* dispatched exactly once, from the one place an order's placed_at
|
* another order can be accepted against stock this order already
|
||||||
* actually gets set (Modules\Core\Order\Listeners\ApplyResolvedPaymentStatus),
|
* committed (Lunar has no stock-reservation step at checkout time to
|
||||||
* so this can't double-decrement across a capture/authorize/refund sequence
|
* begin with — see StockService's own "Never lets stock go negative"
|
||||||
* the way listening to PaymentCaptured directly could.
|
* note — so some oversell race already exists, but a queue stall of
|
||||||
|
* minutes/hours extends that window far past the sub-millisecond one a
|
||||||
|
* synchronous write leaves open). StockService's atomic `GREATEST(stock -
|
||||||
|
* qty, 0)` SQL still protects against a LOST update between two orders
|
||||||
|
* decrementing the same variant concurrently; running it synchronously
|
||||||
|
* keeps the exposure window as small as possible on top of that.
|
||||||
*
|
*
|
||||||
* Only decrements for `purchasable === 'in_stock'` variants — 'always' and
|
* The actual decrement logic lives in Modules\Core\Catalog\Services\
|
||||||
* 'backorder' variants are deliberately allowed to sell past (or without
|
* StockService — stock (the column, its invariants) is a Catalog concern,
|
||||||
* regard to) their stock count already (see ProductVariant::
|
* not an Order one; this listener is just the "an order was placed"
|
||||||
* canBeFulfilledAtQuantity()), so decrementing their stock would just make
|
* trigger. Fires once per order regardless of capture_mode/driver, same
|
||||||
* that column an inaccurate, decreasingly-negative number with no purchasing
|
* reasoning as Modules\Core\Order\Notifications\OrderPlacedNotification:
|
||||||
* consequence. Only `OrderLine::type === 'physical'` lines are considered —
|
* OrderPlaced is dispatched exactly once, from the one place an order's
|
||||||
* a digital line has no stock to decrement (ProductVariant::getType()).
|
* placed_at actually gets set (Modules\Core\Order\Listeners\
|
||||||
*
|
* ApplyResolvedPaymentStatus), so this can't double-decrement across a
|
||||||
* A single UPDATE per variant (`DB::table(...)->decrement()`), not a
|
* capture/authorize/refund sequence the way listening to PaymentCaptured
|
||||||
* read-then-write on the Eloquent model — avoids a lost-update race between
|
* directly could.
|
||||||
* two orders decrementing the same variant concurrently, and skips
|
|
||||||
* Modules\Core\Catalog\Services\ProductIndexer::stock's staleness gap for
|
|
||||||
* the DB value itself even though the search index still only refreshes on
|
|
||||||
* the next reindex event/nightly job (see that class's own docblock).
|
|
||||||
*
|
|
||||||
* Never lets stock go negative (`GREATEST(stock - qty, 0)` via a raw
|
|
||||||
* expression) — an order can still be placed against a variant whose stock
|
|
||||||
* was already fully consumed by another concurrent order (Lunar has no
|
|
||||||
* stock-reservation step at cart/checkout time), so this is a best-effort
|
|
||||||
* count, not a hard inventory guarantee.
|
|
||||||
*/
|
*/
|
||||||
class DecrementStockOnOrderPlaced
|
class DecrementStockOnOrderPlaced
|
||||||
{
|
{
|
||||||
public function handle(OrderPlaced $event): void
|
public function handle(OrderPlaced $event): void
|
||||||
{
|
{
|
||||||
$lines = $event->order->lines()
|
app(StockService::class)->decrementForOrder($event->order);
|
||||||
->where('type', 'physical')
|
|
||||||
->where('purchasable_type', ProductVariant::morphName())
|
|
||||||
->get(['purchasable_id', 'quantity']);
|
|
||||||
|
|
||||||
foreach ($lines as $line) {
|
|
||||||
DB::table((new ProductVariant())->getTable())
|
|
||||||
->where('id', $line->purchasable_id)
|
|
||||||
->where('purchasable', 'in_stock')
|
|
||||||
->update([
|
|
||||||
'stock' => DB::raw('GREATEST(stock - '.(int) $line->quantity.', 0)'),
|
|
||||||
]);
|
|
||||||
}
|
|
||||||
|
|
||||||
$productIds = ProductVariant::whereIn('id', $lines->pluck('purchasable_id'))
|
|
||||||
->pluck('product_id')
|
|
||||||
->unique();
|
|
||||||
|
|
||||||
Product::whereIn('id', $productIds)->get()->each->searchable();
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,17 +2,23 @@
|
|||||||
|
|
||||||
namespace Modules\Core\Order\Listeners;
|
namespace Modules\Core\Order\Listeners;
|
||||||
|
|
||||||
|
use Illuminate\Contracts\Queue\ShouldQueue;
|
||||||
use Modules\Core\Order\Events\OrderDelivered;
|
use Modules\Core\Order\Events\OrderDelivered;
|
||||||
use Modules\Core\Shipping\Enums\TrackingStatus;
|
use Modules\Core\Shipping\Enums\TrackingStatus;
|
||||||
use Modules\Core\Shipping\Events\ShipmentStatusUpdatedByCarrier;
|
use Modules\Core\Shipping\Events\ShipmentStatusUpdatedByCarrier;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* Queued — ShipmentStatusUpdatedByCarrier is dispatched from
|
||||||
|
* Modules\Core\Shipping\Jobs\PollShipmentTrackingJob, a scheduled job with
|
||||||
|
* no HTTP request waiting on a response, so there is no same-request
|
||||||
|
* timing pressure for any of this event's listeners (unlike a webhook).
|
||||||
|
*
|
||||||
* Translates a carrier tracking checkpoint into OrderDelivered — the event
|
* Translates a carrier tracking checkpoint into OrderDelivered — the event
|
||||||
* OrderDeliveredNotification (via NotificationRegistry) actually listens
|
* OrderDeliveredNotification (via NotificationRegistry) actually listens
|
||||||
* to. Kept separate from the notification itself so the "is this checkpoint
|
* to. Kept separate from the notification itself so the "is this checkpoint
|
||||||
* a delivery" filtering doesn't leak into notification code.
|
* a delivery" filtering doesn't leak into notification code.
|
||||||
*/
|
*/
|
||||||
class DeriveOrderDeliveredFromShipment
|
class DeriveOrderDeliveredFromShipment implements ShouldQueue
|
||||||
{
|
{
|
||||||
public function handle(ShipmentStatusUpdatedByCarrier $event): void
|
public function handle(ShipmentStatusUpdatedByCarrier $event): void
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -2,20 +2,28 @@
|
|||||||
|
|
||||||
namespace Modules\Core\Order\Listeners;
|
namespace Modules\Core\Order\Listeners;
|
||||||
|
|
||||||
|
use Illuminate\Contracts\Queue\ShouldQueue;
|
||||||
|
use Modules\Core\Order\Services\OrderStatusFlow;
|
||||||
use Modules\Core\Order\Services\OrderStatusWriter;
|
use Modules\Core\Order\Services\OrderStatusWriter;
|
||||||
use Modules\Core\Shipping\Enums\TrackingStatus;
|
use Modules\Core\Shipping\Enums\TrackingStatus;
|
||||||
use Modules\Core\Shipping\Events\ShipmentStatusUpdatedByCarrier;
|
use Modules\Core\Shipping\Events\ShipmentStatusUpdatedByCarrier;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* Queued — see Modules\Core\Order\Listeners\DeriveOrderDeliveredFromShipment's
|
||||||
|
* own docblock: ShipmentStatusUpdatedByCarrier comes from a scheduled
|
||||||
|
* polling job, not a webhook.
|
||||||
|
*
|
||||||
* Wires TrackingStatus::Failed to the 'delivery_failed' status for the
|
* Wires TrackingStatus::Failed to the 'delivery_failed' status for the
|
||||||
* first time — previously an unused enum case. Guarded to only fire from
|
* first time — previously an unused enum case. Guarded by
|
||||||
* 'dispatched': a stale/duplicate checkpoint, or an order a manual action
|
* OrderStatusFlow::isValidTransition() rather than a hardcoded "only fire
|
||||||
* already moved past, is a silent no-op.
|
* from 'dispatched'" comparison. A stale/duplicate checkpoint, or an
|
||||||
|
* order a manual action already moved past, is a silent no-op either way.
|
||||||
*/
|
*/
|
||||||
class MarkDeliveryFailedOnCarrierCheckpoint
|
class MarkDeliveryFailedOnCarrierCheckpoint implements ShouldQueue
|
||||||
{
|
{
|
||||||
public function __construct(
|
public function __construct(
|
||||||
private readonly OrderStatusWriter $writer,
|
private readonly OrderStatusWriter $writer,
|
||||||
|
private readonly OrderStatusFlow $flow,
|
||||||
) {}
|
) {}
|
||||||
|
|
||||||
public function handle(ShipmentStatusUpdatedByCarrier $event): void
|
public function handle(ShipmentStatusUpdatedByCarrier $event): void
|
||||||
@@ -26,7 +34,7 @@ class MarkDeliveryFailedOnCarrierCheckpoint
|
|||||||
|
|
||||||
$order = $event->shipmentInfo->shipment->order;
|
$order = $event->shipmentInfo->shipment->order;
|
||||||
|
|
||||||
if (! $order || $order->status !== 'dispatched') {
|
if (! $order || ! $this->flow->isValidTransition($order, 'delivery_failed')) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,66 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Modules\Core\Order\Listeners;
|
||||||
|
|
||||||
|
use Illuminate\Support\Facades\Event;
|
||||||
|
use Lunar\Models\Order;
|
||||||
|
use Modules\Core\Checkout\Events\OrderPlaced;
|
||||||
|
use Modules\Core\Order\Services\OrderPaymentResolutionService;
|
||||||
|
use Modules\Core\Payment\Events\PaymentDeferred;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Deliberately NOT queued — the storefront's own post-checkout
|
||||||
|
* confirmation page (Modules\Core\Checkout\Http\Controllers\
|
||||||
|
* CheckoutController::orderStatus()/confirmation(), per docs/checkout.md)
|
||||||
|
* looks up the order by placed_at being set immediately after
|
||||||
|
* initiatePayment() returns; a stalled queue would show the shopper a
|
||||||
|
* blank/failed confirmation for an order that, in the database, already
|
||||||
|
* exists and was genuinely placed. Same reasoning as
|
||||||
|
* DecrementStockOnOrderPlaced staying synchronous — this is the listener
|
||||||
|
* that makes DecrementStockOnOrderPlaced fire at all for a COD order (see
|
||||||
|
* OrderServiceProvider: OrderPlaced => DecrementStockOnOrderPlaced),
|
||||||
|
* so queueing this one would just move the same stock-oversell risk one
|
||||||
|
* hop earlier.
|
||||||
|
*
|
||||||
|
* A thin reactor, same shape as ApplyResolvedPaymentStatus — the actual
|
||||||
|
* decisions ("this order counts as placed the moment a deferred-payment
|
||||||
|
* driver resolves, independent of Order::paid" and "such an order also
|
||||||
|
* has nothing to sit at awaiting_payment for") live in PaymentDeferred's
|
||||||
|
* and OrderPaymentResolutionService::resolveDeferredPayment()'s own
|
||||||
|
* docblocks, re-confirmed with the user; this only extracts the order id
|
||||||
|
* and applies both, guarded against a duplicate/replayed event the same
|
||||||
|
* way OrderPaymentResolutionService::resolveCaptureOrAuthorization() is.
|
||||||
|
*
|
||||||
|
* Without the status advance below, a COD order was left sitting at
|
||||||
|
* 'awaiting_payment' forever — placed_at/OrderPlaced alone fixed order
|
||||||
|
* visibility and stock decrement, but nothing ever moved `status` off its
|
||||||
|
* initial value, since resolveCaptureOrAuthorization() only does that for
|
||||||
|
* an actual capture. Caught and fixed after the fact.
|
||||||
|
*/
|
||||||
|
class MarkOrderPlacedOnDeferredPayment
|
||||||
|
{
|
||||||
|
public function __construct(
|
||||||
|
private readonly OrderPaymentResolutionService $resolution,
|
||||||
|
) {}
|
||||||
|
|
||||||
|
public function handle(PaymentDeferred $event): void
|
||||||
|
{
|
||||||
|
$orderId = $event->context['order_id'] ?? null;
|
||||||
|
|
||||||
|
if ($orderId === null) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
$order = Order::findOrFail($orderId);
|
||||||
|
|
||||||
|
$this->resolution->resolveDeferredPayment($order, self::class);
|
||||||
|
|
||||||
|
if (! blank($order->placed_at)) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
$order->update(['placed_at' => now()]);
|
||||||
|
|
||||||
|
Event::dispatch(new OrderPlaced($order));
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -10,6 +10,17 @@ use Modules\Core\Payment\Events\PaymentRefunded;
|
|||||||
use Modules\Core\Payment\Events\PaymentVoided;
|
use Modules\Core\Payment\Events\PaymentVoided;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* Deliberately NOT queued, despite looking like a pure audit-trail write
|
||||||
|
* with no same-request reader — Modules\Core\Providers\
|
||||||
|
* OrderServiceProvider registers this to run BEFORE
|
||||||
|
* Modules\Core\Order\Listeners\ApplyResolvedPaymentStatus for
|
||||||
|
* PaymentRefunded specifically, because that listener's refund-status
|
||||||
|
* resolution reads the Transaction row this listener just wrote. Queueing
|
||||||
|
* this would run it asynchronously while ApplyResolvedPaymentStatus (sync)
|
||||||
|
* proceeds immediately, almost certainly executing before the queued job
|
||||||
|
* and silently breaking that read. See OrderServiceProvider's own
|
||||||
|
* registration-order comment.
|
||||||
|
*
|
||||||
* Writes the Transaction row for a successful payment outcome — the
|
* Writes the Transaction row for a successful payment outcome — the
|
||||||
* "record what happened" half of reacting to Payment's events, separate
|
* "record what happened" half of reacting to Payment's events, separate
|
||||||
* from Modules\Core\Order\Listeners\ApplyResolvedPaymentStatus's "update
|
* from Modules\Core\Order\Listeners\ApplyResolvedPaymentStatus's "update
|
||||||
|
|||||||
@@ -2,11 +2,16 @@
|
|||||||
|
|
||||||
namespace Modules\Core\Order\Listeners;
|
namespace Modules\Core\Order\Listeners;
|
||||||
|
|
||||||
|
use Illuminate\Contracts\Queue\ShouldQueue;
|
||||||
use Modules\Core\Order\Events\OrderPaidChanged;
|
use Modules\Core\Order\Events\OrderPaidChanged;
|
||||||
use Modules\Core\Order\Events\OrderStatusChanged;
|
use Modules\Core\Order\Events\OrderStatusChanged;
|
||||||
use Modules\Core\Order\Services\OrderStatusTransitionRecorder;
|
use Modules\Core\Order\Services\OrderStatusTransitionRecorder;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* Queued — a pure history-log write with no same-request reader anywhere
|
||||||
|
* in the codebase (no Filament page renders order_status_transitions
|
||||||
|
* immediately after a status change; it's browsed later, if at all).
|
||||||
|
*
|
||||||
* The one place order_status_transitions rows actually get written —
|
* The one place order_status_transitions rows actually get written —
|
||||||
* listens to OrderStatusChanged (every write of the single `status`
|
* listens to OrderStatusChanged (every write of the single `status`
|
||||||
* column, via Modules\Core\Order\Services\OrderStatusWriter::write()) and
|
* column, via Modules\Core\Order\Services\OrderStatusWriter::write()) and
|
||||||
@@ -15,7 +20,7 @@ use Modules\Core\Order\Services\OrderStatusTransitionRecorder;
|
|||||||
* one consistent audit trail entry ('paid', with a null from_status)
|
* one consistent audit trail entry ('paid', with a null from_status)
|
||||||
* rather than a second, separate table.
|
* rather than a second, separate table.
|
||||||
*/
|
*/
|
||||||
class RecordStatusTransition
|
class RecordStatusTransition implements ShouldQueue
|
||||||
{
|
{
|
||||||
public function __construct(
|
public function __construct(
|
||||||
private readonly OrderStatusTransitionRecorder $recorder,
|
private readonly OrderStatusTransitionRecorder $recorder,
|
||||||
|
|||||||
@@ -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;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -8,6 +8,8 @@ use Modules\Core\Order\DTOs\OrderFulfillmentResult;
|
|||||||
use Modules\Core\Order\Events\OrderPickedUp;
|
use Modules\Core\Order\Events\OrderPickedUp;
|
||||||
use Modules\Core\Order\Events\OrderReadyForDispatch;
|
use Modules\Core\Order\Events\OrderReadyForDispatch;
|
||||||
use Modules\Core\Order\Events\OrderReadyForPickup;
|
use Modules\Core\Order\Events\OrderReadyForPickup;
|
||||||
|
use Modules\Core\Payment\DTOs\PaymentResult;
|
||||||
|
use Modules\Core\Payment\Enums\PaymentResultStatus;
|
||||||
use Modules\Core\Shipping\Contracts\CarrierFulfillmentInterface;
|
use Modules\Core\Shipping\Contracts\CarrierFulfillmentInterface;
|
||||||
use Modules\Core\Shipping\DTOs\ShipmentRequest;
|
use Modules\Core\Shipping\DTOs\ShipmentRequest;
|
||||||
use Throwable;
|
use Throwable;
|
||||||
@@ -31,6 +33,7 @@ class OrderFulfillmentService
|
|||||||
public function __construct(
|
public function __construct(
|
||||||
private readonly OrderStatusWriter $writer,
|
private readonly OrderStatusWriter $writer,
|
||||||
private readonly OrderStatusFlow $flow,
|
private readonly OrderStatusFlow $flow,
|
||||||
|
private readonly TransactionRecorder $transactions,
|
||||||
) {}
|
) {}
|
||||||
|
|
||||||
public function markReady(Order $order): OrderFulfillmentResult
|
public function markReady(Order $order): OrderFulfillmentResult
|
||||||
@@ -121,6 +124,39 @@ class OrderFulfillmentService
|
|||||||
return OrderFulfillmentResult::failure('This order cannot be marked paid right now.');
|
return OrderFulfillmentResult::failure('This order cannot be marked paid right now.');
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// canMarkPaid() only ever returns true for an order whose payment
|
||||||
|
// method resolves to the cash-on-delivery DRIVER (see
|
||||||
|
// OrderStatusFlow::isCod(), which checks PaymentMethod::driver,
|
||||||
|
// never the merchant-chosen `type` slug directly — a store could
|
||||||
|
// name that method "cod", "pay-on-delivery", anything). Such an
|
||||||
|
// order never runs through Payment's pay()/authorize() flow at
|
||||||
|
// checkout, so nothing else records a Transaction for it. Money
|
||||||
|
// changes hands right here, at this click, so this is the one
|
||||||
|
// place that write can happen; there is no earlier Payment event
|
||||||
|
// to hang it off of the way Modules\Core\Order\Listeners\
|
||||||
|
// RecordPaymentTransaction does for a gateway driver. See
|
||||||
|
// TransactionRecorder's own docblock — it already anticipated
|
||||||
|
// exactly this "manually-triggered ... from Filament" call site.
|
||||||
|
//
|
||||||
|
// $driver below is the payment method's own `type` slug (whatever
|
||||||
|
// the merchant named it, e.g. 'cash-on-delivery' or 'cod') —
|
||||||
|
// Transaction.driver's established meaning everywhere else in this
|
||||||
|
// codebase (see RecordPaymentTransaction/TransactionRecorder's own
|
||||||
|
// docblocks) is that type key, never the underlying driver CLASS.
|
||||||
|
// No fallback guess here: CheckoutService::initiatePayment() always
|
||||||
|
// writes Order.meta['payment_method'] before charging, and
|
||||||
|
// canMarkPaid() already guarantees this order got that far.
|
||||||
|
$this->transactions->record(
|
||||||
|
$order,
|
||||||
|
type: 'capture',
|
||||||
|
driver: (string) $order->meta['payment_method'],
|
||||||
|
result: new PaymentResult(
|
||||||
|
status: PaymentResultStatus::Succeeded,
|
||||||
|
reference: 'cod-manual-'.$order->id,
|
||||||
|
amount: $order->total,
|
||||||
|
),
|
||||||
|
);
|
||||||
|
|
||||||
$this->writer->markPaid($order, self::class.'::markPaid');
|
$this->writer->markPaid($order, self::class.'::markPaid');
|
||||||
|
|
||||||
return OrderFulfillmentResult::success('Order marked as paid.');
|
return OrderFulfillmentResult::success('Order marked as paid.');
|
||||||
|
|||||||
@@ -0,0 +1,108 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Modules\Core\Order\Services;
|
||||||
|
|
||||||
|
use Illuminate\Support\Facades\Event;
|
||||||
|
use Lunar\Models\Order;
|
||||||
|
use Modules\Core\Checkout\Events\OrderPlaced;
|
||||||
|
use Modules\Core\Order\Enums\PaymentStatus;
|
||||||
|
use Modules\Core\Order\Support\OrderStatus;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The actual business decisions behind reacting to a payment outcome —
|
||||||
|
* previously these lived entirely inside Modules\Core\Order\Listeners\
|
||||||
|
* ApplyResolvedPaymentStatus, a listener with no Service behind it, even
|
||||||
|
* though "should this order be marked paid," "should its status advance,
|
||||||
|
* and to what," and "what does a refund do to status" are all genuine
|
||||||
|
* decisions about Order state, not side effects of Payment's own events.
|
||||||
|
* That listener is now a thin reactor: extract the order id from
|
||||||
|
* $event->context, load the Order, call this service, done.
|
||||||
|
*
|
||||||
|
* See ApplyResolvedPaymentStatus's own docblock for the full business
|
||||||
|
* reasoning (re-confirmed with the user) behind each rule enforced here —
|
||||||
|
* this class only re-documents what's specific to the decision logic
|
||||||
|
* itself, not the "why" already recorded there.
|
||||||
|
*/
|
||||||
|
class OrderPaymentResolutionService
|
||||||
|
{
|
||||||
|
public function __construct(
|
||||||
|
private readonly OrderStatusWriter $writer,
|
||||||
|
private readonly OrderStatusFlow $flow,
|
||||||
|
) {}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A captured or authorized payment: marks the order paid (capture
|
||||||
|
* only — an authorization is not yet captured funds), advances status
|
||||||
|
* out of 'awaiting_payment' (capture only), and marks the order
|
||||||
|
* placed if this is the first payment outcome it's seen.
|
||||||
|
*/
|
||||||
|
public function resolveCaptureOrAuthorization(Order $order, string $causeClass, bool $isCapture): void
|
||||||
|
{
|
||||||
|
$wasPlaced = ! blank($order->placed_at);
|
||||||
|
|
||||||
|
$this->writer->markPaid($order, $causeClass);
|
||||||
|
|
||||||
|
if ($isCapture) {
|
||||||
|
$this->advancePastAwaitingPayment($order, $causeClass);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (! $wasPlaced) {
|
||||||
|
$order->update(['placed_at' => $order->placed_at ?? now()]);
|
||||||
|
Event::dispatch(new OrderPlaced($order));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A deferred-capture payment (currently only cash-on-delivery — see
|
||||||
|
* Payment\Events\PaymentDeferred's own docblock): no money has moved,
|
||||||
|
* so unlike resolveCaptureOrAuthorization() this never calls
|
||||||
|
* $writer->markPaid() — Order::paid stays false until staff explicitly
|
||||||
|
* mark it received. But per OrderStatusFlow's own docblock, payment
|
||||||
|
* method never affects the status SEQUENCE at all — a COD order has
|
||||||
|
* nothing to "await" at checkout (no payment attempt happens), so
|
||||||
|
* 'awaiting_payment' is simply the wrong first status for it. Reuses
|
||||||
|
* the exact same advancePastAwaitingPayment() a capture uses, since
|
||||||
|
* the status-sequence logic itself doesn't differ by payment method,
|
||||||
|
* only whether `paid` also flips alongside it.
|
||||||
|
*/
|
||||||
|
public function resolveDeferredPayment(Order $order, string $causeClass): void
|
||||||
|
{
|
||||||
|
$this->advancePastAwaitingPayment($order, $causeClass);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Requires the refund Transaction row to already exist (Modules\Core\
|
||||||
|
* Order\Listeners\RecordPaymentTransaction must run first — see
|
||||||
|
* OrderServiceProvider's listener registration order for
|
||||||
|
* PaymentRefunded), so the relation is refreshed here rather than
|
||||||
|
* trusted from a possibly-stale $order instance.
|
||||||
|
*/
|
||||||
|
public function resolveRefund(Order $order, string $causeClass): void
|
||||||
|
{
|
||||||
|
$order->load('transactions');
|
||||||
|
|
||||||
|
$target = match (OrderStatus::payment($order)) {
|
||||||
|
PaymentStatus::Refunded => 'refunded',
|
||||||
|
PaymentStatus::PartialRefund => 'partially_refunded',
|
||||||
|
default => null,
|
||||||
|
};
|
||||||
|
|
||||||
|
if ($target !== null && $order->status !== $target) {
|
||||||
|
$this->writer->write($order, $target, $causeClass);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private function advancePastAwaitingPayment(Order $order, string $causeClass): void
|
||||||
|
{
|
||||||
|
if ($order->status !== 'awaiting_payment') {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
$next = $this->flow->nextOptions($order);
|
||||||
|
$target = array_key_first($next);
|
||||||
|
|
||||||
|
if ($target !== null) {
|
||||||
|
$this->writer->write($order, $target, $causeClass);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -133,6 +133,22 @@ class OrderStatusFlow
|
|||||||
return ! $order->paid && $this->isCod($order);
|
return ! $order->paid && $this->isCod($order);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether moving $order to $to is a valid transition from its CURRENT
|
||||||
|
* status — the single source of truth for "is this a legal next step,"
|
||||||
|
* so a caller reacting to an external event (a carrier tracking
|
||||||
|
* checkpoint, a staff action) doesn't need to hardcode its own "only
|
||||||
|
* fire from status X" guard duplicating what nextOptions() already
|
||||||
|
* knows. See e.g. Modules\Core\Order\Listeners\
|
||||||
|
* AdvanceFulfillmentOnCarrierCheckpoint, which used to compare
|
||||||
|
* $order->status to a literal 'ready_for_dispatch' inline instead of
|
||||||
|
* asking this class.
|
||||||
|
*/
|
||||||
|
public function isValidTransition(Order $order, string $to): bool
|
||||||
|
{
|
||||||
|
return array_key_exists($to, $this->nextOptions($order));
|
||||||
|
}
|
||||||
|
|
||||||
private function label(string $status): string
|
private function label(string $status): string
|
||||||
{
|
{
|
||||||
return (string) str($status)->replace('_', ' ')->title();
|
return (string) str($status)->replace('_', ' ')->title();
|
||||||
|
|||||||
@@ -49,6 +49,8 @@ class TransactionRecorder
|
|||||||
'reference' => $result->reference,
|
'reference' => $result->reference,
|
||||||
'status' => $result->status->name,
|
'status' => $result->status->name,
|
||||||
'notes' => $result->failureReason,
|
'notes' => $result->failureReason,
|
||||||
|
'card_type' => $result->meta['card_type'] ?? null,
|
||||||
|
'last_four' => $result->meta['last_four'] ?? null,
|
||||||
'meta' => $result->meta,
|
'meta' => $result->meta,
|
||||||
]);
|
]);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,38 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Modules\Core\Payment\Contracts;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional contract a payment driver implements to declare it only makes
|
||||||
|
* sense for one fulfillment type — the payment-side mirror of
|
||||||
|
* Modules\Core\Shipping\Contracts\DeclaresFulfillmentType. Two concrete
|
||||||
|
* cases exist today, both hardcoded facts about the driver rather than a
|
||||||
|
* merchant configuration choice:
|
||||||
|
* - OfflinePaymentDriver ("pay in store," cash-in-hand) only makes
|
||||||
|
* sense when the shopper collects in person — meaningless for a
|
||||||
|
* carrier delivery, where no staff member is present to take the
|
||||||
|
* cash.
|
||||||
|
* - CashOnDeliveryPaymentDriver only makes sense when a carrier
|
||||||
|
* physically hands over the parcel and collects payment at that
|
||||||
|
* moment — meaningless for store pickup, which already has
|
||||||
|
* OfflinePaymentDriver for exactly that in-person moment.
|
||||||
|
*
|
||||||
|
* A driver that doesn't implement this (Stripe, bank transfer) has no
|
||||||
|
* fulfillment-type constraint — offered regardless of the cart's
|
||||||
|
* currently selected shipping method's fulfillment type.
|
||||||
|
*
|
||||||
|
* Read by Modules\Core\Checkout\Services\CheckoutService::
|
||||||
|
* getPaymentMethods(), which excludes a method whose driver implements
|
||||||
|
* this and disagrees with the cart's current fulfillment type (via
|
||||||
|
* Modules\Core\Shipping\Support\FulfillmentType::resolve() on the
|
||||||
|
* currently selected ShippingMethod). A cart with no shipping option
|
||||||
|
* selected yet imposes no constraint — every method is offered until a
|
||||||
|
* fulfillment type is actually known.
|
||||||
|
*/
|
||||||
|
interface RequiresFulfillmentType
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* @return 'carrier'|'store_pickup'
|
||||||
|
*/
|
||||||
|
public function requiredFulfillmentType(): string;
|
||||||
|
}
|
||||||
@@ -22,7 +22,7 @@ use Modules\Core\Payment\Events\PaymentRefunded;
|
|||||||
* chooses this driver explicitly in the refund action, independent of
|
* chooses this driver explicitly in the refund action, independent of
|
||||||
* which driver the original payment went through (see
|
* which driver the original payment went through (see
|
||||||
* Payment\Support\TransactionDriverAdapter::refundVia() and
|
* Payment\Support\TransactionDriverAdapter::refundVia() and
|
||||||
* Order\Filament\Extensions\OrderRefundActionsExtension). pay() exists so
|
* Order\Filament\Extensions\OrderActionsExtension). pay() exists so
|
||||||
* the same driver also covers receiving a payment by bank transfer, but
|
* the same driver also covers receiving a payment by bank transfer, but
|
||||||
* the admin UI for that (bank reference, notes, proof-of-transfer upload)
|
* the admin UI for that (bank reference, notes, proof-of-transfer upload)
|
||||||
* is deliberately not built yet — see the follow-up work tracked from this
|
* is deliberately not built yet — see the follow-up work tracked from this
|
||||||
|
|||||||
@@ -5,9 +5,11 @@ namespace Modules\Core\Payment\Drivers;
|
|||||||
use Illuminate\Support\Str;
|
use Illuminate\Support\Str;
|
||||||
use Lunar\DataTypes\Price;
|
use Lunar\DataTypes\Price;
|
||||||
use Modules\Core\Payment\Contracts\Configurable;
|
use Modules\Core\Payment\Contracts\Configurable;
|
||||||
|
use Modules\Core\Payment\Contracts\RequiresFulfillmentType;
|
||||||
use Modules\Core\Payment\Contracts\SupportsPay;
|
use Modules\Core\Payment\Contracts\SupportsPay;
|
||||||
use Modules\Core\Payment\DTOs\PaymentResult;
|
use Modules\Core\Payment\DTOs\PaymentResult;
|
||||||
use Modules\Core\Payment\Enums\PaymentResultStatus;
|
use Modules\Core\Payment\Enums\PaymentResultStatus;
|
||||||
|
use Modules\Core\Payment\Events\PaymentDeferred;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Cash-on-delivery/cash-on-pickup — the shopper pays staff in person, at
|
* Cash-on-delivery/cash-on-pickup — the shopper pays staff in person, at
|
||||||
@@ -31,20 +33,46 @@ use Modules\Core\Payment\Enums\PaymentResultStatus;
|
|||||||
* marking it received (Modules\Core\Order\Services\
|
* marking it received (Modules\Core\Order\Services\
|
||||||
* OrderFulfillmentService::markPaid()), offered by the single "Update
|
* OrderFulfillmentService::markPaid()), offered by the single "Update
|
||||||
* Status" action at any time, independent of status.
|
* Status" action at any time, independent of status.
|
||||||
|
*
|
||||||
|
* Despite returning Pending, this order IS fully placed the moment pay()
|
||||||
|
* returns — unlike a Stripe 3-D Secure Pending, nothing will ever resolve
|
||||||
|
* this into a later PaymentCaptured/PaymentAuthorized (COD has no gateway
|
||||||
|
* callback at all). Without PaymentDeferred, no listener ever set
|
||||||
|
* Order::placed_at for a COD order: invisible in customer order history,
|
||||||
|
* no stock decrement (Modules\Core\Order\Listeners\
|
||||||
|
* DecrementStockOnOrderPlaced only reacts to Checkout\Events\OrderPlaced),
|
||||||
|
* and the storefront's own post-checkout confirmation could never find it
|
||||||
|
* — a real bug, not a hypothetical, caught and fixed after the fact. See
|
||||||
|
* PaymentDeferred's own docblock for the full reasoning.
|
||||||
*/
|
*/
|
||||||
class CashOnDeliveryPaymentDriver implements Configurable, SupportsPay
|
class CashOnDeliveryPaymentDriver implements Configurable, SupportsPay, RequiresFulfillmentType
|
||||||
{
|
{
|
||||||
public function isConfigured(): bool
|
public function isConfigured(): bool
|
||||||
{
|
{
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* "On delivery" is the operative word — a carrier physically hands
|
||||||
|
* over the parcel and collects payment at that moment. Meaningless
|
||||||
|
* for store pickup, which already has OfflinePaymentDriver for the
|
||||||
|
* equivalent in-person moment.
|
||||||
|
*/
|
||||||
|
public function requiredFulfillmentType(): string
|
||||||
|
{
|
||||||
|
return 'carrier';
|
||||||
|
}
|
||||||
|
|
||||||
public function pay(string $type, Price $amount, array $data = [], array $context = []): PaymentResult
|
public function pay(string $type, Price $amount, array $data = [], array $context = []): PaymentResult
|
||||||
{
|
{
|
||||||
return new PaymentResult(
|
$result = new PaymentResult(
|
||||||
status: PaymentResultStatus::Pending,
|
status: PaymentResultStatus::Pending,
|
||||||
reference: 'cod-'.Str::uuid(),
|
reference: 'cod-'.Str::uuid(),
|
||||||
amount: $amount,
|
amount: $amount,
|
||||||
);
|
);
|
||||||
|
|
||||||
|
PaymentDeferred::dispatch($type, $result, $context);
|
||||||
|
|
||||||
|
return $result;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -5,6 +5,7 @@ namespace Modules\Core\Payment\Drivers;
|
|||||||
use Illuminate\Support\Str;
|
use Illuminate\Support\Str;
|
||||||
use Lunar\DataTypes\Price;
|
use Lunar\DataTypes\Price;
|
||||||
use Modules\Core\Payment\Contracts\Configurable;
|
use Modules\Core\Payment\Contracts\Configurable;
|
||||||
|
use Modules\Core\Payment\Contracts\RequiresFulfillmentType;
|
||||||
use Modules\Core\Payment\Contracts\SupportsPay;
|
use Modules\Core\Payment\Contracts\SupportsPay;
|
||||||
use Modules\Core\Payment\DTOs\PaymentResult;
|
use Modules\Core\Payment\DTOs\PaymentResult;
|
||||||
use Modules\Core\Payment\Enums\PaymentResultStatus;
|
use Modules\Core\Payment\Enums\PaymentResultStatus;
|
||||||
@@ -25,7 +26,7 @@ use Modules\Core\Payment\Events\PaymentCaptured;
|
|||||||
* none) purely so PaymentCaptured, and anything downstream keying on it,
|
* none) purely so PaymentCaptured, and anything downstream keying on it,
|
||||||
* have something to identify this attempt by.
|
* have something to identify this attempt by.
|
||||||
*/
|
*/
|
||||||
class OfflinePaymentDriver implements Configurable, SupportsPay
|
class OfflinePaymentDriver implements Configurable, SupportsPay, RequiresFulfillmentType
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
* Always true — no external dependency to be missing.
|
* Always true — no external dependency to be missing.
|
||||||
@@ -35,6 +36,16 @@ class OfflinePaymentDriver implements Configurable, SupportsPay
|
|||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Cash-in-hand requires a staff member physically present to take the
|
||||||
|
* payment — meaningless for a carrier delivery, where no such person
|
||||||
|
* exists at handoff.
|
||||||
|
*/
|
||||||
|
public function requiredFulfillmentType(): string
|
||||||
|
{
|
||||||
|
return 'store_pickup';
|
||||||
|
}
|
||||||
|
|
||||||
public function pay(string $type, Price $amount, array $data = [], array $context = []): PaymentResult
|
public function pay(string $type, Price $amount, array $data = [], array $context = []): PaymentResult
|
||||||
{
|
{
|
||||||
$reference = 'offline-'.Str::uuid();
|
$reference = 'offline-'.Str::uuid();
|
||||||
|
|||||||
@@ -4,9 +4,6 @@ namespace Modules\Core\Payment\Drivers;
|
|||||||
|
|
||||||
use Lunar\DataTypes\Price;
|
use Lunar\DataTypes\Price;
|
||||||
use Lunar\Models\Currency;
|
use Lunar\Models\Currency;
|
||||||
use Lunar\Stripe\Facades\Stripe;
|
|
||||||
use Lunar\Stripe\Managers\StripeManager;
|
|
||||||
use Lunar\Stripe\Models\StripePaymentIntent;
|
|
||||||
use Modules\Core\Payment\Contracts\Configurable;
|
use Modules\Core\Payment\Contracts\Configurable;
|
||||||
use Modules\Core\Payment\Contracts\HandlesPaymentCallback;
|
use Modules\Core\Payment\Contracts\HandlesPaymentCallback;
|
||||||
use Modules\Core\Payment\Contracts\SupportsAuthorization;
|
use Modules\Core\Payment\Contracts\SupportsAuthorization;
|
||||||
@@ -26,17 +23,20 @@ use Modules\Core\Payment\Events\PaymentRefundFailed;
|
|||||||
use Modules\Core\Payment\Events\PaymentRefunded;
|
use Modules\Core\Payment\Events\PaymentRefunded;
|
||||||
use Modules\Core\Payment\Events\PaymentVoidFailed;
|
use Modules\Core\Payment\Events\PaymentVoidFailed;
|
||||||
use Modules\Core\Payment\Events\PaymentVoided;
|
use Modules\Core\Payment\Events\PaymentVoided;
|
||||||
|
use Modules\Core\Payment\Models\StripePaymentIntent;
|
||||||
|
use Modules\Core\Payment\Support\StripeManager;
|
||||||
use Stripe\Exception\ApiErrorException;
|
use Stripe\Exception\ApiErrorException;
|
||||||
use Stripe\PaymentIntent;
|
use Stripe\PaymentIntent;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Talks to Stripe's PaymentIntent API directly — deliberately NOT via
|
* Talks to Stripe's PaymentIntent API directly — deliberately NOT via
|
||||||
* Lunar\Stripe\Facades\Stripe::createIntent()/fetchOrCreateIntent(), which
|
* Lunar's own checkout flow (lunarphp/stripe, since removed — see
|
||||||
* take a Lunar\Models\Cart and derive amount/currency from it. Payment
|
* Modules\Core\Payment\Support\StripeManager's own docblock), which took a
|
||||||
* must never receive a Cart (see docs/payments.md) — pay()/authorize()
|
* Lunar\Models\Cart and derived amount/currency from it. Payment must
|
||||||
* already receive $amount explicitly as their own required Lunar Price
|
* never receive a Cart (see docs/payments.md) — pay()/authorize() already
|
||||||
* parameter (see PaymentResult's own docblock), the caller's job to
|
* receive $amount explicitly as their own required Lunar Price parameter
|
||||||
* assemble, same as every other driver.
|
* (see PaymentResult's own docblock), the caller's job to assemble, same
|
||||||
|
* as every other driver.
|
||||||
*
|
*
|
||||||
* Every amount that crosses this class's own boundary is converted right
|
* Every amount that crosses this class's own boundary is converted right
|
||||||
* there: Lunar's Price -> Stripe's minor-unit int going INTO a gateway
|
* there: Lunar's Price -> Stripe's minor-unit int going INTO a gateway
|
||||||
@@ -45,12 +45,11 @@ use Stripe\PaymentIntent;
|
|||||||
* Nothing outside this class ever sees a Stripe-scaled integer.
|
* Nothing outside this class ever sees a Stripe-scaled integer.
|
||||||
*
|
*
|
||||||
* Correlating a later handleCallback() (a separate request — a webhook)
|
* Correlating a later handleCallback() (a separate request — a webhook)
|
||||||
* back to whatever $context identified this attempt is solved the same
|
* back to whatever $context identified this attempt is solved via real
|
||||||
* way lunarphp/stripe's own StripePaymentType/ProcessStripeWebhook solve
|
* cart_id/order_id columns on Modules\Core\Payment\Models\
|
||||||
* it: real cart_id/order_id columns on Lunar\Stripe\Models\
|
* StripePaymentIntent (a table this app now owns outright, already shaped
|
||||||
* StripePaymentIntent (a table already owned by lunarphp/stripe, already
|
* for exactly this), not a generic context blob. See docs/payments.md
|
||||||
* shaped for exactly this), not a generic context blob. See
|
* "Async resolution" for the full reasoning.
|
||||||
* docs/payments.md "Async resolution" for the full reasoning.
|
|
||||||
*/
|
*/
|
||||||
class StripePaymentDriver implements
|
class StripePaymentDriver implements
|
||||||
Configurable,
|
Configurable,
|
||||||
@@ -61,16 +60,18 @@ class StripePaymentDriver implements
|
|||||||
SupportsRefunds,
|
SupportsRefunds,
|
||||||
HandlesPaymentCallback
|
HandlesPaymentCallback
|
||||||
{
|
{
|
||||||
|
public function __construct(
|
||||||
|
private readonly StripeManager $stripe,
|
||||||
|
) {}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Same key lunarphp/stripe's own StripeManager reads its API key from
|
* Same key StripeManager reads its API key from — no key, no usable
|
||||||
* (Stripe::setApiKey(config('services.stripe.key'))) — no key, no
|
* driver.
|
||||||
* usable driver.
|
|
||||||
*/
|
*/
|
||||||
public function isConfigured(): bool
|
public function isConfigured(): bool
|
||||||
{
|
{
|
||||||
return filled(config('services.stripe.key'));
|
return filled(config('services.stripe.key'));
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Atomic charge — capture_method: automatic. Stripe still frequently
|
* Atomic charge — capture_method: automatic. Stripe still frequently
|
||||||
* confirms into requires_action/requires_confirmation rather than
|
* confirms into requires_action/requires_confirmation rather than
|
||||||
@@ -100,16 +101,41 @@ class StripePaymentDriver implements
|
|||||||
'currency' => $amount->currency->code,
|
'currency' => $amount->currency->code,
|
||||||
'capture_method' => $captureMethod,
|
'capture_method' => $captureMethod,
|
||||||
'confirm' => true,
|
'confirm' => true,
|
||||||
|
// 'never' rather than the client-side paymentMethodTypes: ['card']
|
||||||
|
// restriction alone — the storefront's Payment Element already
|
||||||
|
// excludes every redirect-based method, but without this Stripe
|
||||||
|
// still falls back to whatever's enabled in the Dashboard and
|
||||||
|
// demands a return_url on confirm. Setting this unconditionally
|
||||||
|
// (not only when no payment_method is given) matches the actual
|
||||||
|
// flow: a payment_method is always supplied here.
|
||||||
|
'automatic_payment_methods' => ['enabled' => true, 'allow_redirects' => 'never'],
|
||||||
];
|
];
|
||||||
|
|
||||||
if (isset($data['payment_method'])) {
|
if (isset($data['payment_method'])) {
|
||||||
$params['payment_method'] = $data['payment_method'];
|
$params['payment_method'] = $data['payment_method'];
|
||||||
} else {
|
}
|
||||||
$params['automatic_payment_methods'] = ['enabled' => true];
|
|
||||||
|
// 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 {
|
try {
|
||||||
$paymentIntent = Stripe::getClient()->paymentIntents->create($params);
|
$paymentIntent = $this->stripe->getClient()->paymentIntents->create($params);
|
||||||
} catch (ApiErrorException $e) {
|
} catch (ApiErrorException $e) {
|
||||||
return $this->declined($type, $amount, $e, $context, authorizing: $captureMethod === 'manual');
|
return $this->declined($type, $amount, $e, $context, authorizing: $captureMethod === 'manual');
|
||||||
}
|
}
|
||||||
@@ -123,7 +149,7 @@ class StripePaymentDriver implements
|
|||||||
{
|
{
|
||||||
[$intentModel, $type, $context] = $this->resolveIntentModel($reference, $context, $data['type'] ?? '');
|
[$intentModel, $type, $context] = $this->resolveIntentModel($reference, $context, $data['type'] ?? '');
|
||||||
|
|
||||||
$paymentIntent = Stripe::getClient()->paymentIntents->retrieve($reference);
|
$paymentIntent = $this->stripe->getClient()->paymentIntents->retrieve($reference);
|
||||||
|
|
||||||
$authorizing = $paymentIntent->capture_method === PaymentIntent::CAPTURE_METHOD_MANUAL;
|
$authorizing = $paymentIntent->capture_method === PaymentIntent::CAPTURE_METHOD_MANUAL;
|
||||||
|
|
||||||
@@ -131,7 +157,7 @@ class StripePaymentDriver implements
|
|||||||
// automatic capture_method, but Stripe stopped short of
|
// automatic capture_method, but Stripe stopped short of
|
||||||
// capturing (rare, but the API contract allows it) — finish
|
// capturing (rare, but the API contract allows it) — finish
|
||||||
// the job pay() started.
|
// the job pay() started.
|
||||||
$paymentIntent = Stripe::getClient()->paymentIntents->capture($reference);
|
$paymentIntent = $this->stripe->getClient()->paymentIntents->capture($reference);
|
||||||
}
|
}
|
||||||
|
|
||||||
$intentModel?->update(['status' => $paymentIntent->status]);
|
$intentModel?->update(['status' => $paymentIntent->status]);
|
||||||
@@ -146,7 +172,7 @@ class StripePaymentDriver implements
|
|||||||
[$intentModel, $type, $context] = $this->resolveIntentModel($reference, $context);
|
[$intentModel, $type, $context] = $this->resolveIntentModel($reference, $context);
|
||||||
|
|
||||||
try {
|
try {
|
||||||
$paymentIntent = Stripe::getClient()->paymentIntents->capture($reference, [
|
$paymentIntent = $this->stripe->getClient()->paymentIntents->capture($reference, [
|
||||||
'amount_to_capture' => StripeManager::toStripeAmount($amount->value, $amount->currency),
|
'amount_to_capture' => StripeManager::toStripeAmount($amount->value, $amount->currency),
|
||||||
]);
|
]);
|
||||||
} catch (ApiErrorException $e) {
|
} catch (ApiErrorException $e) {
|
||||||
@@ -165,6 +191,7 @@ class StripePaymentDriver implements
|
|||||||
reference: $paymentIntent->id,
|
reference: $paymentIntent->id,
|
||||||
amount: $amount,
|
amount: $amount,
|
||||||
raw: $paymentIntent->toArray(),
|
raw: $paymentIntent->toArray(),
|
||||||
|
meta: $this->cardMetaFromIntent($paymentIntent),
|
||||||
);
|
);
|
||||||
|
|
||||||
$paymentIntent->status === PaymentIntent::STATUS_SUCCEEDED
|
$paymentIntent->status === PaymentIntent::STATUS_SUCCEEDED
|
||||||
@@ -179,7 +206,7 @@ class StripePaymentDriver implements
|
|||||||
[$intentModel, $type, $context] = $this->resolveIntentModel($reference, $context);
|
[$intentModel, $type, $context] = $this->resolveIntentModel($reference, $context);
|
||||||
|
|
||||||
try {
|
try {
|
||||||
$paymentIntent = Stripe::getClient()->paymentIntents->cancel($reference);
|
$paymentIntent = $this->stripe->getClient()->paymentIntents->cancel($reference);
|
||||||
} catch (ApiErrorException $e) {
|
} catch (ApiErrorException $e) {
|
||||||
$result = $this->failure($amount, $e, $reference);
|
$result = $this->failure($amount, $e, $reference);
|
||||||
PaymentVoidFailed::dispatch($type, $result, $context);
|
PaymentVoidFailed::dispatch($type, $result, $context);
|
||||||
@@ -210,7 +237,7 @@ class StripePaymentDriver implements
|
|||||||
[$intentModel, $type, $context] = $this->resolveIntentModel($reference, $context);
|
[$intentModel, $type, $context] = $this->resolveIntentModel($reference, $context);
|
||||||
|
|
||||||
try {
|
try {
|
||||||
$refund = Stripe::getClient()->refunds->create([
|
$refund = $this->stripe->getClient()->refunds->create([
|
||||||
'payment_intent' => $reference,
|
'payment_intent' => $reference,
|
||||||
'amount' => StripeManager::toStripeAmount($amount->value, $amount->currency),
|
'amount' => StripeManager::toStripeAmount($amount->value, $amount->currency),
|
||||||
]);
|
]);
|
||||||
@@ -247,7 +274,7 @@ class StripePaymentDriver implements
|
|||||||
'order_id' => $context['order_id'] ?? null,
|
'order_id' => $context['order_id'] ?? null,
|
||||||
'status' => $paymentIntent->status,
|
'status' => $paymentIntent->status,
|
||||||
'payment_type' => $type,
|
'payment_type' => $type,
|
||||||
'context' => json_encode($context),
|
'context' => $context,
|
||||||
]);
|
]);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -272,28 +299,10 @@ class StripePaymentDriver implements
|
|||||||
return [
|
return [
|
||||||
$intentModel,
|
$intentModel,
|
||||||
$intentModel?->payment_type ?? $typeFallback,
|
$intentModel?->payment_type ?? $typeFallback,
|
||||||
$this->decodeContext($intentModel) ?? $context,
|
$intentModel?->context ?? $context,
|
||||||
];
|
];
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* StripePaymentIntent is a vendor model (lunarphp/stripe) with no cast
|
|
||||||
* declared for our own 'context' column (added by boboko-core's own
|
|
||||||
* migration, see database/migrations/..._add_context_to_stripe_
|
|
||||||
* payment_intents.php) — we can't edit the vendor model to add one, so
|
|
||||||
* decode manually here instead of assuming Eloquent already did it.
|
|
||||||
*
|
|
||||||
* @return array<string, mixed>|null
|
|
||||||
*/
|
|
||||||
private function decodeContext(?StripePaymentIntent $intentModel): ?array
|
|
||||||
{
|
|
||||||
if (! $intentModel || ! $intentModel->context) {
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
|
|
||||||
return json_decode($intentModel->context, associative: true) ?: null;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Converts a live Stripe PaymentIntent's own amount/currency back
|
* Converts a live Stripe PaymentIntent's own amount/currency back
|
||||||
* into Lunar's Price — the one place this class reads a Stripe
|
* into Lunar's Price — the one place this class reads a Stripe
|
||||||
@@ -335,6 +344,7 @@ class StripePaymentDriver implements
|
|||||||
amount: $amount,
|
amount: $amount,
|
||||||
failureReason: $paymentIntent->last_payment_error->message ?? null,
|
failureReason: $paymentIntent->last_payment_error->message ?? null,
|
||||||
raw: $paymentIntent->toArray(),
|
raw: $paymentIntent->toArray(),
|
||||||
|
meta: $status === PaymentResultStatus::Pending ? [] : $this->cardMetaFromIntent($paymentIntent),
|
||||||
continuation: $continuation,
|
continuation: $continuation,
|
||||||
);
|
);
|
||||||
|
|
||||||
@@ -357,6 +367,40 @@ class StripePaymentDriver implements
|
|||||||
return $result;
|
return $result;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* card_type/last_four for Modules\Core\Order\Services\
|
||||||
|
* TransactionRecorder to map onto Transaction (see PaymentResult::
|
||||||
|
* $meta's own docblock) — same fields, same source
|
||||||
|
* (payment_method_details on the underlying Charge) as lunarphp/
|
||||||
|
* stripe's own StoreCharges, just reached via latest_charge instead of
|
||||||
|
* an order-level charge list, since this driver has no Order/Cart to
|
||||||
|
* enumerate charges from.
|
||||||
|
*
|
||||||
|
* @return array{card_type?: string, last_four?: string}
|
||||||
|
*/
|
||||||
|
private function cardMetaFromIntent(PaymentIntent $paymentIntent): array
|
||||||
|
{
|
||||||
|
$chargeId = $paymentIntent->latest_charge;
|
||||||
|
|
||||||
|
if (blank($chargeId)) {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
|
||||||
|
$charge = $this->stripe->getCharge(is_string($chargeId) ? $chargeId : $chargeId->id);
|
||||||
|
|
||||||
|
$paymentType = collect($charge->payment_method_details)->keys()->first();
|
||||||
|
$details = collect($charge->payment_method_details)->first();
|
||||||
|
|
||||||
|
if (blank($details)) {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
|
||||||
|
return array_filter([
|
||||||
|
'card_type' => $details['brand'] ?? $paymentType,
|
||||||
|
'last_four' => $details['last4'] ?? null,
|
||||||
|
], fn ($value) => filled($value));
|
||||||
|
}
|
||||||
|
|
||||||
private function declined(string $type, Price $amount, ApiErrorException $e, array $context, bool $authorizing): PaymentResult
|
private function declined(string $type, Price $amount, ApiErrorException $e, array $context, bool $authorizing): PaymentResult
|
||||||
{
|
{
|
||||||
$result = $this->failure($amount, $e);
|
$result = $this->failure($amount, $e);
|
||||||
|
|||||||
@@ -0,0 +1,46 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Modules\Core\Payment\Events;
|
||||||
|
|
||||||
|
use Illuminate\Foundation\Events\Dispatchable;
|
||||||
|
use Modules\Core\Payment\DTOs\PaymentResult;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* "This order has no money to collect yet, and never will via a gateway
|
||||||
|
* callback — nothing further will ever resolve this PaymentResult's
|
||||||
|
* Pending status into Captured/Authorized." Distinct from a Stripe-style
|
||||||
|
* Pending (3-D Secure, still resolving asynchronously via a later webhook
|
||||||
|
* or client-side confirmation) — that case correctly dispatches nothing
|
||||||
|
* yet, since PaymentCaptured/PaymentAuthorized WILL still follow once
|
||||||
|
* resolved.
|
||||||
|
*
|
||||||
|
* Dispatched by Modules\Core\Payment\Drivers\CashOnDeliveryPaymentDriver::
|
||||||
|
* pay() the moment it returns Pending — a COD order is fully placed at
|
||||||
|
* that instant, with reconciliation (Order::paid) happening independently,
|
||||||
|
* anywhere from same-day to months later, entirely outside any gateway's
|
||||||
|
* knowledge. Any other current or future "deferred capture, no gateway
|
||||||
|
* callback" driver dispatches this the same way, rather than each
|
||||||
|
* reinventing its own "mark placed" event.
|
||||||
|
*
|
||||||
|
* Handled by Modules\Core\Order\Listeners\MarkOrderPlacedOnDeferredPayment
|
||||||
|
* — sets ONLY Order::placed_at and fires Checkout\Events\OrderPlaced.
|
||||||
|
* Deliberately does not touch Order::paid/paid_at (see
|
||||||
|
* OrderStatusWriter::markPaid(), the only path that ever does) or create a
|
||||||
|
* Transaction row (RecordPaymentTransaction listens to PaymentCaptured/
|
||||||
|
* PaymentAuthorized/PaymentVoided/PaymentRefunded only — correctly not
|
||||||
|
* this event, since no money has moved and there is nothing to record
|
||||||
|
* yet).
|
||||||
|
*/
|
||||||
|
class PaymentDeferred
|
||||||
|
{
|
||||||
|
use Dispatchable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param array<string, mixed> $context
|
||||||
|
*/
|
||||||
|
public function __construct(
|
||||||
|
public readonly string $type,
|
||||||
|
public readonly PaymentResult $result,
|
||||||
|
public readonly array $context = [],
|
||||||
|
) {}
|
||||||
|
}
|
||||||
@@ -3,16 +3,21 @@
|
|||||||
namespace Modules\Core\Payment\Filament\Resources;
|
namespace Modules\Core\Payment\Filament\Resources;
|
||||||
|
|
||||||
use Filament\Actions\Action;
|
use Filament\Actions\Action;
|
||||||
|
use Filament\Forms\Components\Hidden;
|
||||||
use Filament\Forms\Components\Select;
|
use Filament\Forms\Components\Select;
|
||||||
use Filament\Forms\Components\TextInput;
|
use Filament\Forms\Components\TextInput;
|
||||||
use Filament\Resources\Resource;
|
use Filament\Resources\Resource;
|
||||||
use Filament\Schemas\Components\Component;
|
use Filament\Schemas\Components\Component;
|
||||||
|
use Filament\Schemas\Components\Utilities\Get;
|
||||||
|
use InvalidArgumentException;
|
||||||
use Filament\Tables\Columns\IconColumn;
|
use Filament\Tables\Columns\IconColumn;
|
||||||
use Filament\Tables\Columns\TextColumn;
|
use Filament\Tables\Columns\TextColumn;
|
||||||
use Filament\Tables\Columns\ToggleColumn;
|
use Filament\Tables\Columns\ToggleColumn;
|
||||||
use Filament\Tables\Table;
|
use Filament\Tables\Table;
|
||||||
use Illuminate\Support\Facades\Event;
|
use Illuminate\Support\Facades\Event;
|
||||||
|
use Lunar\Admin\Support\Forms\Components\TranslatedText;
|
||||||
use Modules\Core\Payment\Contracts\Configurable;
|
use Modules\Core\Payment\Contracts\Configurable;
|
||||||
|
use Modules\Core\Payment\Contracts\SupportsAuthorization;
|
||||||
use Modules\Core\Payment\Events\PaymentMethodsReordered;
|
use Modules\Core\Payment\Events\PaymentMethodsReordered;
|
||||||
use Modules\Core\Payment\Filament\Resources\PaymentMethodResource\Pages\ListPaymentMethods;
|
use Modules\Core\Payment\Filament\Resources\PaymentMethodResource\Pages\ListPaymentMethods;
|
||||||
use Modules\Core\Payment\Models\PaymentMethod;
|
use Modules\Core\Payment\Models\PaymentMethod;
|
||||||
@@ -59,9 +64,9 @@ class PaymentMethodResource extends Resource
|
|||||||
{
|
{
|
||||||
protected static ?string $model = PaymentMethod::class;
|
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';
|
protected static ?string $modelLabel = 'Payment Method';
|
||||||
|
|
||||||
@@ -76,7 +81,7 @@ class PaymentMethodResource extends Resource
|
|||||||
->sortable(),
|
->sortable(),
|
||||||
TextColumn::make('name')
|
TextColumn::make('name')
|
||||||
->label('Name')
|
->label('Name')
|
||||||
->searchable(),
|
->state(fn (PaymentMethod $record) => $record->translate('name')),
|
||||||
TextColumn::make('type')
|
TextColumn::make('type')
|
||||||
->label('Type'),
|
->label('Type'),
|
||||||
TextColumn::make('driver')
|
TextColumn::make('driver')
|
||||||
@@ -124,10 +129,9 @@ class PaymentMethodResource extends Resource
|
|||||||
public static function getFormComponents(): array
|
public static function getFormComponents(): array
|
||||||
{
|
{
|
||||||
return [
|
return [
|
||||||
TextInput::make('name')
|
TranslatedText::make('name')
|
||||||
->label('Name')
|
->label('Name')
|
||||||
->required()
|
->required(),
|
||||||
->maxLength(255),
|
|
||||||
TextInput::make('type')
|
TextInput::make('type')
|
||||||
->label('Type')
|
->label('Type')
|
||||||
->helperText('Machine-facing slug — stored on the cart/order, used by other code to identify this method. Cannot be changed once orders reference it.')
|
->helperText('Machine-facing slug — stored on the cart/order, used by other code to identify this method. Cannot be changed once orders reference it.')
|
||||||
@@ -144,7 +148,31 @@ class PaymentMethodResource extends Resource
|
|||||||
])
|
])
|
||||||
->default('pay')
|
->default('pay')
|
||||||
->live()
|
->live()
|
||||||
->required(),
|
// Only meaningful for a driver that actually implements
|
||||||
|
// SupportsAuthorization — CheckoutService::initiatePayment()
|
||||||
|
// calls $driver->authorize() when capture_mode is
|
||||||
|
// "authorize", which fatals on a driver missing that method
|
||||||
|
// entirely (e.g. CashOnDeliveryPaymentDriver, which only
|
||||||
|
// ever implements SupportsPay: the shopper pays staff in
|
||||||
|
// person, at an unknown future moment — there is no
|
||||||
|
// "hold now, settle later" operation to offer for that at
|
||||||
|
// all). Hidden rather than merely disabled, since a
|
||||||
|
// hidden field is also excluded from validation/dehydration
|
||||||
|
// — required() below would otherwise still block saving.
|
||||||
|
->visible(fn (Get $get) => static::driverSupportsAuthorization($get('driver')))
|
||||||
|
->required(fn (Get $get) => static::driverSupportsAuthorization($get('driver'))),
|
||||||
|
// Every OTHER fillForm() value not backed by a real component
|
||||||
|
// here is silently dropped — an Action::schema() modal only
|
||||||
|
// dehydrates fields present in its own schema, unlike a
|
||||||
|
// resource's form(); ListPaymentMethods::getHeaderActions()'s
|
||||||
|
// CreateAction::fillForm() used to set 'position' this same
|
||||||
|
// way and it never reached PaymentMethodService::create(),
|
||||||
|
// so every new method saved with the column's raw DB default
|
||||||
|
// (0) regardless of what fillForm() computed. Hidden here
|
||||||
|
// purely so it actually dehydrates; the table's own
|
||||||
|
// reorderable('position') drag-and-drop remains the real
|
||||||
|
// staff-facing way to change it afterward.
|
||||||
|
Hidden::make('position'),
|
||||||
];
|
];
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -153,9 +181,23 @@ class PaymentMethodResource extends Resource
|
|||||||
return Select::make('driver')
|
return Select::make('driver')
|
||||||
->label('Driver')
|
->label('Driver')
|
||||||
->options(fn () => app(PaymentDriverRegistry::class)->labels())
|
->options(fn () => app(PaymentDriverRegistry::class)->labels())
|
||||||
|
->live()
|
||||||
->required();
|
->required();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
private static function driverSupportsAuthorization(?string $driver): bool
|
||||||
|
{
|
||||||
|
if (! $driver) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
return app(PaymentDriverRegistry::class)->resolve($driver) instanceof SupportsAuthorization;
|
||||||
|
} catch (InvalidArgumentException) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
public static function getPages(): array
|
public static function getPages(): array
|
||||||
{
|
{
|
||||||
return [
|
return [
|
||||||
@@ -180,7 +222,7 @@ class PaymentMethodResource extends Resource
|
|||||||
->icon('heroicon-o-pencil-square')
|
->icon('heroicon-o-pencil-square')
|
||||||
->schema(static::getFormComponents())
|
->schema(static::getFormComponents())
|
||||||
->fillForm(fn (PaymentMethod $record) => $record->only([
|
->fillForm(fn (PaymentMethod $record) => $record->only([
|
||||||
'name', 'type', 'driver', 'capture_mode',
|
'name', 'type', 'driver', 'capture_mode', 'position',
|
||||||
]))
|
]))
|
||||||
->action(fn (PaymentMethod $record, array $data) => app(PaymentMethodService::class)->update($record, $data));
|
->action(fn (PaymentMethod $record, array $data) => app(PaymentMethodService::class)->update($record, $data));
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,8 +2,10 @@
|
|||||||
|
|
||||||
namespace Modules\Core\Payment\Filament\Resources\PaymentMethodResource\Pages;
|
namespace Modules\Core\Payment\Filament\Resources\PaymentMethodResource\Pages;
|
||||||
|
|
||||||
|
use Filament\Actions\CreateAction;
|
||||||
use Filament\Actions;
|
use Filament\Actions;
|
||||||
use Filament\Resources\Pages\ListRecords;
|
use Filament\Resources\Pages\ListRecords;
|
||||||
|
use Lunar\Models\Language;
|
||||||
use Modules\Core\Payment\Filament\Resources\PaymentMethodResource;
|
use Modules\Core\Payment\Filament\Resources\PaymentMethodResource;
|
||||||
use Modules\Core\Payment\Models\PaymentMethod;
|
use Modules\Core\Payment\Models\PaymentMethod;
|
||||||
use Modules\Core\Payment\Services\PaymentMethodService;
|
use Modules\Core\Payment\Services\PaymentMethodService;
|
||||||
@@ -15,12 +17,21 @@ class ListPaymentMethods extends ListRecords
|
|||||||
protected function getHeaderActions(): array
|
protected function getHeaderActions(): array
|
||||||
{
|
{
|
||||||
return [
|
return [
|
||||||
Actions\CreateAction::make()
|
CreateAction::make()
|
||||||
->schema(PaymentMethodResource::getFormComponents())
|
->schema(PaymentMethodResource::getFormComponents())
|
||||||
->fillForm(fn () => [
|
->fillForm(fn () => [
|
||||||
'position' => (PaymentMethod::max('position') ?? 0) + 1,
|
'position' => (PaymentMethod::max('position') ?? 0) + 1,
|
||||||
'enabled' => false,
|
'enabled' => false,
|
||||||
'data' => [],
|
'data' => [],
|
||||||
|
// TranslatedText's own default() (getLanguageDefaults())
|
||||||
|
// never reaches this mounted action's initial state —
|
||||||
|
// unlike a resource's own form(), an Action::schema()
|
||||||
|
// modal starts from exactly what fillForm() returns, so
|
||||||
|
// `name` was landing as null rather than the expected
|
||||||
|
// per-locale array, and every locale's sub-input
|
||||||
|
// silently failed to bind to it (required() on the
|
||||||
|
// default locale then correctly rejected the null).
|
||||||
|
'name' => Language::pluck('code')->mapWithKeys(fn (string $code) => [$code => ''])->all(),
|
||||||
])
|
])
|
||||||
// Every PaymentMethod write goes through PaymentMethodService
|
// Every PaymentMethod write goes through PaymentMethodService
|
||||||
// — see PaymentMethodResource's own docblock — so this
|
// — see PaymentMethodResource's own docblock — so this
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user