Distilleries\Contentful\Commands\Sync\SyncFlatten

Complexity

Total Complexity

29

Size/Duplication

Total Lines	236
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	12

Test Coverage

Coverage

0%

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	1
A	canSwitch()	0	5	2
A	withTruncate()	0	5	2
A	isPreview()	0	5	2
A	isMultiThread()	0	5	2
B	handle()	0	40	10
A	flattenSyncedData()	0	21	3
A	flattenSyncedDataMultiThread()	0	35	2
A	updateFromOtherThread()	0	4	1
A	getCurrentRelease()	0	4	1
A	createProgressBar()	0	8	1
A	mapItemToContentfulModel()	0	10	2

<?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} {--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

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

     */
    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 withTruncate(): bool
    {
        $bool = $this->option('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'] : []);
        }

        if ($isPreview) {
            use_contentful_preview();
        }

        if ($this->withTruncate()) {
            $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()) {
            if ($this->canSwitch()) {
                $this->call('contentful:sync-switch', $isPreview ? ['--preview', '--live'] : ['--live']);
            }
        }
    }

    /**
     * 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);

It seems like $locales defined by \Distilleries\Contentful\Models\Locale::all() on line 145 can also be of type array<integer,object<Illuminate\Database\Eloquent\Builder>>; however, Distilleries\Contentful\Commands\Sync\SyncFlatten::mapItemToContentfulModel() does only seem to accept object<Illuminate\Support\Collection>, maybe add an additional type check?

                $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('id', $items->pluck('id')->toArray())
                    ->lockForUpdate()
                    ->update(['release_id' => $release->getKey()]);
            });
        } catch (Exception $e) {
            //
        }

        $items->each(function ($item, $key) use ($locales, $bar) {

The variable $items does not seem to be defined for all execution paths leading up to this point.

The parameter $key is not used and could be removed.

            $bar->setMessage('Map entry ID: ' . $item->contentful_id);
            $this->mapItemToContentfulModel($item, $locales);

It seems like $locales defined by \Distilleries\Contentful\Models\Locale::all() on line 166 can also be of type array<integer,object<Illuminate\Database\Eloquent\Builder>>; however, Distilleries\Contentful\Commands\Sync\SyncFlatten::mapItemToContentfulModel() does only seem to accept object<Illuminate\Support\Collection>, maybe add an additional type check?

            $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);
        }
    }
}