cleanups

speedtest/volumes/config/www/app/Utils/InfluxDB/InfluxDB.php

@@ -0,0 +1,113 @@
+<?php
+
+namespace App\Utils\InfluxDB;
+
+use App\Exceptions\InfluxDBConnectionErrorException;
+use App\Exceptions\InfluxDBNotEnabledException;
+use App\Helpers\SettingsHelper;
+use App\Models\Speedtest;
+use InfluxDB\Client as Version1;
+use InfluxDB2\Client as Version2;
+use App\Interfaces\InfluxDBWrapperInterface as Client;
+
+class InfluxDB
+{
+    private Client $client;
+
+    private string $database;
+
+    public function __construct(Client $client)
+    {
+        $this->client = $client;
+    }
+
+    /**
+     * Connect to influx db
+     *
+     * @param string $host
+     * @param integer $port
+     * @param string $database
+     * @return InfluxDB
+     */
+    public static function connect()
+    {
+        if (!(bool) SettingsHelper::get('influx_db_enabled')->value) {
+            throw new InfluxDBNotEnabledException();
+        }
+
+        $host = SettingsHelper::get('influx_db_host')->value;
+        $port = SettingsHelper::get('influx_db_port')->value;
+        $username = SettingsHelper::get('influx_db_username')->value;
+        $password = SettingsHelper::get('influx_db_password')->value;
+        $database = SettingsHelper::get('influx_db_database')->value;
+        $version = (int) SettingsHelper::get('influx_db_version')->value;
+
+        $wrapper = $version === 1
+            ? new InfluxDBVersion1Wrapper(
+                new Version1(
+                    str_replace(['http://', 'https://'], '', $host),
+                    $port,
+                    $username,
+                    $password
+                )
+            )
+            : new InfluxDBVersion2Wrapper(
+                new Version2([
+                    'url' => $host . ':' . $port,
+                    'token' => '',
+                ])
+            );
+
+        return (new self($wrapper))->setDatabase($database)
+            ->testConnection();
+    }
+
+    /**
+     * Set the database field
+     *
+     * @param string $database
+     * @return InfluxDB
+     */
+    public function setDatabase(string $database): InfluxDB
+    {
+        $this->database = $database;
+
+        return $this;
+    }
+
+    /**
+     * Test the connection
+     *
+     * @throws InfluxDBConnectionErrorException
+     * @return InfluxDB
+     */
+    public function testConnection(): InfluxDB
+    {
+        if (!$this->client->testConnection()) {
+            throw new InfluxDBConnectionErrorException();
+        }
+
+        if (!$this->doesDatabaseExist()) {
+            $this->createDatabase();
+        }
+
+        return $this;
+    }
+
+    public function doesDatabaseExist(): bool
+    {
+        return $this->client->doesDatabaseExist($this->database);
+    }
+
+    public function createDatabase(): bool
+    {
+        return $this->client->createDatabase($this->database);
+    }
+
+    public function store(Speedtest $speedtest): InfluxDB
+    {
+        $this->client->store($speedtest);
+
+        return $this;
+    }
+}

speedtest/volumes/config/www/app/Utils/InfluxDB/InfluxDBVersion1Wrapper.php

@@ -0,0 +1,74 @@
+<?php
+
+namespace App\Utils\InfluxDB;
+
+use App\Interfaces\InfluxDBWrapperInterface;
+use App\Models\Speedtest;
+use Exception;
+use InfluxDB\Client;
+use InfluxDB\Database;
+use InfluxDB\Database\RetentionPolicy;
+use InfluxDB\Point;
+use Log;
+
+class InfluxDBVersion1Wrapper implements InfluxDBWrapperInterface
+{
+    private Client $client;
+    private Database $database;
+
+    public function __construct(Client $client)
+    {
+        $this->client = $client;
+    }
+
+    public function testConnection(): bool
+    {
+        try {
+            $this->client->listDatabases();
+
+            return true;
+        } catch (Exception $e) {
+            Log::error($e);
+
+            return false;
+        }
+    }
+
+    public function doesDatabaseExist(string $database): bool
+    {
+        $this->database = $this->client->selectDB($database);
+
+        return (bool) $this->database->exists();
+    }
+
+    public function createDatabase(string $database): bool
+    {
+        try {
+            $this->database->create(
+                new RetentionPolicy(
+                    'speedtest_retention_policy',
+                    config('services.influxdb.retention'),
+                    1,
+                    true
+                )
+            );
+
+            return true;
+        } catch (Exception $e) {
+            Log::error($e);
+            return false;
+        }
+    }
+
+    public function store(Speedtest $speedtest): bool
+    {
+        return $this->database->writePoints([
+            new Point(
+                'speedtest',
+                null,
+                ['host' => config('services.influxdb.host')],
+                $speedtest->formatForInfluxDB(),
+            )
+        ]);
+    }
+}

