Skip to content
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

Jump to bottom

Implement requests pool #502

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from
Open

Implement requests pool #502

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
d82ea15
lib/Requests/cURL: fix option header handling
Jun 21, 2021
c88b9aa
lib/Requests: implement request_pool handling
May 26, 2021
54e4921
tests/Transpot: add pool requests tests
Jun 23, 2021
ac7d032
fixup! tests/Transpot: add pool requests tests
Jun 30, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
73 changes: 73 additions & 0 deletions library/Requests.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -385,6 +385,79 @@ public static function request($url, $headers = array(), $data = array(), $type
return self::parse_response($response, $url, $headers, $data, $options);
}

public static function request_pool($requests, $options = array(), $pool_size = 2) {
$options = array_merge(self::get_default_options(true), $options);

if (!empty($options['hooks'])) {
$options['hooks']->register('transport.internal.parse_response', array('Requests', 'parse_multiple'));
if (!empty($options['complete'])) {
$options['hooks']->register('multiple.request.complete', $options['complete']);
}
}

foreach ($requests as $id => &$request) {
if (!isset($request['headers'])) {
$request['headers'] = array();
}
if (!isset($request['data'])) {
$request['data'] = array();
}
if (!isset($request['type'])) {
$request['type'] = self::GET;
}
if (!isset($request['options'])) {
$request['options'] = $options;
$request['options']['type'] = $request['type'];
}
else {
if (empty($request['options']['type'])) {
$request['options']['type'] = $request['type'];
}
$request['options'] = array_merge($options, $request['options']);
}

self::set_defaults($request['url'], $request['headers'], $request['data'], $request['type'], $request['options']);

// Ensure we only hook in once
if ($request['options']['hooks'] !== $options['hooks']) {
$request['options']['hooks']->register('transport.internal.parse_response', array('Requests', 'parse_multiple'));
if (!empty($request['options']['complete'])) {
$request['options']['hooks']->register('multiple.request.complete', $request['options']['complete']);
}
}
}
unset($request);

if (!empty($options['transport'])) {
$transport = $options['transport'];

if (is_string($options['transport'])) {
$transport = new $transport();
}
}
else {
$transport = self::get_transport();
}

if (get_class($transport) !== 'Requests_Transport_cURL') {
return array();
}

$responses = $transport->request_pool($requests, $options, $pool_size);

foreach ($responses as $id => &$response) {
// If our hook got messed with somehow, ensure we end up with the
// correct response
if (is_string($response)) {
$request = $requests[$id];
self::parse_multiple($response, $request);
$request['options']['hooks']->dispatch('multiple.request.complete', array(&$response, $id));
}
}

return $responses;
}

