mirror of
https://github.com/grafana/grafana.git
synced 2025-02-13 00:55:47 -06:00
8c8f584b41
* feat(plugins): introduce dashboard panel menu placement for adding menu items
* test: add test for getPanelMenu()
* added an unique identifier for each extension.
* added context to getPluginExtensions.
* wip
* Wip
* wiwip
* Wip
* feat: WWWIIIIPPPP 🧨
* Wip
* Renamed some of the types to align a bit better.
* added limit to how many extensions a plugin can register per placement.
* decreased number of items to 2
* will trim the lenght of titles to max 25 chars.
* wrapping configure function with error handling.
* added error handling for all scenarios.
* moved extension menu items to the bottom of the more sub menu.
* added tests for configuring the title.
* minor refactorings.
* changed so you need to specify the full path in package.json.
* wip
* removed unused type.
* big refactor to make things simpler and to centralize all configure error/validation handling.
* added missing import.
* fixed failing tests.
* fixed tests.
* revert(extensions): remove static extensions config in favour of registering via AppPlugin APIs
* removed the compose that didn't work for some reason.
* added tests just to verify that validation and error handling is tied together in configuration function.
* adding some more values to the context.
* draft validation.
* added missing tests for getPanelMenu.
* added more tests.
* refactor(extensions): move logic for validating extension link config to function
* Fixed ts errors.
* Update packages/grafana-data/src/types/app.ts
Co-authored-by: Levente Balogh <balogh.levente.hu@gmail.com>
* Update packages/grafana-runtime/src/services/pluginExtensions/extensions.test.ts
Co-authored-by: Levente Balogh <balogh.levente.hu@gmail.com>
* refactor(extensions): rename limiter -> pluginPlacementCount
* refactor(getpanelmenu): remove redundant continue statement
---------
Co-authored-by: Levente Balogh <balogh.levente.hu@gmail.com>
Co-authored-by: Marcus Andersson <marcus.andersson@grafana.com>
327 lines
10 KiB
TypeScript
327 lines
10 KiB
TypeScript
import { PluginExtensionTypes } from '@grafana/data';
|
|
|
|
import { createPluginExtensionRegistry } from './registryFactory';
|
|
|
|
const validateLink = jest.fn((configure, extension, context) => configure?.(extension, context));
|
|
const errorHandler = jest.fn((configure, extension, context) => configure?.(extension, context));
|
|
|
|
jest.mock('./errorHandling', () => ({
|
|
...jest.requireActual('./errorHandling'),
|
|
createErrorHandling: jest.fn(() => {
|
|
return jest.fn((configure) => {
|
|
return jest.fn((extension, context) => errorHandler(configure, extension, context));
|
|
});
|
|
}),
|
|
}));
|
|
|
|
jest.mock('./validateLink', () => ({
|
|
...jest.requireActual('./validateLink'),
|
|
createLinkValidator: jest.fn(() => {
|
|
return jest.fn((configure) => {
|
|
return jest.fn((extension, context) => validateLink(configure, extension, context));
|
|
});
|
|
}),
|
|
}));
|
|
|
|
describe('Creating extensions registry', () => {
|
|
beforeEach(() => {
|
|
validateLink.mockClear();
|
|
errorHandler.mockClear();
|
|
});
|
|
|
|
it('should register an extension', () => {
|
|
const registry = createPluginExtensionRegistry([
|
|
{
|
|
pluginId: 'belugacdn-app',
|
|
linkExtensions: [
|
|
{
|
|
placement: 'grafana/dashboard/panel/menu',
|
|
title: 'Open incident',
|
|
description: 'You can create an incident from this context',
|
|
path: '/a/belugacdn-app/incidents/declare',
|
|
},
|
|
],
|
|
},
|
|
]);
|
|
|
|
const numberOfPlacements = Object.keys(registry).length;
|
|
const extensions = registry['grafana/dashboard/panel/menu'];
|
|
|
|
expect(numberOfPlacements).toBe(1);
|
|
expect(extensions).toEqual([
|
|
{
|
|
configure: undefined,
|
|
extension: {
|
|
title: 'Open incident',
|
|
type: PluginExtensionTypes.link,
|
|
description: 'You can create an incident from this context',
|
|
path: '/a/belugacdn-app/incidents/declare',
|
|
key: -68154691,
|
|
},
|
|
},
|
|
]);
|
|
});
|
|
|
|
it('should register extensions from one plugin with multiple placements', () => {
|
|
const registry = createPluginExtensionRegistry([
|
|
{
|
|
pluginId: 'belugacdn-app',
|
|
linkExtensions: [
|
|
{
|
|
placement: 'grafana/dashboard/panel/menu',
|
|
title: 'Open incident',
|
|
description: 'You can create an incident from this context',
|
|
path: '/a/belugacdn-app/incidents/declare',
|
|
},
|
|
{
|
|
placement: 'plugins/grafana-slo-app/slo-breached',
|
|
title: 'Open incident',
|
|
description: 'You can create an incident from this context',
|
|
path: '/a/belugacdn-app/incidents/declare',
|
|
},
|
|
],
|
|
},
|
|
]);
|
|
|
|
const numberOfPlacements = Object.keys(registry).length;
|
|
const panelExtensions = registry['grafana/dashboard/panel/menu'];
|
|
const sloExtensions = registry['plugins/grafana-slo-app/slo-breached'];
|
|
|
|
expect(numberOfPlacements).toBe(2);
|
|
expect(panelExtensions).toEqual([
|
|
{
|
|
configure: undefined,
|
|
extension: {
|
|
title: 'Open incident',
|
|
type: PluginExtensionTypes.link,
|
|
description: 'You can create an incident from this context',
|
|
path: '/a/belugacdn-app/incidents/declare',
|
|
key: -68154691,
|
|
},
|
|
},
|
|
]);
|
|
expect(sloExtensions).toEqual([
|
|
{
|
|
configure: undefined,
|
|
extension: {
|
|
title: 'Open incident',
|
|
type: PluginExtensionTypes.link,
|
|
description: 'You can create an incident from this context',
|
|
path: '/a/belugacdn-app/incidents/declare',
|
|
key: -1638987831,
|
|
},
|
|
},
|
|
]);
|
|
});
|
|
|
|
it('should register extensions from multiple plugins with multiple placements', () => {
|
|
const registry = createPluginExtensionRegistry([
|
|
{
|
|
pluginId: 'belugacdn-app',
|
|
linkExtensions: [
|
|
{
|
|
placement: 'grafana/dashboard/panel/menu',
|
|
title: 'Open incident',
|
|
description: 'You can create an incident from this context',
|
|
path: '/a/belugacdn-app/incidents/declare',
|
|
},
|
|
{
|
|
placement: 'plugins/grafana-slo-app/slo-breached',
|
|
title: 'Open incident',
|
|
description: 'You can create an incident from this context',
|
|
path: '/a/belugacdn-app/incidents/declare',
|
|
},
|
|
],
|
|
},
|
|
{
|
|
pluginId: 'grafana-monitoring-app',
|
|
linkExtensions: [
|
|
{
|
|
placement: 'grafana/dashboard/panel/menu',
|
|
title: 'Open Incident',
|
|
description: 'You can create an incident from this context',
|
|
path: '/a/grafana-monitoring-app/incidents/declare',
|
|
},
|
|
],
|
|
},
|
|
]);
|
|
|
|
const numberOfPlacements = Object.keys(registry).length;
|
|
const panelExtensions = registry['grafana/dashboard/panel/menu'];
|
|
const sloExtensions = registry['plugins/grafana-slo-app/slo-breached'];
|
|
|
|
expect(numberOfPlacements).toBe(2);
|
|
expect(panelExtensions).toEqual([
|
|
{
|
|
configure: undefined,
|
|
extension: {
|
|
title: 'Open incident',
|
|
type: PluginExtensionTypes.link,
|
|
description: 'You can create an incident from this context',
|
|
path: '/a/belugacdn-app/incidents/declare',
|
|
key: -68154691,
|
|
},
|
|
},
|
|
{
|
|
configure: undefined,
|
|
extension: {
|
|
title: 'Open Incident',
|
|
type: PluginExtensionTypes.link,
|
|
description: 'You can create an incident from this context',
|
|
path: '/a/grafana-monitoring-app/incidents/declare',
|
|
key: -540306829,
|
|
},
|
|
},
|
|
]);
|
|
|
|
expect(sloExtensions).toEqual([
|
|
{
|
|
configure: undefined,
|
|
extension: {
|
|
title: 'Open incident',
|
|
type: PluginExtensionTypes.link,
|
|
description: 'You can create an incident from this context',
|
|
path: '/a/belugacdn-app/incidents/declare',
|
|
key: -1638987831,
|
|
},
|
|
},
|
|
]);
|
|
});
|
|
|
|
it('should register maximum 2 extensions per plugin and placement', () => {
|
|
const registry = createPluginExtensionRegistry([
|
|
{
|
|
pluginId: 'belugacdn-app',
|
|
linkExtensions: [
|
|
{
|
|
placement: 'grafana/dashboard/panel/menu',
|
|
title: 'Open incident',
|
|
description: 'You can create an incident from this context',
|
|
path: '/a/belugacdn-app/incidents/declare',
|
|
},
|
|
{
|
|
placement: 'grafana/dashboard/panel/menu',
|
|
title: 'Open incident 2',
|
|
description: 'You can create an incident from this context',
|
|
path: '/a/belugacdn-app/incidents/declare',
|
|
},
|
|
{
|
|
placement: 'grafana/dashboard/panel/menu',
|
|
title: 'Open incident 3',
|
|
description: 'You can create an incident from this context',
|
|
path: '/a/belugacdn-app/incidents/declare',
|
|
},
|
|
],
|
|
},
|
|
]);
|
|
|
|
const numberOfPlacements = Object.keys(registry).length;
|
|
const panelExtensions = registry['grafana/dashboard/panel/menu'];
|
|
|
|
expect(numberOfPlacements).toBe(1);
|
|
expect(panelExtensions).toEqual([
|
|
{
|
|
configure: undefined,
|
|
extension: {
|
|
title: 'Open incident',
|
|
type: PluginExtensionTypes.link,
|
|
description: 'You can create an incident from this context',
|
|
path: '/a/belugacdn-app/incidents/declare',
|
|
key: -68154691,
|
|
},
|
|
},
|
|
{
|
|
configure: undefined,
|
|
extension: {
|
|
title: 'Open incident 2',
|
|
type: PluginExtensionTypes.link,
|
|
description: 'You can create an incident from this context',
|
|
path: '/a/belugacdn-app/incidents/declare',
|
|
key: -1072147569,
|
|
},
|
|
},
|
|
]);
|
|
});
|
|
|
|
it('should not register extensions with invalid path configured', () => {
|
|
const registry = createPluginExtensionRegistry([
|
|
{
|
|
pluginId: 'belugacdn-app',
|
|
linkExtensions: [
|
|
{
|
|
placement: 'grafana/dashboard/panel/menu',
|
|
title: 'Open incident',
|
|
description: 'You can create an incident from this context',
|
|
path: '/incidents/declare',
|
|
},
|
|
],
|
|
},
|
|
]);
|
|
|
|
const numberOfPlacements = Object.keys(registry).length;
|
|
expect(numberOfPlacements).toBe(0);
|
|
});
|
|
|
|
it('should wrap configure function with link extension validator', () => {
|
|
const registry = createPluginExtensionRegistry([
|
|
{
|
|
pluginId: 'belugacdn-app',
|
|
linkExtensions: [
|
|
{
|
|
placement: 'grafana/dashboard/panel/menu',
|
|
title: 'Open incident',
|
|
description: 'You can create an incident from this context',
|
|
path: '/a/belugacdn-app/incidents/declare',
|
|
configure: () => ({}),
|
|
},
|
|
],
|
|
},
|
|
]);
|
|
|
|
const extensions = registry['grafana/dashboard/panel/menu'];
|
|
const [extension] = extensions;
|
|
|
|
const context = {};
|
|
const configurable = {
|
|
title: 'Open incident',
|
|
description: 'You can create an incident from this context',
|
|
path: '/a/belugacdn-app/incidents/declare',
|
|
};
|
|
|
|
extension?.configure?.(context);
|
|
|
|
expect(validateLink).toBeCalledWith(expect.any(Function), configurable, context);
|
|
});
|
|
|
|
it('should wrap configure function with extension error handling', () => {
|
|
const registry = createPluginExtensionRegistry([
|
|
{
|
|
pluginId: 'belugacdn-app',
|
|
linkExtensions: [
|
|
{
|
|
placement: 'grafana/dashboard/panel/menu',
|
|
title: 'Open incident',
|
|
description: 'You can create an incident from this context',
|
|
path: '/a/belugacdn-app/incidents/declare',
|
|
configure: () => ({}),
|
|
},
|
|
],
|
|
},
|
|
]);
|
|
|
|
const extensions = registry['grafana/dashboard/panel/menu'];
|
|
const [extension] = extensions;
|
|
|
|
const context = {};
|
|
const configurable = {
|
|
title: 'Open incident',
|
|
description: 'You can create an incident from this context',
|
|
path: '/a/belugacdn-app/incidents/declare',
|
|
};
|
|
|
|
extension?.configure?.(context);
|
|
|
|
expect(errorHandler).toBeCalledWith(expect.any(Function), configurable, context);
|
|
});
|
|
});
|