SyncFlatten::withoutTruncate() - Code Metrics - Inspection of "Fix multithread scripts" - Distilleries/Laravel-Contentful-Utilities - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a1d0a8...328e45 )

by Maxime

created 2018-08-13 12:10 UTC

SyncFlatten::withoutTruncate() A

↳ Parent: SyncFlatten

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
cc	2
nc	2
nop	0
dl	0
loc	5
ccs	0
cts	5
cp	0
crap	6
rs	10
c	0
b	0
f	0

<?php

namespace Distilleries\Contentful\Commands\Sync;

use Distilleries\Contentful\Models\Release;
use stdClass;
use Exception;
use Illuminate\Console\Command;
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\DB;
use Distilleries\Contentful\Models\Locale;
use Symfony\Component\Console\Helper\ProgressBar;
use Distilleries\Contentful\Repositories\AssetsRepository;
use Distilleries\Contentful\Repositories\EntriesRepository;

class SyncFlatten extends Command
{
    use Traits\SyncTrait;

    /**
     * Number of entries to fetch per pagination.
     *
     * @var integer
     */
    const PER_BATCH = 50;

    /**
     * {@inheritdoc}
     */
    protected $signature = 'contentful:sync-flatten {--preview} {--no-switch} {--no-truncate} {--multi}';

    /**
     * {@inheritdoc}
     */
    protected $description = 'Map and persist previously synced Contentful data';

    /**
     * Assets repository instance.
     *
     * @var \Distilleries\Contentful\Repositories\AssetsRepository
     */
    protected $assets;

    /**
     * Entries repository instance.
     *
     * @var \Distilleries\Contentful\Repositories\EntriesRepository
     */
    protected $entries;

    /**
     * MapEntries command constructor.
     *
     * @return void

     */
    public function __construct()
    {
        parent::__construct();

        $this->assets = new AssetsRepository;

        $this->entries = new EntriesRepository;
    }

    protected function canSwitch(): bool
    {
        $bool = $this->option('no-switch');
        return !empty($bool) ? false : true;
    }

    protected function withoutTruncate(): bool
    {
        $bool = $this->option('no-truncate');
        return !empty($bool) ? true : false;
    }

    protected function isPreview(): bool
    {
        $bool = $this->option('preview');
        return !empty($bool) ? true : false;
    }

    protected function isMultiThread(): bool
    {
        $bool = $this->option('multi');
        return !empty($bool) ? true : false;
    }

    /**
     * Execute the console command.
     *
     * @return void
     */
    public function handle(Release $release)
    {
        $isPreview = $this->isPreview();

        if ($this->canSwitch()) {
            $this->call('contentful:sync-switch', $isPreview ? ['--preview'=>true] : []);
        }

        if ($isPreview) {
            use_contentful_preview();
        }

        if (!$this->withoutTruncate()) {
            $this->line('Truncate Contentful related tables');
            $this->assets->truncateRelatedTables();
            $this->entries->truncateRelatedTables();
        }

        try {
            $this->line('Map and persist synced data');
            if($this->isMultiThread()){
                $release = $this->getCurrentRelease($release);
                $this->flattenSyncedDataMultiThread($release);
            }else{
                $this->flattenSyncedData();
            }


        } catch (Exception $e) {
            echo PHP_EOL;
            $this->error($e->getMessage());
            return;
        }

        if ($this->canSwitch()) {
            $this->call('contentful:sync-switch', $isPreview ? ['--preview'=>true, '--live'=>true] : ['--live'=>true]);
        }
    }

    /**
     * Map and persist synced data.
     *
     * @return void
     * @throws \Exception
     */
    protected function flattenSyncedData()
    {
        $page = 1;
        $paginator = DB::table('sync_entries')->paginate(static::PER_BATCH, ['*'], 'page', $page);
        $locales = Locale::all();

        $bar = $this->createProgressBar($paginator->total());
        while ($paginator->isNotEmpty()) {
            foreach ($paginator->items() as $item) {
                $bar->setMessage('Map entry ID: ' . $item->contentful_id);
                $this->mapItemToContentfulModel($item, $locales);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
                $bar->advance();
            }

            $page++;
            $paginator = DB::table('sync_entries')->paginate(static::PER_BATCH, ['*'], 'page', $page);
        }
        $bar->finish();

        echo PHP_EOL;
    }

    protected function flattenSyncedDataMultiThread(Release $release)
    {

        $locales = Locale::all();
        $bar = $this->createProgressBar(DB::table('sync_entries')->count());

        try {
            $this->updateFromOtherThread($bar);
            $items = collect();

            DB::transaction(function () use ($release, & $items) {
                $items = DB::table('sync_entries')
                    ->whereNull('release_id')
                    ->take(static::PER_BATCH)
                    ->lockForUpdate()
                    ->get();

                DB::table('sync_entries')
                    ->whereIn('contentful_id', $items->pluck('contentful_id')->toArray())
                    ->lockForUpdate()
                    ->update(['release_id' => $release->getKey()]);
            });
        } catch (Exception $e) {
            //
        }

        $items->each(function ($item, $key) use ($locales, $bar) {
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
            $bar->setMessage('Map entry ID: ' . $item->contentful_id);
            $this->mapItemToContentfulModel($item, $locales);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
            $bar->advance();
        });

        $bar->finish();

    }

