msw: Add ?include=versions support for GET /api/v1/crates/:name/downloads

Author: eth3lbert

packages/crates-io-msw/handlers/crates/downloads.js

@@ -1,20 +1,29 @@
 import { http, HttpResponse } from 'msw';
 
 import { db } from '../../index.js';
+import { serializeVersion } from '../../serializers/version.js';
 import { notFound } from '../../utils/handlers.js';
 
-export default http.get('/api/v1/crates/:name/downloads', async ({ params }) => {
+export default http.get('/api/v1/crates/:name/downloads', async ({ request, params }) => {
   let crate = db.crate.findFirst({ where: { name: { equals: params.name } } });
   if (!crate) return notFound();
 
   let downloads = db.versionDownload.findMany({ where: { version: { crate: { id: { equals: crate.id } } } } });
-
-  return HttpResponse.json({
+  let resp = {
     version_downloads: downloads.map(download => ({
       date: download.date,
       downloads: download.downloads,
       version: download.version.id,
     })),
     meta: { extra_downloads: crate._extra_downloads },
-  });
+  };
+
+  let url = new URL(request.url);
+  let include = url.searchParams.get('include') ?? '';
+  let includes = include ? include.split(',') : [];
+  if (includes.includes('versions')) {
+    let versions = [...new Set(downloads.map(it => it.version))];
+    resp.versions = versions.map(it => serializeVersion(it));
+  }
+  return HttpResponse.json(resp);
 });

packages/crates-io-msw/handlers/crates/downloads.test.js

@@ -53,3 +53,80 @@ test('returns a list of version downloads belonging to the specified crate versi
     },
   });
 });
+
+test('includes related versions', async function () {
+  let crate = db.crate.create({ name: 'rand' });
+  let versions = Array.from({ length: 2 }, () => db.version.create({ crate }));
+  db.versionDownload.create({ version: versions[0], date: '2020-01-13' });
+  db.versionDownload.create({ version: versions[1], date: '2020-01-14' });
+  db.versionDownload.create({ version: versions[1], date: '2020-01-15' });
+
+  let response = await fetch('/api/v1/crates/rand/downloads?include=versions');
+  assert.strictEqual(response.status, 200);
+  assert.deepEqual(await response.json(), {
+    version_downloads: [
+      {
+        date: '2020-01-13',
+        downloads: 7035,
+        version: 1,
+      },
+      {
+        date: '2020-01-14',
+        downloads: 14_070,
+        version: 2,
+      },
+      {
+        date: '2020-01-15',
+        downloads: 21_105,
+        version: 2,
+      },
+    ],
+    versions: [
+      {
+        crate: 'rand',
+        crate_size: 162_963,
+        created_at: '2010-06-16T21:30:45Z',
+        dl_path: '/api/v1/crates/rand/1.0.0/download',
+        downloads: 3702,
+        features: {},
+        id: 1,
+        license: 'MIT',
+        links: {
+          dependencies: '/api/v1/crates/rand/1.0.0/dependencies',
+          version_downloads: '/api/v1/crates/rand/1.0.0/downloads',
+        },
+        num: '1.0.0',
+        published_by: null,
+        readme_path: '/api/v1/crates/rand/1.0.0/readme',
+        rust_version: null,
+        updated_at: '2017-02-24T12:34:56Z',
+        yank_message: null,
+        yanked: false,
+      },
+      {
+        crate: 'rand',
+        crate_size: 325_926,
+        created_at: '2010-06-16T21:30:45Z',
+        dl_path: '/api/v1/crates/rand/1.0.1/download',
+        downloads: 7404,
+        features: {},
+        id: 2,
+        license: 'Apache-2.0',
+        links: {
+          dependencies: '/api/v1/crates/rand/1.0.1/dependencies',
+          version_downloads: '/api/v1/crates/rand/1.0.1/downloads',
+        },
+        num: '1.0.1',
+        published_by: null,
+        readme_path: '/api/v1/crates/rand/1.0.1/readme',
+        rust_version: null,
+        updated_at: '2017-02-24T12:34:56Z',
+        yank_message: null,
+        yanked: false,
+      },
+    ],
+    meta: {
+      extra_downloads: [],
+    },
+  });
+});