|
| 1 | +import { Injectable, Logger } from '@nestjs/common'; |
| 2 | +import { FieldType, type ILinkFieldOptions } from '@teable/core'; |
| 3 | +import { Prisma, PrismaService } from '@teable/db-main-prisma'; |
| 4 | +import { IntegrityIssueType, type IIntegrityIssue } from '@teable/openapi'; |
| 5 | +import { Knex } from 'knex'; |
| 6 | +import { InjectModel } from 'nest-knexjs'; |
| 7 | +import type { LinkFieldDto } from '../field/model/field-dto/link-field.dto'; |
| 8 | + |
| 9 | +@Injectable() |
| 10 | +export class ForeignKeyIntegrityService { |
| 11 | + private readonly logger = new Logger(ForeignKeyIntegrityService.name); |
| 12 | + |
| 13 | + constructor( |
| 14 | + private readonly prismaService: PrismaService, |
| 15 | + @InjectModel('CUSTOM_KNEX') private readonly knex: Knex |
| 16 | + ) {} |
| 17 | + |
| 18 | + async getIssues(tableId: string, field: LinkFieldDto): Promise<IIntegrityIssue[]> { |
| 19 | + const { foreignTableId, fkHostTableName, foreignKeyName, selfKeyName } = field.options; |
| 20 | + const issues: IIntegrityIssue[] = []; |
| 21 | + |
| 22 | + const { name: selfTableName, dbTableName: selfTableDbTableName } = |
| 23 | + await this.prismaService.tableMeta.findFirstOrThrow({ |
| 24 | + where: { id: tableId, deletedTime: null }, |
| 25 | + select: { name: true, dbTableName: true }, |
| 26 | + }); |
| 27 | + |
| 28 | + const { name: foreignTableName, dbTableName: foreignTableDbTableName } = |
| 29 | + await this.prismaService.tableMeta.findFirstOrThrow({ |
| 30 | + where: { id: foreignTableId, deletedTime: null }, |
| 31 | + select: { name: true, dbTableName: true }, |
| 32 | + }); |
| 33 | + |
| 34 | + // Check self references |
| 35 | + if (selfTableDbTableName !== fkHostTableName) { |
| 36 | + const selfIssues = await this.checkInvalidReferences({ |
| 37 | + fkHostTableName, |
| 38 | + targetTableName: selfTableDbTableName, |
| 39 | + keyName: selfKeyName, |
| 40 | + field, |
| 41 | + referencedTableName: selfTableName, |
| 42 | + isSelfReference: true, |
| 43 | + }); |
| 44 | + issues.push(...selfIssues); |
| 45 | + } |
| 46 | + |
| 47 | + // Check foreign references |
| 48 | + if (foreignTableDbTableName !== fkHostTableName) { |
| 49 | + const foreignIssues = await this.checkInvalidReferences({ |
| 50 | + fkHostTableName, |
| 51 | + targetTableName: foreignTableDbTableName, |
| 52 | + keyName: foreignKeyName, |
| 53 | + field, |
| 54 | + referencedTableName: foreignTableName, |
| 55 | + isSelfReference: false, |
| 56 | + }); |
| 57 | + issues.push(...foreignIssues); |
| 58 | + } |
| 59 | + |
| 60 | + return issues; |
| 61 | + } |
| 62 | + |
| 63 | + private async checkInvalidReferences({ |
| 64 | + fkHostTableName, |
| 65 | + targetTableName, |
| 66 | + keyName, |
| 67 | + field, |
| 68 | + referencedTableName, |
| 69 | + isSelfReference, |
| 70 | + }: { |
| 71 | + fkHostTableName: string; |
| 72 | + targetTableName: string; |
| 73 | + keyName: string; |
| 74 | + field: { id: string; name: string }; |
| 75 | + referencedTableName: string; |
| 76 | + isSelfReference: boolean; |
| 77 | + }): Promise<IIntegrityIssue[]> { |
| 78 | + const issues: IIntegrityIssue[] = []; |
| 79 | + |
| 80 | + const invalidQuery = this.knex(fkHostTableName) |
| 81 | + .leftJoin(targetTableName, `${fkHostTableName}.${keyName}`, `${targetTableName}.__id`) |
| 82 | + .whereNull(`${targetTableName}.__id`) |
| 83 | + .count(`${fkHostTableName}.${keyName} as count`) |
| 84 | + .first() |
| 85 | + .toQuery(); |
| 86 | + |
| 87 | + try { |
| 88 | + const invalidRefs = |
| 89 | + await this.prismaService.$queryRawUnsafe<{ count: bigint }[]>(invalidQuery); |
| 90 | + const refCount = Number(invalidRefs[0]?.count || 0); |
| 91 | + |
| 92 | + if (refCount > 0) { |
| 93 | + const message = isSelfReference |
| 94 | + ? `Found ${refCount} invalid self references in table ${referencedTableName}` |
| 95 | + : `Found ${refCount} invalid foreign references to table ${referencedTableName}`; |
| 96 | + |
| 97 | + issues.push({ |
| 98 | + type: IntegrityIssueType.MissingRecordReference, |
| 99 | + message: `${message} (Field Name: ${field.name}, Field ID: ${field.id})`, |
| 100 | + }); |
| 101 | + } |
| 102 | + } catch (error) { |
| 103 | + if (error instanceof Prisma.PrismaClientKnownRequestError && error.code === 'P2010') { |
| 104 | + console.error('error ignored:', error); |
| 105 | + } else { |
| 106 | + throw error; |
| 107 | + } |
| 108 | + } |
| 109 | + |
| 110 | + return issues; |
| 111 | + } |
| 112 | + |
| 113 | + async fix(_tableId: string, fieldId: string): Promise<IIntegrityIssue | undefined> { |
| 114 | + const field = await this.prismaService.field.findFirstOrThrow({ |
| 115 | + where: { id: fieldId, type: FieldType.Link, isLookup: null, deletedTime: null }, |
| 116 | + }); |
| 117 | + |
| 118 | + const options = JSON.parse(field.options as string) as ILinkFieldOptions; |
| 119 | + const { foreignTableId, fkHostTableName, foreignKeyName, selfKeyName } = options; |
| 120 | + const foreignTable = await this.prismaService.tableMeta.findFirstOrThrow({ |
| 121 | + where: { id: foreignTableId, deletedTime: null }, |
| 122 | + select: { id: true, name: true, dbTableName: true }, |
| 123 | + }); |
| 124 | + |
| 125 | + let totalFixed = 0; |
| 126 | + |
| 127 | + // Fix invalid self references |
| 128 | + if (fkHostTableName !== fkHostTableName) { |
| 129 | + const selfDeleted = await this.deleteMissingReferences({ |
| 130 | + fkHostTableName, |
| 131 | + targetTableName: fkHostTableName, |
| 132 | + keyName: selfKeyName, |
| 133 | + }); |
| 134 | + totalFixed += selfDeleted; |
| 135 | + } |
| 136 | + |
| 137 | + // Fix invalid foreign references |
| 138 | + if (foreignTable.dbTableName !== fkHostTableName) { |
| 139 | + const foreignDeleted = await this.deleteMissingReferences({ |
| 140 | + fkHostTableName, |
| 141 | + targetTableName: foreignTable.dbTableName, |
| 142 | + keyName: foreignKeyName, |
| 143 | + }); |
| 144 | + totalFixed += foreignDeleted; |
| 145 | + } |
| 146 | + |
| 147 | + if (totalFixed > 0) { |
| 148 | + return { |
| 149 | + type: IntegrityIssueType.MissingRecordReference, |
| 150 | + message: `Fixed ${totalFixed} invalid references and inconsistent links for link field (Field Name: ${field.name}, Field ID: ${field.id})`, |
| 151 | + }; |
| 152 | + } |
| 153 | + } |
| 154 | + |
| 155 | + private async deleteMissingReferences({ |
| 156 | + fkHostTableName, |
| 157 | + targetTableName, |
| 158 | + keyName, |
| 159 | + }: { |
| 160 | + fkHostTableName: string; |
| 161 | + targetTableName: string; |
| 162 | + keyName: string; |
| 163 | + }) { |
| 164 | + const deleteQuery = this.knex(fkHostTableName) |
| 165 | + .whereNotExists( |
| 166 | + this.knex |
| 167 | + .select('__id') |
| 168 | + .from(targetTableName) |
| 169 | + .where('__id', this.knex.ref(`${fkHostTableName}.${keyName}`)) |
| 170 | + ) |
| 171 | + .delete() |
| 172 | + .toQuery(); |
| 173 | + return await this.prismaService.$executeRawUnsafe(deleteQuery); |
| 174 | + } |
| 175 | +} |
0 commit comments