Improve webshop backend (#3810)

Author: ildyria

.env.example

@@ -239,4 +239,32 @@ VITE_PUSHER_APP_CLUSTER="${PUSHER_APP_CLUSTER}"
 # VITE_LOCAL_DEV=true
 # VITE_HTTP_PROXY_TARGET=http://localhost:8000
 
-# DISABLE_IMPORT_FROM_SERVER=false
+# DISABLE_IMPORT_FROM_SERVER=false
+
+###################################################################
+# Payment integration (requires SE)                               #
+###################################################################
+
+# Enable test mode (Sandbox mode) for payment gateways.
+# In test mode, no real money transactions are done.
+# We set it to true by default for safety. Make sure to set it to false
+# when you go live.
+# OMNIPAY_TEST_MODE=true
+
+# Configuration values for Mollie integration
+# MOLLIE_API_KEY=
+# MOLLIE_PROFILE_ID=
+
+# Configuration values for Stripe integration (NOT WORKING YET, MAYBE LATER)
+# STRIPE_API_KEY=
+# STRIPE_PUBLISHABLE_KEY=
+
+# https://github.com/thephpleague/omnipay-paypal/blob/master/src/RestGateway.php
+# PAYPAL_CLIENT_ID=
+# PAYPAL_SECRET=
+
+# https://github.com/thephpleague/omnipay-paypal/blob/master/src/ExpressInContextGateway.php
+# https://github.com/thephpleague/omnipay-paypal/blob/master/src/ProGateway.php
+# PAYPAL_API_USERNAME=
+# PAYPAL_API_PASSWORD=
+# PAYPAL_API_SIGNATURE=

app/Actions/Diagnostics/Pipes/Checks/WebshopCheck.php

@@ -8,6 +8,7 @@
 
 namespace App\Actions\Diagnostics\Pipes\Checks;
 
+use App\Actions\Shop\OrderService;
 use App\Contracts\DiagnosticPipe;
 use App\DTO\DiagnosticData;
 use App\Enum\OmnipayProviderType;
@@ -22,6 +23,7 @@ class WebshopCheck implements DiagnosticPipe
 {
 	public function __construct(
 		private OmnipayFactory $factory,
+		private OrderService $order_service,
 	) {
 	}
 
@@ -37,6 +39,14 @@ public function handle(array &$data, \Closure $next): array
 		if (!Configs::getValueAsBool('webshop_enabled')) {
 			return $next($data);
 		}
+		// @codeCoverageIgnoreStart
+		if (config('omnipay.testMode', false) === true) {
+			$data[] = DiagnosticData::warn(
+				'Webshop is running in test mode.',
+				self::class,
+				['This means that payments won\'t be executed.', 'Users may use it to get free content.']
+			);
+		}
 
 		if (config('app.env', 'production') !== 'production') {
 			$data[] = DiagnosticData::warn(
@@ -61,6 +71,25 @@ public function handle(array &$data, \Closure $next): array
 			);
 		}
 
+		$number_broken_order = $this->order_service->selectClosedOrderNeedingFulfillmentQuery()->count();
+		if ($number_broken_order > 0) {
+			$data[] = DiagnosticData::error(
+				'There are ' . $number_broken_order . ' closed orders with items that have no associated download link or size variant.',
+				self::class,
+				['Please check and assign the needed materials.']
+			);
+		}
+
+		$number_waiting_order = $this->order_service->selectCompleteOrderNeedingFulfillmentQuery()->count();
+		if ($number_waiting_order > 0) {
+			$data[] = DiagnosticData::warn(
+				'There are ' . $number_waiting_order . ' completed orders which require your attention.',
+				self::class,
+				['Please check and fulfill them in order to mark them as closed.']
+			);
+		}
+		// @codeCoverageIgnoreEnd
+
 		return $next($data);
 	}
 }

app/Actions/Shop/BasketService.php

@@ -60,11 +60,10 @@ protected function ensurePendingStatus(Order $basket): void
 	public function getOrCreateBasket(?Order $basket, ?User $user = null): Order
 	{
 		if ($basket !== null) {
-			$this->ensurePendingStatus($basket);
-
 			// If user is now logged in but basket wasn't associated with a user
 			if ($user !== null && $basket->user_id === null) {
 				$basket->user_id = $user->id;
+				$basket->email = $user->email;
 				$basket->save();
 			}
 

app/Actions/Shop/CheckoutService.php

@@ -16,9 +16,11 @@
 use App\Models\Order;
 use App\Services\MoneyService;
 use Illuminate\Support\Facades\Log;
+use Illuminate\Support\Facades\Session;
 use Omnipay\Common\Exception\InvalidCreditCardException;
 use Omnipay\Common\Message\RedirectResponseInterface;
 use Omnipay\Common\Message\ResponseInterface;
+use Omnipay\Mollie\Message\Response\FetchTransactionResponse;
 
 /**
  * Service for handling checkout operations using Omnipay.
@@ -80,6 +82,13 @@ public function processPayment(Order $order, string $return_url, string $cancel_
 
 			// Handle the response
 			if ($response->isRedirect()) {
+				if ($response instanceof FetchTransactionResponse) {
+					$metadata = $response->getMetadata();
+					$reference = $response->getTransactionReference();
+					$metadata['transactionReference'] = $reference;
+					Session::put('metadata.' . $order->id, $metadata);
+				}
+
 				if (!$response instanceof RedirectResponseInterface) {
 					throw new LycheeLogicException('Expected RedirectResponseInterface for redirect response.');
 				}
@@ -151,22 +160,23 @@ public function completePayment(Order $order, ResponseInterface $response): Orde
 	/**
 	 * Handle the return from the payment gateway.
 	 *
-	 * @param Order               $order        The order being processed
-	 * @param array               $request_data The request data from the payment gateway
-	 * @param OmnipayProviderType $provider     The payment provider used
+	 * @param Order               $order    The order being processed
+	 * @param OmnipayProviderType $provider The payment provider used
 	 *
 	 * @return Order|null The updated order if found, null otherwise
 	 */
-	public function handlePaymentReturn(Order $order, array $request_data, OmnipayProviderType $provider): ?Order
+	public function handlePaymentReturn(Order $order, OmnipayProviderType $provider): ?Order
 	{
+		$metadata = Session::get('metadata.' . $order->id, []);
+		Log::info('Payment return metadata', ['metadata' => $metadata]);
+
 		$gateway = $this->omnipay_factory->create_gateway($provider);
 
 		try {
 			if ($order->status !== PaymentStatusType::PROCESSING) {
 				throw new LycheeLogicException('Order with invalid status.');
 			}
-
-			$response = $gateway->completePurchase($request_data)->send();
+			$response = $gateway->completePurchase($metadata)->send();
 			if ($response->isSuccessful()) {
 				return $this->completePayment($order, $response);
 			} else {