Merge branch 'main' into BC-4374-submission-due-date

apps/server/src/console/console.module.ts

@@ -8,6 +8,7 @@ import { ConsoleWriterModule } from '@shared/infra/console/console-writer/consol
 import { KeycloakModule } from '@shared/infra/identity-management/keycloak/keycloak.module';
 import { DB_PASSWORD, DB_URL, DB_USERNAME, createConfigModuleOptions } from '@src/config';
 import { FilesModule } from '@src/modules/files';
+import { FileEntity } from '@src/modules/files/entity';
 import { FileRecord } from '@src/modules/files-storage/entity';
 import { ManagementModule } from '@src/modules/management/management.module';
 import { serverConfig } from '@src/modules/server';
@@ -28,7 +29,7 @@ import { ServerConsole } from './server.console';
 			clientUrl: DB_URL,
 			password: DB_PASSWORD,
 			user: DB_USERNAME,
-			entities: [...ALL_ENTITIES, FileRecord],
+			entities: [...ALL_ENTITIES, FileEntity, FileRecord],
 			allowGlobalContext: true,
 			findOneOrFailHandler: (entityName: string, where: Dictionary | IPrimaryKey) =>
 				new NotFoundException(`The requested ${entityName}: ${JSON.stringify(where)} has not been found.`),

apps/server/src/modules/files-storage-client/service/copy-files.service.spec.ts

@@ -1,7 +1,13 @@
 import { createMock, DeepMocked } from '@golevelup/ts-jest';
 import { Test, TestingModule } from '@nestjs/testing';
 import { ComponentType, IComponentProperties } from '@shared/domain';
-import { courseFactory, fileFactory, lessonFactory, schoolFactory, setupEntities } from '@shared/testing';
+import {
+	courseFactory,
+	lessonFactory,
+	schoolFactory,
+	legacyFileEntityMockFactory,
+	setupEntities,
+} from '@shared/testing';
 import { CopyElementType, CopyHelperService } from '@src/modules/copy-helper';
 import { CopyFilesService } from './copy-files.service';
 import { FilesStorageClientAdapterService } from './files-storage-client.service';
