feat(server): team quota

packages/backend/server/migrations/20241129062332_workspace_invite_status/migration.sql

@@ -0,0 +1,12 @@
+-- CreateEnum
+CREATE TYPE "WorkspaceMemberStatus" AS ENUM ('Pending', 'NeedMoreSeat', 'UnderReview', 'Accepted');
+
+-- AlterTable
+ALTER TABLE "workspace_features" ADD COLUMN     "configs" JSON NOT NULL DEFAULT '{}';
+
+-- AlterTable
+ALTER TABLE "workspace_user_permissions" ADD COLUMN     "status" "WorkspaceMemberStatus" NOT NULL DEFAULT 'Pending',
+ADD COLUMN     "updated_at" TIMESTAMPTZ(3) NOT NULL DEFAULT CURRENT_TIMESTAMP;
+
+-- CreateIndex
+CREATE INDEX "workspace_features_workspace_id_idx" ON "workspace_features"("workspace_id");

packages/backend/server/migrations/20241204081412_add_workspace_level_feature_flags/migration.sql

@@ -0,0 +1,3 @@
+-- AlterTable
+ALTER TABLE "workspaces" ADD COLUMN     "enable_ai" BOOLEAN NOT NULL DEFAULT true,
+ADD COLUMN     "enable_share" BOOLEAN NOT NULL DEFAULT true;

packages/backend/server/schema.prisma

