fixed serialization context of article and article-page (#118)

sulu · Mar 29, 2017 · a905e5b · a905e5b
1 parent 48a8251
commit a905e5b
Show file tree

Hide file tree

Showing 8 changed files with 140 additions and 37 deletions.
diff --git a/Controller/ArticleController.php b/Controller/ArticleController.php
@@ -199,7 +199,9 @@ public function getAction($uuid, Request $request)
 
         return $this->handleView(
             $this->view($document)->setSerializationContext(
-                SerializationContext::create()->setSerializeNull(true)->setGroups(['defaultPage'])
+                SerializationContext::create()
+                    ->setSerializeNull(true)
+                    ->setGroups(['defaultPage', 'defaultArticle', 'smallArticlePage'])
             )
         );
     }
@@ -224,7 +226,9 @@ public function postAction(Request $request)
 
         return $this->handleView(
             $this->view($document)->setSerializationContext(
-                SerializationContext::create()->setSerializeNull(true)->setGroups(['defaultPage'])
+                SerializationContext::create()
+                    ->setSerializeNull(true)
+                    ->setGroups(['defaultPage', 'defaultArticle', 'smallArticlePage'])
             )
         );
     }
@@ -260,7 +264,9 @@ public function putAction(Request $request, $uuid)
 
         return $this->handleView(
             $this->view($document)->setSerializationContext(
-                SerializationContext::create()->setSerializeNull(true)->setGroups(['defaultPage'])
+                SerializationContext::create()
+                    ->setSerializeNull(true)
+                    ->setGroups(['defaultPage', 'defaultArticle', 'smallArticlePage'])
             )
         );
     }
@@ -348,7 +354,11 @@ public function postTriggerAction($uuid, Request $request)
 
             // prepare view
             $view = $this->view($data, $data !== null ? 200 : 204);
-            $view->setSerializationContext(SerializationContext::create()->setGroups(['defaultPage']));
+            $view->setSerializationContext(
+                SerializationContext::create()
+                    ->setSerializeNull(true)
+                    ->setGroups(['defaultPage', 'defaultArticle', 'smallArticlePage'])
+            );
         } catch (RestException $exc) {
             $view = $this->view($exc->toArray(), 400);
         }

diff --git a/Controller/ArticlePageController.php b/Controller/ArticlePageController.php
@@ -16,6 +16,7 @@
 use Sulu\Bundle\ArticleBundle\Admin\ArticleAdmin;
 use Sulu\Bundle\ArticleBundle\Document\ArticlePageDocument;
 use Sulu\Bundle\ArticleBundle\Document\Form\ArticlePageDocumentType;
+use Sulu\Bundle\ArticleBundle\Exception\ArticlePageNotFoundException;
 use Sulu\Bundle\ArticleBundle\Exception\ParameterNotAllowedException;
 use Sulu\Component\Content\Form\Exception\InvalidFormException;
 use Sulu\Component\Content\Mapper\ContentMapperInterface;
@@ -44,6 +45,8 @@ class ArticlePageController extends RestController implements ClassResourceInter
      * @param Request $request
      *
      * @return Response
+     *
+     * @throws ArticlePageNotFoundException
      */
     public function getAction($articleUuid, $uuid, Request $request)
     {
@@ -57,9 +60,18 @@ public function getAction($articleUuid, $uuid, Request $request)
             ]
         );
 
+        if ($articleUuid !== $document->getParent()->getUuid()) {
+            // it is required that the parent will be called to resolve the proxy.
+            // this wont be done in the serialization process.
+
+            throw new ArticlePageNotFoundException($uuid, $articleUuid);
+        }
+
         return $this->handleView(
             $this->view($document)->setSerializationContext(
-                SerializationContext::create()->setSerializeNull(true)->setGroups(['defaultPage'])
+                SerializationContext::create()
+                    ->setSerializeNull(true)
+                    ->setGroups(['defaultPage', 'defaultArticlePage', 'smallArticle'])
             )
         );
     }
