Skip to content

📈 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!

add post, delete, put for admin

kruzhambus5d63ebd8305a
diff --git a/src/project/project.controller.ts b/src/project/project.controller.ts
index 4d4d0f101..453fa119b 100644
--- a/src/project/project.controller.ts
+++ b/src/project/project.controller.ts
@@ -1,182 +1,169 @@
import {
- Controller, Body, Query, Param, UseGuards, Get, Post, Put, Delete,
- BadRequestException, HttpCode, NotFoundException, ForbiddenException,
-} from '@nestjs/common'
-import { ApiTags, ApiQuery, ApiResponse } from '@nestjs/swagger'
-import * as _isEmpty from 'lodash/isEmpty'
-import * as _map from 'lodash/map'
-import * as _trim from 'lodash/trim'
-import * as _size from 'lodash/size'
-import * as _values from 'lodash/values'
-
-import { ProjectService } from './project.service'
-import { UserType, ACCOUNT_PLANS } from '../user/entities/user.entity'
-import { Roles } from '../common/decorators/roles.decorator'
-import { RolesGuard } from '../common/guards/roles.guard'
-import { SelfhostedGuard } from 'src/common/guards/selfhosted.guard'
-import { Pagination } from '../common/pagination/pagination'
-import { Project } from './entity/project.entity'
-import { CurrentUserId } from '../common/decorators/current-user-id.decorator'
-import { UserService } from '../user/user.service'
-import { ProjectDTO } from './dto/project.dto'
-import { AppLoggerService } from '../logger/logger.service'
-import {
- redis, isValidPID, getRedisProjectKey, redisProjectCacheTimeout, clickhouse, isSelfhosted,
-} from '../common/constants'
-import {
- getProjectsClickhouse, createProjectClickhouse, updateProjectClickhouse, deleteProjectClickhouse,
-} from '../common/utils'
-
-@ApiTags('Project')
-@Controller('project')
-export class ProjectController {
- constructor(
- private readonly projectService: ProjectService,
- private readonly userService: UserService,
- private readonly logger: AppLoggerService,
- ) {}
-
- @Get('/')
- @ApiQuery({ name: 'take', required: false })
- @ApiQuery({ name: 'skip', required: false })
- @ApiQuery({ name: 'relatedonly', required: false, type: Boolean })
- @ApiResponse({ status: 200, type: [Project] })
- @UseGuards(RolesGuard)
- @Roles(UserType.CUSTOMER, UserType.ADMIN)
- async get(@CurrentUserId() userId: string, @Query('take') take: number | undefined, @Query('skip') skip: number | undefined): Promise<Pagination<Project> | Project[] | object> {
- this.logger.log({ userId, take, skip }, 'GET /project')
- if (isSelfhosted) {
- const results = await getProjectsClickhouse()
- const formatted = _map(results, this.projectService.formatFromClickhouse)
- return {
- results,
- page_total: _size(formatted),
- total: _size(formatted),
- totalMonthlyEvents: 0, // not needed as it's selfhosed
+ Controller, Body, Query, Param, UseGuards, Get, Post, Put, Delete,
+ BadRequestException, HttpCode, NotFoundException, ForbiddenException,
+ } from '@nestjs/common'
+ import { ApiTags, ApiQuery, ApiResponse } from '@nestjs/swagger'
+ import * as _isEmpty from 'lodash/isEmpty'
+ import * as _map from 'lodash/map'
+ import * as _trim from 'lodash/trim'
+ import * as _size from 'lodash/size'
+ import * as _values from 'lodash/values'
+
+ import { ProjectService } from './project.service'
+ import { UserType, ACCOUNT_PLANS } from '../user/entities/user.entity'
+ import { Roles } from '../common/decorators/roles.decorator'
+ import { SelfhostedGuard } from 'src/common/guards/selfhosted.guard'
+ import { RolesGuard } from '../common/guards/roles.guard'
+ import { Pagination } from '../common/pagination/pagination'
+ import { Project } from './entity/project.entity'
+ import { CurrentUserId } from '../common/decorators/current-user-id.decorator'
+ import { UserService } from '../user/user.service'
+ import { ProjectDTO } from './dto/project.dto'
+ import { AppLoggerService } from '../logger/logger.service'
+ import {
+ redis, isValidPID, getRedisProjectKey, redisProjectCacheTimeout, clickhouse, isSelfhosted,
+ } from '../common/constants'
+ import {
+ getProjectsClickhouse, createProjectClickhouse, updateProjectClickhouse, deleteProjectClickhouse,
+ } from '../common/utils'
+
+ @ApiTags('Project')
+ @Controller('project')
+ export class ProjectController {
+ constructor(
+ private readonly projectService: ProjectService,
+ private readonly userService: UserService,
+ private readonly logger: AppLoggerService,
+ ) {}
+
+ @Get('/')
+ @ApiQuery({ name: 'take', required: false })
+ @ApiQuery({ name: 'skip', required: false })
+ @ApiQuery({ name: 'relatedonly', required: false, type: Boolean })
+ @ApiResponse({ status: 200, type: [Project] })
+ @UseGuards(RolesGuard)
+ @Roles(UserType.CUSTOMER, UserType.ADMIN)
+ async get(@CurrentUserId() userId: string, @Query('take') take: number | undefined, @Query('skip') skip: number | undefined): Promise<Pagination<Project> | Project[] | object> {
+ this.logger.log({ userId, take, skip }, 'GET /project')
+ if (isSelfhosted) {
+ const results = await getProjectsClickhouse()
+ const formatted = _map(results, this.projectService.formatFromClickhouse)
+ return {
+ results,
+ page_total: _size(formatted),
+ total: _size(formatted),
+ totalMonthlyEvents: 0, // not needed as it's selfhosed
+ }
+ } else {
+ const where = Object()
+ where.admin = userId
+
+ const paginated = await this.projectService.paginate({ take, skip }, where)
+ const totalMonthlyEvents = await this.projectService.getRedisCount(userId)
+
+ return {
+ ...paginated,
+ totalMonthlyEvents,
+ }
}
- } else {
+ }
+
+ @Get('/all')
+ @ApiQuery({ name: 'take', required: false })
+ @ApiQuery({ name: 'skip', required: false })
+ @UseGuards(SelfhostedGuard)
+ @UseGuards(RolesGuard)
+ @Roles(UserType.ADMIN)
+ @ApiResponse({ status: 200, type: Project })
+ async getAllProjects(@Query('take') take: number | undefined, @Query('skip') skip: number | undefined): Promise<Project | object> {
+ this.logger.log({take, skip }, 'GET all')
+
+ const where = Object()
+ return await this.projectService.paginate({take, skip}, where)
+ }
+
+
+ @Get('/user/:id')
+ @ApiQuery({ name: 'take', required: false })
+ @ApiQuery({ name: 'skip', required: false })
+ @ApiQuery({ name: 'relatedonly', required: false, type: Boolean })
+ @ApiResponse({ status: 200, type: [Project] })
+ @UseGuards(SelfhostedGuard)
+ @UseGuards(RolesGuard)
+ @Roles(UserType.ADMIN)
+ async getUserProject(@Param('id') userId: string, @Query('take') take: number | undefined, @Query('skip') skip: number | undefined): Promise<Pagination<Project> | Project[] | object> {
+ this.logger.log({ userId, take, skip }, 'GET /user/:id')
+
const where = Object()
where.admin = userId
-
+
const paginated = await this.projectService.paginate({ take, skip }, where)
const totalMonthlyEvents = await this.projectService.getRedisCount(userId)
-
+
return {
...paginated,
totalMonthlyEvents,
}
+
}
- }
-
- @Get('/all')
- @ApiQuery({ name: 'take', required: false })
- @ApiQuery({ name: 'skip', required: false })
- @UseGuards(RolesGuard)
- @Roles(UserType.ADMIN)
- @UseGuards(SelfhostedGuard)
- @ApiResponse({ status: 200, type: Project })
- async getAllProjects(@Query('take') take: number | undefined, @Query('skip') skip: number | undefined): Promise<Project | object> {
- this.logger.log({take, skip }, 'GET /all')
-
- const where = Object()
- return await this.projectService.paginate({take, skip}, where)
- }
-
-
- @Get('/user/:id')
- @ApiQuery({ name: 'take', required: false })
- @ApiQuery({ name: 'skip', required: false })
- @ApiQuery({ name: 'relatedonly', required: false, type: Boolean })
- @ApiResponse({ status: 200, type: [Project] })
- @UseGuards(RolesGuard)
- @UseGuards(SelfhostedGuard)
- @Roles(UserType.ADMIN)
- async getUserProject(@Param('id') userId: string, @Query('take') take: number | undefined, @Query('skip') skip: number | undefined): Promise<Pagination<Project> | Project[] | object> {
- this.logger.log({ userId, take, skip }, 'GET /user/:id')
- const where = Object()
- where.admin = userId
-
- const paginated = await this.projectService.paginate({ take, skip }, where)
- const totalMonthlyEvents = await this.projectService.getRedisCount(userId)
-
- return {
- ...paginated,
- totalMonthlyEvents,
- }
- }
-
- @Get('/:id')
- @ApiResponse({ status: 200, type: Project })
- async getOne(@Param('id') id: string, @CurrentUserId() uid: string): Promise<Project | object> {
- this.logger.log({ id }, 'GET /project/:id')
- if (!isValidPID(id)) throw new BadRequestException('The provided Project ID (pid) is incorrect')
-
- let project
-
- if (isSelfhosted) {
- project = await getProjectsClickhouse(id)
- } else {
- project = await this.projectService.findOne(id)
- }
-
- if (_isEmpty(project)) throw new NotFoundException('Project was not found in the database')
-
- this.projectService.allowedToView(project, uid)
-
- if (isSelfhosted) {
- return this.projectService.formatFromClickhouse(project)
- }
-
- return project
- }
-
- @Post('/')
- @ApiResponse({ status: 201, type: Project })
- @UseGuards(RolesGuard)
- @Roles(UserType.CUSTOMER, UserType.ADMIN)
- async create(@Body() projectDTO: ProjectDTO, @CurrentUserId() userId: string): Promise<Project> {
- this.logger.log({ projectDTO, userId }, 'POST /project')
-
- if (isSelfhosted) {
- const projects = await getProjectsClickhouse()
-
- this.projectService.validateProject(projectDTO)
- this.projectService.checkIfIDUniqueClickhouse(projects, projectDTO.id)
-
- const project = new Project()
- Object.assign(project, projectDTO)
- project.origins = _map(projectDTO.origins, _trim)
- project.active = true
-
- await createProjectClickhouse(project)
-
+
+ @Get('/:id')
+ @ApiResponse({ status: 200, type: Project })
+ async getOne(@Param('id') id: string, @CurrentUserId() uid: string): Promise<Project | object> {
+ this.logger.log({ id }, 'GET /project/:id')
+ if (!isValidPID(id)) throw new BadRequestException('The provided Project ID (pid) is incorrect')
+
+ let project
+
+ if (isSelfhosted) {
+ project = await getProjectsClickhouse(id)
+ } else {
+ project = await this.projectService.findOne(id)
+ }
+
+ if (_isEmpty(project)) throw new NotFoundException('Project was not found in the database')
+
+ this.projectService.allowedToView(project, uid)
+
+ if (isSelfhosted) {
+ return this.projectService.formatFromClickhouse(project)
+ }
+
return project
- } else {
+ }
+
+ @Post('/admin/:id')
+ @ApiResponse({ status: 201, type: Project })
+ @UseGuards(SelfhostedGuard)
+ @UseGuards(RolesGuard)
+ @Roles(UserType.ADMIN)
+ async createForAdmin(@Param('id') userId: string, @Body() projectDTO: ProjectDTO): Promise<Project> {
+ this.logger.log({ userId, projectDTO }, 'POST /project/admin')
+
const user = await this.userService.findOneWithRelations(userId, ['projects'])
const maxProjects = ACCOUNT_PLANS[user.planCode]?.maxProjects
-
+
if (!user.isActive) {
throw new ForbiddenException('Please, verify your email address first')
}
-
+
if (_size(user.projects) >= (maxProjects || 5)) {
throw new ForbiddenException(`You cannot create more than ${maxProjects} projects on your account plan. Please upgrade to be able to create more projects.`)
}
-
+
this.projectService.validateProject(projectDTO)
-
await this.projectService.checkIfIDUnique(projectDTO.id)
-
+
try {
const project = new Project()
Object.assign(project, projectDTO)
project.origins = _map(projectDTO.origins, _trim)
-
+
const newProject = await this.projectService.create(project)
user.projects.push(project)
-
+
await this.userService.create(user)
-
+
return newProject
} catch(e) {
if (e.code === 'ER_DUP_ENTRY'){
@@ -184,95 +171,64 @@ export class ProjectController {
throw new BadRequestException('Project with selected ID already exists')
}
}
-
+
throw new BadRequestException(e)
}
+
}
- }
-
- @Put('/:id')
- @HttpCode(200)
- @UseGuards(RolesGuard)
- @Roles(UserType.CUSTOMER, UserType.ADMIN)
- @ApiResponse({ status: 200, type: Project })
- async update(@Param('id') id: string, @Body() projectDTO: ProjectDTO, @CurrentUserId() uid: string): Promise<any> {
- this.logger.log({ projectDTO, uid, id }, 'PUT /project/:id')
- this.projectService.validateProject(projectDTO)
- let project
-
- if (isSelfhosted) {
- const project = await getProjectsClickhouse(id)
-
- if (_isEmpty(project)) {
- throw new NotFoundException()
- }
- project.active = projectDTO.active
- project.origins = _map(projectDTO.origins, _trim)
- project.name = projectDTO.name
- project.public = projectDTO.public
-
- await updateProjectClickhouse(this.projectService.formatToClickhouse(project))
- } else {
+
+ @Put('/admin/:pid')
+ @HttpCode(200)
+ @UseGuards(SelfhostedGuard)
+ @UseGuards(RolesGuard)
+ @Roles(UserType.ADMIN)
+ @ApiResponse({ status: 200, type: Project })
+ async updateForAdmin(@Param('pid') id: string, @Body() projectDTO: ProjectDTO): Promise<any> {
+ this.logger.log({ projectDTO, id }, 'POST /project/admin/:pid')
+ this.projectService.validateProject(projectDTO)
+ let project
+
project = await this.projectService.findOneWithRelations(id)
-
+
if (_isEmpty(project)) {
throw new NotFoundException()
}
- this.projectService.allowedToManage(project, uid)
-
project.active = projectDTO.active
- project.origins = _map(projectDTO.origins, _trim)
+ project.origins = projectDTO.origins
project.name = projectDTO.name
project.public = projectDTO.public
-
+
await this.projectService.update(id, project)
- }
-
- const key = getRedisProjectKey(id)
-
- try {
- await redis.set(key, JSON.stringify(project), 'EX', redisProjectCacheTimeout)
- } catch {
- await redis.del(key)
- }
-
- return project
- }
-
- @Delete('/:id')
- @HttpCode(204)
- @UseGuards(RolesGuard)
- @Roles(UserType.CUSTOMER, UserType.ADMIN)
- @ApiResponse({ status: 204, description: 'Empty body' })
- async delete(@Param('id') id: string, @CurrentUserId() uid: string): Promise<any> {
- this.logger.log({ uid, id }, 'DELETE /project/:id')
- if (!isValidPID(id)) throw new BadRequestException('The provided Project ID (pid) is incorrect')
-
- if (isSelfhosted) {
- await deleteProjectClickhouse(id)
-
- const query1 = `ALTER table analytics DELETE WHERE pid='${id}'`
- const query2 = `ALTER table customEV DELETE WHERE pid='${id}'`
-
+
+ const key = getRedisProjectKey(id)
+
try {
- await clickhouse.query(query1).toPromise()
- await clickhouse.query(query2).toPromise()
- return 'Project deleted successfully'
- } catch(e) {
- this.logger.error(e)
- return 'Error while deleting your project'
+ await redis.set(key, JSON.stringify(project), 'EX', redisProjectCacheTimeout)
+ } catch {
+ await redis.del(key)
}
- } else {
+
+ return project
+ }
+
+ @Delete('/admin/:id')
+ @HttpCode(204)
+ @UseGuards(SelfhostedGuard)
+ @UseGuards(RolesGuard)
+ @Roles(UserType.ADMIN)
+ @ApiResponse({ status: 204, description: 'Empty body' })
+ async deleteForAdmin(@Param('id') id: string): Promise<any> {
+ this.logger.log({ id }, 'DELETE /project/admin/:id')
+
const project = await this.projectService.findOneWhere({ id }, {
relations: ['admin'],
select: ['id'],
})
-
+
if (_isEmpty(project)) {
throw new NotFoundException(`Project with ID ${id} does not exist`)
}
- this.projectService.allowedToManage(project, uid)
-
+
const query1 = `ALTER table analytics DELETE WHERE pid='${id}'`
const query2 = `ALTER table customEV DELETE WHERE pid='${id}'`
@@ -285,6 +241,165 @@ export class ProjectController {
this.logger.error(e)
return 'Error while deleting your project'
}
+
+ }
+
+ @Post('/')
+ @ApiResponse({ status: 201, type: Project })
+ @UseGuards(RolesGuard)
+ @Roles(UserType.CUSTOMER, UserType.ADMIN)
+ async create(@Body() projectDTO: ProjectDTO, @CurrentUserId() userId: string): Promise<Project> {
+ this.logger.log({ projectDTO, userId }, 'POST /project')
+
+ if (isSelfhosted) {
+ const projects = await getProjectsClickhouse()
+
+ this.projectService.validateProject(projectDTO)
+ this.projectService.checkIfIDUniqueClickhouse(projects, projectDTO.id)
+
+ const project = new Project()
+ Object.assign(project, projectDTO)
+ project.origins = _map(projectDTO.origins, _trim)
+ project.active = true
+
+ await createProjectClickhouse(project)
+
+ return project
+ } else {
+ const user = await this.userService.findOneWithRelations(userId, ['projects'])
+ const maxProjects = ACCOUNT_PLANS[user.planCode]?.maxProjects
+
+ if (!user.isActive) {
+ throw new ForbiddenException('Please, verify your email address first')
+ }
+
+ if (_size(user.projects) >= (maxProjects || 5)) {
+ throw new ForbiddenException(`You cannot create more than ${maxProjects} projects on your account plan. Please upgrade to be able to create more projects.`)
+ }
+
+ this.projectService.validateProject(projectDTO)
+
+ await this.projectService.checkIfIDUnique(projectDTO.id)
+
+ try {
+ const project = new Project()
+ Object.assign(project, projectDTO)
+ project.origins = _map(projectDTO.origins, _trim)
+
+ const newProject = await this.projectService.create(project)
+ user.projects.push(project)
+
+ await this.userService.create(user)
+
+ return newProject
+ } catch(e) {
+ if (e.code === 'ER_DUP_ENTRY'){
+ if (e.sqlMessage.includes(projectDTO.id)){
+ throw new BadRequestException('Project with selected ID already exists')
+ }
+ }
+
+ throw new BadRequestException(e)
+ }
+ }
+ }
+
+ @Put('/:id')
+ @HttpCode(200)
+ @UseGuards(RolesGuard)
+ @Roles(UserType.CUSTOMER, UserType.ADMIN)
+ @ApiResponse({ status: 200, type: Project })
+ async update(@Param('id') id: string, @Body() projectDTO: ProjectDTO, @CurrentUserId() uid: string): Promise<any> {
+ this.logger.log({ projectDTO, uid, id }, 'PUT /project/:id')
+ this.projectService.validateProject(projectDTO)
+ let project
+
+ if (isSelfhosted) {
+ const project = await getProjectsClickhouse(id)
+
+ if (_isEmpty(project)) {
+ throw new NotFoundException()
+ }
+ project.active = projectDTO.active
+ project.origins = _map(projectDTO.origins, _trim)
+ project.name = projectDTO.name
+ project.public = projectDTO.public
+
+ await updateProjectClickhouse(this.projectService.formatToClickhouse(project))
+ } else {
+ project = await this.projectService.findOneWithRelations(id)
+
+ if (_isEmpty(project)) {
+ throw new NotFoundException()
+ }
+ this.projectService.allowedToManage(project, uid)
+
+ project.active = projectDTO.active
+ project.origins = _map(projectDTO.origins, _trim)
+ project.name = projectDTO.name
+ project.public = projectDTO.public
+
+ await this.projectService.update(id, project)
+ }
+
+ const key = getRedisProjectKey(id)
+
+ try {
+ await redis.set(key, JSON.stringify(project), 'EX', redisProjectCacheTimeout)
+ } catch {
+ await redis.del(key)
+ }
+
+ return project
+ }
+
+ @Delete('/:id')
+ @HttpCode(204)
+ @UseGuards(RolesGuard)
+ @Roles(UserType.CUSTOMER, UserType.ADMIN)
+ @ApiResponse({ status: 204, description: 'Empty body' })
+ async delete(@Param('id') id: string, @CurrentUserId() uid: string): Promise<any> {
+ this.logger.log({ uid, id }, 'DELETE /project/:id')
+ if (!isValidPID(id)) throw new BadRequestException('The provided Project ID (pid) is incorrect')
+
+ if (isSelfhosted) {
+ await deleteProjectClickhouse(id)
+
+ const query1 = `ALTER table analytics DELETE WHERE pid='${id}'`
+ const query2 = `ALTER table customEV DELETE WHERE pid='${id}'`
+
+ try {
+ await clickhouse.query(query1).toPromise()
+ await clickhouse.query(query2).toPromise()
+ return 'Project deleted successfully'
+ } catch(e) {
+ this.logger.error(e)
+ return 'Error while deleting your project'
+ }
+ } else {
+ const project = await this.projectService.findOneWhere({ id }, {
+ relations: ['admin'],
+ select: ['id'],
+ })
+
+ if (_isEmpty(project)) {
+ throw new NotFoundException(`Project with ID ${id} does not exist`)
+ }
+ this.projectService.allowedToManage(project, uid)
+
+ const query1 = `ALTER table analytics DELETE WHERE pid='${id}'`
+ const query2 = `ALTER table customEV DELETE WHERE pid='${id}'`
+
+ try {
+ await this.projectService.delete(id)
+ await clickhouse.query(query1).toPromise()
+ await clickhouse.query(query2).toPromise()
+ return 'Project deleted successfully'
+ } catch(e) {
+ this.logger.error(e)
+ return 'Error while deleting your project'
+ }
+ }
}
}
-}
+
\ No newline at end of file