102 lines
3.1 KiB
TypeScript
102 lines
3.1 KiB
TypeScript
import { ReplaySubject } from 'rxjs';
|
|
|
|
import { IconName, PluginExtensionAddedLinkConfig } from '@grafana/data';
|
|
import { PluginAddedLinksConfigureFunc, PluginExtensionEventHelpers } from '@grafana/data/src/types/pluginExtensions';
|
|
|
|
import * as errors from '../errors';
|
|
import { isGrafanaDevMode } from '../utils';
|
|
import { isAddedLinkMetaInfoMissing, isConfigureFnValid, isLinkPathValid } from '../validators';
|
|
|
|
import { PluginExtensionConfigs, Registry, RegistryType } from './Registry';
|
|
|
|
const logPrefix = 'Could not register link extension. Reason:';
|
|
|
|
export type AddedLinkRegistryItem<Context extends object = object> = {
|
|
pluginId: string;
|
|
extensionPointId: string;
|
|
title: string;
|
|
description?: string;
|
|
path?: string;
|
|
onClick?: (event: React.MouseEvent | undefined, helpers: PluginExtensionEventHelpers<Context>) => void;
|
|
configure?: PluginAddedLinksConfigureFunc<Context>;
|
|
icon?: IconName;
|
|
category?: string;
|
|
};
|
|
|
|
export class AddedLinksRegistry extends Registry<AddedLinkRegistryItem[], PluginExtensionAddedLinkConfig> {
|
|
constructor(
|
|
options: {
|
|
registrySubject?: ReplaySubject<RegistryType<AddedLinkRegistryItem[]>>;
|
|
initialState?: RegistryType<AddedLinkRegistryItem[]>;
|
|
} = {}
|
|
) {
|
|
super(options);
|
|
}
|
|
|
|
mapToRegistry(
|
|
registry: RegistryType<AddedLinkRegistryItem[]>,
|
|
item: PluginExtensionConfigs<PluginExtensionAddedLinkConfig>
|
|
): RegistryType<AddedLinkRegistryItem[]> {
|
|
const { pluginId, configs } = item;
|
|
|
|
for (const config of configs) {
|
|
const { path, title, description, configure, onClick, targets } = config;
|
|
const configLog = this.logger.child({
|
|
path: path ?? '',
|
|
description: description ?? '',
|
|
title,
|
|
pluginId,
|
|
onClick: typeof onClick,
|
|
});
|
|
|
|
if (!title) {
|
|
configLog.error(`${logPrefix} ${errors.TITLE_MISSING}`);
|
|
continue;
|
|
}
|
|
|
|
if (!isConfigureFnValid(configure)) {
|
|
configLog.error(`${logPrefix} ${errors.INVALID_CONFIGURE_FUNCTION}`);
|
|
continue;
|
|
}
|
|
|
|
if (!path && !onClick) {
|
|
configLog.error(`${logPrefix} ${errors.INVALID_PATH_OR_ON_CLICK}`);
|
|
continue;
|
|
}
|
|
|
|
if (path && !isLinkPathValid(pluginId, path)) {
|
|
configLog.error(`${logPrefix} ${errors.INVALID_PATH}`);
|
|
continue;
|
|
}
|
|
|
|
if (pluginId !== 'grafana' && isGrafanaDevMode() && isAddedLinkMetaInfoMissing(pluginId, config, configLog)) {
|
|
continue;
|
|
}
|
|
|
|
const extensionPointIds = Array.isArray(targets) ? targets : [targets];
|
|
|
|
for (const extensionPointId of extensionPointIds) {
|
|
const pointIdLog = configLog.child({ extensionPointId });
|
|
const { targets, ...registryItem } = config;
|
|
|
|
if (!(extensionPointId in registry)) {
|
|
registry[extensionPointId] = [];
|
|
}
|
|
|
|
pointIdLog.debug('Added link extension successfully registered');
|
|
|
|
registry[extensionPointId].push({ ...registryItem, pluginId, extensionPointId });
|
|
}
|
|
}
|
|
|
|
return registry;
|
|
}
|
|
|
|
// Returns a read-only version of the registry.
|
|
readOnly() {
|
|
return new AddedLinksRegistry({
|
|
registrySubject: this.registrySubject,
|
|
});
|
|
}
|
|
}
|