@@ -80,12 +92,14 @@ public function postAction($articleUuid, Request $request)
         $data = $request->request->all();
 
         $this->persistDocument($data, $document, $locale, $articleUuid);
-        $this->handleActionParameter($action, $document, $locale);
+        $this->handleActionParameter($action, $document->getParent(), $locale);
         $this->getDocumentManager()->flush();
 
         return $this->handleView(
             $this->view($document)->setSerializationContext(
-                SerializationContext::create()->setSerializeNull(true)->setGroups(['defaultPage'])
+                SerializationContext::create()
+                    ->setSerializeNull(true)
+                    ->setGroups(['defaultPage', 'defaultArticlePage', 'smallArticle'])
             )
         );
     }
@@ -117,12 +131,14 @@ public function putAction($articleUuid, $uuid, Request $request)
         $this->get('sulu_hash.request_hash_checker')->checkHash($request, $document, $document->getUuid());
 
         $this->persistDocument($data, $document, $locale, $articleUuid);
-        $this->handleActionParameter($action, $document, $locale);
+        $this->handleActionParameter($action, $document->getParent(), $locale);
         $this->getDocumentManager()->flush();
 
         return $this->handleView(
             $this->view($document)->setSerializationContext(
-                SerializationContext::create()->setSerializeNull(true)->setGroups(['defaultPage'])
+                SerializationContext::create()
+                    ->setSerializeNull(true)
+                    ->setGroups(['defaultPage', 'defaultArticlePage', 'smallArticle'])
             )
         );
     }

diff --git a/Controller/VersionController.php b/Controller/VersionController.php
@@ -136,7 +136,11 @@ public function postTriggerAction(Request $request, $uuid, $version)
 
                 $data = $this->getDocumentManager()->find($uuid, $locale);
                 $view = $this->view($data, $data !== null ? Response::HTTP_OK : Response::HTTP_NO_CONTENT);
-                $view->setSerializationContext(SerializationContext::create()->setGroups(['defaultPage']));
+                $view->setSerializationContext(
+                    SerializationContext::create()
+                        ->setSerializeNull(true)
+                        ->setGroups(['defaultPage', 'defaultArticle', 'smallArticlePage'])
+                );
 
                 break;
             default:

diff --git a/DependencyInjection/SuluArticleExtension.php b/DependencyInjection/SuluArticleExtension.php
@@ -15,6 +15,7 @@
 use Sulu\Bundle\ArticleBundle\Document\ArticlePageDocument;
 use Sulu\Bundle\ArticleBundle\Document\Structure\ArticleBridge;
 use Sulu\Bundle\ArticleBundle\Document\Structure\ArticlePageBridge;
+use Sulu\Bundle\ArticleBundle\Exception\ArticlePageNotFoundException;
 use Sulu\Bundle\ArticleBundle\Exception\ParameterNotAllowedException;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
@@ -100,6 +101,7 @@ public function prepend(ContainerBuilder $container)
                     'exception' => [
                         'codes' => [
                             ParameterNotAllowedException::class => 400,
+                            ArticlePageNotFoundException::class => 404,
                         ],
                     ],
                 ]

