first commit

packages/nodes-base/nodes/Grafana/GenericFunctions.ts

@@ -0,0 +1,103 @@
+import type {
+	IExecuteFunctions,
+	IDataObject,
+	ILoadOptionsFunctions,
+	JsonObject,
+	IHttpRequestMethods,
+	IRequestOptions,
+} from 'n8n-workflow';
+import { NodeApiError, NodeOperationError } from 'n8n-workflow';
+
+import type { GrafanaCredentials } from './types';
+
+export function tolerateTrailingSlash(baseUrl: string) {
+	return baseUrl.endsWith('/') ? baseUrl.substr(0, baseUrl.length - 1) : baseUrl;
+}
+
+export async function grafanaApiRequest(
+	this: IExecuteFunctions | ILoadOptionsFunctions,
+	method: IHttpRequestMethods,
+	endpoint: string,
+	body: IDataObject = {},
+	qs: IDataObject = {},
+) {
+	const { baseUrl: rawBaseUrl } = await this.getCredentials<GrafanaCredentials>('grafanaApi');
+
+	const baseUrl = tolerateTrailingSlash(rawBaseUrl);
+
+	const options: IRequestOptions = {
+		headers: {
+			'Content-Type': 'application/json',
+		},
+		method,
+		body,
+		qs,
+		uri: `${baseUrl}/api${endpoint}`,
+		json: true,
+	};
+
+	if (!Object.keys(body).length) {
+		delete options.body;
+	}
+
+	if (!Object.keys(qs).length) {
+		delete options.qs;
+	}
+
+	try {
+		return await this.helpers.requestWithAuthentication.call(this, 'grafanaApi', options);
+	} catch (error) {
+		if (error?.response?.data?.message === 'Team member not found') {
+			error.response.data.message += '. Are you sure the user is a member of this team?';
+		}
+
+		if (error?.response?.data?.message === 'Team not found') {
+			error.response.data.message += ' with the provided ID';
+		}
+
+		if (
+			error?.response?.data?.message ===
+			'A dashboard with the same name in the folder already exists'
+		) {
+			error.response.data.message =
+				'A dashboard with the same name already exists in the selected folder';
+		}
+
+		if (error?.response?.data?.message === 'Team name taken') {
+			error.response.data.message = 'This team name is already taken. Please choose a new one.';
+		}
+
+		if (error?.code === 'ECONNREFUSED') {
+			error.message =
+				'Invalid credentials or error in establishing connection with given credentials';
+		}
+
+		throw new NodeApiError(this.getNode(), error as JsonObject);
+	}
+}
+
+export function throwOnEmptyUpdate(
+	this: IExecuteFunctions,
+	resource: string,
+	updateFields: IDataObject,
+) {
+	if (!Object.keys(updateFields).length) {
+		throw new NodeOperationError(
+			this.getNode(),
+			`Please enter at least one field to update for the ${resource}.`,
+		);
+	}
+}
+
+export function deriveUid(this: IExecuteFunctions, uidOrUrl: string) {
+	if (!uidOrUrl.startsWith('http')) return uidOrUrl;
+
+	const urlSegments = uidOrUrl.split('/');
+	const uid = urlSegments[urlSegments.indexOf('d') + 1];
+
+	if (!uid) {
+		throw new NodeOperationError(this.getNode(), 'Failed to derive UID from URL');
+	}
+
+	return uid;
+}