StartLabelDetection::ensureMimeTypeIsSet() - Code Metrics - Inspection of "wip" - meemalabs/laravel-media-recognition - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 198526...2cbb41 )

by Chris

created 2021-01-02 01:12 UTC

StartLabelDetection::ensureMimeTypeIsSet() A

↳ Parent: StartLabelDetection

Complexity

Conditions	2
Paths	2

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	2
c	0
b	0
f	0
nc	2
nop	0
dl	0
loc	4
rs	10

<?php

namespace Meema\MediaRecognition\Jobs;

use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Bus\Dispatchable;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Queue\SerializesModels;
use Illuminate\Support\Facades\Storage;
use Illuminate\Support\Str;
use Meema\MediaRecognition\Events\FacialAnalysisCompleted;
use Meema\MediaRecognition\Events\LabelAnalysisCompleted;
use Meema\MediaRecognition\Facades\Recognize;

class StartLabelDetection implements ShouldQueue
{
    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;


    private string $path;

    /**
     * $mimeType may be 'image', 'video' or the actual mime type of the file.
     * It allows us to reduce an HTTP request to check for the mime type.
     * If not assigned, it will check the mime type for whether it is an image or a video source.
     *
     * @var string|null
     */
    private ?string $mimeType;

    private ?int $mediaId;

    private ?int $minConfidence;

    private int $maxResults;

    /**
     * Create a new job instance.
     *
     * @param string $path
     * @param string|null $mimeType
     * @param int|null $mediaId
     * @param int|null $minConfidence
     * @param int $maxResults
     */
    public function __construct(string $path, $mimeType = null, $mediaId = null, $minConfidence = null, $maxResults = 1000)
    {
        $this->path = $path;
        $this->mimeType = $mimeType;
        $this->mediaId = $mediaId;
        $this->minConfidence = $minConfidence;
        $this->maxResults = $maxResults;
    }

    /**
     * Execute the job.
     *
     * @return void
     * @throws \Exception
     */
    public function handle()
    {
        $this->ensureMimeTypeIsSet();

        if (Str::contains($this->mimeType, 'image')) {
            $result = Recognize::source($this->path, $this->mimeType)->detectImageLabels($this->mediaId, $this->minConfidence, $this->maxResults);

            // we need to manually fire the event for image analyses because unlike the video analysis,
            // AWS is not sending a webhook upon completion of the image analysis
            event(new LabelAnalysisCompleted($result));

            return;
        }

        if (Str::contains($this->mimeType, 'video')) {
            Recognize::source($this->path, $this->mimeType)->detectVideoLabels($this->mediaId, $this->minConfidence, $this->maxResults);

            return;
        }

        throw new \Exception('$mimeType does neither indicate being a video nor an image');
    }


    protected function ensureMimeTypeIsSet()
    {
        if (is_null($this->mimeType)) {
            $this->mimeType = Storage::disk(config('media-recognition.disk'))->mimeType($this->path);
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
        }
    }
}


1			<?php
2
3			namespace Meema\MediaRecognition\Jobs;
4
5			use Illuminate\Bus\Queueable;
6			use Illuminate\Contracts\Queue\ShouldQueue;
7			use Illuminate\Foundation\Bus\Dispatchable;
8			use Illuminate\Queue\InteractsWithQueue;
9			use Illuminate\Queue\SerializesModels;
10			use Illuminate\Support\Facades\Storage;
11			use Illuminate\Support\Str;
12			use Meema\MediaRecognition\Events\FacialAnalysisCompleted;
13			use Meema\MediaRecognition\Events\LabelAnalysisCompleted;
14			use Meema\MediaRecognition\Facades\Recognize;
15
16			class StartLabelDetection implements ShouldQueue
17			{
18			use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
			0 ignored issues – show introduced 2021-01-02 00:25 UTC by Report Bug Copy Issue Report The trait `Illuminate\Queue\SerializesModels` requires some properties which are not provided by `Meema\MediaRecognition\Jobs\StartLabelDetection`: `$id`, `$relations`, `$class`, `$keyBy` Loading history...
19
20			private string $path;
21
22			/**
23			* $mimeType may be 'image', 'video' or the actual mime type of the file.
24			* It allows us to reduce an HTTP request to check for the mime type.
25			* If not assigned, it will check the mime type for whether it is an image or a video source.
26			*
27			* @var string\|null
28			*/
29			private ?string $mimeType;
30
31			private ?int $mediaId;
32
33			private ?int $minConfidence;
34
35			private int $maxResults;
36
37			/**
38			* Create a new job instance.
39			*
40			* @param string $path
41			* @param string\|null $mimeType
42			* @param int\|null $mediaId
43			* @param int\|null $minConfidence
44			* @param int $maxResults
45			*/
46			public function __construct(string $path, $mimeType = null, $mediaId = null, $minConfidence = null, $maxResults = 1000)
47			{
48			$this->path = $path;
49			$this->mimeType = $mimeType;
50			$this->mediaId = $mediaId;
51			$this->minConfidence = $minConfidence;
52			$this->maxResults = $maxResults;
53			}
54
55			/**
56			* Execute the job.
57			*
58			* @return void
59			* @throws \Exception
60			*/
61			public function handle()
62			{
63			$this->ensureMimeTypeIsSet();
64
65			if (Str::contains($this->mimeType, 'image')) {
66			$result = Recognize::source($this->path, $this->mimeType)->detectImageLabels($this->mediaId, $this->minConfidence, $this->maxResults);
67
68			// we need to manually fire the event for image analyses because unlike the video analysis,
69			// AWS is not sending a webhook upon completion of the image analysis
70			event(new LabelAnalysisCompleted($result));
71
72			return;
73			}
74
75			if (Str::contains($this->mimeType, 'video')) {
76			Recognize::source($this->path, $this->mimeType)->detectVideoLabels($this->mediaId, $this->minConfidence, $this->maxResults);
77
78			return;
79			}
80
81			throw new \Exception('$mimeType does neither indicate being a video nor an image');
82			}
83
84
85			protected function ensureMimeTypeIsSet()
86			{
87			if (is_null($this->mimeType)) {
88			$this->mimeType = Storage::disk(config('media-recognition.disk'))->mimeType($this->path);
			0 ignored issues – show Documentation Bug introduced 2021-01-02 01:25 UTC by Report Bug Copy Issue Report It seems like `Illuminate\Support\Facad...->mimeType($this->path)` can also be of type `false`. However, the property `$mimeType` is declared as type `null\|string`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
89			}
90			}
91			}
92

meemalabs / laravel-media-recognition

Push — master ( 198526...2cbb41 )

StartLabelDetection::ensureMimeTypeIsSet() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like