nystudio107\webperf\services\ErrorSamples

Complexity

Total Complexity

33

Size/Duplication

Total Lines	363
Duplicated Lines	0 %

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	deleteAllErrorSamples()	0	19	3
A	deleteErrorSampleById()	0	17	2
A	rateLimited()	0	12	3
A	totalErrorSamples()	0	12	2
B	addErrorSample()	0	46	8
A	deleteErrorSamplesByUrl()	0	19	3
A	totalErrorSamplesRange()	0	24	4
A	trimErrorSamples()	0	58	5
A	pageTitle()	0	21	3

<?php
/**
 * Webperf plugin for Craft CMS 3.x
 *
 * Monitor the performance of your webpages through real-world user timing data
 *
 * @link      https://nystudio107.com

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) 2019 nystudio107

@copyright tag must contain a year and the name of the copyright holder

 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

namespace nystudio107\webperf\services;

use nystudio107\webperf\Webperf;
use nystudio107\webperf\base\DbErrorSampleInterface;
use nystudio107\webperf\events\ErrorSampleEvent;

use Craft;

The type Craft was not found. Maybe you did not declare it correctly or list all dependencies?

use craft\base\Component;

The type craft\base\Component was not found. Maybe you did not declare it correctly or list all dependencies?

use craft\db\Query;

The type craft\db\Query was not found. Maybe you did not declare it correctly or list all dependencies?

use craft\helpers\Json;

The type craft\helpers\Json was not found. Maybe you did not declare it correctly or list all dependencies?

/**

Missing short description in doc comment

 * @author    nystudio107

The tag in position 1 should be the @package tag

Content of the @author tag must be in the form "Display Name <username@example.com>"

Tag value for @author tag indented incorrectly; expected 2 spaces but found 4

 * @package   Webperf

Tag value for @package tag indented incorrectly; expected 1 spaces but found 3

 * @since     1.0.0

The tag in position 3 should be the @author tag

Tag value for @since tag indented incorrectly; expected 3 spaces but found 5

 */

