n8n/packages/nodes-base/nodes/Taiga/GenericFunctions.ts
Omar Ajoue 7ce7285f7a
Load credentials from the database (#1741)
* Changes to types so that credentials can be always loaded from DB

This first commit changes all return types from the execute functions
and calls to get credentials to be async so we can use await.

This is a first step as previously credentials were loaded in memory and
always available. We will now be loading them from the DB which requires
turning the whole call chain async.

* Fix updated files

* Removed unnecessary credential loading to improve performance

* Fix typo

*  Fix issue

* Updated new nodes to load credentials async

*  Remove not needed comment

Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
2021-08-20 18:57:30 +02:00

159 lines
4.2 KiB
TypeScript

import {
OptionsWithUri,
} from 'request';
import {
IExecuteFunctions,
IExecuteSingleFunctions,
IHookFunctions,
ILoadOptionsFunctions,
IWebhookFunctions,
} from 'n8n-core';
import {
ICredentialDataDecryptedObject,
IDataObject,
NodeApiError,
NodeOperationError,
} from 'n8n-workflow';
import {
createHash,
} from 'crypto';
export async function getAuthorization(
this: IHookFunctions | IExecuteFunctions | IExecuteSingleFunctions | ILoadOptionsFunctions | IWebhookFunctions,
credentials?: ICredentialDataDecryptedObject,
): Promise<string> {
if (credentials === undefined) {
throw new NodeOperationError(this.getNode(), 'No credentials got returned!');
}
const { password, username } = credentials;
const options: OptionsWithUri = {
headers: { 'Content-Type': 'application/json' },
method: 'POST',
body: {
type: 'normal',
password,
username,
},
uri: (credentials.url) ? `${credentials.url}/api/v1/auth` : 'https://api.taiga.io/api/v1/auth',
json: true,
};
try {
const response = await this.helpers.request!(options);
return response.auth_token;
} catch (error) {
throw new NodeApiError(this.getNode(), error);
}
}
export async function taigaApiRequest(
this: IHookFunctions | IExecuteFunctions | IExecuteSingleFunctions | ILoadOptionsFunctions | IWebhookFunctions,
method: string,
resource: string,
body = {},
query = {},
uri?: string | undefined,
option = {},
): Promise<any> { // tslint:disable-line:no-any
const credentials = await this.getCredentials('taigaApi') as ICredentialDataDecryptedObject;
const authToken = await getAuthorization.call(this, credentials);
const options: OptionsWithUri = {
headers: {
'Content-Type': 'application/json',
},
auth: {
bearer: authToken,
},
qs: query,
method,
body,
uri: uri || (credentials.url) ? `${credentials.url}/api/v1${resource}` : `https://api.taiga.io/api/v1${resource}`,
json: true,
};
if (Object.keys(option).length !== 0) {
Object.assign(options, option);
}
try {
return await this.helpers.request!(options);
} catch (error) {
throw new NodeApiError(this.getNode(), error);
}
}
export async function taigaApiRequestAllItems(this: IHookFunctions | IExecuteFunctions | ILoadOptionsFunctions, method: string, resource: string, body: any = {}, query: IDataObject = {}): Promise<any> { // tslint:disable-line:no-any
const returnData: IDataObject[] = [];
let responseData;
let uri: string | undefined;
do {
responseData = await taigaApiRequest.call(this, method, resource, body, query, uri, { resolveWithFullResponse: true });
returnData.push.apply(returnData, responseData.body);
uri = responseData.headers['x-pagination-next'];
if (query.limit && returnData.length >= query.limit) {
return returnData;
}
} while (
responseData.headers['x-pagination-next'] !== undefined &&
responseData.headers['x-pagination-next'] !== ''
);
return returnData;
}
export function getAutomaticSecret(credentials: ICredentialDataDecryptedObject) {
const data = `${credentials.username},${credentials.password}`;
return createHash('md5').update(data).digest('hex');
}
export async function handleListing(
this: IExecuteFunctions,
method: string,
endpoint: string,
body: IDataObject = {},
qs: IDataObject = {},
i: number,
) {
let responseData;
qs.project = this.getNodeParameter('projectId', i) as number;
const returnAll = this.getNodeParameter('returnAll', i) as boolean;
if (returnAll) {
return await taigaApiRequestAllItems.call(this, method, endpoint, body, qs);
} else {
qs.limit = this.getNodeParameter('limit', i) as number;
responseData = await taigaApiRequestAllItems.call(this, method, endpoint, body, qs);
return responseData.splice(0, qs.limit);
}
}
export const toOptions = (items: LoadedResource[]) =>
items.map(({ name, id }) => ({ name, value: id }));
export function throwOnEmptyUpdate(
this: IExecuteFunctions,
resource: Resource,
) {
throw new NodeOperationError(
this.getNode(),
`Please enter at least one field to update for the ${resource}.`,
);
}
export async function getVersionForUpdate(
this: IExecuteFunctions,
endpoint: string,
) {
return await taigaApiRequest.call(this, 'GET', endpoint).then(response => response.version);
}