[Twitch] Add caching to endpoints: avatar, game, status/title and viewercount

Extend caching of endpoint 'subpoints' from 60 seconds to 120 seconds

Author: Decicus

app/Http/Controllers/TwitchController.php

@@ -5,7 +5,6 @@
 use App\Exceptions\TwitchFormatException;
 use Illuminate\Http\Request;
 
-use App\Http\Requests;
 use App\Http\Controllers\Controller;
 
 use App\User;
@@ -18,13 +17,8 @@
 use App\Repositories\TwitchEmotesApiRepository;
 
 use Carbon\Carbon;
-use Carbon\CarbonInterval;
 use DateTimeZone;
 
-use Symfony\Component\DomCrawler\Crawler;
-use Symfony\Component\CssSelector;
-use GuzzleHttp\Client;
-
 use Crypt;
 use Illuminate\Contracts\Encryption\DecryptException;
 
@@ -248,6 +242,14 @@ public function avatar(Request $request, $user = null)
             return Helper::text(__('generic.username_required'));
         }
 
+        /**
+         * Return avatar URL from cache if it exists.
+         */
+        $cacheKey = sprintf('twitch_avatar_%s', md5($user));
+        if (Cache::has($cacheKey)) {
+            return Helper::text(Cache::get($cacheKey));
+        }
+
         $id = $request->input('id', 'false');
         try {
             $data = $id === 'true' ? $this->api->userById($user) : $this->api->userByUsername($user);
@@ -268,11 +270,13 @@ public function avatar(Request $request, $user = null)
             ]));
         }
 
-        if (empty($data['avatar'])) {
-            return Helper::text($this->defaultAvatar);
-        }
+        // Fallback to the default avatar if necessary.
+        $avatar = $data['avatar'] ?? $this->defaultAvatar;
+
+        // Cache the avatar URL for 5 minutes.
+        Cache::put($cacheKey, $avatar, config('twitch.cache.avatar'));
 
-        return Helper::text($data['avatar']);
+        return Helper::text($avatar);
     }
 
     /**
@@ -851,6 +855,18 @@ public function gameOrStatus(Request $request, $route, $channel = null)
             }
         }
 
+        /**
+         * Check cache for game/status.
+         */
+        $cacheId = md5($channel);
+        $cacheGame = sprintf('twitch_game_%s', $cacheId);
+        $cacheStatus = sprintf('twitch_status_%s', $cacheId);
+
+        $cacheKey = $route === 'game' ? $cacheGame : $cacheStatus;
+        if (Cache::has($cacheKey)) {
+            return Helper::text(Cache::get($cacheKey));
+        }
+
         try {
             $getChannel = $this->api->channelById($channel);
         } catch (TwitchApiException $ex) {
@@ -859,11 +875,20 @@ public function gameOrStatus(Request $request, $route, $channel = null)
             return Helper::text($ex->getMessage());
         }
 
+        $game = $getChannel['game']['name'];
+        $status = $getChannel['title'];
+
+        /**
+         * We can cache both values as it's from the same request anyways.
+         */
+        Cache::put($cacheGame, $game, config('twitch.cache.game'));
+        Cache::put($cacheStatus, $status, config('twitch.cache.status'));
+
         if ($route === 'game') {
-            return Helper::text($getChannel['game']['name'] ?: '');
+            return Helper::text($game ?: '');
         }
 
-        return Helper::text($getChannel['title']);
+        return Helper::text($status);
     }
 
     /**
@@ -1811,7 +1836,7 @@ public function subpoints(Request $request, $channel = null)
              * Cache subpoints for one minute,
              * to prevent excessive requests to the Twitch API.
              */
-            Cache::put($cacheKey, $subpoints, 60);
+            Cache::put($cacheKey, $subpoints, config('twitch.cache.subpoints'));
 
             /**
              * Subtract user-supplied value.
@@ -2190,6 +2215,14 @@ public function viewercount(Request $request, $channel = null)
             }
         }
 
+        /**
+         * Load viewercount from cache to prevent unneccessary API request.
+         */
+        $cacheKey = sprintf('twitch_viewercount_%s', md5($channel));
+        if (Cache::has($cacheKey)) {
+            return Helper::text(Cache::get($cacheKey));
+        }
+
         $stream = $this->twitchApi->streams($channel, $this->version);
 
         if (!empty($stream['status'])) {
@@ -2202,6 +2235,8 @@ public function viewercount(Request $request, $channel = null)
         }
 
         $viewers = $stream['stream']['viewers'];
