Add phone fields migration command to 0 30 (#7269)
Add phone fields migration command to 0 30
This commit is contained in:
Raphaël Bosi
@ -1,356 +0,0 @@
|
||||
import { InjectDataSource, InjectRepository } from '@nestjs/typeorm';
|
||||
|
||||
import chalk from 'chalk';
|
||||
import { isDefined, isEmpty } from 'class-validator';
|
||||
import { parsePhoneNumber } from 'libphonenumber-js';
|
||||
import { Command } from 'nest-commander';
|
||||
import { DataSource, QueryRunner, Repository } from 'typeorm';
|
||||
|
||||
import {
|
||||
ActiveWorkspacesCommandOptions,
|
||||
ActiveWorkspacesCommandRunner,
|
||||
} from 'src/database/commands/active-workspaces.command';
|
||||
import { TypeORMService } from 'src/database/typeorm/typeorm.service';
|
||||
import { Workspace } from 'src/engine/core-modules/workspace/workspace.entity';
|
||||
import { DataSourceService } from 'src/engine/metadata-modules/data-source/data-source.service';
|
||||
import { CreateFieldInput } from 'src/engine/metadata-modules/field-metadata/dtos/create-field.input';
|
||||
import {
|
||||
FieldMetadataEntity,
|
||||
FieldMetadataType,
|
||||
} from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
|
||||
import { FieldMetadataService } from 'src/engine/metadata-modules/field-metadata/field-metadata.service';
|
||||
import { computeColumnName } from 'src/engine/metadata-modules/field-metadata/utils/compute-column-name.util';
|
||||
import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
|
||||
import { TwentyORMGlobalManager } from 'src/engine/twenty-orm/twenty-orm-global.manager';
|
||||
import { computeTableName } from 'src/engine/utils/compute-table-name.util';
|
||||
import { PERSON_STANDARD_FIELD_IDS } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-field-ids';
|
||||
import { ViewService } from 'src/modules/view/services/view.service';
|
||||
import { ViewFieldWorkspaceEntity } from 'src/modules/view/standard-objects/view-field.workspace-entity';
|
||||
|
||||
type MigratePhoneFieldsToPhonesCommandOptions = ActiveWorkspacesCommandOptions;
|
||||
@Command({
|
||||
name: 'upgrade-0.32:migrate-phone-fields-to-phones',
|
||||
description: 'Migrating fields of deprecated type PHONE to type PHONES',
|
||||
})
|
||||
export class MigratePhoneFieldsToPhonesCommand extends ActiveWorkspacesCommandRunner {
|
||||
constructor(
|
||||
@InjectRepository(Workspace, 'core')
|
||||
protected readonly workspaceRepository: Repository<Workspace>,
|
||||
@InjectRepository(FieldMetadataEntity, 'metadata')
|
||||
private readonly fieldMetadataRepository: Repository<FieldMetadataEntity>,
|
||||
@InjectRepository(ObjectMetadataEntity, 'metadata')
|
||||
private readonly objectMetadataRepository: Repository<ObjectMetadataEntity>,
|
||||
@InjectDataSource('metadata')
|
||||
private readonly metadataDataSource: DataSource,
|
||||
private readonly fieldMetadataService: FieldMetadataService,
|
||||
private readonly twentyORMGlobalManager: TwentyORMGlobalManager,
|
||||
private readonly typeORMService: TypeORMService,
|
||||
private readonly dataSourceService: DataSourceService,
|
||||
private readonly viewService: ViewService,
|
||||
) {
|
||||
super(workspaceRepository);
|
||||
}
|
||||
|
||||
async executeActiveWorkspacesCommand(
|
||||
_passedParam: string[],
|
||||
_options: MigratePhoneFieldsToPhonesCommandOptions,
|
||||
workspaceIds: string[],
|
||||
): Promise<void> {
|
||||
this.logger.log(
|
||||
'Running command to migrate phone type fields to phones type',
|
||||
);
|
||||
for (const workspaceId of workspaceIds) {
|
||||
this.logger.log(`Running command for workspace ${workspaceId}`);
|
||||
try {
|
||||
const dataSourceMetadata =
|
||||
await this.dataSourceService.getLastDataSourceMetadataFromWorkspaceId(
|
||||
workspaceId,
|
||||
);
|
||||
|
||||
if (!dataSourceMetadata) {
|
||||
throw new Error(
|
||||
`Could not find dataSourceMetadata for workspace ${workspaceId}`,
|
||||
);
|
||||
}
|
||||
const workspaceDataSource =
|
||||
await this.typeORMService.connectToDataSource(dataSourceMetadata);
|
||||
|
||||
if (!workspaceDataSource) {
|
||||
throw new Error(
|
||||
`Could not connect to dataSource for workspace ${workspaceId}`,
|
||||
);
|
||||
}
|
||||
const standardPersonPhoneFieldWithTextType =
|
||||
await this.fieldMetadataRepository.findOneBy({
|
||||
workspaceId,
|
||||
standardId: PERSON_STANDARD_FIELD_IDS.phone,
|
||||
});
|
||||
|
||||
if (!standardPersonPhoneFieldWithTextType) {
|
||||
throw new Error(
|
||||
`Could not find standard phone field on person for workspace ${workspaceId}`,
|
||||
);
|
||||
}
|
||||
|
||||
await this.migrateStandardPersonPhoneField({
|
||||
standardPersonPhoneField: standardPersonPhoneFieldWithTextType,
|
||||
workspaceDataSource,
|
||||
workspaceSchemaName: dataSourceMetadata.schema,
|
||||
});
|
||||
|
||||
const fieldsWithPhoneType = await this.fieldMetadataRepository.find({
|
||||
where: {
|
||||
workspaceId,
|
||||
type: FieldMetadataType.PHONE,
|
||||
},
|
||||
});
|
||||
|
||||
for (const deprecatedPhoneField of fieldsWithPhoneType) {
|
||||
await this.migrateCustomPhoneField({
|
||||
phoneField: deprecatedPhoneField,
|
||||
workspaceDataSource,
|
||||
workspaceSchemaName: dataSourceMetadata.schema,
|
||||
});
|
||||
}
|
||||
} catch (error) {
|
||||
this.logger.log(
|
||||
chalk.red(
|
||||
`Field migration on workspace ${workspaceId} failed with error: ${error}`,
|
||||
),
|
||||
);
|
||||
continue;
|
||||
}
|
||||
this.logger.log(chalk.green(`Command completed!`));
|
||||
}
|
||||
}
|
||||
|
||||
private async migrateStandardPersonPhoneField({
|
||||
standardPersonPhoneField,
|
||||
workspaceDataSource,
|
||||
workspaceSchemaName,
|
||||
}: {
|
||||
standardPersonPhoneField: FieldMetadataEntity;
|
||||
workspaceDataSource: DataSource;
|
||||
workspaceSchemaName: string;
|
||||
}) {
|
||||
const personObjectMetadata = await this.objectMetadataRepository.findOne({
|
||||
where: { id: standardPersonPhoneField.objectMetadataId },
|
||||
});
|
||||
|
||||
if (!personObjectMetadata) {
|
||||
throw new Error(
|
||||
`Could not find Person objectMetadata (id ${standardPersonPhoneField.objectMetadataId})`,
|
||||
);
|
||||
}
|
||||
|
||||
this.logger.log(`Attempting to migrate standard person phone field.`);
|
||||
const workspaceQueryRunner = workspaceDataSource.createQueryRunner();
|
||||
|
||||
await workspaceQueryRunner.connect();
|
||||
const { id: _id, ...deprecatedPhoneFieldWithoutId } =
|
||||
standardPersonPhoneField;
|
||||
|
||||
const workspaceId = standardPersonPhoneField.workspaceId;
|
||||
|
||||
try {
|
||||
let standardPersonPhonesField =
|
||||
await this.fieldMetadataRepository.findOneBy({
|
||||
workspaceId,
|
||||
standardId: PERSON_STANDARD_FIELD_IDS.phones,
|
||||
});
|
||||
|
||||
if (!standardPersonPhonesField) {
|
||||
standardPersonPhonesField = await this.fieldMetadataService.createOne({
|
||||
...deprecatedPhoneFieldWithoutId,
|
||||
label: 'Phones',
|
||||
type: FieldMetadataType.PHONES,
|
||||
defaultValue: null,
|
||||
name: 'phones',
|
||||
} satisfies CreateFieldInput);
|
||||
|
||||
await this.viewService.removeFieldFromViews({
|
||||
workspaceId: workspaceId,
|
||||
fieldId: standardPersonPhonesField.id,
|
||||
});
|
||||
}
|
||||
|
||||
// Copy phone data from Text type to Phones type
|
||||
await this.copyAndParseDeprecatedPhoneFieldDataIntoNewPhonesField({
|
||||
workspaceQueryRunner,
|
||||
workspaceSchemaName,
|
||||
});
|
||||
|
||||
// Add (deprecated) to Phone field label
|
||||
await this.metadataDataSource.query(
|
||||
`UPDATE "metadata"."fieldMetadata" SET "label" = $1 where "id"=$2`,
|
||||
['Phone (deprecated)', standardPersonPhoneField.id],
|
||||
);
|
||||
|
||||
// Add new phones field to views and hide deprecated phone field
|
||||
const viewFieldRepository =
|
||||
await this.twentyORMGlobalManager.getRepositoryForWorkspace<ViewFieldWorkspaceEntity>(
|
||||
workspaceId,
|
||||
'viewField',
|
||||
);
|
||||
const viewFieldsWithDeprecatedPhoneField = await viewFieldRepository.find(
|
||||
{
|
||||
where: {
|
||||
fieldMetadataId: standardPersonPhoneField.id,
|
||||
isVisible: true,
|
||||
},
|
||||
},
|
||||
);
|
||||
|
||||
await this.viewService.addFieldToViews({
|
||||
workspaceId: workspaceId,
|
||||
fieldId: standardPersonPhonesField.id,
|
||||
viewsIds: viewFieldsWithDeprecatedPhoneField
|
||||
.filter((viewField) => viewField.viewId !== null)
|
||||
.map((viewField) => viewField.viewId as string),
|
||||
positions: viewFieldsWithDeprecatedPhoneField.reduce(
|
||||
(acc, viewField) => {
|
||||
if (!viewField.viewId) {
|
||||
return acc;
|
||||
}
|
||||
acc[viewField.viewId] = viewField.position;
|
||||
|
||||
return acc;
|
||||
},
|
||||
[],
|
||||
),
|
||||
size: 150,
|
||||
});
|
||||
|
||||
await this.viewService.removeFieldFromViews({
|
||||
workspaceId: workspaceId,
|
||||
fieldId: standardPersonPhoneField.id,
|
||||
});
|
||||
|
||||
this.logger.log(
|
||||
`Migration of standard person phone field to phones is done!`,
|
||||
);
|
||||
} catch (error) {
|
||||
this.logger.log(
|
||||
chalk.red(
|
||||
`Failed to migrate field standard person phone field to phones, rolling back. (Error: ${error})`,
|
||||
),
|
||||
);
|
||||
|
||||
// Delete new phones field if it was created
|
||||
const newPhonesField =
|
||||
await this.fieldMetadataService.findOneWithinWorkspace(workspaceId, {
|
||||
where: {
|
||||
name: 'phones',
|
||||
objectMetadataId: standardPersonPhoneField.objectMetadataId,
|
||||
},
|
||||
});
|
||||
|
||||
if (newPhonesField) {
|
||||
this.logger.log(
|
||||
`Deleting phones field of type Phone as part of rolling back.`,
|
||||
);
|
||||
await this.fieldMetadataService.deleteOneField(
|
||||
{ id: newPhonesField.id },
|
||||
workspaceId,
|
||||
);
|
||||
}
|
||||
|
||||
// Revert Phone field label (remove (deprecated))
|
||||
await this.metadataDataSource.query(
|
||||
`UPDATE "metadata"."fieldMetadata" SET "label" = $1 where "id"=$2`,
|
||||
['Phone', standardPersonPhoneField.id],
|
||||
);
|
||||
} finally {
|
||||
await workspaceQueryRunner.release();
|
||||
}
|
||||
}
|
||||
|
||||
private async migrateCustomPhoneField({
|
||||
phoneField,
|
||||
workspaceDataSource,
|
||||
workspaceSchemaName,
|
||||
}: {
|
||||
phoneField: FieldMetadataEntity;
|
||||
workspaceDataSource: DataSource;
|
||||
workspaceSchemaName: string;
|
||||
}) {
|
||||
if (!phoneField) return;
|
||||
const objectMetadata = await this.objectMetadataRepository.findOne({
|
||||
where: { id: phoneField.objectMetadataId },
|
||||
});
|
||||
|
||||
if (!objectMetadata) {
|
||||
throw new Error(
|
||||
`Could not find objectMetadata for field ${phoneField.name}`,
|
||||
);
|
||||
}
|
||||
this.logger.log(
|
||||
`Attempting to migrate field ${phoneField.name} on ${objectMetadata.nameSingular} from Phone to Text.`,
|
||||
);
|
||||
const workspaceQueryRunner = workspaceDataSource.createQueryRunner();
|
||||
|
||||
await workspaceQueryRunner.connect();
|
||||
|
||||
try {
|
||||
await this.metadataDataSource.query(
|
||||
`UPDATE "metadata"."fieldMetadata" SET "type" = $1 where "id"=$2`,
|
||||
[FieldMetadataType.TEXT, phoneField.id],
|
||||
);
|
||||
|
||||
await workspaceQueryRunner.query(
|
||||
`ALTER TABLE "${workspaceSchemaName}"."${computeTableName(objectMetadata.nameSingular, objectMetadata.isCustom)}" ALTER COLUMN "${computeColumnName(phoneField.name)}" TYPE TEXT`,
|
||||
);
|
||||
} catch (error) {
|
||||
this.logger.log(
|
||||
chalk.red(
|
||||
`Failed to migrate field ${phoneField.name} on ${objectMetadata.nameSingular} from Phone to Text.`,
|
||||
),
|
||||
);
|
||||
} finally {
|
||||
await workspaceQueryRunner.release();
|
||||
}
|
||||
}
|
||||
|
||||
private async copyAndParseDeprecatedPhoneFieldDataIntoNewPhonesField({
|
||||
workspaceQueryRunner,
|
||||
workspaceSchemaName,
|
||||
}: {
|
||||
workspaceQueryRunner: QueryRunner;
|
||||
workspaceSchemaName: string;
|
||||
}) {
|
||||
const deprecatedPhoneFieldRows = await workspaceQueryRunner.query(
|
||||
`SELECT id, phone FROM "${workspaceSchemaName}"."person" WHERE
|
||||
phone IS NOT null`,
|
||||
);
|
||||
|
||||
for (const row of deprecatedPhoneFieldRows) {
|
||||
const phoneColumnValue = row['phone'];
|
||||
|
||||
if (isDefined(phoneColumnValue) && !isEmpty(phoneColumnValue)) {
|
||||
const query = `UPDATE "${workspaceSchemaName}"."person" SET "phonesPrimaryPhoneCountryCode" = $1,"phonesPrimaryPhoneNumber" = $2 where "id"=$3 AND ("phonesPrimaryPhoneCountryCode" IS NULL OR "phonesPrimaryPhoneCountryCode" = '');`;
|
||||
|
||||
try {
|
||||
const parsedPhoneColumnValue = parsePhoneNumber(phoneColumnValue);
|
||||
|
||||
await workspaceQueryRunner.query(query, [
|
||||
`+${parsedPhoneColumnValue.countryCallingCode}`,
|
||||
parsedPhoneColumnValue.nationalNumber,
|
||||
row.id,
|
||||
]);
|
||||
} catch (error) {
|
||||
this.logger.log(
|
||||
chalk.red(
|
||||
`Could not save phone number ${phoneColumnValue}, will try again storing value as is without parsing, with default country code.`,
|
||||
),
|
||||
);
|
||||
// Store the invalid string for invalid phone numbers
|
||||
await workspaceQueryRunner.query(query, [
|
||||
'',
|
||||
phoneColumnValue,
|
||||
row.id,
|
||||
]);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -1,46 +0,0 @@
|
||||
import { InjectRepository } from '@nestjs/typeorm';
|
||||
|
||||
import { Command } from 'nest-commander';
|
||||
import { Repository } from 'typeorm';
|
||||
|
||||
import {
|
||||
ActiveWorkspacesCommandOptions,
|
||||
ActiveWorkspacesCommandRunner,
|
||||
} from 'src/database/commands/active-workspaces.command';
|
||||
import { MigratePhoneFieldsToPhonesCommand } from 'src/database/commands/upgrade-version/0-32/0-32-migrate-phone-fields-to-phones.command';
|
||||
import { Workspace } from 'src/engine/core-modules/workspace/workspace.entity';
|
||||
import { SyncWorkspaceMetadataCommand } from 'src/engine/workspace-manager/workspace-sync-metadata/commands/sync-workspace-metadata.command';
|
||||
|
||||
type UpdateTo0_32CommandOptions = ActiveWorkspacesCommandOptions;
|
||||
|
||||
@Command({
|
||||
name: 'upgrade-0.32',
|
||||
description: 'Upgrade to 0.32',
|
||||
})
|
||||
export class UpgradeTo0_32Command extends ActiveWorkspacesCommandRunner {
|
||||
constructor(
|
||||
@InjectRepository(Workspace, 'core')
|
||||
protected readonly workspaceRepository: Repository<Workspace>,
|
||||
private readonly syncWorkspaceMetadataCommand: SyncWorkspaceMetadataCommand,
|
||||
private readonly migratePhoneFieldsToPhones: MigratePhoneFieldsToPhonesCommand,
|
||||
) {
|
||||
super(workspaceRepository);
|
||||
}
|
||||
|
||||
async executeActiveWorkspacesCommand(
|
||||
_passedParam: string[],
|
||||
options: UpdateTo0_32CommandOptions,
|
||||
workspaceIds: string[],
|
||||
): Promise<void> {
|
||||
await this.syncWorkspaceMetadataCommand.executeActiveWorkspacesCommand(
|
||||
_passedParam,
|
||||
{ ...options, force: true },
|
||||
workspaceIds,
|
||||
);
|
||||
await this.migratePhoneFieldsToPhones.executeActiveWorkspacesCommand(
|
||||
_passedParam,
|
||||
options,
|
||||
workspaceIds,
|
||||
);
|
||||
}
|
||||
}
|
||||
@ -1,32 +0,0 @@
|
||||
import { Module } from '@nestjs/common';
|
||||
import { TypeOrmModule } from '@nestjs/typeorm';
|
||||
|
||||
import { MigratePhoneFieldsToPhonesCommand } from 'src/database/commands/upgrade-version/0-32/0-32-migrate-phone-fields-to-phones.command';
|
||||
import { UpgradeTo0_32Command } from 'src/database/commands/upgrade-version/0-32/0-32-upgrade-version.command';
|
||||
import { TypeORMModule } from 'src/database/typeorm/typeorm.module';
|
||||
import { Workspace } from 'src/engine/core-modules/workspace/workspace.entity';
|
||||
import { DataSourceModule } from 'src/engine/metadata-modules/data-source/data-source.module';
|
||||
import { FieldMetadataEntity } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
|
||||
import { FieldMetadataModule } from 'src/engine/metadata-modules/field-metadata/field-metadata.module';
|
||||
import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
|
||||
import { WorkspaceMetadataVersionModule } from 'src/engine/metadata-modules/workspace-metadata-version/workspace-metadata-version.module';
|
||||
import { WorkspaceSyncMetadataCommandsModule } from 'src/engine/workspace-manager/workspace-sync-metadata/commands/workspace-sync-metadata-commands.module';
|
||||
import { ViewModule } from 'src/modules/view/view.module';
|
||||
|
||||
@Module({
|
||||
imports: [
|
||||
TypeOrmModule.forFeature([Workspace], 'core'),
|
||||
WorkspaceSyncMetadataCommandsModule,
|
||||
DataSourceModule,
|
||||
WorkspaceMetadataVersionModule,
|
||||
FieldMetadataModule,
|
||||
TypeOrmModule.forFeature(
|
||||
[FieldMetadataEntity, ObjectMetadataEntity],
|
||||
'metadata',
|
||||
),
|
||||
TypeORMModule,
|
||||
ViewModule,
|
||||
],
|
||||
providers: [UpgradeTo0_32Command, MigratePhoneFieldsToPhonesCommand],
|
||||
})
|
||||
export class UpgradeTo0_32CommandModule {}
|
||||
Reference in New Issue
Block a user