fix: don't check github for a new version every command

carlalexander · carlalexander · commit 4b3bbb493e39 · 2021-08-29T10:18:03.000-04:00
diff --git a/src/CliConfiguration.php b/src/CliConfiguration.php
@@ -85,6 +85,22 @@ public function getActiveTeamId(): int
         return (int) $this->get('active_team');
     }
 
+    /**
+     * Get the CLI version on GitHub.
+     */
+    public function getGitHubCliVersion(): string
+    {
+        return (string) $this->get('github_cli_version');
+    }
+
+    /**
+     * Get the timestamp when GitHub was last checked for a CLI update.
+     */
+    public function getGitHubLastCheckedTimestamp(): int
+    {
+        return (int) $this->get('github_last_checked');
+    }
+
     /**
      * Check if the global configuration has an access token.
      */
@@ -109,6 +125,22 @@ public function setActiveTeamId(int $teamId)
         $this->set('active_team', $teamId);
     }
 
+    /**
+     * Set the CLI version on GitHub.
+     */
+    public function setGitHubCliVersion(string $version)
+    {
+        $this->set('github_cli_version', $version);
+    }
+
+    /**
+     * Set the timestamp when GitHub was last checked for a CLI update.
+     */
+    public function setGitHubLastCheckedTimestamp(int $timestamp)
+    {
+        $this->set('github_last_checked', $timestamp);
+    }
+
     /**
      * Get the given configuration option or return the default.
      */
diff --git a/src/EventListener/VersionCheckSubscriber.php b/src/EventListener/VersionCheckSubscriber.php
@@ -17,10 +17,18 @@
 use Symfony\Component\Console\Event\ConsoleCommandEvent;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 use Ymir\Cli\Application;
+use Ymir\Cli\CliConfiguration;
 use Ymir\Cli\GitHubClient;
 
 class VersionCheckSubscriber implements EventSubscriberInterface
 {
+    /**
+     * The global Ymir CLI configuration.
+     *
+     * @var CliConfiguration
+     */
+    private $cliConfiguration;
+
     /**
      * The API client that interacts with the GitHub API.
      *
@@ -38,8 +46,9 @@ class VersionCheckSubscriber implements EventSubscriberInterface
     /**
      * Constructor.
      */
-    public function __construct(GitHubClient $gitHubClient, string $version)
+    public function __construct(CliConfiguration $cliConfiguration, GitHubClient $gitHubClient, string $version)
     {
+        $this->cliConfiguration = $cliConfiguration;
         $this->gitHubClient = $gitHubClient;
         $this->version = $version;
     }
@@ -59,9 +68,14 @@ public static function getSubscribedEvents()
      */
     public function onConsoleCommand(ConsoleCommandEvent $event)
     {
-        $latestVersion = ltrim($this->gitHubClient->getTags('ymirapp/cli')->pluck('name')->first(), 'v');
+        $time = time();
+
+        if ($time - $this->cliConfiguration->getGitHubLastCheckedTimestamp() > 3600) {
+            $this->cliConfiguration->setGitHubCliVersion(ltrim($this->gitHubClient->getTags('ymirapp/cli')->pluck('name')->first(), 'v'));
+            $this->cliConfiguration->setGitHubLastCheckedTimestamp($time);
+        }
 
-        if (version_compare($latestVersion, $this->version, '>')) {
+        if (version_compare($this->cliConfiguration->getGitHubCliVersion(), $this->version, '>')) {
             $event->getOutput()->writeln('<comment>A new version of the Ymir CLI is available</comment>');
         }
     }
