Merge pull request #401 from internxt/feat/creation-modification-time…

…s-on-folders

[PB-3009]: feat/creation modification times on folders

migrations/20240927193342-add-modification-creation-times-to-folders.js

@@ -0,0 +1,27 @@
+'use strict';
+
+const tableName = 'folders';
+const newColumn1 = 'creation_time';
+const newColumn2 = 'modification_time';
+
+/** @type {import('sequelize-cli').Migration} */
+module.exports = {
+ async up(queryInterface, Sequelize) {
+ await queryInterface.addColumn(tableName, newColumn1, {
+ type: Sequelize.DATE,
+ defaultValue: Sequelize.fn('NOW'),
+ allowNull: false,
+ });
+
+ await queryInterface.addColumn(tableName, newColumn2, {
+ type: Sequelize.DATE,
+ defaultValue: Sequelize.fn('NOW'),
+ allowNull: false,
+ });
+ },
+
+ async down(queryInterface) {
+ await queryInterface.removeColumn(tableName, newColumn1);
+ await queryInterface.removeColumn(tableName, newColumn2);
+ },
+};

migrations/20241002040050-create-modificationtime-index-on-files.js

@@ -0,0 +1,17 @@
+'use strict';
+
+const tableName = 'files';
+const indexName = 'files_modification_time_index';
+
+/** @type {import('sequelize-cli').Migration} */
+module.exports = {
+ async up(queryInterface) {
+ await queryInterface.sequelize.query(
+ `CREATE INDEX CONCURRENTLY ${indexName} ON ${tableName} (modification_time);`,
+ );
+ },
+
+ async down(queryInterface) {
+ await queryInterface.sequelize.query(`DROP INDEX IF EXISTS ${indexName};`);
+ },
+};

migrations/20241002044035-create-modificationtime-index-on-folders.js

@@ -0,0 +1,17 @@
+'use strict';
+
+const tableName = 'folders';
+const indexName = 'folders_modification_time_index';
+
+/** @type {import('sequelize-cli').Migration} */
+module.exports = {
+ async up(queryInterface) {
+ await queryInterface.sequelize.query(
+ `CREATE INDEX CONCURRENTLY ${indexName} ON ${tableName} (modification_time);`,
+ );
+ },
+
+ async down(queryInterface) {
+ await queryInterface.sequelize.query(`DROP INDEX IF EXISTS ${indexName};`);
+ },
+};

src/modules/file/dto/create-file.dto.ts

@@ -81,6 +81,11 @@ export class CreateFileDto {
  @IsOptional()
  date?: Date;
 
+ @ApiProperty({
+ description: 'The creation time of the file (optional)',
+ required: false,
+ example: '2023-05-30T12:34:56.789Z',
+ })
  @ApiProperty({
  description: 'The date associated with the file (optional)',
  required: false,

src/modules/file/file.usecase.spec.ts

@@ -753,6 +753,7 @@ describe('FileUseCases', () => {
  ...mockFile,
  plainName: newFileMeta.plainName,
  name: encryptedName,
+ modificationTime: new Date(),
  },
  });
 
@@ -781,9 +782,24 @@ describe('FileUseCases', () => {
  expect(fileRepository.updateByUuidAndUserId).toHaveBeenCalledWith(
  mockFile.uuid,
  userMocked.id,
- { plainName: newFileMeta.plainName, name: encryptedName },
+ expect.objectContaining({
+ plainName: newFileMeta.plainName,
+ name: encryptedName,
+ }),
+ );
+ const {
+ modificationTime: _resultModificationTime,
+ ...resultWithoutModificationTime
+ } = result;
+ const {
+ modificationTime: updatedFileModificationTime,
+ ...updatedFileWithoutModificationTime
+ } = updatedFile;
+
+ expect(resultWithoutModificationTime).toEqual(
+ updatedFileWithoutModificationTime,
  );
- expect(result).toEqual(updatedFile);
+ expect(mockFile).not.toBe(updatedFileModificationTime);
  });
  });
 

src/modules/file/file.usecase.ts

