n8n/packages/nodes-base/nodes/MoveBinaryData/MoveBinaryData.node.ts

499 lines
12 KiB
TypeScript
Raw Normal View History

import {
get,
set,
unset,
} from 'lodash';
import {
BINARY_ENCODING,
} from 'n8n-core';
import { IExecuteFunctions } from 'n8n-core';
import {
IBinaryData,
IDataObject,
INodeExecutionData,
INodePropertyOptions,
INodeType,
INodeTypeDescription,
:sparkles: Improve node error handling (#1309) * Add path mapping and response error interfaces * Add error handling and throwing functionality * Refactor error handling into a single function * Re-implement error handling in Hacker News node * Fix linting details * Re-implement error handling in Spotify node * Re-implement error handling in G Suite Admin node * :construction: create basic setup NodeError * :construction: add httpCodes * :construction: add path priolist * :construction: handle statusCode in error, adjust interfaces * :construction: fixing type issues w/Ivan * :construction: add error exploration * 👔 fix linter issues * :wrench: improve object check * :construction: remove path passing from NodeApiError * :construction: add multi error + refactor findProperty method * 👔 allow any * :wrench: handle multi error message callback * :zap: change return type of callback * :zap: add customCallback to MultiError * :construction: refactor to use INode * :hammer: handle arrays, continue search after first null property found * 🚫 refactor method access * :construction: setup NodeErrorView * :zap: change timestamp to Date.now * :books: Add documentation for methods and constants * :construction: change message setting * 🚚 move NodeErrors to workflow * :sparkles: add new ErrorView for Nodes * :art: improve error notification * :art: refactor interfaces * :zap: add WorkflowOperationError, refactor error throwing * 👕 fix linter issues * :art: rename param * :bug: fix handling normal errors * :zap: add usage of NodeApiError * :art: fix throw new error instead of constructor * :art: remove unnecessary code/comments * :art: adjusted spacing + updated status messages * :art: fix tab indentation * ✨ Replace current errors with custom errors (#1576) * :zap: Introduce NodeApiError in catch blocks * :zap: Introduce NodeOperationError in nodes * :zap: Add missing errors and remove incompatible * :zap: Fix NodeOperationError in incompatible nodes * :wrench: Adjust error handling in missed nodes PayPal, FileMaker, Reddit, Taiga and Facebook Graph API nodes * :hammer: Adjust Strava Trigger node error handling * :hammer: Adjust AWS nodes error handling * :hammer: Remove duplicate instantiation of NodeApiError * :bug: fix strava trigger node error handling * Add XML parsing to NodeApiError constructor (#1633) * :bug: Remove type annotation from catch variable * :sparkles: Add XML parsing to NodeApiError * :zap: Simplify error handling in Rekognition node * :zap: Pass in XML flag in generic functions * :fire: Remove try/catch wrappers at call sites * :hammer: Refactor setting description from XML * :hammer: Refactor let to const in resource loaders * :zap: Find property in parsed XML * :zap: Change let to const * :fire: Remove unneeded try/catch block * :shirt: Fix linting issues * :bug: Fix errors from merge conflict resolution * :zap: Add custom errors to latest contributions * :shirt: Fix linting issues * :zap: Refactor MongoDB helpers for custom errors * :bug: Correct custom error type * :zap: Apply feedback to A nodes * :zap: Apply feedback to missed A node * :zap: Apply feedback to B-D nodes * :zap: Apply feedback to E-F nodes * :zap: Apply feedback to G nodes * :zap: Apply feedback to H-L nodes * :zap: Apply feedback to M nodes * :zap: Apply feedback to P nodes * :zap: Apply feedback to R nodes * :zap: Apply feedback to S nodes * :zap: Apply feedback to T nodes * :zap: Apply feedback to V-Z nodes * :zap: Add HTTP code to iterable node error * :hammer: Standardize e as error * :hammer: Standardize err as error * :zap: Fix error handling for non-standard nodes Co-authored-by: Ben Hesseldieck <b.hesseldieck@gmail.com> Co-authored-by: Ben Hesseldieck <b.hesseldieck@gmail.com> Co-authored-by: Ben Hesseldieck <1849459+BHesseldieck@users.noreply.github.com>
2021-04-16 09:33:36 -07:00
NodeOperationError,
} from 'n8n-workflow';
import * as iconv from 'iconv-lite';
iconv.encodingExists('utf8');
// Create options for bomAware and encoding
const bomAware: string[] = [];
const encodeDecodeOptions: INodePropertyOptions[] = [];
2021-03-25 05:19:11 -07:00
const encodings = (iconv as any).encodings; // tslint:disable-line:no-any
Object.keys(encodings).forEach(encoding => {
if (!(encoding.startsWith('_') || typeof encodings[encoding] === 'string')) { // only encodings without direct alias or internals
if (encodings[encoding].bomAware) {
bomAware.push(encoding);
}
encodeDecodeOptions.push({ name: encoding, value: encoding });
}
});
encodeDecodeOptions.sort((a, b) => {
if (a.name < b.name) { return -1; }
if (a.name > b.name) { return 1; }
return 0;
});
export class MoveBinaryData implements INodeType {
description: INodeTypeDescription = {
displayName: 'Move Binary Data',
name: 'moveBinaryData',
icon: 'fa:exchange-alt',
group: ['transform'],
version: 1,
subtitle: '={{$parameter["mode"]==="binaryToJson" ? "Binary to JSON" : "JSON to Binary"}}',
description: 'Move data between binary and JSON properties',
defaults: {
name: 'Move Binary Data',
color: '#7722CC',
},
inputs: ['main'],
outputs: ['main'],
properties: [
{
displayName: 'Mode',
name: 'mode',
type: 'options',
options: [
{
name: 'Binary to JSON',
value: 'binaryToJson',
description: 'Move data from Binary to JSON',
},
{
name: 'JSON to Binary',
value: 'jsonToBinary',
description: 'Move data from JSON to Binary.',
},
],
default: 'binaryToJson',
description: 'From and to where data should be moved.',
},
// ----------------------------------
// binaryToJson
// ----------------------------------
{
displayName: 'Set all Data',
name: 'setAllData',
type: 'boolean',
displayOptions: {
show: {
mode: [
'binaryToJson',
],
},
},
default: true,
:zap: Remove unnessasry <br/> (#2340) * introduce analytics * add user survey backend * add user survey backend * set answers on survey submit Co-authored-by: Mutasem Aldmour <4711238+mutdmour@users.noreply.github.com> * change name to personalization * lint Co-authored-by: Mutasem Aldmour <4711238+mutdmour@users.noreply.github.com> * N8n 2495 add personalization modal (#2280) * update modals * add onboarding modal * implement questions * introduce analytics * simplify impl * implement survey handling * add personalized cateogry * update modal behavior * add thank you view * handle empty cases * rename modal * standarize modal names * update image, add tags to headings * remove unused file * remove unused interfaces * clean up footer spacing * introduce analytics * refactor to fix bug * update endpoint * set min height * update stories * update naming from questions to survey * remove spacing after core categories * fix bug in logic * sort nodes * rename types * merge with be * rename userSurvey * clean up rest api * use constants for keys * use survey keys * clean up types * move personalization to its own file Co-authored-by: ahsan-virani <ahsan.virani@gmail.com> * update parameter inputs to be multiline * update spacing * Survey new options (#2300) * split up options * fix quotes * remove unused import * refactor node credentials * add user created workflow event (#2301) * update multi params * simplify env vars * fix versionCli on FE * update personalization env * clean up node detail settings * fix event User opened Credentials panel * fix font sizes across modals * clean up input spacing * fix select modal spacing * increase spacing * fix input copy * fix webhook, tab spacing, retry button * fix button sizes * fix button size * add mini xlarge sizes * fix webhook spacing * fix nodes panel event * fix workflow id in workflow execute event * improve telemetry error logging * fix config and stop process events * add flush call on n8n stop * ready for release * fix input error highlighting * revert change * update toggle spacing * fix delete positioning * keep tooltip while focused * set strict size * increase left spacing * fix sort icons * remove unnessasry <br/> * remove unnessary break * remove unnessary margin * clean unused functionality * remove unnessary css * remove duplicate tracking * only show tooltip when hovering over label * remove extra space * add br * remove extra space * clean up commas * clean up commas * remove extra space * remove extra space * rewrite desc * add commas * add space * remove extra space * add space * add dot * update credentials section * use includes Co-authored-by: ahsan-virani <ahsan.virani@gmail.com> Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
2021-10-27 13:00:13 -07:00
description: 'If all JSON data should be replaced with the data retrieved from binary key. Else the data will be written to a single key.',
},
{
displayName: 'Source Key',
name: 'sourceKey',
type: 'string',
displayOptions: {
show: {
mode: [
'binaryToJson',
],
},
},
default: 'data',
required: true,
placeholder: 'data',
description: 'The name of the binary key to get data from. It is also possible to define deep keys by using dot-notation like for example: "level1.level2.currentKey"',
},
{
displayName: 'Destination Key',
name: 'destinationKey',
type: 'string',
displayOptions: {
show: {
mode: [
'binaryToJson',
],
setAllData: [
false,
],
},
},
default: 'data',
required: true,
placeholder: '',
description: 'The name the JSON key to copy data to. It is also possible to define deep keys by using dot-notation like for example: "level1.level2.newKey"',
},
// ----------------------------------
// jsonToBinary
// ----------------------------------
{
displayName: 'Convert all Data',
name: 'convertAllData',
type: 'boolean',
displayOptions: {
show: {
mode: [
'jsonToBinary',
],
},
},
default: true,
description: 'If all JSON data should be converted to binary. Else only the data of one key will be converted.',
},
{
displayName: 'Source Key',
name: 'sourceKey',
type: 'string',
displayOptions: {
show: {
convertAllData: [
false,
],
mode: [
'jsonToBinary',
],
},
},
default: 'data',
required: true,
placeholder: 'data',
description: 'The name of the JSON key to get data from. It is also possible to define deep keys by using dot-notation like for example: "level1.level2.currentKey"',
},
{
displayName: 'Destination Key',
name: 'destinationKey',
type: 'string',
displayOptions: {
show: {
mode: [
'jsonToBinary',
],
},
},
default: 'data',
required: true,
placeholder: 'data',
description: 'The name the binary key to copy data to. It is also possible to define deep keys by using dot-notation like for example: "level1.level2.newKey"',
},
{
displayName: 'Options',
name: 'options',
type: 'collection',
placeholder: 'Add Option',
default: {},
options: [
{
displayName: 'Data Is Base64',
name: 'dataIsBase64',
type: 'boolean',
displayOptions: {
hide: {
'useRawData': [
true,
],
},
show: {
'/mode': [
'jsonToBinary',
],
'/convertAllData': [
false,
],
},
},
default: false,
description: 'Keeps the binary data as base64 string.',
},
{
displayName: 'Encoding',
name: 'encoding',
type: 'options',
options: encodeDecodeOptions,
displayOptions: {
show: {
'/mode': [
'binaryToJson',
'jsonToBinary',
],
},
},
default: 'utf8',
description: 'Set the encoding of the data stream',
},
{
displayName: 'Strip BOM',
name: 'stripBOM',
displayOptions: {
show: {
'/mode': [
'binaryToJson',
],
2021-03-25 05:19:11 -07:00
encoding: bomAware,
},
},
type: 'boolean',
default: true,
},
{
displayName: 'Add BOM',
name: 'addBOM',
displayOptions: {
show: {
'/mode': [
'jsonToBinary',
],
2021-03-25 05:19:11 -07:00
encoding: bomAware,
},
},
type: 'boolean',
default: false,
},
{
displayName: 'File Name',
name: 'fileName',
type: 'string',
displayOptions: {
show: {
'/mode': [
'jsonToBinary',
],
},
},
default: '',
placeholder: 'example.json',
description: 'The file name to set.',
},
{
displayName: 'JSON Parse',
name: 'jsonParse',
type: 'boolean',
displayOptions: {
hide: {
'keepAsBase64': [
true,
],
},
show: {
'/mode': [
'binaryToJson',
],
'/setAllData': [
2020-10-22 06:46:03 -07:00
false,
],
},
},
default: false,
description: 'Run JSON parse on the data to get proper object data.',
},
{
displayName: 'Keep Source',
name: 'keepSource',
type: 'boolean',
default: false,
description: 'If the source key should be kept. By default it will be deleted.',
},
{
displayName: 'Keep As Base64',
name: 'keepAsBase64',
type: 'boolean',
displayOptions: {
hide: {
'jsonParse': [
true,
],
},
show: {
'/mode': [
'binaryToJson',
],
'/setAllData': [
false,
],
},
},
default: false,
description: 'Keeps the binary data as base64 string.',
},
{
displayName: 'Mime Type',
name: 'mimeType',
type: 'string',
displayOptions: {
show: {
'/mode': [
'jsonToBinary',
],
},
},
default: 'application/json',
placeholder: 'application/json',
description: 'The mime-type to set. By default will the mime-type for JSON be set.',
},
{
displayName: 'Use Raw Data',
name: 'useRawData',
type: 'boolean',
displayOptions: {
hide: {
'dataIsBase64': [
true,
],
},
show: {
'/mode': [
'jsonToBinary',
],
},
},
default: false,
description: 'Use data as is and do not JSON.stringify it.',
},
],
2020-10-22 06:46:03 -07:00
},
],
};
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const items = this.getInputData();
const mode = this.getNodeParameter('mode', 0) as string;
const returnData: INodeExecutionData[] = [];
let item: INodeExecutionData;
let newItem: INodeExecutionData;
let options: IDataObject;
for (let itemIndex = 0; itemIndex < items.length; itemIndex++) {
item = items[itemIndex];
options = this.getNodeParameter('options', itemIndex, {}) as IDataObject;
// Copy the whole JSON data as data on any level can be renamed
newItem = {
json: {},
};
if (mode === 'binaryToJson') {
const setAllData = this.getNodeParameter('setAllData', itemIndex) as boolean;
const sourceKey = this.getNodeParameter('sourceKey', itemIndex) as string;
const value = get(item.binary, sourceKey);
if (value === undefined) {
// No data found so skip
continue;
}
const encoding = (options.encoding as string) || 'utf8';
let convertedValue = value.data;
if (setAllData === true) {
// Set the full data
convertedValue = iconv.decode(Buffer.from(convertedValue, BINARY_ENCODING), encoding, { stripBOM: options.stripBOM as boolean });
newItem.json = JSON.parse(convertedValue);
} else {
// Does get added to existing data so copy it first
newItem.json = JSON.parse(JSON.stringify(item.json));
if (options.keepAsBase64 !== true) {
convertedValue = iconv.decode(Buffer.from(convertedValue, BINARY_ENCODING), encoding, { stripBOM: options.stripBOM as boolean });
}
if (options.jsonParse) {
convertedValue = JSON.parse(convertedValue);
}
const destinationKey = this.getNodeParameter('destinationKey', itemIndex, '') as string;
set(newItem.json, destinationKey, convertedValue);
}
if (options.keepSource === true) {
// Binary data does not get touched so simply reference it
newItem.binary = item.binary;
} else {
// Binary data will change so copy it
newItem.binary = JSON.parse(JSON.stringify(item.binary));
unset(newItem.binary, sourceKey);
}
} else if (mode === 'jsonToBinary') {
const convertAllData = this.getNodeParameter('convertAllData', itemIndex) as boolean;
const destinationKey = this.getNodeParameter('destinationKey', itemIndex) as string;
const encoding = (options.encoding as string) || 'utf8';
let value: IDataObject | string = item.json;
if (convertAllData === false) {
const sourceKey = this.getNodeParameter('sourceKey', itemIndex) as string;
value = get(item.json, sourceKey) as IDataObject;
}
if (value === undefined) {
// No data found so skip
continue;
}
if (item.binary !== undefined) {
// Item already has binary data so copy it
newItem.binary = JSON.parse(JSON.stringify(item.binary));
} else {
// Item does not have binary data yet so initialize empty
newItem.binary = {};
}
if (options.dataIsBase64 !== true) {
if (options.useRawData !== true) {
value = JSON.stringify(value);
}
value = iconv.encode(value as string, encoding, { addBOM: options.addBOM as boolean }).toString(BINARY_ENCODING);
}
const convertedValue: IBinaryData = {
data: value as string,
mimeType: (options.mimeType as string) || 'application/json',
};
if (options.fileName) {
convertedValue.fileName = options.fileName as string;
}
set(newItem.binary!, destinationKey, convertedValue);
if (options.keepSource === true) {
// JSON data does not get touched so simply reference it
newItem.json = item.json;
} else {
// JSON data will change so copy it
if (convertAllData === true) {
// Data should not be kept and all data got converted. So simply set new as empty
newItem.json = {};
} else {
// Data should not be kept and only one key has to get removed. So copy all
// data and then remove the not needed one
newItem.json = JSON.parse(JSON.stringify(item.json));
const sourceKey = this.getNodeParameter('sourceKey', itemIndex) as string;
unset(newItem.json, sourceKey);
}
}
} else {
:sparkles: Improve node error handling (#1309) * Add path mapping and response error interfaces * Add error handling and throwing functionality * Refactor error handling into a single function * Re-implement error handling in Hacker News node * Fix linting details * Re-implement error handling in Spotify node * Re-implement error handling in G Suite Admin node * :construction: create basic setup NodeError * :construction: add httpCodes * :construction: add path priolist * :construction: handle statusCode in error, adjust interfaces * :construction: fixing type issues w/Ivan * :construction: add error exploration * 👔 fix linter issues * :wrench: improve object check * :construction: remove path passing from NodeApiError * :construction: add multi error + refactor findProperty method * 👔 allow any * :wrench: handle multi error message callback * :zap: change return type of callback * :zap: add customCallback to MultiError * :construction: refactor to use INode * :hammer: handle arrays, continue search after first null property found * 🚫 refactor method access * :construction: setup NodeErrorView * :zap: change timestamp to Date.now * :books: Add documentation for methods and constants * :construction: change message setting * 🚚 move NodeErrors to workflow * :sparkles: add new ErrorView for Nodes * :art: improve error notification * :art: refactor interfaces * :zap: add WorkflowOperationError, refactor error throwing * 👕 fix linter issues * :art: rename param * :bug: fix handling normal errors * :zap: add usage of NodeApiError * :art: fix throw new error instead of constructor * :art: remove unnecessary code/comments * :art: adjusted spacing + updated status messages * :art: fix tab indentation * ✨ Replace current errors with custom errors (#1576) * :zap: Introduce NodeApiError in catch blocks * :zap: Introduce NodeOperationError in nodes * :zap: Add missing errors and remove incompatible * :zap: Fix NodeOperationError in incompatible nodes * :wrench: Adjust error handling in missed nodes PayPal, FileMaker, Reddit, Taiga and Facebook Graph API nodes * :hammer: Adjust Strava Trigger node error handling * :hammer: Adjust AWS nodes error handling * :hammer: Remove duplicate instantiation of NodeApiError * :bug: fix strava trigger node error handling * Add XML parsing to NodeApiError constructor (#1633) * :bug: Remove type annotation from catch variable * :sparkles: Add XML parsing to NodeApiError * :zap: Simplify error handling in Rekognition node * :zap: Pass in XML flag in generic functions * :fire: Remove try/catch wrappers at call sites * :hammer: Refactor setting description from XML * :hammer: Refactor let to const in resource loaders * :zap: Find property in parsed XML * :zap: Change let to const * :fire: Remove unneeded try/catch block * :shirt: Fix linting issues * :bug: Fix errors from merge conflict resolution * :zap: Add custom errors to latest contributions * :shirt: Fix linting issues * :zap: Refactor MongoDB helpers for custom errors * :bug: Correct custom error type * :zap: Apply feedback to A nodes * :zap: Apply feedback to missed A node * :zap: Apply feedback to B-D nodes * :zap: Apply feedback to E-F nodes * :zap: Apply feedback to G nodes * :zap: Apply feedback to H-L nodes * :zap: Apply feedback to M nodes * :zap: Apply feedback to P nodes * :zap: Apply feedback to R nodes * :zap: Apply feedback to S nodes * :zap: Apply feedback to T nodes * :zap: Apply feedback to V-Z nodes * :zap: Add HTTP code to iterable node error * :hammer: Standardize e as error * :hammer: Standardize err as error * :zap: Fix error handling for non-standard nodes Co-authored-by: Ben Hesseldieck <b.hesseldieck@gmail.com> Co-authored-by: Ben Hesseldieck <b.hesseldieck@gmail.com> Co-authored-by: Ben Hesseldieck <1849459+BHesseldieck@users.noreply.github.com>
2021-04-16 09:33:36 -07:00
throw new NodeOperationError(this.getNode(), `The operation "${mode}" is not known!`);
}
returnData.push(newItem);
}
return [returnData];
}
}