Skip to content

Refactor buildProperties.php API endpoint #1524

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
williamjallen merged 2 commits into from
Jun 29, 2023
Merged

Refactor buildProperties.php API endpoint #1524

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ed3848b
Copy+paste `buildProperties.php` logic into controller
williamjallen Jun 26, 2023
25b9695
Refactor `buildProperties.php`
williamjallen Jun 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions app/Http/Controllers/BuildController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,11 +186,6 @@ public function buildOverview(): View|RedirectResponse
]);
}

public function buildProperties(): View
{
return view('build.properties');
}

public function viewFiles(): View|RedirectResponse
{
if (!isset($_GET['buildid'])) {
Expand Down
300 changes: 300 additions & 0 deletions app/Http/Controllers/BuildPropertiesController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,300 @@
<?php

namespace App\Http\Controllers;

use App\Services\PageTimer;
use CDash\Database;
use DateInterval;
use DateTime;
use Illuminate\Http\JsonResponse;
use Illuminate\Support\Facades\Session;
use Illuminate\View\View;
use PDOStatement;

require_once 'include/filterdataFunctions.php';

class BuildPropertiesController extends AbstractBuildController
{
public function buildProperties(): View
{
return view('build.properties');
}

public function apiBuildProperties(): JsonResponse
{
$pageTimer = new PageTimer();

if (isset($_GET['buildid'])) {
return response()->json($this->get_defects_for_builds());
}

if (!isset($_GET['project'])) {
abort(400, 'Valid project required');
}
$this->setProjectByName($_GET['project']);

// Begin our JSON response.
$response = begin_JSON_response();
$response['title'] = "{$this->project->Name} - Build Properties";
$response['showcalendar'] = 0;
$response['nightlytime'] = $this->project->NightlyTime;

// Figure out our time range.
$date = null;
$beginning_timestamp = null;
$end_timestamp = null;
if (isset($_GET['begin']) && isset($_GET['end'])) {
$beginning_date = $_GET['begin'];
$end_date = $_GET['end'];
list($unused, $beginning_timestamp) = get_dates($beginning_date, $this->project->NightlyTime);
list($unused, $end_timestamp) = get_dates($end_date, $this->project->NightlyTime);
$datetime = new DateTime();
$datetime->setTimestamp($end_timestamp);
$datetime->add(new DateInterval('P1D'));
$end_timestamp = $datetime->getTimestamp();
$response['begin'] = $beginning_date;
$response['end'] = $end_date;
} elseif (isset($_GET['date'])) {
// Otherwise use the provided date (if any).
$date = $_GET['date'];
} else {
// Default to the current date.
$date = date(FMT_DATE);
}
if (is_null($beginning_timestamp)) {
list($unused, $beginning_timestamp) = get_dates($date, $this->project->NightlyTime);
$datetime = new DateTime();
$datetime->setTimestamp($beginning_timestamp);
$datetime->add(new DateInterval('P1D'));
$end_timestamp = $datetime->getTimestamp();
}
$begin_date = date(FMT_DATETIME, $beginning_timestamp);
$end_date = date(FMT_DATETIME, $end_timestamp);

get_dashboard_JSON($this->project->Name, date(FMT_DATE, $end_timestamp), $response);

// Hide traditional Previous/Current/Next links.
$response['hidenav'] = true;

// List of possible types of defects to track.
$defect_types = [
[
'name' => 'builderrors',
'prettyname' => 'Errors',
'selected' => false
],
[
'name' => 'buildwarnings',
'prettyname' => 'Warnings',
'selected' => false
],
[
'name' => 'testfailed',
'prettyname' => 'Test Failures',
'selected' => false
]
];

// Mark specified types of defects as selected.
if (isset($_GET['defects'])) {
$selected_defect_types = explode(',', $_GET['defects']);
foreach ($selected_defect_types as $selected_type) {
foreach ($defect_types as &$type) {
if ($type['name'] === $selected_type) {
$type['selected'] = true;
break;
}
}
unset($type);
}
} else {
// Use the full list if none was specified.
foreach ($defect_types as &$type) {
$type['selected'] = true;
}
unset($type);
}
$response['defecttypes'] = $defect_types;

$defect_types = array_filter($defect_types, function ($defect_type) {
return $defect_type['selected'];
});

// Construct an SQL SELECT clause for the requested types of defects.
$defect_keys = [];
foreach ($defect_types as $type) {
$defect_keys[] = "b.{$type['name']}";
}
$defect_selection = implode(', ', $defect_keys);

// Get properties and error info for selected builds.
$pdo = Database::getInstance()->getPdo();
$stmt = $pdo->prepare(
"SELECT b.id, b.name, $defect_selection, bp.properties
FROM build b
JOIN buildproperties bp ON (bp.buildid = b.id)
WHERE b.projectid = :projectid AND b.parentid IN (0, -1)
AND b.starttime < :end AND b.starttime >= :begin");
$stmt->bindParam(':projectid', $this->project->Id);
$stmt->bindParam(':begin', $begin_date);
$stmt->bindParam(':end', $end_date);
pdo_execute($stmt);

$builds_response = [];
$all_properties = [];
while ($row = $stmt->fetch()) {
$build_response = [];
$buildid = $row['id'];
$build_response['id'] = $buildid;
foreach ($defect_types as $defect_type) {
$key = $defect_type['name'];
$build_response[$key] = $row[$key];
}
$properties = json_decode($row['properties'], true);
$build_response['properties'] = $properties;
$builds_response[] = $build_response;

// Check for properties we haven't encountered yet.
$new_property_keys = array_diff(array_keys($properties), array_keys($all_properties));
foreach ($new_property_keys as $key) {
// Determine what type of property this is.
$value = $properties[$key];
if (is_array($value)) {
$type = 'array';
} elseif (is_bool($value)) {
$type = 'bool';
} elseif (is_numeric($value) && !str_contains($value, 'e')) {
$type = 'number';
} else {
$type = 'string';
}

// Add it to our list.
$all_properties[$key] = ['type' => $type];
}
}
$response['builds'] = $builds_response;
$response['properties'] = $all_properties;

// Timeline chart needs to know what defects we care about
// and what page we're coming from.
Session::put('defecttypes', $defect_types);

$response['filterdata']['pageId'] = 'buildProperties.php';

$pageTimer->end($response);
return response()->json(cast_data_for_JSON($response));
}

private function get_defects_for_builds()
{
if (!array_key_exists('buildid', $_GET)) {
abort(400, 'Missing parameter: buildid');
}
if (!array_key_exists('defect', $_GET)) {
abort(400, 'Missing parameter: defect');
}

if (!is_array($_GET['buildid']) || count($_GET['buildid']) < 1) {
abort(400, "No builds specified");
}
if (!is_array($_GET['defect']) || count($_GET['defect']) < 1) {
abort(400, "No defects specified");
}

// A bit of a hack to ensure that we are able to access each specified buildid.
// This loop will generate many queries and is generally quite inefficient, but should only
// be operating on small numbers of buildids, so we shouldn't see much of a performance impact.
// Future optimizations can be made at the cost of lower code cleanliness in the future if necessary.
foreach ($_GET['buildid'] as $buildid) {
$this->setBuildById((int) $buildid);
}

$pdo = Database::getInstance()->getPdo();
$placeholder_str = Database::getInstance()->createPreparedArray(count($_GET['buildid']));

$defects_response = [];
foreach ($_GET['defect'] as $defect) {
$valid_defect = false;
$sql = '';
$sql2 = null;

$error_defect = false;
$type = '';
$prettyname = '';
if ($defect === 'builderrors') {
$error_defect = true;
$prettyname = 'Error';
$type = 0;
} elseif ($defect === 'buildwarnings') {
$error_defect = true;
$prettyname = 'Warning';
$type = 1;
}

if ($error_defect) {
$valid_defect = true;
// Query builderror table.
$sql =
"SELECT buildid, text AS descr
FROM builderror
WHERE type = $type AND
buildid IN $placeholder_str";
// Query buildfailure table.
$sql2 =
"SELECT bf.buildid, bfd.stderror AS descr
FROM buildfailure bf
JOIN buildfailuredetails bfd ON bf.detailsid = bfd.id
WHERE bfd.type = $type AND
bf.buildid IN $placeholder_str";
} elseif ($defect === 'testfailed') {
$valid_defect = true;
$prettyname = 'Test Failure';
$sql =
"SELECT t.name AS descr, b.id AS buildid
FROM test t
JOIN build2test b2t ON b2t.testid = t.id
JOIN build b ON b.id = b2t.buildid
WHERE b2t.status = 'failed' AND
b.id IN $placeholder_str";
}

if (!$valid_defect) {
continue;
}

$stmt = $pdo->prepare($sql);
$stmt->execute($_GET['buildid']);

if (!$this->gather_defects($stmt, $prettyname, $defects_response) && !is_null($sql2)) {
$stmt = $pdo->prepare($sql2);
$stmt->execute($_GET['buildid']);
$this->gather_defects($stmt, $prettyname, $defects_response);
}
}

$response = [];
$response['defects'] = $defects_response;
return cast_data_for_JSON($response);
}

private function gather_defects(PDOStatement $stmt, string $prettyname, array &$defects_response): bool
{
$results_found = false;
while ($row = $stmt->fetch()) {
$results_found = true;
$descr = $row['descr'];
$idx = array_search($descr, array_column($defects_response, 'descr'), true);
if ($idx === false) {
$defects_response[] = [
'descr' => $descr,
'type' => $prettyname,
'builds' => []
];
$idx = count($defects_response) - 1;
}
$defects_response[$idx]['builds'][] = $row['buildid'];
}
return $results_found;
}
}
Loading