-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
* move files repo to a dedicated files module * add barrel file for the files deletion console job * remove unused factory function * add ownerId and refOwnerModel (required) fields to the file model in new (NestJS-based) server part * add more File model fields from the legacy model * add parent field in the new Field model * reorder some fields in the new file model * remove some unused imports, rename file properties interface to match current code style guide * add share tokens to the file props * reorder some fields * add lockId field to the new File entity * add embedded security check object * modify some File entity fields to not trigger unnecessary entities loading on the ORM * add model for the files permission * add method for finding all the files with given permissionRefId * add method to find all files by owner userId, refactor findByPermissionRefId to properly return entities mapped from the raw documents * add File entity method that removes permissions with given refId from the entity object * add file entity method that marks file for deletion * add file entity method that verify if file is already marked for deletion * add test cases for saving the file entity after removing some file permissions or marking the file as deleted * rename File entity class to FileEntity to make it compliant with the current convention * rename storage provider entity class to StorgeProviderEntity * rename file security check entity class * rename some classes * add complete domain layer for the files module * replace use of the files-related enums located in the shared entities module before with the new enums defined in the files module domain layer * add getProps method for all the new domain objects of the files module * add mappers for all the domain objects * rename entity key * remove unused user file factory reference * remove unnecessary use of the user file factory as the FileEntity is not really needed there * remove unnecessary use of the user file factory * reorganize some code, move the user file factory to the files repo as its only used there now * remove file factory export as it was moved inside of the files module * rename file record security check to avoid naming collision, move the file entities to the files module * add required injections for the FileEntity (as it was moved from the ALL_ENTITIES), split the files-related entities to a separate files * add complete unit tests for the files-related entities * modify one comment * fix imports order * modify a few imports * move user file factory to a separate submodule * add files service with the markFilesOwnedByUserForDeletion() method * add more unit tests for the markFilesOwnedByUserForDeletion() method * fix one import * replace filter with forEach * add method to remove user permissions to any files with just a single test case as for now * rename filesRepo var to just repo * add more unit tests for the removeUserPermissionsToAnyFiles() method * add files use case with the user data deletion method * modify method to copy file entity in unit tests to make it more generic * replace explicit file entity constructor calls with the file factory calls (wherever possible) * rollback not currently used code to not make the PR too big * replace plain string class name with the callback type * add unit test for creating directory with the complete props object * rollback adding new UC for the files module as it is not yet used and it'll be added in the other ticket once all the authorization-level requirements will be defined * fix some imports * move all consts definition to the top of the test suite * remove all the empty lines in the files module files imports * rename userFileFactory to fileEntityFactory * replace explicit file entity constructor calls with the factory calls * fix imports * change name of the file that contains the FileEntity factory * replace all the FilesPermissionEntity constructor calls with the new factory calls * fix DeleteFilesUC unit tests * change the way of describing unit tests for the file-security-check.entity.spec.ts file * add local factory for the legacy file mock * move the legacy file entity mock factory to the @shared/testing module as it's also needed in the task copy service unit tests * change DeleteFilesUC to DeleteFilesUc to keep it consistent with the majority of the modules in the project * remove some unnecessary setup function calls * move consts inside of the setup function, add some internal setup functions (rest of the "global" setup function calls will also be moved into the specific "describe" blocks) * move setup functions inside of the respective describe blocks * reformat some of the unit tests * modify the way the other files in the files.repo.spec.ts are described and organized * reformat file-permission.entity.spec.ts file unit tests * reformat file.entity.spec.ts file unit tests * remove unused import * fix exports from the shared testing factory submodule index.ts file * remove redeclared var * remove unused var
- Loading branch information
Showing
53 changed files
with
1,702 additions
and
320 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| export * from './types'; |
5 changes: 5 additions & 0 deletions
5
apps/server/src/modules/files/domain/types/file-owner-model.enum.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| export const enum FileOwnerModel { | ||
| USER = 'user', | ||
| COURSE = 'course', | ||
| TEAMS = 'teams', | ||
| } |
4 changes: 4 additions & 0 deletions
4
apps/server/src/modules/files/domain/types/file-permission-reference-model.enum.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| export const enum FilePermissionReferenceModel { | ||
| USER = 'user', | ||
| ROLE = 'role', | ||
| } |
6 changes: 6 additions & 0 deletions
6
apps/server/src/modules/files/domain/types/file-security-check-status.enum.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| export const enum FileSecurityCheckStatus { | ||
| PENDING = 'pending', | ||
| VERIFIED = 'verified', | ||
| BLOCKED = 'blocked', | ||
| WONT_CHECK = 'wont-check', | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| export * from './file-security-check-status.enum'; | ||
| export * from './file-permission-reference-model.enum'; | ||
| export * from './file-owner-model.enum'; |
62 changes: 62 additions & 0 deletions
62
apps/server/src/modules/files/entity/file-permission.entity.spec.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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, | ||
| }) | ||
| ); | ||
| }); | ||
| }); | ||
| }); | ||
| }); |
55 changes: 55 additions & 0 deletions
55
apps/server/src/modules/files/entity/file-permission.entity.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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; | ||
| } | ||
| } | ||
| } |
61 changes: 61 additions & 0 deletions
61
apps/server/src/modules/files/entity/file-security-check.entity.spec.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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); | ||
| }); | ||
| }); | ||
| }); | ||
| }); |
Oops, something went wrong.