msw: Implement GET /api/v1/summary request handler

Author: Turbo87

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

@@ -0,0 +1,36 @@
+import { http, HttpResponse } from 'msw';
+
+import { db } from '../index.js';
+import { serializeCategory } from '../serializers/category.js';
+import { serializeCrate } from '../serializers/crate.js';
+import { serializeKeyword } from '../serializers/keyword.js';
+import { compareDates } from '../utils/dates.js';
+
+export default [
+  http.get('/api/v1/summary', () => {
+    let crates = db.crate.findMany({});
+
+    let just_updated = crates.sort((a, b) => compareDates(b.updated_at, a.updated_at)).slice(0, 10);
+    let most_downloaded = crates.sort((a, b) => b.downloads - a.downloads).slice(0, 10);
+    let new_crates = crates.sort((a, b) => b.id - a.id).slice(0, 10);
+    let most_recently_downloaded = crates.sort((a, b) => b.recent_downloads - a.recent_downloads).slice(0, 10);
+
+    let num_crates = crates.length;
+    // eslint-disable-next-line unicorn/no-array-reduce
+    let num_downloads = crates.reduce((sum, crate) => sum + crate.downloads, 0);
+
+    let popularCategories = db.category.findMany({ take: 10 });
+    let popularKeywords = db.keyword.findMany({ take: 10 });
+
+    return HttpResponse.json({
+      just_updated: just_updated.map(c => serializeCrate(c)),
+      most_downloaded: most_downloaded.map(c => serializeCrate(c)),
+      new_crates: new_crates.map(c => serializeCrate(c)),
+      most_recently_downloaded: most_recently_downloaded.map(c => serializeCrate(c)),
+      num_crates,
+      num_downloads,
+      popular_categories: popularCategories.map(it => serializeCategory(it)),
+      popular_keywords: popularKeywords.map(it => serializeKeyword(it)),
+    });
+  }),
+];

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

