SearchConsoleClient::performQuery() - Code Metrics - Inspection of "Merge branch 'master' of https://github.com/schulz..." - schulzefelix/laravel-search-console - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 8e38ca...66a88b )

by Felix

created 2017-09-26 11:05 UTC

SearchConsoleClient::performQuery() B

↳ Parent: SearchConsoleClient

Complexity

Conditions	6
Paths	3

Size

Total Lines	58
Code Lines	30

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	58
rs	8.7274
c	0
b	0
f	0
cc	6
eloc	30
nc	3
nop	3

How to fix Long Method

<?php

namespace SchulzeFelix\SearchConsole;

use Google_Client;
use GuzzleHttp\Client;
use Google_Service_Webmasters;
use Illuminate\Support\Collection;

class SearchConsoleClient
{
    const CHUNK_SIZE = 5000;

    /**
     * @var Google_Client
     */
    private $googleClient;

    private $queryOptParams = [];

    /**
     * SearchConsoleClient constructor.
     * @param Google_Client $googleClient
     * @internal param Google_Service_Webmasters $service
     */
    public function __construct(Google_Client $googleClient)
    {
        $this->googleClient = $googleClient;
    }

    /**
     * @param string $siteUrl
     * @param int $rows
     * @param \Google_Service_Webmasters_SearchAnalyticsQueryRequest $request
     * @return Collection
     */
    public function performQuery($siteUrl, $rows, $request): Collection
    {
        $searchanalyticsResource = $this->getWebmastersService()->searchanalytics;

        $maxQueries = 2000;
        $currentRequest = 1;
        $dataRows = new Collection();

        while ($currentRequest < $maxQueries) {
            $startRow = ($currentRequest - 1) * self::CHUNK_SIZE;

            $request->setRowLimit(self::CHUNK_SIZE);
            $request->setStartRow($startRow);

            $backoff = new ExponentialBackoff(10);
            $response = $backoff->execute(function () use ($searchanalyticsResource, $siteUrl, $request) {
                return $searchanalyticsResource->query($siteUrl, $request, $this->queryOptParams);
            });

            // Stop if no more rows returned
            if (count($response->getRows()) == 0) {
                break;
            }

            foreach ($response->getRows() as $row) {
                /*
                 * Use a unique hash as key to prevent duplicates caused by the query dimension problem with the google api
                 * Google give less than 5000 rows back when two or more dimension with the query dimension are choosen, repeated calls give back more rows
                 * https://productforums.google.com/forum/?hl=en#!topic/webmasters/wF_Rm9CGr4U
                 */

                $uniqueHash = md5(str_random());
                $item = [];

                if (count($row->getKeys())) {
                    $item = array_combine($request->getDimensions(), $row->getKeys());
                    $uniqueHash = $this->getUniqueItemHash($row, $request);
                }

                $item['clicks'] = $row->getClicks();
                $item['impressions'] = $row->getImpressions();
                $item['ctr'] = $row->getCtr();
                $item['position'] = $row->getPosition();
                $item['searchType'] = $request->getSearchType();

                $dataRows->put($uniqueHash, $item);
            }

            //Stop if the requested row count are reached
            if ($dataRows->count() >= $rows) {
                break;
            }

            $currentRequest++;
        }

        return $dataRows->take($rows);
    }

    /**
     * @param string $quotaUser
     */
    public function setQuotaUser(string $quotaUser)
    {
        $this->queryOptParams['quotaUser'] = $quotaUser;

        $guzzleConfig = $this->googleClient->getHttpClient()->getConfig();

        array_set($guzzleConfig, 'base_uri', Google_Client::API_BASE_PATH.'?quotaUser='.$quotaUser);

        $guzzleClient = new Client($guzzleConfig);

        $this->googleClient->setHttpClient($guzzleClient);
    }

    /**
     * @param string $accessToken
     */
    public function setAccessToken(string $accessToken)
    {
        $this->googleClient->setAccessToken($accessToken);
    }

    public function getWebmastersService(): Google_Service_Webmasters
    {
        return new Google_Service_Webmasters($this->googleClient);
    }

    private function getUniqueItemHash($row, $request)
    {
        $keys = implode('', $row->getKeys());

        $filters = [];
        foreach ($request->getDimensionFilterGroups() as $dimensionFilterGroup) {
            foreach ($dimensionFilterGroup->filters as $filter) {
                $filters[] = $filter->dimension . $filter->expression . $filter->operator;
            }
        }
        $filters = implode('', $filters);

        return md5( $keys . $filters . $request->getSearchType() . $request->endDate . $request->startDate);
    }
}


