Sign upLogin

arkaitzgarro/elastic-apm-laravel

View on GitHub
Star
src/Collectors/ScheduledTaskCollector.php

Summary

Maintainability
A
2 hrs
Test Coverage
A
96%

Method registerEventListeners has 29 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function registerEventListeners(): void
    {
        $this->app->events->listen(ScheduledTaskStarting::class, function (ScheduledTaskStarting $event) {
            $transaction_name = $this->getTransactionName($event);
            if ($transaction_name) {
Severity: Minor
Found in src/Collectors/ScheduledTaskCollector.php - About 1 hr to fix

    Avoid unused parameters such as '$event'.
    Open

        protected function send($event): void
    Severity: Minor
    Found in src/Collectors/ScheduledTaskCollector.php by phpmd

    UnusedFormalParameter

    Since: 0.2

    Avoid passing parameters to methods or constructors and then not using those parameters.

    Example

    class Foo
{
    private function bar($howdy)
    {
        // $howdy is not used
    }
}

    Source https://phpmd.org/rules/unusedcode.html#unusedformalparameter

    Avoid using static access to class '\Illuminate\Support\Facades\Log' in method 'send'.
    Open

                Log::error($exception, ['api_response' => (string) $exception->getResponse()->getBody()]);
    Severity: Minor
    Found in src/Collectors/ScheduledTaskCollector.php by phpmd

    StaticAccess

    Since: 1.4.0

    Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

    Example

    class Foo
{
    public function bar()
    {
        Bar::baz();
    }
}

    Source https://phpmd.org/rules/cleancode.html#staticaccess

    Avoid using static access to class '\Illuminate\Support\Facades\Log' in method 'send'.
    Open

                Log::error($t->getMessage());
    Severity: Minor
    Found in src/Collectors/ScheduledTaskCollector.php by phpmd

    StaticAccess

    Since: 1.4.0

    Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

    Example

    class Foo
{
    public function bar()
    {
        Bar::baz();
    }
}

    Source https://phpmd.org/rules/cleancode.html#staticaccess

    Identical blocks of code found in 2 locations. Consider refactoring.
    Open

            $transaction->setCustomContext([
            'ran_at' => Carbon::now()->toDateTimeString(),
            'memory' => [
                'peak' => round(memory_get_peak_usage(false) / 1024 / 1024, 2) . 'M',
                'peak_real' => round(memory_get_peak_usage(true) / 1024 / 1024, 2) . 'M',
    Severity: Major
    Found in src/Collectors/ScheduledTaskCollector.php and 1 other location - About 1 hr to fix
    src/Collectors/CommandCollector.php on lines 110..116

    Duplicated Code

    Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

    Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

    When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

    Tuning

    This issue has a mass of 102.

    We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

    The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

    If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

    See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

    Refactorings

    Further Reading

    Identical blocks of code found in 2 locations. Consider refactoring.
    Open

            $this->app->events->listen(ScheduledTaskStarting::class, function (ScheduledTaskStarting $event) {
            $transaction_name = $this->getTransactionName($event);
            if ($transaction_name) {
                $transaction = $this->getTransaction($transaction_name);
                if (!$transaction) {
    Severity: Minor
    Found in src/Collectors/ScheduledTaskCollector.php and 1 other location - About 30 mins to fix
    src/Collectors/CommandCollector.php on lines 25..34

    Duplicated Code

    Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

    Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

    When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

    Tuning

    This issue has a mass of 90.

    We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

    The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

    If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

    See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

    Refactorings

    Further Reading

    The parameter $transaction_name is not named in camelCase.
    Open

        protected function startTransaction(string $transaction_name): Transaction
    {
        return $this->agent->startTransaction(
            $transaction_name,
            [],
    Severity: Minor
    Found in src/Collectors/ScheduledTaskCollector.php by phpmd

    CamelCaseParameterName

    Since: 0.2

    It is considered best practice to use the camelCase notation to name parameters.

    Example

    class ClassName {
    public function doSomething($user_name) {
    }
}

    Source

    The parameter $transaction_name is not named in camelCase.
    Open

        protected function stopTransaction(string $transaction_name, ?int $result): void
    {
        // Stop the transaction and measure the time
        $this->agent->stopTransaction($transaction_name, ['result' => (int) $result]);
        $this->agent->collectEvents($transaction_name);
    Severity: Minor
    Found in src/Collectors/ScheduledTaskCollector.php by phpmd

    CamelCaseParameterName

    Since: 0.2

    It is considered best practice to use the camelCase notation to name parameters.

    Example

    class ClassName {
    public function doSomething($user_name) {
    }
}

    Source

    The variable $transaction_name is not named in camelCase.
    Open

        public function registerEventListeners(): void
    {
        $this->app->events->listen(ScheduledTaskStarting::class, function (ScheduledTaskStarting $event) {
            $transaction_name = $this->getTransactionName($event);
            if ($transaction_name) {
    Severity: Minor
    Found in src/Collectors/ScheduledTaskCollector.php by phpmd

    CamelCaseVariableName

    Since: 0.2

    It is considered best practice to use the camelCase notation to name variables.

    Example

    class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

    Source

    The variable $transaction_name is not named in camelCase.
    Open

        protected function getTransactionName($event): string
    {
        $transaction_name = $event->task instanceof CallbackEvent
            ? $event->task->getSummaryForDisplay()
            : $event->task->command;
    Severity: Minor
    Found in src/Collectors/ScheduledTaskCollector.php by phpmd

    CamelCaseVariableName

    Since: 0.2

    It is considered best practice to use the camelCase notation to name variables.

    Example

    class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

    Source

    The variable $transaction_name is not named in camelCase.
    Open

        public function registerEventListeners(): void
    {
        $this->app->events->listen(ScheduledTaskStarting::class, function (ScheduledTaskStarting $event) {
            $transaction_name = $this->getTransactionName($event);
            if ($transaction_name) {
    Severity: Minor
    Found in src/Collectors/ScheduledTaskCollector.php by phpmd

    CamelCaseVariableName

    Since: 0.2

    It is considered best practice to use the camelCase notation to name variables.

    Example

    class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

    Source

    The variable $transaction_name is not named in camelCase.
    Open

        public function registerEventListeners(): void
    {
        $this->app->events->listen(ScheduledTaskStarting::class, function (ScheduledTaskStarting $event) {
            $transaction_name = $this->getTransactionName($event);
            if ($transaction_name) {
    Severity: Minor
    Found in src/Collectors/ScheduledTaskCollector.php by phpmd

    CamelCaseVariableName

    Since: 0.2

    It is considered best practice to use the camelCase notation to name variables.

    Example

    class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

    Source

    The variable $transaction_name is not named in camelCase.
    Open

        public function registerEventListeners(): void
    {
        $this->app->events->listen(ScheduledTaskStarting::class, function (ScheduledTaskStarting $event) {
            $transaction_name = $this->getTransactionName($event);
            if ($transaction_name) {
    Severity: Minor
    Found in src/Collectors/ScheduledTaskCollector.php by phpmd

    CamelCaseVariableName

    Since: 0.2

    It is considered best practice to use the camelCase notation to name variables.

    Example

    class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

    Source

    The variable $transaction_name is not named in camelCase.
    Open

        public function registerEventListeners(): void
    {
        $this->app->events->listen(ScheduledTaskStarting::class, function (ScheduledTaskStarting $event) {
            $transaction_name = $this->getTransactionName($event);
            if ($transaction_name) {
    Severity: Minor
    Found in src/Collectors/ScheduledTaskCollector.php by phpmd

    CamelCaseVariableName

    Since: 0.2

    It is considered best practice to use the camelCase notation to name variables.

    Example

    class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

    Source

    The variable $transaction_name is not named in camelCase.
    Open

        public function registerEventListeners(): void
    {
        $this->app->events->listen(ScheduledTaskStarting::class, function (ScheduledTaskStarting $event) {
            $transaction_name = $this->getTransactionName($event);
            if ($transaction_name) {
    Severity: Minor
    Found in src/Collectors/ScheduledTaskCollector.php by phpmd

    CamelCaseVariableName

    Since: 0.2

    It is considered best practice to use the camelCase notation to name variables.

    Example

    class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

    Source

    The variable $transaction_name is not named in camelCase.
    Open

        protected function getTransactionName($event): string
    {
        $transaction_name = $event->task instanceof CallbackEvent
            ? $event->task->getSummaryForDisplay()
            : $event->task->command;
    Severity: Minor
    Found in src/Collectors/ScheduledTaskCollector.php by phpmd

    CamelCaseVariableName

    Since: 0.2

    It is considered best practice to use the camelCase notation to name variables.

    Example

    class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

    Source

    The variable $transaction_name is not named in camelCase.
    Open

        public function registerEventListeners(): void
    {
        $this->app->events->listen(ScheduledTaskStarting::class, function (ScheduledTaskStarting $event) {
            $transaction_name = $this->getTransactionName($event);
            if ($transaction_name) {
    Severity: Minor
    Found in src/Collectors/ScheduledTaskCollector.php by phpmd

    CamelCaseVariableName

    Since: 0.2

    It is considered best practice to use the camelCase notation to name variables.

    Example

    class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

    Source

    The variable $transaction_name is not named in camelCase.
    Open

        public function registerEventListeners(): void
    {
        $this->app->events->listen(ScheduledTaskStarting::class, function (ScheduledTaskStarting $event) {
            $transaction_name = $this->getTransactionName($event);
            if ($transaction_name) {
    Severity: Minor
    Found in src/Collectors/ScheduledTaskCollector.php by phpmd

    CamelCaseVariableName

    Since: 0.2

    It is considered best practice to use the camelCase notation to name variables.

    Example

    class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

    Source

    The variable $transaction_name is not named in camelCase.
    Open

        protected function startTransaction(string $transaction_name): Transaction
    {
        return $this->agent->startTransaction(
            $transaction_name,
            [],
    Severity: Minor
    Found in src/Collectors/ScheduledTaskCollector.php by phpmd

    CamelCaseVariableName

    Since: 0.2

    It is considered best practice to use the camelCase notation to name variables.

    Example

    class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

    Source

    The variable $transaction_name is not named in camelCase.
    Open

        protected function stopTransaction(string $transaction_name, ?int $result): void
    {
        // Stop the transaction and measure the time
        $this->agent->stopTransaction($transaction_name, ['result' => (int) $result]);
        $this->agent->collectEvents($transaction_name);
    Severity: Minor
    Found in src/Collectors/ScheduledTaskCollector.php by phpmd

    CamelCaseVariableName

    Since: 0.2

    It is considered best practice to use the camelCase notation to name variables.

    Example

    class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

    Source

    The variable $transaction_name is not named in camelCase.
    Open

        protected function stopTransaction(string $transaction_name, ?int $result): void
    {
        // Stop the transaction and measure the time
        $this->agent->stopTransaction($transaction_name, ['result' => (int) $result]);
        $this->agent->collectEvents($transaction_name);
    Severity: Minor
    Found in src/Collectors/ScheduledTaskCollector.php by phpmd

    CamelCaseVariableName

    Since: 0.2

    It is considered best practice to use the camelCase notation to name variables.

    Example

    class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

    Source

    The variable $transaction_name is not named in camelCase.
    Open

        public function registerEventListeners(): void
    {
        $this->app->events->listen(ScheduledTaskStarting::class, function (ScheduledTaskStarting $event) {
            $transaction_name = $this->getTransactionName($event);
            if ($transaction_name) {
    Severity: Minor
    Found in src/Collectors/ScheduledTaskCollector.php by phpmd

    CamelCaseVariableName

    Since: 0.2

    It is considered best practice to use the camelCase notation to name variables.

    Example

    class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

    Source

    The variable $transaction_name is not named in camelCase.
    Open

        public function registerEventListeners(): void
    {
        $this->app->events->listen(ScheduledTaskStarting::class, function (ScheduledTaskStarting $event) {
            $transaction_name = $this->getTransactionName($event);
            if ($transaction_name) {
    Severity: Minor
    Found in src/Collectors/ScheduledTaskCollector.php by phpmd

    CamelCaseVariableName

    Since: 0.2

    It is considered best practice to use the camelCase notation to name variables.

    Example

    class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

    Source

    The variable $transaction_name is not named in camelCase.
    Open

        protected function getTransactionName($event): string
    {
        $transaction_name = $event->task instanceof CallbackEvent
            ? $event->task->getSummaryForDisplay()
            : $event->task->command;
    Severity: Minor
    Found in src/Collectors/ScheduledTaskCollector.php by phpmd

    CamelCaseVariableName

    Since: 0.2

    It is considered best practice to use the camelCase notation to name variables.

    Example

    class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

    Source

    The variable $transaction_name is not named in camelCase.
    Open

        public function registerEventListeners(): void
    {
        $this->app->events->listen(ScheduledTaskStarting::class, function (ScheduledTaskStarting $event) {
            $transaction_name = $this->getTransactionName($event);
            if ($transaction_name) {
    Severity: Minor
    Found in src/Collectors/ScheduledTaskCollector.php by phpmd

    CamelCaseVariableName

    Since: 0.2

    It is considered best practice to use the camelCase notation to name variables.

    Example

    class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

    Source

    The variable $transaction_name is not named in camelCase.
    Open

        public function registerEventListeners(): void
    {
        $this->app->events->listen(ScheduledTaskStarting::class, function (ScheduledTaskStarting $event) {
            $transaction_name = $this->getTransactionName($event);
            if ($transaction_name) {
    Severity: Minor
    Found in src/Collectors/ScheduledTaskCollector.php by phpmd

    CamelCaseVariableName

    Since: 0.2

    It is considered best practice to use the camelCase notation to name variables.

    Example

    class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

    Source

    There are no issues that match your filters.

    Category
    Status