Skip to content

There can be more than Notion and Miro. AFFiNE(pronounced [ə‘fain]) is a next-gen knowledge base that brings planning, sorting and creating all together. Privacy first, open-source, customizable and ready to use.

refactor(server): use @nestjs-cls/transactional to impl database transaction (#9759)

fengmk290b4dc5c00d4
diff --git a/packages/backend/server/package.json b/packages/backend/server/package.json
index 5161d076df..02a9ae0a16 100644
--- a/packages/backend/server/package.json
+++ b/packages/backend/server/package.json
@@ -26,6 +26,8 @@
"@google-cloud/opentelemetry-cloud-monitoring-exporter": "^0.20.0",
"@google-cloud/opentelemetry-cloud-trace-exporter": "^2.4.1",
"@google-cloud/opentelemetry-resource-util": "^2.4.0",
+ "@nestjs-cls/transactional": "^2.4.4",
+ "@nestjs-cls/transactional-adapter-prisma": "^1.2.7",
"@nestjs/apollo": "^12.2.2",
"@nestjs/common": "^10.4.15",
"@nestjs/core": "^10.4.15",
diff --git a/packages/backend/server/src/__tests__/models/workspace.spec.ts b/packages/backend/server/src/__tests__/models/workspace.spec.ts
index cf095b3a7d..ce821826b0 100644
--- a/packages/backend/server/src/__tests__/models/workspace.spec.ts
+++ b/packages/backend/server/src/__tests__/models/workspace.spec.ts
@@ -326,7 +326,7 @@ test('should grant member with read permission and Pending status by default', a
t.true(
updatedSpy.calledOnceWith({
workspaceId: workspace.id,
- count: 2,
+ count: 1,
})
);
});
diff --git a/packages/backend/server/src/app.module.ts b/packages/backend/server/src/app.module.ts
index a7d832c9f6..1ba51ef99a 100644
--- a/packages/backend/server/src/app.module.ts
+++ b/packages/backend/server/src/app.module.ts
@@ -7,6 +7,9 @@ import {
Module,
} from '@nestjs/common';
import { ScheduleModule } from '@nestjs/schedule';
+import { ClsPluginTransactional } from '@nestjs-cls/transactional';
+import { TransactionalAdapterPrisma } from '@nestjs-cls/transactional-adapter-prisma';
+import { PrismaClient } from '@prisma/client';
import { get } from 'lodash-es';
import { ClsModule } from 'nestjs-cls';
@@ -55,6 +58,14 @@ export const FunctionalityModules = [
return randomUUID();
},
},
+ plugins: [
+ // https://papooch.github.io/nestjs-cls/plugins/available-plugins/transactional/prisma-adapter
+ new ClsPluginTransactional({
+ adapter: new TransactionalAdapterPrisma({
+ prismaInjectionToken: PrismaClient,
+ }),
+ }),
+ ],
}),
ConfigModule.forRoot(),
RuntimeModule,
diff --git a/packages/backend/server/src/models/base.ts b/packages/backend/server/src/models/base.ts
index 2b0645cd29..85d1a6b9dc 100644
--- a/packages/backend/server/src/models/base.ts
+++ b/packages/backend/server/src/models/base.ts
@@ -1,4 +1,6 @@
import { Inject, Logger } from '@nestjs/common';
+import { TransactionHost } from '@nestjs-cls/transactional';
+import type { TransactionalAdapterPrisma } from '@nestjs-cls/transactional-adapter-prisma';
import { PrismaClient } from '@prisma/client';
import { Config } from '../base';
@@ -16,4 +18,11 @@ export class BaseModel {
@Inject(PrismaClient)
protected readonly db!: PrismaClient;
+
+ @Inject(TransactionHost)
+ private readonly txHost!: TransactionHost<TransactionalAdapterPrisma>;
+
+ protected get tx() {
+ return this.txHost.tx;
+ }
}
diff --git a/packages/backend/server/src/models/feature.ts b/packages/backend/server/src/models/feature.ts
index 1e3d3097a7..6ec90cbbdc 100644
--- a/packages/backend/server/src/models/feature.ts
+++ b/packages/backend/server/src/models/feature.ts
@@ -1,8 +1,8 @@
import { Injectable } from '@nestjs/common';
+import { Transactional } from '@nestjs-cls/transactional';
import { Feature } from '@prisma/client';
import { z } from 'zod';
-import { PrismaTransaction } from '../base';
import { BaseModel } from './base';
import { Features, FeatureType } from './common';
@@ -20,7 +20,7 @@ type FeatureConfigs<T extends FeatureNames> = z.infer<
@Injectable()
export class FeatureModel extends BaseModel {
async get<T extends FeatureNames>(name: T) {
- const feature = await this.getLatest(this.db, name);
+ const feature = await this.getLatest(name);
// All features are hardcoded in the codebase
// It would be a fatal error if the feature is not found in DB.
@@ -43,6 +43,7 @@ export class FeatureModel extends BaseModel {
};
}
+ @Transactional()
async upsert<T extends FeatureNames>(name: T, configs: FeatureConfigs<T>) {
const shape = this.getConfigShape(name);
const parseResult = shape.safeParse(configs);
@@ -58,37 +59,33 @@ export class FeatureModel extends BaseModel {
// TODO(@forehalo):
// could be a simple upsert operation, but we got useless `version` column in the database
// will be fixed when `version` column gets deprecated
- const feature = await this.db.$transaction(async tx => {
- const latest = await this.getLatest(tx, name);
-
- if (!latest) {
- return await tx.feature.create({
- data: {
- type: FeatureType.Feature,
- feature: name,
- configs: parsedConfigs,
- },
- });
- } else {
- return await tx.feature.update({
- where: { id: latest.id },
- data: {
- configs: parsedConfigs,
- },
- });
- }
- });
+ const latest = await this.getLatest(name);
+
+ let feature: Feature;
+ if (!latest) {
+ feature = await this.tx.feature.create({
+ data: {
+ type: FeatureType.Feature,
+ feature: name,
+ configs: parsedConfigs,
+ },
+ });
+ } else {
+ feature = await this.tx.feature.update({
+ where: { id: latest.id },
+ data: {
+ configs: parsedConfigs,
+ },
+ });
+ }
this.logger.verbose(`Feature ${name} upserted`);
return feature as Feature & { configs: FeatureConfigs<T> };
}
- private async getLatest<T extends FeatureNames>(
- client: PrismaTransaction,
- name: T
- ) {
- return client.feature.findFirst({
+ private async getLatest<T extends FeatureNames>(name: T) {
+ return this.tx.feature.findFirst({
where: { feature: name },
orderBy: { version: 'desc' },
});
diff --git a/packages/backend/server/src/models/page.ts b/packages/backend/server/src/models/page.ts
index e5085e40d7..5e72d28fdb 100644
--- a/packages/backend/server/src/models/page.ts
+++ b/packages/backend/server/src/models/page.ts
@@ -1,4 +1,5 @@
import { Injectable } from '@nestjs/common';
+import { Transactional } from '@nestjs-cls/transactional';
import {
type WorkspacePage as Page,
type WorkspacePageUserPermission as PageUserPermission,
@@ -87,6 +88,7 @@ export class PageModel extends BaseModel {
/**
* Grant the page member with the given permission.
*/
+ @Transactional()
async grantMember(
workspaceId: string,
pageId: string,
@@ -105,50 +107,48 @@ export class PageModel extends BaseModel {
// If the user is already accepted and the new permission is owner, we need to revoke old owner
if (!data || data.type !== permission) {
- return await this.db.$transaction(async tx => {
- if (data) {
- // Update the permission
- data = await tx.workspacePageUserPermission.update({
- where: {
- workspaceId_pageId_userId: {
- workspaceId,
- pageId,
- userId,
- },
- },
- data: { type: permission },
- });
- } else {
- // Create a new permission
- data = await tx.workspacePageUserPermission.create({
- data: {
+ if (data) {
+ // Update the permission
+ data = await this.tx.workspacePageUserPermission.update({
+ where: {
+ workspaceId_pageId_userId: {
workspaceId,
pageId,
userId,
- type: permission,
- // page permission does not require invitee to accept, the accepted field will be deprecated later.
- accepted: true,
- },
- });
- }
-
- // If the new permission is owner, we need to revoke old owner
- if (permission === Permission.Owner) {
- await tx.workspacePageUserPermission.updateMany({
- where: {
- workspaceId,
- pageId,
- type: Permission.Owner,
- userId: { not: userId },
},
- data: { type: Permission.Admin },
- });
- this.logger.log(
- `Change owner of workspace ${workspaceId} page ${pageId} to user ${userId}`
- );
- }
- return data;
- });
+ },
+ data: { type: permission },
+ });
+ } else {
+ // Create a new permission
+ data = await this.tx.workspacePageUserPermission.create({
+ data: {
+ workspaceId,
+ pageId,
+ userId,
+ type: permission,
+ // page permission does not require invitee to accept, the accepted field will be deprecated later.
+ accepted: true,
+ },
+ });
+ }
+
+ // If the new permission is owner, we need to revoke old owner
+ if (permission === Permission.Owner) {
+ await this.tx.workspacePageUserPermission.updateMany({
+ where: {
+ workspaceId,
+ pageId,
+ type: Permission.Owner,
+ userId: { not: userId },
+ },
+ data: { type: Permission.Admin },
+ });
+ this.logger.log(
+ `Change owner of workspace ${workspaceId} page ${pageId} to user ${userId}`
+ );
+ }
+ return data;
}
// nothing to do
diff --git a/packages/backend/server/src/models/workspace.ts b/packages/backend/server/src/models/workspace.ts
index e157dd35d7..ecfb68c5f8 100644
--- a/packages/backend/server/src/models/workspace.ts
+++ b/packages/backend/server/src/models/workspace.ts
@@ -1,4 +1,5 @@
import { Injectable } from '@nestjs/common';
+import { Transactional } from '@nestjs-cls/transactional';
import {
type Workspace,
WorkspaceMemberStatus,
@@ -37,7 +38,7 @@ export class WorkspaceModel extends BaseModel {
* Create a new workspace for the user, default to private.
*/
async create(userId: string) {
- const workspace = await this.db.workspace.create({
+ const workspace = await this.tx.workspace.create({
data: {
public: false,
permissions: {
@@ -58,7 +59,7 @@ export class WorkspaceModel extends BaseModel {
* Update the workspace with the given data.
*/
async update(workspaceId: string, data: UpdateWorkspaceInput) {
- await this.db.workspace.update({
+ await this.tx.workspace.update({
where: {
id: workspaceId,
},
@@ -78,7 +79,7 @@ export class WorkspaceModel extends BaseModel {
}
async delete(workspaceId: string) {
- await this.db.workspace.deleteMany({
+ await this.tx.workspace.deleteMany({
where: {
id: workspaceId,
},
@@ -125,13 +126,14 @@ export class WorkspaceModel extends BaseModel {
/**
* Grant the workspace member with the given permission and status.
*/
+ @Transactional()
async grantMember(
workspaceId: string,
userId: string,
permission: Permission = Permission.Read,
status: WorkspaceMemberStatus = WorkspaceMemberStatus.Pending
): Promise<WorkspaceUserPermission> {
- const data = await this.db.workspaceUserPermission.findUnique({
+ const data = await this.tx.workspaceUserPermission.findUnique({
where: {
workspaceId_userId: {
workspaceId,
@@ -143,7 +145,7 @@ export class WorkspaceModel extends BaseModel {
if (!data) {
// Create a new permission
// TODO(fengmk2): should we check the permission here? Like owner can't be pending?
- const created = await this.db.workspaceUserPermission.create({
+ const created = await this.tx.workspaceUserPermission.create({
data: {
workspaceId,
userId,
@@ -151,41 +153,42 @@ export class WorkspaceModel extends BaseModel {
status,
},
});
+ this.logger.log(
+ `Granted workspace ${workspaceId} member ${userId} with permission ${permission}`
+ );
await this.notifyMembersUpdated(workspaceId);
return created;
}
// If the user is already accepted and the new permission is owner, we need to revoke old owner
if (data.status === WorkspaceMemberStatus.Accepted || data.accepted) {
- return await this.db.$transaction(async tx => {
- const updated = await tx.workspaceUserPermission.update({
+ const updated = await this.tx.workspaceUserPermission.update({
+ where: {
+ workspaceId_userId: { workspaceId, userId },
+ },
+ data: { type: permission },
+ });
+ // If the new permission is owner, we need to revoke old owner
+ if (permission === Permission.Owner) {
+ await this.tx.workspaceUserPermission.updateMany({
where: {
- workspaceId_userId: { workspaceId, userId },
+ workspaceId,
+ type: Permission.Owner,
+ userId: { not: userId },
},
- data: { type: permission },
+ data: { type: Permission.Admin },
});
- // If the new permission is owner, we need to revoke old owner
- if (permission === Permission.Owner) {
- await tx.workspaceUserPermission.updateMany({
- where: {
- workspaceId,
- type: Permission.Owner,
- userId: { not: userId },
- },
- data: { type: Permission.Admin },
- });
- this.logger.log(
- `Change owner of workspace ${workspaceId} to ${userId}`
- );
- }
- return updated;
- });
+ this.logger.log(
+ `Change owner of workspace ${workspaceId} to ${userId}`
+ );
+ }
+ return updated;
}
// If the user is not accepted, we can update the status directly
const allowedStatus = this.getAllowedStatusSource(data.status);
if (allowedStatus.includes(status)) {
- const updated = await this.db.workspaceUserPermission.update({
+ const updated = await this.tx.workspaceUserPermission.update({
where: { workspaceId_userId: { workspaceId, userId } },
data: {
status,
@@ -204,7 +207,7 @@ export class WorkspaceModel extends BaseModel {
* Get the workspace member invitation.
*/
async getMemberInvitation(invitationId: string) {
- return await this.db.workspaceUserPermission.findUnique({
+ return await this.tx.workspaceUserPermission.findUnique({
where: {
id: invitationId,
},
@@ -220,7 +223,7 @@ export class WorkspaceModel extends BaseModel {
workspaceId: string,
status: WorkspaceMemberStatus = WorkspaceMemberStatus.Accepted
) {
- const { count } = await this.db.workspaceUserPermission.updateMany({
+ const { count } = await this.tx.workspaceUserPermission.updateMany({
where: {
id: invitationId,
workspaceId: workspaceId,
@@ -348,7 +351,7 @@ export class WorkspaceModel extends BaseModel {
return false;
}
- await this.db.workspaceUserPermission.deleteMany({
+ await this.tx.workspaceUserPermission.deleteMany({
where: {
workspaceId,
userId,
@@ -407,6 +410,7 @@ export class WorkspaceModel extends BaseModel {
/**
* Refresh the workspace member seat status.
*/
+ @Transactional()
async refreshMemberSeatStatus(workspaceId: string, memberLimit: number) {
const usedCount = await this.getMemberUsedCount(workspaceId);
const availableCount = memberLimit - usedCount;
@@ -414,43 +418,41 @@ export class WorkspaceModel extends BaseModel {
return;
}
- return await this.db.$transaction(async tx => {
- const members = await tx.workspaceUserPermission.findMany({
- select: { id: true, status: true },
- where: {
- workspaceId,
- status: {
- in: [
- WorkspaceMemberStatus.NeedMoreSeat,
- WorkspaceMemberStatus.NeedMoreSeatAndReview,
- ],
- },
+ const members = await this.tx.workspaceUserPermission.findMany({
+ select: { id: true, status: true },
+ where: {
+ workspaceId,
+ status: {
+ in: [
+ WorkspaceMemberStatus.NeedMoreSeat,
+ WorkspaceMemberStatus.NeedMoreSeatAndReview,
+ ],
},
- // find the oldest members first
- orderBy: { createdAt: 'asc' },
- });
+ },
+ // find the oldest members first
+ orderBy: { createdAt: 'asc' },
+ });
- const needChange = members.slice(0, availableCount);
- const groups = groupBy(needChange, m => m.status);
+ const needChange = members.slice(0, availableCount);
+ const groups = groupBy(needChange, m => m.status);
- const toPendings = groups.NeedMoreSeat;
- if (toPendings) {
- // NeedMoreSeat => Pending
- await tx.workspaceUserPermission.updateMany({
- where: { id: { in: toPendings.map(m => m.id) } },
- data: { status: WorkspaceMemberStatus.Pending },
- });
- }
+ const toPendings = groups.NeedMoreSeat;
+ if (toPendings) {
+ // NeedMoreSeat => Pending
+ await this.tx.workspaceUserPermission.updateMany({
+ where: { id: { in: toPendings.map(m => m.id) } },
+ data: { status: WorkspaceMemberStatus.Pending },
+ });
+ }
- const toUnderReviews = groups.NeedMoreSeatAndReview;
- if (toUnderReviews) {
- // NeedMoreSeatAndReview => UnderReview
- await tx.workspaceUserPermission.updateMany({
- where: { id: { in: toUnderReviews.map(m => m.id) } },
- data: { status: WorkspaceMemberStatus.UnderReview },
- });
- }
- });
+ const toUnderReviews = groups.NeedMoreSeatAndReview;
+ if (toUnderReviews) {
+ // NeedMoreSeatAndReview => UnderReview
+ await this.tx.workspaceUserPermission.updateMany({
+ where: { id: { in: toUnderReviews.map(m => m.id) } },
+ data: { status: WorkspaceMemberStatus.UnderReview },
+ });
+ }
}
/**
diff --git a/yarn.lock b/yarn.lock
index 0c4b8db482..22dfebb567 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -772,6 +772,8 @@ __metadata:
"@google-cloud/opentelemetry-cloud-monitoring-exporter": "npm:^0.20.0"
"@google-cloud/opentelemetry-cloud-trace-exporter": "npm:^2.4.1"
"@google-cloud/opentelemetry-resource-util": "npm:^2.4.0"
+ "@nestjs-cls/transactional": "npm:^2.4.4"
+ "@nestjs-cls/transactional-adapter-prisma": "npm:^1.2.7"
"@nestjs/apollo": "npm:^12.2.2"
"@nestjs/common": "npm:^10.4.15"
"@nestjs/core": "npm:^10.4.15"
@@ -8747,6 +8749,31 @@ __metadata:
languageName: node
linkType: hard
+"@nestjs-cls/transactional-adapter-prisma@npm:^1.2.7":
+ version: 1.2.7
+ resolution: "@nestjs-cls/transactional-adapter-prisma@npm:1.2.7"
+ peerDependencies:
+ "@nestjs-cls/transactional": ^2.4.4
+ "@prisma/client": "> 4 < 7"
+ nestjs-cls: ^4.5.0
+ prisma: "> 4 < 7"
+ checksum: 10/43472579bd872252c0de919106a931ed563d4359d5d775c989016cab948fcff42fcf62f1260d4459047ebb3d41e3677dddf566376dbaec3e93282be1fa33d2c1
+ languageName: node
+ linkType: hard
+
+"@nestjs-cls/transactional@npm:^2.4.4":
+ version: 2.4.4
+ resolution: "@nestjs-cls/transactional@npm:2.4.4"
+ peerDependencies:
+ "@nestjs/common": "> 7.0.0 < 11"
+ "@nestjs/core": "> 7.0.0 < 11"
+ nestjs-cls: ^4.5.0
+ reflect-metadata: "*"
+ rxjs: ">= 7"
+ checksum: 10/1ec34e5b0ed8d9f1b781ebab56d616d775f038c5df21138836c61a524b6fec73ff0994d165edf5a54539ca87d5013b64fd4187b1a95bb75ba26252541c7164d0
+ languageName: node
+ linkType: hard
+
"@nestjs/apollo@npm:^12.2.2":
version: 12.2.2
resolution: "@nestjs/apollo@npm:12.2.2"