feat(core, editor): Support pairedItem for pinned data (#3843)

* 📘 Adjust interface * ⚡ Adjust pindata in state store * ✨ Add utils * ⚡ Replace utils calls * ⚡ Adjust pindata intake and display * 🔥 Remove excess BE fixes * 📝 Update comment * 🧪 Adjust tests * 🔥 Remove unneeded helper * 🚚 Improve naming * 🧹 Clean up `ormconfig.ts` * 📘 Add types and type guards * ⚡ Improve serializer for sqlite * ✨ Create migration utils * ⚡ Set up sqlite serializer * 🗃️ Write sqlite migration * 🗃️ Write MySQL migration * 🗃️ Write Postgres migration * ⚡ Add imports and exports to barrels * 🚚 Rename `runChunked` to `runInBatches` * ⚡ Improve migration loggers * ♻️ Address feedback * 🚚 Improve naming
2025-12-19 02:51:14 +00:00 · 2022-08-22 17:46:22 +02:00
parent 6bd7a09a45
commit b1e715299d
24 changed files with 399 additions and 143 deletions
--- a/packages/cli/src/databases/migrations/sqlite/1659888469333-AddJsonKeyPinData.ts
+++ b/packages/cli/src/databases/migrations/sqlite/1659888469333-AddJsonKeyPinData.ts
@@ -0,0 +1,93 @@
+import {
+	logMigrationStart,
+	logMigrationEnd,
+	runInBatches,
+	getTablePrefix,
+	escapeQuery,
+} from '../../utils/migrationHelpers';
+import type { MigrationInterface, QueryRunner } from 'typeorm';
+import { isJsonKeyObject, PinData } from '../../utils/migrations.types';
+
+/**
+ * Convert TEXT-type `pinData` column in `workflow_entity` table from
+ * `{ [nodeName: string]: IDataObject[] }` to `{ [nodeName: string]: INodeExecutionData[] }`
+ */
+export class AddJsonKeyPinData1659888469333 implements MigrationInterface {
+	name = 'AddJsonKeyPinData1659888469333';
+
+	async up(queryRunner: QueryRunner) {
+		logMigrationStart(this.name);
+
+		const workflowTable = `${getTablePrefix()}workflow_entity`;
+
+		const PINDATA_SELECT_QUERY = `
+			SELECT id, pinData
+			FROM "${workflowTable}"
+			WHERE pinData IS NOT NULL;
+		`;
+
+		const PINDATA_UPDATE_STATEMENT = `
+			UPDATE "${workflowTable}"
+			SET "pinData" = :pinData
+			WHERE id = :id;
+		`;
+
+		await runInBatches(
+			queryRunner,
+			PINDATA_SELECT_QUERY,
+			addJsonKeyToPinDataColumn(queryRunner, PINDATA_UPDATE_STATEMENT),
+		);
+
+		logMigrationEnd(this.name);
+	}
+
+	async down() {
+		// irreversible migration
+	}
+}
+
+export const addJsonKeyToPinDataColumn =
+	(queryRunner: QueryRunner, updateStatement: string) =>
+	async (fetchedWorkflows: PinData.FetchedWorkflow[]) => {
+		makeUpdateParams(fetchedWorkflows).forEach((param) => {
+			const params = {
+				pinData: param.pinData,
+				id: param.id,
+			};
+
+			const [escapedStatement, escapedParams] = escapeQuery(queryRunner, updateStatement, params);
+
+			queryRunner.query(escapedStatement, escapedParams);
+		});
+	};
+
+function makeUpdateParams(fetchedWorkflows: PinData.FetchedWorkflow[]) {
+	return fetchedWorkflows.reduce<PinData.FetchedWorkflow[]>(
+		(updateParams, { id, pinData: rawPinData }) => {
+			const pinDataPerWorkflow: PinData.Old | PinData.New =
+				typeof rawPinData === 'string' ? JSON.parse(rawPinData) : rawPinData;
+
+			const newPinDataPerWorkflow = Object.keys(pinDataPerWorkflow).reduce<PinData.New>(
+				(newPinDataPerWorkflow, nodeName) => {
+					const pinDataPerNode = pinDataPerWorkflow[nodeName];
+
+					if (pinDataPerNode.every((item) => item.json)) return newPinDataPerWorkflow;
+
+					newPinDataPerWorkflow[nodeName] = pinDataPerNode.map((item) =>
+						isJsonKeyObject(item) ? item : { json: item },
+					);
+
+					return newPinDataPerWorkflow;
+				},
+				{},
+			);
+
+			if (Object.keys(newPinDataPerWorkflow).length > 0) {
+				updateParams.push({ id, pinData: JSON.stringify(newPinDataPerWorkflow) });
+			}
+
+			return updateParams;
+		},
+		[],
+	);
+}