    /**
     * Update progress from other threads.
     *
     * @return void
     */
    protected function updateFromOtherThread($bar)
    {
        $bar->setProgress((DB::table('sync_entries'))->whereNotNull('release_id')->count());
    }

    /**
     * Get current release.
     *
     */
    protected function getCurrentRelease(Release $release)
    {
        return $release->where('current', true)->get()->first();
    }

    /**
     * Create custom progress bar.
     *
     * @param  integer $total
     * @return \Symfony\Component\Console\Helper\ProgressBar
     */
    protected function createProgressBar(int $total): ProgressBar
    {
        $bar = $this->output->createProgressBar($total);

        $bar->setFormat("%message%" . PHP_EOL . " %current%/%max% [%bar%] %percent:3s%%");

        return $bar;
    }

    /**
     * Map and persist given sync_entries item.
     *
     * @param  \stdClass $item
     * @param \Illuminate\Support\Collection $locales
     * @return void
     * @throws \Exception
     */
    protected function mapItemToContentfulModel(stdClass $item, Collection $locales)
    {
        $entry = json_decode($item->payload, true);

        if ($item->contentful_type === 'asset') {
            $this->assets->toContentfulModel($entry, $locales);
        } else {
            $this->entries->toContentfulModel($entry, $locales);
        }
    }
}


