Files
Tom Moor aab83e8378 fix: Reliability of count-based limit checks (#13542)
* fix: Make count-based limit checks reliable under concurrency

Limits enforced by counting rows before an insert could be exceeded by
requests that ran at the same time, as each one read the same count
before any of them had written. Add a LockHelper that takes a Postgres
advisory lock for the remainder of the transaction, and use it to
serialize the check for webhook subscriptions, team domains, share
subscriptions and pins. The counts now also run on the transaction so
they include rows written earlier in the same request.

* Remove excessive tests

* Also guard simultaneous row removal
2026-08-24 19:14:55 -04:00

104 lines
2.3 KiB
TypeScript

import type {
InferAttributes,
InferCreationAttributes,
SaveOptions,
} from "sequelize";
import { Op } from "sequelize";
import {
DataType,
Column,
ForeignKey,
BelongsTo,
BeforeCreate,
Table,
Length,
} from "sequelize-typescript";
import { PinValidation } from "@shared/validations";
import { ValidationError } from "@server/errors";
import { LockHelper } from "@server/storage/LockHelper";
import Collection from "./Collection";
import Document from "./Document";
import Team from "./Team";
import User from "./User";
import IdModel from "./base/IdModel";
@Table({ tableName: "pins", modelName: "pin" })
class Pin extends IdModel<
InferAttributes<Pin>,
Partial<InferCreationAttributes<Pin>>
> {
@Length({
max: 256,
msg: `index must be 256 characters or less`,
})
@Column(DataType.STRING)
index: string | null;
// associations
@BelongsTo(() => User, "createdById")
createdBy: User;
@ForeignKey(() => User)
@Column(DataType.UUID)
createdById: string;
@BelongsTo(() => Collection, "collectionId")
collection?: Collection | null;
@ForeignKey(() => Collection)
@Column(DataType.UUID)
collectionId?: string | null;
@BelongsTo(() => Document, "documentId")
document: Document;
@ForeignKey(() => Document)
@Column(DataType.UUID)
documentId: string;
@BelongsTo(() => Team, "teamId")
team: Team;
@ForeignKey(() => Team)
@Column(DataType.UUID)
teamId: string;
// hooks
/**
* Limits the number of documents pinned to a single destination, either one
* collection or the home screen.
*/
@BeforeCreate
static async checkLimit(model: Pin, options: SaveOptions) {
const { transaction } = options;
const { teamId, collectionId } = model;
// Serialize concurrent creation for the destination, otherwise every
// request can read the same count and pass the check.
await LockHelper.acquire(
model.sequelize,
`pins:${teamId}:${collectionId ?? "home"}`,
transaction
);
const count = await this.count({
where: {
teamId,
...(collectionId
? { collectionId }
: { collectionId: { [Op.is]: null } }),
},
transaction,
});
if (count >= PinValidation.max) {
throw ValidationError(
`You cannot pin more than ${PinValidation.max} documents`
);
}
}
}
export default Pin;