📈 Open source, privacy-first web analytics — a cookie-less Google Analytics alternative with built-in error tracking and performance monitoring. Self-host it or use our cloud. Get started for free!
TypeScript chartsclickhousedockergdprgoogle-analyticsmetricsmonitoringmysqlnestjsprivacyredisself-hostedselfhostedstatisticstailwindcssweb-analyticswebanalyticswebsite
refactor account limit enforcement to use effective entitlements
Blue Mousea2636dba956f
diff --git a/backend/apps/cloud/src/auth/guards/api-key-rate-limit.guard.ts b/backend/apps/cloud/src/auth/guards/api-key-rate-limit.guard.tsindex 1bd11be40..6c93aedfb 100644--- a/backend/apps/cloud/src/auth/guards/api-key-rate-limit.guard.ts+++ b/backend/apps/cloud/src/auth/guards/api-key-rate-limit.guard.ts@@ -1,29 +1,10 @@import { CanActivate, ExecutionContext, Injectable } from '@nestjs/common'import { checkRateLimitForApiKey } from '../../common/utils'import {- getEffectivePlanType,- getPlanTypeEntitlements,+ getEffectiveAccountLimits,PlanCode,} from '../../user/entities/user.entity'-const getNumericOverride = (- overrides: Record<string, unknown> | null | undefined,- key: string,-) => {- const value = overrides?.[key]-- if (typeof value === 'number') {- return Number.isFinite(value) ? value : null- }-- if (typeof value === 'string' && value.trim()) {- const parsed = Number(value)- return Number.isFinite(parsed) ? parsed : null- }-- return null-}-@Injectable()export class ApiKeyRateLimitGuard implements CanActivate {async canActivate(context: ExecutionContext) {@@ -33,25 +14,13 @@ export class ApiKeyRateLimitGuard implements CanActivate {if (request.headers['x-api-key']) {if (!user) return false- const effectivePlanType = getEffectivePlanType(user)- const entitlements = effectivePlanType- ? getPlanTypeEntitlements(effectivePlanType)- : null- const overrideLimit = getNumericOverride(- user.entitlementOverrides,- 'apiRateLimitPerHour',- )- const planTypeLimit =- overrideLimit ??- (typeof entitlements?.apiRateLimitPerHour === 'number'- ? entitlements.apiRateLimitPerHour- : user.maxApiKeyRequestsPerHour)+ const { apiRateLimitPerHour } = getEffectiveAccountLimits(user)const reqAmount =user.planCode === PlanCode.none ||user.isAccountBillingSuspended ||user.dashboardBlockReason !== null? 0- : planTypeLimit+ : apiRateLimitPerHourreturn checkRateLimitForApiKey(user.apiKey, reqAmount)}diff --git a/backend/apps/cloud/src/project/project.controller.ts b/backend/apps/cloud/src/project/project.controller.tsindex 29bcbb229..cbfa92feb 100644--- a/backend/apps/cloud/src/project/project.controller.ts+++ b/backend/apps/cloud/src/project/project.controller.ts@@ -116,10 +116,10 @@ import { PendingInvitationService } from '../pending-invitation/pending-invitatiimport { PendingInvitationType } from '../pending-invitation/pending-invitation.entity'import {PlanCode,+ getEffectiveAccountLimits,getSessionReplayRetentionEntitlement,} from '../user/entities/user.entity'-const PROJECTS_MAXIMUM = 50const ORIGINS_ITEMS_MAXIMUM = 1000const BLACKLIST_ITEMS_MAXIMUM = 1000@@ -319,7 +319,6 @@ export class ProjectController {const initiatingUser = await this.userService.findOne({where: { id: userId },})- const { maxProjects = PROJECTS_MAXIMUM } = initiatingUserlet user = initiatingUser@@ -359,10 +358,11 @@ export class ProjectController {}const projectCount = await this.projectService.countByAdminId(user.id)+ const { effectiveProjectLimit } = getEffectiveAccountLimits(user)- if (projectCount >= maxProjects) {+ if (projectCount >= effectiveProjectLimit) {throw new ForbiddenException(- `You cannot create more than ${maxProjects} projects on your account plan. Please upgrade to be able to create more projects.`,+ `You cannot create more than ${effectiveProjectLimit} projects on your account plan. Please upgrade to be able to create more projects.`,)}diff --git a/backend/apps/cloud/src/user/entities/user.entity.ts b/backend/apps/cloud/src/user/entities/user.entity.tsindex 5ecad5a32..d2e1023e7 100644--- a/backend/apps/cloud/src/user/entities/user.entity.ts+++ b/backend/apps/cloud/src/user/entities/user.entity.ts@@ -61,13 +61,9 @@ interface PlanSignature {ypid?: string}-type AccountLimitUpdates = {- maxProjects?: number- maxApiKeyRequestsPerHour?: number-}--export const DEFAULT_MAX_PROJECTS = 10+const DEFAULT_MAX_PROJECTS = 10const DEFAULT_API_KEY_REQUESTS_PER_HOUR = 300+type AccountLimitValue = number | 'custom'const PLAN_TYPE_ENTITLEMENTS = {[PlanType.standard]: {@@ -145,7 +141,7 @@ export const getEffectivePlanType = (return PlanType.standard}-export const getPlanTypeEntitlements = (planType?: PlanType | null) =>+const getPlanTypeEntitlements = (planType?: PlanType | null) =>PLAN_TYPE_ENTITLEMENTS[planType || PlanType.standard]const getNumericLimitOverride = (@@ -154,49 +150,38 @@ const getNumericLimitOverride = () => {const value = overrides?.[key]- return typeof value === 'number' ? value : null+ return typeof value === 'number' && Number.isFinite(value) ? value : null}-export const getDefaultAccountLimitUpdates = () => ({- maxProjects: DEFAULT_MAX_PROJECTS,- maxApiKeyRequestsPerHour: DEFAULT_API_KEY_REQUESTS_PER_HOUR,-})+const getNumericAccountLimit = (value: unknown) =>+ typeof value === 'number' && Number.isFinite(value) ? value : null-export const getPlanTypeAccountLimitUpdates = (- planType?: PlanType | null,- entitlementOverrides?: Record<string, unknown> | null,-): AccountLimitUpdates => {- const entitlements = getPlanTypeEntitlements(planType)- const websiteOverride = getNumericLimitOverride(- entitlementOverrides,- 'websites',- )- const apiRateLimitOverride = getNumericLimitOverride(- entitlementOverrides,- 'apiRateLimitPerHour',+export const getPurchasedWebsiteAddons = (+ user?: {+ addonOverrides?: Record<string, unknown> | null+ } | null,+): number =>+ Math.max(+ 0,+ getNumericLimitOverride(user?.addonOverrides, 'websites') ??+ getNumericLimitOverride(user?.addonOverrides, 'additionalWebsites') ??+ 0,)- const maxProjects =- websiteOverride ??- (typeof entitlements.websites === 'number'- ? entitlements.websites- : undefined)- const maxApiKeyRequestsPerHour =- apiRateLimitOverride ??- (typeof entitlements.apiRateLimitPerHour === 'number'- ? entitlements.apiRateLimitPerHour- : undefined)- const updates: AccountLimitUpdates = {}- if (typeof maxProjects === 'number') {- updates.maxProjects = maxProjects- }-- if (typeof maxApiKeyRequestsPerHour === 'number') {- updates.maxApiKeyRequestsPerHour = maxApiKeyRequestsPerHour- }+export const getPurchasedSessionReplayAddons = (+ user?: {+ addonOverrides?: Record<string, unknown> | null+ } | null,+): number =>+ Math.max(+ 0,+ getNumericLimitOverride(user?.addonOverrides, 'sessionReplays') ?? 0,+ )- return updates-}+export const getDefaultAccountLimitUpdates = () => ({+ maxProjects: DEFAULT_MAX_PROJECTS,+ maxApiKeyRequestsPerHour: DEFAULT_API_KEY_REQUESTS_PER_HOUR,+})export const getSessionReplayQuota = (user?: {@@ -210,8 +195,7 @@ export const getSessionReplayQuota = (user?.entitlementOverrides,'sessionReplaysIncluded',)- const replayAddons =- getNumericLimitOverride(user?.addonOverrides, 'sessionReplays') || 0+ const replayAddons = getPurchasedSessionReplayAddons(user)if (typeof replayOverride === 'number') {return replayOverride + replayAddons@@ -257,6 +241,82 @@ export const getSessionReplayRetentionEntitlement = (return getEffectivePlanType(user) === PlanType.enterprise ? 1825 : 30}+export const getEffectiveAccountLimits = (+ user?: {+ planCode?: PlanCode | null+ planType?: PlanType | null+ entitlementOverrides?: Record<string, unknown> | null+ addonOverrides?: Record<string, unknown> | null+ maxProjects?: number | null+ maxApiKeyRequestsPerHour?: number | null+ } | null,+) => {+ const effectivePlanType = getEffectivePlanType(user)+ const entitlements = getPlanTypeEntitlements(effectivePlanType)+ const purchasedWebsiteAddons = getPurchasedWebsiteAddons(user)+ const purchasedSessionReplayAddons = getPurchasedSessionReplayAddons(user)+ const websiteOverride = getNumericLimitOverride(+ user?.entitlementOverrides,+ 'websites',+ )+ const apiRateLimitOverride = getNumericLimitOverride(+ user?.entitlementOverrides,+ 'apiRateLimitPerHour',+ )+ const teamMembersOverride = getNumericLimitOverride(+ user?.entitlementOverrides,+ 'teamMembers',+ )+ const organisationsOverride = getNumericLimitOverride(+ user?.entitlementOverrides,+ 'organisations',+ )+ const includedWebsites =+ websiteOverride ??+ (typeof entitlements.websites === 'number'+ ? entitlements.websites+ : (getNumericAccountLimit(user?.maxProjects) ?? DEFAULT_MAX_PROJECTS))+ const apiRateLimitPerHour =+ apiRateLimitOverride ??+ (typeof entitlements.apiRateLimitPerHour === 'number'+ ? entitlements.apiRateLimitPerHour+ : (getNumericAccountLimit(user?.maxApiKeyRequestsPerHour) ??+ DEFAULT_API_KEY_REQUESTS_PER_HOUR))+ const teamMembers =+ teamMembersOverride ??+ (typeof entitlements.teamMembers === 'number'+ ? entitlements.teamMembers+ : 'custom')+ const organisations =+ organisationsOverride ??+ (typeof entitlements.organisations === 'number'+ ? entitlements.organisations+ : 'custom')+ const sessionReplaysIncluded = getSessionReplayQuota(user)+ const includedSessionReplays =+ sessionReplaysIncluded === 'custom'+ ? sessionReplaysIncluded+ : Math.max(0, sessionReplaysIncluded - purchasedSessionReplayAddons)+ const sessionReplayRetentionDays = getSessionReplayRetentionEntitlement(user)+ const effectiveProjectLimit = includedWebsites + purchasedWebsiteAddons++ return {+ effectivePlanType,+ includedWebsites,+ purchasedWebsiteAddons,+ effectiveProjectLimit,+ maxProjects: effectiveProjectLimit,+ apiRateLimitPerHour,+ maxApiKeyRequestsPerHour: apiRateLimitPerHour,+ includedSessionReplays,+ sessionReplaysIncluded,+ purchasedSessionReplayAddons,+ sessionReplayRetentionDays,+ teamMembers: teamMembers as AccountLimitValue,+ organisations: organisations as AccountLimitValue,+ }+}+const planTypeHasFeature = (planType: PlanType | null | undefined,feature: PlanFeatureCode,diff --git a/backend/apps/cloud/src/user/user.service.ts b/backend/apps/cloud/src/user/user.service.tsindex 37de75265..5b187096e 100644--- a/backend/apps/cloud/src/user/user.service.ts+++ b/backend/apps/cloud/src/user/user.service.ts@@ -35,10 +35,10 @@ import {PlanCode,PlanType,getEffectivePlanType,- getPlanTypeEntitlements,- getPlanTypeAccountLimitUpdates,+ getEffectiveAccountLimits,+ getPurchasedWebsiteAddons,+ getPurchasedSessionReplayAddons,getSessionReplayQuota,- DEFAULT_MAX_PROJECTS,} from './entities/user.entity'import { UserProfileDTO } from './dto/user.dto'import { RefreshToken } from './entities/refresh-token.entity'@@ -328,25 +328,12 @@ export class UserService {return this.usersRepository.count(options)}- private getNumericOverride(- source: Record<string, unknown> | null | undefined,- key: string,- ): number | null {- const value = source?.[key]- return typeof value === 'number' ? value : null- }-private getAddonOverrideQuantity(user: Partial<User>): number {- const addonOverrides = user?.addonOverrides || {}- return (- this.getNumericOverride(addonOverrides, 'websites') ||- this.getNumericOverride(addonOverrides, 'additionalWebsites') ||- 0- )+ return getPurchasedWebsiteAddons(user)}private getSessionReplayAddonOverrideQuantity(user: Partial<User>): number {- return this.getNumericOverride(user?.addonOverrides, 'sessionReplays') || 0+ return getPurchasedSessionReplayAddons(user)}private getMoneyValue(value?: string | null): number | null {@@ -403,46 +390,13 @@ export class UserService {}private getIncludedWebsiteLimit(user: Partial<User>): number {- const effectivePlanType = getEffectivePlanType(user)- const entitlements = getPlanTypeEntitlements(effectivePlanType)- const websiteOverride = this.getNumericOverride(- user?.entitlementOverrides,- 'websites',- )-- if (typeof websiteOverride === 'number') {- return websiteOverride- }-- if (typeof entitlements.websites === 'number') {- return entitlements.websites- }-- return Math.max(- DEFAULT_MAX_PROJECTS,- (user?.maxProjects || DEFAULT_MAX_PROJECTS) -- this.getAddonOverrideQuantity(user),- )+ return getEffectiveAccountLimits(user).includedWebsites}private getIncludedSessionReplayLimit(user: Partial<User>,): number | 'custom' {- const replayOverride = this.getNumericOverride(- user?.entitlementOverrides,- 'sessionReplaysIncluded',- )-- if (typeof replayOverride === 'number') {- return replayOverride- }-- const addonQuantity = this.getSessionReplayAddonOverrideQuantity(user)- const totalQuota = getSessionReplayQuota(user)-- return totalQuota === 'custom'- ? totalQuota- : Math.max(0, totalQuota - addonQuantity)+ return getEffectiveAccountLimits(user).includedSessionReplays}private getWebsiteAddonCurrency(user: User): string {@@ -976,7 +930,6 @@ export class UserService {addonOverrides: Object.keys(addonOverrides).length? addonOverrides: null,- maxProjects: this.getIncludedWebsiteLimit(user) + quantity,}if (manager) {@@ -2265,54 +2218,24 @@ export class UserService {omitSensitiveData(user: Partial<User>): Partial<User> {const maxEventsCount = ACCOUNT_PLANS[user?.planCode]?.monthlyUsageLimit || 0- const effectivePlanType = getEffectivePlanType(user)- const entitlements = getPlanTypeEntitlements(effectivePlanType)- const entitlementOverrides = user?.entitlementOverrides || {}- const addonOverrides = user?.addonOverrides || {}- const numberOverride = (source: Record<string, unknown>, key: string) =>- typeof source[key] === 'number' ? (source[key] as number) : null-- const purchasedWebsiteAddons =- numberOverride(addonOverrides, 'websites') ||- numberOverride(addonOverrides, 'additionalWebsites') ||- 0- const purchasedSessionReplayAddons =- numberOverride(addonOverrides, 'sessionReplays') || 0- const websiteOverride = numberOverride(entitlementOverrides, 'websites')- const apiOverride = numberOverride(- entitlementOverrides,- 'apiRateLimitPerHour',- )- const includedWebsites =- websiteOverride ??- (typeof entitlements.websites === 'number'- ? entitlements.websites- : user?.maxProjects)- const apiRateLimitPerHour =- apiOverride ??- (typeof entitlements.apiRateLimitPerHour === 'number'- ? entitlements.apiRateLimitPerHour- : user?.maxApiKeyRequestsPerHour)- const sessionReplaysIncluded = getSessionReplayQuota(user)+ const limits = getEffectiveAccountLimits(user)const enhancedUser = {...user,- effectivePlanType,+ effectivePlanType: limits.effectivePlanType,maxEventsCount,- maxProjects:- typeof includedWebsites === 'number'- ? Math.max(- user?.maxProjects || 0,- includedWebsites + purchasedWebsiteAddons,- )- : user?.maxProjects,- maxApiKeyRequestsPerHour:- typeof apiRateLimitPerHour === 'number'- ? Math.max(user?.maxApiKeyRequestsPerHour || 0, apiRateLimitPerHour)- : user?.maxApiKeyRequestsPerHour,- sessionReplaysIncluded,- purchasedWebsiteAddons,- purchasedSessionReplayAddons,+ includedWebsites: limits.includedWebsites,+ purchasedWebsiteAddons: limits.purchasedWebsiteAddons,+ maxProjects: limits.effectiveProjectLimit,+ effectiveProjectLimit: limits.effectiveProjectLimit,+ maxApiKeyRequestsPerHour: limits.apiRateLimitPerHour,+ apiRateLimitPerHour: limits.apiRateLimitPerHour,+ includedSessionReplays: limits.includedSessionReplays,+ sessionReplaysIncluded: limits.sessionReplaysIncluded,+ purchasedSessionReplayAddons: limits.purchasedSessionReplayAddons,+ sessionReplayRetentionDays: limits.sessionReplayRetentionDays,+ teamMembers: limits.teamMembers,+ organisations: limits.organisations,}return _omit(enhancedUser, [@@ -2805,7 +2728,6 @@ export class UserService {nextBillDate: date,billingFrequency,tierCurrency: currency,- ...getPlanTypeAccountLimitUpdates(planType, user.entitlementOverrides),}await this.update(id, updateParams)diff --git a/backend/apps/cloud/src/webhook/webhook.controller.ts b/backend/apps/cloud/src/webhook/webhook.controller.tsindex a3de3b824..9914bcbca 100644--- a/backend/apps/cloud/src/webhook/webhook.controller.ts+++ b/backend/apps/cloud/src/webhook/webhook.controller.ts@@ -18,7 +18,6 @@ import {BillingFrequency,DashboardBlockReason,PlanType,- getPlanTypeAccountLimitUpdates,isNextPlan,} from '../user/entities/user.entity'import { UserService } from '../user/user.service'@@ -185,10 +184,6 @@ export class WebhookController {tierCurrency: currency,cancellationEffectiveDate: null,...statusParams,- ...getPlanTypeAccountLimitUpdates(- planType,- currentUser.entitlementOverrides,- ),}if (isTrialing && nextBillDate) {