msw: Migrate models to new @msw/data API

Author: Turbo87

packages/crates-io-msw/index.js

@@ -14,21 +14,6 @@ import teamHandlers from './handlers/teams.js';
 import trustpubHandlers from './handlers/trustpub.js';
 import userHandlers from './handlers/users.js';
 import versionHandlers from './handlers/versions.js';
-import apiToken from './models/api-token.js';
-import category from './models/category.js';
-import crateOwnerInvitation from './models/crate-owner-invitation.js';
-import crateOwnership from './models/crate-ownership.js';
-import crate from './models/crate.js';
-import dependency from './models/dependency.js';
-import keyword from './models/keyword.js';
-import mswSession from './models/msw-session.js';
-import team from './models/team.js';
-import trustpubGithubConfig from './models/trustpub/github-config.js';
-import trustpubGitlabConfig from './models/trustpub/gitlab-config.js';
-import user from './models/user.js';
-import versionDownload from './models/version-download.js';
-import version from './models/version.js';
-import { factory } from './utils/factory.js';
 
 export const handlers = [
   ...apiTokenHandlers,
@@ -49,19 +34,4 @@ export const handlers = [
   ...versionHandlers,
 ];
 
-export const db = factory({
-  apiToken,
-  category,
-  crateOwnerInvitation,
-  crateOwnership,
-  crate,
-  dependency,
-  keyword,
-  mswSession,
-  team,
-  trustpubGithubConfig,
-  trustpubGitlabConfig,
-  user,
-  versionDownload,
-  version,
-});
+export { db } from './models/index.js';

packages/crates-io-msw/models/api-token.js

@@ -1,39 +1,48 @@
-import { nullable, oneOf, primaryKey } from '@mswjs/data';
+import { Collection } from '@msw/data';
+import { z } from 'zod';
 
 import { applyDefault } from '../utils/defaults.js';
+import { preCreateExtension } from '../utils/pre-create-extension.js';
 import { seededRandom } from '../utils/random.js';
 
-export default {
-  id: primaryKey(Number),
-
-  crateScopes: nullable(Array),
-  createdAt: String,
-  endpointScopes: nullable(Array),
-  expiredAt: nullable(String),
-  lastUsedAt: nullable(String),
-  name: String,
-  token: String,
-  revoked: Boolean,
-
-  user: oneOf('user'),
-
-  preCreate(attrs, counter) {
-    applyDefault(attrs, 'id', () => counter);
-    applyDefault(attrs, 'crateScopes', () => null);
-    applyDefault(attrs, 'createdAt', () => '2017-11-19T17:59:22Z');
-    applyDefault(attrs, 'endpointScopes', () => null);
-    applyDefault(attrs, 'expiredAt', () => null);
-    applyDefault(attrs, 'lastUsedAt', () => null);
-    applyDefault(attrs, 'name', () => `API Token ${attrs.id}`);
-    applyDefault(attrs, 'token', () => generateToken(counter));
-    applyDefault(attrs, 'revoked', () => false);
-
-    if (!attrs.user) {
-      throw new Error('Missing `user` relationship on `api-token`');
-    }
-  },
-};
+const schema = z.object({
+  id: z.number(),
+
+  crateScopes: z.array(z.any()).nullable(),
+  createdAt: z.string(),
+  endpointScopes: z.array(z.any()).nullable(),
+  expiredAt: z.string().nullable(),
+  lastUsedAt: z.string().nullable(),
+  name: z.string(),
+  token: z.string(),
+  revoked: z.boolean(),
+
+  user: z.any(),
+});
+
+function preCreate(attrs, counter) {
+  applyDefault(attrs, 'id', () => counter);
+  applyDefault(attrs, 'crateScopes', () => null);
+  applyDefault(attrs, 'createdAt', () => '2017-11-19T17:59:22Z');
+  applyDefault(attrs, 'endpointScopes', () => null);
+  applyDefault(attrs, 'expiredAt', () => null);
+  applyDefault(attrs, 'lastUsedAt', () => null);
+  applyDefault(attrs, 'name', () => `API Token ${attrs.id}`);
+  applyDefault(attrs, 'token', () => generateToken(counter));
+  applyDefault(attrs, 'revoked', () => false);
+
+  if (!attrs.user) {
+    throw new Error('Missing `user` relationship on `api-token`');
+  }
+}
 
 function generateToken(seed) {
   return seededRandom(seed).toString().slice(2);
 }
+
+const collection = new Collection({
+  schema,
+  extensions: [preCreateExtension(preCreate)],
+});
+
+export default collection;

packages/crates-io-msw/models/api-token.test.js

@@ -2,15 +2,15 @@ import { test } from 'vitest';
 
 import { db } from '../index.js';
 
-test('throws if `user` is not set', ({ expect }) => {
-  expect(() => db.apiToken.create()).toThrowErrorMatchingInlineSnapshot(
+test('throws if `user` is not set', async ({ expect }) => {
+  await expect(() => db.apiToken.create()).rejects.toThrowErrorMatchingInlineSnapshot(
     `[Error: Missing \`user\` relationship on \`api-token\`]`,
   );
 });
 
-test('happy path', ({ expect }) => {
-  let user = db.user.create();
-  let session = db.apiToken.create({ user });
+test('happy path', async ({ expect }) => {
+  let user = await db.user.create();
+  let session = await db.apiToken.create({ user });
   expect(session).toMatchInlineSnapshot(`
     {
       "crateScopes": null,
@@ -34,11 +34,7 @@ test('happy path', ({ expect }) => {
         "name": "User 1",
         "publishNotifications": true,
         "url": "https://github.com/user-1",
-        Symbol(type): "user",
-        Symbol(primaryKey): "id",
       },
-      Symbol(type): "apiToken",
-      Symbol(primaryKey): "id",
     }
   `);
 });

packages/crates-io-msw/models/category.js

@@ -1,23 +1,32 @@
-import { nullable, primaryKey } from '@mswjs/data';
+import { Collection } from '@msw/data';
+import { z } from 'zod';
 
 import { applyDefault } from '../utils/defaults.js';
+import { preCreateExtension } from '../utils/pre-create-extension.js';
 import { dasherize } from '../utils/strings.js';
 
-export default {
-  id: primaryKey(String),
+const schema = z.object({
+  id: z.string(),
 
-  category: String,
-  slug: String,
-  description: String,
-  created_at: String,
-  crates_cnt: nullable(Number),
+  category: z.string(),
+  slug: z.string(),
+  description: z.string(),
+  created_at: z.string(),
+  crates_cnt: z.number().nullable(),
+});
 
-  preCreate(attrs, counter) {
-    applyDefault(attrs, 'category', () => `Category ${counter}`);
-    applyDefault(attrs, 'slug', () => dasherize(attrs.category));
-    applyDefault(attrs, 'id', () => attrs.slug);
-    applyDefault(attrs, 'description', () => `This is the description for the category called "${attrs.category}"`);
-    applyDefault(attrs, 'created_at', () => '2010-06-16T21:30:45Z');
-    applyDefault(attrs, 'crates_cnt', () => null);
-  },
-};
+function preCreate(attrs, counter) {
+  applyDefault(attrs, 'category', () => `Category ${counter}`);
+  applyDefault(attrs, 'slug', () => dasherize(attrs.category));
+  applyDefault(attrs, 'id', () => attrs.slug);
+  applyDefault(attrs, 'description', () => `This is the description for the category called "${attrs.category}"`);
+  applyDefault(attrs, 'created_at', () => '2010-06-16T21:30:45Z');
+  applyDefault(attrs, 'crates_cnt', () => null);
+}
+
+const collection = new Collection({
+  schema,
+  extensions: [preCreateExtension(preCreate)],
+});
+
+export default collection;

packages/crates-io-msw/models/category.test.js

@@ -2,8 +2,8 @@ import { test } from 'vitest';
 
 import { db } from '../index.js';
 
-test('default are applied', ({ expect }) => {
-  let category = db.category.create();
+test('default are applied', async ({ expect }) => {
+  let category = await db.category.create();
   expect(category).toMatchInlineSnapshot(`
     {
       "category": "Category 1",
@@ -12,14 +12,12 @@ test('default are applied', ({ expect }) => {
       "description": "This is the description for the category called "Category 1"",
       "id": "category-1",
       "slug": "category-1",
-      Symbol(type): "category",
-      Symbol(primaryKey): "id",
     }
   `);
 });
 
-test('name can be set', ({ expect }) => {
-  let category = db.category.create({ category: 'Network programming' });
+test('name can be set', async ({ expect }) => {
+  let category = await db.category.create({ category: 'Network programming' });
   expect(category).toMatchInlineSnapshot(`
     {
       "category": "Network programming",
@@ -28,8 +26,6 @@ test('name can be set', ({ expect }) => {
       "description": "This is the description for the category called "Network programming"",
       "id": "network-programming",
       "slug": "network-programming",
-      Symbol(type): "category",
-      Symbol(primaryKey): "id",
     }
   `);
 });

packages/crates-io-msw/models/crate-owner-invitation.js

@@ -1,32 +1,41 @@
-import { oneOf, primaryKey } from '@mswjs/data';
+import { Collection } from '@msw/data';
+import { z } from 'zod';
 
 import { applyDefault } from '../utils/defaults.js';
+import { preCreateExtension } from '../utils/pre-create-extension.js';
 
-export default {
-  id: primaryKey(Number),
-
-  createdAt: String,
-  expiresAt: String,
-  token: String,
-
-  crate: oneOf('crate'),
-  invitee: oneOf('user'),
-  inviter: oneOf('user'),
-
-  preCreate(attrs, counter) {
-    applyDefault(attrs, 'id', () => counter);
-    applyDefault(attrs, 'createdAt', () => '2016-12-24T12:34:56Z');
-    applyDefault(attrs, 'expiresAt', () => '2017-01-24T12:34:56Z');
-    applyDefault(attrs, 'token', () => `secret-token-${attrs.id}`);
-
-    if (!attrs.crate) {
-      throw new Error(`Missing \`crate\` relationship on \`crate-owner-invitation\``);
-    }
-    if (!attrs.invitee) {
-      throw new Error(`Missing \`invitee\` relationship on \`crate-owner-invitation\``);
-    }
-    if (!attrs.inviter) {
-      throw new Error(`Missing \`inviter\` relationship on \`crate-owner-invitation\``);
-    }
-  },
-};
+const schema = z.object({
+  id: z.number(),
+
+  createdAt: z.string(),
+  expiresAt: z.string(),
+  token: z.string(),
+
+  crate: z.any(),
+  invitee: z.any(),
+  inviter: z.any(),
+});
+
+function preCreate(attrs, counter) {
+  applyDefault(attrs, 'id', () => counter);
+  applyDefault(attrs, 'createdAt', () => '2016-12-24T12:34:56Z');
+  applyDefault(attrs, 'expiresAt', () => '2017-01-24T12:34:56Z');
+  applyDefault(attrs, 'token', () => `secret-token-${attrs.id}`);
+
+  if (!attrs.crate) {
+    throw new Error(`Missing \`crate\` relationship on \`crate-owner-invitation\``);
+  }
+  if (!attrs.invitee) {
+    throw new Error(`Missing \`invitee\` relationship on \`crate-owner-invitation\``);
+  }
+  if (!attrs.inviter) {
+    throw new Error(`Missing \`inviter\` relationship on \`crate-owner-invitation\``);
+  }
+}
+
+const collection = new Collection({
+  schema,
+  extensions: [preCreateExtension(preCreate)],
+});
+
+export default collection;

packages/crates-io-msw/models/crate-owner-invitation.test.js

@@ -2,35 +2,35 @@ import { test } from 'vitest';
 
 import { db } from '../index.js';
 
-test('throws if `crate` is not set', ({ expect }) => {
-  let inviter = db.user.create();
-  let invitee = db.user.create();
-  expect(() => db.crateOwnerInvitation.create({ inviter, invitee })).toThrowErrorMatchingInlineSnapshot(
+test('throws if `crate` is not set', async ({ expect }) => {
+  let inviter = await db.user.create();
+  let invitee = await db.user.create();
+  await expect(() => db.crateOwnerInvitation.create({ inviter, invitee })).rejects.toThrowErrorMatchingInlineSnapshot(
     `[Error: Missing \`crate\` relationship on \`crate-owner-invitation\`]`,
   );
 });
 
-test('throws if `inviter` is not set', ({ expect }) => {
-  let crate = db.crate.create();
-  let invitee = db.user.create();
-  expect(() => db.crateOwnerInvitation.create({ crate, invitee })).toThrowErrorMatchingInlineSnapshot(
+test('throws if `inviter` is not set', async ({ expect }) => {
+  let crate = await db.crate.create();
+  let invitee = await db.user.create();
+  await expect(() => db.crateOwnerInvitation.create({ crate, invitee })).rejects.toThrowErrorMatchingInlineSnapshot(
     `[Error: Missing \`inviter\` relationship on \`crate-owner-invitation\`]`,
   );
 });
 
-test('throws if `invitee` is not set', ({ expect }) => {
-  let crate = db.crate.create();
-  let inviter = db.user.create();
-  expect(() => db.crateOwnerInvitation.create({ crate, inviter })).toThrowErrorMatchingInlineSnapshot(
+test('throws if `invitee` is not set', async ({ expect }) => {
+  let crate = await db.crate.create();
+  let inviter = await db.user.create();
+  await expect(() => db.crateOwnerInvitation.create({ crate, inviter })).rejects.toThrowErrorMatchingInlineSnapshot(
     `[Error: Missing \`invitee\` relationship on \`crate-owner-invitation\`]`,
   );
 });
 
-test('happy path', ({ expect }) => {
-  let crate = db.crate.create();
-  let inviter = db.user.create();
-  let invitee = db.user.create();
-  let invite = db.crateOwnerInvitation.create({ crate, inviter, invitee });
+test('happy path', async ({ expect }) => {
+  let crate = await db.crate.create();
+  let inviter = await db.user.create();
+  let invitee = await db.user.create();
+  let invite = await db.crateOwnerInvitation.create({ crate, inviter, invitee });
   expect(invite).toMatchInlineSnapshot(`
     {
       "crate": {
@@ -49,8 +49,6 @@ test('happy path', ({ expect }) => {
         "repository": null,
         "trustpubOnly": false,
         "updated_at": "2017-02-24T12:34:56Z",
-        Symbol(type): "crate",
-        Symbol(primaryKey): "id",
       },
       "createdAt": "2016-12-24T12:34:56Z",
       "expiresAt": "2017-01-24T12:34:56Z",
@@ -67,8 +65,6 @@ test('happy path', ({ expect }) => {
         "name": "User 2",
         "publishNotifications": true,
         "url": "https://github.com/user-2",
-        Symbol(type): "user",
-        Symbol(primaryKey): "id",
       },
       "inviter": {
         "avatar": "https://avatars1.githubusercontent.com/u/14631425?v=4",
@@ -82,12 +78,8 @@ test('happy path', ({ expect }) => {
         "name": "User 1",
         "publishNotifications": true,
         "url": "https://github.com/user-1",
-        Symbol(type): "user",
-        Symbol(primaryKey): "id",
       },
       "token": "secret-token-1",
-      Symbol(type): "crateOwnerInvitation",
-      Symbol(primaryKey): "id",
     }
   `);
 });