@@ -97,8 +97,11 @@ model VerificationToken {
 model Workspace {
   id               String   @id @default(uuid()) @db.VarChar
   public           Boolean
-  enableUrlPreview Boolean  @default(false) @map("enable_url_preview")
   createdAt        DateTime @default(now()) @map("created_at") @db.Timestamptz(3)
+  // workspace level feature flags
+  enableAi         Boolean  @default(true) @map("enable_ai")
+  enableShare      Boolean  @default(true) @map("enable_share")
+  enableUrlPreview Boolean  @default(false) @map("enable_url_preview")
 
   pages           WorkspacePage[]
   permissions     WorkspaceUserPermission[]
@@ -126,21 +129,32 @@ model WorkspacePage {
   @@map("workspace_pages")
 }
 
+enum WorkspaceMemberStatus {
+  Pending // 1. old state accepted = false
+  NeedMoreSeat // 2. for team: workspace owner need to buy more seat
+  UnderReview // 3. for team: member is under review
+  Accepted // 4. old state accepted = true
+}
+
 model WorkspaceUserPermission {
-  id          String   @id @default(uuid()) @db.VarChar
-  workspaceId String   @map("workspace_id") @db.VarChar
-  userId      String   @map("user_id") @db.VarChar
+  id          String                @id @default(uuid()) @db.VarChar
+  workspaceId String                @map("workspace_id") @db.VarChar
+  userId      String                @map("user_id") @db.VarChar
   // Read/Write
-  type        Int      @db.SmallInt
-  /// Whether the permission invitation is accepted by the user
-  accepted    Boolean  @default(false)
-  createdAt   DateTime @default(now()) @map("created_at") @db.Timestamptz(3)
+  type        Int                   @db.SmallInt
+  /// @deprecated Whether the permission invitation is accepted by the user
+  accepted    Boolean               @default(false)
+  /// Whether the invite status of the workspace member
+  status      WorkspaceMemberStatus @default(Pending)
+  createdAt   DateTime              @default(now()) @map("created_at") @db.Timestamptz(3)
+  /// When the invite status changed
+  updatedAt   DateTime              @default(now()) @updatedAt @map("updated_at") @db.Timestamptz(3)
 
   user      User      @relation(fields: [userId], references: [id], onDelete: Cascade)
   workspace Workspace @relation(fields: [workspaceId], references: [id], onDelete: Cascade)
 
   @@unique([workspaceId, userId])
-  // optimize for quering user's workspace permissions
+  // optimize for querying user's workspace permissions
   @@index(userId)
   @@map("workspace_user_permissions")
 }
@@ -200,6 +214,8 @@ model WorkspaceFeature {
   workspaceId String @map("workspace_id") @db.VarChar
   featureId   Int    @map("feature_id") @db.Integer
 
+  // override quota's configs
+  configs   Json      @default("{}") @db.Json
   // we will record the reason why the feature is enabled/disabled
   // for example:
   // - copilet_v1: "owner buy the copilet feature package"
@@ -216,6 +232,7 @@ model WorkspaceFeature {
   feature   Feature   @relation(fields: [featureId], references: [id], onDelete: Cascade)
   workspace Workspace @relation(fields: [workspaceId], references: [id], onDelete: Cascade)
 
+  @@index([workspaceId])
   @@map("workspace_features")
 }
 
@@ -225,7 +242,7 @@ model Feature {
   version   Int      @default(0) @db.Integer
   // 0: feature, 1: quota
   type      Int      @db.Integer
-  // configs, define by feature conntroller
+  // configs, define by feature controller
   configs   Json     @db.Json
   createdAt DateTime @default(now()) @map("created_at") @db.Timestamptz(3)
 

packages/backend/server/src/core/features/index.ts

@@ -26,9 +26,11 @@ import { FeatureService } from './service';
 })
 export class FeatureModule {}
 
+export type { FeatureConfigType } from './feature';
 export {
   type CommonFeature,
   commonFeatureSchema,
+  type FeatureConfig,
   FeatureKind,
   Features,
   FeatureType,

packages/backend/server/src/core/features/management.ts

@@ -69,7 +69,7 @@ export class FeatureManagementService {
   }
 
   async listEarlyAccess(type: EarlyAccessType = EarlyAccessType.App) {
-    return this.feature.listFeatureUsers(
+    return this.feature.listUsersByFeature(
       type === EarlyAccessType.App
         ? FeatureType.EarlyAccess
         : FeatureType.AIEarlyAccess
@@ -132,7 +132,7 @@ export class FeatureManagementService {
 
   // ======== User Feature ========
   async getActivatedUserFeatures(userId: string): Promise<FeatureType[]> {
-    const features = await this.feature.getActivatedUserFeatures(userId);
+    const features = await this.feature.getUserActivatedFeatures(userId);
     return features.map(f => f.feature.name);
   }
 
@@ -165,7 +165,7 @@ export class FeatureManagementService {
   }
 
   async listFeatureWorkspaces(feature: FeatureType) {
-    return this.feature.listFeatureWorkspaces(feature);
+    return this.feature.listWorkspacesByFeature(feature);
   }
 
   @OnEvent('user.admin.created')

packages/backend/server/src/core/features/service.ts

@@ -12,14 +12,9 @@ export class FeatureService {
 
   async getFeature<F extends FeatureType>(feature: F) {
     const data = await this.prisma.feature.findFirst({
-      where: {
-        feature,
-        type: FeatureKind.Feature,
-      },
+      where: { feature, type: FeatureKind.Feature },
       select: { id: true },
-      orderBy: {
-        version: 'desc',
-      },
+      orderBy: { version: 'desc' },
     });
 
     if (data) {
@@ -146,7 +141,7 @@ export class FeatureService {
     return configs.filter(feature => !!feature.feature);
   }
 
-  async getActivatedUserFeatures(userId: string) {
+  async getUserActivatedFeatures(userId: string) {
     const features = await this.prisma.userFeature.findMany({
       where: {
         userId,
@@ -173,7 +168,7 @@ export class FeatureService {
     return configs.filter(feature => !!feature.feature);
   }
 
-  async listFeatureUsers(feature: FeatureType) {
+  async listUsersByFeature(feature: FeatureType) {
     return this.prisma.userFeature
       .findMany({
         where: {
@@ -318,7 +313,9 @@ export class FeatureService {
     return configs.filter(feature => !!feature.feature);
   }
 
-  async listFeatureWorkspaces(feature: FeatureType): Promise<WorkspaceType[]> {
+  async listWorkspacesByFeature(
+    feature: FeatureType
+  ): Promise<WorkspaceType[]> {
     return this.prisma.workspaceFeature
       .findMany({
         where: {

packages/backend/server/src/core/features/types/index.ts

@@ -76,20 +76,24 @@ export const Features: Feature[] = [
 
 /// ======== schema infer ========
 
+export const FeatureConfigSchema = z.discriminatedUnion('feature', [
+  featureCopilot,
+  featureEarlyAccess,
+  featureAIEarlyAccess,
+  featureUnlimitedWorkspace,
+  featureUnlimitedCopilot,
+  featureAdministrator,
+]);
+
 export const FeatureSchema = commonFeatureSchema
   .extend({
     type: z.literal(FeatureKind.Feature),
   })
-  .and(
-    z.discriminatedUnion('feature', [
-      featureCopilot,
-      featureEarlyAccess,
-      featureAIEarlyAccess,
-      featureUnlimitedWorkspace,
-      featureUnlimitedCopilot,
-      featureAdministrator,
-    ])
-  );
+  .and(FeatureConfigSchema);
+
+export type FeatureConfig<F extends FeatureType> = (z.infer<
+  typeof FeatureConfigSchema
+> & { feature: F })['configs'];
 
 export type Feature = z.infer<typeof FeatureSchema>;