IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

Sandbox: allow access to window.grafanaBootData for plugins (#75522)

Browse Source 
* Sandbox: allow access to window.grafanaBootData for plugins

* Do not overlog access to bootdata

* Fix wrong string
This commit is contained in:
Esteban Beltran 2023-09-29 17:15:04 +02:00 committed by GitHub
parent 75beeeed27
commit e45867c635
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 32 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
public/app/features/plugins/sandbox/sandbox_plugin_loader.ts
View File

@ -1,7 +1,8 @@
import createVirtualEnvironment from '@locker/near-membrane-dom'; import createVirtualEnvironment from '@locker/near-membrane-dom';
import { ProxyTarget } from '@locker/near-membrane-shared'; import { ProxyTarget } from '@locker/near-membrane-shared';
import { PluginMeta } from '@grafana/data'; import { BootData, PluginMeta } from '@grafana/data';
import { config, logInfo } from '@grafana/runtime';
import { defaultTrustedTypesPolicy } from 'app/core/trustedTypePolicies'; import { defaultTrustedTypesPolicy } from 'app/core/trustedTypePolicies';
import { getPluginSettings } from '../pluginSettings'; import { getPluginSettings } from '../pluginSettings';
@ -26,6 +27,7 @@ if (process.env.NODE_ENV !== 'production') {
} }
const pluginImportCache = new Map<string, Promise<System.Module>>(); const pluginImportCache = new Map<string, Promise<System.Module>>();
const pluginLogCache: Record<string, boolean> = {};
export async function importPluginModuleInSandbox({ pluginId }: { pluginId: string }): Promise<System.Module> { export async function importPluginModuleInSandbox({ pluginId }: { pluginId: string }): Promise<System.Module> {
try { try {
@ -68,6 +70,7 @@ async function doImportPluginModuleInSandbox(meta: PluginMeta): Promise<System.M
} }
return originalValue; return originalValue;
} }
// each plugin has its own sandbox // each plugin has its own sandbox
sandboxEnvironment = createVirtualEnvironment(window, { sandboxEnvironment = createVirtualEnvironment(window, {
// distortions are interceptors to modify the behavior of objects when // distortions are interceptors to modify the behavior of objects when
@ -91,6 +94,34 @@ async function doImportPluginModuleInSandbox(meta: PluginMeta): Promise<System.M
// Similar to `window.monaco`, `window.Prism` may be undefined when invoked. // Similar to `window.monaco`, `window.Prism` may be undefined when invoked.
return Reflect.get(window, 'Prism'); return Reflect.get(window, 'Prism');
}, },
get grafanaBootData(): BootData {
if (!pluginLogCache[meta.id + '-grafanaBootData']) {
pluginLogCache[meta.id + '-grafanaBootData'] = true;
logInfo('Plugin using window.grafanaBootData', {
sandbox: 'true',
pluginId: meta.id,
guessedPluginName: meta.id,
parent: 'window',
packageName: 'window',
key: 'grafanaBootData',
});
}
// We don't want to encourage plugins to use `window.grafanaBootData`. They should
// use `@grafana/runtime.config` instead.
// if we are in dev mode we fail this access
if (config.buildInfo.env === 'development') {
throw new Error(
`Error in ${meta.id}: Plugins should not use window.grafanaBootData. Use "config" from "@grafana/runtime" instead.`
);
} else {
console.error(
`${meta.id.toUpperCase()}: Plugins should not use window.grafanaBootData. Use "config" from "@grafana/runtime" instead.`
);
}
return config.bootData;
},
// Plugins builds use the AMD module system. Their code consists // Plugins builds use the AMD module system. Their code consists
// of a single function call to `define()` that internally contains all the plugin code. // of a single function call to `define()` that internally contains all the plugin code.
// This is that `define` function the plugin will call. // This is that `define` function the plugin will call.