n8n/packages/nodes-base/nodes/Grafana/Grafana.node.ts
Jan Oberhauser 0da398b0e4
Nodes as JSON and authentication redesign (#2401)
*  change FE to handle new object type

* 🚸 improve UX of handling invalid credentials

* 🚧 WIP

* 🎨 fix typescript issues

* 🐘 add migrations for all supported dbs

* ✏️ add description to migrations

*  add credential update on import

*  resolve after merge issues

* 👕 fix lint issues

*  check credentials on workflow create/update

* update interface

* 👕 fix ts issues

*  adaption to new credentials UI

* 🐛 intialize cache on BE for credentials check

* 🐛 fix undefined oldCredentials

* 🐛 fix deleting credential

* 🐛 fix check for undefined keys

* 🐛 fix disabling edit in execution

* 🎨 just show credential name on execution view

* ✏️  remove TODO

*  implement review suggestions

*  add cache to getCredentialsByType

*  use getter instead of cache

* ✏️ fix variable name typo

* 🐘 include waiting nodes to migrations

* 🐛 fix reverting migrations command

*  update typeorm command

*  create db:revert command

* 👕 fix lint error

*  Add optional authenticate method to credentials

*  Simplify code and add authentication support to MattermostApi

* 👕 Fix lint issue

*  Add support to own-mode

* 👕 Fix lint issue

*  Add support for predefined auth types bearer and headerAuth

*  Make sure that DateTime Node always returns strings

*  Add support for moment types to If Node

*  Make it possible for HTTP Request Node to use all credential types

*  Add basicAuth support

* Add a new dropcontact node

*  First basic implementation of mainly JSON based nodes

*  Add fixedCollection support, added value parameter and
expression support for value and property

* Improvements to #2389

*  Add credentials verification

*  Small improvement

*  set default time to 45 seconds

*  Add support for preSend and postReceive methods

*  Add lodash merge and set depedency to workflow

* 👕 Fix lint issue

*  Improvements

*  Improvements

*  Improvements

*  Improvements

*  Improvements

* 🐛 Set siren and language correctly

*  Add support for requestDefaults

*  Add support for baseURL to httpRequest

*  Move baseURL to correct location

*  Add support for options loading

* 🐛 Fix error with fullAccess nodes

*  Add credential test functionality

* 🐛 Fix issue with OAuth autentication and lint issue

*  Fix build issue

* 🐛 Fix issue that url got always overwritten to empty

*  Add pagination support

*  Code fix required after merge

*  Remove not needed imports

*  Fix credential test

*  Add expression support for request properties and $self
support on properties

*  Rename $self to $value

* 👕 Fix lint issue

*  Add example how to send data in path

*  Make it possible to not sent in dot notation

*  Add support for postReceive:rootProperty

*  Fix typo

*  Add support for postReceive:set

*  Some fixes

*  Small improvement

* ;zap: Separate RoutingNode code

*  Simplify code and fix bug

*  Remove unused code

*  Make it possible to define "request" and "requestProperty" on
options

* 👕 Fix lint issue

*  Change $credentials variables name

*  Enable expressions and access to credentials in requestDefaults

*  Make parameter option loading use RoutingNode.makeRoutingRequest

*  Allow requestOperations overwrite on LoadOptions

*  Make it possible to access current node parameters in loadOptions

*  Rename parameters variable to make future proof

*  Make it possible to use offset-pagination with body

*  Add support for queryAuth

*  Never return more items than requested

*  Make it possible to overwrite requestOperations on parameter
and option level

* 👕 Fix lint issue

*  Allow simplified auth also with regular nodes

*  Add support for receiving binary data

* 🐛 Fix example node

*  Rename property "name" to "displayName" in loadOptions

*  Send data by default as "query" if nothing is set

*  Rename $self to $parent

*  Change to work with INodeExecutionData instead of IDataObject

*  Improve binaryData handling

*  Property design improvements

*  Fix property name

* 🚨 Add some tests

*  Add also test for request

*  Improve test and fix issues

*  Improvements to loadOptions

*  Normalize loadOptions with rest of code

*  Add info text

*  Add support for $value in postReceive

* 🚨 Add tests for RoutingNode.runNode

*  Remove TODOs and make url property optional

*  Fix bug and lint issue

* 🐛 Fix bug that not the correct property got used

* 🚨 Add tests for CredentialsHelper.authenticate

*  Improve code and resolve expressions also everywhere for
loadOptions and credential test requests

*  Make it possible to define multiple preSend and postReceive
actions

*  Allow to define tests on credentials

*  Remove test data

* ⬆️ Update package-lock.json file

*  Remove old not longer used code

Co-authored-by: Ben Hesseldieck <b.hesseldieck@gmail.com>
Co-authored-by: Mutasem <mutdmour@gmail.com>
Co-authored-by: PaulineDropcontact <pauline@dropcontact.io>
Co-authored-by: ricardo <ricardoespinoza105@gmail.com>
2022-02-05 22:55:43 +01:00

577 lines
17 KiB
TypeScript

import {
IExecuteFunctions,
} from 'n8n-core';
import {
ICredentialsDecrypted,
ICredentialTestFunctions,
IDataObject,
ILoadOptionsFunctions,
INodeCredentialTestResult,
INodeExecutionData,
INodePropertyOptions,
INodeType,
INodeTypeDescription,
NodeApiError,
} from 'n8n-workflow';
import {
deriveUid,
grafanaApiRequest,
throwOnEmptyUpdate,
tolerateTrailingSlash,
} from './GenericFunctions';
import {
dashboardFields,
dashboardOperations,
teamFields,
teamMemberFields,
teamMemberOperations,
teamOperations,
userFields,
userOperations,
} from './descriptions';
import {
OptionsWithUri,
} from 'request';
import {
DashboardUpdateFields,
DashboardUpdatePayload,
GrafanaCredentials,
LoadedDashboards,
LoadedFolders,
LoadedTeams,
LoadedUsers,
} from './types';
export class Grafana implements INodeType {
description: INodeTypeDescription = {
displayName: 'Grafana',
name: 'grafana',
icon: 'file:grafana.svg',
group: ['transform'],
version: 1,
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
description: 'Consume the Grafana API',
defaults: {
name: 'Grafana',
},
inputs: ['main'],
outputs: ['main'],
credentials: [
{
name: 'grafanaApi',
required: true,
testedBy: 'grafanaApiTest',
},
],
properties: [
{
displayName: 'Resource',
name: 'resource',
noDataExpression: true,
type: 'options',
options: [
{
name: 'Dashboard',
value: 'dashboard',
},
{
name: 'Team',
value: 'team',
},
{
name: 'Team Member',
value: 'teamMember',
},
{
name: 'User',
value: 'user',
},
],
default: 'dashboard',
},
...dashboardOperations,
...dashboardFields,
...teamOperations,
...teamFields,
...teamMemberOperations,
...teamMemberFields,
...userOperations,
...userFields,
],
};
methods = {
loadOptions: {
async getDashboards(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const dashboards = await grafanaApiRequest.call(
this, 'GET', '/search', {}, { qs: 'dash-db' },
) as LoadedDashboards;
return dashboards.map(({ id, title }) => ({ value: id, name: title }));
},
async getFolders(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const folders = await grafanaApiRequest.call(this, 'GET', '/folders') as LoadedFolders;
return folders.map(({ id, title }) => ({ value: id, name: title }));
},
async getTeams(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const res = await grafanaApiRequest.call(this, 'GET', '/teams/search') as LoadedTeams;
return res.teams.map(({ id, name }) => ({ value: id, name }));
},
async getUsers(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const users = await grafanaApiRequest.call(this, 'GET', '/org/users') as LoadedUsers;
return users.map(({ userId, email }) => ({ value: userId, name: email }));
},
},
credentialTest: {
async grafanaApiTest(
this: ICredentialTestFunctions,
credential: ICredentialsDecrypted,
): Promise<INodeCredentialTestResult> {
const { apiKey, baseUrl: rawBaseUrl } = credential.data as GrafanaCredentials;
const baseUrl = tolerateTrailingSlash(rawBaseUrl);
const options: OptionsWithUri = {
headers: {
Authorization: `Bearer ${apiKey}`,
},
method: 'GET',
uri: `${baseUrl}/api/folders`,
json: true,
};
try {
await this.helpers.request(options);
return {
status: 'OK',
message: 'Authentication successful',
};
} catch (error) {
return {
status: 'Error',
message: error.message,
};
}
},
},
};
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const items = this.getInputData();
const returnData: IDataObject[] = [];
const resource = this.getNodeParameter('resource', 0) as string;
const operation = this.getNodeParameter('operation', 0) as string;
let responseData;
for (let i = 0; i < items.length; i++) {
try {
if (resource === 'dashboard') {
// **********************************************************************
// dashboard
// **********************************************************************
if (operation === 'create') {
// ----------------------------------------
// dashboard: create
// ----------------------------------------
// https://grafana.com/docs/grafana/latest/http_api/dashboard/#create--update-dashboard
const body = {
dashboard: {
id: null,
title: this.getNodeParameter('title', i),
},
};
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
if (Object.keys(additionalFields).length) {
if (additionalFields.folderId === '') delete additionalFields.folderId;
Object.assign(body, additionalFields);
}
responseData = await grafanaApiRequest.call(this, 'POST', '/dashboards/db', body);
} else if (operation === 'delete') {
// ----------------------------------------
// dashboard: delete
// ----------------------------------------
// https://grafana.com/docs/grafana/latest/http_api/dashboard/#delete-dashboard-by-uid
const uidOrUrl = this.getNodeParameter('dashboardUidOrUrl', i) as string;
const uid = deriveUid.call(this, uidOrUrl);
const endpoint = `/dashboards/uid/${uid}`;
responseData = await grafanaApiRequest.call(this, 'DELETE', endpoint);
} else if (operation === 'get') {
// ----------------------------------------
// dashboard: get
// ----------------------------------------
// https://grafana.com/docs/grafana/latest/http_api/dashboard/#get-dashboard-by-uid
const uidOrUrl = this.getNodeParameter('dashboardUidOrUrl', i) as string;
const uid = deriveUid.call(this, uidOrUrl);
const endpoint = `/dashboards/uid/${uid}`;
responseData = await grafanaApiRequest.call(this, 'GET', endpoint);
} else if (operation === 'getAll') {
// ----------------------------------------
// dashboard: getAll
// ----------------------------------------
// https://grafana.com/docs/grafana/latest/http_api/folder_dashboard_search/#search-folders-and-dashboards
const qs = {
type: 'dash-db',
};
const filters = this.getNodeParameter('filters', i) as IDataObject;
if (Object.keys(filters).length) {
Object.assign(qs, filters);
}
const returnAll = this.getNodeParameter('returnAll', i) as boolean;
if (!returnAll) {
const limit = this.getNodeParameter('limit', i) as number;
Object.assign(qs, { limit });
}
responseData = await grafanaApiRequest.call(this, 'GET', '/search', {}, qs);
} else if (operation === 'update') {
// ----------------------------------------
// dashboard: update
// ----------------------------------------
// https://grafana.com/docs/grafana/latest/http_api/dashboard/#create--update-dashboard
const uidOrUrl = this.getNodeParameter('dashboardUidOrUrl', i) as string;
const uid = deriveUid.call(this, uidOrUrl);
// ensure dashboard to update exists
await grafanaApiRequest.call(this, 'GET', `/dashboards/uid/${uid}`);
const body: DashboardUpdatePayload = {
overwrite: true,
dashboard: { uid },
};
const updateFields = this.getNodeParameter('updateFields', i) as DashboardUpdateFields;
throwOnEmptyUpdate.call(this, resource, updateFields);
const { title, ...rest } = updateFields;
if (!title) {
const { dashboard } = await grafanaApiRequest.call(this, 'GET', `/dashboards/uid/${uid}`);
body.dashboard.title = dashboard.title;
} else {
const dashboards = await grafanaApiRequest.call(this, 'GET', '/search') as Array<{ title: string }>;
const titles = dashboards.map(({ title }) => title);
if (titles.includes(title)) {
throw new NodeApiError(
this.getNode(),
{ message: 'A dashboard with the same name already exists in the selected folder' },
);
}
body.dashboard.title = title;
}
if (title) {
body.dashboard.title = title;
}
if (Object.keys(rest).length) {
if (rest.folderId === '') delete rest.folderId;
Object.assign(body, rest);
}
responseData = await grafanaApiRequest.call(this, 'POST', '/dashboards/db', body);
}
} else if (resource === 'team') {
// **********************************************************************
// team
// **********************************************************************
if (operation === 'create') {
// ----------------------------------------
// team: create
// ----------------------------------------
// https://grafana.com/docs/grafana/latest/http_api/team/#add-team
const body = {
name: this.getNodeParameter('name', i) as string,
};
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
if (Object.keys(additionalFields).length) {
Object.assign(body, additionalFields);
}
responseData = await grafanaApiRequest.call(this, 'POST', '/teams', body);
} else if (operation === 'delete') {
// ----------------------------------------
// team: delete
// ----------------------------------------
// https://grafana.com/docs/grafana/latest/http_api/team/#delete-team-by-id
const teamId = this.getNodeParameter('teamId', i);
responseData = await grafanaApiRequest.call(this, 'DELETE', `/teams/${teamId}`);
} else if (operation === 'get') {
// ----------------------------------------
// team: get
// ----------------------------------------
// https://grafana.com/docs/grafana/latest/http_api/team/#get-team-by-id
const teamId = this.getNodeParameter('teamId', i);
responseData = await grafanaApiRequest.call(this, 'GET', `/teams/${teamId}`);
} else if (operation === 'getAll') {
// ----------------------------------------
// team: getAll
// ----------------------------------------
// https://grafana.com/docs/grafana/latest/http_api/team/#team-search-with-paging
const qs = {} as IDataObject;
const filters = this.getNodeParameter('filters', i) as IDataObject;
if (Object.keys(filters).length) {
Object.assign(qs, filters);
}
responseData = await grafanaApiRequest.call(this, 'GET', '/teams/search', {}, qs);
responseData = responseData.teams;
const returnAll = this.getNodeParameter('returnAll', i) as boolean;
if (!returnAll) {
const limit = this.getNodeParameter('limit', i) as number;
responseData = responseData.slice(0, limit);
}
} else if (operation === 'update') {
// ----------------------------------------
// team: update
// ----------------------------------------
// https://grafana.com/docs/grafana/latest/http_api/team/#update-team
const updateFields = this.getNodeParameter('updateFields', i) as IDataObject;
throwOnEmptyUpdate.call(this, resource, updateFields);
const body: IDataObject = {};
const teamId = this.getNodeParameter('teamId', i);
// check if team exists, since API does not specify update failure reason
await grafanaApiRequest.call(this, 'GET', `/teams/${teamId}`);
// prevent email from being overridden to empty
if (!updateFields.email) {
const { email } = await grafanaApiRequest.call(this, 'GET', `/teams/${teamId}`);
body.email = email;
}
if (Object.keys(updateFields).length) {
Object.assign(body, updateFields);
}
responseData = await grafanaApiRequest.call(this, 'PUT', `/teams/${teamId}`, body);
}
} else if (resource === 'teamMember') {
// **********************************************************************
// teamMember
// **********************************************************************
if (operation === 'add') {
// ----------------------------------------
// teamMember: add
// ----------------------------------------
// https://grafana.com/docs/grafana/latest/http_api/team/#add-team-member
const userId = this.getNodeParameter('userId', i) as string;
const body = {
userId: parseInt(userId, 10),
};
const teamId = this.getNodeParameter('teamId', i);
const endpoint = `/teams/${teamId}/members`;
responseData = await grafanaApiRequest.call(this, 'POST', endpoint, body);
} else if (operation === 'remove') {
// ----------------------------------------
// teamMember: remove
// ----------------------------------------
// https://grafana.com/docs/grafana/latest/http_api/team/#remove-member-from-team
const teamId = this.getNodeParameter('teamId', i);
const memberId = this.getNodeParameter('memberId', i);
const endpoint = `/teams/${teamId}/members/${memberId}`;
responseData = await grafanaApiRequest.call(this, 'DELETE', endpoint);
} else if (operation === 'getAll') {
// ----------------------------------------
// teamMember: getAll
// ----------------------------------------
// https://grafana.com/docs/grafana/latest/http_api/team/#get-team-members
const teamId = this.getNodeParameter('teamId', i);
// check if team exists, since API returns all members if team does not exist
await grafanaApiRequest.call(this, 'GET', `/teams/${teamId}`);
const endpoint = `/teams/${teamId}/members`;
responseData = await grafanaApiRequest.call(this, 'GET', endpoint);
const returnAll = this.getNodeParameter('returnAll', i) as boolean;
if (!returnAll) {
const limit = this.getNodeParameter('limit', i) as number;
responseData = responseData.slice(0, limit);
}
}
} else if (resource === 'user') {
// **********************************************************************
// user
// **********************************************************************
if (operation === 'create') {
// ----------------------------------------
// user: create
// ----------------------------------------
// https://grafana.com/docs/grafana/latest/http_api/org/#add-a-new-user-to-the-current-organization
const body = {
role: this.getNodeParameter('role', i),
loginOrEmail: this.getNodeParameter('loginOrEmail', i),
};
responseData = await grafanaApiRequest.call(this, 'POST', '/org/users', body);
} else if (operation === 'delete') {
// ----------------------------------------
// user: delete
// ----------------------------------------
// https://grafana.com/docs/grafana/latest/http_api/org/#delete-user-in-current-organization
const userId = this.getNodeParameter('userId', i);
responseData = await grafanaApiRequest.call(this, 'DELETE', `/org/users/${userId}`);
} else if (operation === 'getAll') {
// ----------------------------------------
// user: getAll
// ----------------------------------------
// https://grafana.com/docs/grafana/latest/http_api/org/#get-all-users-within-the-current-organization
responseData = await grafanaApiRequest.call(this, 'GET', '/org/users');
const returnAll = this.getNodeParameter('returnAll', i) as boolean;
if (!returnAll) {
const limit = this.getNodeParameter('limit', i) as number;
responseData = responseData.slice(0, limit);
}
} else if (operation === 'update') {
// ----------------------------------------
// user: update
// ----------------------------------------
// https://grafana.com/docs/grafana/latest/http_api/org/#updates-the-given-user
const body: IDataObject = {};
const updateFields = this.getNodeParameter('updateFields', i) as IDataObject;
throwOnEmptyUpdate.call(this, resource, updateFields);
if (Object.keys(updateFields).length) {
Object.assign(body, updateFields);
}
const userId = this.getNodeParameter('userId', i) as string;
responseData = await grafanaApiRequest.call(this, 'PATCH', `/org/users/${userId}`, body);
}
}
Array.isArray(responseData)
? returnData.push(...responseData)
: returnData.push(responseData);
} catch (error) {
if (this.continueOnFail()) {
returnData.push({ error: error.message });
continue;
}
throw error;
}
}
return [this.helpers.returnJsonArray(returnData)];
}
}