diff --git a/backend/package.json b/backend/package.json index 5ab21ba4..8707c867 100644 --- a/backend/package.json +++ b/backend/package.json @@ -103,6 +103,7 @@ "**/*.(t|j)s" ], "coverageDirectory": "../coverage", - "testEnvironment": "node" + "testEnvironment": "node", + "testTimeout": 30000 } } diff --git a/backend/src/app.module.ts b/backend/src/app.module.ts index 9669ee9e..358b9e0f 100644 --- a/backend/src/app.module.ts +++ b/backend/src/app.module.ts @@ -28,6 +28,13 @@ import { TextractService } from './textract/textract.service'; import { ResetPasswordModule } from './reset_password/reset_password.module'; import { ResetPasswordRequest } from './reset_password/entities/reset_password_request.entity'; import { MailService } from './mail/mail.service'; +import { DiffsService } from './diffs/diffs.service'; +import { SnapshotService } from './snapshots/snapshots.service'; +import { Diff } from './diffs/entities/diffs.entity'; +import { Snapshot } from './snapshots/entities/snapshots.entity'; +import { VersionControlModule } from './version_control/version_control.module'; +import { VersionControlService } from './version_control/version_control.service'; +import { VersionControlController } from './version_control/version_control.controller'; @Module({ imports: [ @@ -41,17 +48,21 @@ import { MailService } from './mail/mail.service'; TypeOrmModule.forFeature([ ResetPasswordRequest, ]), + TypeOrmModule.forFeature([Diff]), + TypeOrmModule.forFeature([Snapshot]), MarkdownFilesModule, FoldersModule, S3Module, FileManagerModule, AssetManagerModule, + VersionControlModule, ResetPasswordModule, ], controllers: [ AuthController, S3Controller, FileManagerController, + VersionControlController ], providers: [ FileManagerService, @@ -62,6 +73,9 @@ import { MailService } from './mail/mail.service'; ConversionService, TextractService, MailService, + DiffsService, + SnapshotService, + VersionControlService, ], }) export class AppModule {} diff --git a/backend/src/diffs/diffs.service.ts b/backend/src/diffs/diffs.service.ts index b6ccc3a5..dadc1264 100644 --- a/backend/src/diffs/diffs.service.ts +++ b/backend/src/diffs/diffs.service.ts @@ -1,7 +1,11 @@ -import { Injectable } from "@nestjs/common"; -import { InjectRepository } from "@nestjs/typeorm"; -import { Repository } from "typeorm"; -import { Diff } from "./entities/diffs.entity"; +import { Injectable } from '@nestjs/common'; +import { InjectRepository } from '@nestjs/typeorm'; +import { Repository } from 'typeorm'; +import { Diff } from './entities/diffs.entity'; +import 'dotenv/config'; +import * as CryptoJS from 'crypto-js'; +import { MarkdownFileDTO } from '../markdown_files/dto/markdown_file.dto'; +import { DiffDTO } from './dto/diffs.dto'; @Injectable() export class DiffsService { @@ -9,4 +13,160 @@ export class DiffsService { @InjectRepository(Diff) private diffRepository: Repository, ) {} + + ///===----------------------------------------------------- + + async getDiff( + diffDTO: DiffDTO, + nextDiffID: number, + ) { + const diff = + await this.diffRepository.findOne({ + where: { + MarkdownID: diffDTO.MarkdownID, + S3DiffID: nextDiffID, + }, + }); + + return diff; + } + + ///===----------------------------------------------------- + + async updateDiff( + diffDTO: DiffDTO, + nextDiffID: number, + ) { + // const diff = + // await this.diffRepository.findOne({ + // where: { + // MarkdownID: diffDTO.MarkdownID, + // S3DiffID: nextDiffID, + // }, + // }); + + const diff = await this.getDiff( + diffDTO, + nextDiffID, + ); + + diff.LastModified = new Date(); + diff.HasBeenUsed = true; + await this.diffRepository.save(diff); + } + + ///===----------------------------------------------------- + + async createDiffs( + markdownFileDTO: MarkdownFileDTO, + snapshotIDs: string[], + ) { + const diffRecords = []; + let snapshotIndex = 0; + for ( + let i = 0; + i < parseInt(process.env.MAX_DIFFS); + i++ + ) { + const diffID = CryptoJS.SHA256( + markdownFileDTO.UserID.toString() + + new Date().getTime().toString() + + i.toString(), + ).toString(); + + if ( + i % + parseInt( + process.env.DIFFS_PER_SNAPSHOT, + ) === + 0 && + i !== 0 + ) { + snapshotIndex++; + } + + diffRecords.push({ + DiffID: diffID, + MarkdownID: markdownFileDTO.MarkdownID, + UserID: markdownFileDTO.UserID, + S3DiffID: i, + HasBeenUsed: false, + SnapshotID: snapshotIDs[snapshotIndex], + }); + } + await this.diffRepository.insert(diffRecords); + } + + ///===----------------------------------------------------- + + async deleteDiffs( + markdownFileDTO: MarkdownFileDTO, + ) { + await this.diffRepository.delete({ + MarkdownID: markdownFileDTO.MarkdownID, + }); + } + + ///===----------------------------------------------------- + + async resetDiffs( + markdownID: string, + snapshotID: string, + ) { + await this.diffRepository.update( + { + MarkdownID: markdownID, + SnapshotID: snapshotID, + }, + { + HasBeenUsed: false, + }, + ); + } + + ///===----------------------------------------------------- + + async getAllDiffs(markdownID: string) { + return await this.diffRepository.find({ + where: { + MarkdownID: markdownID, + HasBeenUsed: true, + }, + }); + } + + ///===----------------------------------------------------- + + getLogicalIndex( + s3Index: number, + nextDiffID: number, + arr_len: number, + ): number { + return ( + (s3Index - nextDiffID + arr_len) % arr_len + ); + } + + ///===----------------------------------------------------- + + async getLogicalDiffOrder( + diffDTOs: DiffDTO[], + nextDiffID: number, + ) { + const arrLength = parseInt( + process.env.MAX_DIFFS, + ); + const logicalOrder: DiffDTO[] = new Array( + arrLength, + ).fill(0); + for (let idx = 0; idx < arrLength; idx++) { + const logicalIndex = this.getLogicalIndex( + diffDTOs[idx].S3DiffID, + nextDiffID, + arrLength, + ); + logicalOrder[logicalIndex] = diffDTOs[idx]; + } + return logicalOrder; + } } diff --git a/backend/src/diffs/dto/diffs.dto.ts b/backend/src/diffs/dto/diffs.dto.ts new file mode 100644 index 00000000..4cdad6c3 --- /dev/null +++ b/backend/src/diffs/dto/diffs.dto.ts @@ -0,0 +1,23 @@ +export class DiffDTO { + DiffID: string; + MarkdownID: string; + UserID: number; + DisplayID: number; + S3DiffID: number; + LastModified: Date; + Content: string; + SnapshotPayload: string; + SnapshotID: string; + + constructor() { + this.DiffID = undefined; + this.MarkdownID = undefined; + this.UserID = undefined; + this.DisplayID = undefined; + this.S3DiffID = undefined; + this.LastModified = undefined; + this.Content = undefined; + this.SnapshotPayload = undefined; + this.SnapshotID = undefined; + } +} diff --git a/backend/src/diffs/entities/diffs.entity.ts b/backend/src/diffs/entities/diffs.entity.ts index 274f9562..1524d838 100644 --- a/backend/src/diffs/entities/diffs.entity.ts +++ b/backend/src/diffs/entities/diffs.entity.ts @@ -13,10 +13,7 @@ export class Diff { MarkdownID: string; @Column() - UserID: string; - - @Column() - DisplayID: string; + UserID: number; @Column() S3DiffID: number; @@ -27,4 +24,10 @@ export class Diff { onUpdate: 'CURRENT_TIMESTAMP(3)', }) LastModified: Date; + + @Column() + HasBeenUsed: boolean; + + @Column() + SnapshotID: string; } diff --git a/backend/src/file_manager/__mocks__/file_manager.service.ts b/backend/src/file_manager/__mocks__/file_manager.service.ts index bfdf62a9..23268ab4 100644 --- a/backend/src/file_manager/__mocks__/file_manager.service.ts +++ b/backend/src/file_manager/__mocks__/file_manager.service.ts @@ -17,6 +17,8 @@ import { ExportDTO } from '../dto/export.dto'; import * as CryptoJS from 'crypto-js'; import { ConversionService } from '../../conversion/conversion.service'; import { ImportDTO } from '../dto/import.dto'; +import { DiffsService } from '../../diffs/diffs.service'; +import { SnapshotService } from '../../snapshots/snapshots.service'; @Injectable() export class FileManagerServiceMock { @@ -26,6 +28,8 @@ export class FileManagerServiceMock { private s3service: S3Service, private conversionService: ConversionService, private userService: UsersService, + private diffsService: DiffsService, + private snapshotService: SnapshotService, ) {} // File operations: ########################################################### @@ -233,6 +237,22 @@ export class FileManagerServiceMock { markdownFileDTO, ); + await this.s3service.deleteDiffObjectsForFile( + markdownFileDTO, + ); + + await this.s3service.deleteSnapshotObjectsForFile( + markdownFileDTO, + ); + + await this.diffsService.deleteDiffs( + markdownFileDTO, + ); + + await this.snapshotService.deleteSnapshots( + markdownFileDTO, + ); + return this.markdownFilesService.remove( markdownFileDTO, ); diff --git a/backend/src/file_manager/file_manager.controller.spec.ts b/backend/src/file_manager/file_manager.controller.spec.ts index 65aa1f72..7c6fa455 100644 --- a/backend/src/file_manager/file_manager.controller.spec.ts +++ b/backend/src/file_manager/file_manager.controller.spec.ts @@ -33,6 +33,10 @@ import { JwtService } from '@nestjs/jwt'; import { ResetPasswordService } from '../reset_password/reset_password.service'; import { ResetPasswordRequest } from '../reset_password/entities/reset_password_request.entity'; import { MailService } from '../mail/mail.service'; +import { DiffsService } from '../diffs/diffs.service'; +import { SnapshotService } from '../snapshots/snapshots.service'; +import { Diff } from '../diffs/entities/diffs.entity'; +import { Snapshot } from '../snapshots/entities/snapshots.entity'; describe('FileManagerController', () => { let controller: FileManagerController; @@ -54,6 +58,8 @@ describe('FileManagerController', () => { JwtService, ResetPasswordService, MailService, + DiffsService, + SnapshotService, { provide: 'FileManagerService', useValue: { @@ -74,6 +80,14 @@ describe('FileManagerController', () => { provide: getRepositoryToken(User), useClass: Repository, }, + { + provide: getRepositoryToken(Diff), + useClass: Repository, + }, + { + provide: getRepositoryToken(Snapshot), + useClass: Repository, + }, { provide: getRepositoryToken( ResetPasswordRequest, diff --git a/backend/src/file_manager/file_manager.module.ts b/backend/src/file_manager/file_manager.module.ts index bca97939..eef6af36 100644 --- a/backend/src/file_manager/file_manager.module.ts +++ b/backend/src/file_manager/file_manager.module.ts @@ -15,6 +15,10 @@ import { S3ServiceMock } from '../s3/__mocks__/s3.service'; import { ResetPasswordService } from '../reset_password/reset_password.service'; import { ResetPasswordRequest } from '../reset_password/entities/reset_password_request.entity'; import { MailService } from '../mail/mail.service'; +import { DiffsService } from '../diffs/diffs.service'; +import { SnapshotService } from '../snapshots/snapshots.service'; +import { Diff } from '../diffs/entities/diffs.entity'; +import { Snapshot } from '../snapshots/entities/snapshots.entity'; @Module({ imports: [ @@ -24,6 +28,8 @@ import { MailService } from '../mail/mail.service'; TypeOrmModule.forFeature([ ResetPasswordRequest, ]), + TypeOrmModule.forFeature([Diff]), + TypeOrmModule.forFeature([Snapshot]), ], controllers: [FileManagerController], providers: [ @@ -37,6 +43,8 @@ import { MailService } from '../mail/mail.service'; S3ServiceMock, ResetPasswordService, MailService, + DiffsService, + SnapshotService, ], }) export class FileManagerModule {} diff --git a/backend/src/file_manager/file_manager.service.spec.ts b/backend/src/file_manager/file_manager.service.spec.ts index 39194d7c..963c1dbb 100644 --- a/backend/src/file_manager/file_manager.service.spec.ts +++ b/backend/src/file_manager/file_manager.service.spec.ts @@ -36,6 +36,10 @@ import * as CryptoJS from 'crypto-js'; import { ResetPasswordService } from '../reset_password/reset_password.service'; import { ResetPasswordRequest } from '../reset_password/entities/reset_password_request.entity'; import { MailService } from '../mail/mail.service'; +import { DiffsService } from '../diffs/diffs.service'; +import { SnapshotService } from '../snapshots/snapshots.service'; +import { Diff } from '../diffs/entities/diffs.entity'; +import { Snapshot } from '../snapshots/entities/snapshots.entity'; jest.mock('crypto-js', () => { const mockedHash = jest.fn( @@ -67,6 +71,8 @@ describe('FileManagerService', () => { let s3ServiceMock: S3ServiceMock; let conversionService: ConversionService; let usersService: UsersService; + let snapshotService: SnapshotService; + let diffService: DiffsService; beforeEach(async () => { const module: TestingModule = @@ -82,6 +88,8 @@ describe('FileManagerService', () => { AuthService, JwtService, ResetPasswordService, + DiffsService, + SnapshotService, MailService, { provide: 'FileManagerService', @@ -92,6 +100,7 @@ describe('FileManagerService', () => { createFolder: jest.fn(), retrieveAllFolders: jest.fn(), convertFoldersToDTOs: jest.fn(), + deleteFile: jest.fn(), }, }, { @@ -137,6 +146,24 @@ describe('FileManagerService', () => { deleteFile: jest.fn(), createFile: jest.fn(), retrieveFile: jest.fn(), + createDiffObjectsForFile: jest.fn(), + createSnapshotObjectsForFile: + jest.fn(), + }, + }, + { + provide: 'DiffsService', + useValue: { + deleteFile: jest.fn(), + createDiffs: jest.fn(), + deleteDiffs: jest.fn(), + }, + }, + { + provide: 'SnapshotService', + useValue: { + deleteFile: jest.fn(), + createSnapshots: jest.fn(), }, }, { @@ -152,6 +179,14 @@ describe('FileManagerService', () => { provide: getRepositoryToken(User), useClass: Repository, }, + { + provide: getRepositoryToken(Diff), + useClass: Repository, + }, + { + provide: getRepositoryToken(Snapshot), + useClass: Repository, + }, { provide: getRepositoryToken( ResetPasswordRequest, @@ -182,6 +217,15 @@ describe('FileManagerService', () => { usersService = module.get(UsersService); module.close(); + + snapshotService = module.get( + SnapshotService, + ); + module.close(); + + diffService = + module.get(DiffsService); + module.close(); }); describe('create_folder', () => { @@ -629,7 +673,6 @@ describe('FileManagerService', () => { it('should throw an error if UserID is undefined', async () => { const markdownFileDTO = new MarkdownFileDTO(); - try { await service.createFile(markdownFileDTO); expect(true).toBe(false); @@ -656,6 +699,23 @@ describe('FileManagerService', () => { returnFile.Name = 'New Document'; returnFile.Size = 0; + jest.spyOn( + s3Service, + 'createSnapshotObjectsForFile', + ); + + jest.spyOn( + s3Service, + 'createDiffObjectsForFile', + ); + jest + .spyOn(snapshotService, 'createSnapshots') + .mockResolvedValue([] as number[]); + + jest + .spyOn(diffService, 'createDiffs') + .mockResolvedValue([] as any); + const createFileSpy = jest.spyOn( s3Service, 'createFile', @@ -712,6 +772,36 @@ describe('FileManagerService', () => { ) .mockResolvedValueOnce(markdownFileDTO); + jest.spyOn( + s3Service, + 'createSnapshotObjectsForFile', + ); + + jest.spyOn( + s3Service, + 'createDiffObjectsForFile', + ); + jest + .spyOn(snapshotService, 'createSnapshots') + .mockResolvedValue([] as number[]); + + jest + .spyOn(diffService, 'createDiffs') + .mockResolvedValue([] as any); + + jest + .spyOn(markdownFilesService, 'create') + .mockResolvedValueOnce(markdownFileDTO); + + jest + .spyOn(Repository.prototype, 'save') + .mockResolvedValueOnce(markdownFileDTO); + + const createFileSpy = jest.spyOn( + s3Service, + 'createFile', + ); + const response = await service.createFile( markdownFileDTO, true, @@ -745,6 +835,22 @@ describe('FileManagerService', () => { createSpy.mockResolvedValue( markdownFileDTO, ); + jest.spyOn( + s3Service, + 'createSnapshotObjectsForFile', + ).mockResolvedValue([] as any); + + jest.spyOn( + s3Service, + 'createDiffObjectsForFile', + ).mockResolvedValue([] as any); + jest + .spyOn(snapshotService, 'createSnapshots') + .mockResolvedValue([] as number[]); + + jest + .spyOn(diffService, 'createDiffs') + .mockResolvedValue([] as any); const response = await service.createFile( markdownFileDTO, @@ -1381,10 +1487,37 @@ describe('FileManagerService', () => { .spyOn(s3Service, 'deleteFile') .mockResolvedValue(new MarkdownFileDTO()); + jest + .spyOn( + s3Service, + 'deleteDiffObjectsForFile', + ) + .mockResolvedValue([] as any); + jest + .spyOn( + s3Service, + 'deleteSnapshotObjectsForFile', + ) + .mockResolvedValue([] as any); + + jest + .spyOn(diffService, 'deleteDiffs') + .mockResolvedValue([] as any); + + jest + .spyOn(snapshotService, 'deleteSnapshots') + .mockResolvedValue([] as any); + jest .spyOn(markdownFilesService, 'remove') .mockResolvedValue(new MarkdownFile()); + jest + .spyOn(Repository.prototype, 'delete') + .mockResolvedValueOnce( + markdownFileDTO as any, + ); + const response = await service.deleteFile( markdownFileDTO, ); @@ -1435,6 +1568,24 @@ describe('FileManagerService', () => { .spyOn(markdownFilesService, 'remove') .mockResolvedValue(new MarkdownFile()); + jest.spyOn(Repository.prototype, 'delete'); + + jest.spyOn( + s3Service, + 'deleteSnapshotObjectsForFile', + ); + jest.spyOn( + s3Service, + 'deleteDiffObjectsForFile', + ); + jest.spyOn( + snapshotService, + 'deleteSnapshots', + ); + jest + .spyOn(diffService, 'deleteDiffs') + .mockResolvedValue([] as any); + const response = await service.deleteFile( markdownFileDTO, ); diff --git a/backend/src/file_manager/file_manager.service.ts b/backend/src/file_manager/file_manager.service.ts index 5d1699e3..629867e5 100644 --- a/backend/src/file_manager/file_manager.service.ts +++ b/backend/src/file_manager/file_manager.service.ts @@ -18,6 +18,8 @@ import { ExportDTO } from './dto/export.dto'; import * as CryptoJS from 'crypto-js'; import { ConversionService } from '../conversion/conversion.service'; import { ImportDTO } from './dto/import.dto'; +import { DiffsService } from '../diffs/diffs.service'; +import { SnapshotService } from '../snapshots/snapshots.service'; @Injectable() export class FileManagerService { @@ -28,14 +30,11 @@ export class FileManagerService { private conversionService: ConversionService, private userService: UsersService, private s3ServiceMock: S3ServiceMock, + private diffsService: DiffsService, + private snapshotService: SnapshotService, ) {} // File operations: ########################################################### - - // DB Requires the following fields to be initialised in the DTO: - // Path: string; .. TO PLACE THE FILE IN S3 - // Name: string; .. THE NEW NAME OF THE FILE - // Size: number; .. THE SIZE OF THE FILE IN MEGABYTES async createFile( markdownFileDTO: MarkdownFileDTO, isTest = false, @@ -72,19 +71,45 @@ export class FileManagerService { await this.s3ServiceMock.createFile( markdownFileDTO, ); + const returnMD_DTO = new MarkdownFileDTO(); + returnMD_DTO.MarkdownID = 'testID'; + returnMD_DTO.Name = 'New Document'; + returnMD_DTO.Content = 'testContent'; + returnMD_DTO.Path = ''; + returnMD_DTO.DateCreated = new Date(); + returnMD_DTO.LastModified = new Date(); + returnMD_DTO.Size = 0; + returnMD_DTO.ParentFolderID = ''; + returnMD_DTO.UserID = 0; + return returnMD_DTO; } else { await this.s3service.createFile( markdownFileDTO, ); - } + await this.s3service.createDiffObjectsForFile( + markdownFileDTO, + ); + + await this.s3service.createSnapshotObjectsForFile( + markdownFileDTO, + ); + + const snapshotIDs: string[] = + await this.snapshotService.createSnapshots( + markdownFileDTO, + ); + + await this.diffsService.createDiffs( + markdownFileDTO, + snapshotIDs, + ); + } return await this.markdownFilesService.create( markdownFileDTO, - ); // return the file to know ID; + ); } - // This function will need to return the latest diffs for - // the specified file (at most, 10 diffs) async retrieveFile( markdownFileDTO: MarkdownFileDTO, isTest = false, @@ -236,8 +261,6 @@ export class FileManagerService { ); } - // Assuming frontend will send the NextDiffID - return await this.markdownFilesService.updateAfterModification( markdownFileDTO, ); @@ -257,10 +280,29 @@ export class FileManagerService { await this.s3ServiceMock.deleteFile( markdownFileDTO, ); + + // TODO: decide on a return value here, otherwise two calls to remove md file are made + // OR remove the mdservice.remove call from s3serviceMock.deleteFile } else { await this.s3service.deleteFile( markdownFileDTO, ); + + await this.s3service.deleteDiffObjectsForFile( + markdownFileDTO, + ); + + await this.s3service.deleteSnapshotObjectsForFile( + markdownFileDTO, + ); + + await this.diffsService.deleteDiffs( + markdownFileDTO, + ); + + await this.snapshotService.deleteSnapshots( + markdownFileDTO, + ); } return this.markdownFilesService.remove( diff --git a/backend/src/markdown_files/markdown_files.service.ts b/backend/src/markdown_files/markdown_files.service.ts index 4de622da..d54edc74 100644 --- a/backend/src/markdown_files/markdown_files.service.ts +++ b/backend/src/markdown_files/markdown_files.service.ts @@ -3,6 +3,7 @@ import { HttpStatus, Injectable, } from '@nestjs/common'; +import 'dotenv/config'; import { MarkdownFileDTO } from './dto/markdown_file.dto'; import { MarkdownFile } from './entities/markdown_file.entity'; import { InjectRepository } from '@nestjs/typeorm'; @@ -90,8 +91,6 @@ export class MarkdownFilesService { ); markdownToUpdate.LastModified = new Date(); markdownToUpdate.Size = markdownDTO.Size; - markdownToUpdate.NextDiffID = - (markdownToUpdate.NextDiffID + 1) % 10; return this.markdownFileRepository.save( markdownToUpdate, ); @@ -120,4 +119,64 @@ export class MarkdownFilesService { markdownToUpdate, ); } + + ///===---------------------------------------------------- + + async getNextDiffID(markdownID: string) { + const markdownFile = + await this.markdownFileRepository.findOneBy( + { + MarkdownID: markdownID, + }, + ); + return markdownFile.NextDiffID; + } + + ///===---------------------------------------------------- + + async getNextSnapshotID(markdownID: string) { + const markdownFile = + await this.markdownFileRepository.findOneBy( + { + MarkdownID: markdownID, + }, + ); + return markdownFile.NextSnapshotID; + } + + ///===---------------------------------------------------- + + async incrementNextDiffID(markdownID: string) { + const markdownFile = + await this.markdownFileRepository.findOneBy( + { + MarkdownID: markdownID, + }, + ); + markdownFile.NextDiffID = + (markdownFile.NextDiffID + 1) % + parseInt(process.env.MAX_DIFFS); + return await this.markdownFileRepository.save( + markdownFile, + ); + } + + ///===---------------------------------------------------- + + async incrementNextSnapshotID( + markdownID: string, + ) { + const markdownFile = + await this.markdownFileRepository.findOneBy( + { + MarkdownID: markdownID, + }, + ); + markdownFile.NextSnapshotID = + (markdownFile.NextSnapshotID + 1) % + parseInt(process.env.MAX_SNAPSHOTS); + return this.markdownFileRepository.save( + markdownFile, + ); + } } diff --git a/backend/src/s3/s3.service.ts b/backend/src/s3/s3.service.ts index 69d69e4d..26195152 100644 --- a/backend/src/s3/s3.service.ts +++ b/backend/src/s3/s3.service.ts @@ -7,9 +7,11 @@ import { PutObjectCommand, S3Client, } from '@aws-sdk/client-s3'; -import * as fs from 'fs/promises'; // for local storage +// import * as fs from 'fs/promises'; // for local storage import * as CryptoJS from 'crypto-js'; import { AssetDTO } from '../assets/dto/asset.dto'; +import { DiffDTO } from '../diffs/dto/diffs.dto'; +import { SnapshotDTO } from '../snapshots/dto/snapshot.dto'; @Injectable() export class S3Service { @@ -22,6 +24,8 @@ export class S3Service { awsS3SecretAccessKey = process.env.AWS_S3_SECRET_ACCESS_KEY; + ///===---------------------------------------------------- + private readonly s3Client = new S3Client({ credentials: { accessKeyId: this.awsS3AccessKeyId, @@ -30,6 +34,8 @@ export class S3Service { region: this.awsS3BucketRegion, }); + ///===---------------------------------------------------- + async deleteFile( markdownFileDTO: MarkdownFileDTO, ) { @@ -57,10 +63,11 @@ export class S3Service { console.log('Delete Error: ' + err); return undefined; } - return markdownFileDTO; } + ///===---------------------------------------------------- + async createFile( markdownFileDTO: MarkdownFileDTO, ) { @@ -103,28 +110,13 @@ export class S3Service { return undefined; } - for (let i = 0; i < 10; i++) { - try { - await this.s3Client.send( - new PutObjectCommand({ - Bucket: this.awsS3BucketName, - Key: `${filePath}/diff/${i}`, - Body: new Uint8Array(Buffer.from('')), - }), - ); - } catch (err) { - console.log( - `S3 diff ${i} file creation error: ` + - err, - ); - return undefined; - } - } markdownFileDTO.Content = ''; markdownFileDTO.Size = 0; return markdownFileDTO; } + ///===---------------------------------------------------- + async saveFile( markdownFileDTO: MarkdownFileDTO, ) { @@ -162,24 +154,26 @@ export class S3Service { return undefined; } - try { - // await fs.writeFile( - // `./storage/${filePath}/diff/${markdownFileDTO.NextDiffID}`, - // fileData, - // 'utf-8', - // ); - /*const response = */ await this.s3Client.send( - new PutObjectCommand({ - Bucket: this.awsS3BucketName, - Key: `${filePath}/diff/${markdownFileDTO.NextDiffID}`, - Body: markdownFileDTO.NewDiff, - }), - ); - } catch (err) {} + // try { + // // await fs.writeFile( + // // `./storage/${filePath}/diff/${markdownFileDTO.NextDiffID}`, + // // fileData, + // // 'utf-8', + // // ); + // /*const response = */ await this.s3Client.send( + // new PutObjectCommand({ + // Bucket: this.awsS3BucketName, + // Key: `${filePath}/diff/${markdownFileDTO.NextDiffID}`, + // Body: markdownFileDTO.NewDiff, + // }), + // ); + // } catch (err) {} return markdownFileDTO; } + ///===---------------------------------------------------- + async retrieveFile( markdownFileDTO: MarkdownFileDTO, ) { @@ -222,6 +216,393 @@ export class S3Service { return markdownFileDTO; } + ///===---------------------------------------------------- + + async createDiffObjectsForFile( + markdownFileDTO: MarkdownFileDTO, + ) { + const filePath = `${markdownFileDTO.UserID}/${markdownFileDTO.MarkdownID}`; + for ( + let i = 0; + i < parseInt(process.env.MAX_DIFFS); + i++ + ) { + try { + await this.s3Client.send( + new PutObjectCommand({ + Bucket: this.awsS3BucketName, + Key: `${filePath}/diff/${i}`, + Body: new Uint8Array(Buffer.from('')), + }), + ); + } catch (err) { + console.log( + `S3 diff ${i} object creation error: ` + + err, + ); + return undefined; + } + } + } + + ///===---------------------------------------------------- + + async saveDiff( + diffDTO: DiffDTO, + nextDiffID: number, + ) { + const filePath = `${diffDTO.UserID}/${diffDTO.MarkdownID}`; + + console.log( + 'diffDTO.Content: ', + diffDTO.Content, + ); + try { + await this.s3Client.send( + new PutObjectCommand({ + Bucket: this.awsS3BucketName, + Key: `${filePath}/diff/${nextDiffID}`, + Body: diffDTO.Content, + }), + ); + } catch (err) { + console.log('Write File Error: ' + err); + return undefined; + } + return diffDTO; + } + + ///===---------------------------------------------------- + + async getDiffSet( + S3DiffIDs: number[], + userID: number, + markdownID: string, + ) { + const filePath = `${userID}/${markdownID}`; + + const diffDTOs: DiffDTO[] = []; + + for (let i = 0; i < S3DiffIDs.length; i++) { + try { + const response = await this.s3Client.send( + new GetObjectCommand({ + Bucket: this.awsS3BucketName, + Key: `${filePath}/diff/${S3DiffIDs[i]}`, + }), + ); + + const diffDTO = new DiffDTO(); + diffDTO.Content = + await response.Body.transformToString(); + diffDTOs.push(diffDTO); + } catch (err) { + console.log( + `S3 diff ${i} read error: ` + err, + ); + return undefined; + } + } + return diffDTOs; + } + + ///===---------------------------------------------------- + + async getSnapshot( + S3SnapshotID: number, + userID: number, + markdownID: string, + ) { + const filePath = `${userID}/${markdownID}`; + + try { + const response = await this.s3Client.send( + new GetObjectCommand({ + Bucket: this.awsS3BucketName, + Key: `${filePath}/snapshot/${S3SnapshotID}`, + }), + ); + + const snapshotDTO = new SnapshotDTO(); + snapshotDTO.Content = + await response.Body.transformToString(); + return snapshotDTO; + } catch (err) { + console.log( + `S3 snapshot ${S3SnapshotID} read error: ` + + err, + ); + return undefined; + } + } + + ///===---------------------------------------------------- + + async saveOldestSnapshot(diffDTO: DiffDTO) { + const filePath = `${diffDTO.UserID}/${diffDTO.MarkdownID}`; + + const markdownFileDTO = new MarkdownFileDTO(); + markdownFileDTO.UserID = diffDTO.UserID; + markdownFileDTO.MarkdownID = + diffDTO.MarkdownID; + + const file = await this.retrieveFile( + markdownFileDTO, + ); + + try { + await this.s3Client.send( + new PutObjectCommand({ + Bucket: this.awsS3BucketName, + Key: `${filePath}/snapshot/${process.env.MAX_SNAPSHOTS}`, + Body: file.Content, + }), + ); + } catch (err) { + console.log('Write File Error: ' + err); + return undefined; + } + return diffDTO; + } + + ///===---------------------------------------------------- + + async retrieveOldestSnapshot( + markdownFileDTO: MarkdownFileDTO, + ) { + const filePath = `${markdownFileDTO.UserID}/${markdownFileDTO.MarkdownID}`; + + try { + const response = await this.s3Client.send( + new GetObjectCommand({ + Bucket: this.awsS3BucketName, + Key: `${filePath}/snapshot/${process.env.MAX_SNAPSHOTS}`, + }), + ); + + markdownFileDTO.Content = + await response.Body.transformToString(); + markdownFileDTO.Size = + response.ContentLength; + } catch (err) { + console.log('Read File Error: ' + err); + return undefined; + } + } + + ///===---------------------------------------------------- + + /** + * @notes every snapshot is associated with n previous diffs. + * The IDs of the associated diffs do not change unless + * a change is made to the relevant versioning env variables. + */ + + async getAllDiffsForSnapshot( + snapshotDTO: SnapshotDTO, + ) { + const filePath = `${snapshotDTO.UserID}/${snapshotDTO.MarkdownID}`; + + const diffDTOs: DiffDTO[] = []; + + const firstDiffID = + snapshotDTO.S3SnapshotID * + parseInt(process.env.DIFFS_PER_SNAPSHOT); + + for ( + let j = firstDiffID; + j < + firstDiffID + + parseInt(process.env.DIFFS_PER_SNAPSHOT); + j++ + ) { + try { + const response = await this.s3Client.send( + new GetObjectCommand({ + Bucket: this.awsS3BucketName, + Key: `${filePath}/diff/${j}`, + }), + ); + + const diffDTO = new DiffDTO(); + diffDTO.Content = + await response.Body.transformToString(); + diffDTOs.push(diffDTO); + } catch (err) { + console.log( + `S3 diff ${j} read error: ` + err, + ); + return undefined; + } + } + return diffDTOs; + } + + ///===---------------------------------------------------- + + async deleteDiffObjectsForFile( + markdownFileDTO: MarkdownFileDTO, + ) { + const filePath = `${markdownFileDTO.UserID}/${markdownFileDTO.MarkdownID}`; + for ( + let i = 0; + i < parseInt(process.env.MAX_DIFFS); + i++ + ) { + try { + await this.s3Client.send( + new DeleteObjectCommand({ + Bucket: this.awsS3BucketName, + Key: `${filePath}/diff/${i}`, + }), + ); + } catch (err) { + console.log( + 'Delete all diffs error: ' + err, + ); + return undefined; + } + } + } + + ///===---------------------------------------------------- + + async createSnapshotObjectsForFile( + markdownFileDTO: MarkdownFileDTO, + ) { + const filePath = `${markdownFileDTO.UserID}/${markdownFileDTO.MarkdownID}`; + + // Create snapshot objects + for ( + let j = 0; + j < parseInt(process.env.MAX_SNAPSHOTS); + j++ + ) { + try { + await this.s3Client.send( + new PutObjectCommand({ + Bucket: this.awsS3BucketName, + Key: `${filePath}/snapshot/${j}`, + Body: new Uint8Array(Buffer.from('')), + }), + ); + } catch (err) { + console.log( + `S3 snapshot ${j} object creation error`, + ); + return undefined; + } + } + } + + ///===---------------------------------------------------- + + async deleteSnapshotObjectsForFile( + markdownFileDTO: MarkdownFileDTO, + ) { + const filePath = `${markdownFileDTO.UserID}/${markdownFileDTO.MarkdownID}`; + for ( + let i = 0; + i < parseInt(process.env.MAX_SNAPSHOTS); + i++ + ) { + try { + await this.s3Client.send( + new DeleteObjectCommand({ + Bucket: this.awsS3BucketName, + Key: `${filePath}/snapshot/${i}`, + }), + ); + } catch (err) { + console.log( + 'Delete all snapshots error: ' + err, + ); + return undefined; + } + } + } + + ///===---------------------------------------------------- + + async saveSnapshot( + diffDTO: DiffDTO, + nextSnapshotID: number, + ) { + const markdownFileDTO: MarkdownFileDTO = + new MarkdownFileDTO(); + markdownFileDTO.UserID = diffDTO.UserID; + markdownFileDTO.MarkdownID = + diffDTO.MarkdownID; + const fileDTO = await this.retrieveFile( + markdownFileDTO, + ); + + const filePath = `${diffDTO.UserID}/${diffDTO.MarkdownID}`; + + console.log( + 'fileDTO.Content: ', + fileDTO.Content, + ); + + try { + await this.s3Client.send( + new PutObjectCommand({ + Bucket: this.awsS3BucketName, + Key: `${filePath}/snapshot/${nextSnapshotID}`, + Body: fileDTO.Content, + }), + ); + } catch (err) { + console.log('Write File Error: ' + err); + return undefined; + } + + return diffDTO; + } + + ///===---------------------------------------------------- + + async retrieveAllSnapshots( + logicalOrder: number[], + snapshotDTO: SnapshotDTO, + ) { + const filePath = `${snapshotDTO.UserID}/${snapshotDTO.MarkdownID}`; + + const snapshotDTOs: SnapshotDTO[] = []; + + for ( + let i = 0; + i < logicalOrder.length; + i++ + ) { + console.log( + 'Trying to retrieve snapshot on path ', + `${filePath}/snapshot/${logicalOrder[i]}`, + ); + try { + const response = await this.s3Client.send( + new GetObjectCommand({ + Bucket: this.awsS3BucketName, + Key: `${filePath}/snapshot/${logicalOrder[i]}`, + }), + ); + + const snapshotDTO = new SnapshotDTO(); + snapshotDTO.Content = + await response.Body.transformToString(); + snapshotDTOs.push(snapshotDTO); + } catch (err) { + console.log( + `S3 snapshot ${i} read error: ` + err, + ); + return undefined; + } + } + return snapshotDTOs; + } + + ///===---------------------------------------------------- + async createAsset(assetDTO: AssetDTO) { // Generate new AssetID const newAssetDTO = new AssetDTO(); @@ -251,6 +632,8 @@ export class S3Service { return newAssetDTO; } + ///===---------------------------------------------------- + async saveTextractResponse( saveAssetDTO: AssetDTO, textractResponse: any, @@ -299,6 +682,8 @@ export class S3Service { return saveAssetDTO; } + ///===---------------------------------------------------- + async saveImageAsset(saveAssetDTO: AssetDTO) { let filePath = `${saveAssetDTO.UserID}`; @@ -345,6 +730,8 @@ export class S3Service { return saveAssetDTO; } + ///===---------------------------------------------------- + async saveTextAssetImage( saveAssetDTO: AssetDTO, ) { @@ -393,6 +780,8 @@ export class S3Service { return saveAssetDTO; } + ///===---------------------------------------------------- + async retrieveAssetByID( assetID: string, userID: number, @@ -446,6 +835,8 @@ export class S3Service { } } + ///===---------------------------------------------------- + async retrieveAsset( retrieveAssetDTO: AssetDTO, ) { @@ -493,6 +884,8 @@ export class S3Service { return retrieveAssetDTO; } + ///===---------------------------------------------------- + async deleteAsset(assetDTO: AssetDTO) { console.log('Delete Asset (s3)'); let filePath = `${assetDTO.UserID}`; diff --git a/backend/src/snapshots/dto/snapshot.dto.ts b/backend/src/snapshots/dto/snapshot.dto.ts new file mode 100644 index 00000000..cd66fd73 --- /dev/null +++ b/backend/src/snapshots/dto/snapshot.dto.ts @@ -0,0 +1,21 @@ +export class SnapshotDTO { + SnapshotID: string; + MarkdownID: string; + UserID: number; + DisplayID: number; + S3SnapshotID: number; + LastModified: Date; + Content: string; + OldestSnapshot: boolean; + + constructor() { + this.SnapshotID = undefined; + this.MarkdownID = undefined; + this.UserID = undefined; + this.DisplayID = undefined; + this.S3SnapshotID = undefined; + this.LastModified = undefined; + this.Content = undefined; + this.OldestSnapshot = false; + } +} diff --git a/backend/src/snapshots/entities/snapshots.entity.ts b/backend/src/snapshots/entities/snapshots.entity.ts index 0b128556..47892d59 100644 --- a/backend/src/snapshots/entities/snapshots.entity.ts +++ b/backend/src/snapshots/entities/snapshots.entity.ts @@ -13,10 +13,7 @@ export class Snapshot { MarkdownID: string; @Column() - UserID: string; - - @Column() - DisplayID: string; + UserID: number; @Column() S3SnapshotID: number; @@ -27,4 +24,7 @@ export class Snapshot { onUpdate: 'CURRENT_TIMESTAMP(3)', }) LastModified: Date; + + @Column() + HasBeenUsed: boolean; } diff --git a/backend/src/snapshots/snapshots.service.ts b/backend/src/snapshots/snapshots.service.ts index f5841b30..ff23d5dc 100644 --- a/backend/src/snapshots/snapshots.service.ts +++ b/backend/src/snapshots/snapshots.service.ts @@ -1,7 +1,10 @@ -import { Injectable } from "@nestjs/common"; -import { InjectRepository } from "@nestjs/typeorm"; -import { Repository } from "typeorm"; -import { Snapshot } from "./entities/snapshots.entity"; +import { Injectable } from '@nestjs/common'; +import { InjectRepository } from '@nestjs/typeorm'; +import { Repository } from 'typeorm'; +import { Snapshot } from './entities/snapshots.entity'; +import { MarkdownFileDTO } from '../markdown_files/dto/markdown_file.dto'; +import * as CryptoJS from 'crypto-js'; +import { SnapshotDTO } from './dto/snapshot.dto'; @Injectable() export class SnapshotService { @@ -9,4 +12,178 @@ export class SnapshotService { @InjectRepository(Snapshot) private snapshotRepository: Repository, ) {} + + ///===----------------------------------------------------- + + async createSnapshots( + markdownFileDTO: MarkdownFileDTO, + ) { + const snapshotIDs = []; + const snapshotRecords = []; + for ( + let i = 0; + i < parseInt(process.env.MAX_SNAPSHOTS); + i++ + ) { + const snapshotID = CryptoJS.SHA256( + markdownFileDTO.UserID.toString() + + new Date().getTime().toString() + + i.toString(), + ).toString(); + + snapshotRecords.push({ + SnapshotID: snapshotID, + MarkdownID: markdownFileDTO.MarkdownID, + UserID: markdownFileDTO.UserID, + S3SnapshotID: i, + HasBeenUsed: false, + }); + + snapshotIDs.push(snapshotID); + } + await this.snapshotRepository.insert( + snapshotRecords, + ); + + return snapshotIDs; + } + + ///===----------------------------------------------------- + + async updateSnapshot( + markdownID: string, + nextSnapshotID: number, + ) { + const snapshot = + await this.snapshotRepository.findOne({ + where: { + MarkdownID: markdownID, + S3SnapshotID: nextSnapshotID, + }, + }); + + snapshot.LastModified = new Date(); + snapshot.HasBeenUsed = true; + await this.snapshotRepository.save(snapshot); + } + + ///===----------------------------------------------------- + + async getAllSnapshots( + markdownFileDTO: MarkdownFileDTO, + ) { + return await this.snapshotRepository.find({ + where: { + MarkdownID: markdownFileDTO.MarkdownID, + HasBeenUsed: true, + }, + }); + } + + ///===----------------------------------------------------- + + async resetSnapshot( + markdownID: string, + nextSnapshotID: number, + ) { + const snapshot = + await this.snapshotRepository.findOne({ + where: { + MarkdownID: markdownID, + S3SnapshotID: nextSnapshotID, + }, + }); + + snapshot.HasBeenUsed = false; + await this.snapshotRepository.save(snapshot); + return snapshot; + } + + ///===----------------------------------------------------- + + async getSnapshotByS3SnapshotID( + markdownID: string, + s3SnapshotID: number, + ) { + return await this.snapshotRepository.findOne({ + where: { + MarkdownID: markdownID, + S3SnapshotID: s3SnapshotID, + }, + }); + } + + // ///===----------------------------------------------------- + + // async getNextSnapshotID(markdownID: string) { + // const markdownFile = + // await this.snapshotRepository.findOne({ + // where: { + // MarkdownID: markdownID, + // }, + // }); + // return markdownFile.S3SnapshotID; + // } + + ///===----------------------------------------------------- + + async deleteSnapshots( + markdownFileDTO: MarkdownFileDTO, + ) { + await this.snapshotRepository.delete({ + MarkdownID: markdownFileDTO.MarkdownID, + HasBeenUsed: true, + }); + } + + ///===----------------------------------------------------- + + getLogicalIndex( + s3Index: number, + nextSnapshotID: number, + arr_len: number, + ): number { + return ( + (s3Index - nextSnapshotID + arr_len) % + arr_len + ); + } + + ///===----------------------------------------------------- + + async getLogicalSnapshotOrder( + snapshotDTOs: SnapshotDTO[], + nextDiffID: number, + ) { + console.log( + 'snapshots.service snapshotDTOS: ', + snapshotDTOs, + ); + const arrLength = parseInt( + process.env.MAX_DIFFS, + ); + const logicalOrder: SnapshotDTO[] = new Array( + arrLength, + ).fill(0); + for (let idx = 0; idx < arrLength; idx++) { + const logicalIndex = this.getLogicalIndex( + snapshotDTOs[idx].S3SnapshotID, + nextDiffID, + arrLength, + ); + logicalOrder[logicalIndex] = + snapshotDTOs[idx]; + } + return logicalOrder; + } + + ///===----------------------------------------------------- + + async getSnapshotByID(snapshotID: string) { + return await this.snapshotRepository.findOne({ + where: { + SnapshotID: snapshotID, + }, + }); + } } diff --git a/backend/src/version_control/dto/version_history.dto.ts b/backend/src/version_control/dto/version_history.dto.ts new file mode 100644 index 00000000..70d728d8 --- /dev/null +++ b/backend/src/version_control/dto/version_history.dto.ts @@ -0,0 +1,12 @@ +import { DiffDTO } from '../../diffs/dto/diffs.dto'; +import { SnapshotDTO } from '../../snapshots/dto/snapshot.dto'; + +export class VersionHistoryDTO { + DiffHistory: DiffDTO[]; + SnapshotHistory: SnapshotDTO[]; + + constructor() { + this.DiffHistory = undefined; + this.SnapshotHistory = undefined; + } +} diff --git a/backend/src/version_control/dto/version_set.dto.ts b/backend/src/version_control/dto/version_set.dto.ts new file mode 100644 index 00000000..ff47222e --- /dev/null +++ b/backend/src/version_control/dto/version_set.dto.ts @@ -0,0 +1,16 @@ +import { DiffDTO } from '../../diffs/dto/diffs.dto'; +import { SnapshotDTO } from '../../snapshots/dto/snapshot.dto'; + +export class VersionSetDTO { + UserID: number; + MarkdownID: string; + DiffHistory: string[]; + SnapshotID: string; + + constructor() { + this.UserID = undefined; + this.MarkdownID = undefined; + this.DiffHistory = undefined; + this.SnapshotID = undefined; + } +} diff --git a/backend/src/version_control/version_control.controller.ts b/backend/src/version_control/version_control.controller.ts new file mode 100644 index 00000000..33220e9c --- /dev/null +++ b/backend/src/version_control/version_control.controller.ts @@ -0,0 +1,108 @@ +import { + Body, + Controller, + HttpCode, + HttpStatus, + Post, +} from '@nestjs/common'; +import { VersionControlService } from './version_control.service'; +import { DiffDTO } from '../diffs/dto/diffs.dto'; +import { SnapshotDTO } from '../snapshots/dto/snapshot.dto'; +import { MarkdownFileDTO } from '../markdown_files/dto/markdown_file.dto'; +import { VersionHistoryDTO } from './dto/version_history.dto'; +import { SnapshotService } from '../snapshots/snapshots.service'; +import { DiffsService } from '../diffs/diffs.service'; +import { MarkdownFilesService } from '../markdown_files/markdown_files.service'; +import { VersionSetDTO } from './dto/version_set.dto'; + +@Controller('version_control') +export class VersionControlController { + constructor( + private readonly versionControlService: VersionControlService, + private readonly snapshotService: SnapshotService, + private readonly diffService: DiffsService, + private readonly markdownFileService: MarkdownFilesService, + ) {} + + ///===---------------------------------------------------- + + @Post('save_diff') + saveDiff(@Body() diffDTO: DiffDTO) { + this.versionControlService.saveDiff(diffDTO); + } + + ///===---------------------------------------------------- + + @Post('get_all_snapshots') + @HttpCode(HttpStatus.OK) + getAllSnapshots( + @Body() snapshotDTO: SnapshotDTO, + ) { + return this.versionControlService.getAllSnapshots( + snapshotDTO, + ); + } + + ///===---------------------------------------------------- + + @Post('get_history_set') + @HttpCode(HttpStatus.OK) + getHistorySet( + @Body() versionSetDTO: VersionSetDTO, + ) { + return this.versionControlService.getHistorySet( + versionSetDTO, + ); + } + + ///===---------------------------------------------------- + + @Post('load_history') + @HttpCode(HttpStatus.OK) + async loadHistory( + @Body() markdownFileDTO: MarkdownFileDTO, + ) { + const versionHistoryDTO = + new VersionHistoryDTO(); + + // Populate snapshot history + + // const nextSnapshotID = + // await this.markdownFileService.getNextSnapshotID( + // markdownFileDTO.MarkdownID, + // ); + + const snapshots = + await this.snapshotService.getAllSnapshots( + markdownFileDTO, + ); + + const snapshotDTOs = + await this.versionControlService.convertSnapshotsToSnapshotDTOs( + snapshots, + ); + + versionHistoryDTO.SnapshotHistory = + snapshotDTOs; + + // Populate diff history + + // const nextDiffID = + // await this.markdownFileService.getNextDiffID( + // markdownFileDTO.MarkdownID, + // ); + + const diffs = + await this.diffService.getAllDiffs( + markdownFileDTO.MarkdownID, + ); + + const diffDTOs = + await this.versionControlService.convertDiffsToDiffDTOs( + diffs, + ); + + versionHistoryDTO.DiffHistory = diffDTOs; + return versionHistoryDTO; + } +} diff --git a/backend/src/version_control/version_control.module.ts b/backend/src/version_control/version_control.module.ts new file mode 100644 index 00000000..b66a72c2 --- /dev/null +++ b/backend/src/version_control/version_control.module.ts @@ -0,0 +1,30 @@ +import { Module } from '@nestjs/common'; +import { TypeOrmModule } from '@nestjs/typeorm'; +import { DiffsService } from '../diffs/diffs.service'; +import { SnapshotService } from '../snapshots/snapshots.service'; +import { Diff } from '../diffs/entities/diffs.entity'; +import { Snapshot } from '../snapshots/entities/snapshots.entity'; +import { VersionControlController } from './version_control.controller'; +import { VersionControlService } from './version_control.service'; +import { MarkdownFilesService } from '../markdown_files/markdown_files.service'; +import { S3Service } from '../s3/s3.service'; +import { S3ServiceMock } from '../s3/__mocks__/s3.service'; +import { MarkdownFile } from '../markdown_files/entities/markdown_file.entity'; + +@Module({ + imports: [ + TypeOrmModule.forFeature([Diff]), + TypeOrmModule.forFeature([Snapshot]), + TypeOrmModule.forFeature([MarkdownFile]), + ], + controllers: [VersionControlController], + providers: [ + DiffsService, + SnapshotService, + VersionControlService, + MarkdownFilesService, + S3Service, + S3ServiceMock, + ], +}) +export class VersionControlModule {} diff --git a/backend/src/version_control/version_control.service.spec.ts b/backend/src/version_control/version_control.service.spec.ts new file mode 100644 index 00000000..3c66216d --- /dev/null +++ b/backend/src/version_control/version_control.service.spec.ts @@ -0,0 +1,72 @@ +import { + Test, + TestingModule, +} from '@nestjs/testing'; +import { VersionControlService } from './version_control.service'; +import { DiffsService } from '../diffs/diffs.service'; +import { MarkdownFilesService } from '../markdown_files/markdown_files.service'; +import { S3Service } from '../s3/s3.service'; +import { S3ServiceMock } from '../s3/__mocks__/s3.service'; +import { getRepositoryToken } from '@nestjs/typeorm'; +import { Diff } from '../diffs/entities/diffs.entity'; +import { Repository } from 'typeorm'; +import { MarkdownFile } from '../markdown_files/entities/markdown_file.entity'; +import { SnapshotService } from '../snapshots/snapshots.service'; +import { Snapshot } from '../snapshots/entities/snapshots.entity'; + +describe('VersionControlService', () => { + let service: VersionControlService; + let diffsService: DiffsService; + let markdownFilesService: MarkdownFilesService; + let s3Service: S3Service; + let s3ServiceMock: S3ServiceMock; + + beforeEach(async () => { + const module: TestingModule = + await Test.createTestingModule({ + providers: [ + VersionControlService, + DiffsService, + MarkdownFilesService, + S3Service, + S3ServiceMock, + SnapshotService, + { + provide: getRepositoryToken(Diff), + useClass: Repository, + }, + { + provide: + getRepositoryToken(MarkdownFile), + useClass: Repository, + }, + { + provide: getRepositoryToken(Snapshot), + useClass: Repository, + }, + ], + }).compile(); + + service = module.get( + VersionControlService, + ); + + diffsService = + module.get(DiffsService); + + markdownFilesService = + module.get( + MarkdownFilesService, + ); + + s3Service = module.get(S3Service); + + s3ServiceMock = module.get( + S3ServiceMock, + ); + }); + + it('should be defined', () => { + expect(service).toBeDefined(); + }); +}); diff --git a/backend/src/version_control/version_control.service.ts b/backend/src/version_control/version_control.service.ts new file mode 100644 index 00000000..6d6f4c2d --- /dev/null +++ b/backend/src/version_control/version_control.service.ts @@ -0,0 +1,308 @@ +import { Injectable } from '@nestjs/common'; +import { DiffsService } from '../diffs/diffs.service'; +import { DiffDTO } from '../diffs/dto/diffs.dto'; +import { MarkdownFilesService } from '../markdown_files/markdown_files.service'; +import { S3ServiceMock } from '../s3/__mocks__/s3.service'; +import { S3Service } from '../s3/s3.service'; +import { SnapshotDTO } from '../snapshots/dto/snapshot.dto'; +import { SnapshotService } from '../snapshots/snapshots.service'; +import { Snapshot } from '../snapshots/entities/snapshots.entity'; +import { Diff } from '../diffs/entities/diffs.entity'; +import { VersionHistoryDTO } from './dto/version_history.dto'; +import { VersionSetDTO } from './dto/version_set.dto'; + +@Injectable() +export class VersionControlService { + constructor( + private diffService: DiffsService, + private snapshotService: SnapshotService, + private markdownFileService: MarkdownFilesService, + private s3Service: S3Service, + private s3ServiceMock: S3ServiceMock, + ) {} + + ///===----------------------------------------------------- + + async saveDiff(diffDTO: DiffDTO) { + const nextDiffID = + await this.markdownFileService.getNextDiffID( + diffDTO.MarkdownID, + ); + + const nextDiff = + await this.diffService.getDiff( + diffDTO, + nextDiffID, + ); + + await this.s3Service.saveDiff( + diffDTO, + nextDiffID, + ); + + if ( + nextDiffID !== 0 || + nextDiff.HasBeenUsed + ) { + if ( + (nextDiffID + 1) % + parseInt( + process.env.DIFFS_PER_SNAPSHOT, + ) === + 0 + ) { + await this.saveSnapshot(diffDTO); + + // Reset next snapshot and associated diffs + const nextSnapshotID = + await this.markdownFileService.getNextSnapshotID( + diffDTO.MarkdownID, + ); + + const nextSnapshot = + await this.snapshotService.resetSnapshot( + diffDTO.MarkdownID, + nextSnapshotID, + ); + + await this.diffService.resetDiffs( + diffDTO.MarkdownID, + nextSnapshot.SnapshotID, + ); + } + } + + await this.diffService.updateDiff( + diffDTO, + nextDiffID, + ); + + await this.markdownFileService.incrementNextDiffID( + diffDTO.MarkdownID, + ); + } + + ///===----------------------------------------------------- + + async saveSnapshot(diffDTO: DiffDTO) { + const nextSnapshotID = + await this.markdownFileService.getNextSnapshotID( + diffDTO.MarkdownID, + ); + + await this.s3Service.saveSnapshot( + diffDTO, + nextSnapshotID, + ); + + await this.snapshotService.updateSnapshot( + diffDTO.MarkdownID, + nextSnapshotID, + ); + + await this.markdownFileService.incrementNextSnapshotID( + diffDTO.MarkdownID, + ); + } + + ///===----------------------------------------------------- + + // getDiffSetForSnapshot(snapshot: SnapshotDTO) {} + + ///===----------------------------------------------------- + + /** + * @dev frontend calls retrieveOne for file opened by user + * @dev frontend needs to render all snapshots for the file + * as dropdown options + * + * @returns all snapshots for this file, in logical order + */ + async getAllSnapshots( + snapshotDTO: SnapshotDTO, + ) { + const snapshotRange = Array.from( + { + length: parseInt( + process.env.MAX_SNAPSHOTS, + ), + }, + (_, index) => index, + ); + + const nextSnapshotID = + await this.markdownFileService.getNextSnapshotID( + snapshotDTO.MarkdownID, + ); + + const logicalOrder = this.getLogicalOrder( + snapshotRange, + nextSnapshotID, + ); + + let snapshots = + await this.s3Service.retrieveAllSnapshots( + logicalOrder, + snapshotDTO, + ); + + snapshots = + this.pruneEmptySnapshots(snapshots); + + return snapshots; + } + + ///===---------------------------------------------------- + // Helpers + + getDiffSetIndices(snapshotID: number) { + const diffsPerSnap = parseInt( + process.env.DIFFS_PER_SNAPSHOT, + ); + const first = snapshotID * diffsPerSnap; + const last = first + diffsPerSnap; + const indices = Array.from( + { length: last - first }, + (_, index) => index + first, + ); + return indices; + } + + ///===---------------------------------------------------- + + getLogicalIndex( + s3Index: number, + head: number, + arr_len: number, + ): number { + return (s3Index - head + arr_len) % arr_len; + } + + ///===----------------------------------------------------- + + getIndexInS3( + logicalIndex: number, + arr_len: number, + head: number, + ) { + return ( + (logicalIndex + head - arr_len) % arr_len + ); + } + + ///===----------------------------------------------------- + + getLogicalOrder( + arr: number[], + head: number, + ): number[] { + const logicalOrder: number[] = new Array( + arr.length, + ).fill(0); + for (let idx = 0; idx < arr.length; idx++) { + const logicalIndex = this.getLogicalIndex( + idx, + head, + arr.length, + ); + logicalOrder[logicalIndex] = arr[idx]; + } + return logicalOrder; + } + + ///===----------------------------------------------------- + + pruneEmptySnapshots(snapshots: SnapshotDTO[]) { + return snapshots.filter((snapshot) => { + return ( + snapshot.Content !== undefined && + snapshot.Content !== null && + snapshot.Content !== '' + ); + }); + } + + ///===---------------------------------------------------- + + async convertSnapshotsToSnapshotDTOs( + snapshots: Snapshot[], + ) { + const snapshotDTOs = []; + for (let i = 0; i < snapshots.length; i++) { + const snapshot = snapshots[i]; + const snapshotDTO = new SnapshotDTO(); + snapshotDTO.SnapshotID = + snapshot.SnapshotID; + snapshotDTO.MarkdownID = + snapshot.MarkdownID; + snapshotDTO.UserID = snapshot.UserID; + snapshotDTO.S3SnapshotID = + snapshot.S3SnapshotID; + snapshotDTO.LastModified = + snapshot.LastModified; + snapshotDTOs.push(snapshotDTO); + } + return snapshotDTOs; + } + + ///===---------------------------------------------------- + + async convertDiffsToDiffDTOs(diffs: Diff[]) { + const diffDTOs: DiffDTO[] = []; + for (let i = 0; i < diffs.length; i++) { + const diff = diffs[i]; + const diffDTO = new DiffDTO(); + diffDTO.DiffID = diff.DiffID; + diffDTO.MarkdownID = diff.MarkdownID; + diffDTO.UserID = diff.UserID; + diffDTO.S3DiffID = diff.S3DiffID; + diffDTO.LastModified = diff.LastModified; + diffDTO.SnapshotID = diff.SnapshotID; + diffDTOs.push(diffDTO); + } + return diffDTOs; + } + + ///===---------------------------------------------------- + + async getHistorySet( + versionSetDTO: VersionSetDTO, + ) { + const diffs = + await this.diffService.getAllDiffs( + versionSetDTO.MarkdownID, + ); + + const S3DiffIDs: number[] = diffs.map( + (diff) => diff.S3DiffID, + ); + + const diffDTOs = + await this.s3Service.getDiffSet( + S3DiffIDs, + versionSetDTO.UserID, + versionSetDTO.MarkdownID, + ); + + const snapshot = + await this.snapshotService.getSnapshotByID( + versionSetDTO.SnapshotID, + ); + + const snapshotDTO = + await this.s3Service.getSnapshot( + snapshot.S3SnapshotID, + versionSetDTO.UserID, + versionSetDTO.MarkdownID, + ); + + const versionHistoryDTO = + new VersionHistoryDTO(); + + versionHistoryDTO.DiffHistory = diffDTOs; + versionHistoryDTO.SnapshotHistory = [ + snapshotDTO, + ]; + return versionHistoryDTO; + } +} diff --git a/backend/test/file_manager.e2e-spec.ts b/backend/test/file_manager.e2e-spec.ts index 6baa1b2a..106dd64a 100644 --- a/backend/test/file_manager.e2e-spec.ts +++ b/backend/test/file_manager.e2e-spec.ts @@ -18,6 +18,7 @@ import { getRepositoryToken } from '@nestjs/typeorm'; import { MarkdownFile } from '../src/markdown_files/entities/markdown_file.entity'; // import { S3Service } from '../src/s3/s3.service'; import { S3ServiceMock } from '../src/s3/__mocks__/s3.service'; +import { Snapshot } from '../src/snapshots/entities/snapshots.entity'; // import { FileDTO } from '../src/s3/dto/file.dto'; // let startTime: string; @@ -34,6 +35,7 @@ enum ResetScope { describe('FileManagerController (integration)', () => { let app: INestApplication; let markdownFileRepository: Repository; + let snapshotRepository: Repository; let s3Service: S3ServiceMock; beforeAll(async () => { @@ -47,6 +49,10 @@ describe('FileManagerController (integration)', () => { getRepositoryToken(MarkdownFile), useClass: Repository, }, + { + provide: getRepositoryToken(Snapshot), + useClass: Repository, + }, ], }).compile(); @@ -58,6 +64,9 @@ describe('FileManagerController (integration)', () => { >(getRepositoryToken(MarkdownFile)); s3Service = new S3ServiceMock(); + snapshotRepository = moduleFixture.get< + Repository + >(getRepositoryToken(Snapshot)); await resetUser(ResetScope.ALL); }); diff --git a/frontend/src/app/camera/camera.component.html b/frontend/src/app/camera/camera.component.html index 30c3b933..8bd9c151 100644 --- a/frontend/src/app/camera/camera.component.html +++ b/frontend/src/app/camera/camera.component.html @@ -6,7 +6,7 @@ + (click)="captured=false;resetFilters()">



Camera Not @@ -31,9 +31,20 @@

- +
+
+

Adjust Contrast

+ +

Adjust Brightness

+ +
+ + +
+
+
diff --git a/frontend/src/app/camera/camera.component.scss b/frontend/src/app/camera/camera.component.scss index 530d0027..6e3c8418 100644 --- a/frontend/src/app/camera/camera.component.scss +++ b/frontend/src/app/camera/camera.component.scss @@ -90,7 +90,7 @@ $top-bottom-color: #202221; } .previewImg { - max-height: calc(100svh - 140px); + max-height: calc(100svh - 265px); width: 80svw; height: 80svh; object-fit: contain; @@ -156,4 +156,12 @@ $top-bottom-color: #202221; .flipButton { margin: auto; +} + +.slider{ + width:100%; +} +.editImage{ + margin: auto; + width: 50%; } \ No newline at end of file diff --git a/frontend/src/app/camera/camera.component.ts b/frontend/src/app/camera/camera.component.ts index 762153c5..9f2e2bf9 100644 --- a/frontend/src/app/camera/camera.component.ts +++ b/frontend/src/app/camera/camera.component.ts @@ -14,6 +14,7 @@ export class CameraComponent { @ViewChild('videoElement', { static: false }) videoElement!: ElementRef; sysImage = ''; + originalImage = ''; public sidebarVisible = false; assetName: string = ''; videoRef: any; @@ -24,7 +25,8 @@ export class CameraComponent { flipCamera: boolean = false; cameraAvailable: boolean = false; settingCamera: boolean = false; - + contrastValue: number = 0; + brightnessValue: number = 100; constructor( private elementRef: ElementRef, private assetService: AssetService, @@ -59,7 +61,7 @@ export class CameraComponent { } setupCamera() { - this.settingCamera=true; + this.settingCamera = true; if (!navigator.mediaDevices || !navigator.mediaDevices.getUserMedia) { console.error("getUserMedia is not supported in this browser."); this.cameraAvailable = false; @@ -76,7 +78,7 @@ export class CameraComponent { // Access granted, display the camera stream this.cameraAvailable = true; this.videoRef.srcObject = stream; - this.settingCamera=false; + this.settingCamera = false; }) .catch((error) => { // Handle errors and permission denial @@ -89,15 +91,14 @@ export class CameraComponent { disableCamera() { - if(this.settingCamera){ - let interval=setInterval(() => { + if (this.settingCamera) { + let interval = setInterval(() => { try { this.videoRef.srcObject .getTracks() .forEach((track: { stop: () => any }) => track.stop()); clearInterval(interval); } catch (e) { - // console.log(e); } }, 1000); } @@ -106,7 +107,6 @@ export class CameraComponent { .getTracks() .forEach((track: { stop: () => any }) => track.stop()); } catch (e) { - // console.log(e); } } @@ -126,6 +126,7 @@ export class CameraComponent { const dataUrl = canvas.toDataURL('image/jpeg', 1); // Adjust the quality (0.0 to 1.0) this.sysImage = dataUrl; + this.originalImage = dataUrl; this.captured = true; } @@ -164,4 +165,84 @@ export class CameraComponent { } } + async adjustContrast(dataImage: string): Promise { + return new Promise((resolve) => { + const canvas = document.createElement('canvas'); + const ctx = canvas.getContext('2d'); + if (ctx) { + const img = new Image(); + img.src = dataImage; + img.onload = () => { + canvas.width = img.width; + canvas.height = img.height; + ctx.drawImage(img, 0, 0, img.width, img.height); + const imageData = ctx.getImageData(0, 0, canvas.width, canvas.height); + const data = imageData.data; + + // Adjust contrast + const factor = (259 * (this.contrastValue + 255)) / (255 * (259 - this.contrastValue)); + for (let i = 0; i < data.length; i += 4) { + data[i] = this.clamp(factor * (data[i] - 128) + 128); + data[i + 1] = this.clamp(factor * (data[i + 1] - 128) + 128); + data[i + 2] = this.clamp(factor * (data[i + 2] - 128) + 128); + } + + ctx.putImageData(imageData, 0, 0); + resolve(canvas.toDataURL()); + }; + } else { + resolve(dataImage); // Return the original dataURL if the canvas context cannot be obtained + } + }); + } + + + async adjustBrightness(dataImage: string): Promise { + return new Promise((resolve) => { + const canvas = document.createElement('canvas'); + const ctx = canvas.getContext('2d'); + if (ctx) { + const img = new Image(); + img.src = dataImage; + img.onload = () => { + canvas.width = img.width; + canvas.height = img.height; + ctx.drawImage(img, 0, 0, img.width, img.height); + const imageData = ctx.getImageData(0, 0, canvas.width, canvas.height); + const data = imageData.data; + + // Adjust brightness + const factor = (this.brightnessValue - 100) / 100; // Calculate the brightness factor + for (let i = 0; i < data.length; i += 4) { + data[i] = this.clamp(data[i] + 255 * factor); + data[i + 1] = this.clamp(data[i + 1] + 255 * factor); + data[i + 2] = this.clamp(data[i + 2] + 255 * factor); + } + + ctx.putImageData(imageData, 0, 0); + resolve(canvas.toDataURL()); + }; + } else { + resolve(dataImage); // Return the original dataURL if the canvas context cannot be obtained + } + }); + } + + + async applyFilters() { + const contrastImage = await this.adjustBrightness(this.originalImage); + const brightnessImage = await this.adjustContrast(contrastImage); + this.sysImage = brightnessImage; + } + + clamp(value: number, min = 0, max = 255): number { + return Math.min(max, Math.max(min, value)); + } + + resetFilters() { + this.contrastValue = 0; + this.brightnessValue = 100; + this.sysImage = this.originalImage; + } + } diff --git a/frontend/src/app/edit/edit.component.html b/frontend/src/app/edit/edit.component.html index ea3901c6..8b094f69 100644 --- a/frontend/src/app/edit/edit.component.html +++ b/frontend/src/app/edit/edit.component.html @@ -1,9 +1,14 @@
- + +
-
+
- +
-
+
@@ -39,7 +54,7 @@ [(visible)]="exportDialogVisible" [focusOnShow]="true" [modal]="true" - [style]="{ width: '50vw', minWidth: 'min(500px,100vw)' }" + [style]="{ width: '50vw', minWidth: 'min(500px,100vw)' }" >
@@ -77,7 +92,11 @@
-
+
@@ -106,21 +125,48 @@
-->
- +
-
+

Assets

-
+

History

-
- +
+
@@ -128,7 +174,11 @@

Assets

History

-
+
History
- -

- Camera -

+ +

Camera

- -

- Upload -

+ +

Upload

@@ -163,13 +217,29 @@

History

- - -
- +
+
-
- +
+
@@ -178,13 +248,41 @@

History

+

+ No Assets Available +

+
+ +
-

No Assets Available

-
- -
-
-
+
+
+ +
+
@@ -201,7 +299,12 @@

History

/>
-
+
History />
-
+
History />
-
+
- -
+ +
History
- -

{{ capitalizeFirstLetter(obj.Format) }}

+

+ {{ capitalizeFirstLetter(obj.Format) }} +

{{ formatDate(obj.DateCreated) }}

@@ -247,24 +365,70 @@

History

-
-

{{obj.name}}

-

{{obj.date}}

- - +
+
+ + + +

{{obj.LastModifiedString}}

+ +
+
+
+ + +

{{ diffObj.LastModifiedString }}

+ + +
+
-
- -
-
-
+
+

@@ -279,7 +443,7 @@

History

header="Extracted Text:" [(visible)]="textCopyDialog" [modal]="true" - [style]="{ width: '50vw', minWidth: 'min(500px,100vw)' }" + [style]="{ width: '50vw', minWidth: 'min(500px,100vw)' }" [focusOnShow]="true" >
@@ -293,5 +457,5 @@

History

/>
-

No text detected :(

+

No text detected :(

diff --git a/frontend/src/app/edit/edit.component.scss b/frontend/src/app/edit/edit.component.scss index d2c32e52..c8aef93c 100644 --- a/frontend/src/app/edit/edit.component.scss +++ b/frontend/src/app/edit/edit.component.scss @@ -736,10 +736,11 @@ Preserve the relative scale, though. */ color: #000 } +.diffObject, .historyObject { transition: 0.2s; display: grid; - grid-template-columns: 2fr 2fr 1fr; + grid-template-columns: 0.5fr 0.5fr 3.5fr 0.5fr; justify-content: space-around; width: $sidebar-content-width; border-radius: 8px; @@ -755,12 +756,18 @@ Preserve the relative scale, though. */ user-select: none; } +.diffObject:hover, .historyObject:hover { cursor: pointer; // scale: 1.1; background-color: darken($light-grey, 10%); } +.diffObject{ + margin-left: 20px; + grid-template-columns:0.5fr 2fr 0.5fr; +} + .selectedHistory { background-color: #dfd; } @@ -769,7 +776,8 @@ Preserve the relative scale, though. */ background-color: #dfd; } -.historyIcon { +.historyIcon, +.snapshotIcon { margin: 0; margin: auto 0; width: 30px; @@ -783,4 +791,25 @@ Preserve the relative scale, though. */ cursor: pointer; background-color: #ddf; transition: 0.5s; +} + +.dropdownArrow { + transition: transform 0.3s ease; + margin: 0; + margin: auto 0; + width: 20px; + height: 20px; + padding: 4px; + + border-radius: 5px; +} + +.dropdownArrow:hover { + cursor: pointer; + background-color: #ddf; +} + +.dropdownArrow.expanded { + transform: rotate(90deg); + /* Rotate 180 degrees when expanded */ } \ No newline at end of file diff --git a/frontend/src/app/edit/edit.component.ts b/frontend/src/app/edit/edit.component.ts index 90966930..c5ec5d15 100644 --- a/frontend/src/app/edit/edit.component.ts +++ b/frontend/src/app/edit/edit.component.ts @@ -4,10 +4,10 @@ import { ElementRef, HostListener, OnInit, - ViewChild, + Inject, } from '@angular/core'; import { Router } from '@angular/router'; -import { MenuItem } from 'primeng/api'; +import { MenuItem, MessageService, ConfirmationService } from 'primeng/api'; import { FileUploadPopupComponent } from '../file-upload-popup/file-upload-popup.component'; import { ImageUploadPopupComponent } from '../image-upload-popup/image-upload-popup.component'; import { Clipboard } from '@angular/cdk/clipboard'; @@ -15,15 +15,14 @@ import { DialogService } from 'primeng/dynamicdialog'; import { FileService } from '../services/file.service'; import { EditService } from '../services/edit.service'; import { AssetService } from '../services/asset.service'; -import { Inject } from '@angular/core'; -import { MessageService } from 'primeng/api'; -import { set } from 'cypress/types/lodash'; -import { PageBreak } from '@ckeditor/ckeditor5-page-break'; +import { VersionControlService } from '../services/version.control.service'; +import { VersioningApiService } from '../services/versioning-api.service'; import html2pdf from 'html2pdf.js/dist/html2pdf'; import DecoupledEditor from '@ckeditor/ckeditor5-build-decoupled-document'; -import { parse } from 'path'; +import { SnapshotDTO } from '../services/dto/snapshot.dto'; +import { DiffDTO } from '../services/dto/diff.dto'; @Component({ selector: 'app-edit', @@ -55,12 +54,35 @@ export class EditComponent implements AfterViewInit, OnInit { private editService: EditService, private assetService: AssetService, private clipboard: Clipboard, - private messageService: MessageService + private messageService: MessageService, + private versionControlService: VersionControlService, + private confirmationService: ConfirmationService, + private versioningApiService: VersioningApiService ) {} @HostListener('window:beforeunload', ['$event']) beforeUnloadHandler(event: BeforeUnloadEvent) { - this.saveDocumentContents(); + if (this.editService.getContent() !== '') this.saveDocumentContents(); + } + + @HostListener('window:mousewheel', ['$event']) + onMouseWheel(event: WheelEvent) { + if (event.shiftKey) { + if (event.deltaY > 0) { + this.zoomOut(); + } else { + this.zoomIn(); + } + } + } + + @HostListener('window:keydown', ['$event']) + onKeyDown(event: KeyboardEvent) { + // Check if the Ctrl key is pressed and the 's' key (or 'S') is pressed simultaneously + if (event.ctrlKey && (event.key === 's' || event.key === 'S')) { + event.preventDefault(); + this.saveDocumentContents(); + } } showImageUploadPopup(): void { @@ -84,7 +106,6 @@ export class EditComponent implements AfterViewInit, OnInit { } async ngOnInit(): Promise { - this.speedDialItems = [ { icon: 'pi pi-pencil', @@ -116,10 +137,9 @@ export class EditComponent implements AfterViewInit, OnInit { ]; //get window width - this.isTouchScreen=window.matchMedia('(pointer: coarse)').matches; + this.isTouchScreen = window.matchMedia('(pointer: coarse)').matches; const width = window.innerWidth; - if (width < 800) - this.hideSideBar(); + if (width < 800) this.hideSideBar(); const c = localStorage.getItem('content'); const m = localStorage.getItem('markdownID'); const n = localStorage.getItem('name'); @@ -127,21 +147,83 @@ export class EditComponent implements AfterViewInit, OnInit { const pf = localStorage.getItem('parentFolderID'); const sl = localStorage.getItem('safeLock'); const dp = localStorage.getItem('encryptedDocumentPassword'); - - if (c != null && m != null && n != null && p != null && pf != null && sl != null && dp != null) - this.editService.setAll(c, m, n, p, pf, sl === 'true', this.editService.decryptPassword(dp)); + this.versionControlService.setLatestVersionContent(c ? (c as string) : ''); + + if ( + c != null && + m != null && + n != null && + p != null && + pf != null && + sl != null && + dp != null + ) + this.editService.setAll( + c, + m, + n, + p, + pf, + sl === 'true', + this.editService.decryptPassword(dp) + ); this.fileName = this.editService.getName(); - this.history.push({ name: 'Latest', date: 'now', html: this.editService.getContent(), id: 'LATEST', isCurrent: true }); - this.history.push({name: 'Version 7', date: '01-01-1977', html: '', id: '8'}); - this.history.push({name: 'Version 6', date: '01-01-1976', html: '

Text added from V0 to V1.

More Text added from V1 to V2.

Addition from V3 to V4

', id: '7'}); - this.history.push({ name: 'Version 5', date: '01-01-1975', html: '

Text to be removed soon.

Text added from V0 to V1.

More Text added from V1 to V2.

Addition from V3 to V4

', id: '6' }); - this.history.push({ name: 'Version 4', date: '01-01-1974', html: '

Text to be removed soon.

Text added from V0 to V1.

More Text added from V1 to V2.

Addition from V3 to V4

', id: '5' }); - this.history.push({ name: 'Version 3', date: '01-01-1973', html: '

Text to be removed soon.

Text added from V0 to V1.

More Text added from V1 to V2.

', id: '4' }); - this.history.push({ name: 'Version 2', date: '01-01-1972', html: '

Text added from V0 to V1.

More Text added from V1 to V2.

', id: '3' }); - this.history.push({ name: 'Version 1', date: '01-01-1971', html: '

Text added from V0 to V1.

', id: '2' }); - this.history.push({ name: 'Version 0', date: '01-01-1970', html: '', id: '1' }); - + this.history.push({ + name: 'Latest', + date: 'now', + html: this.editService.getContent(), + id: 'LATEST', + isCurrent: true, + }); + this.history.push({ + name: 'Version 7', + date: '01-01-1977', + html: '', + id: '8', + }); + this.history.push({ + name: 'Version 6', + date: '01-01-1976', + html: '

Text added from V0 to V1.

More Text added from V1 to V2.

Addition from V3 to V4

', + id: '7', + }); + this.history.push({ + name: 'Version 5', + date: '01-01-1975', + html: '

Text to be removed soon.

Text added from V0 to V1.

More Text added from V1 to V2.

Addition from V3 to V4

', + id: '6', + }); + this.history.push({ + name: 'Version 4', + date: '01-01-1974', + html: '

Text to be removed soon.

Text added from V0 to V1.

More Text added from V1 to V2.

Addition from V3 to V4

', + id: '5', + }); + this.history.push({ + name: 'Version 3', + date: '01-01-1973', + html: '

Text to be removed soon.

Text added from V0 to V1.

More Text added from V1 to V2.

', + id: '4', + }); + this.history.push({ + name: 'Version 2', + date: '01-01-1972', + html: '

Text added from V0 to V1.

More Text added from V1 to V2.

', + id: '3', + }); + this.history.push({ + name: 'Version 1', + date: '01-01-1971', + html: '

Text added from V0 to V1.

', + id: '2', + }); + this.history.push({ + name: 'Version 0', + date: '01-01-1970', + html: '', + id: '1', + }); } ngAfterViewInit() { @@ -227,6 +309,7 @@ export class EditComponent implements AfterViewInit, OnInit { this.elementRef.nativeElement.ownerDocument.body.style.backgroundColor = '#E3E3E3'; this.elementRef.nativeElement.ownerDocument.body.style.overflow = 'hidden'; + this.refreshSidebarHistory(); this.refreshSidebar(); } @@ -246,27 +329,69 @@ export class EditComponent implements AfterViewInit, OnInit { this.router.navigate(['/camera'], { state: data }); } - saveDocumentContents() { + exitToHome() { + this.confirmationService.confirm({ + message: 'Do you want to save before you leave?', + header: 'Save Confirmation', + icon: 'pi pi-exclamation-triangle', + acceptLabel: 'Exit and Save', + rejectLabel: 'Exit without Saving', + accept: () => { + this.editService.setContent(this.editor.getData()); + this.saveDocumentContents(); + this.router.navigate(['/home']); + }, + reject: (type: any) => { + if (type === 1) this.router.navigate(['/home']); + }, + }); + } + + async saveDocumentContents() { // Save the document quill content to localStorage when changes occur // const editableArea: HTMLElement = this.elementRef.nativeElement.querySelector('.document-editor__editable'); + let contents = this.editor.getData(); let pass = this.editService.getDocumentPassword(); - if(pass != '' && pass != undefined) { - this.fileService.saveDocument( + + const latestVersionContent = + this.versionControlService.getLatestVersionContent(); + + const readablePatch = this.versionControlService.getReadablePatch( + latestVersionContent, + contents + ); + const markdownID = this.editService.getMarkdownID(); + localStorage.setItem('content', contents); + if (pass != '' && pass != undefined) { + await this.fileService.saveDocument( this.fileService.encryptSafeLockDocument(contents, pass), this.editService.getMarkdownID(), this.editService.getPath(), this.editService.getSafeLock() + ); + + if (readablePatch !== '') + this.versioningApiService.saveDiff( + markdownID ? (markdownID as string) : '', + this.fileService.encryptSafeLockDocument(readablePatch, pass) ); - } - else { - this.fileService.saveDocument( + } else { + await this.fileService.saveDocument( contents, this.editService.getMarkdownID(), this.editService.getPath(), this.editService.getSafeLock() + ); + + if (readablePatch !== '') + this.versioningApiService.saveDiff( + markdownID ? (markdownID as string) : '', + readablePatch ); } + + this.versionControlService.setLatestVersionContent(contents); } hideSideBar() { @@ -305,6 +430,7 @@ export class EditComponent implements AfterViewInit, OnInit { .then((Boolean) => { if (Boolean) { this.editService.setName(this.fileName); + localStorage.setItem('name', this.fileName as string); } }); } @@ -455,6 +581,7 @@ export class EditComponent implements AfterViewInit, OnInit { detail: 'Asset deleted', }); this.assets.splice(currAssetIndex, 1); + if(this.assets.length === 0) this.noAssetsAvailable = true; } else { this.assets[currAssetIndex].Deleted = false; } @@ -485,7 +612,69 @@ export class EditComponent implements AfterViewInit, OnInit { } async refreshSidebarHistory() { - console.log('refreshing history'); + this.history = []; + this.versioningApiService + .retrieveAllHistory(this.editService.getMarkdownID() as string) + .then((data) => { + const snapshot = JSON.parse( + JSON.stringify(data.SnapshotHistory) + ) as SnapshotDTO[]; + const diff = JSON.parse(JSON.stringify(data.DiffHistory)) as DiffDTO[]; + + snapshot.sort((a, b) => { + return a.LastModified < b.LastModified + ? 1 + : a.LastModified > b.LastModified + ? -1 + : 0; + }); + + snapshot.forEach((a, i) => { + a.LastModifiedString = this.formatDate(a.LastModified); + a.OrderNumber = i + 1; + a.Name = 'Snapshot ' + a.OrderNumber; + a.ChildDiffs = []; + for (let j = 0; j < diff.length; j++) { + if (a.SnapshotID === diff[j].SnapshotID) { + a.ChildDiffs.push(diff[j]); + diff[j].LastModifiedString = this.formatDate( + diff[j].LastModified + ); + diff[j].HasSnapshot = true; + } + } + }); + snapshot.forEach((a) => + a.ChildDiffs.sort((a, b) => { + return a.LastModified < b.LastModified + ? 1 + : a.LastModified > b.LastModified + ? -1 + : 0; + }).forEach((a, i, arr) => { + a.VersionNumber = arr.length - i + 1; + a.Name = 'Version ' + a.VersionNumber; + }) + ); + + let diffNumber = 0; + let currentSnapshot = new SnapshotDTO(); + currentSnapshot.ChildDiffs = []; + for (let i = 0; i < diff.length; i++) { + if (!diff[i].HasSnapshot) { + diff[i].LastModifiedString = this.formatDate(diff[i].LastModified); + diff[i].VersionNumber = ++diffNumber; + diff[i].Name = 'Diff ' + diff[i].VersionNumber; + currentSnapshot.ChildDiffs.push(diff[i]); + } + } + currentSnapshot.Name = 'Latest'; + currentSnapshot.LastModifiedString = 'now'; + this.history.push(currentSnapshot); + snapshot.forEach((a) => this.history.push(a)); + + console.log(this.history); + }); } pageBreak() { @@ -569,17 +758,23 @@ export class EditComponent implements AfterViewInit, OnInit { return inputString.charAt(0).toUpperCase() + inputString.slice(1); } - formatDate(dateString: string): string { - if (!dateString || dateString.length === 0) { - return dateString; // Return the input string as-is if it's empty or null. - } - + formatDate(dateString: Date): string { + const months = [ + 'January', 'February', 'March', 'April', 'May', 'June', + 'July', 'August', 'September', 'October', 'November', 'December' + ]; + if(!dateString) return ''; const date = new Date(dateString); - const year = date.getFullYear().toString(); - const month = (date.getMonth() + 1).toString().padStart(2, '0'); - const day = date.getDate().toString().padStart(2, '0'); - return `${year}-${month}-${day}`; + const dd = String(date.getDate()).padStart(2, '0'); + const mm = date.getMonth() ; // January is 0! + const yyyy = date.getFullYear(); + + const hh = String(date.getHours()).padStart(2, '0'); + const min = String(date.getMinutes()).padStart(2, '0'); + const ss = String(date.getSeconds()).padStart(2, '0'); + + return `${dd} ${months[mm]}, ${hh}:${min}:${ss}`; } enableReadOnly() { @@ -591,20 +786,54 @@ export class EditComponent implements AfterViewInit, OnInit { } insertContent(obj: any) { + + console.log("Just clicked on: " , obj); + if(!obj.Content) return; this.deselectAllHistory(); obj.isCurrent = true; - if(obj.id === 'LATEST') { + if (obj.Name === 'Latest') { this.disableReadOnly(); - this.editor.setData(obj.html); + this.editor.setData(obj.Content); return; } this.enableReadOnly(); - this.editor.setData(obj.html); + this.editor.setData(obj.Content); } deselectAllHistory() { - for(let i = 0; i < this.history.length; i++) { + for (let i = 0; i < this.history.length; i++) { this.history[i].isCurrent = false; } } + + expandSnapshot(snapshot: any, event: any) { + if (snapshot.expanded) { + snapshot.expanded = false; + } else { + snapshot.expanded = true; + } + + const arrowElement = event.target; + + arrowElement.classList.toggle('expanded'); + + event.stopPropagation(); + + //retrieve all diff content and previous snapshot content + this.versioningApiService.loadHistorySet(this.editService.getMarkdownID() as string, snapshot.ChildDiffs, snapshot.snapshotID).then((data) => { + if(data !== null){ + console.log("Process diff data.", data); + snapshot.Content =data.SnapshotHistory[0].Content; + + } + else { + this.messageService.add({ + severity: 'error', + summary: 'Error', + detail: 'Error retrieving history set', + }); + return; + } + }); + } } diff --git a/frontend/src/app/home/home.component.html b/frontend/src/app/home/home.component.html index 2ef41aa7..b68af925 100644 --- a/frontend/src/app/home/home.component.html +++ b/frontend/src/app/home/home.component.html @@ -1,3 +1,8 @@ + +
+ Loading... +
+
diff --git a/frontend/src/app/home/home.component.scss b/frontend/src/app/home/home.component.scss index 282a7820..f2bd5935 100644 --- a/frontend/src/app/home/home.component.scss +++ b/frontend/src/app/home/home.component.scss @@ -573,4 +573,24 @@ $icon-size: 1.5rem; flex-direction: column; justify-content: center; align-items: center; +} + +/* CSS */ +.loading-overlay { + position: fixed; + top: 0; + left: 0; + width: 100%; + height: 100%; + background-color: rgba(0, 0, 0, 0.5); + /* Adjust the alpha value for transparency */ + display: flex; + justify-content: center; + align-items: center; + z-index: 9999; + /* Adjust the z-index to be on top of everything */ +} + +.loadingIcon { + width:10%; } \ No newline at end of file diff --git a/frontend/src/app/home/home.component.ts b/frontend/src/app/home/home.component.ts index 20e88efd..1668c649 100644 --- a/frontend/src/app/home/home.component.ts +++ b/frontend/src/app/home/home.component.ts @@ -1133,7 +1133,6 @@ export class HomeComponent implements OnInit, AfterViewInit { // @HostListener('document:keydown.enter', ['$event']) // handleEnterKeyPress(event: KeyboardEvent) { // const selected = this.getSelected(); - // console.log(selected); // if (selected.length === 1) { // if (selected[0].Type === 'file') { // this.onOpenFileSelect(selected[0].MarkdownID); @@ -1147,7 +1146,6 @@ export class HomeComponent implements OnInit, AfterViewInit { // @HostListener('document:keydown.delete', ['$event']) // handleDeleteKeyPress(event: KeyboardEvent) { // const selected = this.getSelected(); - // console.log(selected); // if (selected.length === 1) { // this.deleteSelectedEntity(selected[0]); // } @@ -1594,9 +1592,7 @@ export class HomeComponent implements OnInit, AfterViewInit { } let count = 0; for (let i = j; i < x.length; i++) { - console.log(i); setTimeout(() => { - console.log(startSelecting); const element = x[i]; if (element === this.shiftClickStart || element === node) { startSelecting = !startSelecting; @@ -1752,7 +1748,6 @@ export class HomeComponent implements OnInit, AfterViewInit { } out(x: number) { - console.log(x); } async lockDocument() { diff --git a/frontend/src/app/login/login.component.ts b/frontend/src/app/login/login.component.ts index 68927572..d7e719c1 100644 --- a/frontend/src/app/login/login.component.ts +++ b/frontend/src/app/login/login.component.ts @@ -6,6 +6,7 @@ import { MessageService } from 'primeng/api'; import { environment } from 'src/environments/environment'; import { CredentialResponse, PromptMomentNotification } from 'google-one-tap'; +import { VersionControlService } from '../services/version.control.service'; // import { HttpClient, HttpHeaders } from '@angular/common/http'; @@ -33,7 +34,8 @@ export class LoginComponent { private elementRef: ElementRef, private userService: UserService, @Inject(ActivatedRoute) private route: ActivatedRoute, - private messageService: MessageService + private messageService: MessageService, + private versionControlService: VersionControlService ) {} ngOnInit(): void { const data = history.state; @@ -110,6 +112,8 @@ export class LoginComponent { this.navigateToPage('home'); } } + + // await this.versionControlService.init(); } async autoLogin(): Promise { @@ -172,7 +176,6 @@ export class LoginComponent { // // (document.getElementsByClassName('backgroundImage')[0] as HTMLElement).style.backgroundImage= 'radial-gradient(at ' + mouseXpercentage + '% ' + mouseYpercentage + '%, #3498db, #9b59b6)'; // (document.getElementsByClassName('backgroundImage')[0] as HTMLElement).style.backgroundImage = // 'radial-gradient(at ' + mouseXpercentage + '% ' + mouseYpercentage + '%, rgb(100 100 100 / 70%), rgb(100 100 100 / 70%)), url(/assets/MockData/BGIW.jpg)'; - // console.log('radial-gradient(at ' + mouseXpercentage + '% ' + mouseYpercentage + '%, rgb(100 100 100 / 70%), rgb(100 100 100 / 70%)), url(/assets/MockData/BGIW.jpg)'); } isValidPassword(password: string): boolean { diff --git a/frontend/src/app/services/dto/diff.dto.ts b/frontend/src/app/services/dto/diff.dto.ts index 416a110c..fa44912d 100644 --- a/frontend/src/app/services/dto/diff.dto.ts +++ b/frontend/src/app/services/dto/diff.dto.ts @@ -1,13 +1,29 @@ export class DiffDTO { - fileID: string; - diffNumber: number; - snapshotNumber: number; - content: string; + UserID: number; + MarkdownID: string; + DiffNumber: number; + SnapshotNumber: number; + Content: string; + SnapshotPayload: string; + LastModified: Date; + LastModifiedString: string; + Name: string; + SnapshotID: string; + VersionNumber: number; + HasSnapshot: boolean; constructor() { - this.fileID = ''; - this.diffNumber = 0; - this.snapshotNumber = 0; - this.content = ''; + this.UserID = 0; + this.MarkdownID = ''; + this.DiffNumber = 0; + this.SnapshotNumber = 0; + this.Content = ''; + this.SnapshotPayload = ''; + this.LastModified = new Date(); + this.LastModifiedString = ''; + this.Name = ''; + this.SnapshotID = ''; + this.VersionNumber = 0; + this.HasSnapshot = false; } } diff --git a/frontend/src/app/services/dto/file.dto.ts b/frontend/src/app/services/dto/file.dto.ts deleted file mode 100644 index 2dbbdef9..00000000 --- a/frontend/src/app/services/dto/file.dto.ts +++ /dev/null @@ -1,9 +0,0 @@ -export class FileDTO { - fileID: string; - content: string; - - constructor() { - this.fileID = ''; - this.content = ''; - } -} diff --git a/frontend/src/app/services/dto/snapshot.dto.ts b/frontend/src/app/services/dto/snapshot.dto.ts index bd10d116..e7346b97 100644 --- a/frontend/src/app/services/dto/snapshot.dto.ts +++ b/frontend/src/app/services/dto/snapshot.dto.ts @@ -1,11 +1,29 @@ +import { DiffDTO } from './diff.dto'; + export class SnapshotDTO { - fileID: string; - snapshotNumber: number; - content: string; + SnapshotID: string; + UserID: number; + MarkdownID: string; + SnapshotNumber: number; + Content: string; + OldestSnapshot: boolean; + LastModified: Date; + LastModifiedString: string; + Name: string; + ChildDiffs: DiffDTO[]; + OrderNumber: number; constructor() { - this.fileID = ''; - this.snapshotNumber = 0; - this.content = ''; + this.SnapshotID = ''; + this.UserID = 0; + this.MarkdownID = ''; + this.SnapshotNumber = 0; + this.Content = ''; + this.OldestSnapshot = false; + this.LastModified = new Date(); + this.LastModifiedString = ''; + this.Name = ''; + this.ChildDiffs = []; + this.OrderNumber = 0; } } diff --git a/frontend/src/app/services/dto/version.dto.ts b/frontend/src/app/services/dto/version.dto.ts new file mode 100644 index 00000000..4cb051cf --- /dev/null +++ b/frontend/src/app/services/dto/version.dto.ts @@ -0,0 +1,13 @@ +export class VersionDTO { + MarkdownID: string; + IsDiff: boolean; + Content: string; + PrevContent: string; + + constructor() { + this.MarkdownID = ''; + this.IsDiff = true; + this.Content = ''; + this.PrevContent = ''; + } +} diff --git a/frontend/src/app/services/dto/version_set.dto.ts b/frontend/src/app/services/dto/version_set.dto.ts new file mode 100644 index 00000000..3fa7e03c --- /dev/null +++ b/frontend/src/app/services/dto/version_set.dto.ts @@ -0,0 +1,13 @@ +export class VersionSetDTO { + UserID: number; + MarkdownID: string; + DiffHistory: string[]; + SnapshotID: string; + + constructor() { + this.UserID = 0; + this.MarkdownID = ''; + this.DiffHistory = []; + this.SnapshotID = ''; + } +} diff --git a/frontend/src/app/services/folder.service.ts b/frontend/src/app/services/folder.service.ts index 5127c91f..f756c6d9 100644 --- a/frontend/src/app/services/folder.service.ts +++ b/frontend/src/app/services/folder.service.ts @@ -210,11 +210,9 @@ export class FolderService { path: string | undefined, folderName: string ): Promise { - // console.log(folderID+" "+path+" "+folderName); return new Promise((resolve, reject) => { this.sendRenameData(folderID, path, folderName).subscribe({ next: (response: HttpResponse) => { - // console.log(response); if (response.status === 200) { this.messageService.add({ severity: 'success', diff --git a/frontend/src/app/services/user.service.ts b/frontend/src/app/services/user.service.ts index 78303053..e680c196 100644 --- a/frontend/src/app/services/user.service.ts +++ b/frontend/src/app/services/user.service.ts @@ -200,7 +200,6 @@ export class UserService { this.hashPassword(newPassword, salt) ).subscribe({ next: (response: HttpResponse) => { - // console.log('forgotPass response: ', response); if (response.status === 200) { this.messageService.add({ severity: 'success', @@ -386,7 +385,6 @@ export class UserService { return new Promise(async (resolve, reject) => { this.sendPasswordResetData(token, password, salt).subscribe({ next: (response: HttpResponse) => { - console.log(response); if (response.status === 200) { this.messageService.add({ severity: 'success', @@ -482,7 +480,6 @@ export class UserService { this.sendRefreshTokenRequest().subscribe({ next: (response: HttpResponse) => { if (response.status === 200) { - // console.log(response); this.authToken = response.body.Token; this.expiresAt = this.jwtHelper.decodeToken( response.body.Token diff --git a/frontend/src/app/services/version.control.service.ts b/frontend/src/app/services/version.control.service.ts index 6cf7787e..ce56e2d4 100644 --- a/frontend/src/app/services/version.control.service.ts +++ b/frontend/src/app/services/version.control.service.ts @@ -1,22 +1,37 @@ import { Injectable } from '@angular/core'; import { UserService } from './user.service'; -// import DiffMatchPatch from 'diff-match-patch'; -import { Diff, diff_match_patch as DiffMatchPatch } from 'diff-match-patch'; -import { HttpClient } from '@angular/common/http'; +import { diff_match_patch as DiffMatchPatch } from 'diff-match-patch'; + +import { HttpClient, HttpHeaders } from '@angular/common/http'; +import { Observable } from 'rxjs'; +import { HttpResponse } from '@angular/common/http'; +import { MessageService } from 'primeng/api'; +import { environment } from '../../environments/environment'; + import { DiffDTO } from './dto/diff.dto'; import { SnapshotDTO } from './dto/snapshot.dto'; -import { FileDTO } from './dto/file.dto'; +import { MarkdownFileDTO } from './dto/markdown_file.dto'; import { FileService } from './file.service'; +import { VersionDTO } from './dto/version.dto'; +import { VersionSetDTO } from './dto/version_set.dto'; @Injectable({ providedIn: 'root', }) export class VersionControlService { - constructor(private http: HttpClient, private fileService: FileService) {} + constructor( + private http: HttpClient, + private fileService: FileService, + private messageService: MessageService, + private userService: UserService + ) {} public snapshotArr: SnapshotDTO[] = []; public diffArr: DiffDTO[] = []; + public versionArr: VersionDTO[] = []; + + private latestVersion: VersionDTO = new VersionDTO(); private DiffPatchService = new DiffMatchPatch(); // async test(): Promise { @@ -31,101 +46,203 @@ export class VersionControlService { // const diff = this.DiffPatchService.diff_main(text1, text2); // const patches = this.DiffPatchService.patch_make(diff); - // console.log(this.DiffPatchService.patch_toText(patches)); - // console.log(this.DiffPatchService.patch_apply(patches, text1)); // }); // }); // } - init(): void { - this.snapshotArr[0] = new SnapshotDTO(); - this.diffArr[0] = new DiffDTO(); + async init(): Promise { + this.snapshotArr = []; + this.diffArr = []; + this.versionArr = []; + + let text1: string = ''; + let text2: string = ''; + const diffPathArr: string[] = []; + diffPathArr.push('../assets/MockData/VersionControl/abc123_d1'); + diffPathArr.push('../assets/MockData/VersionControl/abc123_d2'); + diffPathArr.push('../assets/MockData/VersionControl/abc123_d3'); + diffPathArr.push('../assets/MockData/VersionControl/abc123_d4'); + + const snapshotPathArr: string[] = []; + snapshotPathArr.push('../assets/MockData/VersionControl/abc123_s0'); + + for (let element of snapshotPathArr) { + this.http.get(element, { responseType: 'text' }).subscribe((data) => { + var tempDTO = new SnapshotDTO(); + tempDTO.MarkdownID = 'abc123'; + tempDTO.SnapshotNumber = +element.charAt(element.length - 1); + tempDTO.Content = data; + this.pushToSnapshotArr(tempDTO); + }); + } + + for (let element of diffPathArr) { + this.http.get(element, { responseType: 'text' }).subscribe((data) => { + var tempDTO = new DiffDTO(); + tempDTO.MarkdownID = 'abc123'; + // tempDTO.snapshotNumber = this.snapshotArr[0].snapshotNumber; + tempDTO.Content = data; + this.pushToDiffArr(tempDTO); + }); + } + + await new Promise((f) => setTimeout(f, 10)); + + this.visualise(); } - createDiff(fileDTO: FileDTO): DiffDTO { - const latestSnapshot = this.getLatestSnapshot(); - let snapshotContent = latestSnapshot.content; + getDiffArr(): DiffDTO[] { + return this.diffArr; + } - const latestDiff = this.getLatestDiff(); // TODO: Check what we need when there are no diffs - const latestDiffNumber = latestDiff.diffNumber; + pushToDiffArr(element: DiffDTO): DiffDTO[] { + this.diffArr.push(element); + return this.diffArr; + } - // Get all relevant diffs - const relevantDiffs = this.diffArr.filter( - (a) => a.snapshotNumber === latestSnapshot.snapshotNumber - ); + getSnapshotArr(): SnapshotDTO[] { + return this.snapshotArr; + } - // Patch all relevant diffs - for (let diff of relevantDiffs) { - snapshotContent = this.patchDiff(snapshotContent, diff); - } + getLatestVersionContent(): string { + return this.latestVersion.Content; + } - // Create newest diff and readable patch - const diff = this.DiffPatchService.diff_main( - snapshotContent, - fileDTO.content - ); - const patches = this.DiffPatchService.patch_make(diff); - - // Create and set new DTO - const readableDiff = new DiffDTO(); - readableDiff.diffNumber = latestDiffNumber + 1; - readableDiff.fileID = fileDTO.fileID; - readableDiff.snapshotNumber = latestSnapshot.snapshotNumber; // TODO: Doesn't take into account squashing of diffs - readableDiff.content = this.DiffPatchService.patch_toText(patches); - return readableDiff; - } - - getLatestSnapshot(): SnapshotDTO { - // TODO: No need to sort - // Get latest snapshot - this.snapshotArr.sort((a, b) => - a.snapshotNumber > b.snapshotNumber + setLatestVersionContent(content: string) { + this.latestVersion.Content = content; + } + + pushToSnapshotArr(element: SnapshotDTO): SnapshotDTO[] { + this.snapshotArr.push(element); + return this.snapshotArr; + } + + sortSnapshotArr(inArr: SnapshotDTO[]): void { + // Ascending sort on snapshotNumber + inArr.sort((a, b) => + a.SnapshotNumber > b.SnapshotNumber ? 1 - : a.snapshotNumber < b.snapshotNumber + : a.SnapshotNumber < b.SnapshotNumber ? -1 : 0 ); - - return this.snapshotArr[0]; } - getLatestDiff(): DiffDTO { - // Get latest diff number - this.diffArr.sort((a, b) => - a.diffNumber > b.diffNumber ? 1 : a.diffNumber < b.diffNumber ? -1 : 0 + sortDiffArr(inArr: DiffDTO[]): void { + // Ascending sort on diffNumber + inArr.sort( + (a, b) => + a.DiffNumber > b.DiffNumber ? 1 : a.DiffNumber < b.DiffNumber ? -1 : 0 // TODO: Rework ); - - return this.diffArr[0]; } - patchDiff(content: string, diffDTO: DiffDTO): string { - const patches = this.DiffPatchService.patch_fromText(diffDTO.content); - const patchResult = this.DiffPatchService.patch_apply(patches, content); - return patchResult[0]; + visualise(): void { + // Build snapshot version + for (let element of this.snapshotArr) { + this.versionArr.push(this.buildSnapshotVersion(element)); + } + + // Build diff version + for (let element of this.diffArr) { + this.versionArr.push(this.buildDiffVersion(element, this.snapshotArr[0])); + } + + // Visualise snapshot + const snapshotVersions = this.versionArr.filter((ele) => { + return !ele.IsDiff; + }); + console.log(snapshotVersions); + + //Visualise diff + const diffVersions = this.versionArr.filter((ele) => { + return ele.IsDiff; + }); + + // Could optimise by saving pretty html somewhere on save + for (let element of diffVersions) { + let dpsDiff = this.DiffPatchService.diff_main( + element.PrevContent, + element.Content + ); + console.log(this.DiffPatchService.diff_prettyHtml(dpsDiff)); + } } - patchVersion(fileDTO: FileDTO, diffDTO: DiffDTO[]): string { - return ''; + buildSnapshotVersion(snapshot: SnapshotDTO): VersionDTO { + const tempDTO = new VersionDTO(); + + tempDTO.Content = snapshot.Content; + tempDTO.IsDiff = false; + tempDTO.MarkdownID = snapshot.MarkdownID; + tempDTO.PrevContent = ''; + + return tempDTO; } - patchSnapshot(fileDTO: FileDTO, snapshotDTO: SnapshotDTO): string { - return ''; + buildDiffVersion(diff: DiffDTO, snapshot: SnapshotDTO): VersionDTO { + const tempDTO = new VersionDTO(); + + tempDTO.IsDiff = true; + tempDTO.MarkdownID = diff.MarkdownID; + tempDTO.PrevContent = this.buildDiffContext(diff, snapshot); + + const patches = this.DiffPatchService.patch_fromText(diff.Content); + tempDTO.Content = this.DiffPatchService.patch_apply( + patches, + tempDTO.PrevContent + )[0]; + + return tempDTO; } - squashDiffs(diffDTOs: DiffDTO[]): SnapshotDTO { - const latestSnapshot = this.getLatestSnapshot(); - let snapshotContent = latestSnapshot.content; + buildDiffContext(diff: DiffDTO, snapshot: SnapshotDTO): string { + let retString = snapshot.Content; + + const tempArr = this.diffArr.filter((ele) => { + return ele.DiffNumber < diff.DiffNumber; // TODO: Rework + }); - // Patch all diffs - for (let diff of diffDTOs) { - snapshotContent = this.patchDiff(snapshotContent, diff); + this.sortDiffArr(tempArr); + + for (let element of tempArr) { + let patches = this.DiffPatchService.patch_fromText(element.Content); + retString = this.DiffPatchService.patch_apply(patches, retString)[0]; } - const newSnapshot = new SnapshotDTO(); - newSnapshot.content = snapshotContent; - newSnapshot.fileID = latestSnapshot.fileID; - newSnapshot.snapshotNumber = latestSnapshot.snapshotNumber + 1; + return retString; + } + + getReadablePatch(text1: string, text2: string): string { + const dpsDiff = this.DiffPatchService.diff_main(text1, text2); + const patches = this.DiffPatchService.patch_make(dpsDiff); + return this.DiffPatchService.patch_toText(patches); + } + + snapshotRestore(snapshot: SnapshotDTO): void { + //TODO: Rework + this.snapshotArr = this.snapshotArr.filter((ele) => { + return ele.SnapshotNumber <= snapshot.SnapshotNumber; + }); + + this.diffArr = this.diffArr.filter((ele) => { + return ele.SnapshotNumber <= snapshot.SnapshotNumber; + }); + + this.sortSnapshotArr(this.snapshotArr); + this.sortDiffArr(this.diffArr); + } + + diffRestore(diff: DiffDTO): void { + //TODO: Rework + this.snapshotArr = this.snapshotArr.filter((ele) => { + return ele.SnapshotNumber <= diff.SnapshotNumber; + }); + + this.diffArr = this.diffArr.filter((ele) => { + return ele.SnapshotNumber <= diff.SnapshotNumber; + }); - return newSnapshot; + this.sortSnapshotArr(this.snapshotArr); + this.sortDiffArr(this.diffArr); } } diff --git a/frontend/src/app/services/versioning-api.service.spec.ts b/frontend/src/app/services/versioning-api.service.spec.ts new file mode 100644 index 00000000..e811992d --- /dev/null +++ b/frontend/src/app/services/versioning-api.service.spec.ts @@ -0,0 +1,16 @@ +import { TestBed } from '@angular/core/testing'; + +import { VersioningApiService } from './versioning-api.service'; + +describe('VersioningApiService', () => { + let service: VersioningApiService; + + beforeEach(() => { + TestBed.configureTestingModule({}); + service = TestBed.inject(VersioningApiService); + }); + + it('should be created', () => { + expect(service).toBeTruthy(); + }); +}); diff --git a/frontend/src/app/services/versioning-api.service.ts b/frontend/src/app/services/versioning-api.service.ts new file mode 100644 index 00000000..b987430b --- /dev/null +++ b/frontend/src/app/services/versioning-api.service.ts @@ -0,0 +1,156 @@ +import { HttpClient, HttpHeaders, HttpResponse } from '@angular/common/http'; +import { Injectable } from '@angular/core'; +import { Observable } from 'rxjs'; +import { environment } from 'src/environments/environment'; +import { VersionSetDTO } from './dto/version_set.dto'; +import { UserService } from './user.service'; +import { DiffDTO } from './dto/diff.dto'; +import { SnapshotDTO } from './dto/snapshot.dto'; +import { MarkdownFileDTO } from './dto/markdown_file.dto'; + +@Injectable({ + providedIn: 'root' +}) +export class VersioningApiService { + + constructor( + private http: HttpClient, + private userService: UserService + ) { } + + saveDiff( + fileID: string, + content: string + ): Promise { + return new Promise((resolve, reject) => { + this.sendSaveDiff(fileID, content).subscribe({ + next: (response: HttpResponse) => { + if (response.status === 200) { + resolve(true); + } else { + resolve(false); + } + }, + }); + }); + } + + sendSaveDiff( + markdownID: string, + content: string + ): Observable> { + const environmentURL = environment.apiURL; + const url = `${environmentURL}version_control/save_diff`; + console.log(url); + const body = new DiffDTO(); + + body.UserID = this.userService.getUserID() as number; + body.Content = content; + body.MarkdownID = markdownID; + const headers = new HttpHeaders().set( + 'Authorization', + 'Bearer ' + this.userService.getAuthToken() + ); + console.log(body); + return this.http.post(url, body, { headers, observe: 'response' }); + } + + retrieveAllSnapshots(markdownID: string): Promise { + return new Promise((resolve, reject) => { + this.sendRetrieveAllSnapshots(markdownID).subscribe({ + next: (response: HttpResponse) => { + console.log(response); + if (response.status === 200) { + resolve(response.body); + } else { + resolve(null); + } + }, + }); + }); + } + + sendRetrieveAllSnapshots(markdownID: string): Observable> { + const environmentURL = environment.apiURL; + const url = `${environmentURL}version_control/get_all_snapshots`; + console.log(url); + const body = new SnapshotDTO(); + + body.UserID = this.userService.getUserID() as number; + body.MarkdownID = markdownID; + const headers = new HttpHeaders().set( + 'Authorization', + 'Bearer ' + this.userService.getAuthToken() + ); + return this.http.post(url, body, { headers, observe: 'response' }); + } + + retrieveAllHistory(markdownID: string): Promise { + return new Promise((resolve, reject) => { + this.sendRetrieveAllHistory(markdownID).subscribe({ + next: (response: HttpResponse) => { + console.log('Backend data response: ', response); + if (response.status === 200) { + resolve(response.body); + } else { + resolve(null); + } + }, + }); + }); + } + + sendRetrieveAllHistory(markdownID: string): Observable> { + const environmentURL = environment.apiURL; + const url = `${environmentURL}version_control/load_history`; + console.log(url); + const body = new MarkdownFileDTO(); + + body.UserID = this.userService.getUserID() as number; + body.MarkdownID = markdownID; + const headers = new HttpHeaders().set( + 'Authorization', + 'Bearer ' + this.userService.getAuthToken() + ); + return this.http.post(url, body, { headers, observe: 'response' }); + } + loadHistorySet( + markdownID: string, + diffHistory: string[], + snapshotID: string + ) { + return new Promise((resolve, reject) => { + this.sendLoadHistorySet(markdownID, diffHistory, snapshotID).subscribe({ + next: (response: HttpResponse) => { + console.log(response); + if (response.status === 200) { + resolve(response.body); + } else { + resolve(null); + } + }, + }); + }); + } + + sendLoadHistorySet( + markdownID: string, + diffHistory: string[], + snapshotID: string + ): Observable> { + const environmentURL = environment.apiURL; + const url = `${environmentURL}version_control/get_history_set`; + const body = new VersionSetDTO(); + + body.UserID = this.userService.getUserID() as number; + body.MarkdownID = markdownID; + body.DiffHistory = diffHistory; + body.SnapshotID = snapshotID; + const headers = new HttpHeaders().set( + 'Authorization', + 'Bearer ' + this.userService.getAuthToken() + ); + return this.http.post(url, body, { headers, observe: 'response' }); + } + +} diff --git a/frontend/src/assets/Icons/editIcons/diffArrow.png b/frontend/src/assets/Icons/editIcons/diffArrow.png new file mode 100644 index 00000000..374a3192 Binary files /dev/null and b/frontend/src/assets/Icons/editIcons/diffArrow.png differ diff --git a/frontend/src/assets/Icons/editIcons/snapshot.png b/frontend/src/assets/Icons/editIcons/snapshot.png new file mode 100644 index 00000000..fb635eab Binary files /dev/null and b/frontend/src/assets/Icons/editIcons/snapshot.png differ diff --git a/frontend/src/assets/MockData/VersionControl/abc123_d1 b/frontend/src/assets/MockData/VersionControl/abc123_d1 new file mode 100644 index 00000000..508c7604 --- /dev/null +++ b/frontend/src/assets/MockData/VersionControl/abc123_d1 @@ -0,0 +1,2 @@ +@@ -0,0 +1,66 @@ ++Hamlet: Do you see yonder cloud that's almost in shape of a camel? \ No newline at end of file diff --git a/frontend/src/assets/MockData/VersionControl/abc123_d2 b/frontend/src/assets/MockData/VersionControl/abc123_d2 new file mode 100644 index 00000000..7ba84a89 --- /dev/null +++ b/frontend/src/assets/MockData/VersionControl/abc123_d2 @@ -0,0 +1,3 @@ +@@ -59,8 +59,62 @@ + a camel? ++%0APolonius: By the mass, and 'tis like a camel, indeed. \ No newline at end of file diff --git a/frontend/src/assets/MockData/VersionControl/abc123_d3 b/frontend/src/assets/MockData/VersionControl/abc123_d3 new file mode 100644 index 00000000..55f51240 --- /dev/null +++ b/frontend/src/assets/MockData/VersionControl/abc123_d3 @@ -0,0 +1,3 @@ +@@ -113,8 +113,46 @@ + indeed. ++%0AHamlet: Methinks it is like a weasel. \ No newline at end of file diff --git a/frontend/src/assets/MockData/VersionControl/abc123_d4 b/frontend/src/assets/MockData/VersionControl/abc123_d4 new file mode 100644 index 00000000..a90a5003 --- /dev/null +++ b/frontend/src/assets/MockData/VersionControl/abc123_d4 @@ -0,0 +1,3 @@ +@@ -151,8 +151,115 @@ + weasel. ++%0APolonius: It is backed like a weasel.%0AHamlet: Or like a whale?%0APolonius: Very like a whale.%0A-- Shakespeare \ No newline at end of file diff --git a/frontend/src/assets/MockData/VersionControl/abc123_s0 b/frontend/src/assets/MockData/VersionControl/abc123_s0 new file mode 100644 index 00000000..e69de29b