Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(WhatsApp Node): Avoid using BinaryDataManager directly from n8n-core #5544

Merged
merged 1 commit into from
Feb 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 28 additions & 24 deletions packages/nodes-base/nodes/WhatsApp/MediaFunctions.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,38 +3,42 @@ import { NodeOperationError } from 'n8n-workflow';

import FormData from 'form-data';

export async function setupUpload(
export async function getUploadFormData(
this: IExecuteSingleFunctions,
requestOptions: IHttpRequestOptions,
) {
const mediaPropertyName = this.getNodeParameter('mediaPropertyName') as string;
if (!mediaPropertyName) {
return requestOptions;
}
if (this.getInputData().binary?.[mediaPropertyName] === undefined || !mediaPropertyName.trim()) {
throw new NodeOperationError(this.getNode(), 'Could not find file in node input data', {
description: `There’s no key called '${mediaPropertyName}' with binary data in it`,
});
}
const binaryFile = this.getInputData().binary![mediaPropertyName]!;
): Promise<{ fileName: string; formData: FormData }> {
const mediaPropertyName = ((this.getNodeParameter('mediaPropertyName') as string) || '').trim();
if (!mediaPropertyName)
throw new NodeOperationError(this.getNode(), 'Parameter "mediaPropertyName" is not defined');

const { binary: binaryData } = this.getInputData();
if (!binaryData) throw new NodeOperationError(this.getNode(), 'Binary data missing in input');

const binaryFile = binaryData[mediaPropertyName];
if (binaryFile === undefined)
throw new NodeOperationError(this.getNode(), 'Could not find file in node input data');

const mediaFileName = (this.getNodeParameter('additionalFields') as IDataObject).mediaFileName as
| string
| undefined;
const binaryFileName = binaryFile.fileName;
if (!mediaFileName && !binaryFileName) {

const fileName = mediaFileName || binaryFile.fileName;
if (!fileName)
throw new NodeOperationError(this.getNode(), 'No file name given for media upload.');
}
const mimeType = binaryFile.mimeType;

const buffer = await this.helpers.getBinaryDataBuffer(mediaPropertyName);

const data = new FormData();
data.append('file', buffer, {
contentType: mimeType,
filename: mediaFileName || binaryFileName,
});
data.append('messaging_product', 'whatsapp');
const formData = new FormData();
formData.append('file', buffer, { contentType: binaryFile.mimeType, filename: fileName });
formData.append('messaging_product', 'whatsapp');

requestOptions.body = data;
return { fileName, formData };
}

export async function setupUpload(
this: IExecuteSingleFunctions,
requestOptions: IHttpRequestOptions,
) {
const uploadData = await getUploadFormData.call(this);
requestOptions.body = uploadData.formData;
return requestOptions;
}
37 changes: 5 additions & 32 deletions packages/nodes-base/nodes/WhatsApp/MessageFunctions.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import set from 'lodash.set';
import { BinaryDataManager } from 'n8n-core';
import type {
IDataObject,
IExecuteSingleFunctions,
Expand All @@ -8,9 +7,9 @@ import type {
INodeExecutionData,
JsonObject,
} from 'n8n-workflow';
import { NodeApiError, NodeOperationError } from 'n8n-workflow';
import { NodeApiError } from 'n8n-workflow';

import FormData from 'form-data';
import { getUploadFormData } from './MediaFunctions';

interface WhatsAppApiError {
error: {
Expand Down Expand Up @@ -62,37 +61,15 @@ export async function mediaUploadFromItem(
this: IExecuteSingleFunctions,
requestOptions: IHttpRequestOptions,
) {
const mediaPropertyName = this.getNodeParameter('mediaPropertyName') as string;
if (this.getInputData().binary?.[mediaPropertyName] === undefined) {
throw new NodeOperationError(
this.getNode(),
`The binary property "${mediaPropertyName}" does not exist. So no file can be written!`,
);
}
const binaryFile = this.getInputData().binary![mediaPropertyName]!;
const mediaFileName = (this.getNodeParameter('additionalFields') as IDataObject).mediaFilename as
| string
| undefined;
const binaryFileName = binaryFile.fileName;
if (!mediaFileName && !binaryFileName) {
throw new NodeOperationError(this.getNode(), 'No file name given for media upload.');
}
const mimeType = binaryFile.mimeType;

const data = new FormData();
data.append('file', await BinaryDataManager.getInstance().retrieveBinaryData(binaryFile), {
contentType: mimeType,
filename: mediaFileName || binaryFileName,
});
data.append('messaging_product', 'whatsapp');
const uploadData = await getUploadFormData.call(this);

const phoneNumberId = this.getNodeParameter('phoneNumberId') as string;

const result = (await this.helpers.httpRequestWithAuthentication.call(this, 'whatsAppApi', {
url: `/${phoneNumberId}/media`,
baseURL: requestOptions.baseURL,
method: 'POST',
body: data,
body: uploadData.formData,
})) as IDataObject;

const operation = this.getNodeParameter('messageType') as string;
Expand All @@ -101,11 +78,7 @@ export async function mediaUploadFromItem(
}
set(requestOptions.body as IDataObject, `${operation}.id`, result.id);
if (operation === 'document') {
set(
requestOptions.body as IDataObject,
`${operation}.filename`,
mediaFileName || binaryFileName,
);
set(requestOptions.body as IDataObject, `${operation}.filename`, uploadData.fileName);
}

return requestOptions;
Expand Down