Skip to content

Sync-in · Sovereign platform for file storage, sharing, synchronization, and collaboration.

refactor(backend:files): split file operations into dedicated controller

johaven1ce10d7420b9
diff --git a/backend/src/applications/files/files-operations.controller.spec.ts b/backend/src/applications/files/files-operations.controller.spec.ts
new file mode 100644
index 00000000..1cdbf77f
--- /dev/null
+++ b/backend/src/applications/files/files-operations.controller.spec.ts
@@ -0,0 +1,262 @@
+import { Test, TestingModule } from '@nestjs/testing'
+import { ContextInterceptor } from '../../infrastructure/context/interceptors/context.interceptor'
+import { ContextManager } from '../../infrastructure/context/services/context-manager.service'
+import { SpaceGuard } from '../spaces/guards/space.guard'
+import { FILE_OPERATION } from './constants/operations'
+import { FilesOperationsController } from './files-operations.controller'
+import { FilesMethods } from './services/files-methods.service'
+import { FilesTasksManager } from './services/tasks/files-tasks-manager.service'
+
+describe(FilesOperationsController.name, () => {
+ let filesOperationsController: FilesOperationsController
+
+ // Reusable fakes
+ const fakeUser: any = { id: 1, login: 'john', role: 1 }
+ const fakeSpace: any = { id: 42, key: 'space-key', url: '/space/a', realPath: '/data/space/a', realBasePath: '/data/space' }
+ const fakeReq: any = { user: fakeUser, space: fakeSpace, headers: {}, method: 'GET', ip: '127.0.0.1' }
+ const fakeRes: any = { header: vi.fn().mockReturnThis(), status: vi.fn().mockReturnThis(), type: vi.fn().mockReturnThis(), send: vi.fn() }
+
+ // Mocks
+ const filesMethodsMock = {
+ headOrGet: vi.fn(),
+ make: vi.fn(),
+ upload: vi.fn(),
+ copy: vi.fn(),
+ move: vi.fn(),
+ delete: vi.fn(),
+ genThumbnail: vi.fn(),
+ downloadFromUrl: vi.fn(),
+ compress: vi.fn(),
+ decompress: vi.fn()
+ }
+
+ const filesTasksManagerMock = {
+ createTask: vi.fn()
+ }
+
+ beforeAll(async () => {
+ const testingModuleBuilder = Test.createTestingModule({
+ controllers: [FilesOperationsController],
+ providers: [
+ { provide: FilesMethods, useValue: filesMethodsMock },
+ { provide: FilesTasksManager, useValue: filesTasksManagerMock },
+ { provide: ContextManager, useValue: {} },
+ ContextInterceptor
+ ]
+ })
+ // IMPORTANT: override the guard referenced by @UseGuards to avoid resolving its dependencies
+ testingModuleBuilder.overrideGuard(SpaceGuard).useValue({ canActivate: vi.fn().mockReturnValue(true) })
+
+ const module: TestingModule = await testingModuleBuilder.compile()
+
+ filesOperationsController = module.get<FilesOperationsController>(FilesOperationsController)
+ })
+
+ it('should be defined', () => {
+ expect(filesOperationsController).toBeDefined()
+ })
+
+ describe('Operations', () => {
+ beforeEach(() => {
+ vi.clearAllMocks()
+ })
+
+ it('head() should delegate to filesMethods.headOrGet(req, res) and return its result', async () => {
+ const stream = {} as any
+ filesMethodsMock.headOrGet.mockResolvedValue(stream)
+
+ const result = await filesOperationsController.head(fakeReq, fakeRes)
+
+ expect(filesMethodsMock.headOrGet).toHaveBeenCalledWith(fakeReq, fakeRes)
+ expect(result).toBe(stream)
+ })
+
+ it('download() should delegate to filesMethods.headOrGet(req, res) and return its result', async () => {
+ const stream = {} as any
+ filesMethodsMock.headOrGet.mockResolvedValue(stream)
+
+ const result = await filesOperationsController.download(fakeReq, fakeRes)
+
+ expect(filesMethodsMock.headOrGet).toHaveBeenCalledWith(fakeReq, fakeRes)
+ expect(result).toBe(stream)
+ })
+
+ it('make() should call filesMethods.make(user, space, dto)', async () => {
+ const dto = { path: '/a', name: 'b', type: 'directory' } as any
+
+ await filesOperationsController.make(fakeUser, fakeSpace, dto)
+
+ expect(filesMethodsMock.make).toHaveBeenCalledWith(fakeUser, fakeSpace, dto)
+ })
+
+ it('upload() should call filesMethods.upload(req, res)', async () => {
+ await filesOperationsController.uploadCreate(fakeReq, fakeRes)
+
+ expect(filesMethodsMock.upload).toHaveBeenCalledWith(fakeReq, fakeRes)
+ })
+
+ it('copy() should call filesMethods.copy(user, space, dto) and return its result', async () => {
+ const dto = { dstDirectory: '/dst', dstName: 'b' } as any
+ const expected = { path: '/dst', name: 'b' }
+ filesMethodsMock.copy.mockResolvedValue(expected)
+
+ const result = await filesOperationsController.copy(fakeUser, fakeSpace, dto)
+
+ expect(filesMethodsMock.copy).toHaveBeenCalledWith(fakeUser, fakeSpace, dto)
+ expect(result).toEqual(expected)
+ })
+
+ it('move() should call filesMethods.move(user, space, dto) and return its result', async () => {
+ const dto = { dstDirectory: '/dst', dstName: 'c' } as any
+ const expected = { path: '/dst', name: 'c' }
+ filesMethodsMock.move.mockResolvedValue(expected)
+
+ const result = await filesOperationsController.move(fakeUser, fakeSpace, dto)
+
+ expect(filesMethodsMock.move).toHaveBeenCalledWith(fakeUser, fakeSpace, dto)
+ expect(result).toEqual(expected)
+ })
+
+ it('delete() should call filesMethods.delete(user, space)', async () => {
+ await filesOperationsController.delete(fakeUser, fakeSpace)
+
+ expect(filesMethodsMock.delete).toHaveBeenCalledWith(fakeUser, fakeSpace)
+ })
+
+ it('genThumbnail() should default size to 256 when not provided', async () => {
+ const stream = {} as any
+ filesMethodsMock.genThumbnail.mockResolvedValue(stream)
+
+ // pass undefined to exercise controller default parameter
+ const result = await filesOperationsController.genThumbnail(fakeSpace, undefined as unknown as number, fakeRes)
+
+ expect(filesMethodsMock.genThumbnail).toHaveBeenCalledWith(fakeSpace, 256)
+ expect(fakeRes.type).toHaveBeenCalled()
+ expect(fakeRes.send).toHaveBeenCalledWith(stream)
+ expect(result).toBeUndefined()
+ })
+
+ it('genThumbnail() should pass provided size', async () => {
+ const stream = {} as any
+ filesMethodsMock.genThumbnail.mockResolvedValue(stream)
+
+ const result = await filesOperationsController.genThumbnail(fakeSpace, 512, fakeRes)
+
+ expect(filesMethodsMock.genThumbnail).toHaveBeenCalledWith(fakeSpace, 512)
+ expect(fakeRes.type).toHaveBeenCalled()
+ expect(fakeRes.send).toHaveBeenCalledWith(stream)
+ expect(result).toBeUndefined()
+ })
+
+ it('genThumbnail() should reduce size larger than 1024', async () => {
+ const stream = {} as any
+ filesMethodsMock.genThumbnail.mockResolvedValue(stream)
+
+ const result = await filesOperationsController.genThumbnail(fakeSpace, 2048, fakeRes)
+
+ expect(filesMethodsMock.genThumbnail).toHaveBeenCalledWith(fakeSpace, 1024)
+ expect(fakeRes.type).toHaveBeenCalled()
+ expect(fakeRes.send).toHaveBeenCalledWith(stream)
+ expect(result).toBeUndefined()
+ })
+ })
+
+ describe('Tasks operations', () => {
+ beforeEach(() => {
+ vi.clearAllMocks()
+ })
+
+ it('downloadFromUrlAsTask() should create DOWNLOAD task using method name "downloadFromUrl"', async () => {
+ const dto = { url: 'http://x', to: '/a' } as any
+ const task = { id: 1 } as any
+ filesTasksManagerMock.createTask.mockResolvedValue(task)
+
+ const result = await filesOperationsController.downloadFromUrlAsTask(fakeUser, fakeSpace, dto)
+
+ expect(filesTasksManagerMock.createTask).toHaveBeenCalledWith(
+ FILE_OPERATION.DOWNLOAD,
+ fakeUser,
+ fakeSpace,
+ dto,
+ filesMethodsMock.downloadFromUrl.name
+ )
+ expect(result).toBe(task)
+ })
+
+ it('compressAsTask() should call SpaceGuard.checkPermissions when compressInDirectory is true', async () => {
+ const dto = { compressInDirectory: true } as any
+ const spy = vi.spyOn(SpaceGuard as any, 'checkPermissions').mockImplementation(() => undefined)
+
+ filesTasksManagerMock.createTask.mockResolvedValue({} as any)
+ await filesOperationsController.compressAsTask(fakeReq, dto)
+
+ expect(spy).toHaveBeenCalled()
+ spy.mockRestore()
+ })
+
+ it('compressAsTask() should create COMPRESS task with req.user and req.space and method name "compress"', async () => {
+ const dto = { compressInDirectory: false } as any
+ const task = { id: 2 } as any
+ filesTasksManagerMock.createTask.mockResolvedValue(task)
+
+ const result = await filesOperationsController.compressAsTask(fakeReq, dto)
+
+ expect(filesTasksManagerMock.createTask).toHaveBeenCalledWith(
+ FILE_OPERATION.COMPRESS,
+ fakeReq.user,
+ fakeReq.space,
+ dto,
+ filesMethodsMock.compress.name
+ )
+ expect(result).toBe(task)
+ })
+
+ it('decompressAsTask() should create DECOMPRESS task with null dto and method name "decompress"', async () => {
+ const task = { id: 3 } as any
+ filesTasksManagerMock.createTask.mockResolvedValue(task)
+
+ const result = await filesOperationsController.decompressAsTask(fakeUser, fakeSpace)
+
+ expect(filesTasksManagerMock.createTask).toHaveBeenCalledWith(
+ FILE_OPERATION.DECOMPRESS,
+ fakeUser,
+ fakeSpace,
+ null,
+ filesMethodsMock.decompress.name
+ )
+ expect(result).toBe(task)
+ })
+
+ it('copyAsTask() should create COPY task with method name "copy"', async () => {
+ const dto = { from: '/a', to: '/b' } as any
+ const task = { id: 4 } as any
+ filesTasksManagerMock.createTask.mockResolvedValue(task)
+
+ const result = await filesOperationsController.copyAsTask(fakeUser, fakeSpace, dto)
+
+ expect(filesTasksManagerMock.createTask).toHaveBeenCalledWith(FILE_OPERATION.COPY, fakeUser, fakeSpace, dto, filesMethodsMock.copy.name)
+ expect(result).toBe(task)
+ })
+
+ it('moveAsTask() should create MOVE task with method name "move"', async () => {
+ const dto = { from: '/a', to: '/c' } as any
+ const task = { id: 5 } as any
+ filesTasksManagerMock.createTask.mockResolvedValue(task)
+
+ const result = await filesOperationsController.moveAsTask(fakeUser, fakeSpace, dto)
+
+ expect(filesTasksManagerMock.createTask).toHaveBeenCalledWith(FILE_OPERATION.MOVE, fakeUser, fakeSpace, dto, filesMethodsMock.move.name)
+ expect(result).toBe(task)
+ })
+
+ it('deleteAsTask() should create DELETE task with null dto and method name "delete"', async () => {
+ const task = { id: 6 } as any
+ filesTasksManagerMock.createTask.mockResolvedValue(task)
+
+ const result = await filesOperationsController.deleteAsTask(fakeUser, fakeSpace)
+
+ expect(filesTasksManagerMock.createTask).toHaveBeenCalledWith(FILE_OPERATION.DELETE, fakeUser, fakeSpace, null, filesMethodsMock.delete.name)
+ expect(result).toBe(task)
+ })
+ })
+})
diff --git a/backend/src/applications/files/files-operations.controller.ts b/backend/src/applications/files/files-operations.controller.ts
new file mode 100644
index 00000000..940a8685
--- /dev/null
+++ b/backend/src/applications/files/files-operations.controller.ts
@@ -0,0 +1,173 @@
+import {
+ Body,
+ Controller,
+ Copy,
+ Delete,
+ Get,
+ Head,
+ Lock,
+ Logger,
+ Move,
+ ParseBoolPipe,
+ ParseIntPipe,
+ Patch,
+ Post,
+ Put,
+ Query,
+ Req,
+ Res,
+ StreamableFile,
+ Unlock,
+ UseGuards,
+ UseInterceptors
+} from '@nestjs/common'
+import { FastifyReply } from 'fastify'
+import { webpMimeType } from '../../common/image'
+import { ContextInterceptor } from '../../infrastructure/context/interceptors/context.interceptor'
+import { SkipSpacePermissionsCheck } from '../spaces/decorators/space-skip-permissions.decorator'
+import { GetSpace } from '../spaces/decorators/space.decorator'
+import { SpaceGuard } from '../spaces/guards/space.guard'
+import { FastifySpaceRequest } from '../spaces/interfaces/space-request.interface'
+import { SpaceEnv } from '../spaces/models/space-env.model'
+import { GetUser } from '../users/decorators/user.decorator'
+import { UserModel } from '../users/models/user.model'
+import { FILE_OPERATION, FORCE_AS_FILE_OWNER } from './constants/operations'
+import { FILES_ROUTE } from './constants/routes'
+import { CompressFileDto, CopyMoveFileDto, DownloadFileDto, MakeFileDto } from './dto/file-operations.dto'
+import type { CopyMoveFileResponse } from './interfaces/copy-move-file.interface'
+import { FileLockProps } from './interfaces/file-props.interface'
+import { FileTask } from './models/file-task'
+import { FilesMethods } from './services/files-methods.service'
+import { FilesTasksManager } from './services/tasks/files-tasks-manager.service'
+
+@Controller(FILES_ROUTE.BASE)
+@UseGuards(SpaceGuard)
+export class FilesOperationsController {
+ private readonly logger = new Logger(FilesOperationsController.name)
+
+ constructor(
+ private readonly filesMethods: FilesMethods,
+ private readonly filesTasksManager: FilesTasksManager
+ ) {}
+
+ // OPERATIONS
+
+ @Head(`${FILES_ROUTE.OPERATION}/*`)
+ async head(@Req() req: FastifySpaceRequest, @Res({ passthrough: true }) res: FastifyReply): Promise<StreamableFile> {
+ return this.filesMethods.headOrGet(req, res)
+ }
+
+ @Get(`${FILES_ROUTE.OPERATION}/*`)
+ async download(@Req() req: FastifySpaceRequest, @Res({ passthrough: true }) res: FastifyReply): Promise<StreamableFile> {
+ return this.filesMethods.headOrGet(req, res)
+ }
+
+ @Post(`${FILES_ROUTE.OPERATION}/${FILE_OPERATION.MAKE}/*`)
+ async make(@GetUser() user: UserModel, @GetSpace() space: SpaceEnv, @Body() makeFileDto: MakeFileDto): Promise<void> {
+ return this.filesMethods.make(user, space, makeFileDto)
+ }
+
+ @Post(`${FILES_ROUTE.OPERATION}/${FILE_OPERATION.UPLOAD}/*`)
+ async uploadCreate(@Req() req: FastifySpaceRequest, @Res({ passthrough: true }) res: FastifyReply): Promise<void> {
+ return this.filesMethods.upload(req, res)
+ }
+
+ @Put(`${FILES_ROUTE.OPERATION}/${FILE_OPERATION.UPLOAD}/*`)
+ async uploadOverwrite(@Req() req: FastifySpaceRequest, @Res({ passthrough: true }) res: FastifyReply): Promise<void> {
+ return this.filesMethods.upload(req, res)
+ }
+
+ @Patch(`${FILES_ROUTE.OPERATION}/${FILE_OPERATION.UPLOAD}/*`)
+ async uploadContent(@Req() req: FastifySpaceRequest, @Res({ passthrough: true }) res: FastifyReply): Promise<void> {
+ return this.filesMethods.upload(req, res)
+ }
+
+ @Copy(`${FILES_ROUTE.OPERATION}/*`)
+ async copy(@GetUser() user: UserModel, @GetSpace() space: SpaceEnv, @Body() copyMoveFileDto: CopyMoveFileDto): Promise<CopyMoveFileResponse> {
+ return this.filesMethods.copy(user, space, copyMoveFileDto)
+ }
+
+ @Move(`${FILES_ROUTE.OPERATION}/*`)
+ async move(@GetUser() user: UserModel, @GetSpace() space: SpaceEnv, @Body() copyMoveFileDto: CopyMoveFileDto): Promise<CopyMoveFileResponse> {
+ return this.filesMethods.move(user, space, copyMoveFileDto)
+ }
+
+ @Delete(`${FILES_ROUTE.OPERATION}/*`)
+ async delete(@GetUser() user: UserModel, @GetSpace() space: SpaceEnv): Promise<void> {
+ return this.filesMethods.delete(user, space)
+ }
+
+ @Get(`${FILES_ROUTE.OPERATION}/${FILE_OPERATION.THUMBNAIL}/*`)
+ async genThumbnail(
+ @GetSpace() space: SpaceEnv,
+ @Query('size', new ParseIntPipe({ optional: true })) size = 256,
+ @Res() res: FastifyReply
+ ): Promise<StreamableFile> {
+ if (size > 1024) size = 1024
+ const thumb = await this.filesMethods.genThumbnail(space, size)
+ res.type(webpMimeType)
+ return res.send(thumb)
+ }
+
+ @Lock(`${FILES_ROUTE.OPERATION}/*`)
+ async lock(@GetUser() user: UserModel, @GetSpace() space: SpaceEnv): Promise<FileLockProps> {
+ return this.filesMethods.lock(user, space)
+ }
+
+ @Unlock(`${FILES_ROUTE.OPERATION}/*`)
+ async unlock(
+ @GetUser() user: UserModel,
+ @GetSpace() space: SpaceEnv,
+ @Query(FORCE_AS_FILE_OWNER, new ParseBoolPipe({ optional: true })) forceAsFileOwner?: boolean
+ ): Promise<void> {
+ return this.filesMethods.unlock(user, space, forceAsFileOwner)
+ }
+
+ @Unlock(`${FILES_ROUTE.OPERATION}/${FILE_OPERATION.UNLOCK_REQUEST}/*`)
+ @UseInterceptors(ContextInterceptor)
+ async unlockRequest(@GetUser() user: UserModel, @GetSpace() space: SpaceEnv): Promise<void> {
+ return this.filesMethods.unlockRequest(user, space)
+ }
+
+ @Get(`${FILES_ROUTE.OPERATION}/${FILE_OPERATION.GET_SIZE}/*`)
+ async getSize(@GetSpace() space: SpaceEnv): Promise<{ size: number }> {
+ return this.filesMethods.getSize(space)
+ }
+
+ // TASKS OPERATIONS
+
+ @Post(`${FILES_ROUTE.TASK_OPERATION}/${FILE_OPERATION.DOWNLOAD}/*`)
+ async downloadFromUrlAsTask(@GetUser() user: UserModel, @GetSpace() space: SpaceEnv, @Body() downloadFileDto: DownloadFileDto): Promise<FileTask> {
+ return this.filesTasksManager.createTask(FILE_OPERATION.DOWNLOAD, user, space, downloadFileDto, this.filesMethods.downloadFromUrl.name)
+ }
+
+ @Post(`${FILES_ROUTE.TASK_OPERATION}/${FILE_OPERATION.COMPRESS}/*`)
+ @SkipSpacePermissionsCheck()
+ // Can be used to create or download an archive of files; permissions are checked later
+ async compressAsTask(@Req() req: FastifySpaceRequest, @Body() compressFileDto: CompressFileDto): Promise<FileTask> {
+ if (compressFileDto.compressInDirectory) {
+ await SpaceGuard.checkPermissions(req, this.logger)
+ }
+ return this.filesTasksManager.createTask(FILE_OPERATION.COMPRESS, req.user, req.space, compressFileDto, this.filesMethods.compress.name)
+ }
+
+ @Post(`${FILES_ROUTE.TASK_OPERATION}/${FILE_OPERATION.DECOMPRESS}/*`)
+ async decompressAsTask(@GetUser() user: UserModel, @GetSpace() space: SpaceEnv): Promise<FileTask> {
+ return this.filesTasksManager.createTask(FILE_OPERATION.DECOMPRESS, user, space, null, this.filesMethods.decompress.name)
+ }
+
+ @Copy(`${FILES_ROUTE.TASK_OPERATION}/*`)
+ async copyAsTask(@GetUser() user: UserModel, @GetSpace() space: SpaceEnv, @Body() copyMoveFileDto: CopyMoveFileDto): Promise<FileTask> {
+ return this.filesTasksManager.createTask(FILE_OPERATION.COPY, user, space, copyMoveFileDto, this.filesMethods.copy.name)
+ }
+
+ @Move(`${FILES_ROUTE.TASK_OPERATION}/*`)
+ async moveAsTask(@GetUser() user: UserModel, @GetSpace() space: SpaceEnv, @Body() copyMoveFileDto: CopyMoveFileDto): Promise<FileTask> {
+ return this.filesTasksManager.createTask(FILE_OPERATION.MOVE, user, space, copyMoveFileDto, this.filesMethods.move.name)
+ }
+
+ @Delete(`${FILES_ROUTE.TASK_OPERATION}/*`)
+ async deleteAsTask(@GetUser() user: UserModel, @GetSpace() space: SpaceEnv): Promise<FileTask> {
+ return this.filesTasksManager.createTask(FILE_OPERATION.DELETE, user, space, null, this.filesMethods.delete.name)
+ }
+}
diff --git a/backend/src/applications/files/files.controller.spec.ts b/backend/src/applications/files/files.controller.spec.ts
index 64ada721..8ee31de3 100644
--- a/backend/src/applications/files/files.controller.spec.ts
+++ b/backend/src/applications/files/files.controller.spec.ts
@@ -1,42 +1,15 @@
import { Test, TestingModule } from '@nestjs/testing'
-import { ContextInterceptor } from '../../infrastructure/context/interceptors/context.interceptor'
-import { ContextManager } from '../../infrastructure/context/services/context-manager.service'
import { SpaceGuard } from '../spaces/guards/space.guard'
-import { FILE_OPERATION } from './constants/operations'
import { FilesController } from './files.controller'
+import { FilesContentIndexer } from './services/files-content-indexer.service'
import { FilesFavoritesManager } from './services/files-favorites-manager.service'
-import { FilesMethods } from './services/files-methods.service'
import { FilesRecents } from './services/files-recents.service'
import { FilesSearchManager } from './services/files-search-manager.service'
-import { FilesTasksManager } from './services/tasks/files-tasks-manager.service'
-import { FilesContentIndexer } from './services/files-content-indexer.service'
describe(FilesController.name, () => {
let filesController: FilesController
- // Reusable fakes
const fakeUser: any = { id: 1, login: 'john', role: 1 }
- const fakeSpace: any = { id: 42, key: 'space-key', url: '/space/a', realPath: '/data/space/a', realBasePath: '/data/space' }
- const fakeReq: any = { user: fakeUser, space: fakeSpace, headers: {}, method: 'GET', ip: '127.0.0.1' }
- const fakeRes: any = { header: vi.fn().mockReturnThis(), status: vi.fn().mockReturnThis(), type: vi.fn().mockReturnThis(), send: vi.fn() }
-
- // Mocks
- const filesMethodsMock = {
- headOrGet: vi.fn(),
- make: vi.fn(),
- upload: vi.fn(),
- copy: vi.fn(),
- move: vi.fn(),
- delete: vi.fn(),
- genThumbnail: vi.fn(),
- downloadFromUrl: vi.fn(),
- compress: vi.fn(),
- decompress: vi.fn()
- }
-
- const filesTasksManagerMock = {
- createTask: vi.fn()
- }
const filesRecentsMock = {
getRecents: vi.fn()
@@ -50,17 +23,12 @@ describe(FilesController.name, () => {
const testingModuleBuilder = Test.createTestingModule({
controllers: [FilesController],
providers: [
- { provide: FilesMethods, useValue: filesMethodsMock },
- { provide: FilesTasksManager, useValue: filesTasksManagerMock },
{ provide: FilesRecents, useValue: filesRecentsMock },
{ provide: FilesSearchManager, useValue: filesSearchMock },
- { provide: ContextManager, useValue: filesSearchMock },
{ provide: FilesContentIndexer, useValue: {} },
- { provide: FilesFavoritesManager, useValue: {} },
- ContextInterceptor
+ { provide: FilesFavoritesManager, useValue: {} }
]
})
- // IMPORTANT: override the guard referenced by @UseGuards to avoid resolving its dependencies
testingModuleBuilder.overrideGuard(SpaceGuard).useValue({ canActivate: vi.fn().mockReturnValue(true) })
const module: TestingModule = await testingModuleBuilder.compile()
@@ -72,210 +40,6 @@ describe(FilesController.name, () => {
expect(filesController).toBeDefined()
})
- describe('Operations', () => {
- beforeEach(() => {
- vi.clearAllMocks()
- })
-
- it('head() should delegate to filesMethods.headOrGet(req, res) and return its result', async () => {
- const stream = {} as any
- filesMethodsMock.headOrGet.mockResolvedValue(stream)
-
- const result = await filesController.head(fakeReq, fakeRes)
-
- expect(filesMethodsMock.headOrGet).toHaveBeenCalledWith(fakeReq, fakeRes)
- expect(result).toBe(stream)
- })
-
- it('download() should delegate to filesMethods.headOrGet(req, res) and return its result', async () => {
- const stream = {} as any
- filesMethodsMock.headOrGet.mockResolvedValue(stream)
-
- const result = await filesController.download(fakeReq, fakeRes)
-
- expect(filesMethodsMock.headOrGet).toHaveBeenCalledWith(fakeReq, fakeRes)
- expect(result).toBe(stream)
- })
-
- it('make() should call filesMethods.make(user, space, dto)', async () => {
- const dto = { path: '/a', name: 'b', type: 'directory' } as any
-
- await filesController.make(fakeUser, fakeSpace, dto)
-
- expect(filesMethodsMock.make).toHaveBeenCalledWith(fakeUser, fakeSpace, dto)
- })
-
- it('upload() should call filesMethods.upload(req, res)', async () => {
- await filesController.uploadCreate(fakeReq, fakeRes)
-
- expect(filesMethodsMock.upload).toHaveBeenCalledWith(fakeReq, fakeRes)
- })
-
- it('copy() should call filesMethods.copy(user, space, dto) and return its result', async () => {
- const dto = { dstDirectory: '/dst', dstName: 'b' } as any
- const expected = { path: '/dst', name: 'b' }
- filesMethodsMock.copy.mockResolvedValue(expected)
-
- const result = await filesController.copy(fakeUser, fakeSpace, dto)
-
- expect(filesMethodsMock.copy).toHaveBeenCalledWith(fakeUser, fakeSpace, dto)
- expect(result).toEqual(expected)
- })
-
- it('move() should call filesMethods.move(user, space, dto) and return its result', async () => {
- const dto = { dstDirectory: '/dst', dstName: 'c' } as any
- const expected = { path: '/dst', name: 'c' }
- filesMethodsMock.move.mockResolvedValue(expected)
-
- const result = await filesController.move(fakeUser, fakeSpace, dto)
-
- expect(filesMethodsMock.move).toHaveBeenCalledWith(fakeUser, fakeSpace, dto)
- expect(result).toEqual(expected)
- })
-
- it('delete() should call filesMethods.delete(user, space)', async () => {
- await filesController.delete(fakeUser, fakeSpace)
-
- expect(filesMethodsMock.delete).toHaveBeenCalledWith(fakeUser, fakeSpace)
- })
-
- it('genThumbnail() should default size to 256 when not provided', async () => {
- const stream = {} as any
- filesMethodsMock.genThumbnail.mockResolvedValue(stream)
-
- // pass undefined to exercise controller default parameter
- const result = await filesController.genThumbnail(fakeSpace, undefined as unknown as number, fakeRes)
-
- expect(filesMethodsMock.genThumbnail).toHaveBeenCalledWith(fakeSpace, 256)
- expect(fakeRes.type).toHaveBeenCalled()
- expect(fakeRes.send).toHaveBeenCalledWith(stream)
- expect(result).toBeUndefined()
- })
-
- it('genThumbnail() should pass provided size', async () => {
- const stream = {} as any
- filesMethodsMock.genThumbnail.mockResolvedValue(stream)
-
- const result = await filesController.genThumbnail(fakeSpace, 512, fakeRes)
-
- expect(filesMethodsMock.genThumbnail).toHaveBeenCalledWith(fakeSpace, 512)
- expect(fakeRes.type).toHaveBeenCalled()
- expect(fakeRes.send).toHaveBeenCalledWith(stream)
- expect(result).toBeUndefined()
- })
-
- it('genThumbnail() should reduce size larger than 1024', async () => {
- const stream = {} as any
- filesMethodsMock.genThumbnail.mockResolvedValue(stream)
-
- const result = await filesController.genThumbnail(fakeSpace, 2048, fakeRes)
-
- expect(filesMethodsMock.genThumbnail).toHaveBeenCalledWith(fakeSpace, 1024)
- expect(fakeRes.type).toHaveBeenCalled()
- expect(fakeRes.send).toHaveBeenCalledWith(stream)
- expect(result).toBeUndefined()
- })
- })
-
- describe('Tasks operations', () => {
- beforeEach(() => {
- vi.clearAllMocks()
- })
-
- it('downloadFromUrlAsTask() should create DOWNLOAD task using method name "downloadFromUrl"', async () => {
- const dto = { url: 'http://x', to: '/a' } as any
- const task = { id: 1 } as any
- filesTasksManagerMock.createTask.mockResolvedValue(task)
-
- const result = await filesController.downloadFromUrlAsTask(fakeUser, fakeSpace, dto)
-
- expect(filesTasksManagerMock.createTask).toHaveBeenCalledWith(
- FILE_OPERATION.DOWNLOAD,
- fakeUser,
- fakeSpace,
- dto,
- filesMethodsMock.downloadFromUrl.name
- )
- expect(result).toBe(task)
- })
-
- it('compressAsTask() should call SpaceGuard.checkPermissions when compressInDirectory is true', async () => {
- const dto = { compressInDirectory: true } as any
- const spy = vi.spyOn(SpaceGuard as any, 'checkPermissions').mockImplementation(() => undefined)
-
- filesTasksManagerMock.createTask.mockResolvedValue({} as any)
- await filesController.compressAsTask(fakeReq, dto)
-
- expect(spy).toHaveBeenCalled()
- spy.mockRestore()
- })
-
- it('compressAsTask() should create COMPRESS task with req.user and req.space and method name "compress"', async () => {
- const dto = { compressInDirectory: false } as any
- const task = { id: 2 } as any
- filesTasksManagerMock.createTask.mockResolvedValue(task)
-
- const result = await filesController.compressAsTask(fakeReq, dto)
-
- expect(filesTasksManagerMock.createTask).toHaveBeenCalledWith(
- FILE_OPERATION.COMPRESS,
- fakeReq.user,
- fakeReq.space,
- dto,
- filesMethodsMock.compress.name
- )
- expect(result).toBe(task)
- })
-
- it('decompressAsTask() should create DECOMPRESS task with null dto and method name "decompress"', async () => {
- const task = { id: 3 } as any
- filesTasksManagerMock.createTask.mockResolvedValue(task)
-
- const result = await filesController.decompressAsTask(fakeUser, fakeSpace)
-
- expect(filesTasksManagerMock.createTask).toHaveBeenCalledWith(
- FILE_OPERATION.DECOMPRESS,
- fakeUser,
- fakeSpace,
- null,
- filesMethodsMock.decompress.name
- )
- expect(result).toBe(task)
- })
-
- it('copyAsTask() should create COPY task with method name "copy"', async () => {
- const dto = { from: '/a', to: '/b' } as any
- const task = { id: 4 } as any
- filesTasksManagerMock.createTask.mockResolvedValue(task)
-
- const result = await filesController.copyAsTask(fakeUser, fakeSpace, dto)
-
- expect(filesTasksManagerMock.createTask).toHaveBeenCalledWith(FILE_OPERATION.COPY, fakeUser, fakeSpace, dto, filesMethodsMock.copy.name)
- expect(result).toBe(task)
- })
-
- it('moveAsTask() should create MOVE task with method name "move"', async () => {
- const dto = { from: '/a', to: '/c' } as any
- const task = { id: 5 } as any
- filesTasksManagerMock.createTask.mockResolvedValue(task)
-
- const result = await filesController.moveAsTask(fakeUser, fakeSpace, dto)
-
- expect(filesTasksManagerMock.createTask).toHaveBeenCalledWith(FILE_OPERATION.MOVE, fakeUser, fakeSpace, dto, filesMethodsMock.move.name)
- expect(result).toBe(task)
- })
-
- it('deleteAsTask() should create DELETE task with null dto and method name "delete"', async () => {
- const task = { id: 6 } as any
- filesTasksManagerMock.createTask.mockResolvedValue(task)
-
- const result = await filesController.deleteAsTask(fakeUser, fakeSpace)
-
- expect(filesTasksManagerMock.createTask).toHaveBeenCalledWith(FILE_OPERATION.DELETE, fakeUser, fakeSpace, null, filesMethodsMock.delete.name)
- expect(result).toBe(task)
- })
- })
-
describe('Recents & Search', () => {
beforeEach(() => {
vi.clearAllMocks()
diff --git a/backend/src/applications/files/files.controller.ts b/backend/src/applications/files/files.controller.ts
index 9b9c7711..f1cea9de 100644
--- a/backend/src/applications/files/files.controller.ts
+++ b/backend/src/applications/files/files.controller.ts
@@ -1,198 +1,37 @@
-import {
- Body,
- Controller,
- Copy,
- Delete,
- Get,
- Head,
- Lock,
- Logger,
- Move,
- ParseBoolPipe,
- ParseIntPipe,
- Patch,
- Post,
- Put,
- Query,
- Req,
- Res,
- Search,
- StreamableFile,
- Unlock,
- UseGuards,
- UseInterceptors
-} from '@nestjs/common'
-import { FastifyReply } from 'fastify'
-import { webpMimeType } from '../../common/image'
-import { ContextInterceptor } from '../../infrastructure/context/interceptors/context.interceptor'
-import { SkipSpaceGuard } from '../spaces/decorators/space-skip-guard.decorator'
+import { Body, Controller, Delete, Get, Post, Query, Search, UseGuards } from '@nestjs/common'
import { SkipSpacePermissionsCheck } from '../spaces/decorators/space-skip-permissions.decorator'
import { GetSpace } from '../spaces/decorators/space.decorator'
import { SpaceGuard } from '../spaces/guards/space.guard'
-import { FastifySpaceRequest } from '../spaces/interfaces/space-request.interface'
import { SpaceEnv } from '../spaces/models/space-env.model'
+import { USER_ROLE } from '../users/constants/user'
+import { UserHaveRole } from '../users/decorators/roles.decorator'
import { GetUser } from '../users/decorators/user.decorator'
+import { UserRolesGuard } from '../users/guards/roles.guard'
import { UserModel } from '../users/models/user.model'
-import { FILE_OPERATION, FORCE_AS_FILE_OWNER } from './constants/operations'
import { FILES_ROUTE } from './constants/routes'
-import { CompressFileDto, CopyMoveFileDto, DownloadFileDto, MakeFileDto, SearchFilesDto } from './dto/file-operations.dto'
import { DeleteFileFavoriteDto, FileFavoriteDto } from './dto/file-favorite.dto'
-import { FileLockProps } from './interfaces/file-props.interface'
-import { FileTask } from './models/file-task'
+import { SearchFilesDto } from './dto/file-operations.dto'
+import { IndexingStatus } from './interfaces/indexing.interface'
import { FileContent } from './schemas/file-content.interface'
import type { FileFavorite, FileFavoriteIdentity } from './schemas/file-favorite.interface'
import { FileRecent } from './schemas/file-recent.interface'
-import { FilesMethods } from './services/files-methods.service'
-import { FilesRecents } from './services/files-recents.service'
-import { FilesSearchManager } from './services/files-search-manager.service'
-import { FilesTasksManager } from './services/tasks/files-tasks-manager.service'
import { FilesContentIndexer } from './services/files-content-indexer.service'
import { FilesFavoritesManager } from './services/files-favorites-manager.service'
-import { UserHaveRole } from '../users/decorators/roles.decorator'
-import { USER_ROLE } from '../users/constants/user'
-import { UserRolesGuard } from '../users/guards/roles.guard'
-import { IndexingStatus } from './interfaces/indexing.interface'
-import type { CopyMoveFileResponse } from './interfaces/copy-move-file.interface'
+import { FilesRecents } from './services/files-recents.service'
+import { FilesSearchManager } from './services/files-search-manager.service'
@Controller(FILES_ROUTE.BASE)
-@UseGuards(SpaceGuard)
export class FilesController {
- private readonly logger = new Logger(FilesController.name)
-
constructor(
- private readonly filesMethods: FilesMethods,
- private readonly filesTasksManager: FilesTasksManager,
private readonly filesRecents: FilesRecents,
private readonly filesSearch: FilesSearchManager,
private readonly filesContentIndexer: FilesContentIndexer,
private readonly filesFavoritesManager: FilesFavoritesManager
) {}
- // OPERATIONS
-
- @Head(`${FILES_ROUTE.OPERATION}/*`)
- async head(@Req() req: FastifySpaceRequest, @Res({ passthrough: true }) res: FastifyReply): Promise<StreamableFile> {
- return this.filesMethods.headOrGet(req, res)
- }
-
- @Get(`${FILES_ROUTE.OPERATION}/*`)
- async download(@Req() req: FastifySpaceRequest, @Res({ passthrough: true }) res: FastifyReply): Promise<StreamableFile> {
- return this.filesMethods.headOrGet(req, res)
- }
-
- @Post(`${FILES_ROUTE.OPERATION}/${FILE_OPERATION.MAKE}/*`)
- async make(@GetUser() user: UserModel, @GetSpace() space: SpaceEnv, @Body() makeFileDto: MakeFileDto): Promise<void> {
- return this.filesMethods.make(user, space, makeFileDto)
- }
-
- @Post(`${FILES_ROUTE.OPERATION}/${FILE_OPERATION.UPLOAD}/*`)
- async uploadCreate(@Req() req: FastifySpaceRequest, @Res({ passthrough: true }) res: FastifyReply): Promise<void> {
- return this.filesMethods.upload(req, res)
- }
-
- @Put(`${FILES_ROUTE.OPERATION}/${FILE_OPERATION.UPLOAD}/*`)
- async uploadOverwrite(@Req() req: FastifySpaceRequest, @Res({ passthrough: true }) res: FastifyReply): Promise<void> {
- return this.filesMethods.upload(req, res)
- }
-
- @Patch(`${FILES_ROUTE.OPERATION}/${FILE_OPERATION.UPLOAD}/*`)
- async uploadContent(@Req() req: FastifySpaceRequest, @Res({ passthrough: true }) res: FastifyReply): Promise<void> {
- return this.filesMethods.upload(req, res)
- }
-
- @Copy(`${FILES_ROUTE.OPERATION}/*`)
- async copy(@GetUser() user: UserModel, @GetSpace() space: SpaceEnv, @Body() copyMoveFileDto: CopyMoveFileDto): Promise<CopyMoveFileResponse> {
- return this.filesMethods.copy(user, space, copyMoveFileDto)
- }
-
- @Move(`${FILES_ROUTE.OPERATION}/*`)
- async move(@GetUser() user: UserModel, @GetSpace() space: SpaceEnv, @Body() copyMoveFileDto: CopyMoveFileDto): Promise<CopyMoveFileResponse> {
- return this.filesMethods.move(user, space, copyMoveFileDto)
- }
-
- @Delete(`${FILES_ROUTE.OPERATION}/*`)
- async delete(@GetUser() user: UserModel, @GetSpace() space: SpaceEnv): Promise<void> {
- return this.filesMethods.delete(user, space)
- }
-
- @Get(`${FILES_ROUTE.OPERATION}/${FILE_OPERATION.THUMBNAIL}/*`)
- async genThumbnail(
- @GetSpace() space: SpaceEnv,
- @Query('size', new ParseIntPipe({ optional: true })) size = 256,
- @Res() res: FastifyReply
- ): Promise<StreamableFile> {
- if (size > 1024) size = 1024
- const thumb = await this.filesMethods.genThumbnail(space, size)
- res.type(webpMimeType)
- return res.send(thumb)
- }
-
- @Lock(`${FILES_ROUTE.OPERATION}/*`)
- async lock(@GetUser() user: UserModel, @GetSpace() space: SpaceEnv): Promise<FileLockProps> {
- return this.filesMethods.lock(user, space)
- }
-
- @Unlock(`${FILES_ROUTE.OPERATION}/*`)
- async unlock(
- @GetUser() user: UserModel,
- @GetSpace() space: SpaceEnv,
- @Query(FORCE_AS_FILE_OWNER, new ParseBoolPipe({ optional: true })) forceAsFileOwner?: boolean
- ): Promise<void> {
- return this.filesMethods.unlock(user, space, forceAsFileOwner)
- }
-
- @Unlock(`${FILES_ROUTE.OPERATION}/${FILE_OPERATION.UNLOCK_REQUEST}/*`)
- @UseInterceptors(ContextInterceptor)
- async unlockRequest(@GetUser() user: UserModel, @GetSpace() space: SpaceEnv): Promise<void> {
- return this.filesMethods.unlockRequest(user, space)
- }
-
- @Get(`${FILES_ROUTE.OPERATION}/${FILE_OPERATION.GET_SIZE}/*`)
- async getSize(@GetSpace() space: SpaceEnv): Promise<{ size: number }> {
- return this.filesMethods.getSize(space)
- }
-
- // TASKS OPERATIONS
-
- @Post(`${FILES_ROUTE.TASK_OPERATION}/${FILE_OPERATION.DOWNLOAD}/*`)
- async downloadFromUrlAsTask(@GetUser() user: UserModel, @GetSpace() space: SpaceEnv, @Body() downloadFileDto: DownloadFileDto): Promise<FileTask> {
- return this.filesTasksManager.createTask(FILE_OPERATION.DOWNLOAD, user, space, downloadFileDto, this.filesMethods.downloadFromUrl.name)
- }
-
- @Post(`${FILES_ROUTE.TASK_OPERATION}/${FILE_OPERATION.COMPRESS}/*`)
- @SkipSpacePermissionsCheck()
- // Can be used to create or download an archive of files; permissions are checked later
- async compressAsTask(@Req() req: FastifySpaceRequest, @Body() compressFileDto: CompressFileDto): Promise<FileTask> {
- if (compressFileDto.compressInDirectory) {
- await SpaceGuard.checkPermissions(req, this.logger)
- }
- return this.filesTasksManager.createTask(FILE_OPERATION.COMPRESS, req.user, req.space, compressFileDto, this.filesMethods.compress.name)
- }
-
- @Post(`${FILES_ROUTE.TASK_OPERATION}/${FILE_OPERATION.DECOMPRESS}/*`)
- async decompressAsTask(@GetUser() user: UserModel, @GetSpace() space: SpaceEnv): Promise<FileTask> {
- return this.filesTasksManager.createTask(FILE_OPERATION.DECOMPRESS, user, space, null, this.filesMethods.decompress.name)
- }
-
- @Copy(`${FILES_ROUTE.TASK_OPERATION}/*`)
- async copyAsTask(@GetUser() user: UserModel, @GetSpace() space: SpaceEnv, @Body() copyMoveFileDto: CopyMoveFileDto): Promise<FileTask> {
- return this.filesTasksManager.createTask(FILE_OPERATION.COPY, user, space, copyMoveFileDto, this.filesMethods.copy.name)
- }
-
- @Move(`${FILES_ROUTE.TASK_OPERATION}/*`)
- async moveAsTask(@GetUser() user: UserModel, @GetSpace() space: SpaceEnv, @Body() copyMoveFileDto: CopyMoveFileDto): Promise<FileTask> {
- return this.filesTasksManager.createTask(FILE_OPERATION.MOVE, user, space, copyMoveFileDto, this.filesMethods.move.name)
- }
-
- @Delete(`${FILES_ROUTE.TASK_OPERATION}/*`)
- async deleteAsTask(@GetUser() user: UserModel, @GetSpace() space: SpaceEnv): Promise<FileTask> {
- return this.filesTasksManager.createTask(FILE_OPERATION.DELETE, user, space, null, this.filesMethods.delete.name)
- }
-
// FAVORITES
@Get(FILES_ROUTE.FAVORITES)
- @SkipSpaceGuard()
@UserHaveRole(USER_ROLE.GUEST)
@UseGuards(UserRolesGuard)
getFavorites(@GetUser() user: UserModel): Promise<FileFavorite[]> {
@@ -203,13 +42,12 @@ export class FilesController {
// only writes user metadata; SpaceGuard still resolves and validates access to the requested location.
@SkipSpacePermissionsCheck()
@UserHaveRole(USER_ROLE.GUEST)
- @UseGuards(UserRolesGuard)
+ @UseGuards(SpaceGuard, UserRolesGuard)
addFavorite(@GetUser() user: UserModel, @GetSpace() space: SpaceEnv, @Body() favoriteDto: FileFavoriteDto): Promise<FileFavoriteIdentity> {
return this.filesFavoritesManager.addFavorite(user, space, favoriteDto.fileId)
}
@Delete(FILES_ROUTE.FAVORITES)
- @SkipSpaceGuard()
@UserHaveRole(USER_ROLE.GUEST)
@UseGuards(UserRolesGuard)
removeFavorite(@GetUser() user: UserModel, @Body() favoriteDto: DeleteFileFavoriteDto): Promise<void> {
@@ -219,7 +57,6 @@ export class FilesController {
// RECENT FILES
@Get(FILES_ROUTE.RECENTS)
- @SkipSpaceGuard()
getRecents(@GetUser() user: UserModel, @Query('limit') limit: number = 10): Promise<FileRecent[]> {
return this.filesRecents.getRecents(user, limit)
}
@@ -227,7 +64,6 @@ export class FilesController {
// SEARCH FILES
@Search(FILES_ROUTE.SEARCH)
- @SkipSpaceGuard()
search(@GetUser() user: UserModel, @Body() search: SearchFilesDto): Promise<FileContent[]> {
return this.filesSearch.search(user, search)
}
@@ -235,7 +71,6 @@ export class FilesController {
// CONTENT INDEXING (requires ADMIN role)
@Get(FILES_ROUTE.INDEXING)
- @SkipSpaceGuard()
@UserHaveRole(USER_ROLE.ADMINISTRATOR)
@UseGuards(UserRolesGuard)
status(): Promise<IndexingStatus> {
@@ -243,7 +78,6 @@ export class FilesController {
}
@Post(`${FILES_ROUTE.INDEXING}/${FILES_ROUTE.INDEXING_START}`)
- @SkipSpaceGuard()
@UserHaveRole(USER_ROLE.ADMINISTRATOR)
@UseGuards(UserRolesGuard)
startIndexing(): Promise<boolean> {
@@ -251,7 +85,6 @@ export class FilesController {
}
@Post(`${FILES_ROUTE.INDEXING}/${FILES_ROUTE.INDEXING_STOP}`)
- @SkipSpaceGuard()
@UserHaveRole(USER_ROLE.ADMINISTRATOR)
@UseGuards(UserRolesGuard)
stopIndexing(): Promise<boolean> {
@@ -259,7 +92,6 @@ export class FilesController {
}
@Delete(FILES_ROUTE.INDEXING)
- @SkipSpaceGuard()
@UserHaveRole(USER_ROLE.ADMINISTRATOR)
@UseGuards(UserRolesGuard)
dropIndexes(): Promise<void> {
diff --git a/backend/src/applications/files/files.module.ts b/backend/src/applications/files/files.module.ts
index 87e23cea..3ae38bd1 100644
--- a/backend/src/applications/files/files.module.ts
+++ b/backend/src/applications/files/files.module.ts
@@ -1,6 +1,7 @@
import { Module } from '@nestjs/common'
import { configuration } from '../../configuration/config.environment'
import { FilesContentStoreMySQL } from './adapters/files-content-store-mysql.service'
+import { FilesOperationsController } from './files-operations.controller'
import { FilesTasksController } from './files-tasks.controller'
import { FilesController } from './files.controller'
import { FilesContentStore } from './models/files-content-store'
@@ -32,7 +33,7 @@ import { FilesFavoritesQueries } from './services/files-favorites-queries.servic
: []),
...(configuration.applications.files.editors.collabora.enabled ? [CollaboraOnlineModule] : [])
],
- controllers: [FilesController, FilesTasksController],
+ controllers: [FilesOperationsController, FilesController, FilesTasksController],
providers: [
FilesMethods,
FilesManager,