feat(server): add settings model (#10755)

close CLOUD-166

packages/backend/server/src/models/__tests__/settings.spec.ts

@@ -0,0 +1,98 @@
+import { randomUUID } from 'node:crypto';
+import { mock } from 'node:test';
+
+import ava, { TestFn } from 'ava';
+import { ZodError } from 'zod';
+
+import { createTestingModule, type TestingModule } from '../../__tests__/utils';
+import { Config } from '../../base/config';
+import { Models, User } from '..';
+
+interface Context {
+  config: Config;
+  module: TestingModule;
+  models: Models;
+}
+
+const test = ava as TestFn<Context>;
+
+test.before(async t => {
+  const module = await createTestingModule();
+
+  t.context.models = module.get(Models);
+  t.context.config = module.get(Config);
+  t.context.module = module;
+  await t.context.module.initTestingDB();
+});
+
+let user: User;
+
+test.beforeEach(async t => {
+  user = await t.context.models.user.create({
+    email: `test-${randomUUID()}@affine.pro`,
+  });
+});
+
+test.afterEach.always(() => {
+  mock.reset();
+  mock.timers.reset();
+});
+
+test.after(async t => {
+  await t.context.module.close();
+});
+
+test('should get a user settings with default value', async t => {
+  const settings = await t.context.models.settings.get(user.id);
+  t.deepEqual(settings, {
+    receiveInvitationEmail: true,
+    receiveMentionEmail: true,
+  });
+});
+
+test('should update a user settings', async t => {
+  const settings = await t.context.models.settings.set(user.id, {
+    receiveInvitationEmail: false,
+  });
+  t.deepEqual(settings, {
+    receiveInvitationEmail: false,
+    receiveMentionEmail: true,
+  });
+  const settings2 = await t.context.models.settings.get(user.id);
+  t.deepEqual(settings2, settings);
+
+  // update existing setting
+  const setting3 = await t.context.models.settings.set(user.id, {
+    receiveInvitationEmail: true,
+  });
+  t.deepEqual(setting3, {
+    receiveInvitationEmail: true,
+    receiveMentionEmail: true,
+  });
+  const setting4 = await t.context.models.settings.get(user.id);
+  t.deepEqual(setting4, setting3);
+
+  const setting5 = await t.context.models.settings.set(user.id, {
+    receiveMentionEmail: false,
+    receiveInvitationEmail: false,
+  });
+  t.deepEqual(setting5, {
+    receiveInvitationEmail: false,
+    receiveMentionEmail: false,
+  });
+  const setting6 = await t.context.models.settings.get(user.id);
+  t.deepEqual(setting6, setting5);
+});
+
+test('should throw error when update settings with invalid payload', async t => {
+  await t.throwsAsync(
+    t.context.models.settings.set(user.id, {
+      // @ts-expect-error invalid setting input types
+      receiveInvitationEmail: 1,
+    }),
+    {
+      instanceOf: ZodError,
+      message: /Expected boolean, received number/,
+    }
+  );
+});