nystudio107\webperf\services\DataSamples

Complexity

Total Complexity

37

Size/Duplication

Total Lines	407
Duplicated Lines	0 %

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
B	addDataSample()	0	74	10
A	deleteDataSamplesByUrl()	0	19	3
A	rateLimited()	0	12	3
A	deleteAllDataSamples()	0	19	3
A	deleteSampleById()	0	17	2
A	trimOrphanedSamples()	0	16	2
A	trimDataSamples()	0	59	5
A	trimOutlierSamples()	0	20	4
A	pageTitle()	0	21	3
A	totalSamples()	0	12	2

<?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\CraftDataSample;
use nystudio107\webperf\base\DbDataSampleInterface;
use nystudio107\webperf\events\DataSampleEvent;

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?

/**

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 DataSamples extends Component
{
    // Constants
    // =========================================================================

    const LAST_DATASAMPLES_TRIM_CACHE_KEY = 'webperf-last-datasamples-trim';

    const OUTLIER_PAGELOAD_MULTIPLIER = 10;

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

     * @event DataSampleEvent The event that is triggered after the redirect is saved
     *
     * ```php
     * use nystudio107\webperf\services\DataSamples;
     * use nystudio107\webperf\events\DataSampleEvent;
     *
     * Event::on(DataSamples::class,
     *     DataSamples::EVENT_AFTER_SAVE_DATA_SAMPLE,
     *     function(DataSampleEvent $event) {
     *         // the data sample was saved
     *     }
     * );
     * ```
     */
    const EVENT_AFTER_SAVE_DATA_SAMPLE = 'afterSaveDataSample';

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

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

Missing parameter comment

     * @param string $column

Missing parameter comment

     *
     * @return int|string
     */
    public function totalSamples(int $siteId, string $column)
    {
        // Get the total number of data samples
        $query = (new Query())
            ->from(['{{%webperf_data_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 page title from data samples 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_data_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 a data sample to the webperf_data_samples table
     *
     * @param DbDataSampleInterface $dataSample

Missing parameter comment

     */

Missing @return tag in function comment

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

            return;
        }
        $isNew = true;
        if (!empty($dataSample->requestId)) {

Accessing requestId on the interface nystudio107\webperf\base\DbDataSampleInterface suggest that you code against a concrete implementation. How about adding an instanceof check?

            // See if a data sample exists with the same requestId already
            $testSample = (new Query())
                ->from(['{{%webperf_data_samples}}'])
                ->where(['requestId' => $dataSample->requestId])
                ->one();
            // If it exists, update it rather than having duplicates
            if (!empty($testSample)) {
                $isNew = false;
            }
        }
        // Trigger a 'beforeSaveDataSample' event
        $event = new DataSampleEvent([

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

            'isNew' => $isNew,
            'dataSample' => $dataSample,
        ]);

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

        $this->trigger(self::EVENT_BEFORE_SAVE_DATA_SAMPLE, $event);
        if (!$event->isValid) {
            return;
        }
        // Get the validated model attributes and save them to the db
        $dataSampleConfig = $dataSample->getAttributes();
        $db = Craft::$app->getDb();
        if ($isNew) {
            Craft::debug('Creating new data sample', __METHOD__);
            // Create a new record
            try {
                $result = $db->createCommand()->insert(
                    '{{%webperf_data_samples}}',
                    $dataSampleConfig
                )->execute();
                Craft::debug($result, __METHOD__);
            } catch (\Exception $e) {
                Craft::error($e->getMessage(), __METHOD__);
            }
        } else {
            Craft::debug('Updating existing data sample', __METHOD__);
            // Update the existing record
            try {
                $result = $db->createCommand()->update(
                    '{{%webperf_data_samples}}',
                    $dataSampleConfig,
                    [
                        'requestId' => $dataSample->requestId,
                    ]
                )->execute();
                Craft::debug($result, __METHOD__);
            } catch (\Exception $e) {
                Craft::error($e->getMessage(), __METHOD__);
            }
        }
        // Trigger a 'afterSaveDataSample' event
        $this->trigger(self::EVENT_AFTER_SAVE_DATA_SAMPLE, $event);
        // Trim orphaned samples
        $this->trimOrphanedSamples($dataSample->requestId);
        // After adding the DataSample, trim the webperf_data_samples db table
        if (Webperf::$settings->automaticallyTrimDataSamples && !$this->rateLimited()) {
            $this->trimDataSamples();
        }
    }

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

Missing parameter comment

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

        return $result;
    }

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

Missing parameter comment

     * @param int|null $siteId

Missing parameter comment

     *
     * @return int
     */
    public function deleteDataSamplesByUrl(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_data_samples}}',
                $conditions
            )->execute();
        } catch (\Exception $e) {
            Craft::error($e->getMessage(), __METHOD__);
            $result = 0;
        }

        return $result;
    }

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

Missing parameter comment

     *
     * @return int
     */
    public function deleteAllDataSamples(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_data_samples}}',
                $conditions
            )->execute();
        } catch (\Exception $e) {
            Craft::error($e->getMessage(), __METHOD__);
            $result = 0;
        }

        return $result;
    }

    /**
     * Trim any samples that our outliers
     */

Missing @return tag in function comment

    public function trimOutlierSamples()
    {
        if (Webperf::$settings->trimOutlierDataSamples) {
            $db = Craft::$app->getDb();
            Craft::debug('Trimming outlier samples', __METHOD__);
            // Get the average pageload time
            $stats = (new Query())
                ->from('{{%webperf_data_samples}}')
                ->average('[[pageLoad]]');
            if (!empty($stats)) {
                $threshold = $stats * self::OUTLIER_PAGELOAD_MULTIPLIER;
                // Delete any samples that are far above average
                try {
                    $result = $db->createCommand()->delete(
                        '{{%webperf_data_samples}}',
                        ['>', '[[pageLoad]]', $threshold]
                    )->execute();
                    Craft::debug($result, __METHOD__);
                } catch (\Exception $e) {
                    Craft::error($e->getMessage(), __METHOD__);
                }
            }
        }
    }

    /**
     * Trim samples that have the placeholder in the URL, aka they never
     * received the Boomerang beacon
     *
     * @param int $requestId

Missing parameter comment

     */

Missing @return tag in function comment

    public function trimOrphanedSamples($requestId)
    {
        $db = Craft::$app->getDb();
        Craft::debug('Trimming orphaned samples', __METHOD__);
        // Update the existing record
        try {
            $result = $db->createCommand()->delete(
                '{{%webperf_data_samples}}',
                [
                    'and', ['url' => CraftDataSample::PLACEHOLDER_URL],
                    ['not', ['requestId' => $requestId]],
                ]
            )->execute();
            Craft::debug($result, __METHOD__);
        } catch (\Exception $e) {
            Craft::error($e->getMessage(), __METHOD__);
        }
    }

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

Missing parameter comment

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

        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_data_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_DATASAMPLES_TRIM_CACHE_KEY);
        if (($then !== false) && ($now - (int)$then < Webperf::$settings->samplesRateLimitMs)) {
            $limited = true;
        }
        $cache->set(self::LAST_DATASAMPLES_TRIM_CACHE_KEY, $now, 0);

        return $limited;
    }
}