[6.x] Add pagination to package changelogs (#13692)

Author: duncanmcclean

resources/js/components/updater/Updater.vue

@@ -42,17 +42,27 @@
             :package="package"
             :show-actions="showActions"
         />
+
+        <Pagination
+            v-if="meta.last_page > 1"
+            class="mt-6"
+            :resource-meta="meta"
+            :per-page="perPage"
+            @page-selected="setPage"
+            @per-page-changed="setPerPage"
+        />
     </div>
 </template>
 
 <script>
 import Release from './Release.vue';
-import { Icon } from '@/components/ui';
+import { Icon, Pagination } from '@/components/ui';
 
 export default {
     components: {
         Release,
         Icon,
+        Pagination,
     },
 
     props: ['slug', 'package', 'name'],
@@ -64,6 +74,9 @@ export default {
             currentVersion: null,
             latestRelease: null,
             showingUnlicensedReleases: false,
+            page: 1,
+            perPage: 10,
+            meta: {},
         };
     },
 
@@ -113,12 +126,34 @@ export default {
         getChangelog() {
             this.gettingChangelog = true;
 
-            this.$axios.get(cp_url(`/updater/${this.slug}/changelog`)).then((response) => {
-                this.gettingChangelog = false;
-                this.changelog = response.data.changelog;
-                this.currentVersion = response.data.currentVersion;
-                this.latestRelease = response.data.changelog[0];
-            });
+            this.$axios
+                .get(cp_url(`/updater/${this.slug}/changelog`), {
+                    params: {
+                        page: this.page,
+                        perPage: this.perPage,
+                    },
+                })
+                .then((response) => {
+                    this.gettingChangelog = false;
+                    this.changelog = response.data.changelog;
+                    this.currentVersion = response.data.currentVersion;
+                    this.meta = response.data.meta;
+
+                    if (this.page === 1 && response.data.changelog.length > 0) {
+                        this.latestRelease = response.data.changelog[0];
+                    }
+                });
+        },
+
+        setPage(page) {
+            this.page = page;
+            this.getChangelog();
+        },
+
+        setPerPage(perPage) {
+            this.perPage = perPage;
+            this.page = 1;
+            this.getChangelog();
         },
     },
 };

src/Http/Controllers/CP/Updater/UpdateProductController.php

@@ -3,6 +3,7 @@
 namespace Statamic\Http\Controllers\CP\Updater;
 
 use Facades\Statamic\Marketplace\Marketplace;
+use Illuminate\Http\Request;
 use Inertia\Inertia;
 use Statamic\Http\Controllers\CP\CpController;
 
@@ -33,7 +34,7 @@ public function show($marketplaceProductSlug)
      *
      * @param  string  $slug
      */
-    public function changelog($marketplaceProductSlug)
+    public function changelog(Request $request, $marketplaceProductSlug)
     {
         $this->authorize('view updates');
 
@@ -43,9 +44,15 @@ public function changelog($marketplaceProductSlug)
 
         $changelog = $product->changelog();
 
+        $paginated = $changelog->paginate(
+            $request->input('page', 1),
+            $request->input('perPage', 10)
+        );
+
         return [
-            'changelog' => $changelog->get(),
+            'changelog' => $paginated['data'],
             'currentVersion' => $changelog->currentVersion(),
+            'meta' => $paginated['meta'],
         ];
     }
 }

src/Marketplace/Marketplace.php

@@ -27,19 +27,23 @@ public function packages(array $packages)
         });
     }
 
-    public function releases($package)
+    public function releases($package, $params = [])
     {
         $uri = "packages/$package/releases";
+        $hash = md5(json_encode($params));
 
-        return Cache::rememberWithExpiration("marketplace-$uri", function () use ($uri) {
-            $fallback = [5 => collect()];
+        return Cache::rememberWithExpiration("marketplace-$uri-$hash", function () use ($uri, $params) {
+            $fallback = [5 => ['data' => collect(), 'meta' => null]];
 
             try {
-                if (! $response = Client::get($uri)) {
+                if (! $response = Client::get($uri, $params)) {
                     return $fallback;
                 }
 
-                return [60 => collect($response['data'])];
+                return [60 => [
+                    'data' => collect($response['data']),
+                    'meta' => $response['meta'] ?? null,
+                ]];
             } catch (RequestException $e) {
                 return $fallback;
             }

src/Updater/Changelog.php

@@ -27,16 +27,46 @@ abstract public function item();
      * @return \Illuminate\Support\Collection
      */
     public function get()
+    {
+        return $this->transformReleases(
+            Marketplace::releases($this->item())['data']
+        );
+    }
+
+    /**
+     * Get paginated changelog.
+     *
+     * @return array
+     */
+    public function paginate($page = 1, $perPage = 10)
+    {
+        $response = Marketplace::releases($this->item(), [
+            'page' => $page,
+            'perPage' => $perPage,
+        ]);
+
+        return [
+            'data' => $this->transformReleases($response['data'], $page),
+            'meta' => $response['meta'],
+        ];
+    }
+
+    /**
+     * Transform releases into changelog format.
+     *
+     * @return \Illuminate\Support\Collection
+     */
+    protected function transformReleases($releases, $page = 1)
     {
         $type = null;
 
-        return Marketplace::releases($this->item())->map(function ($release, $index) use (&$type) {
+        return $releases->map(function ($release, $index) use (&$type, $page) {
             $type = $type === 'downgrade' ? $type : $this->parseReleaseType($release['version'], $index);
 
             return (object) [
                 'version' => $release['version'],
                 'type' => $type,
-                'latest' => $index === 0,
+                'latest' => $page === 1 && $index === 0,
                 'licensed' => $this->isLicensed($release['version']),
                 'date' => Carbon::parse($release['date'])->toIso8601String(),
                 'body' => $release['changelog'],