1			<?php
2
3			namespace SchulzeFelix\SearchConsole;
4
5			use Google_Client;
6			use GuzzleHttp\Client;
7			use Google_Service_Webmasters;
8			use Illuminate\Support\Collection;
9
10			class SearchConsoleClient
11			{
12			const CHUNK_SIZE = 5000;
13
14			/**
15			* @var Google_Client
16			*/
17			private $googleClient;
18
19			private $queryOptParams = [];
20
21			/**
22			* SearchConsoleClient constructor.
23			* @param Google_Client $googleClient
24			* @internal param Google_Service_Webmasters $service
25			*/
26			public function __construct(Google_Client $googleClient)
27			{
28			$this->googleClient = $googleClient;
29			}
30
31			/**
32			* @param string $siteUrl
33			* @param int $rows
34			* @param \Google_Service_Webmasters_SearchAnalyticsQueryRequest $request
35			* @return Collection
36			*/
37			public function performQuery($siteUrl, $rows, $request): Collection
38			{
39			$searchanalyticsResource = $this->getWebmastersService()->searchanalytics;
40
41			$maxQueries = 2000;
42			$currentRequest = 1;
43			$dataRows = new Collection();
44
45			while ($currentRequest < $maxQueries) {
46			$startRow = ($currentRequest - 1) * self::CHUNK_SIZE;
47
48			$request->setRowLimit(self::CHUNK_SIZE);
49			$request->setStartRow($startRow);
50
51			$backoff = new ExponentialBackoff(10);
52			$response = $backoff->execute(function () use ($searchanalyticsResource, $siteUrl, $request) {
53			return $searchanalyticsResource->query($siteUrl, $request, $this->queryOptParams);
54			});
55
56			// Stop if no more rows returned
57			if (count($response->getRows()) == 0) {
58			break;
59			}
60
61			foreach ($response->getRows() as $row) {
62			/*
63			* Use a unique hash as key to prevent duplicates caused by the query dimension problem with the google api
64			* Google give less than 5000 rows back when two or more dimension with the query dimension are choosen, repeated calls give back more rows
65			* https://productforums.google.com/forum/?hl=en#!topic/webmasters/wF_Rm9CGr4U
66			*/
67
68			$uniqueHash = md5(str_random());
69			$item = [];
70
71			if (count($row->getKeys())) {
72			$item = array_combine($request->getDimensions(), $row->getKeys());
73			$uniqueHash = $this->getUniqueItemHash($row, $request);
74			}
75
76			$item['clicks'] = $row->getClicks();
77			$item['impressions'] = $row->getImpressions();
78			$item['ctr'] = $row->getCtr();
79			$item['position'] = $row->getPosition();
80			$item['searchType'] = $request->getSearchType();
81
82			$dataRows->put($uniqueHash, $item);
83			}
84
85			//Stop if the requested row count are reached
86			if ($dataRows->count() >= $rows) {
87			break;
88			}
89
90			$currentRequest++;
91			}
92
93			return $dataRows->take($rows);
94			}
95
96			/**
97			* @param string $quotaUser
98			*/
99			public function setQuotaUser(string $quotaUser)
100			{
101			$this->queryOptParams['quotaUser'] = $quotaUser;
102
103			$guzzleConfig = $this->googleClient->getHttpClient()->getConfig();
104
105			array_set($guzzleConfig, 'base_uri', Google_Client::API_BASE_PATH.'?quotaUser='.$quotaUser);
106
107			$guzzleClient = new Client($guzzleConfig);
108
109			$this->googleClient->setHttpClient($guzzleClient);
110			}
111
112			/**
113			* @param string $accessToken
114			*/
115			public function setAccessToken(string $accessToken)
116			{
117			$this->googleClient->setAccessToken($accessToken);
118			}
119
120			public function getWebmastersService(): Google_Service_Webmasters
121			{
122			return new Google_Service_Webmasters($this->googleClient);
123			}
124
125			private function getUniqueItemHash($row, $request)
126			{
127			$keys = implode('', $row->getKeys());
128
129			$filters = [];
130			foreach ($request->getDimensionFilterGroups() as $dimensionFilterGroup) {
131			foreach ($dimensionFilterGroup->filters as $filter) {
132			$filters[] = $filter->dimension . $filter->expression . $filter->operator;
133			}
134			}
135			$filters = implode('', $filters);
136
137			return md5( $keys . $filters . $request->getSearchType() . $request->endDate . $request->startDate);
138			}
139			}
140

schulzefelix / laravel-search-console

Push — master ( 8e38ca...66a88b )

SearchConsoleClient::performQuery() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like