Skip to content

CreateCurlOptions method regression tests #95

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 27, 2018
Merged

CreateCurlOptions method regression tests #95

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ee8ca8d
CreateCurlOptions method tests added
misantron Mar 13, 2018
4f33cb3
Merge branch 'master' into issue94-patch
misantron Mar 13, 2018
861bb42
Docblock fixes
misantron Mar 13, 2018
a952b54
Merge remote-tracking branch 'remotes/upstream/master' into issue94-p…
misantron Mar 24, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
231 changes: 126 additions & 105 deletions lib/Client.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
<?php

/**
* HTTP Client library
*
* @author Matt Bernier <[email protected]>
* @author Elmer Thomas <[email protected]>
* @copyright 2018 SendGrid
* @license https://opensource.org/licenses/MIT The MIT License
* @version GIT: <git_id>
* @link http://packagist.org/packages/sendgrid/php-http-client
*/
* HTTP Client library
*
* @author Matt Bernier <[email protected]>
* @author Elmer Thomas <[email protected]>
* @copyright 2018 SendGrid
* @license https://opensource.org/licenses/MIT The MIT License
* @version GIT: <git_id>
* @link http://packagist.org/packages/sendgrid/php-http-client
*/

namespace SendGrid;

Expand All @@ -27,29 +27,54 @@
*/
class Client
{
/** @var string */
const TOO_MANY_REQUESTS_HTTP_CODE = 429;

/**
* @var string
*/
protected $host;
/** @var array */

/**
* @var array
*/
protected $headers;
/** @var string */

/**
* @var string
*/
protected $version;
/** @var array */

/**
* @var array
*/
protected $path;
/** @var array */

/**
* @var array
*/
protected $curlOptions;
/** @var bool $isConcurrentRequest */

/**
* @var bool
*/
protected $isConcurrentRequest;
/** @var array $savedRequests */

/**
* @var array
*/
protected $savedRequests;
/** @var bool */

/**
* @var bool
*/
protected $retryOnLimit;

/**
* These are the supported HTTP verbs
*
* @var array
*/
private $methods = ['get', 'post', 'patch', 'put', 'delete'];
private $methods = ['get', 'post', 'patch', 'put', 'delete'];

/**
* Initialize the client
Expand Down Expand Up @@ -105,6 +130,14 @@ public function getPath()
return $this->path;
}

/**
* @return array
*/
public function getCurlOptions()
{
return $this->curlOptions;
}

/**
* Set extra options to set during curl initialization
*
Expand Down Expand Up @@ -134,7 +167,7 @@ public function setRetryOnLimit($retry)
}

/**
* set concurrent request flag
* Set concurrent request flag
*
* @param bool $isConcurrent
*
Expand All @@ -148,20 +181,12 @@ public function setIsConcurrentRequest($isConcurrent)
}

/**
* @return array
* Build the final URL to be passed
*
* @param array $queryParams an array of all the query parameters
*
* @return string
*/
public function getCurlOptions()
{
return $this->curlOptions;
}

/**
* Build the final URL to be passed
*
* @param array $queryParams an array of all the query parameters
*
* @return string
*/
private function buildUrl($queryParams = null)
{
$path = '/' . implode('/', $this->path);
Expand All @@ -178,13 +203,14 @@ private function buildUrl($queryParams = null)
* @param string $method
* @param array $body
* @param array $headers
*
* @return array
*/
private function createCurlOptions($method, $body = null, $headers = null)
{
$options = [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HEADER => 1,
CURLOPT_HEADER => true,
CURLOPT_CUSTOMREQUEST => strtoupper($method),
CURLOPT_SSL_VERIFYPEER => true,
CURLOPT_FAILONERROR => false
Expand Down Expand Up @@ -213,7 +239,7 @@ private function createCurlOptions($method, $body = null, $headers = null)
*
* @return array
*/
private function createSavedRequest($requestData, $retryOnLimit = false)
private function createSavedRequest(array $requestData, $retryOnLimit = false)
{
return array_merge($requestData, ['retryOnLimit' => $retryOnLimit]);
}
Expand All @@ -223,7 +249,7 @@ private function createSavedRequest($requestData, $retryOnLimit = false)
*
* @return array
*/
private function createCurlMultiHandle($requests)
private function createCurlMultiHandle(array $requests)
{
$channels = [];
$multiHandle = curl_multi_init();
Expand All @@ -241,68 +267,72 @@ private function createCurlMultiHandle($requests)
/**
* Prepare response object
*
* @param resource $curl the curl resource
* @param resource $channel the curl resource
* @param string $content
*
* @return Response object
*/
private function prepareResponse($curl)
private function parseResponse($channel, $content)
{
$response = curl_exec($curl);
$headerSize = curl_getinfo($curl, CURLINFO_HEADER_SIZE);
$statusCode = curl_getinfo($curl, CURLINFO_HTTP_CODE);
$responseBody = substr($response, $headerSize);
$responseHeaders = substr($response, 0, $headerSize);
$headerSize = curl_getinfo($channel, CURLINFO_HEADER_SIZE);
$statusCode = curl_getinfo($channel, CURLINFO_HTTP_CODE);

$responseBody = substr($content, $headerSize);

$responseHeaders = substr($content, 0, $headerSize);
$responseHeaders = explode("\n", $responseHeaders);
$responseHeaders = array_map('trim', $responseHeaders);
$response = new Response($statusCode, $responseBody, $responseHeaders);
return $response;

return new Response($statusCode, $responseBody, $responseHeaders);
}

/**
* Retry request
*
* @param array $responseHeaders headers from rate limited response
* @param string $method the HTTP verb
* @param string $url the final url to call
* @param array $body request body
* @param array $headers original headers
* @param array $responseHeaders headers from rate limited response
* @param string $method the HTTP verb
* @param string $url the final url to call
* @param array $body request body
* @param array $headers original headers
*
* @return Response response object
*/
private function retryRequest($responseHeaders, $method, $url, $body, $headers)
private function retryRequest(array $responseHeaders, $method, $url, $body, $headers)
{
$sleepDurations = $responseHeaders['X-Ratelimit-Reset'] - time();
sleep($sleepDurations > 0 ? $sleepDurations : 0);
return $this->makeRequest($method, $url, $body, $headers, false);
}

/**
* Make the API call and return the response. This is separated into
* it's own function, so we can mock it easily for testing.
*
* @param string $method the HTTP verb
* @param string $url the final url to call
* @param array|\JsonSerializable $body request body
* @param array $headers any additional request headers
* @param bool $retryOnLimit should retry if rate limit is reach?
*
* @return Response object
*/
* Make the API call and return the response.
* This is separated into it's own function, so we can mock it easily for testing.
*
* @param string $method the HTTP verb
* @param string $url the final url to call
* @param array $body request body
* @param array $headers any additional request headers
* @param bool $retryOnLimit should retry if rate limit is reach?
*
* @return Response object
*/
public function makeRequest($method, $url, $body = null, $headers = null, $retryOnLimit = false)
{
$curl = curl_init($url);
$channel = curl_init($url);

$curlOpts = $this->createCurlOptions($method, $body, $headers);
$options = $this->createCurlOptions($method, $body, $headers);

curl_setopt_array($curl, $curlOpts);
curl_setopt_array($channel, $options);
$content = curl_exec($channel);

$response = $this->prepareResponse($curl);
$response = $this->parseResponse($channel, $content);

if ($response->statusCode() == 429 && $retryOnLimit) {
return $this->retryRequest($response->headers(true), $method, $url, $body, $headers);
if ($response->statusCode() === self::TOO_MANY_REQUESTS_HTTP_CODE && $retryOnLimit) {
$responseHeaders = $response->headers(true);
return $this->retryRequest($responseHeaders, $method, $url, $body, $headers);
}

curl_close($curl);
curl_close($channel);

return $response;
}
Expand All @@ -311,9 +341,10 @@ public function makeRequest($method, $url, $body = null, $headers = null, $retry
* Send all saved requests at once
*
* @param array $requests
*
* @return Response[]
*/
public function makeAllRequests($requests = [])
public function makeAllRequests(array $requests = [])
{
if (empty($requests)) {
$requests = $this->savedRequests;
Expand All @@ -330,32 +361,26 @@ public function makeAllRequests($requests = [])
$retryRequests = [];
$responses = [];
$sleepDurations = 0;
foreach ($channels as $id => $ch) {
$response = curl_multi_getcontent($ch);
$headerSize = curl_getinfo($ch, CURLINFO_HEADER_SIZE);
$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
$responseBody = substr($response, $headerSize);

$responseHeaders = substr($response, 0, $headerSize);
$responseHeaders = explode("\n", $responseHeaders);
$responseHeaders = array_map('trim', $responseHeaders);

$response = new Response($statusCode, $responseBody, $responseHeaders);
if (($statusCode === 429) && $requests[$id]['retryOnLimit']) {
foreach ($channels as $id => $channel) {

$content = curl_multi_getcontent($channel);
$response = $this->parseResponse($channel, $content);

if ($response->statusCode() === self::TOO_MANY_REQUESTS_HTTP_CODE && $requests[$id]['retryOnLimit']) {
$headers = $response->headers(true);
$sleepDurations = max($sleepDurations, $headers['X-Ratelimit-Reset'] - time());
$requestData = [
'method' => $requests[$id]['method'],
'url' => $requests[$id]['url'],
'body' => $requests[$id]['body'],
'headers' =>$headers,
'headers' => $headers,
];
$retryRequests[] = $this->createSavedRequest($requestData, false);
} else {
$responses[] = $response;
}

curl_multi_remove_handle($multiHandle, $ch);
curl_multi_remove_handle($multiHandle, $channel);
}
curl_multi_close($multiHandle);

Expand All @@ -368,15 +393,13 @@ public function makeAllRequests($requests = [])
}

/**
* Add variable values to the url.
* (e.g. /your/api/{variable_value}/call)
* Another example: if you have a PHP reserved word, such as and,
* in your url, you must use this method.
*
* @param string $name name of the url segment
*
* @return Client object
*/
* Add variable values to the url. (e.g. /your/api/{variable_value}/call)
* Another example: if you have a PHP reserved word, such as and, in your url, you must use this method.
*
* @param string $name name of the url segment
*
* @return Client object
*/
public function _($name = null)
{
if (isset($name)) {
Expand All @@ -391,14 +414,14 @@ public function _($name = null)
}

/**
* Dynamically add method calls to the url, then call a method.
* (e.g. client.name.name.method())
*
* @param string $name name of the dynamic method call or HTTP verb
* @param array $args parameters passed with the method call
*
* @return Client|Response|Response[]|null object
*/
* Dynamically add method calls to the url, then call a method.
* (e.g. client.name.name.method())
*
* @param string $name name of the dynamic method call or HTTP verb
* @param array $args parameters passed with the method call
*
* @return Client|Response|Response[]|null object
*/
public function __call($name, $args)
{
$name = strtolower($name);
Expand All @@ -422,10 +445,8 @@ public function __call($name, $args)

if ($this->isConcurrentRequest) {
// save request to be sent later
$this->savedRequests[] = $this->createSavedRequest(
['method' => $name, 'url' => $url, 'body' => $body, 'headers' => $headers],
$retryOnLimit
);
$requestData = ['method' => $name, 'url' => $url, 'body' => $body, 'headers' => $headers];
$this->savedRequests[] = $this->createSavedRequest($requestData, $retryOnLimit);
return null;
}

Expand Down
Loading