Skip to content

Add the ability to set a project root #15

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
Stoux wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add the ability to set a project root #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a3ee1d6
Add the configuration option 'project_root'.
Stoux Sep 30, 2019
cd4cb99
Update readme to mention project_root
Stoux Sep 30, 2019
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
44 changes: 42 additions & 2 deletions Helper/Config.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
use Bugsnag\Configuration;
use Magento\Framework\App\DeploymentConfig\Reader;
use Magento\Framework\Config\File\ConfigFilePool;
use Magento\Framework\Filesystem\DirectoryList;

class Config
{
Expand All @@ -19,6 +20,13 @@ class Config
*/
protected $deploymentConfig;

/**
* Magento's directory list used for fetching the root folder
*
* @var DirectoryList
*/
protected $directoryList;

/**
* Full array of data from env.php
*
Expand All @@ -44,12 +52,18 @@ class Config
* Config constructor
*
* @param Reader $deploymentConfig
* @param DirectoryList $directoryList
*
* @throws \Magento\Framework\Exception\FileSystemException
* @throws \Magento\Framework\Exception\RuntimeException
*/
public function __construct(
Reader $deploymentConfig
Reader $deploymentConfig,
DirectoryList $directoryList
)
{
$this->deploymentConfig = $deploymentConfig;
$this->directoryList = $directoryList;
$this->env = $deploymentConfig->load(ConfigFilePool::APP_ENV);
if(isset($this->env['bugsnag'])) {
$this->bugsnagConfig = $this->env['bugsnag'];
Expand All @@ -71,6 +85,12 @@ public function getConfiguration()
if ($releaseStage) {
$this->config->setReleaseStage($releaseStage);
}

$projectRoot = $this->getProjectRoot();
if ($projectRoot) {
$this->config->setProjectRoot($projectRoot);
}

return $this->config;
}
}
Expand Down Expand Up @@ -103,4 +123,24 @@ public function getReleaseStage()
return false;
}

}
/**
* Get the project_root full path from env.php if existent.
*
* This can also be the boolval `true` if it should be resolved using Magento.
*
* @return bool|mixed|string
*/
public function getProjectRoot() {
if (array_key_exists('project_root', $this->bugsnagConfig)) {
$projectRoot = $this->bugsnagConfig['project_root'];
if ($projectRoot === true) {
// The root should be resolved by Magento
return $this->directoryList->getRoot();
} else {

@Stoux Stoux Sep 30, 2019

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought about adding a } if else (is_dir($projectroot)) { check here, but figured this allows more flexibility? Thoughts?

return $projectRoot;
}
}
return false;
}

}
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,13 @@ More information on [Release Stage](https://docs.bugsnag.com/platforms/php/other
...
'release_stage' => 'staging',
...
'project_root' => true || '/path/to/magento',
),

You can set `project_root` to either `true` or the absolute path of the magento installation.
This will cause all paths in Bugsnag to be normalized across deployments and display the errors starting from the magento root.
When the value is set to true it will use Magento's DirectoryList to resolve the root folder. [See documentation on docs.bugsnag.com.](https://docs.bugsnag.com/platforms/php/other/configuration-options/#project-root)

# Support

If you have any issues with this extension, open an issue on [GitHub](https://github.com/Interjar/bugsnag-magento2/issues).
Expand Down