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.

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

Catch down network exception and non-object responses in fetch #2492

Merged
merged 5 commits into from
Sep 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
33 changes: 32 additions & 1 deletion src/Collections/TerminusCollection.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,18 @@
use Pantheon\Terminus\Models\TerminusModel;
use Pantheon\Terminus\Request\RequestAwareInterface;
use Pantheon\Terminus\Request\RequestAwareTrait;
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerAwareTrait;

/**
* Class TerminusCollection
* @package Pantheon\Terminus\Collections
*/
abstract class TerminusCollection implements ContainerAwareInterface, RequestAwareInterface
abstract class TerminusCollection implements ContainerAwareInterface, RequestAwareInterface, LoggerAwareInterface
{
use ContainerAwareTrait;
use RequestAwareTrait;
use LoggerAwareTrait;

/**
* @var array
Expand Down Expand Up @@ -91,6 +94,34 @@ public function all()
public function fetch()
{
foreach ($this->getData() as $id => $model_data) {
if (!is_object($model_data)) {
// This should always be an object, however occasionally it is returning as a string
// We need more information about what it is and to handle the error
$model_data_str = print_r($model_data, true);
$error_maxlength = 250;
if (is_string($model_data_str) && strlen($model_data_str) > $error_maxlength) {
$model_data_str = substr($model_data_str, 0, $error_maxlength) . ' ...';
}
$error_message = "Fetch failed {file}:{line} \$model_data expected as object but returned as {type}.";
$error_message .= "\nUnexpected value: {model_data_str}";
$trace = debug_backtrace();
$context = [
'file' => $trace[0]['file'],
'line' => $trace[0]['line'],
'type' => gettype($model_data),
'model_data_str' => $model_data_str
];

// verbose logging for debugging
$this->logger->debug($error_message, $context);

// less information for more user-facing messages, but a problem has occurred and we're skipping this
// item so we should still surface a user-facing message
$this->logger->warning("Model data missing for {id}", ['id' => $id,]);

// skip this item since it lacks useful data
continue;
}
if (!isset($model_data->id)) {
$model_data->id = $id;
}
Expand Down
11 changes: 10 additions & 1 deletion src/Request/Request.php
Original file line number Diff line number Diff line change
Expand Up @@ -244,12 +244,21 @@ private function createRetryDecider(): callable
}
}

// Response can be null if there is a network disconnect. Get a different error message in that case.
if (is_object($response) && is_object($response->getBody()) && $response->getBody()->getContents() !== '') {
jms-pantheon marked this conversation as resolved.
Show resolved Hide resolved
$error = $response->getBody()->getContents();
} elseif (null !== $exception && '' != $exception->getMessage()) {
$error = $exception->getMessage();
} else {
$error = "Undefined";
}

$this->logger->error(
"HTTP request {method} {uri} has failed with error {error}.",
[
'method' => $request->getMethod(),
'uri' => $request->getUri(),
'error' => $response->getBody()->getContents(),
'error' => $error,
]
);

Expand Down
Loading