diff --git a/Exception/ArticlePageNotFoundException.php b/Exception/ArticlePageNotFoundException.php
@@ -0,0 +1,59 @@
+<?php
+
+/*
+ * This file is part of Sulu.
+ *
+ * (c) MASSIVE ART WebServices GmbH
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Sulu\Bundle\ArticleBundle\Exception;
+
+/**
+ * Thrown when article-page not found in article.
+ */
+class ArticlePageNotFoundException extends \Exception
+{
+    /**
+     * @var string
+     */
+    private $pageUuid;
+
+    /**
+     * @var string
+     */
+    private $articleUuid;
+
+    /**
+     * @param string $pageUuid
+     * @param string $articleUuid
+     */
+    public function __construct($pageUuid, $articleUuid)
+    {
+        parent::__construct(sprintf('Page "%s" not found in article "%s".', $pageUuid, $articleUuid));
+        $this->pageUuid = $pageUuid;
+        $this->articleUuid = $articleUuid;
+    }
+
+    /**
+     * Returns page-uuid.
+     *
+     * @return string
+     */
+    public function getPageUuid()
+    {
+        return $this->pageUuid;
+    }
+
+    /**
+     * Returns article-uuid.
+     *
+     * @return string
+     */
+    public function getArticleUuid()
+    {
+        return $this->articleUuid;
+    }
+}
diff --git a/Resources/config/serializer/Document.ArticleDocument.xml b/Resources/config/serializer/Document.ArticleDocument.xml
@@ -6,31 +6,35 @@
                 <h:parameter name="uuid" value="expr(object.getUuid())"/>
                 <h:parameter name="locale" value="expr(object.getLocale())"/>
             </h:href>
-            <h:exclusion groups="defaultPage"/>
+            <h:exclusion groups="defaultArticle,smallArticle"/>
         </h:relation>
 
-        <property name="uuid" serialized-name="id" type="string" groups="defaultPage,smallPage,preview"/>
+        <h:relation rel="pages">
+            <h:embedded>
+                <h:content>expr(object.getChildren())</h:content>
+            </h:embedded>
+            <h:exclusion groups="defaultArticle"/>
+        </h:relation>
+
+        <property name="uuid" serialized-name="id" type="string" groups="defaultArticle,smallArticle,preview"/>
         <property name="nodeName" type="string"/>
         <property name="path" type="string"/>
-        <property name="routePath" serialized-name="route" type="string" groups="website,defaultPage,smallPage,preview"/>
+        <property name="routePath" serialized-name="route" type="string" groups="website,defaultArticle,smallArticle,preview"/>
 
         <property name="locale" type="string" groups="preview"/>
         <property name="originalLocale" type="string" groups="preview"/>
         <property name="structure" type="Sulu\Component\Content\Document\Structure\Structure" groups="preview"/>
         <property name="structureType" type="string" groups="preview"/>
 
-        <property name="title" type="string" groups="defaultPage,smallPage,preview"/>
-        <property name="creator" type="integer" groups="website,defaultPage,preview"/>
-        <property name="changer" type="integer" groups="website,defaultPage,preview"/>
-        <property name="created" type="DateTime" groups="website,defaultPage,preview"/>
-        <property name="changed" type="DateTime" groups="website,defaultPage,preview"/>
+        <property name="title" type="string" groups="defaultArticle,smallArticle,preview"/>
+        <property name="creator" type="integer" groups="website,defaultArticle,preview"/>
+        <property name="changer" type="integer" groups="website,defaultArticle,preview"/>
+        <property name="created" type="DateTime" groups="website,defaultArticle,preview"/>
+        <property name="changed" type="DateTime" groups="website,defaultArticle,preview"/>
 
-        <property name="published" type="DateTime" groups="website,defaultPage,smallPage,preview"/>
-        <property name="author" type="integer" groups="website,defaultPage,preview"/>
-        <property name="authored" type="DateTime" groups="website,defaultPage,smallPage,preview"/>
-        <property name="extensions" type="Sulu\Component\Content\Document\Extension\ExtensionContainer" serialized-name="ext" groups="defaultPage,preview"/>
-        <property name="children" serialized-name="pages" groups="defaultPage,preview">
-            <type><![CDATA[array<Sulu\Bundle\ArticleBundle\Document\ArticlePageDocument>]]></type>
-        </property>
+        <property name="published" type="DateTime" groups="website,defaultArticle,smallArticle,preview"/>
+        <property name="author" type="integer" groups="website,defaultArticle,preview"/>
+        <property name="authored" type="DateTime" groups="website,defaultArticle,smallArticle,preview"/>
+        <property name="extensions" type="Sulu\Component\Content\Document\Extension\ExtensionContainer" serialized-name="ext" groups="defaultArticle,preview"/>
     </class>
 </serializer>
