understand / understand-laravel5

src/Understand/UnderstandLaravel5/FieldProvider.php

<?php namespace Understand\UnderstandLaravel5;

use Illuminate\Support\Arr;
use Illuminate\Support\Str;
use Understand\UnderstandLaravel5\UniqueProcessIdentifier;
use \Illuminate\Session\Store AS SessionStore;
use \Illuminate\Routing\Router;
use Illuminate\Http\Request;
use Illuminate\Foundation\Application;

class FieldProvider
{

    /**
     * The registered field providers.
     *
     * @var array
     */
    protected $providers = [];

    /**
     * Default field
     *
     * @var array
     */
    protected $defaultProviders = [
        'getSessionId',
        'getRouteName',
        'getUrl',
        'getRequestMethod',
        'getServerIp',
        'getClientIp',
        'getClientUserAgent',
        'getEnvironment',
        'getFromSession',
        'getProcessIdentifier',
        'getUserId',
        'getGroupId',
        'getLaravelVersion',
        'getSqlQueries',
        'getArtisanCommandName',
        'getRunningInConsole',
        'getLoggerVersion',
        'getPostDataArray',
        'getQueryStringArray',
    ];

    /**
     * Session store
     *
     * @var \Illuminate\Session\Store
     */
    protected $session;

    /**
     * Router
     *
     * @var Router
     */
    protected $router;

    /**
     * Server variable
     *
     * @var Request
     */
    protected $request;

    /**
     * Token provider
     *
     * @var UniqueProcessIdentifier
     */
    protected $tokenProvider;

    /**
     * Current environment
     *
     * @var string
     */
    protected $environment;

    /**
     * @var DataCollector
     */
    protected $dataCollector;

    /**
     * @var Application
     */
    protected $app;

    /**
     * @return void

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

     */
    public function __construct()
    {
        foreach ($this->defaultProviders as $defaultProviderName)
        {
            $this->extend($defaultProviderName, [$this, $defaultProviderName]);
        }
    }

    /**
     * @param Application $app
     */
    public function setApp(Application $app)
    {
        $this->app = $app;
    }

    /**
     * Set session store
     *
     * @param type $service
     */
    public function setSessionStore(SessionStore $service)
    {
        $this->session = $service;
    }

    /**
     * Set router
     *
     * @param Router $router
     */
    public function setRouter(Router $router)
    {
        $this->router = $router;
    }

    /**
     * Set request
     *
     * @param Request $request
     */
    public function setRequest(Request $request)

You have injected the Request via parameter $request. This is generally not recommended as there might be multiple instances during a request cycle (f.e. when using sub-requests). Instead, it is recommended to inject the RequestStack and retrieve the current request each time you need it via getCurrentRequest().

    {
        $this->request = $request;
    }

    /**
     * Set current environment
     *
     * @param string $environment
     */
    public function setEnvironment($environment)
    {
        $this->environment = $environment;
    }

    /**
     * @param DataCollector $dataCollector
     */
    public function setDataCollector(DataCollector $dataCollector)
    {
        $this->dataCollector = $dataCollector;
    }

    /**
     * Register a custom HTML macro.
     *
     * @param string $name
     * @param  mixed  $macro

There is no parameter named $macro. Was it maybe removed?

     * @return void
     */
    public function extend($name, $provider)
    {
        $this->providers[$name] = $provider;
    }

    /**
     * Set token provider
     *
     * @param UniqueProcessIdentifier $tokenProvider
     */
    public function setTokenProvider(TokenProvider $tokenProvider)
    {
        $this->tokenProvider = $tokenProvider;

It seems like $tokenProvider of type object<Understand\UnderstandLaravel5\TokenProvider> is incompatible with the declared type object<Understand\UnderstandLaravel5\UniqueProcessIdentifier> of property $tokenProvider.

    }

    /**
     * Return resolved field-value array
     *
     * @param array $callbacks
     * @param array $log
     * @return array
     */
    public function resolveValues(array $callbacks, array $log)
    {
        $data = [];

        foreach ($callbacks as $fieldName => $caller)
        {
            if (!is_array($caller))
            {
                $caller = [$caller];
            }

            $callback = Arr::get($caller, 0);
            $args = [$log];

            $value = call_user_func_array($callback, $args);

            $data[$fieldName] = $value;
        }

        return $data;
    }

