ACPT-1552

Made new classes for caching region models and country models for AbstraceAddress

Author: JacobBrownAustin

app/code/Magento/Customer/Model/Address/AbstractAddress.php

@@ -11,6 +11,8 @@
 use Magento\Customer\Api\Data\AddressInterfaceFactory;
 use Magento\Customer\Api\Data\RegionInterface;
 use Magento\Customer\Api\Data\RegionInterfaceFactory;
+use Magento\Customer\Model\Address\AbstractAddress\CountryModelsCache;
+use Magento\Customer\Model\Address\AbstractAddress\RegionModelsCache;
 use Magento\Customer\Model\Data\Address as AddressData;
 use Magento\Framework\App\ObjectManager;
 use Magento\Framework\Model\AbstractExtensibleModel;
@@ -61,18 +63,28 @@ class AbstractAddress extends AbstractExtensibleModel implements AddressModelInt
     protected $_eventObject = 'customer_address';
 
     /**
-     * cache of Directory country models
+     * Directory country models
      *
      * @var \Magento\Directory\Model\Country[]
+     * @deprecated
+     * @see $countryModelsCache
      */
-    protected $_countryModels = [];
+    protected static $_countryModels = [];
+
+    /** @var CountryModelsCache */
+    private readonly CountryModelsCache $countryModelsCache;
 
     /**
-     * cache of Directory region models
+     * Directory region models
      *
      * @var \Magento\Directory\Model\Region[]
+     * @deprecated
+     * @see $regionModelsCache
      */
-    protected $_regionModels = [];
+    protected static $_regionModels = [];
+
+    /** @var RegionModelsCache */
+    private readonly RegionModelsCache $regionModelsCache;
 
     /**
      * @var \Magento\Directory\Helper\Data
@@ -144,7 +156,9 @@ class AbstractAddress extends AbstractExtensibleModel implements AddressModelInt
      * @param \Magento\Framework\Model\ResourceModel\AbstractResource $resource
      * @param \Magento\Framework\Data\Collection\AbstractDb $resourceCollection
      * @param array $data
-     * @param CompositeValidator $compositeValidator
+     * @param CompositeValidator|null $compositeValidator
+     * @param CountryModelsCache|null $countryModelsCache
+     * @param RegionModelsCache|null $regionModelsCache
      *
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
@@ -165,7 +179,9 @@ public function __construct(
         \Magento\Framework\Model\ResourceModel\AbstractResource $resource = null,
         \Magento\Framework\Data\Collection\AbstractDb $resourceCollection = null,
         array $data = [],
-        CompositeValidator $compositeValidator = null
+        ?CompositeValidator $compositeValidator = null,
+        ?CountryModelsCache $countryModelsCache = null,
+        ?RegionModelsCache $regionModelsCache = null,
     ) {
         $this->_directoryData = $directoryData;
         $data = $this->_implodeArrayField($data);
@@ -179,6 +195,10 @@ public function __construct(
         $this->dataObjectHelper = $dataObjectHelper;
         $this->compositeValidator = $compositeValidator ?: ObjectManager::getInstance()
             ->get(CompositeValidator::class);
+        $this->countryModelsCache = $countryModelsCache ?: ObjectManager::getInstance()
+            ->get(CountryModelsCache::class);
+        $this->regionModelsCache = $regionModelsCache ?: ObjectManager::getInstance()
+            ->get(RegionModelsCache::class);
         parent::__construct(
             $context,
             $registry,
@@ -502,12 +522,12 @@ public function getCountry()
      */
     public function getCountryModel()
     {
-        if (!isset($this->_countryModels[$this->getCountryId()])) {
+        if ($country = $this->countryModelsCache->get($this->getCountryId())) {
             $country = $this->_createCountryInstance();
             $country->load($this->getCountryId());
-            $this->_countryModels[$this->getCountryId()] = $country;
+            $this->countryModelsCache->add($this->getCountryId(), $country);
         }
-        return $this->_countryModels[$this->getCountryId()];
+        return $country;
     }
 
     /**
@@ -521,14 +541,12 @@ public function getRegionModel($regionId = null)
         if ($regionId === null) {
             $regionId = $this->getRegionId();
         }
-
-        if (!isset($this->_regionModels[$regionId])) {
+        if ($region = $this->regionModelsCache->get($regionId)) {
             $region = $this->_createRegionInstance();
             $region->load($regionId);
-            $this->_regionModels[$regionId] = $region;
+            $this->regionModelsCache->add($regionId, $region);
         }
-
-        return $this->_regionModels[$regionId];
+        return $region;
     }
 
     /**
@@ -746,7 +764,7 @@ private function processCustomAttribute(array $attribute): array
      */
     public function _resetState(): void
     {
-        $this->_countryModels  = [];
-        $this->_regionModels = [];
+        self::$_countryModels  = [];
+        self::$_regionModels = [];
     }
 }

app/code/Magento/Customer/Model/Address/AbstractAddress/CountryModelsCache.php

@@ -0,0 +1,50 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\Customer\Model\Address\AbstractAddress;
+
+use Magento\Directory\Model\Country;
+use Magento\Framework\ObjectManager\ResetAfterRequestInterface;
+
+/**
+ * Cache of Country Models
+ */
+class CountryModelsCache implements ResetAfterRequestInterface
+{
+    /** @var array */
+    private array $countryModels = [];
+
+    /**
+     * @inheritDoc
+     */
+    public function _resetState(): void
+    {
+        $this->countryModels = [];
+    }
+
+    /**
+     * Adds model to cache using key
+     *
+     * @param string $key
+     * @param Country $value
+     * @return void
+     */
+    public function add(string $key, Country $model) : void
+    {
+        $this->countryModels[$key] = $model;
+    }
+
+    /**
+     * Gets model from cache using key
+     *
+     * @param string $key
+     * @return Country|null
+     */
+    public function get(string $key) : ?Country
+    {
+        return $this->countryModels[$key] ?? null;
+    }
+}

app/code/Magento/Customer/Model/Address/AbstractAddress/RegionModelsCache.php

@@ -0,0 +1,50 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\Customer\Model\Address\AbstractAddress;
+
+use Magento\Directory\Model\Region;
+use Magento\Framework\ObjectManager\ResetAfterRequestInterface;
+
+/**
+ * Cache of Region Models
+ */
+class RegionModelsCache implements ResetAfterRequestInterface
+{
+    /** @var array */
+    private array $regionModels = [];
+
+    /**
+     * @inheritDoc
+     */
+    public function _resetState(): void
+    {
+        $this->regionModels = [];
+    }
+
+    /**
+     * Adds model to cache using key
+     *
+     * @param string $key
+     * @param Region $value
+     * @return void
+     */
+    public function add(string $key, Region $model) : void
+    {
+        $this->regionModels[$key] = $model;
+    }
+
+    /**
+     * Gets model from cache using key
+     *
+     * @param string $key
+     * @return Region|null
+     */
+    public function get(string $key) : ?Region
+    {
+        return $this->regionModels[$key] ?? null;
+    }
+}