fix(core): Let deduplicateTranslations accept an array of translation tables

Author: brmk

packages/core/src/migration-utils/translation-deduplication.ts

@@ -3,41 +3,50 @@ import { QueryRunner } from 'typeorm';
 
 /**
  * @description
- * Removes duplicate rows from a translation table, keeping only the most recently updated
- * row per `(baseId, languageCode)` pair.
+ * Removes duplicate rows from one or more translation tables, keeping only the most recently
+ * updated row per `(baseId, languageCode)` pair.
  *
  * Prior to the fix for a race condition in `TranslatableSaver.update()`, two concurrent
  * updates could both add a translation for the same language before either had committed,
  * resulting in two rows for the same `(baseId, languageCode)` pair. This is no longer
  * possible going forward, but a unique constraint on translation tables cannot be added to an
  * existing database that already contains such duplicates without first removing them.
  *
+ * This applies to any table backing a `Translation<T>` entity used with `TranslatableSaver`,
+ * including translation tables defined by plugins for their own custom translatable entities —
+ * not just the 13 core tables shown below.
+ *
  * Call this from your migration's `up()` method **before** the unique constraint on the
- * translation table is created, once per affected table. `vendure migrate generate` will
- * generate the DDL that creates the constraints; you only need to add the
- * `deduplicateTranslations` calls ahead of it. On Postgres this looks like (constraint names
- * are deterministic, so `vendure migrate generate` will produce these exact names):
+ * translation table(s) is created. `vendure migrate generate` will generate the DDL that
+ * creates the constraints; you only need to add a `deduplicateTranslations` call ahead of it,
+ * passing either a single table name or an array of table names. On Postgres this looks like
+ * (constraint names are deterministic, so `vendure migrate generate` will produce these exact
+ * names):
  *
  * ```ts
  * import { MigrationInterface, QueryRunner } from 'typeorm';
  * import { deduplicateTranslations } from '\@vendure/core';
  *
  * export class AddTranslationUniqueConstraints1234567890 implements MigrationInterface {
  *     public async up(queryRunner: QueryRunner): Promise<any> {
- *         // --- Remove any pre-existing duplicate rows, one call per translation table ---
- *         await deduplicateTranslations(queryRunner, 'product_translation');
- *         await deduplicateTranslations(queryRunner, 'product_variant_translation');
- *         await deduplicateTranslations(queryRunner, 'product_option_translation');
- *         await deduplicateTranslations(queryRunner, 'product_option_group_translation');
- *         await deduplicateTranslations(queryRunner, 'collection_translation');
- *         await deduplicateTranslations(queryRunner, 'facet_translation');
- *         await deduplicateTranslations(queryRunner, 'facet_value_translation');
- *         await deduplicateTranslations(queryRunner, 'asset_translation');
- *         await deduplicateTranslations(queryRunner, 'api_key_translation');
- *         await deduplicateTranslations(queryRunner, 'payment_method_translation');
- *         await deduplicateTranslations(queryRunner, 'promotion_translation');
- *         await deduplicateTranslations(queryRunner, 'region_translation');
- *         await deduplicateTranslations(queryRunner, 'shipping_method_translation');
+ *         // --- Remove any pre-existing duplicate rows across all core translation tables ---
+ *         await deduplicateTranslations(queryRunner, [
+ *             'product_translation',
+ *             'product_variant_translation',
+ *             'product_option_translation',
+ *             'product_option_group_translation',
+ *             'collection_translation',
+ *             'facet_translation',
+ *             'facet_value_translation',
+ *             'asset_translation',
+ *             'api_key_translation',
+ *             'payment_method_translation',
+ *             'promotion_translation',
+ *             'region_translation',
+ *             'shipping_method_translation',
+ *             // Include any of your own custom translatable entities' tables here too, e.g.:
+ *             // 'my_custom_entity_translation',
+ *         ]);
  *
  *         // --- Auto-generated DDL continues (Postgres) ---
  *         await queryRunner.query(`ALTER TABLE "product_translation" ADD CONSTRAINT "UQ_dcc35f0d2b8d422634e878b813c" UNIQUE ("languageCode", "baseId")`);
@@ -72,6 +81,16 @@ import { QueryRunner } from 'typeorm';
  * @docsCategory migration
  */
 export async function deduplicateTranslations(
+    queryRunner: QueryRunner,
+    translationTableNames: string | string[],
+): Promise<void> {
+    const tableNames = Array.isArray(translationTableNames) ? translationTableNames : [translationTableNames];
+    for (const tableName of tableNames) {
+        await deduplicateTranslationTable(queryRunner, tableName);
+    }
+}
+
+async function deduplicateTranslationTable(
     queryRunner: QueryRunner,
     translationTableName: string,
 ): Promise<void> {