PES-2913: introduced carrier and shipping method caching (#829)

Author: zemekoule

changelog.txt

@@ -1,4 +1,7 @@
 == Changelog ==
+= 2.0.10 =
+Fixed: Introduced carrier and shipping method caching to prevent excessive memory usage and performance problems.
+
 = 2.0.9 =
 Fixed: Type error when migrating guest session to user session during order.
 

languages/packeta.pot

@@ -2,14 +2,14 @@
 # This file is distributed under the GNU General Public License v3.0.
 msgid ""
 msgstr ""
-"Project-Id-Version: Packeta 2.0.9\n"
+"Project-Id-Version: Packeta 2.0.10\n"
 "Report-Msgid-Bugs-To: https://wordpress.org/support/plugin/packeta\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <[email protected]>\n"
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=UTF-8\n"
 "Content-Transfer-Encoding: 8bit\n"
-"POT-Creation-Date: 2025-08-08T10:10:14+02:00\n"
+"POT-Creation-Date: 2025-08-14T14:49:12+02:00\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "X-Generator: WP-CLI 2.11.0\n"
 "X-Domain: packeta\n"
@@ -24,7 +24,7 @@ msgstr ""
 #: src/Packetery/Module/Carrier/PacketaPickupPointsConfig.php:137
 #: src/Packetery/Module/Checkout/CheckoutRenderer.php:88
 #: src/Packetery/Module/Checkout/CheckoutRenderer.php:110
-#: src/Packetery/Module/Checkout/CheckoutSettings.php:181
+#: src/Packetery/Module/Checkout/CheckoutSettings.php:190
 #: src/Packetery/Module/DashboardWidget.php:116
 #: src/Packetery/Module/DashboardWidget.php:189
 #: src/Packetery/Module/Log/Page.php:133
@@ -582,38 +582,38 @@ msgstr ""
 msgid "COD surcharge"
 msgstr ""
 
-#: src/Packetery/Module/Checkout/CheckoutSettings.php:182
+#: src/Packetery/Module/Checkout/CheckoutSettings.php:191
 #: src/Packetery/Module/Order/Metabox.php:647
 msgid "Choose pickup point"
 msgstr ""
 
-#: src/Packetery/Module/Checkout/CheckoutSettings.php:183
+#: src/Packetery/Module/Checkout/CheckoutSettings.php:192
 #: src/Packetery/Module/Checkout/CheckoutValidator.php:157
 msgid "Pickup point is not chosen."
 msgstr ""
 
-#: src/Packetery/Module/Checkout/CheckoutSettings.php:184
+#: src/Packetery/Module/Checkout/CheckoutSettings.php:193
 msgid "Loading Packeta widget button..."
 msgstr ""
 
-#: src/Packetery/Module/Checkout/CheckoutSettings.php:185
+#: src/Packetery/Module/Checkout/CheckoutSettings.php:194
 msgid "Choose delivery address"
 msgstr ""
 
-#: src/Packetery/Module/Checkout/CheckoutSettings.php:186
+#: src/Packetery/Module/Checkout/CheckoutSettings.php:195
 msgid "Address validation is out of order"
 msgstr ""
 
-#: src/Packetery/Module/Checkout/CheckoutSettings.php:187
+#: src/Packetery/Module/Checkout/CheckoutSettings.php:196
 #: src/Packetery/Module/Order/Metabox.php:599
 msgid "The selected country does not correspond to the destination country."
 msgstr ""
 
-#: src/Packetery/Module/Checkout/CheckoutSettings.php:188
+#: src/Packetery/Module/Checkout/CheckoutSettings.php:197
 msgid "The order will be delivered to the address:"
 msgstr ""
 
-#: src/Packetery/Module/Checkout/CheckoutSettings.php:189
+#: src/Packetery/Module/Checkout/CheckoutSettings.php:198
 msgid "Delivery address has not been chosen. Choosing a delivery address using the widget is required by this carrier."
 msgstr ""
 
@@ -1473,7 +1473,7 @@ msgstr ""
 
 #: src/Packetery/Module/Order/GridExtender.php:399
 #: src/Packetery/Module/Order/Metabox.php:430
-#: src/Packetery/Module/Views/AssetManager.php:246
+#: src/Packetery/Module/Views/AssetManager.php:254
 msgid "It is not possible to submit the shipment because all the information required for this shipment is not filled."
 msgstr ""
 
@@ -2076,7 +2076,7 @@ msgstr ""
 msgid "Database %s table of Packeta plugin could not be created or altered, you can find more information in Packeta log."
 msgstr ""
 
-#: src/Packetery/Module/Views/AssetManager.php:245
+#: src/Packetery/Module/Views/AssetManager.php:253
 msgid "Customs declaration has to be filled in order detail."
 msgstr ""
 

packeta.php

@@ -8,7 +8,7 @@
  *
  * Plugin Name: Packeta
  * Description: This is the official plugin, that allows you to choose pickup points of Packeta and its external carriers in all of Europe, or utilize address delivery to 25 countries in the European Union, straight from the cart in your e-shop. Furthermore, you can also submit all your orders to Packeta with just one click.
- * Version: 2.0.9
+ * Version: 2.0.10
  * Author: Zásilkovna s.r.o.
  * Author URI: https://www.zasilkovna.cz/
  * Text Domain: packeta

readme.txt

@@ -3,7 +3,7 @@ Contributors: packeta
 Tags: WooCommerce, shipping
 Requires at least: 5.5
 Tested up to: 6.8.2
-Stable tag: 2.0.9
+Stable tag: 2.0.10
 Requires PHP: 7.2
 WC requires at least: 5.1
 WC tested up to: 10.0.4
@@ -63,6 +63,9 @@ We are constantly working on adding new features. If there is a feature you woul
 Please contact us at [email protected] .
 
 == Changelog ==
+= 2.0.10 =
+Fixed: Introduced carrier and shipping method caching to prevent excessive memory usage and performance problems.
+
 = 2.0.9 =
 Fixed: Type error when migrating guest session to user session during order.
 

src/Packetery/Module/Carrier/EntityRepository.php

@@ -19,6 +19,11 @@
  */
 class EntityRepository {
 
+	/**
+	 * @var array<int, Entity\Carrier|null>
+	 */
+	private static $carrierDataCache = [];
+
 	/**
 	 * Carrier repository.
 	 *
@@ -82,7 +87,7 @@ public function __construct(
 	 *
 	 * @return Entity\Carrier|null
 	 */
-	public function getById( int $carrierId ): ?Entity\Carrier {
+	private function getById( int $carrierId ): ?Entity\Carrier {
 		$result = $this->repository->getById( $carrierId );
 		if ( $result === null ) {
 			return null;
@@ -91,14 +96,23 @@ public function getById( int $carrierId ): ?Entity\Carrier {
 		return $this->carrierEntityFactory->fromDbResult( $result );
 	}
 
+	private function getByIdCached( int $carrierId ): ?Entity\Carrier {
+		if ( ! isset( self::$carrierDataCache[ $carrierId ] ) ) {
+			self::$carrierDataCache[ $carrierId ] = $this->getById( $carrierId );
+		}
+
+		return self::$carrierDataCache[ $carrierId ];
+	}
+
 	/**
 	 * Gets feed carrier or Packeta carrier by id.
 	 *
 	 * @param string $carrierId Extended branch service id.
+	 * @param bool   $useCache
 	 *
 	 * @return Entity\Carrier|null
 	 */
-	public function getAnyById( string $carrierId ): ?Entity\Carrier {
+	public function getAnyById( string $carrierId, bool $useCache = false ): ?Entity\Carrier {
 		$nonFeedCarriers = $this->pickupPointsConfig->getCompoundAndVendorCarriers();
 
 		foreach ( $nonFeedCarriers as $nonFeedCarrier ) {
@@ -111,6 +125,10 @@ public function getAnyById( string $carrierId ): ?Entity\Carrier {
 			return null;
 		}
 
+		if ( $useCache === true ) {
+			return $this->getByIdCached( (int) $carrierId );
+		}
+
 		return $this->getById( (int) $carrierId );
 	}
 

src/Packetery/Module/Hooks/HookRegistrar.php

@@ -573,9 +573,7 @@ public function addLinksToPluginGrid(): void {
 	 */
 	public function addShippingMethods( array $methods ): array {
 		if ( $this->optionsProvider->isWcCarrierConfigEnabled() ) {
-			$unsortedMethods = $this->shippingProvider->addMethods( $methods );
-
-			return $this->shippingProvider->sortMethods( $unsortedMethods );
+			return $this->shippingProvider->getSortedCachedMethods( $methods );
 		}
 
 		$methods[ ShippingMethod::PACKETERY_METHOD_ID ] = ShippingMethod::class;

src/Packetery/Module/Plugin.php

@@ -18,7 +18,7 @@
  */
 class Plugin {
 
-	public const VERSION                = '2.0.9';
+	public const VERSION                = '2.0.10';
 	public const DOMAIN                 = 'packeta';
 	public const PARAM_PACKETERY_ACTION = 'packetery_action';
 	public const PARAM_NONCE            = '_wpnonce';

src/Packetery/Module/Shipping/BaseShippingMethod.php

@@ -71,7 +71,7 @@ public function __construct( int $instanceId = 0 ) {
 		// phpcs:ignore Squiz.NamingConventions.ValidVariableName.MemberNotCamelCaps
 		$this->method_description = __( 'Allows to choose one of Packeta delivery methods', 'packeta' );
 
-		$carrier = $this->carrierRepository->getAnyById( static::CARRIER_ID );
+		$carrier = $this->carrierRepository->getAnyById( static::CARRIER_ID, true );
 		if ( $carrier !== null ) {
 			// phpcs:ignore Squiz.NamingConventions.ValidVariableName.MemberNotCamelCaps
 			$this->method_title = $carrier->getName();

src/Packetery/Module/Shipping/ShippingProvider.php

@@ -16,6 +16,10 @@
 use WC_Order;
 
 class ShippingProvider {
+	/**
+	 * @var array<int, array<string, string>>
+	 */
+	private static $sortedMethodsCache = [];
 
 	/**
 	 * @var FeatureFlagProvider
@@ -153,7 +157,7 @@ public static function isPacketaMethod( string $methodId ): bool {
 	 *
 	 * @return array<string, string>
 	 */
-	public function addMethods( array $methods ): array {
+	private function addMethods( array $methods ): array {
 		$zoneId = $this->contextResolver->getShippingZoneId();
 		if ( $zoneId === null ) {
 			return $this->addAllMethods( $methods );
@@ -225,7 +229,7 @@ private function addActiveCarrierMethod( string $fullyQualifiedClassname, array
 	 *
 	 * @return array<string, string>
 	 */
-	public function sortMethods( array $methods ): array {
+	private function sortMethods( array $methods ): array {
 		uasort(
 			$methods,
 			function ( $classA, $classB ) {
@@ -239,4 +243,21 @@ function ( $classA, $classB ) {
 
 		return $methods;
 	}
+
+	/**
+	 * @param array<string, string> $originalMethods
+	 *
+	 * @return array<string, string>
+	 */
+	public function getSortedCachedMethods( array $originalMethods ): array {
+		// phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize
+		$cacheKey = crc32( serialize( $originalMethods ) );
+
+		if ( ! isset( self::$sortedMethodsCache[ $cacheKey ] ) ) {
+			$unsortedMethods                       = $this->addMethods( $originalMethods );
+			self::$sortedMethodsCache[ $cacheKey ] = $this->sortMethods( $unsortedMethods );
+		}
+
+		return self::$sortedMethodsCache[ $cacheKey ];
+	}
 }

tests/Module/Shipping/ShippingProviderTest.php

@@ -4,12 +4,47 @@
 
 namespace Tests\Module\Shipping;
 
+use Packetery\Module\Carrier\CarDeliveryConfig;
+use Packetery\Module\Carrier\CarrierOptionsFactory;
+use Packetery\Module\Carrier\EntityRepository;
+use Packetery\Module\Carrier\PacketaPickupPointsConfig;
+use Packetery\Module\ContextResolver;
+use Packetery\Module\Options\FlagManager\FeatureFlagProvider;
 use Packetery\Module\Shipping\BaseShippingMethod;
 use Packetery\Module\Shipping\ShippingProvider;
 use Packetery\Module\ShippingMethod;
+use Packetery\Module\ShippingZoneRepository;
+use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
+use ReflectionClass;
 
 class ShippingProviderTest extends TestCase {
+
+	private ContextResolver&MockObject $contextResolver;
+	private ShippingZoneRepository&MockObject $shippingZoneRepository;
+
+	private function createShippingProvider(): ShippingProvider {
+		$this->contextResolver        = $this->createMock( ContextResolver::class );
+		$this->shippingZoneRepository = $this->createMock( ShippingZoneRepository::class );
+
+		return new ShippingProvider(
+			$this->createMock( FeatureFlagProvider::class ),
+			$this->createMock( PacketaPickupPointsConfig::class ),
+			$this->createMock( CarDeliveryConfig::class ),
+			$this->contextResolver,
+			$this->shippingZoneRepository,
+			$this->createMock( EntityRepository::class ),
+			$this->createMock( CarrierOptionsFactory::class )
+		);
+	}
+
+	public function tearDown(): void {
+		$shippingProviderReflection = new ReflectionClass( ShippingProvider::class );
+		$property                   = $shippingProviderReflection->getProperty( 'sortedMethodsCache' );
+		$property->setAccessible( true );
+		$property->setValue( [] );
+	}
+
 	/**
 	 * @return array
 	 */
@@ -48,4 +83,32 @@ public static function shippingMethodsProvider(): array {
 	public function testIsPacketaMethod( $methodId, $isPacketaMethod ): void {
 		self::assertEquals( $isPacketaMethod, ShippingProvider::isPacketaMethod( $methodId ) );
 	}
+
+	public function testGetSortedCachedMethodsFillsCache(): void {
+		$shippingProvider = $this->createShippingProvider();
+
+		$dummyZoneId = 123;
+		$this->contextResolver->expects( $this->once() )->method( 'getShippingZoneId' )->willReturn( $dummyZoneId );
+		$this->shippingZoneRepository->expects( $this->once() )->method( 'getCountryCodesForShippingZone' )->willReturn( [] );
+
+		$shippingProvider->getSortedCachedMethods( [] );
+	}
+
+	public function testGetSortedCachedMethodsGetsFromCache(): void {
+		$shippingProvider = $this->createShippingProvider();
+
+		$originalMethods = [];
+		// phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize
+		$cacheKey = crc32( serialize( $originalMethods ) );
+
+		$shippingProviderReflection = new ReflectionClass( ShippingProvider::class );
+		$property                   = $shippingProviderReflection->getProperty( 'sortedMethodsCache' );
+		$property->setAccessible( true );
+		$property->setValue( [ $cacheKey => [ 'dummyMethodId' => 'dummyMethodClass' ] ] );
+
+		$this->contextResolver->expects( $this->never() )->method( 'getShippingZoneId' );
+		$this->shippingZoneRepository->expects( $this->never() )->method( 'getCountryCodesForShippingZone' );
+
+		$shippingProvider->getSortedCachedMethods( $originalMethods );
+	}
 }