From 92e9f79f09d4e6551abcea79c0fc4dc492f33213 Mon Sep 17 00:00:00 2001
From: Giuseppe Digilio <giuseppe.digilio@4science.it>
Date: Wed, 17 Nov 2021 09:37:49 +0100
Subject: [PATCH] [DSC-287] optimize code and add typedoc

---
 src/app/app-routing.module.ts                   | 16 ++++++----------
 src/app/core/server-check/server-check.guard.ts |  7 +++++++
 2 files changed, 13 insertions(+), 10 deletions(-)

diff --git a/src/app/app-routing.module.ts b/src/app/app-routing.module.ts
index 63fa669206..49e96a028a 100644
--- a/src/app/app-routing.module.ts
+++ b/src/app/app-routing.module.ts
@@ -11,6 +11,7 @@ import {
   FORBIDDEN_PATH,
   FORGOT_PASSWORD_PATH,
   INFO_MODULE_PATH,
+  INTERNAL_SERVER_ERROR,
   LEGACY_BITSTREAM_MODULE_PATH,
   PROFILE_MODULE_PATH,
   REGISTER_PATH,
@@ -33,7 +34,7 @@ import { ServerCheckGuard } from './core/server-check/server-check.guard';
 @NgModule({
   imports: [
     RouterModule.forRoot([
-      { path: '500', component: ThemedPageInternalServerErrorComponent },
+      { path: INTERNAL_SERVER_ERROR, component: ThemedPageInternalServerErrorComponent },
       {
         path: '', canActivate: [ServerCheckGuard, AuthBlockingGuard],
         children: [
@@ -144,14 +145,12 @@ import { ServerCheckGuard } from './core/server-check/server-check.guard';
           {
             path: 'login',
             loadChildren: () => import('./login-page/login-page.module')
-              .then((m) => m.LoginPageModule),
-            canActivate: [ServerCheckGuard]
+              .then((m) => m.LoginPageModule)
           },
           {
             path: 'logout',
             loadChildren: () => import('./logout-page/logout-page.module')
-              .then((m) => m.LogoutPageModule),
-            canActivate: [ServerCheckGuard]
+              .then((m) => m.LogoutPageModule)
           },
           {
             path: 'submit',
@@ -191,8 +190,7 @@ import { ServerCheckGuard } from './core/server-check/server-check.guard';
           },
           {
             path: INFO_MODULE_PATH,
-            loadChildren: () => import('./info/info.module').then((m) => m.InfoModule),
-            canActivate: [ServerCheckGuard]
+            loadChildren: () => import('./info/info.module').then((m) => m.InfoModule)
           },
           {
             path: REQUEST_COPY_MODULE_PATH,
@@ -206,15 +204,13 @@ import { ServerCheckGuard } from './core/server-check/server-check.guard';
           {
             path: 'statistics',
             loadChildren: () => import('./statistics-page/statistics-page-routing.module')
-              .then((m) => m.StatisticsPageRoutingModule),
-            canActivate: [ServerCheckGuard]
+              .then((m) => m.StatisticsPageRoutingModule)
           },
           {
             path: ACCESS_CONTROL_MODULE_PATH,
             loadChildren: () => import('./access-control/access-control.module').then((m) => m.AccessControlModule),
             canActivate: [GroupAdministratorGuard],
           },
-
           { path: '**', pathMatch: 'full', component: ThemedPageNotFoundComponent },
         ]
       }
diff --git a/src/app/core/server-check/server-check.guard.ts b/src/app/core/server-check/server-check.guard.ts
index 478a710567..b7982eee9a 100644
--- a/src/app/core/server-check/server-check.guard.ts
+++ b/src/app/core/server-check/server-check.guard.ts
@@ -12,10 +12,17 @@ import { getFirstCompletedRemoteData } from '../shared/operators';
 @Injectable({
   providedIn: 'root'
 })
+/**
+ * A guard that checks if root api endpoint is reachable.
+ * If not redirect to 500 error page
+ */
 export class ServerCheckGuard implements CanActivate {
   constructor(private router: Router, private rootDataService: RootDataService) {
   }
 
+  /**
+   * True when root api endpoint is reachable.
+   */
   canActivate(
     route: ActivatedRouteSnapshot,
     state: RouterStateSnapshot): Observable<boolean> {