grafana/public/app/features/plugins/extensions/createPluginExtensionRegistry.test.ts

import { PluginExtensionLinkConfig, PluginExtensionTypes } from '@grafana/data';

import { createPluginExtensionRegistry } from './createPluginExtensionRegistry';

describe('createRegistry()', () => {
  const placement1 = 'grafana/dashboard/panel/menu';
  const placement2 = 'plugins/myorg-basic-app/start';
  const pluginId = 'grafana-basic-app';
  let link1: PluginExtensionLinkConfig, link2: PluginExtensionLinkConfig;

  beforeEach(() => {
    link1 = {
      type: PluginExtensionTypes.link,
      title: 'Link 1',
      description: 'Link 1 description',
      path: `/a/${pluginId}/declare-incident`,
      extensionPointId: placement1,
      configure: jest.fn().mockReturnValue({}),
    };
    link2 = {
      type: PluginExtensionTypes.link,
      title: 'Link 2',
      description: 'Link 2 description',
      path: `/a/${pluginId}/declare-incident`,
      extensionPointId: placement2,
      configure: jest.fn().mockImplementation((context) => ({ title: context?.title })),
    };

    global.console.warn = jest.fn();
  });

  it('should be possible to register extensions', () => {
    const registry = createPluginExtensionRegistry([{ pluginId, extensionConfigs: [link1, link2] }]);

    expect(Object.getOwnPropertyNames(registry)).toEqual([placement1, placement2]);

    // Placement 1
    expect(registry[placement1]).toHaveLength(1);
    expect(registry[placement1]).toEqual(
      expect.arrayContaining([
        expect.objectContaining({
          pluginId,
          config: {
            ...link1,
            configure: expect.any(Function),
          },
        }),
      ])
    );

    // Placement 2
    expect(registry[placement2]).toHaveLength(1);
    expect(registry[placement2]).toEqual(
      expect.arrayContaining([
        expect.objectContaining({
          pluginId,
          config: {
            ...link2,
            configure: expect.any(Function),
          },
        }),
      ])
    );
  });

  it('should not register link extensions with invalid path configured', () => {
    const registry = createPluginExtensionRegistry([
      { pluginId, extensionConfigs: [{ ...link1, path: 'invalid-path' }, link2] },
    ]);

    expect(Object.getOwnPropertyNames(registry)).toEqual([placement2]);

    // Placement 2
    expect(registry[placement2]).toHaveLength(1);
    expect(registry[placement2]).toEqual(
      expect.arrayContaining([
        expect.objectContaining({
          pluginId,
          config: {
            ...link2,
            configure: expect.any(Function),
          },
        }),
      ])
    );
  });

  it('should not register extensions for a plugin that had errors', () => {
    const registry = createPluginExtensionRegistry([
      { pluginId, extensionConfigs: [link1, link2], error: new Error('Plugin failed to load') },
    ]);

    expect(Object.getOwnPropertyNames(registry)).toEqual([]);
  });

  it('should not register an extension if it has an invalid configure() function', () => {
    const registry = createPluginExtensionRegistry([
      // @ts-ignore (We would like to provide an invalid configure function on purpose)
      { pluginId, extensionConfigs: [{ ...link1, configure: '...' }, link2] },
    ]);

    expect(Object.getOwnPropertyNames(registry)).toEqual([placement2]);

    // Placement 2 (checking if it still registers the extension with a valid configuration)
    expect(registry[placement2]).toHaveLength(1);
    expect(registry[placement2]).toEqual(
      expect.arrayContaining([
        expect.objectContaining({
          pluginId,
          config: {
            ...link2,
            configure: expect.any(Function),
          },
        }),
      ])
    );
  });

  it('should not register an extension if it has invalid properties (empty title / description)', () => {
    const registry = createPluginExtensionRegistry([
      { pluginId, extensionConfigs: [{ ...link1, title: '', description: '' }, link2] },
    ]);

    expect(Object.getOwnPropertyNames(registry)).toEqual([placement2]);

    // Placement 2 (checking if it still registers the extension with a valid configuration)
    expect(registry[placement2]).toHaveLength(1);
    expect(registry[placement2]).toEqual(
      expect.arrayContaining([
        expect.objectContaining({
          pluginId,
          config: {
            ...link2,
            configure: expect.any(Function),
          },
        }),
      ])
    );
  });
});