Issue/327 versioning (#345)

* Switch to semver format

* Rewrite new version check to use Github Releases and cron

* Styling

* Remove v from in front of version

* New version check test fix

* Uncomment test case

app/Console/Commands/Version.php

@@ -3,6 +3,7 @@
 namespace App\Console\Commands;
 
 use App\Console\Command;
+use App\Services\VersionService;
 use Symfony\Component\Yaml\Yaml;
 
 /**
@@ -12,23 +13,12 @@ class Version extends Command
 {
     protected $signature = 'phpvms:version {--write} {--base-only}';
 
-    /**
-     * Create the version number that gets written out
-     *
-     * @param mixed $cfg
-     *
-     * @return bool|string
-     */
-    protected function createVersionNumber($cfg)
+    private $versionSvc;
+
+    public function __construct(VersionService $versionSvc)
     {
-        exec($cfg['git']['git-local'], $version);
-        $version = substr($version[0], 0, $cfg['build']['length']);
-
-        // prefix with the date in YYMMDD format
-        $date = date('ymd');
-        $version = $date.'-'.$version;
-
-        return $version;
+        parent::__construct();
+        $this->versionSvc = $versionSvc;
     }
 
     /**
@@ -38,27 +28,17 @@ class Version extends Command
      */
     public function handle()
     {
-        $version_file = config_path('version.yml');
-        $cfg = Yaml::parse(file_get_contents($version_file));
-
-        // Get the current build id
-        $build_number = $this->createVersionNumber($cfg);
-        $cfg['build']['number'] = $build_number;
-
-        $c = $cfg['current'];
-        $version = "v{$c['major']}.{$c['minor']}.{$c['patch']}-{$build_number}";
-
+        // Write the updated build number out to the file
         if ($this->option('write')) {
+            $version_file = config_path('version.yml');
+            $cfg = Yaml::parse(file_get_contents($version_file));
+            $build_number = $this->versionSvc->getBuildId($cfg);
+            $cfg['build']['number'] = $build_number;
+
             file_put_contents($version_file, Yaml::dump($cfg, 4, 2));
         }
 
-        // Only show the major.minor.patch version
-        if ($this->option('base-only')) {
-            $version = 'v'.$cfg['current']['major'].'.'
-                .$cfg['current']['minor'].'.'
-                .$cfg['current']['patch'];
-        }
-
+        $version = $this->versionSvc->getCurrentVersion(!$this->option('base-only'));
         echo $version."\n";
     }
 }

app/Cron/Nightly/NewVersionCheck.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace App\Cron\Nightly;
+
+use App\Contracts\Listener;
+use App\Events\CronNightly;
+use App\Services\VersionService;
+
+/**
+ * Determine if any pilots should be set to ON LEAVE status
+ */
+class NewVersionCheck extends Listener
+{
+    private $versionSvc;
+
+    /**
+     * @param VersionService $versionSvc
+     */
+    public function __construct(VersionService $versionSvc)
+    {
+        $this->versionSvc = $versionSvc;
+    }
+
+    /**
+     * Set any users to being on leave after X days
+     *
+     * @param CronNightly $event
+     */
+    public function handle(CronNightly $event): void
+    {
+        $this->versionSvc->isNewVersionAvailable();
+    }
+}

app/Database/seeds/settings.yml

@@ -12,6 +12,13 @@
   options: ''
   type: text
   description: 'Email where notices, etc are sent'
+- key: general.check_prerelease_version
+  name: 'Pre-release versions in version check'
+  group: general
+  value: false
+  options: ''
+  type: boolean
+  description: 'Include beta and other pre-release versions when checking for a new version'
 - key: units.distance
   name: 'Distance Units'
   group: units

app/Http/Controllers/Admin/DashboardController.php

@@ -3,7 +3,7 @@
 namespace App\Http\Controllers\Admin;
 
 use App\Contracts\Controller;
-use App\Facades\Utils;
+use App\Repositories\KvpRepository;
 use App\Repositories\NewsRepository;
 use App\Repositories\PirepRepository;
 use App\Repositories\UserRepository;
