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

116 lines
2.8 KiB
TypeScript
Raw Normal View History

import type { OptionsWithUri } from 'request';
import type {
IExecuteFunctions,
IHookFunctions,
IDataObject,
ILoadOptionsFunctions,
JsonObject,
} from 'n8n-workflow';
import { NodeApiError, NodeOperationError } from 'n8n-workflow';
2019-06-23 03:35:23 -07:00
/**
* Make an API request to Github
*
*/
export async function githubApiRequest(
this: IHookFunctions | IExecuteFunctions | ILoadOptionsFunctions,
method: string,
endpoint: string,
body: object,
query?: object,
option: IDataObject = {},
): Promise<any> {
const options: OptionsWithUri = {
2019-06-23 03:35:23 -07:00
method,
headers: {
'User-Agent': 'n8n',
},
2019-06-23 03:35:23 -07:00
body,
qs: query,
uri: '',
2020-10-22 06:46:03 -07:00
json: true,
2019-06-23 03:35:23 -07:00
};
if (Object.keys(option).length !== 0) {
Object.assign(options, option);
}
2019-06-23 03:35:23 -07:00
try {
const authenticationMethod = this.getNodeParameter(
'authentication',
0,
'accessToken',
) as string;
2022-05-31 00:46:20 -07:00
let credentialType = '';
if (authenticationMethod === 'accessToken') {
const credentials = await this.getCredentials('githubApi');
2022-05-31 00:46:20 -07:00
credentialType = 'githubApi';
const baseUrl = credentials.server || 'https://api.github.com';
options.uri = `${baseUrl}${endpoint}`;
} else {
const credentials = await this.getCredentials('githubOAuth2Api');
2022-05-31 00:46:20 -07:00
credentialType = 'githubOAuth2Api';
const baseUrl = credentials.server || 'https://api.github.com';
options.uri = `${baseUrl}${endpoint}`;
}
2022-05-31 00:46:20 -07:00
return await this.helpers.requestWithAuthentication.call(this, credentialType, options);
2019-06-23 03:35:23 -07:00
} catch (error) {
throw new NodeApiError(this.getNode(), error as JsonObject);
2019-06-23 03:35:23 -07:00
}
}
/**
* Returns the SHA of the given file
*
* @param {(IHookFunctions | IExecuteFunctions)} this
*/
export async function getFileSha(
this: IHookFunctions | IExecuteFunctions,
owner: string,
repository: string,
filePath: string,
branch?: string,
): Promise<any> {
2019-06-23 03:35:23 -07:00
const getBody: IDataObject = {};
if (branch !== undefined) {
getBody.branch = branch;
}
const getEndpoint = `/repos/${owner}/${repository}/contents/${encodeURI(filePath)}`;
const responseData = await githubApiRequest.call(this, 'GET', getEndpoint, getBody, {});
if (responseData.sha === undefined) {
: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(), 'Could not get the SHA of the file.');
2019-06-23 03:35:23 -07:00
}
return responseData.sha;
}
export async function githubApiRequestAllItems(
this: IHookFunctions | IExecuteFunctions,
method: string,
endpoint: string,
body: any = {},
query: IDataObject = {},
): Promise<any> {
const returnData: IDataObject[] = [];
let responseData;
query.per_page = 100;
query.page = 1;
do {
responseData = await githubApiRequest.call(this, method, endpoint, body as IDataObject, query, {
resolveWithFullResponse: true,
});
query.page++;
returnData.push.apply(returnData, responseData.body as IDataObject[]);
} while (responseData.headers.link?.includes('next'));
return returnData;
}