Remove deprecated /api/v1/viewBuildError.php endpoint (#3619)

Author: williamjallen

app/Http/Controllers/BuildController.php

@@ -7,7 +7,6 @@
 use App\Models\BuildUpdateFile;
 use App\Models\Comment;
 use App\Models\Project;
-use App\Models\RichBuildAlert;
 use App\Models\UploadFile;
 use App\Models\User;
 use App\Utils\DatabaseCleanupUtils;
@@ -16,10 +15,8 @@
 use App\Utils\TestingDay;
 use CDash\Database;
 use CDash\Model\Build;
-use CDash\Model\BuildFailure;
 use CDash\Model\BuildGroupRule;
 use CDash\Model\BuildRelationship;
-use CDash\ServiceContainer;
 use Illuminate\Http\JsonResponse;
 use Illuminate\Http\RedirectResponse;
 use Illuminate\Http\Request;
@@ -867,264 +864,6 @@ public function build_file(int $build_id, int $file_id): StreamedResponse
         }, $filename, $headers, 'inline');
     }
 
-    public function apiViewBuildError(): JsonResponse
-    {
-        $pageTimer = new PageTimer();
-
-        if (!isset($_GET['buildid']) || !is_numeric($_GET['buildid'])) {
-            abort(400, 'Invalid buildid!');
-        }
-        $this->setBuildById((int) $_GET['buildid']);
-
-        $eloquentBuild = EloquentBuild::findOrFail((int) $this->build->Id);
-
-        $service = ServiceContainer::getInstance();
-
-        $response = begin_JSON_response();
-        $response['title'] = $this->project->Name;
-
-        $type = (int) ($_GET['type'] ?? 0);
-
-        $date = TestingDay::get($this->project, $this->build->StartTime);
-        get_dashboard_JSON($this->project->Name, $date, $response);
-
-        $menu = [];
-        if ($this->build->GetParentId() > 0) {
-            $menu['back'] = 'index.php?project=' . urlencode($this->project->Name) . "&parentid={$this->build->GetParentId()}";
-        } else {
-            $menu['back'] = 'index.php?project=' . urlencode($this->project->Name) . '&date=' . $date;
-        }
-
-        $previous_buildid = $this->build->GetPreviousBuildId();
-        $current_buildid = $this->build->GetCurrentBuildId();
-        $next_buildid = $this->build->GetNextBuildId();
-
-        $menu['previous'] = $previous_buildid > 0 ? "viewBuildError.php?type=$type&buildid=$previous_buildid" : false;
-        $menu['current'] = "viewBuildError.php?type=$type&buildid=$current_buildid";
-        $menu['next'] = $next_buildid > 0 ? "viewBuildError.php?type=$type&buildid=$next_buildid" : false;
-
-        $response['menu'] = $menu;
-
-        // Site
-        $extra_build_fields = [
-            'site' => $this->build->GetSite()->name,
-        ];
-
-        // Update
-        if ($eloquentBuild->updateStep !== null) {
-            $revision = $eloquentBuild->updateStep->revision;
-            $extra_build_fields['revision'] = $revision;
-        } else {
-            $revision = null;
-        }
-
-        // Build
-        $response['build'] = Build::MarshalResponseArray($this->build, $extra_build_fields);
-
-        $buildfailure = $service->get(BuildFailure::class);
-
-        // Set the error
-        if ($type === 0) {
-            $response['errortypename'] = 'Error';
-            $response['nonerrortypename'] = 'Warning';
-            $response['nonerrortype'] = 1;
-        } else {
-            $response['errortypename'] = 'Warning';
-            $response['nonerrortypename'] = 'Error';
-            $response['nonerrortype'] = 0;
-        }
-
-        $response['parentBuild'] = $this->build->IsParentBuild();
-        $response['errors'] = [];
-        $response['numErrors'] = 0;
-
-        if (isset($_GET['onlydeltan'])) {
-            // Build error table
-            $resolvedBuildErrors = $this->build->GetResolvedBuildErrors($type);
-            if ($resolvedBuildErrors !== false) {
-                while ($resolvedBuildError = $resolvedBuildErrors->fetch()) {
-                    $this->addErrorResponse(self::marshalBuildError($resolvedBuildError, $this->project, $revision), $response);
-                }
-            }
-
-            // Build failure table
-            $resolvedBuildFailures = $this->build->GetResolvedBuildFailures($type);
-            foreach ($resolvedBuildFailures as $resolvedBuildFailure) {
-                $marshaledResolvedBuildFailure = self::marshalBuildFailure($resolvedBuildFailure, $this->project, $revision, false, $buildfailure);
-
-                if ($this->project->DisplayLabels) {
-                    get_labels_JSON_from_query_results('
-                        SELECT text
-                        FROM label, label2buildfailure
-                        WHERE
-                            label.id=label2buildfailure.labelid
-                            AND label2buildfailure.buildfailureid=?
-                        ORDER BY text ASC
-                    ', [(int) $resolvedBuildFailure['id']], $marshaledResolvedBuildFailure);
-                }
-
-                $marshaledResolvedBuildFailure = array_merge($marshaledResolvedBuildFailure, [
-                    'stderr' => $resolvedBuildFailure['stderror'],
-                    'stderrorrows' => min(10, substr_count($resolvedBuildFailure['stderror'], "\n") + 1),
-                    'stdoutput' => $resolvedBuildFailure['stdoutput'],
-                    'stdoutputrows' => min(10, substr_count($resolvedBuildFailure['stdoutput'], "\n") + 1),
-                ]);
-
-                $this->addErrorResponse($marshaledResolvedBuildFailure, $response);
-            }
-        } else {
-            $filter_error_properties = ['type' => $type];
-
-            if (isset($_GET['onlydeltap'])) {
-                $filter_error_properties['newstatus'] = Build::STATUS_NEW;
-            }
-
-            // Build error table
-            $buildErrors = $this->build->GetErrors($filter_error_properties);
-
-            foreach ($buildErrors as $error) {
-                $this->addErrorResponse(self::marshalBuildError($error, $this->project, $revision), $response);
-            }
-
-            // Build failure table
-            $buildFailures = $this->build->GetFailures(['type' => $type]);
-
-            foreach ($buildFailures as $fail) {
-                $failure = self::marshalBuildFailure($fail, $this->project, $revision, true, $buildfailure);
-
-                if ($this->project->DisplayLabels) {
-                    $labels = RichBuildAlert::findOrFail((int) $fail['id'])->labels()->pluck('text');
-                    if ($labels->count() > 0) {
-                        $failure['labels'] = $labels->toArray();
-                    }
-                }
-                $this->addErrorResponse($failure, $response);
-            }
-        }
-
-        if ($this->build->IsParentBuild()) {
-            $response['numSubprojects'] = count(array_unique(array_map(fn ($buildError) => $buildError['subprojectid'], $response['errors'])));
-        }
-
-        $pageTimer->end($response);
-        return response()->json(cast_data_for_JSON($response));
-    }
-
-    /**
-     * @return array{
-     *     'file': string,
-     *     'directory': string,
-     * }
-     */
-    private static function GetSourceFileFromBuildError(array $data): array
-    {
-        $sourceFile = [];
-
-        // Detect if the source directory has already been replaced by CTest
-        // with /.../.  If so, sourcefile is already a relative path from the
-        // root of the source tree.
-        if (str_contains($data['stdoutput'], '/.../')) {
-            $parts = explode('/', $data['sourcefile']);
-            $sourceFile['file'] = array_pop($parts);
-            $sourceFile['directory'] = implode('/', $parts);
-        } else {
-            $sourceFile['file'] = basename($data['sourcefile']);
-            $sourceFile['directory'] = dirname($data['sourcefile']);
-        }
-
-        return $sourceFile;
-    }
-
-    // Ideally $data would be loaded into $this
-    // need an id field?
-    /**
-     * Marshals the data of a particular build error into a serializable
-     * friendly format.
-     *
-     * Requires the $data of a build error, the $project, and the buildupdate.revision.
-     *
-     * @return array<string,mixed>
-     **/
-    public static function marshalBuildError(array $data, \CDash\Model\Project $project, $revision): array
-    {
-        deepEncodeHTMLEntities($data);
-
-        $sourceFile = self::GetSourceFileFromBuildError($data);
-
-        // When building without launchers, CTest truncates the source dir to
-        // /.../<project-name>/.  Use this pattern to linkify compiler output.
-        $source_dir = "/\.\.\./[^/]+";
-
-        $marshaled = [
-            'new' => (int) ($data['newstatus'] ?? -1),
-            'logline' => (int) $data['logline'],
-            'cvsurl' => RepositoryUtils::get_diff_url($project->Id, $project->CvsUrl ?? '', $sourceFile['directory'], $sourceFile['file'], $revision),
-            'precontext' => '',
-            'text' => RepositoryUtils::linkify_compiler_output($project->CvsUrl ?? '', $source_dir, $revision, $data['stdoutput']),
-            'postcontext' => '',
-            'sourcefile' => $data['sourcefile'],
-            'sourceline' => $data['sourceline'],
-        ];
-
-        if (isset($data['subprojectid'])) {
-            $marshaled['subprojectid'] = $data['subprojectid'];
-            $marshaled['subprojectname'] = $data['subprojectname'];
-        }
-
-        return $marshaled;
-    }
-
-    /**
-     * Marshal a build failure, this includes the build failure arguments.
-     **/
-    public static function marshalBuildFailure($data, \CDash\Model\Project $project, $revision, $linkifyOutput, $buildfailure): array
-    {
-        deepEncodeHTMLEntities($data);
-
-        $marshaled = array_merge([
-            'language' => $data['language'],
-            'sourcefile' => $data['sourcefile'],
-            'targetname' => $data['targetname'],
-            'outputfile' => $data['outputfile'],
-            'outputtype' => $data['outputtype'],
-            'workingdirectory' => $data['workingdirectory'],
-            'exitcondition' => $data['exitcondition'],
-        ], $buildfailure->GetBuildFailureArguments((int) $data['id']));
-
-        $marshaled['stderror'] = $data['stderror'];
-        $marshaled['stdoutput'] = $data['stdoutput'];
-
-        if (isset($data['sourcefile'])) {
-            $file = basename($data['sourcefile']);
-            $directory = dirname($data['sourcefile']);
-
-            $source_dir = RepositoryUtils::get_source_dir($project->Id, $project->CvsUrl ?? '', $directory);
-            if (str_starts_with($directory, $source_dir)) {
-                $directory = substr($directory, strlen($source_dir));
-            }
-
-            $marshaled['cvsurl'] = RepositoryUtils::get_diff_url($project->Id,
-                $project->CvsUrl ?? '',
-                $directory,
-                $file,
-                $revision);
-
-            if ($source_dir !== null && $linkifyOutput) {
-                $marshaled['stderror'] = RepositoryUtils::linkify_compiler_output($project->CvsUrl ?? '', $source_dir,
-                    $revision, $data['stderror']);
-                $marshaled['stdoutput'] = RepositoryUtils::linkify_compiler_output($project->CvsUrl ?? '', $source_dir,
-                    $revision, $data['stdoutput']);
-            }
-        }
-
-        if (isset($data['subprojectid'])) {
-            $marshaled['subprojectid'] = $data['subprojectid'];
-            $marshaled['subprojectname'] = $data['subprojectname'];
-        }
-
-        return $marshaled;
-    }
-
     public function manageBuildGroup(): View
     {
         $this->setProjectById(request()->integer('projectid'));
@@ -1137,24 +876,6 @@ public function viewBuildGroup(): View
         return $this->angular_view('index');
     }
 
-    /**
-     * Add a new (marshaled) error to the response.
-     * Keeps track of the id necessary for frontend JS, and updates
-     * the numErrors response key.
-     *
-     * @todo id should probably just be a unique id for the builderror?
-     * builderror table currently has no integer that serves as a unique identifier.
-     *
-     * @param array<string,mixed> $response
-     **/
-    private function addErrorResponse(mixed $data, array &$response): void
-    {
-        $data['id'] = $response['numErrors'];
-        $response['numErrors']++;
-
-        $response['errors'][] = $data;
-    }
-
     public function apiBuildUpdateGraph(): JsonResponse
     {
         $this->setBuildById((int) ($_GET['buildid'] ?? -1));

app/Utils/RepositoryUtils.php

@@ -14,44 +14,6 @@
 
 class RepositoryUtils
 {
-    /** Return the source directory for a source file */
-    public static function get_source_dir($projectid, $projecturl, $file_path)
-    {
-        if (!is_numeric($projectid)) {
-            return;
-        }
-
-        $service = ServiceContainer::getInstance();
-        $project = $service->get(Project::class);
-        $project->Id = $projectid;
-        $project->Fill();
-        if (null === $project->CvsViewerType) {
-            return;
-        }
-        $cvsviewertype = strtolower($project->CvsViewerType);
-
-        $target_fn = $cvsviewertype . '_get_source_dir';
-
-        if (method_exists(self::class, $target_fn)) {
-            return self::$target_fn($projecturl, $file_path);
-        }
-    }
-
-    /** Extract the source directory from a Github URL and a full path to
-     * a source file.  This only works properly if the source dir's name matches
-     * the repo's name, ie it was not renamed as it was cloned.
-     **/
-    public static function github_get_source_dir($projecturl, $file_path): string
-    {
-        $repo_name = basename($projecturl);
-        $offset = stripos($file_path, $repo_name);
-        if ($offset === false) {
-            return '/.../';
-        }
-        $offset += strlen($repo_name);
-        return substr($file_path, 0, $offset);
-    }
-
     /** Return the GitHub diff URL */
     public static function get_github_diff_url($projecturl, $directory, $file, $revision)
     {
@@ -155,36 +117,6 @@ public static function get_revision_url($projectid, $revision, $priorrevision)
         return self::get_github_revision_url($projecturl, $revision, $priorrevision);
     }
 
-    public static function linkify_compiler_output($projecturl, $source_dir, $revision, $compiler_output): string
-    {
-        // Escape HTML characters in compiler output first.  This allows us to properly
-        // display characters such as angle brackets in compiler output.
-        $compiler_output = htmlspecialchars($compiler_output, ENT_QUOTES, 'UTF-8', false);
-
-        // set a reasonable default revision if none was specified
-        if (empty($revision)) {
-            $revision = 'master';
-        }
-
-        // Make sure we specify a protocol so this isn't interpreted as a relative path.
-        if (!str_contains($projecturl, '//')) {
-            $projecturl = '//' . $projecturl;
-        }
-        $repo_link = "<a class='cdash-link' href='$projecturl/blob/$revision";
-        $pattern = "&$source_dir\/*([a-zA-Z0-9_\.\-\\/]+):(\d+)&";
-        $replacement = "$repo_link/$1#L$2'>$1:$2</a>";
-
-        // create links for source files
-        $compiler_output = preg_replace($pattern, $replacement, $compiler_output);
-
-        // remove base dir from other (binary) paths
-        $base_dir = dirname($source_dir) . '/';
-        if ($base_dir !== '//') {
-            return str_replace($base_dir, '', $compiler_output);
-        }
-        return $compiler_output;
-    }
-
     /** Post a comment on a pull request */
     public static function post_pull_request_comment($projectid, $pull_request, $comment, $cdash_url): void
     {