diff --git a/Resources/config/serializer/Document.ArticlePageDocument.xml b/Resources/config/serializer/Document.ArticlePageDocument.xml
@@ -7,10 +7,17 @@
                 <h:parameter name="articleUuid" value="expr(object.getParent().getUuid())"/>
                 <h:parameter name="locale" value="expr(object.getLocale())"/>
             </h:href>
-            <h:exclusion groups="defaultPage"/>
+            <h:exclusion groups="defaultArticlePage,smallArticlePage"/>
         </h:relation>
 
-        <property name="uuid" serialized-name="id" type="string" groups="defaultPage,smallPage,preview"/>
+        <h:relation rel="article">
+            <h:embedded>
+                <h:content>expr(object.getParent())</h:content>
+            </h:embedded>
+            <h:exclusion groups="defaultArticlePage"/>
+        </h:relation>
+
+        <property name="uuid" serialized-name="id" type="string" groups="defaultArticlePage,smallArticlePage,preview"/>
         <property name="nodeName" type="string"/>
         <property name="path" type="string"/>
 
@@ -20,12 +27,11 @@
         <property name="structureType" type="string" groups="preview"/>
 
         <property name="title" serialized-name="articleTitle" type="string" groups="preview"/>
-        <property name="pageNumber" type="integer" groups="website,defaultPage,preview"/>
-        <property name="creator" type="integer" groups="website,defaultPage,preview"/>
-        <property name="changer" type="integer" groups="website,defaultPage,preview"/>
-        <property name="created" type="DateTime" groups="website,defaultPage,preview"/>
-        <property name="changed" type="DateTime" groups="website,defaultPage,preview"/>
-
-        <property name="published" type="DateTime" groups="website,defaultPage,smallPage,preview"/>
+        <property name="pageNumber" type="integer" groups="website,defaultArticlePage,smallArticlePage,preview"/>
+        <property name="creator" type="integer" groups="website,defaultArticlePage,smallArticlePage,preview"/>
+        <property name="changer" type="integer" groups="website,defaultArticlePage,smallArticlePage,preview"/>
+        <property name="created" type="DateTime" groups="website,defaultArticlePage,smallArticlePage,preview"/>
+        <property name="changed" type="DateTime" groups="website,defaultArticlePage,smallArticlePage,preview"/>
+        <property name="published" type="DateTime" groups="website,defaultArticlePage,smallArticlePage,preview"/>
     </class>
 </serializer>
diff --git a/Tests/Functional/Controller/ArticlePageControllerTest.php b/Tests/Functional/Controller/ArticlePageControllerTest.php
@@ -93,9 +93,11 @@ public function testPost($title = 'Test-Article', $pageTitle = 'Test-Page', $tem
         $this->assertEquals($template, $response['template']);
         $this->assertEquals(2, $response['pageNumber']);
 
+        $this->assertEquals($article['id'], $response['_embedded']['article']['id']);
+
         $article = $this->getArticle($article['id']);
-        $this->assertCount(1, $article['pages']);
-        $this->assertEquals($response['id'], reset($article['pages'])['id']);
+        $this->assertCount(1, $article['_embedded']['pages']);
+        $this->assertEquals($response['id'], reset($article['_embedded']['pages'])['id']);
 
         $articleViewDocument = $this->findViewDocument($article['id'], 'de');
         $this->assertCount(1, $articleViewDocument->getPages());
@@ -164,7 +166,7 @@ public function testDelete()
         $this->assertHttpStatusCode(204, $client->getResponse());
 
         $article = $this->getArticle($article['id']);
-        $this->assertCount(0, $article['pages']);
+        $this->assertCount(0, $article['_embedded']['pages']);
 
         $articleViewDocument = $this->findViewDocument($article['id'], 'de');
         $this->assertCount(0, $articleViewDocument->getPages());