    /**
     * Handle class calls
     *
     * @param string $name
     * @param  mixed $params
     * @return mixed
     *
     * @throws \BadMethodCallException
     */
    public function __call($name, $params)
    {
        if (isset($this->providers[$name]))
        {
            return call_user_func_array($this->providers[$name], $params);
        }

        throw new \BadMethodCallException("Method {$name} does not exist.");
    }

    /**
     * Return hashed version of session id
     *
     * @return string
     */
    protected function getSessionId()
    {
        if ( ! $this->session)
        {
            return null;
        }

        $sessionId = $this->session->getId();

        // by default we provide only hashed version of session id
        $hashed = sha1($sessionId);

        return $hashed;
    }

    /**
     * @return string
     */
    protected function getLaravelVersion()
    {
        return Application::VERSION;
    }

    /**
     * @return array
     */
    protected function getSqlQueries()
    {
        if ( ! $this->dataCollector)
        {
            return [];
        }

        $queries = $this->dataCollector->getByKey('sql_queries');

        if ( ! $queries)
        {
            return null;
        }

        $bindingsEnabled = $this->app['config']->get('understand-laravel.sql_bindings');

        foreach($queries as $key => $queryArray)
        {
            if ($bindingsEnabled)
            {
                $queries[$key]['query'] = $this->mergeBindings($queryArray);
            }

            unset($queries[$key]['bindings']);
        }

        return $queries;
    }

    /**
     * @param $queryArray
     * @return mixed
     */
    protected function mergeBindings($queryArray)
    {
        $sqlQuery = $queryArray['query'];
        $placeholder = '?';

        foreach($queryArray['bindings'] as $key => $value)
        {
            try
            {
                if ($value instanceof \DateTimeInterface)
                {
                    $binding = $value->format('Y-m-d H:i:s');
                }
                elseif (is_bool($value))
                {
                    $binding = (int) $value;
                }
                else
                {
                    $binding = (string)$value;
                }
            }
            catch (\Exception $e)
            {
                $binding = '[handler error]';
            }

            $position = strpos($sqlQuery, $placeholder);

            if ($position !== false)
            {
                $sqlQuery = substr_replace($sqlQuery, $binding, $position, strlen($placeholder));
            }
        }

        return $sqlQuery;
}

    /**
     * Return current route name
     *
     * @return string
     */
    protected function getRouteName()
    {
        if ( ! $this->router)
        {
            return null;
        }

        return $this->router->getCurrentRoute()->getName();
    }

    /**
     * Return current url
     *
     * @return string
     */
    protected function getUrl()
    {
        if ( ! $this->request)
        {
            return null;
        }

        $url = $this->request->path();

        if ( ! Str::startsWith($url, '/'))
        {
            $url = '/' . $url;
        }

        return $url;
    }

    /**
     * @return array|null
     */
    protected function getQueryStringArray()
    {
        $enabled = $this->app['config']->get('understand-laravel.query_string_enabled');

        if ( ! $enabled)
        {
            return null;
        }

        if ( ! $this->request->query instanceof \IteratorAggregate)
        {
            return null;
        }

        $queryString = [];

        foreach($this->request->query as $key => $value)
        {
            try
            {
                $queryString[$key] = $this->parseRequestFieldValue($key, $value);
            }
            catch (\Exception $e)
            {
                $queryString[$key] = '[handler error]';
            }
        }

        return $queryString;
    }

    /**
     * @return array|null
     */
    protected function getPostDataArray()
    {
        $enabled = $this->app['config']->get('understand-laravel.post_data_enabled');

        if ( ! $enabled)
        {
            return null;
        }

        // Laravel merge and update the symphony `request` property that should hold only POST data
        // by checking if the request method is not GET or HEAD we can decide whether to use it or not
        if (in_array($this->request->getRealMethod(), ['GET', 'HEAD']))
        {
            return null;
        }

        $source = null;

$source is not used, you could remove the assignment.

        if (method_exists($this->request, 'json') && method_exists($this->request, 'isJson') && $this->request->isJson())
        {
            $source = $this->request->json();
        }
        else if ($this->request->request instanceof \IteratorAggregate)
        {
            $source = $this->request->request;
        }
        else
        {
            return;
        }

        if ( ! $source)
        {
            return;
        }

        $postData = [];

        foreach($source as $key => $value)
        {
            try
            {
                $postData[$key] = $this->parseRequestFieldValue($key, $value);
            }
            catch (\Exception $e)
            {
                $postData[$key] = '[handler error]';
            }
        }

        return $postData;
    }

