Feature/serialzer cache (#244)

* feat: cache smart cache on serializers

Change-Id: I0d0994bf1da352a7a3b0d5a8427a379ce78cf56a

* fix: expand relations on events related serializers

Signed-off-by: [email protected] <[email protected]>
Change-Id: Ifbd7abbb73ff7be2a280768710df5e45a99c80fc

* refactor: add serializer decorator for params pre processing
refactor: removed unused code
fix: add relation and field usage over all serializers

Change-Id: If3903f5965535fb792babe4c79bc570a07b633d9

* fix: added validation exception

Change-Id: I9bb93caf91b909c611de813ca4af49300590cffa

---------

Signed-off-by: [email protected] <[email protected]>

Author: smarcet

Libs/ModelSerializers/AbstractSerializer.php

@@ -50,8 +50,7 @@ public function __construct($object, IResourceServerContext $resource_server_con
         $this->resource_server_context = $resource_server_context;
     }
 
-    protected static $array_mappings = [
-    ];
+    protected static $array_mappings = [];
 
     protected static $allowed_fields = [];
 
@@ -62,7 +61,7 @@ public function __construct($object, IResourceServerContext $resource_server_con
     /**
      * @return array
      */
-    protected function getAllowedFields():array
+    public function getAllowedFields():array
     {
         try {
             $allowed_fields = [];
@@ -135,7 +134,7 @@ protected function getExpandsMappings():array
     /**
      * @return array
      */
-    protected function getAllowedRelations():array
+    public function getAllowedRelations():array
     {
         try {
             $relations = [];
@@ -169,6 +168,11 @@ protected function getAllowedRelations():array
         }
     }
 
+    static public function getFirstLevelAllowedFields(array $relations):array{
+        return array_filter($relations, function($elem) {
+            return !str_contains(trim($elem), ".");
+        });
+    }
     /**
      * @return array
      */
@@ -415,7 +419,7 @@ protected function _expand(array $values, ?string $expand, array $fields = [], a
      * @param string $prefix
      * @return string
      */
-    public static function filterExpandByPrefix(?string $expand_str, string $prefix):?string
+    public static function filterExpandByPrefix(?string $expand_str, string $prefix, string $default = ''):?string
     {
         if(empty($expand_str)) return '';
         $expand_to = explode(',', $expand_str);
@@ -428,6 +432,10 @@ public static function filterExpandByPrefix(?string $expand_str, string $prefix)
             if (strlen($res) > 0) $res .= ',';
             $res .= str_replace_first($prefix . ".", "", strtolower(trim($filtered_expand_elem)));
         }
+        if(!empty($default)){
+            if(strlen($res) > 0) $res .= ',';
+            $res .= $default;
+        }
         return $res;
     }
 

Libs/ModelSerializers/IModelSerializer.php

@@ -22,5 +22,5 @@ interface IModelSerializer
      * @return array
      * @throw HTTP403ForbiddenException
      */
-    public function serialize($expand = null, array $fields = array(), array $relations = array(), array $params = array() );
+    public function serialize($expand = null, array $fields = [], array $relations = [], array $params = []);
 }

app/Http/Controllers/Apis/Protected/Main/OAuth2TeamsApiController.php

@@ -148,10 +148,10 @@ public function getMyTeam($team_id){
                     ->getSerializer($team)
                     ->serialize
                     (
-                        $expand    = Request::input('expand',''),
-                        $fields    = [],
+                        $expand = Request::input('expand', ''),
+                        $fields = [],
                         $relations = [],
-                        $params    = [
+                        $params = [
                             'current_member' => $current_member
                         ]
                     )

app/Http/Controllers/Apis/Protected/Summit/OAuth2PresentationCategoryGroupController.php

@@ -300,7 +300,7 @@ public function getTrackGroupBySummit($summit_id, $track_group_id){
             if(is_null($track_group))
                 return $this->error404();
 
-            return $this->ok(SerializerRegistry::getInstance()->getSerializer($track_group)->serialize( Request::input('expand', '')));
+            return $this->ok(SerializerRegistry::getInstance()->getSerializer($track_group)->serialize(Request::input('expand', '')));
         } catch (ValidationException $ex1) {
             Log::warning($ex1);
             return $this->error412([$ex1->getMessage()]);

app/Http/Controllers/Apis/Protected/Summit/OAuth2SummitApiController.php

@@ -448,7 +448,7 @@ public function getAllSummitByIdOrSlugRegistrationStats($id)
                         SerializerUtils::getExpand(),
                         SerializerUtils::getFields(),
                         SerializerUtils::getRelations(),
-                        [ 'filter' => $filter ]
+                        ['filter' => $filter]
                     )
             );
         });

app/Http/Controllers/Apis/Protected/Summit/OAuth2SummitNotificationsApiController.php

@@ -334,7 +334,7 @@ public function approveNotification($summit_id, $notification_id){
             if (is_null($summit)) return $this->error404();
 
             $notification = $this->push_notification_service->approveNotification($summit, $this->resource_server_context->getCurrentUser(), $notification_id);
-            return $this->updated(SerializerRegistry::getInstance()->getSerializer($notification)->serialize( Request::input('expand', '')));
+            return $this->updated(SerializerRegistry::getInstance()->getSerializer($notification)->serialize(Request::input('expand', '')));
         } catch (ValidationException $ex1) {
             Log::warning($ex1);
             return $this->error412(array($ex1->getMessage()));
@@ -358,7 +358,7 @@ public function unApproveNotification($summit_id, $notification_id){
             if (is_null($summit)) return $this->error404();
 
             $notification = $this->push_notification_service->unApproveNotification($summit, $this->resource_server_context->getCurrentUser(), $notification_id);
-            return $this->updated(SerializerRegistry::getInstance()->getSerializer($notification)->serialize( Request::input('expand', '')));
+            return $this->updated(SerializerRegistry::getInstance()->getSerializer($notification)->serialize(Request::input('expand', '')));
         } catch (ValidationException $ex1) {
             Log::warning($ex1);
             return $this->error412(array($ex1->getMessage()));

app/Http/Controllers/Apis/Protected/Summit/OAuth2SummitRSVPTemplatesApiController.php

@@ -196,7 +196,7 @@ public function getRSVPTemplate($summit_id, $template_id){
                 return $this->error404();
             }
 
-            return $this->ok(SerializerRegistry::getInstance()->getSerializer($template)->serialize($expand,[], $relations));
+            return $this->ok(SerializerRegistry::getInstance()->getSerializer($template)->serialize($expand, [], $relations));
         }
         catch (ValidationException $ex1) {
             Log::warning($ex1);

app/Http/Controllers/Apis/Protected/Summit/OAuth2SummitSpeakersApiController.php

@@ -1037,9 +1037,9 @@ public function updateSpeaker($speaker_id)
 
             return $this->updated(SerializerRegistry::getInstance()
                 ->getSerializer($speaker, SerializerRegistry::SerializerType_Private)->serialize(
-                SerializerUtils::getExpand(),
-                SerializerUtils::getFields(),
-                SerializerUtils::getRelations()
+                    SerializerUtils::getExpand(),
+                    SerializerUtils::getFields(),
+                    SerializerUtils::getRelations()
             ));
         });
     }

app/ModelSerializers/AbstractMemberSerializer.php

@@ -58,13 +58,10 @@ class AbstractMemberSerializer extends SilverStripeSerializer
      * @param array $params
      * @return array
      */
-    public function serialize($expand = null, array $fields = array(), array $relations = array(), array $params = array())
+    public function serialize($expand = null, array $fields = [], array $relations = [], array $params = [])
     {
         $member  = $this->object;
         if(!$member instanceof Member) return [];
-
-        if(!count($relations)) $relations = $this->getAllowedRelations();
-
         $values = parent::serialize($expand, $fields, $relations, $params);
 
         if(in_array('groups', $relations) && !isset($values['groups']))

app/ModelSerializers/AffiliationSerializer.php

@@ -30,7 +30,7 @@ final class AffiliationSerializer extends SilverStripeSerializer
         'OrganizationId'  => 'organization_id:json_int'
     ];
 
-    public function serialize($expand = null, array $fields = array(), array $relations = array(), array $params = array())
+    public function serialize($expand = null, array $fields = [], array $relations = [], array $params = [])
     {
         $affiliation = $this->object;
         if (!$affiliation instanceof Affiliation) return [];