github/directus
1
1
Fork 0
mirror of https://github.com/directus/directus.git synced 2026-04-25 03:00:53 -04:00
Code Issues Packages Projects Releases Wiki Activity

Attempt to make "require shares fields" migration safer/more reliable (#19619)

Browse Source 
Co-authored-by: Azri Kahar <42867097+azrikahar@users.noreply.github.com>
This commit is contained in:
Pascal Jufer
2023-09-12 21:10:58 +02:00
committed by GitHub
parent 9f216c09bc
commit 0c56c46fdf
2 changed files with 59 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

76
api/src/database/migrations/20230721A-require-shares-fields.ts
View File

@@ -1,37 +1,69 @@
import { createInspector } from '@directus/schema';
import type { Knex } from 'knex';
import logger from '../../logger.js';
import { getHelpers } from '../helpers/index.js';
export async function up(knex: Knex): Promise<void> {
const helper = getHelpers(knex).schema;
const isMysql = helper.isOneOfClients(['mysql']);
if (isMysql) {
await dropConstraint(knex);
}
await knex.schema.alterTable('directus_shares', (table) => {
if (knex.client.constructor.name === 'Client_MySQL') {
// Temporary drop foreign key constraint, see https://github.com/directus/directus/issues/19399
table.dropForeign('collection', 'directus_shares_collection_foreign');
}
table.dropNullable('collection');
if (knex.client.constructor.name === 'Client_MySQL') {
// Recreate foreign key constraint, from 20211211A-add-shares.ts
table.foreign('collection').references('directus_collections.collection').onDelete('CASCADE');
}
table.dropNullable('item');
});
if (isMysql) {
await recreateConstraint(knex);
}
}
export async function down(knex: Knex): Promise<void> {
const helper = getHelpers(knex).schema;
const isMysql = helper.isOneOfClients(['mysql']);
if (isMysql) {
await dropConstraint(knex);
}
await knex.schema.alterTable('directus_shares', (table) => {
if (knex.client.constructor.name === 'Client_MySQL') {
// Temporary drop foreign key constraint, see https://github.com/directus/directus/issues/19399
table.dropForeign('collection', 'directus_shares_collection_foreign');
}
table.setNullable('collection');
if (knex.client.constructor.name === 'Client_MySQL') {
// Recreate foreign key constraint, from 20211211A-add-shares.ts
table.foreign('collection').references('directus_collections.collection').onDelete('CASCADE');
}
table.setNullable('item');
});
if (isMysql) {
await recreateConstraint(knex);
}
}
/**
* Temporarily drop foreign key constraint for MySQL instances, see https://github.com/directus/directus/issues/19399
*/
async function dropConstraint(knex: Knex) {
const inspector = createInspector(knex);
const foreignKeys = await inspector.foreignKeys('directus_shares');
const collectionForeignKeys = foreignKeys.filter((fk) => fk.column === 'collection');
const constraintName = collectionForeignKeys[0]?.constraint_name;
if (constraintName && collectionForeignKeys.length === 1) {
await knex.schema.alterTable('directus_shares', (table) => {
table.dropForeign('collection', constraintName);
});
} else {
logger.warn(`Unexpected number of foreign key constraints on 'directus_shares.collection':`);
logger.warn(JSON.stringify(collectionForeignKeys, null, 4));
}
}
/**
* Recreate foreign key constraint for MySQL instances, from 20211211A-add-shares.ts
*/
async function recreateConstraint(knex: Knex) {
return knex.schema.alterTable('directus_shares', async (table) => {
table.foreign('collection').references('directus_collections.collection').onDelete('CASCADE');
});
}