Merge remote-tracking branch 'remotes/dev/master'

orocrmdeployer · orocrmdeployer · commit d93ef23734d6 · 2018-09-29T22:56:16.000+03:00
diff --git a/src/Oro/Bundle/ApiBundle/Processor/CollectResources/AddExcludedActions.php b/src/Oro/Bundle/ApiBundle/Processor/CollectResources/AddExcludedActions.php
@@ -17,7 +17,7 @@
 class AddExcludedActions implements ProcessorInterface
 {
     /** the name of the context item to store the configuration of "actions" section */
-    const ACTIONS_CONFIG_KEY = 'actions_config';
+    public const ACTIONS_CONFIG_KEY = 'actions_config';
 
     /** @var ConfigLoaderFactory */
     protected $configLoaderFactory;
diff --git a/src/Oro/Bundle/ApiBundle/Provider/ResourcesCache.php b/src/Oro/Bundle/ApiBundle/Provider/ResourcesCache.php
@@ -149,33 +149,26 @@ public function getResourcesWithoutIdentifier(string $version, RequestType $requ
      * @param string        $version             The Data API version
      * @param RequestType   $requestType         The request type, for example "rest", "soap", etc.
      * @param ApiResource[] $resources           The list of Data API resources
-     * @param string[]      $accessibleResources The list of resources accessible through Data API
+     * @param array         $accessibleResources The resources accessible through Data API
+     * @param array         $excludedActions     The actions excluded from Data API
      */
     public function saveResources(
         string $version,
         RequestType $requestType,
         array $resources,
-        array $accessibleResources
+        array $accessibleResources,
+        array $excludedActions
     ): void {
         $allResources = [];
-        $excludedActionsData = [];
-        $accessibleResourcesData = array_fill_keys($accessibleResources, true);
         foreach ($resources as $resource) {
             $entityClass = $resource->getEntityClass();
             $allResources[$entityClass] = $this->serializeApiResource($resource);
-            if (!isset($accessibleResourcesData[$entityClass])) {
-                $accessibleResourcesData[$entityClass] = false;
-            }
-            $excludedActions = $resource->getExcludedActions();
-            if (!empty($excludedActions)) {
-                $excludedActionsData[$entityClass] = $excludedActions;
-            }
         }
 
         $keyIndex = $this->getCacheKeyIndex($version, $requestType);
         $this->cache->save(self::RESOURCES_KEY_PREFIX . $keyIndex, $allResources);
-        $this->cache->save(self::ACCESSIBLE_RESOURCES_KEY_PREFIX . $keyIndex, $accessibleResourcesData);
-        $this->cache->save(self::EXCLUDED_ACTIONS_KEY_PREFIX . $keyIndex, $excludedActionsData);
+        $this->cache->save(self::ACCESSIBLE_RESOURCES_KEY_PREFIX . $keyIndex, $accessibleResources);
+        $this->cache->save(self::EXCLUDED_ACTIONS_KEY_PREFIX . $keyIndex, $excludedActions);
     }
 
     /**
diff --git a/src/Oro/Bundle/ApiBundle/Provider/ResourcesProvider.php b/src/Oro/Bundle/ApiBundle/Provider/ResourcesProvider.php
@@ -21,6 +21,9 @@ class ResourcesProvider
     /** @var ResourcesWithoutIdentifierLoader */
     private $resourcesWithoutIdentifierLoader;
 
+    /** @var array [request cache key => [ApiResource, ...], ...] */
+    private $resources = [];
+
     /** @var array [request cache key => [entity class => accessible flag, ...], ...] */
     private $accessibleResources = [];
 
@@ -55,26 +58,53 @@ public function __construct(
      */
     public function getResources($version, RequestType $requestType): array
     {
-        $resources = $this->resourcesCache->getResources($version, $requestType);
-        if (null !== $resources) {
-            return $resources;
+        $cacheIndex = $this->getCacheKeyIndex($version, $requestType);
+        if (array_key_exists($cacheIndex, $this->resources)) {
+            $resources = $this->resources[$cacheIndex];
+        } else {
+            $resources = $this->resourcesCache->getResources($version, $requestType);
+            if (null === $resources) {
+                // load data
+                /** @var CollectResourcesContext $context */
+                $context = $this->processor->createContext();
+                $context->setVersion($version);
+                $context->getRequestType()->set($requestType);
+                $this->processor->process($context);
+
+                // prepare loaded data
+                /** @var ApiResource[] $resources */
+                $resources = array_values($context->getResult()->toArray());
+                $accessibleResources = array_fill_keys($context->getAccessibleResources(), true);
+                $excludedActions = [];
+                foreach ($resources as $resource) {
+                    $entityClass = $resource->getEntityClass();
+                    if (!isset($accessibleResources[$entityClass])) {
+                        $accessibleResources[$entityClass] = false;
+                    }
+                    $resourceExcludedActions = $resource->getExcludedActions();
+                    if (!empty($resourceExcludedActions)) {
+                        $excludedActions[$entityClass] = $resourceExcludedActions;
+                    }
+                }
+
+                // add data to memory cache
+                $this->resources[$cacheIndex] = $resources;
+                $this->accessibleResources[$cacheIndex] = $accessibleResources;
+                $this->excludedActions[$cacheIndex] = $excludedActions;
+
+                // save data to the cache
+                $this->resourcesCache->saveResources(
+                    $version,
+                    $requestType,
+                    $resources,
+                    $accessibleResources,
+                    $excludedActions
+                );
+            } else {
+                $this->resources[$cacheIndex] = $resources;
+            }
         }
 
-        /** @var CollectResourcesContext $context */
-        $context = $this->processor->createContext();
-        $context->setVersion($version);
-        $context->getRequestType()->set($requestType);
-
-        $this->processor->process($context);
-
-        $resources = array_values($context->getResult()->toArray());
-        $this->resourcesCache->saveResources(
-            $version,
-            $requestType,
-            $resources,
-            $context->getAccessibleResources()
-        );
-
         return $resources;
     }
 
@@ -191,6 +221,7 @@ public function isResourceWithoutIdentifier($entityClass, $version, RequestType
      */
     public function clearCache(): void
     {
+        $this->resources = [];
         $this->accessibleResources = [];
         $this->excludedActions = [];
         $this->resourcesWithoutIdentifier = [];
diff --git a/src/Oro/Bundle/ApiBundle/Tests/Unit/Provider/ResourcesCacheTest.php b/src/Oro/Bundle/ApiBundle/Tests/Unit/Provider/ResourcesCacheTest.php
@@ -146,6 +146,16 @@ public function testSave()
         $resource3 = new ApiResource('Test\Entity3');
         $resource3->setExcludedActions(['create']);
 
+        $accessibleResources = [
+            'Test\Entity1' => true,
+            'Test\Entity2' => false,
+            'Test\Entity3' => true
+        ];
+        $excludedActions = [
+            'Test\Entity2' => ['get', 'get_list'],
+            'Test\Entity3' => ['create']
+        ];
+
         $this->cache->expects(self::at(0))
             ->method('save')
             ->with(
@@ -160,27 +170,21 @@ public function testSave()
             ->method('save')
             ->with(
                 'accessible_1.2rest',
-                [
-                    'Test\Entity1' => true,
-                    'Test\Entity2' => false,
-                    'Test\Entity3' => true
-                ]
+                $accessibleResources
             );
         $this->cache->expects(self::at(2))
             ->method('save')
             ->with(
                 'excluded_actions_1.2rest',
-                [
-                    'Test\Entity2' => ['get', 'get_list'],
-                    'Test\Entity3' => ['create']
-                ]
+                $excludedActions
             );
 
         $this->resourcesCache->saveResources(
             '1.2',
             new RequestType(['rest']),
             [$resource1, $resource2, $resource3],
-            ['Test\Entity1', 'Test\Entity3']
+            $accessibleResources,
+            $excludedActions
         );
     }
 
diff --git a/src/Oro/Bundle/ApiBundle/Tests/Unit/Provider/ResourcesProviderTest.php b/src/Oro/Bundle/ApiBundle/Tests/Unit/Provider/ResourcesProviderTest.php
@@ -46,7 +46,11 @@ public function testGetResourcesNoCache()
             new ApiResource('Test\Entity1'),
             new ApiResource('Test\Entity3')
         ];
-        $expectedAccessibleResources = ['Test\Entity3'];
+        $expectedAccessibleResources = [
+            'Test\Entity1' => false,
+            'Test\Entity3' => true
+        ];
+        $expectedExcludedActions = [];
 
         $this->processor->expects(self::once())
             ->method('process')
@@ -67,7 +71,13 @@ function (CollectResourcesContext $context) use ($version, $requestType) {
             ->willReturn(null);
         $this->resourcesCache->expects(self::once())
             ->method('saveResources')
-            ->with($version, self::identicalTo($requestType), $expectedResources, $expectedAccessibleResources);
+            ->with(
+                $version,
+                self::identicalTo($requestType),
+                $expectedResources,
+                $expectedAccessibleResources,
+                $expectedExcludedActions
+            );
 
         self::assertEquals(
             $expectedResources,
@@ -142,7 +152,11 @@ public function testGetAccessibleResourcesWhenCacheDoesNotExist()
             new ApiResource('Test\Entity1'),
             new ApiResource('Test\Entity3')
         ];
-        $expectedAccessibleResources = ['Test\Entity3'];
+        $expectedAccessibleResources = [
+            'Test\Entity1' => false,
+            'Test\Entity3' => true
+        ];
+        $expectedExcludedActions = [];
 
         $this->processor->expects(self::once())
             ->method('process')
@@ -167,15 +181,17 @@ function (CollectResourcesContext $context) use ($version, $requestType) {
             ->willReturn(null);
         $this->resourcesCache->expects(self::at(2))
             ->method('saveResources')
-            ->with($version, self::identicalTo($requestType), $expectedResources, $expectedAccessibleResources);
+            ->with(
+                $version,
+                self::identicalTo($requestType),
+                $expectedResources,
+                $expectedAccessibleResources,
+                $expectedExcludedActions
+            );
         $this->resourcesCache->expects(self::at(3))
             ->method('getAccessibleResources')
             ->with($version, self::identicalTo($requestType))
             ->willReturn($cachedData);
-        $this->resourcesCache->expects(self::once())
-            ->method('getResourcesWithoutIdentifier')
-            ->with($version, self::identicalTo($requestType))
-            ->willReturn([]);
 
         self::assertEquals(
             ['Test\Entity3'],
@@ -250,7 +266,11 @@ public function testIsResourceAccessibleWhenCacheDoesNotExist()
             new ApiResource('Test\Entity1'),
             new ApiResource('Test\Entity3')
         ];
-        $expectedAccessibleResources = ['Test\Entity3'];
+        $expectedAccessibleResources = [
+            'Test\Entity1' => false,
+            'Test\Entity3' => true
+        ];
+        $expectedExcludedActions = [];
 
         $this->processor->expects(self::once())
             ->method('process')
@@ -275,15 +295,17 @@ function (CollectResourcesContext $context) use ($version, $requestType) {
             ->willReturn(null);
         $this->resourcesCache->expects(self::at(2))
             ->method('saveResources')
-            ->with($version, self::identicalTo($requestType), $expectedResources, $expectedAccessibleResources);
+            ->with(
+                $version,
+                self::identicalTo($requestType),
+                $expectedResources,
+                $expectedAccessibleResources,
+                $expectedExcludedActions
+            );
         $this->resourcesCache->expects(self::at(3))
             ->method('getAccessibleResources')
             ->with($version, self::identicalTo($requestType))
             ->willReturn($cachedData);
-        $this->resourcesCache->expects(self::once())
-            ->method('getResourcesWithoutIdentifier')
-            ->with($version, self::identicalTo($requestType))
-            ->willReturn([]);
 
         self::assertFalse(
             $this->resourcesProvider->isResourceAccessible('Test\Entity1', $version, $requestType)
@@ -358,7 +380,11 @@ public function testIsResourceKnownWhenCacheDoesNotExist()
             new ApiResource('Test\Entity1'),
             new ApiResource('Test\Entity3')
         ];
-        $expectedAccessibleResources = ['Test\Entity3'];
+        $expectedAccessibleResources = [
+            'Test\Entity1' => false,
+            'Test\Entity3' => true
+        ];
+        $expectedExcludedActions = [];
 
         $this->processor->expects(self::once())
             ->method('process')
@@ -383,7 +409,13 @@ function (CollectResourcesContext $context) use ($version, $requestType) {
             ->willReturn(null);
         $this->resourcesCache->expects(self::at(2))
             ->method('saveResources')
-            ->with($version, self::identicalTo($requestType), $expectedResources, $expectedAccessibleResources);
+            ->with(
+                $version,
+                self::identicalTo($requestType),
+                $expectedResources,
+                $expectedAccessibleResources,
+                $expectedExcludedActions
+            );
         $this->resourcesCache->expects(self::at(3))
             ->method('getAccessibleResources')
             ->with($version, self::identicalTo($requestType))
@@ -446,7 +478,13 @@ public function testGetResourceExcludeActionsWhenCacheDoesNotExist()
         $resource3 = new ApiResource('Test\Entity3');
         $resource3->addExcludedAction('delete');
         $expectedResources = [$resource1, $resource3];
-        $expectedAccessibleResources = ['Test\Entity3'];
+        $expectedAccessibleResources = [
+            'Test\Entity1' => false,
+            'Test\Entity3' => true
+        ];
+        $expectedExcludedActions = [
+            'Test\Entity3' => ['delete']
+        ];
 
         $this->processor->expects(self::once())
             ->method('process')
@@ -474,7 +512,13 @@ function (CollectResourcesContext $context) use ($version, $requestType) {
             ->willReturn(null);
         $this->resourcesCache->expects(self::at(2))
             ->method('saveResources')
-            ->with($version, self::identicalTo($requestType), $expectedResources, $expectedAccessibleResources);
+            ->with(
+                $version,
+                self::identicalTo($requestType),
+                $expectedResources,
+                $expectedAccessibleResources,
+                $expectedExcludedActions
+            );
         $this->resourcesCache->expects(self::at(3))
             ->method('getExcludedActions')
             ->with($version, self::identicalTo($requestType))
@@ -621,6 +665,10 @@ public function testClearCache()
         $version = '1.2.3';
         $requestType = new RequestType([RequestType::REST, RequestType::JSON_API]);
 
+        $this->resourcesCache->expects(self::exactly(2))
+            ->method('getResources')
+            ->with($version, self::identicalTo($requestType))
+            ->willReturn([new ApiResource('Test\Entity1')]);
         $this->resourcesCache->expects(self::exactly(2))
             ->method('getAccessibleResources')
             ->with($version, self::identicalTo($requestType))
@@ -637,6 +685,10 @@ public function testClearCache()
             ->method('clear');
 
         // warmup the local cache
+        self::assertEquals(
+            [new ApiResource('Test\Entity1')],
+            $this->resourcesProvider->getResources($version, $requestType)
+        );
         self::assertTrue(
             $this->resourcesProvider->isResourceAccessible('Test\Entity1', $version, $requestType)
         );
@@ -652,6 +704,10 @@ public function testClearCache()
         $this->resourcesProvider->clearCache();
 
         // check that clearCache method clears the local cache
+        self::assertEquals(
+            [new ApiResource('Test\Entity1')],
+            $this->resourcesProvider->getResources($version, $requestType)
+        );
         self::assertTrue(
             $this->resourcesProvider->isResourceAccessible('Test\Entity1', $version, $requestType)
         );

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@`
`17`	`17`	`class AddExcludedActions implements ProcessorInterface`
`18`	`18`	`{`
`19`	`19`	`/** the name of the context item to store the configuration of "actions" section */`
`20`		`- const ACTIONS_CONFIG_KEY = 'actions_config';`
	`20`	`+ public const ACTIONS_CONFIG_KEY = 'actions_config';`
`21`	`21`
`22`	`22`	`/** @var ConfigLoaderFactory */`
`23`	`23`	`protected $configLoaderFactory;`