App\Commands\Ngrok\Open

Complexity

Total Complexity

10

Size/Duplication

Total Lines	82
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	2
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
B	handle()	0	38	7
A	checkItWillResolveProperly()	0	14	3

<?php

namespace App\Commands\Ngrok;

use App\Porter;
use App\Models\Site;
use App\Commands\BaseCommand;
use App\Support\Mechanics\Mechanic;
use App\Support\Mechanics\Exceptions\UnableToRetrieveIP;

class Open extends BaseCommand
{
    /**
     * The signature of the command.
     *
     * @var string
     */
    protected $signature = 'ngrok {site?} {--region=eu} {--no-inspection}';

    /**
     * The description of the command.
     *
     * @var string
     */
    protected $description = 'Open ngrok connection to forward your dev environment to an external url';

    /**
     * Execute the console command.
     *
     * @return void
     */
    public function handle(): void
    {
        $site = Site::resolveFromPathOrCurrentWorkingDirectory($this->argument('site'));

It seems like $this->argument('site') can also be of type array; however, parameter $path of App\Models\Site::resolveFromPathOrCurrentWorkingDirectory() does only seem to accept null|string, maybe add an additional type check?

        $wasSecure = false;

        if (! $site) {
            $this->error('No site at this location, and no site path provided.');
            return;
        }

        if (! $this->checkItWillResolveProperly()) {
            return;
        }

        if ($site->secure) {
            $this->info('Removing SSL for site (required for free ngrok version)');
            $site->unsecure();
            $wasSecure = true;
        }

        app(Porter::class)->stop('ngrok');

        $tls = ' -bind-tls='.($wasSecure ? 'true' : 'false');
        $region = ' -region='. $this->option('region');
        $inspect = ' -inspect='.($this->option('no-inspection') ? 'false' : 'true');

        $this->dockerCompose
            ->runContainer('ngrok')
            ->append("ngrok http -host-header=rewrite{$region}{$tls}{$inspect} {$site->url}:80")
            ->interactive()
            ->perform();

        if ($wasSecure) {
            $this->info('Restoring SSL for site');
            $site->secure();
        }

        app(Porter::class)->stop('ngrok');
    }

    /**
     * Checking that Porter is using the dns:set-host IP. If we don't ngrok
     * requests will only resolve to 127.0.0.1 which is internal to the
     * ngrok container, and results in a useless 502 error.
     *
     * @return bool
     */
    public function checkItWillResolveProperly()
    {
        try {
            if (app(Mechanic::class)->isUsingDefaultHostAddress()) {
                $this->info('You need to use an alternative loopback address.');
                $this->info('Please run porter dns:set-host and review the documentation here: https://github.com/konsulting/porter#dns');
                return false;
            }
        } catch (UnableToRetrieveIP $e) {
            $this->info('Please run porter dns:flush and try again. You may need to give it a little while.');
            return false;
        }

        return true;
    }
}