speedtest/volumes/config/www/app/Utils/InfluxDB/InfluxDBVersion2Wrapper.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace App\Utils\InfluxDB;
+
+use App\Interfaces\InfluxDBWrapperInterface;
+use App\Models\Speedtest;
+use InfluxDB2\Client;
+
+class InfluxDBVersion2Wrapper implements InfluxDBWrapperInterface
+{
+    private Client $client;
+
+    public function __construct(Client $client)
+    {
+        $this->client = $client;
+    }
+
+    public function testConnection(): bool
+    {
+        return $this->client->health()->getStatus() !== 'pass';
+    }
+
+    public function doesDatabaseExist(string $database): bool
+    {
+        return true;
+    }
+
+    public function createDatabase(string $database): bool
+    {
+        return true;
+    }
+
+    public function store(Speedtest $speedtest): bool
+    {
+        return true;
+    }
+}

speedtest/volumes/config/www/app/Utils/OoklaTester.php

@@ -0,0 +1,128 @@
+<?php
+
+namespace App\Utils;
+
+use App\Exceptions\SpeedtestFailureException;
+use App\Helpers\SettingsHelper;
+use App\Helpers\SpeedtestHelper;
+use App\Interfaces\SpeedtestProvider;
+use App\Models\Speedtest;
+use Cache;
+use Exception;
+use JsonException;
+use Log;
+
+class OoklaTester implements SpeedtestProvider
+{
+    public function run($output = false, $scheduled = true): Speedtest
+    {
+        if ($output === false) {
+            $output = $this->output();
+        }
+
+        try {
+            $output = json_decode($output, true, 512, JSON_THROW_ON_ERROR);
+
+            if (!$this->isOutputComplete($output)) {
+                $test = false;
+            }
+
+            $test = Speedtest::create([
+                'ping' => $output['ping']['latency'],
+                'download' => SpeedtestHelper::convert($output['download']['bandwidth']),
+                'upload' => SpeedtestHelper::convert($output['upload']['bandwidth']),
+                'server_id' => $output['server']['id'],
+                'server_name' => $output['server']['name'],
+                'server_host' => $output['server']['host'] . ':' . $output['server']['port'],
+                'url' => $output['result']['url'],
+                'scheduled' => $scheduled
+            ]);
+        } catch (JsonException $e) {
+            Log::error('Failed to parse speedtest JSON');
+            Log::error($output);
+            $test = false;
+        } catch (Exception $e) {
+            Log::error($e->getMessage());
+            $test = false;
+        }
+
+        if ($test == false) {
+            Speedtest::create([
+                'ping' => 0,
+                'upload' => 0,
+                'download' => 0,
+                'failed' => true,
+                'scheduled' => $scheduled,
+            ]);
+
+            throw new SpeedtestFailureException(json_encode($output));
+        }
+
+        Cache::flush();
+
+        return $test;
+    }
+
+    public function output()
+    {
+        $server = SettingsHelper::get('server')['value'];
+
+        $binPath = app_path() . DIRECTORY_SEPARATOR . 'Bin' . DIRECTORY_SEPARATOR . 'speedtest';
+        $homePrefix = config('speedtest.home') . ' && ';
+
+        if ($server != '' && $server != false) {
+            $server = explode(',', $server);
+            $server = $server[array_rand($server)];
+            if ($server == false) {
+                Log::error('Speedtest server undefined');
+                return false;
+            }
+
+            return shell_exec($homePrefix . $binPath . ' -f json -s ' . $server);
+        }
+
+        return shell_exec($homePrefix . $binPath . ' -f json');
+    }
+
+    /**
+     * Checks that the speedtest JSON output is complete/valid
+     *
+     * @param array $output
+     * @return boolean
+     */
+    public static function isOutputComplete($output)
+    {
+        /**
+         * Array of indexes that must exist in $output
+         */
+        $checks = [
+            'type' => 'result',
+            'download' => ['bandwidth' => '*'],
+            'upload' => ['bandwidth' => '*'],
+            'ping' => ['latency' => '*'],
+            'server' => [
+                'id' => '*',
+                'name' => '*',
+                'host' => '*',
+                'port' => '*'
+            ],
+            'result' => [
+                'url' => '*'
+            ],
+        ];
+        /**
+         * Array of indexes that must not exist
+         */
+        $checkMissing = [
+            'type' => 'error'
+        ];
+
+        foreach ($checks as $key => $value) {
+            if (!isset($output[$key])) {
+                return false;
+            }
+        }
+
+        return true;
+    }
+}