n8n/packages/nodes-base/nodes/Harvest/GenericFunctions.ts

117 lines
2.8 KiB
TypeScript
Raw Normal View History

import { OptionsWithUri } from 'request';
2020-01-28 06:46:38 -08:00
import {
IExecuteFunctions,
IExecuteSingleFunctions,
IHookFunctions,
ILoadOptionsFunctions,
} from 'n8n-core';
import { IDataObject, NodeApiError } from 'n8n-workflow';
2020-01-28 06:46:38 -08:00
export async function harvestApiRequest(
this: IHookFunctions | IExecuteFunctions | IExecuteSingleFunctions | ILoadOptionsFunctions,
method: string,
qs: IDataObject,
path: string,
body: IDataObject = {},
option: IDataObject = {},
uri?: string,
): Promise<any> {
2020-01-28 06:46:38 -08:00
let options: OptionsWithUri = {
headers: {
'Harvest-Account-Id': `${this.getNodeParameter('accountId', 0)}`,
'User-Agent': 'Harvest App',
Authorization: '',
},
2020-01-28 06:46:38 -08:00
method,
body,
uri: uri || `https://api.harvestapp.com/v2/${path}`,
qs,
2020-01-28 06:46:38 -08:00
json: true,
};
options = Object.assign({}, options, option);
if (Object.keys(options.body).length === 0) {
delete options.body;
}
const authenticationMethod = this.getNodeParameter('authentication', 0);
2020-02-03 04:55:21 -08:00
2020-01-28 06:46:38 -08:00
try {
if (authenticationMethod === 'accessToken') {
const credentials = await this.getCredentials('harvestApi');
//@ts-ignore
options.headers.Authorization = `Bearer ${credentials.accessToken}`;
return await this.helpers.request(options);
} else {
return await this.helpers.requestOAuth2.call(this, 'harvestOAuth2Api', options);
}
2020-01-28 06:46:38 -08:00
} catch (error) {
: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 NodeApiError(this.getNode(), error);
2020-01-28 06:46:38 -08:00
}
}
/**
* Make an API request to paginated flow endpoint
* and return all results
*/
export async function harvestApiRequestAllItems(
this: IHookFunctions | IExecuteFunctions | IExecuteSingleFunctions | ILoadOptionsFunctions,
method: string,
qs: IDataObject,
uri: string,
resource: string,
body: IDataObject = {},
option: IDataObject = {},
): Promise<any> {
2020-01-28 06:46:38 -08:00
const returnData: IDataObject[] = [];
let responseData;
do {
responseData = await harvestApiRequest.call(this, method, qs, uri, body, option);
qs.page = responseData.next_page;
returnData.push.apply(returnData, responseData[resource]);
} while (responseData.next_page);
return returnData;
}
/**
* fetch All resource using paginated calls
*/
export async function getAllResource(
this: IExecuteFunctions | ILoadOptionsFunctions,
resource: string,
i: number,
) {
const endpoint = resource;
const qs: IDataObject = {};
const requestMethod = 'GET';
qs.per_page = 100;
const additionalFields = this.getNodeParameter('filters', i);
const returnAll = this.getNodeParameter('returnAll', i);
Object.assign(qs, additionalFields);
let responseData: IDataObject = {};
if (returnAll) {
responseData[resource] = await harvestApiRequestAllItems.call(
this,
requestMethod,
qs,
endpoint,
resource,
);
} else {
const limit = this.getNodeParameter('limit', i);
qs.per_page = limit;
responseData = await harvestApiRequest.call(this, requestMethod, qs, endpoint);
2020-01-28 06:46:38 -08:00
}
return responseData[resource] as IDataObject[];
2020-01-28 06:46:38 -08:00
}