Update ModuleController to detect module fetch failure and display error message to user

Author: adamlundrigan

module/User/view/user/helper/user-organizations.phtml

@@ -26,12 +26,18 @@
 
         <?php
         $jsTemplate = <<<'JAVASCRIPT'
-        $('#org-%s').on("show.bs.collapse", function () {
-            $('#org-content-%s').load("%s");
+        $('#org-%1$s').on("show.bs.collapse", function () {
+            $.ajax({
+                url: "%2$s",
+            }).done(function(data) {
+                $('#org-content-%1$s').html(data);
+            }).fail(function(xhr) {
+                $('#org-content-%1$s').html(xhr.responseText);
+            });
         });
 JAVASCRIPT;
 
-        $this->inlineScript()->appendScript(sprintf($jsTemplate, $org->login, $org->login, $this->url('zf-module/list', ['owner' => $org->login])));
+        $this->inlineScript()->appendScript(sprintf($jsTemplate, $org->login, $this->url('zf-module/list', ['owner' => $org->login])));
         ?>
     <?php endforeach; ?>
 </div>

module/User/view/zfc-user/user/index.phtml

@@ -48,4 +48,13 @@
         </div>
     </div>
 </div>
-<?php $this->inlineScript()->appendScript('$("#repositories").load("' . $this->escapeJs($this->url('zf-module')) . '");'); ?>
+<?php $this->inlineScript()->appendScript(<<<EOB
+    $.ajax({
+        url: "{$this->escapeJs($this->url('zf-module'))}",
+    }).done(function(data) {
+        $('#repositories').html(data);
+    }).fail(function(xhr) {
+        $('#repositories').html(xhr.responseText);
+    });
+EOB
+); 

module/ZfModule/src/ZfModule/Controller/ModuleController.php

@@ -83,17 +83,24 @@ public function indexAction()
             return $this->redirect()->toRoute('zfcuser/login');
         }
 
+        $viewModel = new ViewModel();
+        $viewModel->setTerminal(true);
+        
         $currentUserRepositories = $this->repositoryRetriever->getAuthenticatedUserRepositories([
             'type' => 'all',
             'per_page' => 100,
             'sort' => 'updated',
             'direction' => 'desc',
         ]);
+        if ($currentUserRepositories === false) {
+            $this->getResponse()->setStatusCode(503);
+            $viewModel->setVariable('errorMessage', 'module_fetch_failed');
 
-        $repositories = $this->unregisteredRepositories($currentUserRepositories);
+            return $viewModel;
+        }
 
-        $viewModel = new ViewModel(['repositories' => $repositories]);
-        $viewModel->setTerminal(true);
+        $repositories = $this->unregisteredRepositories($currentUserRepositories);
+        $viewModel->setVariable('repositories', $repositories);
 
         return $viewModel;
     }
@@ -105,18 +112,25 @@ public function listAction()
         }
 
         $owner = $this->params()->fromRoute('owner', null);
+        
+        $viewModel = new ViewModel();
+        $viewModel->setTerminal(true);
+        $viewModel->setTemplate('zf-module/module/index.phtml');
 
         $userRepositories = $this->repositoryRetriever->getUserRepositories($owner, [
             'per_page' => 100,
             'sort' => 'updated',
             'direction' => 'desc',
         ]);
+        if ($userRepositories === false) {
+            $this->getResponse()->setStatusCode(503);
+            $viewModel->setVariable('errorMessage', 'module_fetch_failed');
 
+            return $viewModel;
+        }
+        
         $repositories = $this->unregisteredRepositories($userRepositories);
-
-        $viewModel = new ViewModel(['repositories' => $repositories]);
-        $viewModel->setTerminal(true);
-        $viewModel->setTemplate('zf-module/module/index.phtml');
+        $viewModel->setVariable('repositories', $repositories);
 
         return $viewModel;
     }

module/ZfModule/test/ZfModuleTest/Integration/Controller/ModuleControllerTest.php

