msw: Implement GET /api/v1/crates/:name request handler

Author: Turbo87

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

@@ -1,3 +1,4 @@
+import getCrate from './crates/get.js';
 import listCrates from './crates/list.js';
 
-export default [listCrates];
+export default [listCrates, getCrate];

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

@@ -0,0 +1,55 @@
+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 { serializeVersion } from '../../serializers/version.js';
+import { notFound } from '../../utils/handlers.js';
+
+const DEFAULT_INCLUDES = ['versions', 'keywords', 'categories'];
+
+export default http.get('/api/v1/crates/:name', async ({ request, params }) => {
+  let { name } = params;
+  let canonicalName = toCanonicalName(name);
+  let crate = db.crate.findMany({}).find(it => toCanonicalName(it.name) === canonicalName);
+  if (!crate) return notFound();
+
+  let versions = db.version.findMany({ where: { crate: { id: { equals: crate.id } } } });
+  versions.sort((a, b) => b.id - a.id);
+
+  let url = new URL(request.url);
+  let include = url.searchParams.get('include');
+  let includes = include == null || include === 'full' ? DEFAULT_INCLUDES : include.split(',');
+
+  let includeCategories = includes.includes('categories');
+  let includeKeywords = includes.includes('keywords');
+  let includeVersions = includes.includes('versions');
+  let includeDefaultVersion = includes.includes('default_version');
+
+  let serializedCrate = serializeCrate(crate, {
+    calculateVersions: includeVersions,
+    includeCategories,
+    includeKeywords,
+    includeVersions,
+  });
+
+  let serializedVersions = null;
+  if (includeVersions) {
+    serializedVersions = versions.map(v => serializeVersion(v));
+  } else if (includeDefaultVersion) {
+    let defaultVersion = versions.find(v => v.num === serializedCrate.default_version);
+    serializedVersions = [serializeVersion(defaultVersion)];
+  }
+
+  return HttpResponse.json({
+    crate: serializedCrate,
+    categories: includeCategories ? crate.categories.map(c => serializeCategory(c)) : null,
+    keywords: includeKeywords ? crate.keywords.map(k => serializeKeyword(k)) : null,
+    versions: serializedVersions,
+  });
+});
+
+function toCanonicalName(name) {
+  return name.toLowerCase().replace(/-/g, '_');
+}

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

