Files
Jack Westbrook 0d1845f857 Plugins: Fix applying default extension and AMD detection (#74471)
* fix(plugins): support edge cases where default extension was not added

* fix(plugins): only apply AMD wrapper to AMD format plugins

* refactor(plugins): update regex for codeql warnings

* refactor(plugins): remove check for commented out dependency strings in AMD regex

* test(plugins): add tests for systemjs hook amd detection
2023-09-07 14:30:35 +02:00

95 lines
3.3 KiB
TypeScript

import { config, SystemJS } from '@grafana/runtime';
import { transformPluginSourceForCDN } from '../cdn/utils';
import { resolveWithCache } from './cache';
import { LOAD_PLUGIN_CSS_REGEX, JS_CONTENT_TYPE_REGEX, AMD_MODULE_REGEX, SHARED_DEPENDENCY_PREFIX } from './constants';
import { SystemJSWithLoaderHooks } from './types';
import { isHostedOnCDN } from './utils';
export async function decorateSystemJSFetch(
systemJSFetch: SystemJSWithLoaderHooks['fetch'],
url: string,
options?: Record<string, unknown>
) {
const res = await systemJSFetch(url, options);
const contentType = res.headers.get('content-type') || '';
if (JS_CONTENT_TYPE_REGEX.test(contentType)) {
const source = await res.text();
let transformedSrc = source;
if (AMD_MODULE_REGEX.test(transformedSrc)) {
transformedSrc = preventAMDLoaderCollision(source);
}
// JS files on the CDN need their asset paths transformed in the source
if (isHostedOnCDN(res.url)) {
const cdnTransformedSrc = transformPluginSourceForCDN({ url: res.url, source: transformedSrc });
return new Response(new Blob([cdnTransformedSrc], { type: 'text/javascript' }));
}
return new Response(new Blob([transformedSrc], { type: 'text/javascript' }));
}
return res;
}
export function decorateSystemJSResolve(
this: SystemJSWithLoaderHooks,
originalResolve: SystemJSWithLoaderHooks['resolve'],
id: string,
parentUrl?: string
) {
const isFileSystemModule = id.endsWith('module.js') && !isHostedOnCDN(id);
try {
const url = originalResolve.apply(this, [id, parentUrl]);
const cleanedUrl = getBackWardsCompatibleUrl(url);
// Add a cache query param for filesystem module.js requests
// CDN hosted plugins contain the version in the path so skip
return isFileSystemModule ? resolveWithCache(cleanedUrl) : cleanedUrl;
} catch (err) {
// Provide fallback for old plugins that use `loadPluginCss` to load theme styles
// Only affect plugins on the filesystem.
if (LOAD_PLUGIN_CSS_REGEX.test(id)) {
return `${config.appSubUrl ?? ''}/public/${id}`;
}
console.log(`SystemJS: failed to resolve '${id}'`);
return id;
}
}
export function decorateSystemJsOnload(err: unknown, id: string) {
if (id.endsWith('.css') && !err) {
const module = SystemJS.get(id);
const styles = module?.default;
if (styles) {
document.adoptedStyleSheets = [...document.adoptedStyleSheets, styles];
}
}
}
// This function handles the following legacy SystemJS functionality:
// - strips legacy loader wildcard from urls
// - support config.defaultExtension for System.register deps that lack an extension (e.g. './my_ctrl')
function getBackWardsCompatibleUrl(url: string) {
if (url.startsWith(`${SHARED_DEPENDENCY_PREFIX}:`)) {
return url;
}
if (url.endsWith('!')) {
url = url.slice(0, -1);
}
const systemJSFileExtensions = ['css', 'js', 'json', 'wasm'];
const hasValidFileExtension = systemJSFileExtensions.some((extensionName) => url.endsWith(extensionName));
return hasValidFileExtension ? url : url + '.js';
}
// This transform prevents a conflict between systemjs and requirejs which Monaco Editor
// depends on. See packages/grafana-runtime/src/utils/plugin.ts for more.
function preventAMDLoaderCollision(source: string) {
return `(function(define) {
${source}
})(window.__grafana_amd_define);`;
}