Skip to content

Commit

Permalink
Merge pull request #151 from devenbansod/fix_119
Browse files Browse the repository at this point in the history 
Improve content in generated issues on Github
  • Loading branch information
@nijel
nijel committed Jun 2, 2017
2 parents d4e4dcf + 8ac69f9 commit 912609f
Showing 1 changed file with 83 additions and 37 deletions.
120 changes: 83 additions & 37 deletions src/Controller/GithubController.php
View file
Expand Up @@ -35,8 +35,6 @@ class GithubController extends AppController

public $components = array('GithubApi');

public $uses = array('Report');

public function beforeFilter(Event $event)
{
parent::beforeFilter($event);
Expand All @@ -58,25 +56,31 @@ public function create_issue($reportId)
throw new \NotFoundException(__('Invalid report'));
}

$report = TableRegistry::get('Reports')->findById($reportId)->toArray();
$report = TableRegistry::get('Reports')->findById($reportId)->first()->toArray();
if (!$report) {
throw new NotFoundException(__('Invalid report'));
}

if (empty($this->request->data)) {
$this->set('pma_version', $report[0]['pma_version']);
$this->set('error_name', $report[0]['error_name']);
$this->set('error_message', $report[0]['error_message']);
$this->set('pma_version', $report['pma_version']);
$this->set('error_name', $report['error_name']);
$this->set('error_message', $report['error_message']);

return;
}
$data = array(
'title' => $this->request->data['summary'],
'body' => $this->_augmentDescription(
$this->request->data['description'], $reportId),
'labels' => $this->request->data['labels'] ? explode(',', $this->request->data['labels']) : array(),
);
$incidents_query = TableRegistry::get('Incidents')->findByReportId($reportId)->all();
$incident = $incidents_query->first();
$report['exception_type'] = $incident['exception_type'] ? 'php' : 'js';
$report['description'] = $this->request->data['description'];

$data['body']
= $this->_getReportDescriptionText($reportId, $report);
$data['labels'][] = 'automated-error-report';

list($issueDetails, $status) = $this->GithubApi->createIssue(
Configure::read('GithubRepoPath'),
$data,
Expand Down Expand Up @@ -104,7 +108,7 @@ public function link_issue($reportId)
throw new NotFoundException(__('Invalid reportId'));
}

$report = TableRegistry::get('Reports')->findById($reportId)->all()->first();
$report = TableRegistry::get('Reports')->findById($reportId)->all()->first()->toArray();
if (!$report) {
throw new NotFoundException(__('Invalid Report'));
}
Expand All @@ -114,23 +118,13 @@ public function link_issue($reportId)
throw new NotFoundException(__('Invalid Ticket ID!!'));
}

$incident = TableRegistry::get('Incidents')->findByReportId($reportId)->all()->first();
$exception_type = ($incident['exception_type']) ? ('php') : ('js');

// "formatted" text of the comment.
$commentText = 'Param | Value '
. "\n -----------|--------------------"
. "\n Error Type | " . $report['error_name']
. "\n Error Message |" . $report['error_message']
. "\n Exception Type |" . $exception_type
. "\n Link | [Report#"
. $reportId
. ']('
. Router::url('/reports/view/' . $reportId, true)
. ')'
. "\n\n*This comment is posted automatically by phpMyAdmin's "
. '[error-reporting-server](https://reports.phpmyadmin.net).*';
$incidents_query = TableRegistry::get('Incidents')->findByReportId($reportId)->all();
$incident = $incidents_query->first();
$report['exception_type'] = $incident['exception_type'] ? 'php' : 'js';

$commentText = $this->_getReportDescriptionText(
$reportId, $report
);
list($commentDetails, $status) = $this->GithubApi->createComment(
Configure::read('GithubRepoPath'),
array('body' => $commentText),
Expand Down Expand Up @@ -158,7 +152,7 @@ public function unlink_issue($reportId)
throw new NotFoundException(__('Invalid reportId'));
}

$report = TableRegistry::get('Reports')->findById($reportId)->all()->first();
$report = TableRegistry::get('Reports')->findById($reportId)->all()->first()->toArray();
if (!$report) {
throw new NotFoundException(__('Invalid Report'));
}
Expand Down Expand Up @@ -216,21 +210,37 @@ protected function _getErrors($response, $status)
}

/**
* Returns the description with the added string to link to the report.
* Returns the text to be added while creating an issue
*
* @param string $description the original description submitted by the dev
* @param string $reportId the report id relating to the ticket
* @param integer $reportId Report Id
* @param array $report Report associative array
*
* @return string augmented description
* @return string
*/
protected function _augmentDescription($description, $reportId)
protected function _getReportDescriptionText($reportId, $report)
{
$report = TableRegistry::get('Reports');
$report->id = $reportId;
$incident_count = $this->_getTotalIncidentCount($reportId);

// "formatted" text of the comment.
$formattedText
= array_key_exists('description', $report) ? $report['description'] . "\n\n"
: '';
$formattedText .= "\nParam | Value "
. "\n -----------|--------------------"
. "\n Error Type | " . $report['error_name']
. "\n Error Message |" . $report['error_message']
. "\n Exception Type |" . $report['exception_type']
. "\n phpMyAdmin version |" . $report['pma_version']
. "\n Incident count | " . $incident_count
. "\n Link | [Report#"
. $reportId
. ']('
. Router::url('/reports/view/' . $reportId, true)
. ')'
. "\n\n*This comment is posted automatically by phpMyAdmin's "
. '[error-reporting-server](https://reports.phpmyadmin.net).*';

return "$description\n\n\nThis report is related to user submitted report "
. '[#' . $report->id . '](' . $report->getUrl()
. ') on the phpmyadmin error reporting server.';
return $formattedText;
}

/**
Expand Down Expand Up @@ -265,6 +275,7 @@ protected function _handleGithubResponse($response, $type, $report_id, $ticket_i
case 3:
$msg = 'Github issue has been unlinked with this report.';
$ticket_id = null;

break;
default:
$msg = 'Something went wrong!!';
Expand Down Expand Up @@ -293,7 +304,7 @@ protected function _handleGithubResponse($response, $type, $report_id, $ticket_i
$flash_class = 'alert alert-error';
$this->Flash->default(
'Bug Issue not found on Github.'
. ' Are you sure the issue number is correct?!! Please check and try again',
. ' Are you sure the issue number is correct? Please check and try again!',
array('params' => array('class' => $flash_class)));

return false;
Expand All @@ -306,6 +317,41 @@ protected function _handleGithubResponse($response, $type, $report_id, $ticket_i
return false;
}

/**
* Get Incident counts for a report and
* all its related reports
*
* @param $reportId Report ID
*
* @return $total_incident_count Total Incident count for a report
*/
protected function _getTotalIncidentCount($reportId)
{
$incidents_query = TableRegistry::get('Incidents')->findByReportId($reportId)->all();
$incident_count = $incidents_query->count();

$params_count = array(
'fields' => array('inci_count' => 'inci_count'),
'conditions' => array(
'related_to = ' . $reportId,
),
);
$subquery_params_count = array(
'fields' => array(
'report_id' => 'report_id',
),
);
$subquery_count = TableRegistry::get('Incidents')->find(
'all', $subquery_params_count
);
$inci_count_related = TableRegistry::get('Reports')->find('all', $params_count)->innerJoin(
array('incidents' => $subquery_count),
array('incidents.report_id = Reports.related_to')
)->count();

return $incident_count + $inci_count_related;
}

/*
* Synchronize Report Statuses from Github issue
* To be used as a cron job.
Expand Down

0 comments on commit 912609f

Please sign in to comment.