@@ -0,0 +1,330 @@
+import { assert, test } from 'vitest';
+
+import { db } from '../../index.js';
+
+test('returns 404 for unknown crates', async function () {
+  let response = await fetch('/api/v1/crates/foo');
+  assert.strictEqual(response.status, 404);
+  assert.deepEqual(await response.json(), { errors: [{ detail: 'Not Found' }] });
+});
+
+test('returns a crate object for known crates', async function () {
+  let crate = db.crate.create({ name: 'rand' });
+  db.version.create({ crate, num: '1.0.0-beta.1' });
+
+  let response = await fetch('/api/v1/crates/rand');
+  assert.strictEqual(response.status, 200);
+  assert.deepEqual(await response.json(), {
+    categories: [],
+    crate: {
+      badges: [],
+      categories: [],
+      created_at: '2010-06-16T21:30:45Z',
+      default_version: '1.0.0-beta.1',
+      description: 'This is the description for the crate called "rand"',
+      documentation: null,
+      downloads: 37_035,
+      homepage: null,
+      id: 'rand',
+      keywords: [],
+      links: {
+        owner_team: '/api/v1/crates/rand/owner_team',
+        owner_user: '/api/v1/crates/rand/owner_user',
+        reverse_dependencies: '/api/v1/crates/rand/reverse_dependencies',
+        version_downloads: '/api/v1/crates/rand/downloads',
+        versions: '/api/v1/crates/rand/versions',
+      },
+      max_version: '1.0.0-beta.1',
+      max_stable_version: null,
+      name: 'rand',
+      newest_version: '1.0.0-beta.1',
+      repository: null,
+      recent_downloads: 321,
+      updated_at: '2017-02-24T12:34:56Z',
+      versions: [1],
+      yanked: false,
+    },
+    keywords: [],
+    versions: [
+      {
+        id: 1,
+        crate: 'rand',
+        crate_size: 162_963,
+        created_at: '2010-06-16T21:30:45Z',
+        dl_path: '/api/v1/crates/rand/1.0.0-beta.1/download',
+        downloads: 3702,
+        features: {},
+        license: 'MIT',
+        links: {
+          dependencies: '/api/v1/crates/rand/1.0.0-beta.1/dependencies',
+          version_downloads: '/api/v1/crates/rand/1.0.0-beta.1/downloads',
+        },
+        num: '1.0.0-beta.1',
+        published_by: null,
+        readme_path: '/api/v1/crates/rand/1.0.0-beta.1/readme',
+        rust_version: null,
+        updated_at: '2017-02-24T12:34:56Z',
+        yanked: false,
+        yank_message: null,
+      },
+    ],
+  });
+});
+
+test('works for non-canonical names', async function () {
+  let crate = db.crate.create({ name: 'foo-bar' });
+  db.version.create({ crate, num: '1.0.0-beta.1' });
+
+  let response = await fetch('/api/v1/crates/foo_bar');
+  assert.strictEqual(response.status, 200);
+  assert.deepEqual(await response.json(), {
+    categories: [],
+    crate: {
+      badges: [],
+      categories: [],
+      created_at: '2010-06-16T21:30:45Z',
+      default_version: '1.0.0-beta.1',
+      description: 'This is the description for the crate called "foo-bar"',
+      documentation: null,
+      downloads: 37_035,
+      homepage: null,
+      id: 'foo-bar',
+      keywords: [],
+      links: {
+        owner_team: '/api/v1/crates/foo-bar/owner_team',
+        owner_user: '/api/v1/crates/foo-bar/owner_user',
+        reverse_dependencies: '/api/v1/crates/foo-bar/reverse_dependencies',
+        version_downloads: '/api/v1/crates/foo-bar/downloads',
+        versions: '/api/v1/crates/foo-bar/versions',
+      },
+      max_version: '1.0.0-beta.1',
+      max_stable_version: null,
+      name: 'foo-bar',
+      newest_version: '1.0.0-beta.1',
+      repository: null,
+      recent_downloads: 321,
+      updated_at: '2017-02-24T12:34:56Z',
+      versions: [1],
+      yanked: false,
+    },
+    keywords: [],
+    versions: [
+      {
+        id: 1,
+        crate: 'foo-bar',
+        crate_size: 162_963,
+        created_at: '2010-06-16T21:30:45Z',
+        dl_path: '/api/v1/crates/foo-bar/1.0.0-beta.1/download',
+        downloads: 3702,
+        features: {},
+        license: 'MIT',
+        links: {
+          dependencies: '/api/v1/crates/foo-bar/1.0.0-beta.1/dependencies',
+          version_downloads: '/api/v1/crates/foo-bar/1.0.0-beta.1/downloads',
+        },
+        num: '1.0.0-beta.1',
+        published_by: null,
+        readme_path: '/api/v1/crates/foo-bar/1.0.0-beta.1/readme',
+        rust_version: null,
+        updated_at: '2017-02-24T12:34:56Z',
+        yanked: false,
+        yank_message: null,
+      },
+    ],
+  });
+});
+
+test('includes related versions', async function () {
+  let crate = db.crate.create({ name: 'rand' });
+  db.version.create({ crate, num: '1.0.0' });
+  db.version.create({ crate, num: '1.1.0' });
+  db.version.create({ crate, num: '1.2.0' });
+
+  let response = await fetch('/api/v1/crates/rand');
+  assert.strictEqual(response.status, 200);
+
+  let responsePayload = await response.json();
+  assert.deepEqual(responsePayload.crate.versions, [1, 2, 3]);
+  assert.deepEqual(responsePayload.versions, [
+    {
+      id: 3,
+      crate: 'rand',
+      crate_size: 488_889,
+      created_at: '2010-06-16T21:30:45Z',
+      dl_path: '/api/v1/crates/rand/1.2.0/download',
+      downloads: 11_106,
+      features: {},
+      license: 'MIT/Apache-2.0',
+      links: {
+        dependencies: '/api/v1/crates/rand/1.2.0/dependencies',
+        version_downloads: '/api/v1/crates/rand/1.2.0/downloads',
+      },
+      num: '1.2.0',
+      published_by: null,
+      readme_path: '/api/v1/crates/rand/1.2.0/readme',
+      rust_version: null,
+      updated_at: '2017-02-24T12:34:56Z',
+      yanked: false,
+      yank_message: null,
+    },
+    {
+      id: 2,
+      crate: 'rand',
+      crate_size: 325_926,
+      created_at: '2010-06-16T21:30:45Z',
+      dl_path: '/api/v1/crates/rand/1.1.0/download',
+      downloads: 7404,
+      features: {},
+      license: 'Apache-2.0',
+      links: {
+        dependencies: '/api/v1/crates/rand/1.1.0/dependencies',
+        version_downloads: '/api/v1/crates/rand/1.1.0/downloads',
+      },
+      num: '1.1.0',
+      published_by: null,
+      readme_path: '/api/v1/crates/rand/1.1.0/readme',
+      rust_version: null,
+      updated_at: '2017-02-24T12:34:56Z',
+      yanked: false,
+      yank_message: null,
+    },
+    {
+      id: 1,
+      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: {},
+      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',
+      yanked: false,
+      yank_message: null,
+    },
+  ]);
+});
+
+test('includes related categories', async function () {
+  let noStd = db.category.create({ category: 'no-std' });
+  db.category.create({ category: 'cli' });
+  let crate = db.crate.create({ name: 'rand', categories: [noStd] });
+  db.version.create({ crate });
+
+  let response = await fetch('/api/v1/crates/rand');
+  assert.strictEqual(response.status, 200);
+
+  let responsePayload = await response.json();
+  assert.deepEqual(responsePayload.crate.categories, ['no-std']);
+  assert.deepEqual(responsePayload.categories, [
+    {
+      id: 'no-std',
+      category: 'no-std',
+      crates_cnt: 1,
+      created_at: '2010-06-16T21:30:45Z',
+      description: 'This is the description for the category called "no-std"',
+      slug: 'no-std',
+    },
+  ]);
+});
+
+test('includes related keywords', async function () {
+  let noStd = db.keyword.create({ keyword: 'no-std' });
+  db.keyword.create({ keyword: 'cli' });
+  let crate = db.crate.create({ name: 'rand', keywords: [noStd] });
+  db.version.create({ crate });
+
+  let response = await fetch('/api/v1/crates/rand');
+  assert.strictEqual(response.status, 200);
+
+  let responsePayload = await response.json();
+  assert.deepEqual(responsePayload.crate.keywords, ['no-std']);
+  assert.deepEqual(responsePayload.keywords, [
+    {
+      crates_cnt: 1,
+      id: 'no-std',
+      keyword: 'no-std',
+    },
+  ]);
+});
+
+test('without versions included', async function () {
+  db.category.create({ category: 'no-std' });
+  db.category.create({ category: 'cli' });
+  db.keyword.create({ keyword: 'no-std' });
+  db.keyword.create({ keyword: 'cli' });
+  let crate = db.crate.create({ name: 'rand', categoryIds: ['no-std'], keywordIds: ['no-std'] });
+  db.version.create({ crate, num: '1.0.0' });
+  db.version.create({ crate, num: '1.1.0' });
+  db.version.create({ crate, num: '1.2.0' });
+
+  let req = await fetch('/api/v1/crates/rand');
+  let expected = await req.json();
+
+  let response = await fetch('/api/v1/crates/rand?include=keywords,categories');
+  assert.strictEqual(response.status, 200);
+
+  let responsePayload = await response.json();
+  assert.deepEqual(responsePayload, {
+    ...expected,
+    crate: {
+      ...expected.crate,
+      max_version: '0.0.0',
+      newest_version: '0.0.0',
+      max_stable_version: null,
+      versions: null,
+    },
+    versions: null,
+  });
+});
+
+test('includes default_version', async function () {
+  let crate = db.crate.create({ name: 'rand' });
+  db.version.create({ crate, num: '1.0.0' });
+  db.version.create({ crate, num: '1.1.0' });
+  db.version.create({ crate, num: '1.2.0' });
+
+  let req = await fetch('/api/v1/crates/rand');
+  let expected = await req.json();
+
+  let response = await fetch('/api/v1/crates/rand?include=default_version');
+  assert.strictEqual(response.status, 200);
+
+  let responsePayload = await response.json();
+  let default_version = expected.versions.find(it => it.num === responsePayload.crate.default_version);
+  assert.deepEqual(responsePayload, {
+    ...expected,
+    crate: {
+      ...expected.crate,
+      categories: null,
+      keywords: null,
+      max_version: '0.0.0',
+      newest_version: '0.0.0',
+      max_stable_version: null,
+      versions: null,
+    },
+    categories: null,
+    keywords: null,
+    versions: [default_version],
+  });
+
+  let resp_both = await fetch('/api/v1/crates/rand?include=versions,default_version');
+  assert.strictEqual(response.status, 200);
+  assert.deepEqual(await resp_both.json(), {
+    ...expected,
+    crate: {
+      ...expected.crate,
+      categories: null,
+      keywords: null,
+    },
+    categories: null,
+    keywords: null,
+  });
+});