Merge pull request #10490 from eth3lbert/msw-seek-versions

msw: Add seek pagination support for `GET /api/v1/crates/:name/versions`

Author: Turbo87

packages/crates-io-msw/handlers/versions/list.js

@@ -1,4 +1,5 @@
 import { http, HttpResponse } from 'msw';
+import compareSemver from 'semver/functions/compare-loose.js';
 
 import { db } from '../../index.js';
 import { serializeVersion } from '../../serializers/version.js';
@@ -18,18 +19,43 @@ export default http.get('/api/v1/crates/:name/versions', async ({ request, param
     versions = versions.filter(v => nums.includes(v.num));
   }
 
-  versions.sort((a, b) => b.id - a.id);
+  let sort = url.searchParams.get('sort');
+  versions =
+    sort == 'date' ? versions.sort((a, b) => b.id - a.id) : versions.sort((a, b) => compareSemver(b.num, a.num));
+
   let total = versions.length;
 
   let include = url.searchParams.get('include') ?? '';
   let includes = include ? include.split(',') : [];
-
-  let serializedVersions = versions.map(v => serializeVersion(v, { includePublishedBy: true }));
   let meta = { total, next_page: null };
 
   if (includes.includes('release_tracks')) {
     meta.release_tracks = calculateReleaseTracks(versions);
   }
 
+  // seek pagination
+  // A simplified seek encoding is applied here for testing purposes only. It should be opaque in
+  // real-world scenarios.
+  let next_seek = null;
+  let per_page = url.searchParams.get('per_page');
+  if (per_page != null) {
+    let seek = url.searchParams.get('seek');
+    if (seek != null) {
+      let start = versions.findIndex(it => it.num === seek);
+      versions = versions.slice(start + 1);
+    }
+    versions = versions.slice(0, parseInt(per_page));
+
+    if (versions.length == per_page) {
+      next_seek = versions.at(-1).num;
+    }
+  }
+  if (next_seek) {
+    let next_params = new URLSearchParams(url.searchParams);
+    next_params.set('seek', next_seek);
+    meta.next_page = `?${next_params}`;
+  }
+
+  let serializedVersions = versions.map(v => serializeVersion(v, { includePublishedBy: true }));
   return HttpResponse.json({ versions: serializedVersions, meta });
 });

packages/crates-io-msw/handlers/versions/list.test.js

@@ -104,6 +104,45 @@ test('returns all versions belonging to the specified crate', async function ()
   });
 });
 
