move query limit check to DDD

This commit is contained in:
Ramnique Singh 2025-08-05 15:36:50 +05:30
parent 51a33ab2df
commit 9fba2b1bec
11 changed files with 72 additions and 63 deletions

View file

@ -7,14 +7,16 @@ import {
Workflow} from "../lib/types/workflow_types"; Workflow} from "../lib/types/workflow_types";
import { DataSource } from "../lib/types/datasource_types"; import { DataSource } from "../lib/types/datasource_types";
import { z } from 'zod'; import { z } from 'zod';
import { check_query_limit } from "../lib/rate_limiting";
import { QueryLimitError } from "@/src/entities/errors/common";
import { projectAuthCheck } from "./project_actions"; import { projectAuthCheck } from "./project_actions";
import { redisClient } from "../lib/redis"; import { redisClient } from "../lib/redis";
import { authorizeUserAction, logUsage } from "./billing_actions"; import { authorizeUserAction, logUsage } from "./billing_actions";
import { USE_BILLING } from "../lib/feature_flags"; import { USE_BILLING } from "../lib/feature_flags";
import { WithStringId } from "../lib/types/types"; import { WithStringId } from "../lib/types/types";
import { getEditAgentInstructionsResponse } from "../lib/copilot/copilot"; import { getEditAgentInstructionsResponse } from "../lib/copilot/copilot";
import { container } from "@/di/container";
import { IUsageQuotaPolicyService } from "@/src/application/services/usage-quota-policy.service.interface";
const usageQuotaPolicyService = container.resolve<IUsageQuotaPolicyService>('usageQuotaPolicyService');
export async function getCopilotResponseStream( export async function getCopilotResponseStream(
projectId: string, projectId: string,
@ -26,9 +28,7 @@ export async function getCopilotResponseStream(
streamId: string; streamId: string;
} | { billingError: string }> { } | { billingError: string }> {
await projectAuthCheck(projectId); await projectAuthCheck(projectId);
if (!await check_query_limit(projectId)) { await usageQuotaPolicyService.assertAndConsume(projectId);
throw new QueryLimitError();
}
// Check billing authorization // Check billing authorization
const authResponse = await authorizeUserAction({ const authResponse = await authorizeUserAction({
@ -39,9 +39,7 @@ export async function getCopilotResponseStream(
return { billingError: authResponse.error || 'Billing error' }; return { billingError: authResponse.error || 'Billing error' };
} }
if (!await check_query_limit(projectId)) { await usageQuotaPolicyService.assertAndConsume(projectId);
throw new QueryLimitError();
}
// prepare request // prepare request
const request: z.infer<typeof CopilotAPIRequest> = { const request: z.infer<typeof CopilotAPIRequest> = {
@ -73,9 +71,7 @@ export async function getCopilotAgentInstructions(
agentName: string, agentName: string,
): Promise<string | { billingError: string }> { ): Promise<string | { billingError: string }> {
await projectAuthCheck(projectId); await projectAuthCheck(projectId);
if (!await check_query_limit(projectId)) { await usageQuotaPolicyService.assertAndConsume(projectId);
throw new QueryLimitError();
}
// Check billing authorization // Check billing authorization
const authResponse = await authorizeUserAction({ const authResponse = await authorizeUserAction({

View file

@ -4,12 +4,13 @@ import { projectsCollection, chatsCollection, chatMessagesCollection } from "../
import { z } from "zod"; import { z } from "zod";
import { ObjectId, WithId } from "mongodb"; import { ObjectId, WithId } from "mongodb";
import { authCheck } from "../../../utils"; import { authCheck } from "../../../utils";
import { check_query_limit } from "../../../../../../lib/rate_limiting";
import { PrefixLogger } from "../../../../../../lib/utils"; import { PrefixLogger } from "../../../../../../lib/utils";
import { authorize, getCustomerIdForProject, logUsage } from "@/app/lib/billing"; import { authorize, getCustomerIdForProject, logUsage } from "@/app/lib/billing";
import { USE_BILLING } from "@/app/lib/feature_flags"; import { USE_BILLING } from "@/app/lib/feature_flags";
import { getResponse } from "@/app/lib/agents"; import { getResponse } from "@/app/lib/agents";
import { Message, AssistantMessage, AssistantMessageWithToolCalls, ToolMessage } from "@/app/lib/types/types"; import { Message, AssistantMessage, AssistantMessageWithToolCalls, ToolMessage } from "@/app/lib/types/types";
import { IUsageQuotaPolicyService } from "@/src/application/services/usage-quota-policy.service.interface";
import { container } from "@/di/container";
function convert(messages: z.infer<typeof apiV1.ChatMessage>[]): z.infer<typeof Message>[] { function convert(messages: z.infer<typeof apiV1.ChatMessage>[]): z.infer<typeof Message>[] {
const result: z.infer<typeof Message>[] = []; const result: z.infer<typeof Message>[] = [];
@ -123,11 +124,9 @@ export async function POST(
billingCustomerId = await getCustomerIdForProject(session.projectId); billingCustomerId = await getCustomerIdForProject(session.projectId);
} }
// check query limit // assert and consume quota
if (!await check_query_limit(session.projectId)) { const usageQuotaPolicyService = container.resolve<IUsageQuotaPolicyService>('usageQuotaPolicyService');
logger.log(`Query limit exceeded for project ${session.projectId}`); await usageQuotaPolicyService.assertAndConsume(session.projectId);
return Response.json({ error: "Query limit exceeded" }, { status: 429 });
}
// parse and validate the request body // parse and validate the request body
let body; let body;

View file

@ -1,21 +0,0 @@
import { redisClient } from "./redis";
const MAX_QUERIES_PER_MINUTE = Number(process.env.MAX_QUERIES_PER_MINUTE) || 0;
export async function check_query_limit(projectId: string): Promise<boolean> {
// if the limit is 0, we don't want to check the limit
if (MAX_QUERIES_PER_MINUTE === 0) {
return true;
}
const minutes_since_epoch = Math.floor(Date.now() / 1000 / 60); // 60 second window
const key = `rate_limit:${projectId}:${minutes_since_epoch}`;
// increment the counter and return the count
const count = await redisClient.incr(key);
if (count === 1) {
await redisClient.expire(key, 70); // Set TTL to clean up automatically
}
return count <= MAX_QUERIES_PER_MINUTE;
}

View file

@ -9,6 +9,7 @@ import { CreateCachedTurnUseCase } from "@/src/application/use-cases/conversatio
import { FetchCachedTurnUseCase } from "@/src/application/use-cases/conversations/fetch-cached-turn.use-case"; import { FetchCachedTurnUseCase } from "@/src/application/use-cases/conversations/fetch-cached-turn.use-case";
import { CreateCachedTurnController } from "@/src/interface-adapters/controllers/conversations/create-cached-turn.controller"; import { CreateCachedTurnController } from "@/src/interface-adapters/controllers/conversations/create-cached-turn.controller";
import { RunTurnController } from "@/src/interface-adapters/controllers/conversations/run-turn.controller"; import { RunTurnController } from "@/src/interface-adapters/controllers/conversations/run-turn.controller";
import { RedisUsageQuotaPolicyService } from "@/src/infrastructure/services/redis.usage-quota-policy.service";
export const container = createContainer({ export const container = createContainer({
injectionMode: InjectionMode.PROXY, injectionMode: InjectionMode.PROXY,
@ -19,6 +20,7 @@ container.register({
// services // services
// --- // ---
cacheService: asClass(RedisCacheService).singleton(), cacheService: asClass(RedisCacheService).singleton(),
usageQuotaPolicyService: asClass(RedisUsageQuotaPolicyService).singleton(),
// conversations // conversations
// --- // ---

View file

@ -0,0 +1,4 @@
export interface IUsageQuotaPolicyService {
// this method will throw a QuotaExceededError if the quota is exceeded
assertAndConsume(projectId: string): Promise<void>;
}

View file

@ -1,12 +1,11 @@
import { BadRequestError, NotAuthorizedError, NotFoundError } from '@/src/entities/errors/common'; import { BadRequestError, NotAuthorizedError, NotFoundError } from '@/src/entities/errors/common';
import { check_query_limit } from "@/app/lib/rate_limiting";
import { QueryLimitError } from "@/src/entities/errors/common";
import { apiKeysCollection, projectMembersCollection } from "@/app/lib/mongodb"; import { apiKeysCollection, projectMembersCollection } from "@/app/lib/mongodb";
import { IConversationsRepository } from "@/src/application/repositories/conversations.repository.interface"; import { IConversationsRepository } from "@/src/application/repositories/conversations.repository.interface";
import { z } from "zod"; import { z } from "zod";
import { nanoid } from 'nanoid'; import { nanoid } from 'nanoid';
import { ICacheService } from '@/src/application/services/cache.service.interface'; import { ICacheService } from '@/src/application/services/cache.service.interface';
import { CachedTurnRequest, Turn } from '@/src/entities/models/turn'; import { CachedTurnRequest, Turn } from '@/src/entities/models/turn';
import { IUsageQuotaPolicyService } from '../../services/usage-quota-policy.service.interface';
const inputSchema = z.object({ const inputSchema = z.object({
caller: z.enum(["user", "api"]), caller: z.enum(["user", "api"]),
@ -23,16 +22,20 @@ export interface ICreateCachedTurnUseCase {
export class CreateCachedTurnUseCase implements ICreateCachedTurnUseCase { export class CreateCachedTurnUseCase implements ICreateCachedTurnUseCase {
private readonly cacheService: ICacheService; private readonly cacheService: ICacheService;
private readonly conversationsRepository: IConversationsRepository; private readonly conversationsRepository: IConversationsRepository;
private readonly usageQuotaPolicyService: IUsageQuotaPolicyService;
constructor({ constructor({
cacheService, cacheService,
conversationsRepository, conversationsRepository,
usageQuotaPolicyService,
}: { }: {
cacheService: ICacheService, cacheService: ICacheService,
conversationsRepository: IConversationsRepository, conversationsRepository: IConversationsRepository,
usageQuotaPolicyService: IUsageQuotaPolicyService,
}) { }) {
this.cacheService = cacheService; this.cacheService = cacheService;
this.conversationsRepository = conversationsRepository; this.conversationsRepository = conversationsRepository;
this.usageQuotaPolicyService = usageQuotaPolicyService;
} }
async execute(data: z.infer<typeof inputSchema>): Promise<{ key: string }> { async execute(data: z.infer<typeof inputSchema>): Promise<{ key: string }> {
@ -45,10 +48,8 @@ export class CreateCachedTurnUseCase implements ICreateCachedTurnUseCase {
// extract projectid from conversation // extract projectid from conversation
const { projectId } = conversation; const { projectId } = conversation;
// check query limit for project // assert and consume quota
if (!await check_query_limit(projectId)) { await this.usageQuotaPolicyService.assertAndConsume(projectId);
throw new QueryLimitError('Query limit exceeded');
}
// if caller is a user, ensure they are a member of project // if caller is a user, ensure they are a member of project
if (data.caller === "user") { if (data.caller === "user") {

View file

@ -1,11 +1,10 @@
import { BadRequestError, NotAuthorizedError, NotFoundError } from '@/src/entities/errors/common'; import { BadRequestError, NotAuthorizedError, NotFoundError } from '@/src/entities/errors/common';
import { check_query_limit } from "@/app/lib/rate_limiting";
import { QueryLimitError } from "@/src/entities/errors/common";
import { apiKeysCollection, projectMembersCollection, projectsCollection } from "@/app/lib/mongodb"; import { apiKeysCollection, projectMembersCollection, projectsCollection } from "@/app/lib/mongodb";
import { IConversationsRepository } from "@/src/application/repositories/conversations.repository.interface"; import { IConversationsRepository } from "@/src/application/repositories/conversations.repository.interface";
import { z } from "zod"; import { z } from "zod";
import { Conversation } from "@/src/entities/models/conversation"; import { Conversation } from "@/src/entities/models/conversation";
import { Workflow } from "@/app/lib/types/workflow_types"; import { Workflow } from "@/app/lib/types/workflow_types";
import { IUsageQuotaPolicyService } from '../../services/usage-quota-policy.service.interface';
const inputSchema = z.object({ const inputSchema = z.object({
caller: z.enum(["user", "api"]), caller: z.enum(["user", "api"]),
@ -22,13 +21,17 @@ export interface ICreateConversationUseCase {
export class CreateConversationUseCase implements ICreateConversationUseCase { export class CreateConversationUseCase implements ICreateConversationUseCase {
private readonly conversationsRepository: IConversationsRepository; private readonly conversationsRepository: IConversationsRepository;
private readonly usageQuotaPolicyService: IUsageQuotaPolicyService;
constructor({ constructor({
conversationsRepository, conversationsRepository,
usageQuotaPolicyService,
}: { }: {
conversationsRepository: IConversationsRepository, conversationsRepository: IConversationsRepository,
usageQuotaPolicyService: IUsageQuotaPolicyService,
}) { }) {
this.conversationsRepository = conversationsRepository; this.conversationsRepository = conversationsRepository;
this.usageQuotaPolicyService = usageQuotaPolicyService;
} }
async execute(data: z.infer<typeof inputSchema>): Promise<z.infer<typeof Conversation>> { async execute(data: z.infer<typeof inputSchema>): Promise<z.infer<typeof Conversation>> {
@ -36,10 +39,8 @@ export class CreateConversationUseCase implements ICreateConversationUseCase {
let isLiveWorkflow = Boolean(data.isLiveWorkflow); let isLiveWorkflow = Boolean(data.isLiveWorkflow);
let workflow = data.workflow; let workflow = data.workflow;
// check query limit for project // assert and consume quota
if (!await check_query_limit(projectId)) { await this.usageQuotaPolicyService.assertAndConsume(projectId);
throw new QueryLimitError('Query limit exceeded');
}
// if caller is a user, ensure they are a member of project // if caller is a user, ensure they are a member of project
if (caller === "user") { if (caller === "user") {

View file

@ -1,11 +1,10 @@
import { BadRequestError, NotAuthorizedError, NotFoundError } from '@/src/entities/errors/common'; import { BadRequestError, NotAuthorizedError, NotFoundError } from '@/src/entities/errors/common';
import { check_query_limit } from "@/app/lib/rate_limiting";
import { QueryLimitError } from "@/src/entities/errors/common";
import { apiKeysCollection, projectMembersCollection } from "@/app/lib/mongodb"; import { apiKeysCollection, projectMembersCollection } from "@/app/lib/mongodb";
import { IConversationsRepository } from "@/src/application/repositories/conversations.repository.interface"; import { IConversationsRepository } from "@/src/application/repositories/conversations.repository.interface";
import { z } from "zod"; import { z } from "zod";
import { ICacheService } from '@/src/application/services/cache.service.interface'; import { ICacheService } from '@/src/application/services/cache.service.interface';
import { CachedTurnRequest, Turn } from '@/src/entities/models/turn'; import { CachedTurnRequest, Turn } from '@/src/entities/models/turn';
import { IUsageQuotaPolicyService } from '../../services/usage-quota-policy.service.interface';
const inputSchema = z.object({ const inputSchema = z.object({
caller: z.enum(["user", "api"]), caller: z.enum(["user", "api"]),
@ -21,16 +20,20 @@ export interface IFetchCachedTurnUseCase {
export class FetchCachedTurnUseCase implements IFetchCachedTurnUseCase { export class FetchCachedTurnUseCase implements IFetchCachedTurnUseCase {
private readonly cacheService: ICacheService; private readonly cacheService: ICacheService;
private readonly conversationsRepository: IConversationsRepository; private readonly conversationsRepository: IConversationsRepository;
private readonly usageQuotaPolicyService: IUsageQuotaPolicyService;
constructor({ constructor({
cacheService, cacheService,
conversationsRepository, conversationsRepository,
usageQuotaPolicyService,
}: { }: {
cacheService: ICacheService, cacheService: ICacheService,
conversationsRepository: IConversationsRepository, conversationsRepository: IConversationsRepository,
usageQuotaPolicyService: IUsageQuotaPolicyService,
}) { }) {
this.cacheService = cacheService; this.cacheService = cacheService;
this.conversationsRepository = conversationsRepository; this.conversationsRepository = conversationsRepository;
this.usageQuotaPolicyService = usageQuotaPolicyService;
} }
async execute(data: z.infer<typeof inputSchema>): Promise<z.infer<typeof CachedTurnRequest>> { async execute(data: z.infer<typeof inputSchema>): Promise<z.infer<typeof CachedTurnRequest>> {
@ -52,10 +55,8 @@ export class FetchCachedTurnUseCase implements IFetchCachedTurnUseCase {
// extract projectid from conversation // extract projectid from conversation
const { projectId } = conversation; const { projectId } = conversation;
// check query limit for project // assert and consume quota
if (!await check_query_limit(projectId)) { await this.usageQuotaPolicyService.assertAndConsume(projectId);
throw new QueryLimitError('Query limit exceeded');
}
// if caller is a user, ensure they are a member of project // if caller is a user, ensure they are a member of project
if (data.caller === "user") { if (data.caller === "user") {

View file

@ -2,13 +2,12 @@ import { Turn, TurnEvent } from "@/src/entities/models/turn";
import { USE_BILLING } from "@/app/lib/feature_flags"; import { USE_BILLING } from "@/app/lib/feature_flags";
import { authorize, getCustomerIdForProject } from "@/app/lib/billing"; import { authorize, getCustomerIdForProject } from "@/app/lib/billing";
import { BadRequestError, BillingError, NotAuthorizedError, NotFoundError } from '@/src/entities/errors/common'; import { BadRequestError, BillingError, NotAuthorizedError, NotFoundError } from '@/src/entities/errors/common';
import { check_query_limit } from "@/app/lib/rate_limiting";
import { QueryLimitError } from "@/src/entities/errors/common";
import { apiKeysCollection, projectMembersCollection } from "@/app/lib/mongodb"; import { apiKeysCollection, projectMembersCollection } from "@/app/lib/mongodb";
import { IConversationsRepository } from "@/src/application/repositories/conversations.repository.interface"; import { IConversationsRepository } from "@/src/application/repositories/conversations.repository.interface";
import { streamResponse } from "@/app/lib/agents"; import { streamResponse } from "@/app/lib/agents";
import { z } from "zod"; import { z } from "zod";
import { Message } from "@/app/lib/types/types"; import { Message } from "@/app/lib/types/types";
import { IUsageQuotaPolicyService } from '../../services/usage-quota-policy.service.interface';
const inputSchema = z.object({ const inputSchema = z.object({
caller: z.enum(["user", "api"]), caller: z.enum(["user", "api"]),
@ -25,13 +24,17 @@ export interface IRunConversationTurnUseCase {
export class RunConversationTurnUseCase implements IRunConversationTurnUseCase { export class RunConversationTurnUseCase implements IRunConversationTurnUseCase {
private readonly conversationsRepository: IConversationsRepository; private readonly conversationsRepository: IConversationsRepository;
private readonly usageQuotaPolicyService: IUsageQuotaPolicyService;
constructor({ constructor({
conversationsRepository, conversationsRepository,
usageQuotaPolicyService,
}: { }: {
conversationsRepository: IConversationsRepository, conversationsRepository: IConversationsRepository,
usageQuotaPolicyService: IUsageQuotaPolicyService,
}) { }) {
this.conversationsRepository = conversationsRepository; this.conversationsRepository = conversationsRepository;
this.usageQuotaPolicyService = usageQuotaPolicyService;
} }
async *execute(data: z.infer<typeof inputSchema>): AsyncGenerator<z.infer<typeof TurnEvent>, void, unknown> { async *execute(data: z.infer<typeof inputSchema>): AsyncGenerator<z.infer<typeof TurnEvent>, void, unknown> {
@ -44,10 +47,8 @@ export class RunConversationTurnUseCase implements IRunConversationTurnUseCase {
// extract projectid from conversation // extract projectid from conversation
const { id: conversationId, projectId } = conversation; const { id: conversationId, projectId } = conversation;
// check query limit for project // assert and consume quota
if (!await check_query_limit(projectId)) { await this.usageQuotaPolicyService.assertAndConsume(projectId);
throw new QueryLimitError('Query limit exceeded');
}
// if caller is a user, ensure they are a member of project // if caller is a user, ensure they are a member of project
if (data.caller === "user") { if (data.caller === "user") {

View file

@ -4,7 +4,7 @@ export class BillingError extends Error {
} }
} }
export class QueryLimitError extends Error { export class QuotaExceededError extends Error {
constructor(message?: string, options?: ErrorOptions) { constructor(message?: string, options?: ErrorOptions) {
super(message, options); super(message, options);
} }

View file

@ -0,0 +1,25 @@
import { IUsageQuotaPolicyService } from "@/src/application/services/usage-quota-policy.service.interface";
import { redisClient } from "@/app/lib/redis";
import { QuotaExceededError } from "@/src/entities/errors/common";
const MAX_QUERIES_PER_MINUTE = Number(process.env.MAX_QUERIES_PER_MINUTE) || 0;
export class RedisUsageQuotaPolicyService implements IUsageQuotaPolicyService {
async assertAndConsume(projectId: string): Promise<void> {
if (MAX_QUERIES_PER_MINUTE === 0) {
return;
}
const minutes_since_epoch = Math.floor(Date.now() / 1000 / 60); // 60 second window
const key = `rate_limit:${projectId}:${minutes_since_epoch}`;
const count = await redisClient.incr(key);
if (count === 1) {
await redisClient.expire(key, 70); // Set TTL to clean up automatically
}
if (count > MAX_QUERIES_PER_MINUTE) {
throw new QuotaExceededError(`Quota exceeded for project ${projectId}`);
}
}
}