+        // Add viewercount to the cache and cache it for 60 seconds.
+        Cache::put($cacheKey, $viewers, config('twitch.cache.viewercount'));
         return Helper::text($viewers);
     }
 

config/twitch.php

@@ -1,85 +1,17 @@
 <?php
     return [
-        'emoteslots' => [
-            0 => 2,
-            25 => 4,
-            50 => 6,
-            100 => 8,
-            250 => 10,
-            500 => 15,
-            1000 => 20,
-            2000 => 25,
-            3000 => 30,
-            4000 => 35,
-            5000 => 40,
-            6000 => 45,
-            7000 => 50
+        /**
+         * $endpoint => $seconds
+         *
+         * $seconds = how long a value per channel / user should be cached.
+         */
+        'cache' => [
+            'avatar' => 300,
+            'game' => 60,
+            // Stream title/status
+            'status' => 60,
+            'subpoints' => 120,
+            'viewercount' => 60,
         ],
-        'help' => [
-            'articles' => [
-                'About Site Suspensions, DMCA Suspensions, and Chat Bans' => 1727973,
-                'Adding a Game and Box Art to the Directory' => 2348988,
-                'Authy FAQ' => 2186821,
-                'Channel Banned Words' => 2100263,
-                'Chat Commands' => 659095,
-                'Chat Replay FAQ' => 2337148,
-                'Community Guidelines' => 983016,
-                'Creative FAQ' => 2176641,
-                'Guide to Broadcast Health and Using Twitch Inspector' => 2420572,
-                'Guide to Cheering (Bits)' => 2449458,
-                'Guide to Closed Captions' => 2564215,
-                'Guide to Custom Resub Messages' => 2457351,
-                'Guide to Earning Revenue from Game Sales' => 2582870,
-                'Guide to Twitch Crates' => 2772801,
-                'How to Buy Games on Twitch' => 2771293,
-                'How to Claim In-Game Content' => 2773669,
-                'How to Edit Info Panels' => 2416760,
-                'How to File a User Report' => 725568,
-                'How to Handle Viewbots/Followbots' => 2435640,
-                'How to Link Your Amazon Account' => 2574978,
-                'How to Manage Harassment in Chat' => 2329145,
-                'How to Redeem Coupon Codes' => 2392092,
-                'How to Use AutoMod' => 2662186,
-                'How to use Channel Feed' => 2377877,
-                'How to Use Clips' => 2442508,
-                'How to use the Friends Feature' => 2418761,
-                'How to Use Host Mode' => 2508329,
-                'How to use Pulse' => 2752590,
-                'How To Use VOD Thumbnails' => 2218412,
-                'HTML5 Video Player Beta' => 2477288,
-                'List of Prohibited/Banned Games' => 1992676,
-                'Missed Email Responses' => 1626286,
-                'Moderation Team Building FAQ' => 1360598,
-                'Partner Program Overview' => 735069,
-                'Partner Emoticon and Badge Guide' => 2348985,
-                'Partner Help and Contact Information' => 735178,
-                'Partner Payment FAQ' => 735169,
-                'Partner Payout FAQ' => 735169,
-                'Partner Revenue Guide' => 2347894,
-                'Partner Settings Guide' => 2401004,
-                'Purchase Support FAQ' => 2341636,
-                'Social Eating FAQ' => 2483343,
-                'Subscription Program FAQ' => 735176,
-                'Terms of Service (ToS)' => 735191,
-                'Tips for Applying to the Partner Program' => 735127,
-                'Twitch Chat Badges Guide' => 659115,
-                'Twitch IRC' => 1302780,
-                'Twitch IRL FAQ' => 2672652,
-                'Twitch Music FAQ' => 1824967,
-                'Twitch Prime Guide' => 2572060,
-                'Twitch Rules of Conduct (RoC)' => 983016,
-                'Twitch Turbo' => 973896,
-                'Twitch Twitter "@TwitchSupport" FAQ' => 1210307,
-                'Two Factor Authentication (2FA) with Authy' => 2186271,
-                'Username Rename (Name Changes) and Recycling Policies' => 1015624,
-                'Whispers FAQ' => 2215236,
-                // Sorted at the bottom for lower priority
-                'Android Subscriptions FAQ' => 2297883,
-                'Creative Commissions' => 2337107,
-                'How to File a Whisper Report' => 2329782,
-                'How to Use Twitch Prime Subscriptions (Free)' => 2574674,
-                'Twitch Prime Game Code Redemption and Installation' => 2574721
-            ]
-        ]
     ];
 ?>