1			<?php
2
3			namespace Distilleries\Contentful\Commands\Sync;
4
5			use Distilleries\Contentful\Models\Release;
6			use stdClass;
7			use Exception;
8			use Illuminate\Console\Command;
9			use Illuminate\Support\Collection;
10			use Illuminate\Support\Facades\DB;
11			use Distilleries\Contentful\Models\Locale;
12			use Symfony\Component\Console\Helper\ProgressBar;
13			use Distilleries\Contentful\Repositories\AssetsRepository;
14			use Distilleries\Contentful\Repositories\EntriesRepository;
15
16			class SyncFlatten extends Command
17			{
18			use Traits\SyncTrait;
19
20			/**
21			* Number of entries to fetch per pagination.
22			*
23			* @var integer
24			*/
25			const PER_BATCH = 50;
26
27			/**
28			* {@inheritdoc}
29			*/
30			protected $signature = 'contentful:sync-flatten {--preview} {--no-switch} {--no-truncate} {--multi}';
31
32			/**
33			* {@inheritdoc}
34			*/
35			protected $description = 'Map and persist previously synced Contentful data';
36
37			/**
38			* Assets repository instance.
39			*
40			* @var \Distilleries\Contentful\Repositories\AssetsRepository
41			*/
42			protected $assets;
43
44			/**
45			* Entries repository instance.
46			*
47			* @var \Distilleries\Contentful\Repositories\EntriesRepository
48			*/
49			protected $entries;
50
51			/**
52			* MapEntries command constructor.
53			*
54			* @return void
			0 ignored issues – show Comprehensibility Best Practice introduced 2018-07-10 09:53 UTC by Report Bug Copy Issue Report Adding a `@return` annotation to constructors is generally not recommended as a constructor does not have a meaningful return value. Adding a `@return` annotation to a constructor is not recommended, since a constructor does not have a meaningful return value. Please refer to the PHP core documentation on constructors. Loading history...
55			*/
56			public function __construct()
57			{
58			parent::__construct();
59
60			$this->assets = new AssetsRepository;
61
62			$this->entries = new EntriesRepository;
63			}
64
65			protected function canSwitch(): bool
66			{
67			$bool = $this->option('no-switch');
68			return !empty($bool) ? false : true;
69			}
70
71			protected function withoutTruncate(): bool
72			{
73			$bool = $this->option('no-truncate');
74			return !empty($bool) ? true : false;
75			}
76
77			protected function isPreview(): bool
78			{
79			$bool = $this->option('preview');
80			return !empty($bool) ? true : false;
81			}
82
83			protected function isMultiThread(): bool
84			{
85			$bool = $this->option('multi');
86			return !empty($bool) ? true : false;
87			}
88
89			/**
90			* Execute the console command.
91			*
92			* @return void
93			*/
94			public function handle(Release $release)
95			{
96			$isPreview = $this->isPreview();
97
98			if ($this->canSwitch()) {
99			$this->call('contentful:sync-switch', $isPreview ? ['--preview'=>true] : []);
100			}
101
102			if ($isPreview) {
103			use_contentful_preview();
104			}
105
106			if (!$this->withoutTruncate()) {
107			$this->line('Truncate Contentful related tables');
108			$this->assets->truncateRelatedTables();
109			$this->entries->truncateRelatedTables();
110			}
111
112			try {
113			$this->line('Map and persist synced data');
114			if($this->isMultiThread()){
115			$release = $this->getCurrentRelease($release);
116			$this->flattenSyncedDataMultiThread($release);
117			}else{
118			$this->flattenSyncedData();
119			}
120
121
122			} catch (Exception $e) {
123			echo PHP_EOL;
124			$this->error($e->getMessage());
125			return;
126			}
127
128			if ($this->canSwitch()) {
129			$this->call('contentful:sync-switch', $isPreview ? ['--preview'=>true, '--live'=>true] : ['--live'=>true]);
130			}
131			}
132
133			/**
134			* Map and persist synced data.
135			*
136			* @return void
137			* @throws \Exception
138			*/
139			protected function flattenSyncedData()
140			{
141			$page = 1;
142			$paginator = DB::table('sync_entries')->paginate(static::PER_BATCH, ['*'], 'page', $page);
143			$locales = Locale::all();
144
145			$bar = $this->createProgressBar($paginator->total());
146			while ($paginator->isNotEmpty()) {
147			foreach ($paginator->items() as $item) {
148			$bar->setMessage('Map entry ID: ' . $item->contentful_id);
149			$this->mapItemToContentfulModel($item, $locales);
			0 ignored issues – show Bug introduced 2018-07-13 15:05 UTC by Report Bug Copy Issue Report It seems like `$locales` defined by `\Distilleries\Contentful\Models\Locale::all()` on line `143` can also be of type `array<integer,object<Ill...base\Eloquent\Builder>>`; however, `Distilleries\Contentful\...ItemToContentfulModel()` does only seem to accept `object<Illuminate\Support\Collection>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
150			$bar->advance();
151			}
152
153			$page++;
154			$paginator = DB::table('sync_entries')->paginate(static::PER_BATCH, ['*'], 'page', $page);
155			}
156			$bar->finish();
157
158			echo PHP_EOL;
159			}
160
161			protected function flattenSyncedDataMultiThread(Release $release)
162			{
163
164			$locales = Locale::all();
165			$bar = $this->createProgressBar(DB::table('sync_entries')->count());
166
167			try {
168			$this->updateFromOtherThread($bar);
169			$items = collect();
170
171			DB::transaction(function () use ($release, & $items) {
172			$items = DB::table('sync_entries')
173			->whereNull('release_id')
174			->take(static::PER_BATCH)
175			->lockForUpdate()
176			->get();
177
178			DB::table('sync_entries')
179			->whereIn('contentful_id', $items->pluck('contentful_id')->toArray())
180			->lockForUpdate()
181			->update(['release_id' => $release->getKey()]);
182			});
183			} catch (Exception $e) {
184			//
185			}
186
187			$items->each(function ($item, $key) use ($locales, $bar) {
			1 ignored issue – show Bug introduced 2018-08-13 10:12 UTC by Report Bug Copy Issue Report The variable `$items` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history... Unused Code introduced 2018-08-13 10:12 UTC by Report Bug Copy Issue Report The parameter `$key` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
188			$bar->setMessage('Map entry ID: ' . $item->contentful_id);
189			$this->mapItemToContentfulModel($item, $locales);
			0 ignored issues – show Bug introduced 2018-08-13 10:12 UTC by Report Bug Copy Issue Report It seems like `$locales` defined by `\Distilleries\Contentful\Models\Locale::all()` on line `164` can also be of type `array<integer,object<Ill...base\Eloquent\Builder>>`; however, `Distilleries\Contentful\...ItemToContentfulModel()` does only seem to accept `object<Illuminate\Support\Collection>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
190			$bar->advance();
191			});
192
193			$bar->finish();
194
195			}
196
197			/**
198			* Update progress from other threads.
199			*
200			* @return void
201			*/
202			protected function updateFromOtherThread($bar)
203			{
204			$bar->setProgress((DB::table('sync_entries'))->whereNotNull('release_id')->count());
205			}
206
207			/**
208			* Get current release.
209			*
210			*/
211			protected function getCurrentRelease(Release $release)
212			{
213			return $release->where('current', true)->get()->first();
214			}
215
216			/**
217			* Create custom progress bar.
218			*
219			* @param integer $total
220			* @return \Symfony\Component\Console\Helper\ProgressBar
221			*/
222			protected function createProgressBar(int $total): ProgressBar
223			{
224			$bar = $this->output->createProgressBar($total);
225
226			$bar->setFormat("%message%" . PHP_EOL . " %current%/%max% [%bar%] %percent:3s%%");
227
228			return $bar;
229			}
230
231			/**
232			* Map and persist given sync_entries item.
233			*
234			* @param \stdClass $item
235			* @param \Illuminate\Support\Collection $locales
236			* @return void
237			* @throws \Exception
238			*/
239			protected function mapItemToContentfulModel(stdClass $item, Collection $locales)
240			{
241			$entry = json_decode($item->payload, true);
242
243			if ($item->contentful_type === 'asset') {
244			$this->assets->toContentfulModel($entry, $locales);
245			} else {
246			$this->entries->toContentfulModel($entry, $locales);
247			}
248			}
249			}
250

Distilleries / Laravel-Contentful-Utilities

Push — master ( a1d0a8...328e45 )

SyncFlatten::withoutTruncate() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like