Missing @category tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class ErrorSamples extends Component
{
    // Constants
    // =========================================================================

    const LAST_ERRORSAMPLES_TRIM_CACHE_KEY = 'webperf-last-errorsamples-trim';

    /**

Missing short description in doc comment

     * @event ErrorSampleEvent The event that is triggered before the error sample is saved
     * You may set [[ErrorSampleEvent::isValid]] to `false` to prevent the error sample from getting saved.
     *
     * ```php
     * use nystudio107\webperf\services\ErrorSamples;
     * use nystudio107\retour\events\ErrorSampleEvent;
     *
     * Event::on(ErrorSamples::class,
     *     ErrorSamples::EVENT_BEFORE_SAVE_ERROR_SAMPLE,
     *     function(ErrorSampleEvent $event) {
     *         // potentially set $event->isValid;
     *     }
     * );
     * ```
     */
    const EVENT_BEFORE_SAVE_ERROR_SAMPLE = 'beforeSaveErrorSample';

    /**

Missing short description in doc comment

     * @event ErrorSampleEvent The event that is triggered after the redirect is saved
     *
     * ```php
     * use nystudio107\webperf\services\ErrorSamples;
     * use nystudio107\webperf\events\ErrorSampleEvent;
     *
     * Event::on(ErrorSamples::class,
     *     ErrorSamples::EVENT_AFTER_SAVE_ERROR_SAMPLE,
     *     function(ErrorSampleEvent $event) {
     *         // the error sample was saved
     *     }
     * );
     * ```
     */
    const EVENT_AFTER_SAVE_ERROR_SAMPLE = 'afterSaveErrorSample';

    // Public Methods
    // =========================================================================

    /**
     * Get the total number of errors optionally limited by siteId
     *
     * @param int    $siteId

Missing parameter comment

     * @param string $column

Missing parameter comment

     *
     * @return int|string
     */
    public function totalErrorSamples(int $siteId, string $column)
    {
        // Get the total number of errors
        $query = (new Query())
            ->from(['{{%webperf_error_samples}}'])
            ->where(['not', [$column => null]])

Space after closing parenthesis of function call prohibited

            ;
        if ((int)$siteId !== 0) {
            $query->andWhere(['siteId' => $siteId]);
        }

        return $query->count();
    }

    /**
     * Get the total number of errors optionally limited by siteId, between
     * $start and $end
     *
     * @param int         $siteId

Missing parameter comment

     * @param string      $start

Missing parameter comment

     * @param string      $end

Missing parameter comment

     * @param string|null $pageUrl

Missing parameter comment

     * @param string|null $type

Missing parameter comment

     *
     * @return int
     */
    public function totalErrorSamplesRange(int $siteId, string $start, string $end, $pageUrl = null, $type = null): int
    {
        // Add a day since YYYY-MM-DD is really YYYY-MM-DD 00:00:00
        $end = date('Y-m-d', strtotime($end.'+1 day'));
        // Get the total number of errors
        $query = (new Query())
            ->from(['{{%webperf_error_samples}}'])
            ->where(['between', 'dateCreated', $start, $end])

Space after closing parenthesis of function call prohibited

        ;
        if ($type !== null) {
            $query
                ->andWhere(['type' => $type])

Space after closing parenthesis of function call prohibited

            ;
        }
        if ($pageUrl !== null) {
            $query
                ->andWhere(['url' => $pageUrl])

Space after closing parenthesis of function call prohibited

            ;
        }
        if ((int)$siteId !== 0) {
            $query->andWhere(['siteId' => $siteId]);
        }

        return $query->count();
    }

    /**
     * Get the page title from errors by URL and optionally siteId
     *
     * @param string   $url

Missing parameter comment

Expected 1 spaces after parameter type; 3 found

     * @param int $siteId

Missing parameter comment

Expected 4 spaces after parameter type; 1 found

     *
     * @return string
     */
    public function pageTitle(string $url, int $siteId = 0): string
    {
        // Get the page title from a URL
        $query = (new Query())
            ->select(['title'])
            ->from(['{{%webperf_error_samples}}'])
            ->where([

The opening parenthesis of a multi-line function call should be the last content on the line.

                'and', ['url' => $url],
                ['not', ['title' => '']],
            ])

Space after closing parenthesis of function call prohibited

For multi-line function calls, the closing parenthesis should be on a new line.

        ;
        if ((int)$siteId !== 0) {
            $query->andWhere(['siteId' => $siteId]);
        }
        $result = $query->one();
        // Decode any emojis in the title
        if (!empty($result['title'])) {
            $result['title'] = html_entity_decode($result['title'], ENT_NOQUOTES, 'UTF-8');
        }

        return $result['title'] ?? '';
    }

    /**
     * Add an error to the webperf_error_samples table
     *
     * @param DbErrorSampleInterface $errorSample

Missing parameter comment

     */

Missing @return tag in function comment

    public function addErrorSample(DbErrorSampleInterface $errorSample)
    {
        // Validate the model before saving it to the db
        if ($errorSample->validate() === false) {
            Craft::error(
                Craft::t(
                    'webperf',
                    'Error validating error sample: {errors}',
                    ['errors' => print_r($errorSample->getErrors(), true)]
                ),
                __METHOD__
            );

            return;
        }
        // Trigger a 'beforeSaveErrorSample' event
        $event = new ErrorSampleEvent([

The opening parenthesis of a multi-line function call should be the last content on the line.

            'errorSample' => $errorSample,
        ]);

For multi-line function calls, the closing parenthesis should be on a new line.

        $this->trigger(self::EVENT_BEFORE_SAVE_ERROR_SAMPLE, $event);
        if (!$event->isValid) {
            return;
        }
        // Get the validated model attributes and save them to the db
        $errorSampleConfig = $errorSample->getAttributes();
        if (!empty($errorSampleConfig['pageErrors'])) {
            if (\is_array($errorSampleConfig['pageErrors'])) {
                $errorSampleConfig['pageErrors'] = Json::encode($errorSampleConfig['pageErrors']);
            }
            $db = Craft::$app->getDb();
            Craft::debug('Creating new error sample', __METHOD__);
            // Create a new record
            try {
                $result = $db->createCommand()->insert(
                    '{{%webperf_error_samples}}',
                    $errorSampleConfig
                )->execute();
                Craft::debug($result, __METHOD__);
            } catch (\Exception $e) {
                Craft::error($e->getMessage(), __METHOD__);
            }
            // Trigger a 'afterSaveErrorSample' event
            $this->trigger(self::EVENT_AFTER_SAVE_ERROR_SAMPLE, $event);
            // After adding the ErrorSample, trim the webperf_error_samples db table
            if (Webperf::$settings->automaticallyTrimErrorSamples && !$this->rateLimited()) {
                $this->trimErrorSamples();
            }
        }
    }

    /**
     * Delete a error sample by id
     *
     * @param int $id

Missing parameter comment

     *
     * @return int The result
     */
    public function deleteErrorSampleById(int $id): int
    {
        $db = Craft::$app->getDb();
        // Delete a row from the db table
        try {
            $result = $db->createCommand()->delete(
                '{{%webperf_error_samples}}',
                [
                    'id' => $id,
                ]
            )->execute();
        } catch (\Exception $e) {
            Craft::error($e->getMessage(), __METHOD__);
            $result = 0;
        }

        return $result;
    }

    /**
     * Delete error samples by URL and optionally siteId
     *
     * @param string   $url

Missing parameter comment

     * @param int|null $siteId

Missing parameter comment

     *
     * @return int
     */
    public function deleteErrorSamplesByUrl(string $url, int $siteId = null): int
    {
        $db = Craft::$app->getDb();
        // Delete a row from the db table
        try {
            $conditions = ['url' => $url];
            if ($siteId !== null) {
                $conditions['siteId'] = $siteId;
            }
            $result = $db->createCommand()->delete(
                '{{%webperf_error_samples}}',
                $conditions
            )->execute();
        } catch (\Exception $e) {
            Craft::error($e->getMessage(), __METHOD__);
            $result = 0;
        }

        return $result;
    }

    /**
     * Delete all error samples optionally siteId
     *
     * @param int|null $siteId

Missing parameter comment

     *
     * @return int
     */
    public function deleteAllErrorSamples(int $siteId = null): int
    {
        $db = Craft::$app->getDb();
        // Delete a row from the db table
        try {
            $conditions = [];
            if ($siteId !== null) {
                $conditions['siteId'] = $siteId;
            }
            $result = $db->createCommand()->delete(
                '{{%webperf_error_samples}}',
                $conditions
            )->execute();
        } catch (\Exception $e) {
            Craft::error($e->getMessage(), __METHOD__);
            $result = 0;
        }

        return $result;
    }

    /**
     * Trim the webperf_error_samples db table based on the errorSamplesStoredLimit
     * config.php setting
     *
     * @param int|null $limit

Missing parameter comment

     *
     * @return int
     */
    public function trimErrorSamples(int $limit = null): int
    {
        $affectedRows = 0;
        $db = Craft::$app->getDb();
        $quotedTable = $db->quoteTableName('{{%webperf_error_samples}}');
        $limit = $limit ?? Webperf::$settings->errorSamplesStoredLimit;

        if ($limit !== null) {

The condition $limit !== null is always true.

            //  https://stackoverflow.com/questions/578867/sql-query-delete-all-records-from-the-table-except-latest-n
            try {
                if ($db->getIsMysql()) {
                    // Handle MySQL
                    $affectedRows = $db->createCommand(/** @lang mysql */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

                        "
                        DELETE FROM {$quotedTable}
                        WHERE id NOT IN (
                          SELECT id
                          FROM (
                            SELECT id
                            FROM {$quotedTable}
                            ORDER BY dateCreated DESC
                            LIMIT {$limit}
                          ) foo
                        )
                        "
                    )->execute();
                }
                if ($db->getIsPgsql()) {
                    // Handle Postgres
                    $affectedRows = $db->createCommand(/** @lang mysql */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

                        "
                        DELETE FROM {$quotedTable}
                        WHERE id NOT IN (
                          SELECT id
                          FROM (
                            SELECT id
                            FROM {$quotedTable}
                            ORDER BY \"dateCreated\" DESC
                            LIMIT {$limit}
                          ) foo
                        )
                        "
                    )->execute();
                }
            } catch (\Exception $e) {
                Craft::error($e->getMessage(), __METHOD__);
            }
            Craft::info(
                Craft::t(
                    'webperf',
                    'Trimmed {rows} from webperf_error_samples table',
                    ['rows' => $affectedRows]
                ),
                __METHOD__
            );
        }

        return $affectedRows;
    }


    // Protected Methods
    // =========================================================================

    /**
     * Don't trim more than a given interval, so that performance is not affected
     *
     * @return bool
     */
    protected function rateLimited(): bool
    {
        $limited = false;
        $now = round(microtime(true) * 1000);
        $cache = Craft::$app->getCache();
        $then = $cache->get(self::LAST_ERRORSAMPLES_TRIM_CACHE_KEY);
        if (($then !== false) && ($now - (int)$then < Webperf::$settings->samplesRateLimitMs)) {
            $limited = true;
        }
        $cache->set(self::LAST_ERRORSAMPLES_TRIM_CACHE_KEY, $now, 0);

        return $limited;
    }
}