IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-14 17:43:35 -06:00
Code Issues Packages Projects Releases Wiki Activity

PluginExtensions: Allow to specify unkown properties in override but they will be ignored (#72273)

Browse Source 
* fixed bug.

* Update public/app/features/plugins/extensions/getPluginExtensions.ts

Co-authored-by: Ben Sully <ben.sully@grafana.com>

* Update public/app/features/plugins/extensions/getPluginExtensions.test.ts

Co-authored-by: Ben Sully <ben.sully@grafana.com>

* Update public/app/features/plugins/extensions/getPluginExtensions.ts

Co-authored-by: Jack Westbrook <jack.westbrook@gmail.com>

* Update public/app/features/plugins/extensions/getPluginExtensions.test.ts

Co-authored-by: Jack Westbrook <jack.westbrook@gmail.com>

---------

Co-authored-by: Ben Sully <ben.sully@grafana.com>
Co-authored-by: Jack Westbrook <jack.westbrook@gmail.com>
This commit is contained in:
Marcus Andersson 2023-07-25 20:18:49 +02:00 committed by GitHub
parent 9ff193f692
commit 1755f8c7b7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 17 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
public/app/features/plugins/extensions/getPluginExtensions.test.ts
View File

@ -134,18 +134,30 @@ describe('getPluginExtensions()', () => {
expect(extension.category).toBe('Machine Learning'); expect(extension.category).toBe('Machine Learning');
}); });
test('should hide the extension if it tries to override not-allowed properties with the configure() function', () => { test('should ignore restricted properties passed via the configure() function', () => {
link2.configure = jest.fn().mockImplementation(() => ({ link2.configure = jest.fn().mockImplementation(() => ({
// The following props are not allowed to override // The following props are not allowed to override
type: 'unknown-type', type: 'unknown-type',
pluginId: 'another-plugin', pluginId: 'another-plugin',
// Unknown properties
testing: false,
// The following props are allowed to override
title: 'test',
})); }));
const registry = createPluginExtensionRegistry([{ pluginId, extensionConfigs: [link2] }]); const registry = createPluginExtensionRegistry([{ pluginId, extensionConfigs: [link2] }]);
const { extensions } = getPluginExtensions({ registry, extensionPointId: extensionPoint2 }); const { extensions } = getPluginExtensions({ registry, extensionPointId: extensionPoint2 });
const [extension] = extensions;
expect(link2.configure).toHaveBeenCalledTimes(1); expect(link2.configure).toHaveBeenCalledTimes(1);
expect(extensions).toHaveLength(0); expect(extensions).toHaveLength(1);
expect(extension.title).toBe('test');
expect(extension.type).toBe('link');
expect(extension.pluginId).toBe('grafana-basic-app');
//@ts-ignore
expect(extension.testing).toBeUndefined();
}); });
test('should pass a read only context to the configure() function', () => { test('should pass a read only context to the configure() function', () => {
const context = { title: 'New title from the context!' }; const context = { title: 'New title from the context!' };

6
public/app/features/plugins/extensions/getPluginExtensions.ts
View File

@ -139,10 +139,10 @@ function getLinkExtensionOverrides(pluginId: string, config: PluginExtensionLink
assertStringProps({ title, description }, ['title', 'description']); assertStringProps({ title, description }, ['title', 'description']);
if (Object.keys(rest).length > 0) { if (Object.keys(rest).length > 0) {
throw new Error( logWarning(
`Invalid extension "${config.title}". Trying to override not-allowed properties: ${Object.keys(rest).join( `Extension "${config.title}", is trying to override restricted properties: ${Object.keys(rest).join(
', ' ', '
)}` )} which will be ignored.`
); );
} }