From e5474511d8838a257648e3da9b06f31681332cea Mon Sep 17 00:00:00 2001
From: Jack Westbrook <jack.westbrook@gmail.com>
Date: Fri, 21 Jun 2024 11:35:02 +0200
Subject: [PATCH] Plugins: Introduce magic modules to fe sandbox loader
 (#89274)

* feat(fe-sandbox): introduce module and exports magic modules to executed plugin code

* refactor(fe-sandbox): rename module and exports vars for clarity
---
 .../plugins/sandbox/sandbox_plugin_loader.ts  | 34 +++++++++++++++++--
 1 file changed, 31 insertions(+), 3 deletions(-)

diff --git a/public/app/features/plugins/sandbox/sandbox_plugin_loader.ts b/public/app/features/plugins/sandbox/sandbox_plugin_loader.ts
index dc0b26dc2c0..c3c278cb5bf 100644
--- a/public/app/features/plugins/sandbox/sandbox_plugin_loader.ts
+++ b/public/app/features/plugins/sandbox/sandbox_plugin_loader.ts
@@ -162,7 +162,7 @@ async function doImportPluginModuleInSandbox(meta: SandboxPluginMeta): Promise<S
           }
 
           try {
-            const resolvedDeps = resolvePluginDependencies(dependencies, meta.id);
+            const resolvedDeps = resolvePluginDependencies(dependencies, meta);
             // execute the plugin's code
             const pluginExportsRaw = factory.apply(null, resolvedDeps);
             // only after the plugin has been executed
@@ -213,7 +213,21 @@ async function doImportPluginModuleInSandbox(meta: SandboxPluginMeta): Promise<S
   });
 }
 
-function resolvePluginDependencies(deps: string[], pluginId: string) {
+/**
+ *
+ * This function resolves the dependencies using the array of AMD deps.
+ * Additionally it supports the RequireJS magic modules `module` and `exports`.
+ * https://github.com/requirejs/requirejs/wiki/Differences-between-the-simplified-CommonJS-wrapper-and-standard-AMD-define#magic
+ *
+ */
+function resolvePluginDependencies(deps: string[], pluginMeta: SandboxPluginMeta) {
+  const pluginExports = {};
+  const pluginModuleDep: ModuleMeta = {
+    id: pluginMeta.id,
+    uri: pluginMeta.module,
+    exports: pluginExports,
+  };
+
   // resolve dependencies
   const resolvedDeps: CompartmentDependencyModule[] = [];
   for (const dep of deps) {
@@ -222,10 +236,18 @@ function resolvePluginDependencies(deps: string[], pluginId: string) {
       resolvedDep = resolvedDep.default;
     }
 
+    if (dep === 'module') {
+      resolvedDep = pluginModuleDep;
+    }
+
+    if (dep === 'exports') {
+      resolvedDep = pluginExports;
+    }
+
     if (!resolvedDep) {
       const error = new Error(`[sandbox] Could not resolve dependency ${dep}`);
       logError(error, {
-        pluginId,
+        pluginId: pluginMeta.id,
         dependency: dep,
         error: String(error),
       });
@@ -235,3 +257,9 @@ function resolvePluginDependencies(deps: string[], pluginId: string) {
   }
   return resolvedDeps;
 }
+
+interface ModuleMeta {
+  id: string;
+  uri: string;
+  exports: System.Module;
+}