n8n/packages/nodes-base/nodes/GoToWebinar/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

276 lines
7.2 KiB
TypeScript

import {
IExecuteFunctions,
IHookFunctions,
} from 'n8n-core';
import {
IDataObject,
ILoadOptionsFunctions,
INodePropertyOptions,
NodeApiError,
} from 'n8n-workflow';
import {
OptionsWithUri,
} from 'request';
import * as moment from 'moment';
import * as losslessJSON from 'lossless-json';
/**
* Make an authenticated API request to GoToWebinar.
*/
export async function goToWebinarApiRequest(
this: IHookFunctions | IExecuteFunctions | ILoadOptionsFunctions,
method: string,
endpoint: string,
qs: IDataObject,
body: IDataObject | IDataObject[],
option: IDataObject = {},
) {
const operation = this.getNodeParameter('operation', 0) as string;
const resource = this.getNodeParameter('resource', 0) as string;
const options: OptionsWithUri = {
headers: {
'user-agent': 'n8n',
'Accept': 'application/json',
'Content-Type': 'application/json',
},
method,
uri: `https://api.getgo.com/G2W/rest/v2/${endpoint}`,
qs,
body: JSON.stringify(body),
json: false,
};
if (resource === 'session' && operation === 'getAll') {
options.headers!['Accept'] = 'application/vnd.citrix.g2wapi-v1.1+json';
}
if (['GET', 'DELETE'].includes(method)) {
delete options.body;
}
if (!Object.keys(qs).length) {
delete options.qs;
}
if (Object.keys(option)) {
Object.assign(options, option);
}
try {
const response = await this.helpers.requestOAuth2!.call(this, 'goToWebinarOAuth2Api', options, { tokenExpiredStatusCode: 403 });
if (response === '') {
return {};
}
// https://stackoverflow.com/questions/62190724/getting-gotowebinar-registrant
return losslessJSON.parse(response, convertLosslessNumber);
} catch (error) {
throw new NodeApiError(this.getNode(), error);
}
}
/**
* Make an authenticated API request to GoToWebinar and return all results.
*/
export async function goToWebinarApiRequestAllItems(
this: IHookFunctions | IExecuteFunctions | ILoadOptionsFunctions,
method: string,
endpoint: string,
qs: IDataObject,
body: IDataObject,
resource: string,
) {
const resourceToResponseKey: { [key: string]: string } = {
session: 'sessionInfoResources',
webinar: 'webinars',
};
const key = resourceToResponseKey[resource];
let returnData: IDataObject[] = [];
let responseData;
do {
responseData = await goToWebinarApiRequest.call(this, method, endpoint, qs, body);
if (responseData.page && parseInt(responseData.page.totalElements, 10) === 0) {
return [];
} else if (responseData._embedded && responseData._embedded[key]) {
returnData.push(...responseData._embedded[key]);
} else {
returnData.push(...responseData);
}
if (qs.limit && returnData.length >= qs.limit) {
returnData = returnData.splice(0, qs.limit as number);
return returnData;
}
} while (
responseData.totalElements && parseInt(responseData.totalElements, 10) > returnData.length
);
return returnData;
}
export async function handleGetAll(
this: IExecuteFunctions,
endpoint: string,
qs: IDataObject,
body: IDataObject,
resource: string) {
const returnAll = this.getNodeParameter('returnAll', 0) as boolean;
if (!returnAll) {
qs.limit = this.getNodeParameter('limit', 0) as number;
}
return await goToWebinarApiRequestAllItems.call(this, 'GET', endpoint, qs, body, resource);
}
export async function loadWebinars(this: ILoadOptionsFunctions) {
const { oauthTokenData } = await this.getCredentials('goToWebinarOAuth2Api') as {
oauthTokenData: { account_key: string }
};
const endpoint = `accounts/${oauthTokenData.account_key}/webinars`;
const qs = {
fromTime: moment().subtract(1, 'years').format(),
toTime: moment().add(1, 'years').format(),
};
const resourceItems = await goToWebinarApiRequestAllItems.call(this, 'GET', endpoint, qs, {}, 'webinar');
const returnData: INodePropertyOptions[] = [];
resourceItems.forEach((item) => {
returnData.push({
name: item.subject as string,
value: item.webinarKey as string,
});
});
return returnData;
}
export async function loadWebinarSessions(this: ILoadOptionsFunctions) {
const { oauthTokenData } = await this.getCredentials('goToWebinarOAuth2Api') as {
oauthTokenData: { organizer_key: string }
};
const webinarKey = this.getCurrentNodeParameter('webinarKey') as string;
const endpoint = `organizers/${oauthTokenData.organizer_key}/webinars/${webinarKey}/sessions`;
const resourceItems = await goToWebinarApiRequestAllItems.call(this, 'GET', endpoint, {}, {}, 'session');
const returnData: INodePropertyOptions[] = [];
resourceItems.forEach((item) => {
returnData.push({
name: `Date: ${moment(item.startTime as string).format('MM-DD-YYYY')} | From: ${moment(item.startTime as string).format('LT')} - To: ${moment(item.endTime as string).format('LT')}`,
value: item.sessionKey as string,
});
});
return returnData;
}
export async function loadRegistranSimpleQuestions(this: ILoadOptionsFunctions) {
const { oauthTokenData } = await this.getCredentials('goToWebinarOAuth2Api') as {
oauthTokenData: { organizer_key: string }
};
const webinarkey = this.getNodeParameter('webinarKey') as string;
const endpoint = `organizers/${oauthTokenData.organizer_key}/webinars/${webinarkey}/registrants/fields`;
const { questions } = await goToWebinarApiRequest.call(this, 'GET', endpoint, {}, {});
const returnData: INodePropertyOptions[] = [];
questions.forEach((item: IDataObject) => {
if (item.type === 'shortAnswer') {
returnData.push({
name: item.question as string,
value: item.questionKey as string,
});
}
});
return returnData;
}
export async function loadAnswers(this: ILoadOptionsFunctions) {
const { oauthTokenData } = await this.getCredentials('goToWebinarOAuth2Api') as {
oauthTokenData: { organizer_key: string }
};
const webinarKey = this.getCurrentNodeParameter('webinarKey') as string;
const questionKey = this.getCurrentNodeParameter('questionKey') as string;
const endpoint = `organizers/${oauthTokenData.organizer_key}/webinars/${webinarKey}/registrants/fields`;
const { questions } = await goToWebinarApiRequest.call(this, 'GET', endpoint, {}, {});
const returnData: INodePropertyOptions[] = [];
questions.forEach((item: IDataObject) => {
if (item.type === 'multiChoice' && item.questionKey === questionKey) {
for (const answer of item.answers as IDataObject[]) {
returnData.push({
name: answer.answer as string,
value: answer.answerKey as string,
});
}
}
});
return returnData;
}
export async function loadRegistranMultiChoiceQuestions(this: ILoadOptionsFunctions) {
const { oauthTokenData } = await this.getCredentials('goToWebinarOAuth2Api') as {
oauthTokenData: { organizer_key: string }
};
const webinarkey = this.getNodeParameter('webinarKey') as string;
const endpoint = `organizers/${oauthTokenData.organizer_key}/webinars/${webinarkey}/registrants/fields`;
const { questions } = await goToWebinarApiRequest.call(this, 'GET', endpoint, {}, {});
const returnData: INodePropertyOptions[] = [];
questions.forEach((item: IDataObject) => {
if (item.type === 'multipleChoice') {
returnData.push({
name: item.question as string,
value: item.questionKey as string,
});
}
});
return returnData;
}
// tslint:disable-next-line: no-any
function convertLosslessNumber(key: any, value: any) {
if (value && value.isLosslessNumber) {
return value.toString();
}
else {
return value;
}
}