@@ -16,6 +16,7 @@ use vierbergenlars\SemVer\version as semver;
 
 class DashboardController extends Controller
 {
+    private $kvpRepo;
     private $newsRepo;
     private $pirepRepo;
     private $userRepo;
@@ -23,15 +24,18 @@ class DashboardController extends Controller
     /**
      * DashboardController constructor.
      *
+     * @param KvpRepository   $kvpRepo
      * @param NewsRepository  $newsRepo
      * @param PirepRepository $pirepRepo
      * @param UserRepository  $userRepo
      */
     public function __construct(
+        KvpRepository $kvpRepo,
         NewsRepository $newsRepo,
         PirepRepository $pirepRepo,
         UserRepository $userRepo
     ) {
+        $this->kvpRepo = $kvpRepo;
         $this->newsRepo = $newsRepo;
         $this->pirepRepo = $pirepRepo;
         $this->userRepo = $userRepo;
@@ -47,10 +51,8 @@ class DashboardController extends Controller
     protected function checkNewVersion()
     {
         try {
-            $current_version = new semver(Version::compact());
-            $latest_version = new semver(Utils::downloadUrl(config('phpvms.version_file')));
-
-            if (semver::gt($latest_version, $current_version)) {
+            if ($this->kvpRepo->get('new_version_available', false) === true) {
+                $latest_version = $this->kvpRepo->get('latest_version_tag');
                 Flash::warning('New version '.$latest_version.' is available!');
             }
         } catch (\Exception $e) {

app/Providers/CronServiceProvider.php

@@ -2,7 +2,10 @@
 
 namespace App\Providers;
 
+use App\Cron\Hourly\RemoveExpiredBids;
+use App\Cron\Hourly\RemoveExpiredLiveFlights;
 use App\Cron\Nightly\ApplyExpenses;
+use App\Cron\Nightly\NewVersionCheck;
 use App\Cron\Nightly\PilotLeave;
 use App\Cron\Nightly\RecalculateBalances;
 use App\Cron\Nightly\RecalculateStats;
@@ -25,6 +28,7 @@ class CronServiceProvider extends ServiceProvider
             PilotLeave::class,
             SetActiveFlights::class,
             RecalculateStats::class,
+            NewVersionCheck::class,
         ],
 
         CronWeekly::class => [
@@ -35,8 +39,8 @@ class CronServiceProvider extends ServiceProvider
         ],
 
         CronHourly::class => [
-            \App\Cron\Hourly\RemoveExpiredBids::class,
-            \App\Cron\Hourly\RemoveExpiredLiveFlights::class,
+            RemoveExpiredBids::class,
+            RemoveExpiredLiveFlights::class,
         ],
     ];
 }

app/Repositories/KvpRepository.php

@@ -0,0 +1,69 @@
+<?php
+
+namespace App\Repositories;
+
+use Spatie\Valuestore\Valuestore;
+
+class KvpRepository
+{
+    private $valueStore;
+
+    public function __construct()
+    {
+        $this->valueStore = Valuestore::make(config('phpvms.kvp_storage_path'));
+    }
+
+    /**
+     * @param $key
+     * @param null $default
+     *
+     * @return array|string|null
+     */
+    public function retrieve($key, $default = null)
+    {
+        return $this->get($key, $default);
+    }
+
+    /**
+     * Get a value from the KVP store
+     *
+     * @param string $key
+     * @param mixed  $default default value to return
+     *
+     * @return array|string|null
+     */
+    public function get($key, $default = null)
+    {
+        if (!$this->valueStore->has($key)) {
+            return $default;
+        }
+
+        return $this->valueStore->get($key);
+    }
+
+    /**
+     * @alias store($key,$value)
+     *
+     * @param string $key
+     * @param mixed  $value
+     *
+     * @return null
+     */
+    public function save($key, $value)
+    {
+        return $this->store($key, $value);
+    }
+
+    /**
+     * Save a value to the KVP store
+     *
+     * @param $key
+     * @param $value
+     *
+     * @return null
+     */
+    public function store($key, $value)
+    {
+        return $this->valueStore->put($key, $value);
+    }
+}

app/Services/VersionService.php

@@ -0,0 +1,194 @@
+<?php
+
+namespace App\Services;
+
+use App\Contracts\Service;
+use App\Repositories\KvpRepository;
+use App\Support\HttpClient;
+use GuzzleHttp\Exception\GuzzleException;
+use Illuminate\Support\Facades\Log;
+use SemVer\SemVer\Version;
+use Symfony\Component\Yaml\Yaml;
+
+class VersionService extends Service
+{
+    private $httpClient;
+    private $kvpRepo;
+
+    public function __construct(
+        HttpClient $httpClient,
+        KvpRepository $kvpRepo
+    ) {
+        $this->httpClient = $httpClient;
+        $this->kvpRepo = $kvpRepo;
+    }
+
+    /**
+     * Clean the version string (e.,g strip the v in front)
+     *
+     * @param string $version
+     *
+     * @return string
+     */
+    private function cleanVersionString($version): string
+    {
+        if ($version[0] === 'v') {
+            $version = substr($version, 1);
+        }
+
+        return $version;
+    }
+
+    /**
+     * Set the latest release version/tag into the KVP repo and return the tag
+     *
+     * @param $version_tag
+     * @param $download_url
+     *
+     * @return string The version string
+     */
+    private function setLatestRelease($version_tag, $download_url): string
+    {
+        $version_tag = $this->cleanVersionString($version_tag);
+
+        $this->kvpRepo->save('latest_version_tag', $version_tag);
+        $this->kvpRepo->save('latest_version_url', $download_url);
+
+        return $version_tag;
+    }
+
+    /**
+     * Find and return the Github asset line
+     *
+     * @param $release
+     *
+     * @return string
+     */
+    private function getGithubAsset($release): string
+    {
+        foreach ($release['assets'] as $asset) {
+            if ($asset['content_type'] === 'application/gzip') {
+                return $asset['browser_download_url'];
+            }
+        }
+
+        return '';
+    }
+
+    /**
+     * Download the latest version from github
+     */
+    private function getLatestVersionGithub()
+    {
+        $releases = [];
+
+        try {
+            $releases = $this->httpClient->get(config('phpvms.version_file'), [
+                'headers' => [
+                    'Accept' => 'application/json',
+                ],
+            ]);
+        } catch (GuzzleException $e) {
+            Log::error('Error retrieving new version: '.$e->getMessage());
+        }
+
+        $include_prerelease = setting('general.check_prerelease_version', false);
+        foreach ($releases as $release) {
+            if ($release['prerelease'] === true) {
+                if ($include_prerelease) {
+                    return $this->setLatestRelease(
+                        $release['tag_name'],
+                        $this->getGithubAsset($release)
+                    );
+                }
+                continue;
+            }
+
+            return $this->setLatestRelease(
+                $release['tag_name'],
+                $this->getGithubAsset($release)
+            );
+        }
+
+        return $releases;
+    }
+
+    /**
+     * Downloads the latest version and saves it into the KVP store
+     */
+    public function getLatestVersion()
+    {
+        $latest_version = $this->getLatestVersionGithub();
+        return $latest_version;
+    }
+
+    /**
+     * Get the build ID, which is the date and the git log version
+     *
+     * @param array $cfg
+     *
+     * @return string
+     */
+    public function getBuildId($cfg)
+    {
+        exec($cfg['git']['git-local'], $version);
+        $version = substr($version[0], 0, $cfg['build']['length']);
+
+        // prefix with the date in YYMMDD format
+        $date = date('ymd');
+        return $date.'.'.$version;
+    }
+
+    /**
+     * Get the current version
+     *
+     * @param bool $include_build True will include the build ID
+     *
+     * @return string
+     */
+    public function getCurrentVersion($include_build = true)
+    {
+        $version_file = config_path('version.yml');
+        $cfg = Yaml::parse(file_get_contents($version_file));
+
+        $c = $cfg['current'];
+        $version = "{$c['major']}.{$c['minor']}.{$c['patch']}";
+
+        if ($include_build) {
+            // Get the current build id
+            $build_number = $this->getBuildId($cfg);
+            $cfg['build']['number'] = $build_number;
+            $version = $version.'+'.$build_number;
+        }
+
+        return $version;
+    }
+
+    /**
+     * See if a new version is available. Saves a flag into the KVP store if there is
+     *
+     * @param null [$current_version]
+     *
+     * @return bool
+     */
+    public function isNewVersionAvailable($current_version = null)
+    {
+        if (!$current_version) {
+            $current_version = $this->getCurrentVersion(false);
+        } else {
+            $current_version = $this->cleanVersionString($current_version);
+        }
+
+        $current_version = Version::fromString($current_version);
+        $latest_version = Version::fromString($this->getLatestVersion());
+
+        // Convert to semver
+        if ($latest_version->isGreaterThan($current_version)) {
+            $this->kvpRepo->save('new_version_available', true);
+            return true;
+        }
+
+        $this->kvpRepo->save('new_version_available', false);
+        return false;
+    }
+}

app/Support/Http.php

@@ -20,7 +20,7 @@ class Http
      *
      * @return string
      */
-    public static function get($uri, array $opts)
+    public static function get($uri, array $opts = [])
     {
         $opts = array_merge([
             'connect_timeout' => 2, // wait two seconds by default

app/Support/HttpClient.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace App\Support;
+
+use GuzzleHttp\Client;
+
+/**
+ * Helper for HTTP stuff
+ */
+class HttpClient
+{
+    private $httpClient;
+
+    public function __construct(
+        Client $httpClient
+    ) {
+        $this->httpClient = $httpClient;
+    }
+
+    /**
+     * Download a URI. If a file is given, it will save the downloaded
+     * content into that file
+     *
+     * @param       $uri
+     * @param array $opts
+     *
+     * @throws \GuzzleHttp\Exception\GuzzleException
+     *
+     * @return string
+     */
+    public function get($uri, array $opts = [])
+    {
+        $opts = array_merge([
+            'connect_timeout' => 2, // wait two seconds by default
+        ], $opts);
+
+        $response = $this->httpClient->request('GET', $uri, $opts);
+
+        $body = $response->getBody()->getContents();
+        $content_type = $response->getHeaderLine('content-type');
+        if (strpos($content_type, 'application/json') !== false) {
+            $body = \GuzzleHttp\json_decode($body, true);
+        }
+
+        return $body;
+    }
+}