feat(server): feature model (#9709)

close CLOUD-101

packages/backend/server/src/__tests__/models/__snapshots__/feature.spec.ts.md

@@ -0,0 +1,31 @@
+# Snapshot report for `src/__tests__/models/feature.spec.ts`
+
+The actual snapshot is saved in `feature.spec.ts.snap`.
+
+Generated by [AVA](https://avajs.dev).
+
+## should get feature
+
+> Snapshot 1
+
+    {
+      blobLimit: 10485760,
+      copilotActionLimit: 10,
+      historyPeriod: 604800000,
+      memberLimit: 3,
+      name: 'Free',
+      storageQuota: 10737418240,
+    }
+
+## should get feature if extra fields exist in feature config
+
+> Snapshot 1
+
+    {
+      blobLimit: 10485760,
+      copilotActionLimit: 10,
+      historyPeriod: 604800000,
+      memberLimit: 3,
+      name: 'Free',
+      storageQuota: 10737418240,
+    }

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

@@ -0,0 +1,121 @@
+import { TestingModule } from '@nestjs/testing';
+import { PrismaClient } from '@prisma/client';
+import ava, { TestFn } from 'ava';
+
+import { FeatureModel } from '../../models/feature';
+import { createTestingModule, initTestingDB } from '../utils';
+
+interface Context {
+  module: TestingModule;
+  feature: FeatureModel;
+}
+
+const test = ava as TestFn<Context>;
+
+test.before(async t => {
+  const module = await createTestingModule({
+    providers: [FeatureModel],
+  });
+
+  t.context.feature = module.get(FeatureModel);
+  t.context.module = module;
+});
+
+test.beforeEach(async t => {
+  await initTestingDB(t.context.module.get(PrismaClient));
+});
+
+test.after(async t => {
+  await t.context.module.close();
+});
+
+test('should get feature', async t => {
+  const { feature } = t.context;
+  const freePlanFeature = await feature.get('free_plan_v1');
+
+  t.snapshot(freePlanFeature.configs);
+});
+
+test('should throw if feature not found', async t => {
+  const { feature } = t.context;
+  await t.throwsAsync(feature.get('not_found_feature' as any), {
+    message: 'Feature not_found_feature not found',
+  });
+});
+
+test('should throw if feature config in invalid', async t => {
+  const { feature } = t.context;
+  const freePlanFeature = await feature.get('free_plan_v1');
+
+  // @ts-expect-error internal
+  await feature.db.feature.update({
+    where: {
+      id: freePlanFeature.id,
+    },
+    data: {
+      configs: {
+        ...freePlanFeature.configs,
+        memberLimit: 'invalid' as any,
+      },
+    },
+  });
+
+  await t.throwsAsync(feature.get('free_plan_v1'), {
+    message: 'Invalid feature config for free_plan_v1',
+  });
+});
+
+// NOTE(@forehalo): backward compatibility
+//   new version of feature config may introduce new field
+//   this test means to ensure that the older version of AFFiNE Server can still read it
+test('should get feature if extra fields exist in feature config', async t => {
+  const { feature } = t.context;
+  const freePlanFeature = await feature.get('free_plan_v1');
+
+  // @ts-expect-error internal
+  await feature.db.feature.update({
+    where: {
+      id: freePlanFeature.id,
+    },
+    data: {
+      configs: {
+        ...freePlanFeature.configs,
+        extraField: 'extraValue',
+      },
+    },
+  });
+
+  const freePlanFeature2 = await feature.get('free_plan_v1');
+
+  t.snapshot(freePlanFeature2.configs);
+});
+
+test('should create feature', async t => {
+  const { feature } = t.context;
+
+  const newFeature = await feature.upsert('new_feature' as any, {});
+
+  t.deepEqual(newFeature.configs, {});
+});
+
+test('should update feature', async t => {
+  const { feature } = t.context;
+  const freePlanFeature = await feature.get('free_plan_v1');
+
+  const newFreePlanFeature = await feature.upsert('free_plan_v1', {
+    ...freePlanFeature.configs,
+    memberLimit: 10,
+  });
+
+  t.deepEqual(newFreePlanFeature.configs, {
+    ...freePlanFeature.configs,
+    memberLimit: 10,
+  });
+});
+
+test('should throw if feature config is invalid when updating', async t => {
+  const { feature } = t.context;
+  await t.throwsAsync(feature.upsert('free_plan_v1', {} as any), {
+    message: 'Invalid feature config for free_plan_v1',
+  });
+});