    /**
     * @param $key
     * @param $value
     * @return mixed|string
     */
    protected function parseRequestFieldValue($key, $value)
    {
        $hiddenFields = $this->app['config']->get('understand-laravel.hidden_fields', []);

        if (in_array($key, $hiddenFields))
        {
            return '[value hidden]';
        }

        if (is_scalar($value))
        {
            return $value;
        }

        if (is_array($value))
        {
            return print_r($value, true);
        }

        if (is_object($value))
        {
            return get_class($value);
        }

        return (string)$value;
    }

    /**
     * Return request method
     *
     * @return string
     */
    protected function getRequestMethod()
    {
        if ( ! $this->request)
        {
            return null;
        }

        return $this->request->method();
    }

    /**
     * Return server ip address
     *
     * @return string
     */
    protected function getServerIp()
    {
        if ( ! $this->request)
        {
            return null;
        }

        return $this->request->server->get('SERVER_ADDR');
    }

    /**
     * Return client ip
     *
     * @return string
     */
    protected function getClientIp()
    {
        if ( ! $this->request)
        {
            return null;
        }

        return $this->request->getClientIp();
    }

    /**
     * Return client user agent string
     *
     * @return string
     */
    protected function getClientUserAgent()
    {
        if ( ! $this->request)
        {
            return null;
        }

        return $this->request->server->get('HTTP_USER_AGENT');
    }

    /**
     * Return current enviroment
     *
     * @return string
     */
    protected function getEnvironment()
    {
        return $this->environment;
    }

    /**
     * Retrive parameter from current session
     *
     * @param string $key
     * @return string
     */
    protected function getFromSession($key)
    {
        if ( ! $this->session)
        {
            return null;
        }

        return $this->session->get($key);
    }

    /**
     * Return group id
     *
     * @param array $log
     * @return string
     */
    protected function getGroupId(array $log)
    {
        $parts = [];

        foreach(['class', 'file', 'line', 'code'] as $field)
        {
            // only include `code` if it's not null value
            // the `code` attribute of the exception object is useful to differentiate SQL and other exceptions
            //
            // https://www.php.net/manual/en/exception.getcode.php
            // https://www.php.net/manual/en/pdo.errorinfo.php
            // https://docs.oracle.com/cd/E15817_01/appdev.111/b31228/appd.htm
            if ($field == 'code' && empty($log[$field]))
            {
                continue;
            }

            $parts[] = isset($log[$field]) ? (string)$log[$field] : null;
        }

        return sha1(implode('#', $parts));
    }

    /**
     * Return current active user id
     *
     * @return int
     */
    protected function getUserId()
    {
        try
        {
            if (class_exists('\Auth') && ($userId = \Auth::id()))
            {
                return $userId;
            }
        }
        catch (\Throwable $e)

Consider adding a comment why this CATCH block is empty.

The class Throwable does not exist. Did you forget a USE statement, or did you not list all dependencies?

        {}
        catch (\Exception $e)

Consider adding a comment why this CATCH block is empty.

        {}

        try
        {
            if (class_exists('\Sentinel') && ($user = \Sentinel::getUser()))
            {
                return $user->id;
            }
        }
        catch (\Throwable $e)

Consider adding a comment why this CATCH block is empty.

The class Throwable does not exist. Did you forget a USE statement, or did you not list all dependencies?

        {}
        catch (\Exception $e)

Consider adding a comment why this CATCH block is empty.

        {}

        try
        {
            if (class_exists('\Sentry') && ($user = \Sentry::getUser()))
            {
                return $user->id;
            }
        }
        catch (\Throwable $e)

Consider adding a comment why this CATCH block is empty.

The class Throwable does not exist. Did you forget a USE statement, or did you not list all dependencies?

        {}
        catch (\Exception $e)

Consider adding a comment why this CATCH block is empty.

        {}
    }

    /**
     * @return string
     */
    protected function getArtisanCommandName()
    {
        if ($this->app->runningInConsole() && isset($_SERVER['argv']))
        {
            return implode(' ', $_SERVER['argv']);
        }
    }

    /**
     * @return bool
     */
    protected function getRunningInConsole()
    {
        return $this->app->runningInConsole();
    }

    /**
     * @return float
     */
    protected function getLoggerVersion()
    {
        return Logger::VERSION;
    }

    /**
     * Return process identifier token
     *
     * @return string
     */
    protected function getProcessIdentifier()
    {
        return $this->tokenProvider->getToken();
    }

}