@@ -173,6 +173,46 @@ public function testIndexActionRendersUnregisteredModulesOnly()
         $this->assertCount(1, $viewVariable);
         $this->assertSame($unregisteredModule, $viewVariable[0]);
     }
+    
+    public function testIndexActionRendersErrorMessageWhenModuleFetchReturnsFalse()
+    {
+        $this->authenticatedAs(new User());
+
+        $repositoryRetriever = $this->getMockBuilder(RepositoryRetriever::class)
+            ->disableOriginalConstructor()
+            ->getMock()
+        ;
+
+        $repositoryRetriever
+            ->expects($this->once())
+            ->method('getAuthenticatedUserRepositories')
+            ->willReturn(false)
+        ;
+
+        $this->getApplicationServiceLocator()
+            ->setAllowOverride(true)
+            ->setService(
+                RepositoryRetriever::class,
+                $repositoryRetriever
+            )
+        ;
+
+        $this->dispatch('/module');
+
+        $this->assertMatchedRouteName('zf-module');
+
+        $this->assertControllerName(Controller\ModuleController::class);
+        $this->assertActionName('index');
+        $this->assertResponseStatusCode(Http\Response::STATUS_CODE_503);
+
+        $viewModel = $this->getApplication()->getMvcEvent()->getViewModel();
+
+        $this->assertTrue($viewModel->terminate());
+        $this->assertSame('zf-module/module/index', $viewModel->getTemplate());
+
+        $this->assertEquals(null, $viewModel->getVariable('repositories'));
+        $this->assertEquals('module_fetch_failed', $viewModel->getVariable('errorMessage'));
+    }
 
     public function testListActionRedirectsIfNotAuthenticated()
     {
@@ -439,6 +479,53 @@ public function testListActionRendersUnregisteredModulesOnly()
         $this->assertCount(1, $viewVariable);
         $this->assertSame($unregisteredModule, $viewVariable[0]);
     }
+    
+    public function testListActionRendersErrorMessageWhenModuleFetchReturnsFalse()
+    {
+        $this->authenticatedAs(new User());
+
+        $repositoryRetriever = $this->getMockBuilder(RepositoryRetriever::class)
+            ->disableOriginalConstructor()
+            ->getMock()
+        ;
+
+        $vendor = 'suzie';
+        
+        $repositoryRetriever
+            ->expects($this->once())
+            ->method('getUserRepositories')
+            ->willReturn(false)
+        ;
+
+        $this->getApplicationServiceLocator()
+            ->setAllowOverride(true)
+            ->setService(
+                RepositoryRetriever::class,
+                $repositoryRetriever
+            )
+        ;
+
+        $url = sprintf(
+            '/module/list/%s',
+            $vendor
+        );
+
+        $this->dispatch($url);
+
+        $this->assertMatchedRouteName('zf-module/list');
+
+        $this->assertControllerName(Controller\ModuleController::class);
+        $this->assertActionName('list');
+        $this->assertResponseStatusCode(Http\Response::STATUS_CODE_503);
+
+        $viewModel = $this->getApplication()->getMvcEvent()->getViewModel();
+
+        $this->assertTrue($viewModel->terminate());
+        $this->assertSame('zf-module/module/index.phtml', $viewModel->getTemplate());
+
+        $this->assertEquals(null, $viewModel->getVariable('repositories'));
+        $this->assertEquals('module_fetch_failed', $viewModel->getVariable('errorMessage'));
+    }
 
     public function testAddActionRedirectsIfNotAuthenticated()
     {

module/ZfModule/view/zf-module/module/index.phtml

@@ -1,5 +1,7 @@
 <?php /* @var stdClass[] $repositories */ ?>
-<?php if (!count($repositories)): ?>
+<?php if (isset($errorMessage)): ?>
+    <div class="alert alert-block alert-danger">An error occurred while fetching modules</div>
+<?php elseif (!count($repositories)): ?>
     <div class="alert alert-block">No modules found</div>
 <?php else: ?>
     <?php foreach ($repositories as $repository): ?>