@@ -188,15 +188,19 @@ export class FileUseCases {
  );
  }
 
+ const modificationTime = new Date();
+
  await this.fileRepository.updateByUuidAndUserId(file.uuid, user.id, {
  plainName: newFileMetada.plainName,
  name: cryptoFileName,
+ modificationTime: modificationTime,
  });
 
  return {
  ...file.toJSON(),
  name: cryptoFileName,
  plainName: newFileMetada.plainName,
+ modificationTime,
  };
  }
 

src/modules/folder/dto/create-folder.dto.ts

@@ -1,5 +1,5 @@
 import { ApiProperty } from '@nestjs/swagger';
-import { IsNotEmpty, IsUUID } from 'class-validator';
+import { IsDateString, IsNotEmpty, IsOptional, IsUUID } from 'class-validator';
 import { FolderAttributes } from '../../folder/folder.attributes';
 
 export class CreateFolderDto {
@@ -17,4 +17,22 @@ export class CreateFolderDto {
  @IsNotEmpty()
  @IsUUID('4')
  parentFolderUuid: FolderAttributes['uuid'];
+
+ @ApiProperty({
+ description: 'The last modification time of the folder (optional)',
+ required: false,
+ example: '2023-05-30T12:34:56.789Z',
+ })
+ @IsDateString()
+ @IsOptional()
+ modificationTime?: Date;
+
+ @ApiProperty({
+ description: 'The creation time of the folder (optional)',
+ required: false,
+ example: '2023-05-30T12:34:56.789Z',
+ })
+ @IsDateString()
+ @IsOptional()
+ creationTime?: Date;
 }

src/modules/folder/folder.attributes.ts

@@ -18,5 +18,7 @@ export interface FolderAttributes {
  createdAt: Date;
  updatedAt: Date;
  removedAt: Date;
+ creationTime: Date;
+ modificationTime: Date;
  sharings?: Sharing[];
 }

src/modules/folder/folder.controller.ts

@@ -112,11 +112,9 @@ export class FolderController {
  @Body() createFolderDto: CreateFolderDto,
  @Client() clientId: string,
  ) {
- const { plainName, parentFolderUuid } = createFolderDto;
  const folder = await this.folderUseCases.createFolder(
  user,
- plainName,
- parentFolderUuid,
+ createFolderDto,
  );
 
  this.storageNotificationService.folderCreated({

src/modules/folder/folder.domain.ts

@@ -38,6 +38,8 @@ export class Folder implements FolderAttributes {
  createdAt: Date;
  updatedAt: Date;
  size: number;
+ creationTime: Date;
+ modificationTime: Date;
  sharings?: Sharing[];
 
  private constructor({
@@ -59,6 +61,8 @@ export class Folder implements FolderAttributes {
  removed,
  removedAt,
  sharings,
+ creationTime,
+ modificationTime,
  }: FolderAttributes) {
  this.type = 'folder';
  this.id = id;
@@ -80,6 +84,8 @@ export class Folder implements FolderAttributes {
  this.removed = removed;
  this.removedAt = removedAt;
  this.sharings = sharings;
+ this.creationTime = creationTime;
+ this.modificationTime = modificationTime;
  }
 
  static build(folder: FolderAttributes): Folder {

src/modules/folder/folder.model.ts

@@ -18,6 +18,7 @@ import { FolderAttributes } from './folder.attributes';
 import { SharingModel } from '../sharing/models';
 import { Sharing } from '../sharing/sharing.domain';
 import { WorkspaceItemUserModel } from '../workspaces/models/workspace-items-users.model';
+import { Sequelize } from 'sequelize';
 
 @Table({
  underscored: true,
@@ -74,6 +75,14 @@ export class FolderModel extends Model implements FolderAttributes {
  @Column
  removed: boolean;
 
+ @Default(Sequelize.fn('NOW'))
+ @Column
+ creationTime: Date;
+
+ @Default(Sequelize.fn('NOW'))
+ @Column
+ modificationTime: Date;
+
  @AllowNull
  @Column
  deletedAt: Date;