Skip to content

⬆️ Upgrades bugsnag SDK to v3 #69

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

Open
mschadegg wants to merge 1 commit into
base: master
Choose a base branch
from
+42 −43
Open

⬆️ Upgrades bugsnag SDK to v3 #69

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
83 changes: 41 additions & 42 deletions bugsnag.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@
License: GPLv2 or later
*/

use Bugsnag\Client;
use Bugsnag\Handler;
use Bugsnag\ErrorTypes;
use Bugsnag\Report;

class Bugsnag_Wordpress
{
private static $COMPOSER_AUTOLOADER = 'vendor/autoload.php';
Expand All @@ -21,7 +26,7 @@ class Bugsnag_Wordpress
'url' => 'https://github.com/bugsnag/bugsnag-wordpress',
);

private $client;
private Client $client;
private $apiKey;
private $notifySeverities;
private $filterFields;
Expand All @@ -35,7 +40,7 @@ public function __construct()
$this->pluginBase = 'bugsnag/bugsnag.php';

// Run init actions (loading wp user)
add_action('init', array($this, 'initActions'));
add_action('init', array($this, 'registerUser'));

// Load admin actions (admin links and pages)
add_action('admin_menu', array($this, 'adminMenuActions'));
Expand Down Expand Up @@ -75,13 +80,13 @@ private function constructBugsnag()
{
// Activate the bugsnag client
if (!empty($this->apiKey)) {
$this->client = new Bugsnag_Client($this->apiKey);
$this->client = Client::make($this->apiKey);

$this->client->setReleaseStage($this->releaseStage())
->setErrorReportingLevel($this->errorReportingLevel())
->setFilters($this->filterFields());
->setRedactedKeys($this->filterFields());

$this->client->mergeDeviceData(['runtimeVersions' => ['wordpress' => get_bloginfo('version')]]);
$this->client->getConfig()->mergeDeviceData(['runtimeVersions' => ['wordpress' => get_bloginfo('version')]]);

$this->client->setNotifier(self::$NOTIFIER);

Expand All @@ -96,16 +101,15 @@ private function constructBugsnag()

if ($set_error_and_exception_handlers === true) {
// Hook up automatic error handling
set_error_handler(array($this->client, 'errorHandler'));
set_exception_handler(array($this->client, 'exceptionHandler'));
Handler::register($this->client);
}
}
}

private function requireBugsnagPhp()
{
// Bugsnag-php was already loaded by some 3rd-party code, don't need to load it again.
if (class_exists('Bugsnag_Client')) {
if (class_exists('Bugsnag\Client')) {
return true;
}

Expand Down Expand Up @@ -142,7 +146,7 @@ private function errorReportingLevel()

$severities = explode(',', $notifySeverities);
foreach ($severities as $severity) {
$level |= Bugsnag_ErrorTypes::getLevelsForSeverity($severity);
$level |= ErrorTypes::getLevelsForSeverity($severity);
}

return $level;
Expand Down Expand Up @@ -178,35 +182,28 @@ private function releaseStage()
}

// Action hooks
public function initActions()
public function registerUser()
{
// This should be handled on stage of initializing,
// not even adding action if init failed.
//
// Leaving it here for now.
if (empty($this->client)) {
return;
}

// Set the bugsnag user using the current WordPress user if available,
// set as anonymous otherwise.
$user = array();
if (is_user_logged_in()) {
$wp_user = wp_get_current_user();

// Removed checks for !empty($wp_user->display_name), it should not be required.
$user['id'] = $wp_user->user_login;
$user['email'] = $wp_user->user_email;
$user['name'] = $wp_user->display_name;
} else {
$use_unsafe_spoofable_ip_address_getter = apply_filters('bugsnag_use_unsafe_spoofable_ip_address_getter', true);
$user['id'] = $use_unsafe_spoofable_ip_address_getter ?
$this->getClientIpAddressUnsafe() :
$this->getClientIpAddress();
$user['name'] = 'anonymous';
}
$this->client->registerCallback(function(Report $report) {
// Set the bugsnag user using the current WordPress user if available,
// set as anonymous otherwise.
$user = [];

if (is_user_logged_in()) {
$wp_user = wp_get_current_user();
$user['id'] = $wp_user->user_login;
$user['email'] = $wp_user->user_email;
$user['name'] = $wp_user->display_name;
} else {
$use_unsafe_spoofable_ip_address_getter = apply_filters('bugsnag_use_unsafe_spoofable_ip_address_getter', true);
$user['id'] = $use_unsafe_spoofable_ip_address_getter ?
$this->getClientIpAddressUnsafe() :
$this->getClientIpAddress();
$user['name'] = 'anonymous';
}

$this->client->setUser($user);
$report->setUser($user);
});
}

// Unsafe: client can spoof address.
Expand Down Expand Up @@ -289,14 +286,16 @@ public function testBugsnag()
$this->notifySeverities = $_POST['bugsnag_notify_severities'];
$this->filterFields = $_POST['bugsnag_filterfields'];

$this->constructBugsnag();
$this->client->notifyError(
'BugsnagTest',
'Testing bugsnag',
array(
'notifier' => self::$NOTIFIER,
'docs' => array('url' => 'https://docs.bugsnag.com/platforms/php/wordpress/'),
)
function (Report $report) {
$report->setSeverity('info');
$report->setMetaData([
'notifier' => self::$NOTIFIER,
'docs' => array('url' => 'https://docs.bugsnag.com/platforms/php/wordpress/'),
]);
}
);

die();
Expand Down Expand Up @@ -346,7 +345,7 @@ public function __call($method, $arguments)
return call_user_func_array(array($this->client, $method), $arguments);
}

throw new BadMethodCallException(sprintf('Method %s does not exist on %s or Bugsnag_Client', $method, __CLASS__));
throw new BadMethodCallException(sprintf('Method %s does not exist on %s or Bugsnag\Client', $method, __CLASS__));
}
}

Expand Down
2 changes: 1 addition & 1 deletion composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "bugsnag/bugsnag-wordpress",
"type": "wordpress-plugin",
"require": {
"bugsnag/bugsnag": "^2.10.2",
"bugsnag/bugsnag": "^3.30.0",
"composer/installers": "^1.0"
},
"license": "MIT",
Expand Down