/**
* Send multiple HTTP requests simultaneously
*
Expand Down
156 changes: 142 additions & 14 deletions library/Requests/Transport/cURL.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,20 +147,6 @@ public function request($url, $headers = array(), $data = array(), $options = ar
$this->response_byte_limit = $options['max_bytes'];
}

if (isset($options['verify'])) {
if ($options['verify'] === false) {
curl_setopt($this->handle, CURLOPT_SSL_VERIFYHOST, 0);
curl_setopt($this->handle, CURLOPT_SSL_VERIFYPEER, 0);
}
elseif (is_string($options['verify'])) {
curl_setopt($this->handle, CURLOPT_CAINFO, $options['verify']);
}
}

if (isset($options['verifyname']) && $options['verifyname'] === false) {
curl_setopt($this->handle, CURLOPT_SSL_VERIFYHOST, 0);
}

curl_exec($this->handle);
$response = $this->response_data;

Expand All @@ -186,6 +172,134 @@ public function request($url, $headers = array(), $data = array(), $options = ar
return $this->headers;
}


/**
* Send multiple requests simultaneously with a maximal concurrent conncetion (pool)
*
* @param array $requests Request data
* @param array $options Global options
* @param int $pool_size Maximal simultaneously connections
* @return array Array of Requests_Response objects (may contain Requests_Exception or string responses as well)
*/
public function request_pool($requests, $options, $pool_size = 2) {
if (empty($requests)) {
return array();
}

$pool = array();
$queue = array();
$responses = array();

$main_curl_executor_pool = curl_multi_init();

foreach ($requests as $id => $request) {
$queue[] = array(
$id,
$request,
);
}

$queue = array_reverse($queue);

$request['options']['hooks']->dispatch('curl.before_multi_exec', array(&$multihandle));

while (!empty($pool) || !empty($queue)) {
curl_multi_exec($main_curl_executor_pool, $active);
$done = curl_multi_info_read($main_curl_executor_pool);

if ($done !== false) {
$pool_key = (int) $done['handle'];
$pool_element = $pool[$pool_key];
unset($pool[$pool_key]);

$response = $this->handleCurlResponse($done, $pool_element);
$responses[$pool_element['id']] = $response;
curl_multi_remove_handle($main_curl_executor_pool, $done['handle']);
curl_close($done['handle']);

$pool_element['request']['options']['hooks']->dispatch(
'multiple.request.complete',
array(
&$responses[$pool_element['id']],
$pool_element['id'],
)
);
}

if (count($pool) >= $pool_size || empty($queue)) {
sleep(0.5);

continue;
}

list($id, $request) = array_pop($queue);
list($subhandle, $subrequest) = $this->addNewSubrequestHandle($request);

$pool[(int) $subhandle] = array(
'id' => $id,
'request' => $request,
'subhandle' => $subhandle,
'subrequest' => $subrequest,
);

curl_multi_add_handle($main_curl_executor_pool, $subhandle);
}

$request['options']['hooks']->dispatch('curl.after_multi_exec', array(&$multihandle));
curl_multi_close($main_curl_executor_pool);

return $responses;
}

private function addNewSubrequestHandle($request) {
$class = get_class($this);
$subrequest = new $class();
$subhandle = $subrequest->get_subrequest_handle(
$request['url'],
$request['headers'],
$request['data'],
$request['options']
);
$request['options']['hooks']->dispatch('curl.before_multi_add', array(&$subhandle));

return array($subhandle, $subrequest);
}

private function handleCurlResponse(array $done, $pool_element) {

if ($done['result'] === CURLE_OK) {
$parsed_response = $pool_element['subrequest']->process_response(
$pool_element['subrequest']->response_data,
$pool_element['request']['options']
);

$pool_element['request']['options']['hooks']->dispatch(
'transport.internal.parse_response',
array(
&$parsed_response,
$pool_element['request'],
)
);

return $parsed_response;
}

$reason = curl_error($done['handle']);
$exception = new Requests_Exception_Transport_cURL(
$reason,
Requests_Exception_Transport_cURL::EASY,
$done['handle'],
$done['result']
);

$pool_element['request']['options']['hooks']->dispatch(
'transport.internal.parse_error',
array(&$exception, $pool_element['request'])
);

return $exception;
}

