perf!: improve model performance

BREAKING CHANGE: removes ability to write attributes and casts arrays in case other than camelcase INT-613
myparcelnl · Sep 9, 2024 · a79da45 · a79da45
1 parent 1c9a68c
commit a79da45
Show file tree

Hide file tree

Showing 36 changed files with 195 additions and 139 deletions.
diff --git a/private/GenerateFactory/Service/ModelFactoryGeneratorService.php b/private/GenerateFactory/Service/ModelFactoryGeneratorService.php
@@ -10,7 +10,7 @@
 use MyParcelNL\Pdk\Console\Types\Shared\Model\ClassDefinition;
 use MyParcelNL\Pdk\Console\Types\Shared\Model\ClassProperty;
 use MyParcelNL\Pdk\Tests\Factory\FactoryFactory;
-use MyParcelNL\Sdk\src\Support\Str;
+use MyParcelNL\Pdk\Base\Support\Str;
 use Throwable;
 
 final class ModelFactoryGeneratorService extends AbstractFactoryGeneratorService

diff --git a/private/PhpLoader.php b/private/PhpLoader.php
@@ -10,7 +10,7 @@
 use MyParcelNL\Pdk\Console\Types\Shared\Concern\ReportsTiming;
 use MyParcelNL\Pdk\Console\Types\Shared\Service\ParsesPhpDocs;
 use MyParcelNL\Pdk\Facade\Pdk;
-use MyParcelNL\Sdk\src\Support\Str;
+use MyParcelNL\Pdk\Base\Support\Str;
 use Nette\Loaders\RobotLoader;
 
 final class PhpLoader

diff --git a/private/Types/Documentation/DocumentationGenerator.php b/private/Types/Documentation/DocumentationGenerator.php
@@ -8,7 +8,7 @@
 use MyParcelNL\Pdk\Console\Types\Shared\AbstractHelperGenerator;
 use MyParcelNL\Pdk\Console\Types\Shared\Model\ClassDefinition;
 use MyParcelNL\Pdk\Console\Types\Shared\Model\KeyValue;
-use MyParcelNL\Sdk\src\Support\Str;
+use MyParcelNL\Pdk\Base\Support\Str;
 use ReflectionClass;
 
 final class DocumentationGenerator extends AbstractHelperGenerator

diff --git a/private/Types/Php/IdeHelperGenerator.php b/private/Types/Php/IdeHelperGenerator.php
@@ -14,7 +14,7 @@
 use MyParcelNL\Pdk\Console\Types\Shared\Model\KeyValue;
 use MyParcelNL\Pdk\Console\Types\Shared\Service\PhpTypeParser;
 use MyParcelNL\Pdk\Facade\Pdk;
-use MyParcelNL\Sdk\src\Support\Str;
+use MyParcelNL\Pdk\Base\Support\Str;
 use Symfony\Component\PropertyInfo\Type;
 
 final class IdeHelperGenerator extends AbstractHelperGenerator

diff --git a/private/Types/Shared/Concern/UsesCache.php b/private/Types/Shared/Concern/UsesCache.php
@@ -9,7 +9,7 @@
 use MyParcelNL\Pdk\Console\Storage\ConsoleMemoryCacheStorage;
 use MyParcelNL\Pdk\Console\Storage\Contract\ConsoleStorageInterface;
 use MyParcelNL\Pdk\Facade\Pdk;
-use MyParcelNL\Sdk\src\Support\Str;
+use MyParcelNL\Pdk\Base\Support\Str;
 use function sprintf;
 
 trait UsesCache

diff --git a/private/Types/Shared/Service/PhpSourceParser.php b/private/Types/Shared/Service/PhpSourceParser.php
@@ -16,7 +16,7 @@
 use MyParcelNL\Pdk\Console\Types\Shared\Concern\ReportsTiming;
 use MyParcelNL\Pdk\Console\Types\Shared\Model\ClassDefinition;
 use MyParcelNL\Pdk\Console\Types\Shared\Model\KeyValue;
-use MyParcelNL\Sdk\src\Support\Str;
+use MyParcelNL\Pdk\Base\Support\Str;
 use ReflectionClass;
 use ReflectionMethod;
 use Symfony\Component\PropertyInfo\Extractor\ReflectionExtractor;

