Merge pull request #6923 from ever-co/feat/6909-active-archived-softD…

…elete-records Feat/6909 active archived soft delete records
ever-co · Oct 4, 2023 · 81509be · 81509be
2 parents b2642bd + f638b06
commit 81509be
Show file tree

Hide file tree

Showing 28 changed files with 5,547 additions and 150 deletions.
diff --git a/packages/contracts/src/base-entity.model.ts b/packages/contracts/src/base-entity.model.ts
@@ -1,28 +1,35 @@
 import { ITenant } from './tenant.model';
 import { IOrganization } from './organization.model';
 
+// Common properties for entities with relations
 export interface IBaseRelationsEntityModel {
-	readonly relations?: string[];
+	relations?: string[]; // List of related entities
 }
 
+// Common properties for soft delete entities
 export interface IBaseSoftDeleteEntityModel {
-	deletedAt?: Date;
+	deletedAt?: Date; // Indicates if the record is soft deleted
 }
 
-export interface IBaseEntityModel extends IBaseSoftDeleteEntityModel  {
-	id?: string;
+// Common properties for entities
+export interface IBaseEntityModel extends IBaseSoftDeleteEntityModel {
+	id?: string; // Unique identifier
 
-	readonly createdAt?: Date;
-	readonly updatedAt?: Date;
+	readonly createdAt?: Date; // Date when the record was created
+	readonly updatedAt?: Date; // Date when the record was last updated
+
+	isActive?: boolean; // Indicates if the record is currently active
+	isArchived?: boolean; // Indicates if the record is archived
 }
 
+// Common properties for entities associated with a tenant
 export interface IBasePerTenantEntityModel extends IBaseEntityModel {
-	tenantId?: string;
-	tenant?: ITenant;
+	tenantId?: ITenant['id']; // Identifier of the associated tenant
+	tenant?: ITenant; // Reference to the associated tenant
 }
 
-export interface IBasePerTenantAndOrganizationEntityModel
-	extends IBasePerTenantEntityModel {
-	organizationId?: string;
-	organization?: IOrganization;
+// Common properties for entities associated with both tenant and organization
+export interface IBasePerTenantAndOrganizationEntityModel extends IBasePerTenantEntityModel {
+	organizationId?: IOrganization['id']; // Identifier of the associated organization
+	organization?: IOrganization; // Reference to the associated organization
 }
diff --git a/packages/contracts/src/candidate-interview.model.ts b/packages/contracts/src/candidate-interview.model.ts
@@ -1,21 +1,18 @@
 import { IBasePerTenantAndOrganizationEntityModel } from './base-entity.model';
-import { ICandidate } from './candidate.model';
+import { IRelationalCandidate } from './candidate.model';
 import { ICandidateFeedback } from './candidate-feedback.model';
 import { ICandidateInterviewers } from './candidate-interviewers.model';
 import { ICandidatePersonalQualities } from './candidate-personal-qualities.model';
 import { ICandidateTechnologies } from './candidate-technologies.model';
 import { IEmployee } from './employee.model';
 
 export interface IRelationalCandidateInterview {
-    readonly interview?: ICandidateInterview;
-    readonly interviewId?: ICandidateInterview['id'];
+	readonly interview?: ICandidateInterview;
+	readonly interviewId?: ICandidateInterview['id'];
 }
 
-export interface ICandidateInterview
-	extends IBasePerTenantAndOrganizationEntityModel {
+export interface ICandidateInterview extends IBasePerTenantAndOrganizationEntityModel, IRelationalCandidate {
 	title: string;
-	candidateId?: string;
-	candidate?: ICandidate;
 	interviewers?: ICandidateInterviewers[];
 	location?: string;
 	startTime: Date;
@@ -26,13 +23,10 @@ export interface ICandidateInterview
 	technologies?: ICandidateTechnologies[];
 	personalQualities?: ICandidatePersonalQualities[];
 	rating?: number;
-	isArchived?: boolean;
 }
 
-export interface ICandidateInterviewFindInput
-	extends IBasePerTenantAndOrganizationEntityModel {
+export interface ICandidateInterviewFindInput extends IBasePerTenantAndOrganizationEntityModel, IRelationalCandidate {
 	title?: string;
-	candidateId?: string;
 	interviewers?: ICandidateInterviewers[];
 	location?: string;
 	startTime?: Date;
@@ -43,10 +37,8 @@ export interface ICandidateInterviewFindInput
 	personalQualities?: ICandidatePersonalQualities[];
 }
 
-export interface ICandidateInterviewCreateInput
-	extends IBasePerTenantAndOrganizationEntityModel {
+export interface ICandidateInterviewCreateInput extends IBasePerTenantAndOrganizationEntityModel, IRelationalCandidate {
 	title: string;
-	candidateId?: string;
 	interviewers?: ICandidateInterviewers[];
 	location?: string;
 	note?: string;

diff --git a/packages/contracts/src/candidate.model.ts b/packages/contracts/src/candidate.model.ts
@@ -16,8 +16,8 @@ import { ITag } from './tag.model';
 import { IEmployee, PayPeriodEnum } from './employee.model';
 
 export interface IRelationalCandidate {
-	readonly candidate?: ICandidate;
-	readonly candidateId?: ICandidate['id'];
+	candidate?: ICandidate;
+	candidateId?: ICandidate['id'];
 }
 
 export interface ICandidate extends IBasePerTenantAndOrganizationEntityModel {
@@ -47,7 +47,6 @@ export interface ICandidate extends IBasePerTenantAndOrganizationEntityModel {
 	cvUrl?: string;
 	feedbacks?: ICandidateFeedback[];
 	rating?: number;
-	isArchived?: boolean;
 	interview?: ICandidateInterview[];
 	contact?: IContact;
 	contactId?: IContact['id'];

diff --git a/packages/contracts/src/email.model.ts b/packages/contracts/src/email.model.ts
@@ -9,7 +9,6 @@ export interface IEmailHistory extends IBasePerTenantAndOrganizationEntityModel,
 	name: string;
 	content: string;
 	email: string;
-	isArchived?: boolean;
 }
 
 export interface IEmailUpdateInput extends IBasePerTenantAndOrganizationEntityModel, IRelationalUser, Partial<IRelationalEmailTemplate> {

diff --git a/packages/contracts/src/employee.model.ts b/packages/contracts/src/employee.model.ts
@@ -31,7 +31,6 @@ export interface IEmployee extends IBasePerTenantAndOrganizationEntityModel {
 	user: IUser;
 	userId: string;
 	valueDate?: Date;
-	isActive: boolean;
 	short_description?: string;
 	description?: string;
 	teams?: IOrganizationTeam[];

diff --git a/packages/contracts/src/event-type.model.ts b/packages/contracts/src/event-type.model.ts
@@ -7,7 +7,6 @@ export interface IEventType extends IBasePerTenantAndOrganizationEntityModel {
 	description?: string;
 	duration: number;
 	durationUnit: string;
-	isActive: boolean;
 	employeeId?: string;
 	employee?: IEmployee;
 	tags?: ITag[];

diff --git a/packages/contracts/src/invoice.model.ts b/packages/contracts/src/invoice.model.ts
@@ -38,7 +38,6 @@ export interface IInvoice extends IBasePerTenantAndOrganizationEntityModel {
 	amountDue?: number;
 	hasRemainingAmountInvoiced?: boolean;
 	token?: string;
-	isArchived?: boolean;
 }
 
 export interface IInvoiceCreateInput

diff --git a/packages/contracts/src/organization-sprint.model.ts b/packages/contracts/src/organization-sprint.model.ts
@@ -12,7 +12,6 @@ export interface IOrganizationSprint
 	endDate?: Date;
 	dayStart?: number; // Enum ((Sunday-Saturday) => (0-7))
 	project?: IOrganizationProject;
-	isActive?: boolean;
 	tasks?: ITask[];
 }
 

diff --git a/packages/contracts/src/organization.model.ts b/packages/contracts/src/organization.model.ts
@@ -56,7 +56,6 @@ export interface IOrganization
 	overview: string;
 	skills: ISkill[];
 	currency: string;
-	isActive: boolean;
 	defaultValueDateType: DefaultValueDateTypeEnum;
 	defaultAlignmentType?: string;
 	dateFormat?: string;

diff --git a/packages/contracts/src/pipeline.model.ts b/packages/contracts/src/pipeline.model.ts
@@ -8,7 +8,6 @@ export interface IPipeline extends IBasePerTenantAndOrganizationEntityModel {
 	stages: IPipelineStage[];
 	description: string;
 	name: string;
-	isActive: boolean;
 }
 
 export type IPipelineFindInput = Partial<

diff --git a/packages/contracts/src/time-off.model.ts b/packages/contracts/src/time-off.model.ts
@@ -52,7 +52,6 @@ export interface ITimeOff extends IBasePerTenantAndOrganizationEntityModel {
 	documentUrl?: string;
 	fullName?: string;
 	imageUrl?: string;
-	isArchived?: boolean;
 }
 
 export interface ITimeOffFindInput

diff --git a/packages/contracts/src/user-organization.model.ts b/packages/contracts/src/user-organization.model.ts
@@ -5,7 +5,6 @@ export interface IUserOrganization
 	extends IBasePerTenantAndOrganizationEntityModel {
 	userId: string;
 	isDefault: boolean;
-	isActive: boolean;
 	user?: IUser;
 }
 

diff --git a/packages/contracts/src/user.model.ts b/packages/contracts/src/user.model.ts
@@ -42,8 +42,6 @@ export interface IUser extends IBasePerTenantEntityModel, IRelationalImageAsset
 	organizations?: IUserOrganization[];
 	isImporting?: boolean;
 	sourceId?: string;
-	isActive?: boolean;
-	isArchived?: boolean;
 	code?: string;
 	codeExpireAt?: Date;
 	emailVerifiedAt?: Date;

diff --git a/packages/core/src/candidate-interview/candidate-interview.entity.ts b/packages/core/src/candidate-interview/candidate-interview.entity.ts
@@ -42,9 +42,6 @@ export class CandidateInterview extends TenantOrganizationBaseEntity
 	@Column({ nullable: true })
 	note?: string;
 
-	@ApiPropertyOptional({ type: () => Boolean, default: false })
-	@Column({ nullable: true, default: false })
-	isArchived?: boolean;
 
 	@ApiPropertyOptional({ type: () => Number })
 	@Column({
@@ -55,10 +52,10 @@ export class CandidateInterview extends TenantOrganizationBaseEntity
 	rating?: number;
 
 	/*
-    |--------------------------------------------------------------------------
-    | @OneToMany
-    |--------------------------------------------------------------------------
-    */
+	|--------------------------------------------------------------------------
+	| @OneToMany
+	|--------------------------------------------------------------------------
+	*/
 	@ApiProperty({ type: () => CandidateFeedback })
 	@OneToMany(() => CandidateFeedback, (feedback) => feedback.interview, {
 		onDelete: 'SET NULL'
@@ -88,10 +85,10 @@ export class CandidateInterview extends TenantOrganizationBaseEntity
 	interviewers?: ICandidateInterviewers[];
 
 	/*
-    |--------------------------------------------------------------------------
-    | @ManyToOne
-    |--------------------------------------------------------------------------
-    */
+	|--------------------------------------------------------------------------
+	| @ManyToOne
+	|--------------------------------------------------------------------------
+	*/
 
 	/**
 	 * Candidate

diff --git a/packages/core/src/candidate/candidate.entity.ts b/packages/core/src/candidate/candidate.entity.ts
@@ -107,9 +107,6 @@ export class Candidate extends TenantOrganizationBaseEntity implements ICandidat
 	@Column({ nullable: true })
 	cvUrl?: string;
 
-	@ApiPropertyOptional({ type: () => Boolean, default: false })
-	@Column({ nullable: true, default: false })
-	isArchived?: boolean;
 
 	ratings?: number;
 	alreadyHired?: boolean;

diff --git a/packages/core/src/core/entities/base.entity.ts b/packages/core/src/core/entities/base.entity.ts
@@ -5,10 +5,13 @@
 import {
 	PrimaryGeneratedColumn,
 	UpdateDateColumn,
-	CreateDateColumn
+	CreateDateColumn,
+	Column,
+	Index
 } from 'typeorm';
 import { ApiPropertyOptional } from '@nestjs/swagger';
 import { BaseEntityModel as IBaseEntityModel } from '@gauzy/contracts';
+import { IsBoolean, IsOptional } from 'class-validator';
 
 export abstract class Model {
 	constructor(input?: any) {
@@ -25,6 +28,7 @@ export abstract class BaseEntity extends Model implements IBaseEntityModel {
 	@PrimaryGeneratedColumn('uuid')
 	id?: string;
 
+	// Date when the record was created
 	@ApiPropertyOptional({
 		type: 'string',
 		format: 'date-time',
@@ -33,11 +37,28 @@ export abstract class BaseEntity extends Model implements IBaseEntityModel {
 	@CreateDateColumn()
 	createdAt?: Date;
 
+	// Date when the record was last updated
 	@ApiPropertyOptional({
 		type: 'string',
 		format: 'date-time',
 		example: '2018-11-21T06:20:32.232Z'
 	})
 	@UpdateDateColumn()
 	updatedAt?: Date;
+
+	// Indicates if record is active now
+	@ApiPropertyOptional({ type: Boolean, default: true })
+	@IsOptional()
+	@IsBoolean()
+	@Index()
+	@Column({ nullable: false, default: true })
+	isActive?: boolean;
+
+	// Indicate if record is archived
+	@ApiPropertyOptional({ type: Boolean, default: false })
+	@IsOptional()
+	@IsBoolean()
+	@Index()
+	@Column({ nullable: false, default: false })
+	isArchived?: boolean;
 }
diff --git a/packages/core/src/database/migrations/1643809486960-MigrateEmailTemplatesData.ts b/packages/core/src/database/migrations/1643809486960-MigrateEmailTemplatesData.ts
@@ -1,28 +1,32 @@
-import { MigrationInterface, QueryRunner, SelectQueryBuilder } from "typeorm";
-import { createDefaultEmailTemplates } from "./../../email-template/email-template.seed";
-import { EmailTemplate } from "./../../core/entities/internal";
+import { MigrationInterface, QueryRunner } from "typeorm";
+import * as chalk from 'chalk';
+import { EmailTemplateEnum } from "@gauzy/contracts";
+import { EmailTemplateUtils } from "email-template/utils";
 
 export class MigrateEmailTemplatesData1643809486960 implements MigrationInterface {
 
     name = 'MigrateEmailTemplatesData1643809486960';
 
+    /**
+    * Up Migration
+    *
+    * @param queryRunner
+    */
     public async up(queryRunner: QueryRunner): Promise<any> {
-        /**
-         * Removed default gauzy email templates, again seed them with new one
-         */
-        const query = queryRunner.connection.createQueryBuilder(EmailTemplate, 'email_template');
-        query.where((qb: SelectQueryBuilder<EmailTemplate>) => {
-            qb.andWhere(`"${qb.alias}"."organizationId" IS NULL`);
-            qb.andWhere(`"${qb.alias}"."tenantId" IS NULL`);
-        });
-        const emailTemplates = await query.getMany();
-        await queryRunner.connection.getRepository(EmailTemplate).remove(emailTemplates);
-
-        /**
-         * Reseed all new default email templates
-         */
-        await createDefaultEmailTemplates(queryRunner.connection);
+        console.log(chalk.yellow(`MigrateEmailTemplatesData1643809486960 start running!`));
+        const templates = Object.values(EmailTemplateEnum);
+        await Promise.all(
+            templates.map(
+                async (template: EmailTemplateEnum) => {
+                    try {
+                        await EmailTemplateUtils.migrateEmailTemplates(queryRunner, template);
+                    } catch (error) {
+                        console.log(`Error while migrating missing email templates for ${template}`, error);
+                    }
+                }
+            )
+        );
     }
 
-    public async down(queryRunner: QueryRunner): Promise<any> {}
-}
+    public async down(queryRunner: QueryRunner): Promise<any> { }
+}