/**
* Send multiple requests simultaneously
*
Expand Down Expand Up @@ -410,6 +524,20 @@ protected function setup_handle($url, $headers, $data, $options) {
curl_setopt($this->handle, CURLOPT_WRITEFUNCTION, array($this, 'stream_body'));
curl_setopt($this->handle, CURLOPT_BUFFERSIZE, Requests::BUFFER_SIZE);
}

if (isset($options['verify'])) {
if ($options['verify'] === false) {
curl_setopt($this->handle, CURLOPT_SSL_VERIFYHOST, 0);
curl_setopt($this->handle, CURLOPT_SSL_VERIFYPEER, 0);
}
elseif (is_string($options['verify'])) {
curl_setopt($this->handle, CURLOPT_CAINFO, $options['verify']);
}
}

if (isset($options['verifyname']) && $options['verifyname'] === false) {
curl_setopt($this->handle, CURLOPT_SSL_VERIFYHOST, 0);
}
}

/**
Expand Down
129 changes: 129 additions & 0 deletions tests/Transport/cURL.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,135 @@ public function testExpiredHTTPS() {
parent::testExpiredHTTPS();
}

public function testPoolMultiple() {
$requests = array(
'test1' => array(
'url' => httpbin('/get'),
),
'test2' => array(
'url' => httpbin('/get'),
),
);
$responses = Requests::request_pool($requests, $this->getOptions());

// test1
$this->assertNotEmpty($responses['test1']);
$this->assertInstanceOf('Requests_Response', $responses['test1']);
$this->assertSame(200, $responses['test1']->status_code);

$result = json_decode($responses['test1']->body, true);
$this->assertSame(httpbin('/get'), $result['url']);
$this->assertEmpty($result['args']);

// test2
$this->assertNotEmpty($responses['test2']);
$this->assertInstanceOf('Requests_Response', $responses['test2']);
$this->assertSame(200, $responses['test2']->status_code);

$result = json_decode($responses['test2']->body, true);
$this->assertSame(httpbin('/get'), $result['url']);
$this->assertEmpty($result['args']);
}

public function testPoolWithDifferingMethods() {
$requests = array(
'get' => array(
'url' => httpbin('/get'),
),
'post' => array(
'url' => httpbin('/post'),
'type' => Requests::POST,
'data' => 'test',
),
);
$responses = Requests::request_pool($requests, $this->getOptions());

// get
$this->assertSame(200, $responses['get']->status_code);

// post
$this->assertSame(200, $responses['post']->status_code);
$result = json_decode($responses['post']->body, true);
$this->assertSame('test', $result['data']);
}

public function testPoolUsingCallbackAndFailure() {
$requests = array(
'success' => array(
'url' => httpbin('/get'),
),
'timeout' => array(
'url' => httpbin('/delay/10'),
'options' => array(
'timeout' => 1,
),
),
);
$this->completed = array();
$options = array(
'complete' => array($this, 'completeCallback'),
);
$responses = Requests::request_pool($requests, $this->getOptions($options));

$this->assertSame($this->completed, $responses);
$this->completed = array();
}

public function testPoolUsingCallback() {
$requests = array(
'get' => array(
'url' => httpbin('/get'),
),
'post' => array(
'url' => httpbin('/post'),
'type' => Requests::POST,
'data' => 'test',
),
);
$this->completed = array();
$options = array(
'complete' => array($this, 'completeCallback'),
);
$responses = Requests::request_pool($requests, $this->getOptions($options));

$this->assertSame($this->completed, $responses);
$this->completed = array();
}

public function testPoolToFile() {
$requests = array(
'get' => array(
'url' => httpbin('/get'),
'options' => array(
'filename' => tempnam(sys_get_temp_dir(), 'RLT'), // RequestsLibraryTest
),
),
'post' => array(
'url' => httpbin('/post'),
'type' => Requests::POST,
'data' => 'test',
'options' => array(
'filename' => tempnam(sys_get_temp_dir(), 'RLT'), // RequestsLibraryTest
),
),
);
Requests::request_pool($requests, $this->getOptions());

// GET request
$contents = file_get_contents($requests['get']['options']['filename']);
$result = json_decode($contents, true);
$this->assertSame(httpbin('/get'), $result['url']);
$this->assertEmpty($result['args']);
unlink($requests['get']['options']['filename']);

// POST request
$contents = file_get_contents($requests['post']['options']['filename']);
$result = json_decode($contents, true);
$this->assertSame(httpbin('/post'), $result['url']);
$this->assertSame('test', $result['data']);
unlink($requests['post']['options']['filename']);
}

public function testRevokedHTTPS() {
$this->expectException('Requests_Exception');
$this->expectExceptionMessage('certificate subject name');
Expand Down