admin/twenty
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Improve health check command (#3553)

Browse Source 
* Improve health check command

* Fix health check

* Fix health check
This commit is contained in:
Charles Bochet
2024-01-19 16:54:43 +01:00
committed by GitHub
parent 7607ecaac6
commit 2cf4bd746a
7 changed files with 60 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
packages/twenty-server/src/metadata/object-metadata/object-metadata.service.ts
View File

@ -101,7 +101,7 @@ export class ObjectMetadataService extends TypeOrmQueryService<ObjectMetadataEnt
},
icon: 'Icon123',
description: 'Id',
isNullable: true,
isNullable: false,
isActive: true,
isCustom: false,
isSystem: true,
@ -117,7 +117,7 @@ export class ObjectMetadataService extends TypeOrmQueryService<ObjectMetadataEnt
},
icon: 'IconAbc',
description: 'Name',
isNullable: true,
isNullable: false,
isActive: true,
isCustom: false,
workspaceId: objectMetadataInput.workspaceId,
@ -132,7 +132,7 @@ export class ObjectMetadataService extends TypeOrmQueryService<ObjectMetadataEnt
},
icon: 'IconCalendar',
description: 'Creation date',
isNullable: true,
isNullable: false,
isActive: true,
isCustom: false,
workspaceId: objectMetadataInput.workspaceId,
@ -147,7 +147,7 @@ export class ObjectMetadataService extends TypeOrmQueryService<ObjectMetadataEnt
},
icon: 'IconCalendar',
description: 'Update date',
isNullable: true,
isNullable: false,
isActive: true,
isCustom: false,
isSystem: true,
@ -245,7 +245,7 @@ export class ObjectMetadataService extends TypeOrmQueryService<ObjectMetadataEnt
{
action: WorkspaceMigrationColumnActionType.CREATE,
columnName: 'name',
columnType: 'varchar',
columnType: 'text',
defaultValue: "'Untitled'",
} satisfies WorkspaceMigrationColumnCreate,
],
@ -330,6 +330,7 @@ export class ObjectMetadataService extends TypeOrmQueryService<ObjectMetadataEnt
) {
return this.objectMetadataRepository.find({
relations: [
'fields.object',
'fields',
'fields.fromRelationMetadata',
'fields.toRelationMetadata',

5
packages/twenty-server/src/metadata/relation-metadata/relation-metadata.service.ts
View File

@ -20,14 +20,13 @@ import { WorkspaceMigrationColumnActionType } from 'src/metadata/workspace-migra
import { ObjectMetadataEntity } from 'src/metadata/object-metadata/object-metadata.entity';
import { createCustomColumnName } from 'src/metadata/utils/create-custom-column-name.util';
import { computeObjectTargetTable } from 'src/workspace/utils/compute-object-target-table.util';
import { createRelationForeignKeyColumnName } from 'src/metadata/relation-metadata/utils/create-relation-foreign-key-column-name.util';
import {
RelationMetadataEntity,
RelationMetadataType,
} from './relation-metadata.entity';
import { createRelationMetadataForeignKey } from './utils/create-relation-metadata-foreign-key.util';
@Injectable()
export class RelationMetadataService extends TypeOrmQueryService<RelationMetadataEntity> {
constructor(
@ -56,7 +55,7 @@ export class RelationMetadataService extends TypeOrmQueryService<RelationMetadat
// NOTE: this logic is called to create relation through metadata graphql endpoint (so only for custom field relations)
const isCustom = true;
const baseColumnName = `${camelCase(relationMetadataInput.toName)}Id`;
const foreignKeyColumnName = createRelationMetadataForeignKey(
const foreignKeyColumnName = createRelationForeignKeyColumnName(
relationMetadataInput.toName,
isCustom,
);

4
packages/twenty-server/src/metadata/relation-metadata/utils/create-relation-metadata-foreign-key.util.ts → packages/twenty-server/src/metadata/relation-metadata/utils/create-relation-foreign-key-column-name.util.ts
View File

@ -1,9 +1,9 @@
import { createCustomColumnName } from 'src/metadata/utils/create-custom-column-name.util';
import { camelCase } from 'src/utils/camel-case';
export const createRelationMetadataForeignKey = (
export const createRelationForeignKeyColumnName = (
name: string,
isCustom?: boolean,
isCustom: boolean,
) => {
const baseColumnName = `${camelCase(name)}Id`;

5
packages/twenty-server/src/metadata/relation-metadata/utils/create-relation-foreign-key-field-metadata-name.util.ts Normal file
View File

@ -0,0 +1,5 @@
import { camelCase } from 'src/utils/camel-case';
export const createRelationForeignKeyFieldMetadataName = (name: string) => {
return `${camelCase(name)}Id`;
};

16
packages/twenty-server/src/workspace/workspace-health/services/database-structure.service.ts
View File

@ -63,7 +63,10 @@ export class DatabaseStructureService {
c.table_schema AS "tableSchema",
c.table_name AS "tableName",
c.column_name AS "columnName",
c.data_type AS "dataType",
CASE
WHEN (c.data_type = 'USER-DEFINED') THEN c.udt_name
ELSE data_type
END AS "dataType",
c.is_nullable AS "isNullable",
c.column_default AS "columnDefault",
CASE
@ -116,10 +119,19 @@ export class DatabaseStructureService {
}));
}
getPostgresDataType(fieldMetadataType: FieldMetadataType): string {
getPostgresDataType(
fieldMetadataType: FieldMetadataType,
fieldMetadataName: string,
objectMetadataNameSingular: string,
): string {
const typeORMType = fieldMetadataTypeToColumnType(fieldMetadataType);
const mainDataSource = this.typeORMService.getMainDataSource();
// TODO: remove special case for enum type, should we include this to fieldMetadataTypeToColumnType?
if (typeORMType === 'enum') {
return `${objectMetadataNameSingular}_${fieldMetadataName}_enum`;
}
return mainDataSource.driver.normalizeType({
type: typeORMType,
});

8
packages/twenty-server/src/workspace/workspace-health/services/field-metadata-health.service.ts
View File

@ -117,9 +117,13 @@ export class FieldMetadataHealthService {
): WorkspaceHealthIssue[] {
const issues: WorkspaceHealthIssue[] = [];
const columnName = fieldMetadata.targetColumnMap.value;
const dataType = this.databaseStructureService.getPostgresDataType(
fieldMetadata.type,
fieldMetadata.name,
fieldMetadata.object?.nameSingular,
);
const defaultValue = this.databaseStructureService.getPostgresDefault(
fieldMetadata.type,
fieldMetadata.defaultValue,
@ -155,7 +159,9 @@ export class FieldMetadataHealthService {
type: WorkspaceHealthIssueType.COLUMN_NULLABILITY_CONFLICT,
fieldMetadata,
columnStructure,
message: `Column ${columnName} is not nullable as expected`,
message: `Column ${columnName} is expected to be ${
fieldMetadata.isNullable ? 'nullable' : 'not nullable'
} but is ${columnStructure.isNullable ? 'nullable' : 'not nullable'}`,
});
}

29
packages/twenty-server/src/workspace/workspace-health/services/relation-metadata.health.service.ts
View File

@ -18,12 +18,13 @@ import {
RelationMetadataEntity,
RelationMetadataType,
} from 'src/metadata/relation-metadata/relation-metadata.entity';
import { createRelationMetadataForeignKey } from 'src/metadata/relation-metadata/utils/create-relation-metadata-foreign-key.util';
import {
RelationDirection,
deduceRelationDirection,
} from 'src/workspace/utils/deduce-relation-direction.util';
import { ObjectMetadataEntity } from 'src/metadata/object-metadata/object-metadata.entity';
import { createRelationForeignKeyColumnName } from 'src/metadata/relation-metadata/utils/create-relation-foreign-key-column-name.util';
import { createRelationForeignKeyFieldMetadataName } from 'src/metadata/relation-metadata/utils/create-relation-foreign-key-field-metadata-name.util';
@Injectable()
export class RelationMetadataHealthService {
@ -136,7 +137,7 @@ export class RelationMetadataHealthService {
}
const isCustom = toFieldMetadata.isCustom ?? false;
const foreignKeyColumnName = createRelationMetadataForeignKey(
const foreignKeyColumnName = createRelationForeignKeyColumnName(
toFieldMetadata.name,
isCustom,
);
@ -144,16 +145,34 @@ export class RelationMetadataHealthService {
(column) => column.columnName === foreignKeyColumnName,
);
const relationFieldMetadata = toObjectMetadataFields.find(
(fieldMetadata) => fieldMetadata.name === foreignKeyColumnName,
(fieldMetadata) =>
fieldMetadata.name ===
createRelationForeignKeyFieldMetadataName(toFieldMetadata.name),
);
if (!relationColumn || !relationFieldMetadata) {
if (!relationFieldMetadata) {
issues.push({
type: WorkspaceHealthIssueType.RELATION_FOREIGN_KEY_NOT_VALID,
fromFieldMetadata,
toFieldMetadata,
relationMetadata,
message: `Relation ${relationMetadata.id} doesn't have a valid foreign key`,
message: `Relation ${
relationMetadata.id
} doesn't have a valid foreign key (expected fieldMetadata.name to be ${createRelationForeignKeyFieldMetadataName(
toFieldMetadata.name,
)}`,
});
return issues;
}
if (!relationColumn) {
issues.push({
type: WorkspaceHealthIssueType.RELATION_FOREIGN_KEY_NOT_VALID,
fromFieldMetadata,
toFieldMetadata,
relationMetadata,
message: `Relation ${relationMetadata.id} doesn't have a valid foreign key (expected column name to be ${foreignKeyColumnName}`,
});
return issues;