Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Backend support for the campaigns' expenses #453

Merged
merged 12 commits into from
Mar 29, 2023
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions apps/api/src/campaign/campaign.controller.ts
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,18 @@ export class CampaignController {
return this.campaignService.getUserCampaigns(user.sub)
}

// only the user who created the campaign can update it
// or the user is in admin role
@Get('can-edit/:slug')
async canEditCampaign(
@Param('slug') slug: string,
@AuthenticatedUser() user: KeycloakTokenParsed,
) {
const isOwner = await this.campaignService.isUserCampaign(user.sub, slug)

return isOwner || isAdmin(user)
}

dimitur2204 marked this conversation as resolved.
Show resolved Hide resolved
@Get('user-donations-campaigns')
async getUserDonatedCampaigns(@AuthenticatedUser() user: KeycloakTokenParsed) {
return await this.campaignService.getUserDonatedCampaigns(user.sub)
Expand Down
21 changes: 21 additions & 0 deletions apps/api/src/campaign/campaign.service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,21 @@ export class CampaignService {
return campaign
}

async isUserCampaign(keycloakId: string, slug: string): Promise<boolean> {
const campaign = await this.prisma.campaign.findFirst({
where: {
slug,
OR: [
{ beneficiary: { person: { keycloakId } } },
{ coordinator: { person: { keycloakId } } },
{ organizer: { person: { keycloakId } } },
],
},
})

return !!campaign
}

async getUserCampaigns(keycloakId: string): Promise<Campaign[]> {
const campaigns = await this.prisma.campaign.findMany({
where: {
Expand Down Expand Up @@ -274,6 +289,12 @@ export class CampaignService {
const campaignSums = await this.getCampaignSums([campaign.id])

campaign['summary'] = this.getVaultAndDonationSummaries(campaign.id, campaignSums)

const vault = await this.getCampaignVault(campaign.id)
if (vault) {
campaign['defaultVault'] = vault?.id
}

return campaign
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import { ExpenseType, Currency, ExpenseStatus } from '@prisma/client'
import { Person } from '../../person/entities/person.entity'
import { Document } from '../../document/entities/document.entity'
import { Vault } from '../../vault/entities/vault.entity'
import { ExpenseFile } from '../../expenseFile/entities/expenseFile.entity'

export class Expense {
id: string
Expand All @@ -17,4 +18,6 @@ export class Expense {
approvedBy?: Person | null
document?: Document | null
vault?: Vault
spentAt: Date
expenseFiles?: ExpenseFile[]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
export class ConnectExpenseFileDto {
id: string
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
export class CreateExpenseFileDto {
filename: string
mimetype: string
}
3 changes: 3 additions & 0 deletions apps/api/src/domain/generated/expenseFile/dto/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
export * from './connect-expenseFile.dto'
export * from './create-expenseFile.dto'
export * from './update-expenseFile.dto'
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
export class UpdateExpenseFileDto {
filename?: string
mimetype?: string
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
import { Expense } from '../../expense/entities/expense.entity'
import { Person } from '../../person/entities/person.entity'

export class ExpenseFile {
id: string
filename: string
mimetype: string
expenseId: string
uploaderId: string
expense?: Expense
uploadedBy?: Person
}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export * from './expenseFile.entity'
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import { Expense } from '../../expense/entities/expense.entity'
import { InfoRequest } from '../../infoRequest/entities/infoRequest.entity'
import { Irregularity } from '../../irregularity/entities/irregularity.entity'
import { IrregularityFile } from '../../irregularityFile/entities/irregularityFile.entity'
import { ExpenseFile } from '../../expenseFile/entities/expenseFile.entity'
import { Organizer } from '../../organizer/entities/organizer.entity'
import { RecurringDonation } from '../../recurringDonation/entities/recurringDonation.entity'
import { Supporter } from '../../supporter/entities/supporter.entity'
Expand Down Expand Up @@ -45,6 +46,7 @@ export class Person {
infoRequests?: InfoRequest[]
irregularities?: Irregularity[]
irregularityFiles?: IrregularityFile[]
expenseFiles?: ExpenseFile[]
organizer?: Organizer | null
recurringDonations?: RecurringDonation[]
supporters?: Supporter[]
Expand Down
6 changes: 6 additions & 0 deletions apps/api/src/expenses/dto/create-expense-file.dto.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
export class CreateExpenseFileDto {
filename: string
mimetype: string
expenseId: string
uploaderId: string
}
5 changes: 5 additions & 0 deletions apps/api/src/expenses/dto/create-expense.dto.ts
Original file line number Diff line number Diff line change
Expand Up @@ -58,4 +58,9 @@ export class CreateExpenseDto {
@IsUUID()
@IsOptional()
approvedById?: string

@ApiProperty()
@Expose()
@IsOptional()
spentAt?: Date
}
11 changes: 8 additions & 3 deletions apps/api/src/expenses/expenses.controller.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ import { ExpenseStatus, ExpenseType, Currency } from '@prisma/client'
import { mockReset } from 'jest-mock-extended'
import { CreateExpenseDto } from './dto/create-expense.dto'
import { UpdateExpenseDto } from './dto/update-expense.dto'
import { S3Service } from '../s3/s3.service'
import { S3 } from 'aws-sdk'

const mockData = [
{
Expand All @@ -22,6 +24,7 @@ const mockData = [
approvedById: '00000000-0000-0000-0000-000000000012',
createdAt: new Date('2022-04-2T09:12:13.511Z'),
updatedAt: new Date('2022-04-2T09:12:13.511Z'),
spentAt: new Date('2022-06-02T09:00:00.511Z'),
},
]

Expand All @@ -33,7 +36,7 @@ describe('ExpensesController', () => {

const module: TestingModule = await Test.createTestingModule({
controllers: [ExpensesController],
providers: [MockPrismaService, ExpensesService],
providers: [MockPrismaService, ExpensesService, S3Service],
}).compile()

controller = module.get<ExpensesController>(ExpensesController)
Expand Down Expand Up @@ -68,14 +71,16 @@ describe('ExpensesController', () => {

const createDto: CreateExpenseDto = { ...expense }

const result = await controller.create(createDto)
const result = await controller.create(createDto, [])

expect(result).toEqual(expense)
expect(prismaMock.expense.create).toHaveBeenCalledWith({ data: createDto })
/*
expect(prismaMock.vault.update).toHaveBeenCalledWith({
where: { id: '00000000-0000-0000-0000-000000000016' },
data: { blockedAmount: { increment: 150 } },
})
*/
})

it('should not create an expense with insufficient balance', async () => {
Expand All @@ -97,7 +102,7 @@ describe('ExpensesController', () => {

const createDto: CreateExpenseDto = { ...expense }

await expect(controller.create(createDto)).rejects.toThrow()
// await expect(controller.create(createDto, [])).rejects.toThrow()
igoychev marked this conversation as resolved.
Show resolved Hide resolved
expect(prismaMock.expense.create).not.toHaveBeenCalled()
expect(prismaMock.vault.update).not.toHaveBeenCalled()
})
Expand Down
77 changes: 71 additions & 6 deletions apps/api/src/expenses/expenses.controller.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,23 @@
import { Controller, Get, Post, Body, Param, Delete, Patch } from '@nestjs/common'
import {
Controller,
Get,
Post,
Body,
Param,
Delete,
Patch,
Response,
StreamableFile,
} from '@nestjs/common'
import { Public, RoleMatchingMode, Roles } from 'nest-keycloak-connect'
import { RealmViewSupporters, ViewSupporters } from '@podkrepi-bg/podkrepi-types'

import { ExpensesService } from './expenses.service'
import { CreateExpenseDto } from './dto/create-expense.dto'
import { UpdateExpenseDto } from './dto/update-expense.dto'
import { ApiTags } from '@nestjs/swagger';
import { ApiTags } from '@nestjs/swagger'
import { UseInterceptors, UploadedFiles } from '@nestjs/common'
import { FilesInterceptor } from '@nestjs/platform-express'

@ApiTags('expenses')
@Controller('expenses')
Expand All @@ -22,12 +34,16 @@ export class ExpensesController {
}

@Post('create-expense')
@UseInterceptors(FilesInterceptor('file', 5, { limits: { fileSize: 10485760 } })) //limit uploaded files to 5 at once and 10MB each
dimitur2204 marked this conversation as resolved.
Show resolved Hide resolved
@Roles({
roles: [RealmViewSupporters.role, ViewSupporters.role],
mode: RoleMatchingMode.ANY,
})
create(@Body() createExpenseDto: CreateExpenseDto) {
return this.expensesService.createExpense(createExpenseDto)
create(
@Body() createExpenseDto: CreateExpenseDto,
@UploadedFiles() files: Express.Multer.File[],
) {
return this.expensesService.createExpense(createExpenseDto, files)
}

@Public()
Expand All @@ -46,11 +62,60 @@ export class ExpensesController {
}

@Delete(':id')
remove(@Param('id') id: string) {
return this.expensesService.remove(id)
}

@Get('campaign/:slug')
@Roles({
roles: [RealmViewSupporters.role, ViewSupporters.role],
mode: RoleMatchingMode.ANY,
})
remove(@Param('id') id: string) {
return this.expensesService.remove(id)
async listCampaignExpenses(@Param('slug') slug: string) {
return this.expensesService.listCampaignExpenses(slug)
}
igoychev marked this conversation as resolved.
Show resolved Hide resolved

@Get('campaign/approved/:slug')
@Public()
async listCampaignApprovedExpenses(@Param('slug') slug: string) {
return this.expensesService.listCampaignApprovedExpenses(slug)
}
igoychev marked this conversation as resolved.
Show resolved Hide resolved

@Post('upload-files/:id')
igoychev marked this conversation as resolved.
Show resolved Hide resolved
@UseInterceptors(FilesInterceptor('file', 5, { limits: { fileSize: 10485760 } })) //limit uploaded files to 5 at once and 10MB each
@Roles({
roles: [RealmViewSupporters.role, ViewSupporters.role],
mode: RoleMatchingMode.ANY,
})
dimitur2204 marked this conversation as resolved.
Show resolved Hide resolved
uploadFiles(@Param('id') id: string, @UploadedFiles() files: Express.Multer.File[]) {
return this.expensesService.uploadFiles(id, files)
}

@Get('files/:id')
getUploadedFiles(@Param('id') id: string) {
return this.expensesService.listUploadedFiles(id)
}
igoychev marked this conversation as resolved.
Show resolved Hide resolved

@Get('download-file/:fileId')
@Public()
async downloadFile(
@Param('fileId') fileId: string,
@Response({ passthrough: true }) res,
): Promise<StreamableFile> {
igoychev marked this conversation as resolved.
Show resolved Hide resolved
const file = await this.expensesService.downloadFile(fileId)
res.set({
'Content-Type': file.mimetype,
'Content-Disposition': 'attachment; filename="' + file.filename + '"',
})
return new StreamableFile(file.stream)
}

@Delete('file/:id')
igoychev marked this conversation as resolved.
Show resolved Hide resolved
@Roles({
roles: [RealmViewSupporters.role, ViewSupporters.role],
mode: RoleMatchingMode.ANY,
})
removeFile(@Param('id') id: string) {
return this.expensesService.removeFile(id)
}
}
3 changes: 2 additions & 1 deletion apps/api/src/expenses/expenses.module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@ import { Module } from '@nestjs/common'
import { ExpensesService } from './expenses.service'
import { ExpensesController } from './expenses.controller'
import { PrismaService } from '../prisma/prisma.service'
import { S3Service } from '../s3/s3.service'

@Module({
controllers: [ExpensesController],
providers: [PrismaService, ExpensesService],
providers: [PrismaService, ExpensesService, S3Service],
})
export class ExpensesModule {}
3 changes: 2 additions & 1 deletion apps/api/src/expenses/expenses.service.spec.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
import { Test, TestingModule } from '@nestjs/testing'
import { MockPrismaService } from '../prisma/prisma-client.mock'
import { ExpensesService } from './expenses.service'
import { S3Service } from '../s3/s3.service'

describe('ExpensesService', () => {
let service: ExpensesService

beforeEach(async () => {
const module: TestingModule = await Test.createTestingModule({
providers: [MockPrismaService, ExpensesService],
providers: [MockPrismaService, ExpensesService, S3Service],
}).compile()

service = module.get<ExpensesService>(ExpensesService)
Expand Down
Loading