@@ -52,16 +58,16 @@ describe('copy files service', () => {
 	describe('copy files of entity', () => {
 		const setup = () => {
 			const school = schoolFactory.build();
-			const file1 = fileFactory.buildWithId({ name: 'file.jpg' });
-			const file2 = fileFactory.buildWithId({ name: 'file.jpg' });
+			const file1 = legacyFileEntityMockFactory.build();
+			const file2 = legacyFileEntityMockFactory.build();
 			const imageHTML1 = getImageHTML(file1.id, file1.name);
 			const imageHTML2 = getImageHTML(file2.id, file2.name);
-			return { file1, file2, school, imageHTML1, imageHTML2 };
+			return { school, imageHTML1, imageHTML2 };
 		};
 
 		describe('copy files of lesson', () => {
 			const lessonSetup = () => {
-				const { file1, file2, school, imageHTML1, imageHTML2 } = setup();
+				const { school, imageHTML1, imageHTML2 } = setup();
 				const originalCourse = courseFactory.build({ school });
 				const textContent: IComponentProperties = {
 					title: '',
@@ -86,7 +92,7 @@ describe('copy files service', () => {
 				const mockedFileDto = { id: 'mockedFileId', sourceId: 'mockedSourceId', name: 'mockedName' };
 
 				filesStorageClientAdapterService.copyFilesOfParent.mockResolvedValue([mockedFileDto]);
-				return { originalLesson, copyLesson, file1, file2, schoolId: school.id, userId, mockedFileDto };
+				return { originalLesson, copyLesson, schoolId: school.id, userId, mockedFileDto };
 			};
 
 			it('should return fileUrlReplacements', async () => {

apps/server/src/modules/files-storage/entity/filerecord.entity.spec.ts

@@ -6,7 +6,7 @@ import { PreviewInputMimeTypes } from '../interface';
 import {
 	FileRecord,
 	FileRecordParentType,
-	FileSecurityCheck,
+	FileRecordSecurityCheck,
 	IFileRecordProperties,
 	PreviewStatus,
 	ScanStatus,
@@ -95,21 +95,21 @@ describe('FileRecord Entity', () => {
 		});
 	});
 
-	describe('FileSecurityCheck', () => {
+	describe('FileRecordSecurityCheck', () => {
 		it('should set the requestToken via the constructor', () => {
-			const securityCheck = new FileSecurityCheck({ requestToken: '08154711' });
+			const securityCheck = new FileRecordSecurityCheck({ requestToken: '08154711' });
 			expect(securityCheck.requestToken).toEqual('08154711');
 			expect(securityCheck.status).toEqual(securityCheck.status);
 			expect(securityCheck.reason).toEqual(securityCheck.reason);
 		});
 		it('should set the status via the constructor', () => {
-			const securityCheck = new FileSecurityCheck({ status: ScanStatus.PENDING });
+			const securityCheck = new FileRecordSecurityCheck({ status: ScanStatus.PENDING });
 			expect(securityCheck.status).toEqual(ScanStatus.PENDING);
 			expect(securityCheck.requestToken).toEqual(securityCheck.requestToken);
 			expect(securityCheck.reason).toEqual(securityCheck.reason);
 		});
 		it('should set the reason via the constructor', () => {
-			const securityCheck = new FileSecurityCheck({ reason: 'test-reason' });
+			const securityCheck = new FileRecordSecurityCheck({ reason: 'test-reason' });
 			expect(securityCheck.reason).toEqual('test-reason');
 			expect(securityCheck.status).toEqual(securityCheck.status);
 			expect(securityCheck.requestToken).toEqual(securityCheck.requestToken);

apps/server/src/modules/files-storage/entity/filerecord.entity.ts

@@ -1,7 +1,7 @@
 import { Embeddable, Embedded, Entity, Enum, Index, Property } from '@mikro-orm/core';
 import { ObjectId } from '@mikro-orm/mongodb';
 import { BadRequestException } from '@nestjs/common';
-import { BaseEntityWithTimestamps, type EntityId } from '@shared/domain';
+import { BaseEntityWithTimestamps, EntityId } from '@shared/domain';
 import { v4 as uuid } from 'uuid';
 import { ErrorType } from '../error';
 import { PreviewInputMimeTypes } from '../interface/preview-input-mime-types.enum';
@@ -33,13 +33,13 @@ export enum PreviewStatus {
 	PREVIEW_NOT_POSSIBLE_WRONG_MIME_TYPE = 'preview_not_possible_wrong_mime_type',
 }
 
-export interface IFileSecurityCheckProperties {
+export interface IFileRecordSecurityCheckProperties {
 	status?: ScanStatus;
 	reason?: string;
 	requestToken?: string;
 }
 @Embeddable()
-export class FileSecurityCheck {
+export class FileRecordSecurityCheck {
 	@Enum()
 	status: ScanStatus = ScanStatus.PENDING;
 
@@ -55,7 +55,7 @@ export class FileSecurityCheck {
 	@Property()
 	updatedAt = new Date();
 
-	constructor(props: IFileSecurityCheckProperties) {
+	constructor(props: IFileRecordSecurityCheckProperties) {
 		if (props.status !== undefined) {
 			this.status = props.status;
 		}
@@ -111,8 +111,8 @@ export class FileRecord extends BaseEntityWithTimestamps {
 	@Property()
 	mimeType: string; // TODO mime-type enum?
 
-	@Embedded(() => FileSecurityCheck, { object: true, nullable: false })
-	securityCheck: FileSecurityCheck;
+	@Embedded(() => FileRecordSecurityCheck, { object: true, nullable: false })
+	securityCheck: FileRecordSecurityCheck;
 
 	@Index()
 	@Enum()
@@ -161,7 +161,7 @@ export class FileRecord extends BaseEntityWithTimestamps {
 		if (props.isCopyFrom) {
 			this._isCopyFrom = new ObjectId(props.isCopyFrom);
 		}
-		this.securityCheck = new FileSecurityCheck({});
+		this.securityCheck = new FileRecordSecurityCheck({});
 		this.deletedSince = props.deletedSince;
 	}
 

apps/server/src/modules/files-storage/files-storage.module.ts

@@ -9,7 +9,7 @@ import { RabbitMQWrapperModule } from '@shared/infra/rabbitmq/rabbitmq.module';
 import { S3ClientModule } from '@shared/infra/s3-client';
 import { DB_PASSWORD, DB_URL, DB_USERNAME, createConfigModuleOptions } from '@src/config';
 import { LoggerModule } from '@src/core/logger';
-import { FileRecord, FileSecurityCheck } from './entity';
+import { FileRecord, FileRecordSecurityCheck } from './entity';
 import { config, s3Config } from './files-storage.config';
 import { FileRecordRepo } from './repo';
 import { FilesStorageService } from './service/files-storage.service';
@@ -45,7 +45,7 @@ const defaultMikroOrmOptions: MikroOrmModuleSyncOptions = {
 			clientUrl: DB_URL,
 			password: DB_PASSWORD,
 			user: DB_USERNAME,
-			entities: [...ALL_ENTITIES, FileRecord, FileSecurityCheck],
+			entities: [...ALL_ENTITIES, FileRecord, FileRecordSecurityCheck],
 
 			// debug: true, // use it for locally debugging of querys
 		}),

apps/server/src/modules/files/domain/index.ts

@@ -0,0 +1 @@
+export * from './types';

apps/server/src/modules/files/domain/types/file-owner-model.enum.ts

@@ -0,0 +1,5 @@
+export const enum FileOwnerModel {
+	USER = 'user',
+	COURSE = 'course',
+	TEAMS = 'teams',
+}

apps/server/src/modules/files/domain/types/file-permission-reference-model.enum.ts

@@ -0,0 +1,4 @@
+export const enum FilePermissionReferenceModel {
+	USER = 'user',
+	ROLE = 'role',
+}

apps/server/src/modules/files/domain/types/file-security-check-status.enum.ts

@@ -0,0 +1,6 @@
+export const enum FileSecurityCheckStatus {
+	PENDING = 'pending',
+	VERIFIED = 'verified',
+	BLOCKED = 'blocked',
+	WONT_CHECK = 'wont-check',
+}

apps/server/src/modules/files/domain/types/index.ts

@@ -0,0 +1,3 @@
+export * from './file-security-check-status.enum';
+export * from './file-permission-reference-model.enum';
+export * from './file-owner-model.enum';

apps/server/src/modules/files/entity/file-permission.entity.spec.ts

@@ -0,0 +1,62 @@
+import { ObjectId } from '@mikro-orm/mongodb';
+import { FilePermissionReferenceModel } from '../domain';
+import { FilePermissionEntity } from './file-permission.entity';
+
+describe(FilePermissionEntity.name, () => {
+	describe('constructor', () => {
+		const setup = () => {
+			const refId = new ObjectId();
+			const refPermModel = FilePermissionReferenceModel.USER;
+
+			return { refId, refPermModel };
+		};
+
+		describe('when passed a minimal valid props object', () => {
+			it(`should return a valid ${FilePermissionEntity.name} object with proper default fields values and with the values taken from the passed props object`, () => {
+				const { refId, refPermModel } = setup();
+
+				const entity = new FilePermissionEntity({
+					refId: refId.toHexString(),
+					refPermModel,
+				});
+
+				expect(entity).toEqual(
+					expect.objectContaining({
+						refId,
+						refPermModel,
+						write: true,
+						read: true,
+						create: true,
+						delete: true,
+					})
+				);
+			});
+		});
+
+		describe('when passed a complete (fully filled) props object', () => {
+			it(`should return a valid ${FilePermissionEntity.name} object with proper fields values taken from the passed props object`, () => {
+				const { refId, refPermModel } = setup();
+
+				const entity = new FilePermissionEntity({
+					refId: refId.toHexString(),
+					refPermModel,
+					write: false,
+					read: false,
+					create: false,
+					delete: false,
+				});
+
+				expect(entity).toEqual(
+					expect.objectContaining({
+						refId,
+						refPermModel,
+						write: false,
+						read: false,
+						create: false,
+						delete: false,
+					})
+				);
+			});
+		});
+	});
+});

apps/server/src/modules/files/entity/file-permission.entity.ts

@@ -0,0 +1,55 @@
+import { Embeddable, Enum, Property } from '@mikro-orm/core';
+import { ObjectId } from '@mikro-orm/mongodb';
+import { EntityId } from '@shared/domain';
+import { FilePermissionReferenceModel } from '../domain';
+
+export interface FilePermissionEntityProps {
+	refId: EntityId;
+	refPermModel: FilePermissionReferenceModel;
+	write?: boolean;
+	read?: boolean;
+	create?: boolean;
+	delete?: boolean;
+}
+
+@Embeddable()
+export class FilePermissionEntity {
+	@Property({ nullable: false })
+	refId: ObjectId;
+
+	@Enum({ nullable: false })
+	refPermModel: FilePermissionReferenceModel;
+
+	@Property()
+	write = true;
+
+	@Property()
+	read = true;
+
+	@Property()
+	create = true;
+
+	@Property()
+	delete = true;
+
+	constructor(props: FilePermissionEntityProps) {
+		this.refId = new ObjectId(props.refId);
+		this.refPermModel = props.refPermModel;
+
+		if (props.write !== undefined) {
+			this.write = props.write;
+		}
+
+		if (props.read !== undefined) {
+			this.read = props.read;
+		}
+
+		if (props.create !== undefined) {
+			this.create = props.create;
+		}
+
+		if (props.delete !== undefined) {
+			this.delete = props.delete;
+		}
+	}
+}

apps/server/src/modules/files/entity/file-security-check.entity.spec.ts

@@ -0,0 +1,61 @@
+import { validate as validateUUID } from 'uuid';
+import { FileSecurityCheckStatus } from '../domain';
+import { FileSecurityCheckEntity } from './file-security-check.entity';
+
+describe(FileSecurityCheckEntity.name, () => {
+	describe('constructor', () => {
+		const verifyTimestamps = (entity: FileSecurityCheckEntity) => {
+			const currentTime = new Date().getTime();
+
+			const createdAtTime = entity.createdAt.getTime();
+
+			expect(createdAtTime).toBeGreaterThan(0);
+			expect(createdAtTime).toBeLessThanOrEqual(currentTime);
+
+			const updatedAtTime = entity.updatedAt.getTime();
+
+			expect(updatedAtTime).toBeGreaterThan(0);
+			expect(updatedAtTime).toBeLessThanOrEqual(currentTime);
+		};
+
+		describe('when passed an empty props object', () => {
+			it(`should return a valid ${FileSecurityCheckEntity.name} object with proper default fields values`, () => {
+				const entity = new FileSecurityCheckEntity({});
+
+				verifyTimestamps(entity);
+				expect(entity).toEqual(
+					expect.objectContaining({
+						status: FileSecurityCheckStatus.PENDING,
+						reason: 'not yet scanned',
+					})
+				);
+				expect(entity.requestToken).toBeDefined();
+				expect(entity.requestToken?.length).toBeGreaterThan(0);
+				expect(validateUUID(entity.requestToken as string)).toEqual(true);
+			});
+		});
+
+		describe('when passed a complete (fully filled) props object', () => {
+			it(`should return a valid ${FileSecurityCheckEntity.name} object with fields values taken from the passed props object`, () => {
+				const status = FileSecurityCheckStatus.VERIFIED;
+				const reason = 'AV scanning done';
+				const requestToken = 'b9ebf8d9-6029-4d6c-bd93-4cace483df3c';
+
+				const entity = new FileSecurityCheckEntity({
+					status,
+					reason,
+					requestToken,
+				});
+
+				verifyTimestamps(entity);
+				expect(entity).toEqual(
+					expect.objectContaining({
+						status,
+						reason,
+					})
+				);
+				expect(entity.requestToken).toEqual(requestToken);
+			});
+		});
+	});
+});