App\Controller\IncidentsController

Complexity

Total Complexity

13

Size/Duplication

Total Lines	132
Duplicated Lines	0 %

Test Coverage

Coverage

93.94%

Importance

Changes	2
Bugs	0	Features	1

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getSimilarFields()	0	19	2
A	sendNotificationMail()	0	18	1
A	view()	0	17	3
A	create()	0	38	4
A	json()	0	21	3

<?php

/**
 * Incidents controller handling incident creation and rendering.
 *
 * phpMyAdmin Error reporting server
 * Copyright (c) phpMyAdmin project (https://www.phpmyadmin.net/)
 *
 * Licensed under The MIT License
 * For full copyright and license information, please see the LICENSE.txt
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright Copyright (c) phpMyAdmin project (https://www.phpmyadmin.net/)
 * @license   https://opensource.org/licenses/mit-license.php MIT License
 *
 * @see      https://www.phpmyadmin.net/
 */

namespace App\Controller;

use Cake\Core\Configure;
use Cake\Http\Exception\NotFoundException;
use Cake\Http\Response;
use Cake\ORM\TableRegistry;
use const JSON_PRETTY_PRINT;
use const JSON_UNESCAPED_SLASHES;
use function __;
use function array_merge;
use function count;
use function in_array;
use function json_decode;
use function json_encode;

/**
 * Incidents controller handling incident creation and rendering.
 */
class IncidentsController extends AppController
{
    /** @var string[] */
    public $uses = [
        'Incident',
        'Notification',
    ];

    /** @var string */
    public $components = ['Mailer'];

    public function create(): ?Response
    {
        // Only allow POST requests
        $this->request->allowMethod(['post']);

        $bugReport = $this->request->input('json_decode', true);
        $result = $this->Incidents->createIncidentFromBugReport($bugReport);

The property Incidents does not exist on App\Controller\IncidentsController. Since you implemented __get, consider adding a @property annotation.

        if (count($result['incidents']) > 0
            && ! in_array(false, $result['incidents'])
        ) {
            $response = [
                'success' => true,
                'message' => 'Thank you for your submission',
                'incident_id' => $result['incidents'],        // Return a list of incident ids.
            ];
        } else {
            $response = [
                'success' => false,
                'message' => 'There was a problem with your submission.',
            ];
        }
        $this->autoRender = false;
        $this->response->header([

The function Cake\Http\Response::header() has been deprecated: 3.4.0 Use `withHeader()`, `getHeaderLine()` and `getHeaders()` instead.

            'Content-Type' => 'application/json',
            'X-Content-Type-Options' => 'nosniff',
        ]);
        $this->response->body(

The function Cake\Http\Response::body() has been deprecated: 3.4.0 Mutable response methods are deprecated. Use `withBody()`/`withStringBody()` and `getBody()` instead.

            json_encode($response, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES)
        );

        // For all the newly added reports,
        // send notification emails
        foreach ($result['reports'] as $report_id) {
            $this->sendNotificationMail($report_id);
        }

        return $this->response;
    }

    public function json(?string $id): ?Response
    {
        if (empty($id)) {
            throw new NotFoundException(__('Invalid Incident'));
        }

        $this->Incidents->recursive = -1;

The property Incidents does not exist on App\Controller\IncidentsController. Since you implemented __get, consider adding a @property annotation.

        $incident = $this->Incidents->findById($id)->all()->first();
        if (! $incident) {
            throw new NotFoundException(__('Invalid Incident'));
        }

        $incident['full_report'] =
            json_decode($incident['full_report'], true);
        $incident['stacktrace'] =
            json_decode($incident['stacktrace'], true);

        $this->autoRender = false;
        $this->response->body(json_encode($incident, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES));

The function Cake\Http\Response::body() has been deprecated: 3.4.0 Mutable response methods are deprecated. Use `withBody()`/`withStringBody()` and `getBody()` instead.

        return $this->response;
    }

    public function view(?string $incidentId): void
    {
        if (empty($incidentId)) {
            throw new NotFoundException(__('Invalid Incident'));
        }

        $incident = $this->Incidents->findById($incidentId)->all()->first();

The property Incidents does not exist on App\Controller\IncidentsController. Since you implemented __get, consider adding a @property annotation.

        if (! $incident) {
            throw new NotFoundException(__('Invalid Incident'));
        }

        $incident['full_report'] =
            json_decode($incident['full_report'], true);
        $incident['stacktrace'] =
            json_decode($incident['stacktrace'], true);

        $this->set('incident', $incident);
    }

    private function sendNotificationMail(int $reportId): void
    {
        $this->Reports = TableRegistry::getTableLocator()->get('Reports');

The property Reports does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $report = $this->Reports->findById($reportId)->all()->first()->toArray();
        $this->Reports->id = $reportId;

The property id does not seem to exist on Cake\ORM\Table.

        $viewVars = [
            'report' => $report,
            'project_name' => Configure::read('GithubRepoPath'),
            'incidents' => $this->Reports->getIncidents()->toArray(),
            'incidents_with_description' => $this->Reports->getIncidentsWithDescription(),
            'incidents_with_stacktrace' => $this->Reports->getIncidentsWithDifferentStacktrace(),
            'related_reports' => $this->Reports->getRelatedReports(),
            'status' => $this->Reports->status,
        ];
        $viewVars = array_merge($viewVars, $this->getSimilarFields($reportId));

        $this->Mailer->sendReportMail($viewVars);

The property Mailer does not exist on App\Controller\IncidentsController. Since you implemented __get, consider adding a @property annotation.

    }

    protected function getSimilarFields(int $id): array
    {
        $this->Reports->id = $id;

        $viewVars = [
            'columns' => TableRegistry::getTableLocator()->get('Incidents')->summarizableFields,
        ];
        $relatedEntries = [];

        foreach (TableRegistry::getTableLocator()->get('Incidents')->summarizableFields as $field) {
            [$entriesWithCount, $totalEntries] =
                    $this->Reports->getRelatedByField($field, 25, true);
            $relatedEntries[$field] = $entriesWithCount;
            $viewVars["${field}_distinct_count"] = $totalEntries;
        }

        $viewVars['related_entries'] = $relatedEntries;

        return $viewVars;
    }
}