fix: refactor Request scope cache feature (#415)

remove unnecessary middleware that was affecting performance

Author: smarcet

app/Http/Kernel.php

@@ -39,7 +39,6 @@ class Kernel extends HttpKernel
         \App\Http\Middleware\SecurityHTTPHeadersWriterMiddleware::class,
         \App\Http\Middleware\ParseMultipartFormDataInputForNonPostRequests::class,
         \App\Http\Middleware\DoctrineMiddleware::class,
-        \App\Http\Middleware\RequestScopedCacheMiddleware::class,
     ];
 
     /**

app/Http/Middleware/RequestScopedCacheMiddleware.php

@@ -13,7 +13,6 @@
  **/
 
 use App\ModelSerializers\Traits\RequestScopedCache;
-use Libs\ModelSerializers\AbstractSerializer;
 use models\summit\SummitTicketType;
 
 /**
@@ -76,4 +75,4 @@ public function serialize($expand = null, array $fields = [], array $relations =
         });
 
     }
-}
+}

app/ModelSerializers/Summit/Registration/SummitTicketTypeSerializer.php

@@ -24,6 +24,9 @@
 trait RequestScopedCache
 {
 
+    static function store(){
+        return  Cache::store(config('cache.request_scope_cache_store', 'array'));
+    }
     /**
      * @return string
      */
@@ -36,34 +39,12 @@ static function getScopeId():string{
             $time = time();
             $sessionId = Session::getId();
             $uuid = Uuid::uuid4()->toString();
-            /*Log::debug
-            (
-                sprintf
-                (
-                    "RequestScopedCache::getScopeId scope is empty ip %s time %s sessionId %s uuid%s .",
-                    $ip , $time, $sessionId, $uuid
-                )
-            );*/
-
             $requestId = md5(sprintf("%s.%s.%s.%s", $ip, $time, $sessionId, $uuid));
-
-            /*Log::debug
-            (
-                sprintf
-                (
-                    "RequestScopedCache::getScopeId setting request id %s.",
-                    $requestId
-                )
-            );*/
-
             $request->headers->set('X-Request-ID', $requestId);
-
             $_SERVER['HTTP_X_REQUEST_ID'] = $requestId;
 
         }
 
-        //Log::debug(sprintf("RequestScopedCache::getScopeId retrieving request id %s" , $requestId));
-
         return $requestId;
     }
 
@@ -86,23 +67,21 @@ function getRequestKey(string $serializeName, int $id, ?string $expand = null, a
      * @return mixed
      */
     function cache(string $key, Closure $callback){
+        $key   = self::getScopeId().':'.$key;
+        $store = self::store();
 
-        $scope = self::getScopeId();
+        $computed = false;
 
-        //Log::debug(sprintf("RequestScopedCache::cache scope %s key %s.", $scope, $key));
+        $value = $store->remember($key, now()->addSeconds(30), function () use ($callback, &$computed, $key) {
+            $computed = true; // closure ran => MISS
+            Log::debug('RequestScopedCache MISS', ['key' => $key]);
+            return $callback();
+        });
 
-        $res = Cache::tags($scope)->get($key);
-        if(!empty($res)){
-            $json_res = gzinflate($res);
-            $res = json_decode($json_res,true);
-            //Log::debug(sprintf("RequestScopedCache::cache scope %s key %s cache hit res %s.", $scope, $key, $json_res));
-            return $res;
+        if (!$computed) {
+            Log::debug('RequestScopedCache HIT', ['key' => $key]);
         }
 
-        $res = $callback();
-        $json = json_encode($res);
-        //Log::debug(sprintf("RequestScopedCache::cache scope %s key %s res %s adding to cache.", $scope, $key, $json));
-        Cache::tags($scope)->add($key, gzdeflate($json, 9));
-        return $res;
+        return $value;
     }
-}
+}

app/ModelSerializers/Traits/RequestScopedCache.php

@@ -88,5 +88,5 @@
     */
 
     'prefix' => 'laravel',
-
+    'request_scope_cache_store' => env('REQUEST_SCOPE_CACHE_STORE', 'array'),
 ];