129 lines
4.4 KiB
TypeScript
129 lines
4.4 KiB
TypeScript
import { isString } from 'lodash';
|
|
import { useMemo } from 'react';
|
|
import { useObservable } from 'react-use';
|
|
|
|
import { PluginExtensionLink, PluginExtensionTypes, usePluginContext } from '@grafana/data';
|
|
import { UsePluginLinksOptions, UsePluginLinksResult } from '@grafana/runtime';
|
|
|
|
import { useAddedLinksRegistry } from './ExtensionRegistriesContext';
|
|
import * as errors from './errors';
|
|
import { log } from './logs/log';
|
|
import { useLoadAppPlugins } from './useLoadAppPlugins';
|
|
import {
|
|
generateExtensionId,
|
|
getExtensionPointPluginDependencies,
|
|
getLinkExtensionOnClick,
|
|
getLinkExtensionOverrides,
|
|
getLinkExtensionPathWithTracking,
|
|
getReadOnlyProxy,
|
|
isGrafanaDevMode,
|
|
} from './utils';
|
|
import { isExtensionPointIdValid, isExtensionPointMetaInfoMissing } from './validators';
|
|
|
|
// Returns an array of component extensions for the given extension point
|
|
export function usePluginLinks({
|
|
limitPerPlugin,
|
|
extensionPointId,
|
|
context,
|
|
}: UsePluginLinksOptions): UsePluginLinksResult {
|
|
const registry = useAddedLinksRegistry();
|
|
const pluginContext = usePluginContext();
|
|
const registryState = useObservable(registry.asObservable());
|
|
const { isLoading: isLoadingAppPlugins } = useLoadAppPlugins(getExtensionPointPluginDependencies(extensionPointId));
|
|
|
|
return useMemo(() => {
|
|
// For backwards compatibility we don't enable restrictions in production or when the hook is used in core Grafana.
|
|
const enableRestrictions = isGrafanaDevMode() && pluginContext !== null;
|
|
const pluginId = pluginContext?.meta.id ?? '';
|
|
const pointLog = log.child({
|
|
pluginId,
|
|
extensionPointId,
|
|
});
|
|
|
|
if (enableRestrictions && !isExtensionPointIdValid({ extensionPointId, pluginId })) {
|
|
pointLog.error(errors.INVALID_EXTENSION_POINT_ID);
|
|
return {
|
|
isLoading: false,
|
|
links: [],
|
|
};
|
|
}
|
|
|
|
if (enableRestrictions && isExtensionPointMetaInfoMissing(extensionPointId, pluginContext)) {
|
|
pointLog.error(errors.EXTENSION_POINT_META_INFO_MISSING);
|
|
return {
|
|
isLoading: false,
|
|
links: [],
|
|
};
|
|
}
|
|
|
|
if (isLoadingAppPlugins) {
|
|
return {
|
|
isLoading: true,
|
|
links: [],
|
|
};
|
|
}
|
|
|
|
if (!registryState || !registryState[extensionPointId]) {
|
|
return {
|
|
isLoading: false,
|
|
links: [],
|
|
};
|
|
}
|
|
|
|
const frozenContext = context ? getReadOnlyProxy(context) : {};
|
|
const extensions: PluginExtensionLink[] = [];
|
|
const extensionsByPlugin: Record<string, number> = {};
|
|
|
|
for (const addedLink of registryState[extensionPointId] ?? []) {
|
|
const { pluginId } = addedLink;
|
|
const linkLog = pointLog.child({
|
|
path: addedLink.path ?? '',
|
|
title: addedLink.title,
|
|
description: addedLink.description ?? '',
|
|
onClick: typeof addedLink.onClick,
|
|
});
|
|
|
|
// Only limit if the `limitPerPlugin` is set
|
|
if (limitPerPlugin && extensionsByPlugin[pluginId] >= limitPerPlugin) {
|
|
linkLog.debug(`Skipping link extension from plugin "${pluginId}". Reason: Limit reached.`);
|
|
continue;
|
|
}
|
|
|
|
if (extensionsByPlugin[pluginId] === undefined) {
|
|
extensionsByPlugin[pluginId] = 0;
|
|
}
|
|
|
|
// Run the configure() function with the current context, and apply the ovverides
|
|
const overrides = getLinkExtensionOverrides(pluginId, addedLink, linkLog, frozenContext);
|
|
|
|
// configure() returned an `undefined` -> hide the extension
|
|
if (addedLink.configure && overrides === undefined) {
|
|
continue;
|
|
}
|
|
|
|
const path = overrides?.path || addedLink.path;
|
|
const extension: PluginExtensionLink = {
|
|
id: generateExtensionId(pluginId, extensionPointId, addedLink.title),
|
|
type: PluginExtensionTypes.link,
|
|
pluginId: pluginId,
|
|
onClick: getLinkExtensionOnClick(pluginId, extensionPointId, addedLink, linkLog, frozenContext),
|
|
|
|
// Configurable properties
|
|
icon: overrides?.icon || addedLink.icon,
|
|
title: overrides?.title || addedLink.title,
|
|
description: overrides?.description || addedLink.description || '',
|
|
path: isString(path) ? getLinkExtensionPathWithTracking(pluginId, path, extensionPointId) : undefined,
|
|
category: overrides?.category || addedLink.category,
|
|
};
|
|
|
|
extensions.push(extension);
|
|
extensionsByPlugin[pluginId] += 1;
|
|
}
|
|
|
|
return {
|
|
isLoading: false,
|
|
links: extensions,
|
|
};
|
|
}, [context, extensionPointId, limitPerPlugin, registryState, pluginContext, isLoadingAppPlugins]);
|
|
}
|