📈 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
Completed task https://github.com/Swetrix/roadmap/issues/33
Yevhenii Kulisidi4fb5dd785841
diff --git a/package.json b/package.jsonindex cc9251a92..25ff209d5 100644--- a/package.json+++ b/package.json@@ -61,6 +61,7 @@"newrelic": "^9.7.4","otplib": "^12.0.1","passport": "^0.6.0",+ "passport-headerapikey": "^1.2.2","passport-jwt": "^4.0.1","php-serialize": "^4.0.2","postmark": "^3.0.15",diff --git a/src/analytics/analytics.controller.ts b/src/analytics/analytics.controller.tsindex 25ce1043e..c1918445e 100644--- a/src/analytics/analytics.controller.ts+++ b/src/analytics/analytics.controller.ts@@ -66,7 +66,7 @@ import {import { BotDetection } from '../common/decorators/bot-detection.decorator'import { BotDetectionGuard } from '../common/guards/bot-detection.guard'import { OptionalJwtAccessTokenGuard } from 'src/auth/guards'-import { Public } from 'src/auth/decorators'+import { Auth, Public } from 'src/auth/decorators'dayjs.extend(utc)dayjs.extend(timezone)@@ -212,6 +212,7 @@ export class AnalyticsController {) { }@Get('/')+ @Auth([], true, true)async getData(@Query() data: AnalyticsGET_DTO,@CurrentUserId() uid: string,@@ -361,6 +362,7 @@ export class AnalyticsController {}@Get('/performance')+ @Auth([], true, true)async getPerfData(@Query() data: AnalyticsGET_DTO,@CurrentUserId() uid: string,@@ -501,6 +503,7 @@ export class AnalyticsController {}@Get('/birdseye')+ @Auth([], true, true)// returns overall short statistics per projectasync getOverallStats(@Query() data,@@ -572,6 +575,7 @@ export class AnalyticsController {}@Get('/liveVisitors')+ @Auth([], true, true)async getLiveVisitors(@Query() data,@CurrentUserId() uid: string,@@ -645,7 +649,7 @@ export class AnalyticsController {}@Post('/hb')- @Public()+ @Auth([], true, true)async heartbeat(@Body() logDTO: PageviewsDTO,@Headers() headers,diff --git a/src/auth/auth.module.ts b/src/auth/auth.module.tsindex d9bb6280e..4108922e9 100644--- a/src/auth/auth.module.ts+++ b/src/auth/auth.module.ts@@ -7,7 +7,11 @@ import { UserModule } from 'src/user/user.module'import { AuthController } from './auth.controller'import { AuthService } from './auth.service'import { ProjectModule } from 'src/project/project.module'-import { JwtAccessTokenStrategy, JwtRefreshTokenStrategy } from './strategies'+import {+ ApiKeyStrategy,+ JwtAccessTokenStrategy,+ JwtRefreshTokenStrategy,+} from './strategies'@Module({imports: [@@ -20,7 +24,12 @@ import { JwtAccessTokenStrategy, JwtRefreshTokenStrategy } from './strategies'ProjectModule,],controllers: [AuthController],- providers: [AuthService, JwtAccessTokenStrategy, JwtRefreshTokenStrategy],+ providers: [+ AuthService,+ JwtAccessTokenStrategy,+ JwtRefreshTokenStrategy,+ ApiKeyStrategy,+ ],exports: [AuthService],})export class AuthModule {}diff --git a/src/auth/auth.service.ts b/src/auth/auth.service.tsindex 72b8013d5..45f625f0a 100644--- a/src/auth/auth.service.ts+++ b/src/auth/auth.service.ts@@ -94,7 +94,10 @@ export class AuthService {})}- public async createUnverifiedUser(email: string, password: string): Promise<User> {+ public async createUnverifiedUser(+ email: string,+ password: string,+ ): Promise<User> {const hashedPassword = await this.hashPassword(password)const user = await this.userService.createUser({@@ -401,4 +404,8 @@ export class AuthService {async logout(userId: string, refreshToken: string) {await this.userService.deleteRefreshToken(userId, refreshToken)}++ async validateApiKey(apiKey: string): Promise<User | null> {+ return await this.userService.findUserByApiKey(apiKey)+ }}diff --git a/src/auth/decorators/auth.decorator.ts b/src/auth/decorators/auth.decorator.tsnew file mode 100644index 000000000..f7f8185f1--- /dev/null+++ b/src/auth/decorators/auth.decorator.ts@@ -0,0 +1,24 @@+import { applyDecorators, SetMetadata, UseGuards } from '@nestjs/common'+import {+ ApiKeyRateLimitGuard,+ JwtAccessTokenGuard,+ MultiAuthGuard,+ RolesGuard,+} from 'src/auth/guards'+import { UserType } from 'src/user/entities/user.entity'+import { ROLES_KEY } from './roles.decorator'++export const IS_OPTIONAL_AUTH_KEY = 'isOptionalAuth'+export function Auth(+ roles: UserType[],+ isApiKeyAuth = false,+ isOptionalAuth = false,+) {+ return applyDecorators(+ SetMetadata(ROLES_KEY, roles),+ SetMetadata(IS_OPTIONAL_AUTH_KEY, isOptionalAuth),+ isApiKeyAuth+ ? UseGuards(MultiAuthGuard, ApiKeyRateLimitGuard, RolesGuard)+ : UseGuards(JwtAccessTokenGuard, RolesGuard),+ )+}diff --git a/src/auth/decorators/current-user-id.decorator.ts b/src/auth/decorators/current-user-id.decorator.tsindex 7db24d4c6..6091686cd 100644--- a/src/auth/decorators/current-user-id.decorator.ts+++ b/src/auth/decorators/current-user-id.decorator.ts@@ -1,10 +1,9 @@import { createParamDecorator, ExecutionContext } from '@nestjs/common'-import { IJwtPayload } from '../interfaces'export const CurrentUserId = createParamDecorator((_: unknown, context: ExecutionContext) => {const request = context.switchToHttp().getRequest()- const user = request.user as IJwtPayload- return user && user.sub ? user.sub : null+ const user = request.user+ return user && user.id ? user.id : null},)diff --git a/src/auth/decorators/index.ts b/src/auth/decorators/index.tsindex 4215329a4..377aac6a6 100644--- a/src/auth/decorators/index.ts+++ b/src/auth/decorators/index.ts@@ -3,3 +3,4 @@ export * from './public.decorator'export * from './current-user.decorator'export * from './two-fa-not-required.decorator'export * from './roles.decorator'+export * from './auth.decorator'diff --git a/src/auth/decorators/roles.decorator.ts b/src/auth/decorators/roles.decorator.tsindex d7cee989d..2a56336a4 100644--- a/src/auth/decorators/roles.decorator.ts+++ b/src/auth/decorators/roles.decorator.ts@@ -1,5 +1,5 @@import { SetMetadata } from '@nestjs/common'import { UserType } from 'src/user/entities/user.entity'-export const IS_ROLES_KEY = 'roles'-export const Roles = (...roles: UserType[]) => SetMetadata(IS_ROLES_KEY, roles)+export const ROLES_KEY = 'roles'+export const Roles = (...roles: UserType[]) => SetMetadata(ROLES_KEY, roles)diff --git a/src/auth/guards/api-key-rate-limit.guard.ts b/src/auth/guards/api-key-rate-limit.guard.tsnew file mode 100644index 000000000..0003c88ad--- /dev/null+++ b/src/auth/guards/api-key-rate-limit.guard.ts@@ -0,0 +1,19 @@+import { CanActivate, ExecutionContext, Injectable } from '@nestjs/common'+import { checkRateLimitForApiKey } from 'src/common/utils'+import { ACCOUNT_PLANS, PlanCode } from 'src/user/entities/user.entity'++@Injectable()+export class ApiKeyRateLimitGuard implements CanActivate {+ async canActivate(context: ExecutionContext) {+ const request = context.switchToHttp().getRequest()+ const user = request.user++ if (request.headers['x-api-key']) {+ const reqAmount =+ ACCOUNT_PLANS[user.planCode as PlanCode].maxApiKeyRequestsPerHour+ return await checkRateLimitForApiKey(user.apiKey, reqAmount)+ }++ return true+ }+}diff --git a/src/auth/guards/api-key.guard.ts b/src/auth/guards/api-key.guard.tsnew file mode 100644index 000000000..43e58ce2d--- /dev/null+++ b/src/auth/guards/api-key.guard.ts@@ -0,0 +1,5 @@+import { Injectable } from '@nestjs/common'+import { AuthGuard } from '@nestjs/passport'++@Injectable()+export class ApiKeyGuard extends AuthGuard('api-key') {}diff --git a/src/auth/guards/index.ts b/src/auth/guards/index.tsindex 8e7e8ff21..0658afa44 100644--- a/src/auth/guards/index.ts+++ b/src/auth/guards/index.ts@@ -2,3 +2,6 @@ export * from './jwt-access-token.guard'export * from './jwt-refresh-token.guard'export * from './roles.guard'export * from './optional-jwt-access-token.guard'+export * from './api-key.guard'+export * from './api-key-rate-limit.guard'+export * from './multi-auth.guard'diff --git a/src/auth/guards/multi-auth.guard.ts b/src/auth/guards/multi-auth.guard.tsnew file mode 100644index 000000000..96503daa0--- /dev/null+++ b/src/auth/guards/multi-auth.guard.ts@@ -0,0 +1,28 @@+import { ExecutionContext, Injectable } from '@nestjs/common'+import { Reflector } from '@nestjs/core'+import { AuthGuard } from '@nestjs/passport'+import { IS_OPTIONAL_AUTH_KEY } from '../decorators'++@Injectable()+export class MultiAuthGuard extends AuthGuard(['jwt-access-token', 'api-key']) {+ constructor(private readonly reflector: Reflector) {+ super()+ }++ handleRequest(+ err: any,+ user: any,+ info: any,+ context: ExecutionContext,+ status?: any,+ ) {+ const isOptionalAuth = this.reflector.getAllAndOverride<boolean>(+ IS_OPTIONAL_AUTH_KEY,+ [context.getHandler(), context.getClass()],+ )++ if (isOptionalAuth) return user++ return super.handleRequest(err, user, info, context, status)+ }+}diff --git a/src/auth/guards/optional-jwt-access-token.guard.ts b/src/auth/guards/optional-jwt-access-token.guard.tsindex c7a62398c..f4747504e 100644--- a/src/auth/guards/optional-jwt-access-token.guard.ts+++ b/src/auth/guards/optional-jwt-access-token.guard.ts@@ -4,6 +4,6 @@ import { AuthGuard } from '@nestjs/passport'@Injectable()export class OptionalJwtAccessTokenGuard extends AuthGuard('jwt-access-token') {handleRequest(err: any, user: any) {- return !err && user ? user : { sub: null }+ return !err && user ? user : { id: null }}}diff --git a/src/auth/guards/roles.guard.ts b/src/auth/guards/roles.guard.tsindex ce8ca7835..9b7a5ad5c 100644--- a/src/auth/guards/roles.guard.ts+++ b/src/auth/guards/roles.guard.ts@@ -2,8 +2,7 @@ import { Injectable, CanActivate, ExecutionContext } from '@nestjs/common'import { Reflector } from '@nestjs/core'import { UserType } from 'src/user/entities/user.entity'import { UserService } from 'src/user/user.service'-import { IS_ROLES_KEY, IS_TWO_FA_NOT_REQUIRED_KEY } from '../decorators'-import { IJwtPayload } from '../interfaces'+import { IS_TWO_FA_NOT_REQUIRED_KEY, ROLES_KEY } from '../decorators'@Injectable()export class RolesGuard implements CanActivate {@@ -14,7 +13,7 @@ export class RolesGuard implements CanActivate {async canActivate(context: ExecutionContext) {const roles = this.reflector.get<UserType[]>(- IS_ROLES_KEY,+ ROLES_KEY,context.getHandler(),)@@ -23,12 +22,12 @@ export class RolesGuard implements CanActivate {context.getHandler(),)- if (!roles) return true+ if (!roles || roles.length === 0) return trueconst request = context.switchToHttp().getRequest()- const userFromRequest = request.user as IJwtPayload+ const userFromRequest = request.user- const user = await this.userService.findUserById(userFromRequest.sub)+ const user = await this.userService.findUserById(userFromRequest.id)const hasRole = user.roles.some(role => roles.includes(role))diff --git a/src/auth/strategies/api-key.strategy.ts b/src/auth/strategies/api-key.strategy.tsnew file mode 100644index 000000000..8d05f0a0a--- /dev/null+++ b/src/auth/strategies/api-key.strategy.ts@@ -0,0 +1,22 @@+import { Injectable, UnauthorizedException } from '@nestjs/common'+import { PassportStrategy } from '@nestjs/passport'+import { HeaderAPIKeyStrategy } from 'passport-headerapikey'+import { AuthService } from '../auth.service'++@Injectable()+export class ApiKeyStrategy extends PassportStrategy(+ HeaderAPIKeyStrategy,+ 'api-key',+) {+ constructor(private readonly authService: AuthService) {+ super(+ { header: 'X-Api-Key', prefix: '' },+ true,+ async (apiKey: string, done: any) => {+ const user = await this.authService.validateApiKey(apiKey)+ if (!user) return done(new UnauthorizedException(), false)+ done(null, user)+ },+ )+ }+}diff --git a/src/auth/strategies/index.ts b/src/auth/strategies/index.tsindex 20e4bbdce..f544f42d4 100644--- a/src/auth/strategies/index.ts+++ b/src/auth/strategies/index.ts@@ -1,2 +1,3 @@export * from './jwt-access-token.strategy'export * from './jwt-refresh-token.strategy'+export * from './api-key.strategy'diff --git a/src/auth/strategies/jwt-access-token.strategy.ts b/src/auth/strategies/jwt-access-token.strategy.tsindex 2d0a99e7f..eac802ec6 100644--- a/src/auth/strategies/jwt-access-token.strategy.ts+++ b/src/auth/strategies/jwt-access-token.strategy.ts@@ -1,7 +1,8 @@-import { Injectable } from '@nestjs/common'+import { Injectable, UnauthorizedException } from '@nestjs/common'import { ConfigService } from '@nestjs/config'import { PassportStrategy } from '@nestjs/passport'import { Strategy, ExtractJwt } from 'passport-jwt'+import { UserService } from 'src/user/user.service'import { IJwtPayload } from '../interfaces'@Injectable()@@ -9,7 +10,10 @@ export class JwtAccessTokenStrategy extends PassportStrategy(Strategy,'jwt-access-token',) {- constructor(public readonly configService: ConfigService) {+ constructor(+ public readonly configService: ConfigService,+ private readonly userService: UserService,+ ) {super({jwtFromRequest: ExtractJwt.fromAuthHeaderAsBearerToken(),ignoreExpiration: false,@@ -17,7 +21,9 @@ export class JwtAccessTokenStrategy extends PassportStrategy(})}- public validate(payload: IJwtPayload) {- return payload+ public async validate(payload: IJwtPayload) {+ const user = await this.userService.findUserById(payload.sub)+ if (!user) throw new UnauthorizedException()+ return user}}diff --git a/src/common/utils.ts b/src/common/utils.tsindex f6e7f339d..8b1f17981 100644--- a/src/common/utils.ts+++ b/src/common/utils.ts@@ -47,8 +47,8 @@ const RATE_LIMIT_TIMEOUT = 86400 // 24 hoursconst allowedToUpdateKeys = ['name', 'origins', 'active', 'public']-const _getRateLimitHash = (ip: string, salt = '') =>- `rl:${hash(`${ip}${salt}`).toString('hex')}`+const _getRateLimitHash = (ipOrApiKey: string, salt = '') =>+ `rl:${hash(`${ipOrApiKey}${salt}`).toString('hex')}`const splitAt = (x, index): Array<Array<any> | string> => [x.slice(0, index),@@ -75,6 +75,21 @@ const checkRateLimit = async (await redis.set(rlHash, 1 + rlCount, 'EX', reqTimeout)}+const RATE_LIMIT_FOR_API_KEY_TIMEOUT = 60 * 60 // 1 hour+export const checkRateLimitForApiKey = async (+ apiKey: string,+ reqAmount: number,+): Promise<boolean> => {+ const rlHash = _getRateLimitHash(apiKey)+ const rlCount: number = _toNumber(await redis.get(rlHash)) || 0++ if (rlCount >= reqAmount) {+ throw new ForbiddenException('Too many requests, please try again later')+ }+ await redis.set(rlHash, 1 + rlCount, 'EX', RATE_LIMIT_FOR_API_KEY_TIMEOUT)+ return true+}+const getProjectsClickhouse = async (id = null) => {if (!id) {const query = 'SELECT * FROM project;'diff --git a/src/project/project.controller.ts b/src/project/project.controller.tsindex 1ea63b742..09cfe8fe7 100644--- a/src/project/project.controller.ts+++ b/src/project/project.controller.ts@@ -56,7 +56,7 @@ import {deleteProjectClickhouse,} from '../common/utils'import { JwtAccessTokenGuard } from 'src/auth/guards'-import { Public } from 'src/auth/decorators'+import { Auth, Public } from 'src/auth/decorators'// const updateProjectRedis = async (id: string, project: Project) => {// const key = getRedisProjectKey(id)@@ -109,8 +109,7 @@ export class ProjectController {@ApiQuery({ name: 'skip', required: false })@ApiQuery({ name: 'relatedonly', required: false, type: Boolean })@ApiResponse({ status: 200, type: [Project] })- @UseGuards(JwtAccessTokenGuard, RolesGuard)- @Roles(UserType.CUSTOMER, UserType.ADMIN)+ @Auth([UserType.CUSTOMER, UserType.ADMIN], true)async get(@CurrentUserId() userId: string,@Query('take') take: number | undefined,@@ -154,8 +153,7 @@ export class ProjectController {@ApiQuery({ name: 'skip', required: false })@ApiQuery({ name: 'relatedonly', required: false, type: Boolean })@ApiResponse({ status: 200, type: [Project] })- @UseGuards(JwtAccessTokenGuard, RolesGuard)- @Roles(UserType.CUSTOMER, UserType.ADMIN)+ @Auth([UserType.CUSTOMER, UserType.ADMIN], true)async getShared(@CurrentUserId() userId: string,@Query('take') take: number | undefined,@@ -227,7 +225,7 @@ export class ProjectController {}@Get('/:id')- @Public()+ @Auth([], true, true)@ApiResponse({ status: 200, type: Project })async getOne(@Param('id') id: string,diff --git a/src/user/entities/user.entity.ts b/src/user/entities/user.entity.tsindex 89a73bd8c..0587c8960 100644--- a/src/user/entities/user.entity.ts+++ b/src/user/entities/user.entity.ts@@ -28,6 +28,7 @@ export const ACCOUNT_PLANS = {monthlyUsageLimit: 5000,maxProjects: 10,maxAlerts: 1,+ maxApiKeyRequestsPerHour: 5,},[PlanCode.freelancer]: {id: PlanCode.freelancer,@@ -37,6 +38,7 @@ export const ACCOUNT_PLANS = {pid: '752316', // Plan IDypid: '776469', // Plan ID - Yearly billingmaxAlerts: 10,+ maxApiKeyRequestsPerHour: 600,},[PlanCode.startup]: {id: PlanCode.startup,@@ -46,6 +48,7 @@ export const ACCOUNT_PLANS = {pid: '752317',ypid: '776470',maxAlerts: 50,+ maxApiKeyRequestsPerHour: 6000, // REVIEW},[PlanCode.enterprise]: {id: PlanCode.enterprise,@@ -55,6 +58,7 @@ export const ACCOUNT_PLANS = {pid: '752318',ypid: '776471',maxAlerts: 100,+ maxApiKeyRequestsPerHour: 60000, // REVIEW},}diff --git a/src/user/user.service.ts b/src/user/user.service.tsindex 19dd4e776..f56c1b911 100644--- a/src/user/user.service.ts+++ b/src/user/user.service.ts@@ -195,4 +195,8 @@ export class UserService {refreshToken,})}++ public async findUserByApiKey(apiKey: string) {+ return await this.usersRepository.findOne({ where: { apiKey } })+ }}