+test('supports `sort` parameters', async function () {
+  let user = db.user.create();
+  let crate = db.crate.create({ name: 'rand' });
+  db.version.create({ crate, num: '1.0.0' });
+  db.version.create({ crate, num: '2.0.0-alpha', publishedBy: user });
+  db.version.create({ crate, num: '1.1.0', rust_version: '1.69' });
+
+  // sort by `semver` by default
+  {
+    let response = await fetch('/api/v1/crates/rand/versions');
+    assert.strictEqual(response.status, 200);
+    let json = await response.json();
+    assert.deepEqual(
+      json.versions.map(it => it.num),
+      ['2.0.0-alpha', '1.1.0', '1.0.0'],
+    );
+  }
+
+  {
+    let response = await fetch('/api/v1/crates/rand/versions?sort=semver');
+    assert.strictEqual(response.status, 200);
+    let json = await response.json();
+    assert.deepEqual(
+      json.versions.map(it => it.num),
+      ['2.0.0-alpha', '1.1.0', '1.0.0'],
+    );
+  }
+
+  {
+    let response = await fetch('/api/v1/crates/rand/versions?sort=date');
+    assert.strictEqual(response.status, 200);
+    let json = await response.json();
+    assert.deepEqual(
+      json.versions.map(it => it.num),
+      ['1.1.0', '2.0.0-alpha', '1.0.0'],
+    );
+  }
+});
+
 test('supports multiple `ids[]` parameters', async function () {
   let user = db.user.create();
   let crate = db.crate.create({ name: 'rand' });
@@ -119,6 +158,85 @@ test('supports multiple `ids[]` parameters', async function () {
   );
 });
 
+test('supports seek pagination', async function () {
+  let user = db.user.create();
+  let crate = db.crate.create({ name: 'rand' });
+  db.version.create({ crate, num: '1.0.0' });
+  db.version.create({ crate, num: '2.0.0-alpha', publishedBy: user });
+  db.version.create({ crate, num: '1.1.0', rust_version: '1.69' });
+
+  async function seek_forwards(queryParams) {
+    let calls = 0;
+    let next_page;
+    let responses = [];
+    let base_url = '/api/v1/crates/rand/versions';
+    let params = new URLSearchParams(queryParams);
+    let url = `${base_url}?${params}`;
+    while ((calls == 0 || next_page) && calls < 50) {
+      if (next_page) {
+        url = `${base_url}${next_page}`;
+      }
+      let response = await fetch(url);
+      calls += 1;
+      assert.strictEqual(response.status, 200);
+      let json = await response.json();
+      responses.push(json);
+      next_page = json.meta.next_page;
+      if (next_page == null) {
+        break;
+      }
+    }
+    return responses;
+  }
+
+  // sort by `semver` by default
+  {
+    let responses = await seek_forwards({ per_page: 1 });
+    assert.deepEqual(
+      responses.map(it => it.versions.map(v => v.num)),
+      [['2.0.0-alpha'], ['1.1.0'], ['1.0.0'], []],
+    );
+    assert.deepEqual(
+      responses.map(it => it.meta.next_page),
+      ['?per_page=1&seek=2.0.0-alpha', '?per_page=1&seek=1.1.0', '?per_page=1&seek=1.0.0', null],
+    );
+  }
+
+  {
+    let responses = await seek_forwards({ per_page: 1, sort: 'semver' });
+    assert.deepEqual(
+      responses.map(it => it.versions.map(v => v.num)),
+      [['2.0.0-alpha'], ['1.1.0'], ['1.0.0'], []],
+    );
+    assert.deepEqual(
+      responses.map(it => it.meta.next_page),
+      [
+        '?per_page=1&sort=semver&seek=2.0.0-alpha',
+        '?per_page=1&sort=semver&seek=1.1.0',
+        '?per_page=1&sort=semver&seek=1.0.0',
+        null,
+      ],
+    );
+  }
+
+  {
+    let responses = await seek_forwards({ per_page: 1, sort: 'date' });
+    assert.deepEqual(
+      responses.map(it => it.versions.map(v => v.num)),
+      [['1.1.0'], ['2.0.0-alpha'], ['1.0.0'], []],
+    );
+    assert.deepEqual(
+      responses.map(it => it.meta.next_page),
+      [
+        '?per_page=1&sort=date&seek=1.1.0',
+        '?per_page=1&sort=date&seek=2.0.0-alpha',
+        '?per_page=1&sort=date&seek=1.0.0',
+        null,
+      ],
+    );
+  }
+});
+
 test('include `release_tracks` meta', async function () {
   let user = db.user.create();
   let crate = db.crate.create({ name: 'rand' });

tests/models/version-test.js

@@ -154,8 +154,8 @@ module('Model | Version', function (hooks) {
         '0.3.3',
         '0.3.2',
         '0.3.1',
-        '0.3.0-alpha.01',
         '0.3.0',
+        '0.3.0-alpha.01',
         '0.2.1',
         '0.2.0',
         '0.1.2',
@@ -182,8 +182,8 @@ module('Model | Version', function (hooks) {
           { num: '0.3.3', isHighestOfReleaseTrack: false },
           { num: '0.3.2', isHighestOfReleaseTrack: false },
           { num: '0.3.1', isHighestOfReleaseTrack: false },
-          { num: '0.3.0-alpha.01', isHighestOfReleaseTrack: false },
           { num: '0.3.0', isHighestOfReleaseTrack: false },
+          { num: '0.3.0-alpha.01', isHighestOfReleaseTrack: false },
           { num: '0.2.1', isHighestOfReleaseTrack: true },
           { num: '0.2.0', isHighestOfReleaseTrack: false },
           { num: '0.1.2', isHighestOfReleaseTrack: true },