fix(MongoDB Node): Stringify response ObjectIDs (#6990)

Github issue / Community forum post (link here to close automatically):
n8n-io · Aug 29, 2023 · 9ca990b · 9ca990b
1 parent 8a01d06
commit 9ca990b
Show file tree

Hide file tree

Showing 4 changed files with 320 additions and 307 deletions.
diff --git a/packages/nodes-base/nodes/MongoDb/GenericFunctions.ts b/packages/nodes-base/nodes/MongoDb/GenericFunctions.ts
@@ -6,15 +6,15 @@ import type {
 } from 'n8n-workflow';
 import { NodeOperationError } from 'n8n-workflow';
 
+import get from 'lodash/get';
+import set from 'lodash/set';
+import { ObjectId } from 'mongodb';
 import type {
 	IMongoCredentials,
 	IMongoCredentialsType,
 	IMongoParametricCredentials,
 } from './mongoDb.types';
 
-import get from 'lodash/get';
-import set from 'lodash/set';
-
 /**
  * Standard way of building the MongoDB connection string, unless overridden with a provided string
  *
@@ -129,3 +129,14 @@ export function prepareFields(fields: string) {
 		.map((field) => field.trim())
 		.filter((field) => !!field);
 }
+
+export function stringifyObjectIDs(items: IDataObject[]) {
+	items.forEach((item) => {
+		if (item._id instanceof ObjectId) {
+			item._id = item._id.toString();
+		}
+		if (item.id instanceof ObjectId) {
+			item.id = item.id.toString();
+		}
+	});
+}
diff --git a/packages/nodes-base/nodes/MongoDb/MongoDb.node.ts b/packages/nodes-base/nodes/MongoDb/MongoDb.node.ts
@@ -11,27 +11,47 @@ import type {
 } from 'n8n-workflow';
 import { NodeOperationError } from 'n8n-workflow';
 
-import { nodeDescription } from './MongoDbDescription';
-
-import {
-	buildParameterizedConnString,
-	prepareFields,
-	prepareItems,
-	validateAndResolveMongoCredentials,
-} from './GenericFunctions';
-
 import type {
 	FindOneAndReplaceOptions,
 	FindOneAndUpdateOptions,
 	UpdateOptions,
 	Sort,
 } from 'mongodb';
 import { MongoClient, ObjectId } from 'mongodb';
+import { nodeProperties } from './MongoDbProperties';
+
+import {
+	buildParameterizedConnString,
+	prepareFields,
+	prepareItems,
+	stringifyObjectIDs,
+	validateAndResolveMongoCredentials,
+} from './GenericFunctions';
 
 import type { IMongoParametricCredentials } from './mongoDb.types';
 
 export class MongoDb implements INodeType {
-	description: INodeTypeDescription = nodeDescription;
+	description: INodeTypeDescription = {
+		displayName: 'MongoDB',
+		name: 'mongoDb',
+		icon: 'file:mongodb.svg',
+		group: ['input'],
+		version: 1,
+		description: 'Find, insert and update documents in MongoDB',
+		defaults: {
+			name: 'MongoDB',
+		},
+		inputs: ['main'],
+		outputs: ['main'],
+		credentials: [
+			{
+				name: 'mongoDb',
+				required: true,
+				testedBy: 'mongoDbCredentialTest',
+			},
+		],
+		properties: nodeProperties,
+	};
 
 	methods = {
 		credentialTest: {
@@ -65,7 +85,7 @@ export class MongoDb implements INodeType {
 				} catch (error) {
 					return {
 						status: 'Error',
-						message: error.message,
+						message: (error as Error).message,
 					};
 				}
 				return {
@@ -98,15 +118,17 @@ export class MongoDb implements INodeType {
 			// ----------------------------------
 
 			try {
-				const queryParameter = JSON.parse(this.getNodeParameter('query', 0) as string);
+				const queryParameter = JSON.parse(
+					this.getNodeParameter('query', 0) as string,
+				) as IDataObject;
 
 				if (queryParameter._id && typeof queryParameter._id === 'string') {
-					queryParameter._id = new ObjectId(queryParameter._id as string);
+					queryParameter._id = new ObjectId(queryParameter._id);
 				}
 
 				const query = mdb
 					.collection(this.getNodeParameter('collection', 0) as string)
-					.aggregate(queryParameter as Document[]);
+					.aggregate(queryParameter as unknown as Document[]);
 
 				responseData = await query.toArray();
 			} catch (error) {
@@ -140,20 +162,22 @@ export class MongoDb implements INodeType {
 			// ----------------------------------
 
 			try {
-				const queryParameter = JSON.parse(this.getNodeParameter('query', 0) as string);
+				const queryParameter = JSON.parse(
+					this.getNodeParameter('query', 0) as string,
+				) as IDataObject;
 
 				if (queryParameter._id && typeof queryParameter._id === 'string') {
-					queryParameter._id = new ObjectId(queryParameter._id as string);
+					queryParameter._id = new ObjectId(queryParameter._id);
 				}
 
 				let query = mdb
 					.collection(this.getNodeParameter('collection', 0) as string)
-					.find(queryParameter as Document);
+					.find(queryParameter as unknown as Document);
 
 				const options = this.getNodeParameter('options', 0);
 				const limit = options.limit as number;
 				const skip = options.skip as number;
-				const sort: Sort = options.sort && JSON.parse(options.sort as string);
+				const sort = options.sort && (JSON.parse(options.sort as string) as Sort);
 				if (skip > 0) {
 					query = query.skip(skip);
 				}
@@ -339,6 +363,8 @@ export class MongoDb implements INodeType {
 
 		await client.close();
 
+		stringifyObjectIDs(responseData);
+
 		const executionData = this.helpers.constructExecutionMetaData(
 			this.helpers.returnJsonArray(responseData),
 			{ itemData: { item: 0 } },