diff --git a/private/Types/Shared/Service/PhpTypeParser.php b/private/Types/Shared/Service/PhpTypeParser.php
@@ -7,7 +7,7 @@
 use MyParcelNL\Pdk\Base\Support\Arr;
 use MyParcelNL\Pdk\Base\Support\Collection;
 use MyParcelNL\Pdk\Base\Support\Utils;
-use MyParcelNL\Sdk\src\Support\Str;
+use MyParcelNL\Pdk\Base\Support\Str;
 use Symfony\Component\PropertyInfo\Type;
 
 class PhpTypeParser

diff --git a/private/Types/TypeScript/TsTypeParser.php b/private/Types/TypeScript/TsTypeParser.php
@@ -9,7 +9,7 @@
 use DateTimeImmutable;
 use MyParcelNL\Pdk\Base\Support\Arr;
 use MyParcelNL\Pdk\Console\Types\Shared\Concern\UsesCache;
-use MyParcelNL\Sdk\src\Support\Str;
+use MyParcelNL\Pdk\Base\Support\Str;
 
 class TsTypeParser
 {

diff --git a/src/App/Action/Backend/Webhook/AbstractWebhooksAction.php b/src/App/Action/Backend/Webhook/AbstractWebhooksAction.php
@@ -11,7 +11,7 @@
 use MyParcelNL\Pdk\Webhook\Collection\WebhookSubscriptionCollection;
 use MyParcelNL\Pdk\Webhook\Model\WebhookSubscription;
 use MyParcelNL\Pdk\Webhook\Repository\WebhookSubscriptionRepository;
-use MyParcelNL\Sdk\src\Support\Str;
+use MyParcelNL\Pdk\Base\Support\Str;
 
 abstract class AbstractWebhooksAction implements ActionInterface
 {

diff --git a/src/App/DeliveryOptions/Service/DeliveryOptionsFeesService.php b/src/App/DeliveryOptions/Service/DeliveryOptionsFeesService.php
@@ -12,7 +12,7 @@
 use MyParcelNL\Pdk\Shipment\Model\DeliveryOptions;
 use MyParcelNL\Pdk\Shipment\Model\ShipmentOptions;
 use MyParcelNL\Pdk\Types\Service\TriStateService;
-use MyParcelNL\Sdk\src\Support\Str;
+use MyParcelNL\Pdk\Base\Support\Str;
 
 class DeliveryOptionsFeesService implements DeliveryOptionsFeesServiceInterface
 {

diff --git a/src/App/DeliveryOptions/Service/DeliveryOptionsService.php b/src/App/DeliveryOptions/Service/DeliveryOptionsService.php
@@ -21,7 +21,7 @@
 use MyParcelNL\Pdk\Shipment\Model\DeliveryOptions;
 use MyParcelNL\Pdk\Validation\Repository\SchemaRepository;
 use MyParcelNL\Pdk\Validation\Validator\OrderPropertiesValidator;
-use MyParcelNL\Sdk\src\Support\Str;
+use MyParcelNL\Pdk\Base\Support\Str;
 
 class DeliveryOptionsService implements DeliveryOptionsServiceInterface
 {

diff --git a/src/App/Order/Calculator/General/LabelDescriptionCalculator.php b/src/App/Order/Calculator/General/LabelDescriptionCalculator.php
@@ -12,7 +12,7 @@
 use MyParcelNL\Pdk\Fulfilment\Model\OrderNote;
 use MyParcelNL\Pdk\Settings\Model\LabelSettings;
 use MyParcelNL\Pdk\Types\Service\TriStateService;
-use MyParcelNL\Sdk\src\Support\Str;
+use MyParcelNL\Pdk\Base\Support\Str;
 
 final class LabelDescriptionCalculator extends AbstractPdkOrderOptionCalculator
 {

diff --git a/src/App/Order/Model/PdkProduct.php b/src/App/Order/Model/PdkProduct.php
@@ -84,6 +84,7 @@ public function toStorableArray(): array
 
     /**
      * @return \MyParcelNL\Pdk\Settings\Model\ProductSettings
+     * @noinspection PhpUnused
      */
     protected function getMergedSettingsAttribute(): ProductSettings
     {
@@ -121,12 +122,13 @@ private function resolveMergedSettings(): ProductSettings
             return $settings;
         }
 
+        /** @var \MyParcelNL\Pdk\Types\Contract\TriStateServiceInterface $triStateService */
         $triStateService = Pdk::get(TriStateServiceInterface::class);
 
         foreach ($settings->getAttributes() as $key => $value) {
             $coerced = $triStateService->coerce($settings->getAttribute($key));
 
-            if ($coerced === '-1') {
+            if ((string) TriStateService::INHERIT === $coerced) {
                 $coerced = (int) $coerced;
             }
 

diff --git a/src/Base/Concern/HasAttributes.php b/src/Base/Concern/HasAttributes.php
@@ -14,12 +14,12 @@
 use MyParcelNL\Pdk\Base\Exception\InvalidCastException;
 use MyParcelNL\Pdk\Base\Support\Arr;
 use MyParcelNL\Pdk\Base\Support\Collection;
+use MyParcelNL\Pdk\Base\Support\Str;
 use MyParcelNL\Pdk\Base\Support\Utils;
 use MyParcelNL\Pdk\Facade\Logger;
 use MyParcelNL\Pdk\Facade\Pdk;
 use MyParcelNL\Pdk\Types\Contract\TriStateServiceInterface;
 use MyParcelNL\Pdk\Types\Service\TriStateService;
-use MyParcelNL\Sdk\src\Support\Str;
 use Throwable;
 
 /**
@@ -183,7 +183,7 @@ public function getAttribute(string $key)
             return null;
         }
 
-        $key = Utils::changeCase($key);
+        $key = Str::changeCase($key);
 
         if ($this->isGuarded($key)) {
             return $this->guarded[$key];
@@ -269,7 +269,7 @@ public function only($attributes, ?int $flags = null): array
      */
     public function setAttribute(string $key, $value): self
     {
-        $key = $this->convertDeprecatedKey(Utils::changeCase($key));
+        $key = $this->convertDeprecatedKey(Str::changeCase($key));
 
         if ($this->isGuarded($key)) {
             return $this;
@@ -301,8 +301,8 @@ public function setAttribute(string $key, $value): self
     protected function addCastAttributesToArray(array $attributes, array $mutatedAttributes, ?int $flags): array
     {
         foreach ($this->getCasts() as $key => $value) {
-            $originalKey = Utils::changeCase($key);
-            $key         = Utils::changeCase($key, $flags);
+            $originalKey = Str::changeCase($key);
+            $key         = Str::changeCase($key, $flags);
 
             if (! array_key_exists($key, $attributes) || in_array($key, $mutatedAttributes, true)) {
                 continue;
@@ -358,8 +358,8 @@ protected function addCastAttributesToArray(array $attributes, array $mutatedAtt
     protected function addMutatedAttributesToArray(array $attributes, array $mutatedAttributes, ?int $flags): array
     {
         foreach ($mutatedAttributes as $key) {
-            $originalKey = Utils::changeCase($key);
-            $key         = Utils::changeCase($key, $flags);
+            $originalKey = Str::changeCase($key);
+            $key         = Str::changeCase($key, $flags);
 
             if (! array_key_exists($key, $attributes)) {
                 continue;
@@ -582,7 +582,7 @@ protected function getCastAttribute(string $string)
     protected function getCastType(string $key): ?string
     {
         $casts         = $this->getCasts();
-        $normalizedKey = Utils::changeCase($key);
+        $normalizedKey = Str::changeCase($key);
 
         return $casts[$normalizedKey];
     }
@@ -594,7 +594,7 @@ protected function getCastType(string $key): ?string
      */
     protected function getCasts(): array
     {
-        return Utils::changeArrayKeysCase($this->casts);
+        return $this->casts;
     }
 
     /**

diff --git a/src/Base/Config.php b/src/Base/Config.php
@@ -8,7 +8,7 @@
 use MyParcelNL\Pdk\Base\Contract\ConfigInterface;
 use MyParcelNL\Pdk\Base\Support\Arr;
 use MyParcelNL\Pdk\Facade\Pdk as PdkFacade;
-use MyParcelNL\Sdk\src\Support\Str;
+use MyParcelNL\Pdk\Base\Support\Str;
 
 class Config implements ConfigInterface
 {

diff --git a/src/Base/Model/Model.php b/src/Base/Model/Model.php
@@ -9,8 +9,9 @@
 use MyParcelNL\Pdk\Base\Contract\Arrayable;
 use MyParcelNL\Pdk\Base\Contract\ModelInterface;
 use MyParcelNL\Pdk\Base\Contract\StorableArrayable;
+use MyParcelNL\Pdk\Base\Support\Arr;
+use MyParcelNL\Pdk\Base\Support\Str;
 use MyParcelNL\Pdk\Base\Support\Utils;
-use MyParcelNL\Sdk\src\Support\Str;
 
 /**
  * @SuppressWarnings(PHPMD.TooManyPublicMethods)
@@ -29,6 +30,8 @@ class Model implements StorableArrayable, ArrayAccess, ModelInterface
      */
     protected static $traitInitializers;
 
+    protected        $lazy = [];
+
     /**
      * @var bool
      */
@@ -41,14 +44,29 @@ public function __construct(?array $data = null)
     {
         $this->bootIfNotBooted();
 
-        $this->guarded    = Utils::changeArrayKeysCase($this->guarded);
-        $this->attributes = $this->guarded + Utils::changeArrayKeysCase($this->attributes);
+        $this->attributes = $this->guarded + $this->attributes;
 
         $this->initializeTraits();
 
-        $convertedData = Utils::changeArrayKeysCase($data ?? []);
+        // filter out the items that are in $this->lazy
+        $attributes = Utils::changeArrayKeysCase($data ?? []) + $this->attributes;
+
+        $filteredAttributes = count($this->lazy)
+            ? Arr::where($attributes, function ($value, $key) {
+                return $value !== null || ! $this->isLazy($key);
+            }) : $attributes;
 
-        $this->fill($convertedData + $this->attributes);
+        $this->fill($filteredAttributes);
+    }
+
+    /**
+     * @param  string $key
+     *
+     * @return bool
+     */
+    private function isLazy(string $key): bool
+    {
+        return in_array($key, $this->lazy, true);
     }
 
     public static function isBooted(): bool
@@ -225,7 +243,7 @@ public function offsetSet($offset, $value): void
      */
     public function offsetUnset($offset): void
     {
-        unset($this->attributes[(Utils::changeCase($offset))]);
+        unset($this->attributes[(Str::changeCase($offset))]);
     }
 
     /**
@@ -313,7 +331,7 @@ private function normalizeAttributes(array $attributes): array
         $normalizedAttributes = [];
 
         foreach ($attributes as $initialKey => $value) {
-            $caseKey = Utils::changeCase($initialKey);
+            $caseKey = Str::changeCase($initialKey);
             $key     = $this->convertDeprecatedKey($caseKey);
 
             if (array_key_exists($key, $normalizedAttributes)) {

diff --git a/src/Base/Service/CountryService.php b/src/Base/Service/CountryService.php
@@ -6,7 +6,7 @@
 
 use MyParcelNL\Pdk\Base\Contract\CountryServiceInterface;
 use MyParcelNL\Pdk\Facade\Platform;
-use MyParcelNL\Sdk\src\Support\Str;
+use MyParcelNL\Pdk\Base\Support\Str;
 
 class CountryService implements CountryServiceInterface
 {

diff --git a/src/Base/Support/Str.php b/src/Base/Support/Str.php
@@ -0,0 +1,57 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MyParcelNL\Pdk\Base\Support;
+
+use MyParcelNL\Pdk\Base\Contract\Arrayable;
+use MyParcelNL\Sdk\src\Support\Str as SdkStr;
+
+class Str extends SdkStr
+{
+    /**
+     * @var array
+     */
+    private static $flagCaseCache = [];
+
+    /**
+     * @param  string   $string
+     * @param  null|int $flags
+     *
+     * @return string
+     */
+    public static function changeCase(string $string, ?int $flags = null): string
+    {
+        $case = self::getFlagCase($flags);
+
+        return self::{$case}($string);
+    }
+
+    /**
+     * @param  null|int $flags
+     *
+     * @return string
+     */
+    private static function getFlagCase(?int $flags = null): string
+    {
+        if (! isset(self::$flagCaseCache[$flags])) {
+            $case = 'camel';
+
+            if ($flags & Arrayable::CASE_SNAKE) {
+                $case = 'snake';
+            }
+
+            if ($flags & Arrayable::CASE_KEBAB) {
+                $case = 'kebab';
+            }
+
+            if ($flags & Arrayable::CASE_STUDLY) {
+                $case = 'studly';
+            }
+
+            self::$flagCaseCache[$flags] = $case;
+        }
+
+        return self::$flagCaseCache[$flags];
+    }
+}