Set project image and title on initial page load (#2863)

Some pages currently use data from the primary API response to populate
the project name and image. This means that there is a "flash" as the
project name and logo is rendered after the rest of the initial page
load occurs. This PR addresses the handful of locations where this
behavior occurs, making all pages load the header in a consistent
fashion. Despite rendering the content in the same amount of time, the
pages now feel slightly snappier, especially when waiting for large
pages to load.

Author: williamjallen

app/Http/Controllers/AbstractController.php

@@ -19,20 +19,13 @@ abstract class AbstractController extends BaseController
     /**
      * Add global data to each view
      */
-    protected function view(string $view, string $title = ''): View
+    protected function view(string $view, string $title): View
     {
         session()->put('url.intended', url()->full());
-
-        $result = view($view);
-
-        if ($title !== '') {
-            $result = $result->with('title', $title);
-        }
-
-        return $result;
+        return view($view)->with('title', $title);
     }
 
-    protected function angular_view(string $view): View
+    protected function angular_view(string $view, string $title = ''): View
     {
         // A hack to ensure that redirects work properly after being redirected to the login page
         session(['url.intended' => url()->full()]);
@@ -51,7 +44,7 @@ protected function angular_view(string $view): View
             $controller_name = Str::studly($file) . 'Controller';
         }
 
-        return $this->view('cdash')
+        return $this->view('cdash', $title)
             ->with('xsl_content', file_get_contents(base_path("public/assets/js/angular/views/$view.html")))
             ->with('xsl', true)
             ->with('angular', true)

app/Http/Controllers/AbstractProjectController.php

@@ -24,6 +24,12 @@ protected function view(string $view, string $title = ''): View
             return parent::view($view, $title);
         }
 
+        if ($title === '') {
+            $title = $this->project->Name;
+        } else {
+            $title = $this->project->Name . ' - ' . $title;
+        }
+
         return parent::view($view, $title)
             ->with('project', $this->project);
     }

app/Http/Controllers/AdminController.php

@@ -100,7 +100,7 @@ public function removeBuilds(): View|RedirectResponse
             $alert = 'Removed ' . count($builds) . ' builds.';
         }
 
-        return $this->view('admin.remove-builds')
+        return $this->view('admin.remove-builds', 'Remove Builds')
             ->with('alert', $alert)
             ->with('selected_projectid', $projectid)
             ->with('available_projects', $available_projects)

app/Http/Controllers/AuthTokenController.php

@@ -17,7 +17,7 @@ final class AuthTokenController extends AbstractController
 {
     public function manage(): View
     {
-        return $this->view('admin.manage-authtokens');
+        return $this->view('admin.manage-authtokens', 'Authentication Tokens');
     }
 
     /**

app/Http/Controllers/BuildController.php

@@ -550,8 +550,7 @@ public function buildOverview(): View|RedirectResponse
             ];
         }
 
-        return $this->view('build.overview')
-            ->with('project', $this->project)
+        return $this->view('build.overview', 'Build Overview')
             ->with('selected_group', $selected_group)
             ->with('sourcefiles', $sourcefiles)
             ->with('startdate', date('l, F d Y H:i:s', $currentstarttime));
@@ -804,7 +803,7 @@ public function files(int $build_id): View
             }
         }
 
-        return $this->view('build.files')
+        return $this->view('build.files', 'Files')
             ->with('build', $this->build)
             ->with('files', $files)
             ->with('urls', $urls);
@@ -856,7 +855,7 @@ public function ajaxBuildNote(): View
             $note->user = $user;
         }
 
-        return $this->view('build.note')
+        return $this->view('build.note', 'Notes')
             ->with('notes', $notes);
     }
 
@@ -1013,16 +1012,19 @@ public function apiViewBuildError(): JsonResponse
 
     public function manageBuildGroup(): View
     {
-        return $this->angular_view('manageBuildGroup');
+        $this->setProjectById(request()->integer('projectid'));
+        return $this->angular_view('manageBuildGroup', 'Manage Build Groups');
     }
 
     public function viewBuildError(): View
     {
-        return $this->angular_view('viewBuildError');
+        $this->setBuildById(request()->integer('buildid'));
+        return $this->angular_view('viewBuildError', 'Build Errors');
     }
 
     public function viewBuildGroup(): View
     {
+        $this->setProjectByName(request()->input('project'));
         return $this->angular_view('index');
     }
 
@@ -1231,7 +1233,7 @@ public function apiBuildExpected(): JsonResponse
 
     public function apiRelateBuilds(): JsonResponse
     {
-        $this->setProjectByName(request()->input('project') ?? '');
+        $this->setProjectByName(request()->string('project') ?? '');
 
         if (!request()->has('buildid')) {
             abort(400, '"buildid" parameter required.');

app/Http/Controllers/BuildPropertiesController.php

@@ -17,7 +17,7 @@ final class BuildPropertiesController extends AbstractBuildController
 {
     public function buildProperties(): View
     {
-        return $this->view('build.properties');
+        return $this->view('build.properties', 'Build Properties');
     }
 
     public function apiBuildProperties(): JsonResponse

app/Http/Controllers/CTestConfigurationController.php

@@ -10,7 +10,7 @@ public function get(int $id): Response
     {
         $this->setProjectById($id);
 
-        $view = $this->view('project.ctest-configuration')
+        $view = $this->view('project.ctest-configuration', '')
             ->with('subprojects', $this->project->GetSubProjects());
         return response($view, 200, ['Content-Type' => 'text/plain']);
     }

app/Http/Controllers/CoverageController.php

@@ -29,7 +29,7 @@ public function compareCoverage(): View|RedirectResponse
             return redirect('projects');
         }
 
-        return $this->angular_view('compareCoverage');
+        return $this->angular_view('compareCoverage', 'Compare Coverage');
     }
 
     private static function get_cdash_dashboard_xml_by_name(string $projectname, $date): string
@@ -539,7 +539,7 @@ public function viewCoverageFile(): View
 
         $file = implode('<br>', $file_array);
 
-        return $this->view('coverage.coverage-file')
+        return $this->view('coverage.coverage-file', 'Coverage')
             ->with('coverage_file', $coverageFile)
             ->with('log', $file);
     }

app/Http/Controllers/DynamicAnalysisController.php

@@ -14,12 +14,12 @@ final class DynamicAnalysisController extends AbstractBuildController
     public function viewDynamicAnalysis(int $buildid): View
     {
         $this->setBuildById($buildid);
-        return $this->view('dynamicanalysis.dynamic-analysis');
+        return $this->view('dynamicanalysis.dynamic-analysis', 'Dynamic Analysis');
     }
 
     public function viewDynamicAnalysisFile(): View
     {
-        return $this->angular_view('viewDynamicAnalysisFile');
+        return $this->angular_view('viewDynamicAnalysisFile', 'Dynamic Analysis');
     }
 
     public function apiViewDynamicAnalysis(): JsonResponse

app/Http/Controllers/IndexController.php

@@ -5,7 +5,7 @@
 use Illuminate\Http\RedirectResponse;
 use Illuminate\View\View;
 
-final class IndexController extends AbstractController
+final class IndexController extends AbstractProjectController
 {
     public function showIndexPage(): View|RedirectResponse
     {
@@ -15,6 +15,8 @@ public function showIndexPage(): View|RedirectResponse
             return redirect($url);
         }
 
+        $this->setProjectByName($_GET['project']);
+
         return $this->angular_view('index');
     }
 }