@@ -0,0 +1,170 @@
+import { assert, test } from 'vitest';
+
+import { db } from '../index.js';
+
+test('empty case', async function () {
+  let response = await fetch('/api/v1/summary');
+  assert.strictEqual(response.status, 200);
+  assert.deepEqual(await response.json(), {
+    just_updated: [],
+    most_downloaded: [],
+    most_recently_downloaded: [],
+    new_crates: [],
+    num_crates: 0,
+    num_downloads: 0,
+    popular_categories: [],
+    popular_keywords: [],
+  });
+});
+
+test('returns the data for the front page', async function () {
+  Array.from({ length: 15 }, () => db.category.create());
+  Array.from({ length: 25 }, () => db.keyword.create());
+  let crates = Array.from({ length: 20 }, () => db.crate.create());
+  crates.forEach(crate => db.version.create({ crate }));
+
+  let response = await fetch('/api/v1/summary');
+  assert.strictEqual(response.status, 200);
+
+  let responsePayload = await response.json();
+
+  assert.strictEqual(responsePayload.just_updated.length, 10);
+  assert.deepEqual(responsePayload.just_updated[0], {
+    id: 'crate-1',
+    badges: [],
+    categories: null,
+    created_at: '2010-06-16T21:30:45Z',
+    default_version: '1.0.0',
+    description: 'This is the description for the crate called "crate-1"',
+    documentation: null,
+    downloads: 37_035,
+    homepage: null,
+    keywords: null,
+    links: {
+      owner_team: '/api/v1/crates/crate-1/owner_team',
+      owner_user: '/api/v1/crates/crate-1/owner_user',
+      reverse_dependencies: '/api/v1/crates/crate-1/reverse_dependencies',
+      version_downloads: '/api/v1/crates/crate-1/downloads',
+      versions: '/api/v1/crates/crate-1/versions',
+    },
+    max_version: '1.0.0',
+    max_stable_version: '1.0.0',
+    name: 'crate-1',
+    newest_version: '1.0.0',
+    recent_downloads: 321,
+    repository: null,
+    updated_at: '2017-02-24T12:34:56Z',
+    versions: null,
+    yanked: false,
+  });
+
+  assert.strictEqual(responsePayload.most_downloaded.length, 10);
+  assert.deepEqual(responsePayload.most_downloaded[0], {
+    id: 'crate-4',
+    badges: [],
+    categories: null,
+    created_at: '2010-06-16T21:30:45Z',
+    default_version: '1.0.3',
+    description: 'This is the description for the crate called "crate-4"',
+    documentation: null,
+    downloads: 148_140,
+    homepage: null,
+    keywords: null,
+    links: {
+      owner_team: '/api/v1/crates/crate-4/owner_team',
+      owner_user: '/api/v1/crates/crate-4/owner_user',
+      reverse_dependencies: '/api/v1/crates/crate-4/reverse_dependencies',
+      version_downloads: '/api/v1/crates/crate-4/downloads',
+      versions: '/api/v1/crates/crate-4/versions',
+    },
+    max_version: '1.0.3',
+    max_stable_version: '1.0.3',
+    name: 'crate-4',
+    newest_version: '1.0.3',
+    repository: null,
+    recent_downloads: 963,
+    updated_at: '2017-02-24T12:34:56Z',
+    versions: null,
+    yanked: false,
+  });
+
+  assert.strictEqual(responsePayload.most_recently_downloaded.length, 10);
+  assert.deepEqual(responsePayload.most_recently_downloaded[0], {
+    id: 'crate-11',
+    badges: [],
+    categories: null,
+    created_at: '2010-06-16T21:30:45Z',
+    default_version: '1.0.10',
+    description: 'This is the description for the crate called "crate-11"',
+    documentation: null,
+    downloads: 86_415,
+    homepage: null,
+    keywords: null,
+    links: {
+      owner_team: '/api/v1/crates/crate-11/owner_team',
+      owner_user: '/api/v1/crates/crate-11/owner_user',
+      reverse_dependencies: '/api/v1/crates/crate-11/reverse_dependencies',
+      version_downloads: '/api/v1/crates/crate-11/downloads',
+      versions: '/api/v1/crates/crate-11/versions',
+    },
+    max_version: '1.0.10',
+    max_stable_version: '1.0.10',
+    name: 'crate-11',
+    newest_version: '1.0.10',
+    repository: null,
+    recent_downloads: 3852,
+    updated_at: '2017-02-24T12:34:56Z',
+    versions: null,
+    yanked: false,
+  });
+
+  assert.strictEqual(responsePayload.new_crates.length, 10);
+  assert.deepEqual(responsePayload.new_crates[0], {
+    id: 'crate-20',
+    badges: [],
+    categories: null,
+    created_at: '2010-06-16T21:30:45Z',
+    default_version: '1.0.19',
+    description: 'This is the description for the crate called "crate-20"',
+    documentation: null,
+    downloads: 98_760,
+    homepage: null,
+    keywords: null,
+    links: {
+      owner_team: '/api/v1/crates/crate-20/owner_team',
+      owner_user: '/api/v1/crates/crate-20/owner_user',
+      reverse_dependencies: '/api/v1/crates/crate-20/reverse_dependencies',
+      version_downloads: '/api/v1/crates/crate-20/downloads',
+      versions: '/api/v1/crates/crate-20/versions',
+    },
+    max_version: '1.0.19',
+    max_stable_version: '1.0.19',
+    name: 'crate-20',
+    newest_version: '1.0.19',
+    repository: null,
+    recent_downloads: 1605,
+    updated_at: '2017-02-24T12:34:56Z',
+    versions: null,
+    yanked: false,
+  });
+
+  assert.strictEqual(responsePayload.num_crates, 20);
+  assert.strictEqual(responsePayload.num_downloads, 1_518_435);
+
+  assert.strictEqual(responsePayload.popular_categories.length, 10);
+  assert.deepEqual(responsePayload.popular_categories[0], {
+    id: 'category-1',
+    category: 'Category 1',
+    crates_cnt: 0,
+    created_at: '2010-06-16T21:30:45Z',
+    description: 'This is the description for the category called "Category 1"',
+    slug: 'category-1',
+  });
+
+  assert.strictEqual(responsePayload.popular_keywords.length, 10);
+  assert.deepEqual(responsePayload.popular_keywords[0], {
+    id: 'keyword-1',
+    crates_cnt: 0,
+    keyword: 'keyword-1',
+  });
+});

packages/crates-io-msw/index.js

@@ -6,6 +6,7 @@ import inviteHandlers from './handlers/invites.js';
 import keywordHandlers from './handlers/keywords.js';
 import metadataHandlers from './handlers/metadata.js';
 import sessionHandlers from './handlers/sessions.js';
+import summaryHandlers from './handlers/summary.js';
 import teamHandlers from './handlers/teams.js';
 import userHandlers from './handlers/users.js';
 import versionHandlers from './handlers/versions.js';
@@ -32,6 +33,7 @@ export const handlers = [
   ...keywordHandlers,
   ...metadataHandlers,
   ...sessionHandlers,
+  ...summaryHandlers,
   ...teamHandlers,
   ...userHandlers,
   ...versionHandlers,