fix(web): import builtin plugin from external url (#625)

reearth · Aug 8, 2023 · 17b2566 · 17b2566
1 parent d196904
commit 17b2566
Show file tree

Hide file tree

Showing 7 changed files with 30 additions and 65 deletions.
diff --git a/web/src/beta/lib/core/Crust/Infobox/Block/builtin/unsafeBlocks.ts b/web/src/beta/lib/core/Crust/Infobox/Block/builtin/unsafeBlocks.ts
@@ -14,7 +14,7 @@ function processUnsafeBuiltinBlocks(plugin?: UnsafeBuiltinPlugin[]) {
 
   const unsafeBlocks: UnsafeBuiltinBlocks<Component> | undefined = plugin
     .map(p =>
-      p.widgets.map(w => {
+      p.blocks?.map(w => {
         return {
           widgetId: `${p.id}/${w.extensionId}`,
           ...w,
@@ -23,11 +23,11 @@ function processUnsafeBuiltinBlocks(plugin?: UnsafeBuiltinPlugin[]) {
     )
     .reduce((a, b) => {
       const newObject: { [key: string]: Component } = {};
-      b.forEach(w => {
+      b?.forEach(w => {
         newObject[w.widgetId] = w.component;
       });
       return merge(a, newObject);
     }, {});
 
-  return unsafeBlocks;
+  return unsafeBlocks || [];
 }
diff --git a/web/src/beta/lib/core/Crust/Widgets/Widget/builtin/unsafeWidgets.ts b/web/src/beta/lib/core/Crust/Widgets/Widget/builtin/unsafeWidgets.ts
@@ -16,7 +16,7 @@ function processUnsafeBuiltinWidgets(plugin?: UnsafeBuiltinPlugin[]) {
 
   const unsafeWidgets: UnsafeBuiltinWidgets<Component> | undefined = plugin
     .map(p =>
-      p.widgets.map(w => {
+      p.widgets?.map(w => {
         return {
           widgetId: `${p.id}/${w.extensionId}`,
           ...w,
@@ -25,11 +25,11 @@ function processUnsafeBuiltinWidgets(plugin?: UnsafeBuiltinPlugin[]) {
     )
     .reduce((a, b) => {
       const newObject: { [key: string]: Component } = {};
-      b.forEach(w => {
+      b?.forEach(w => {
         newObject[w.widgetId] = w.component;
       });
       return merge(a, newObject);
     }, {});
 
-  return unsafeWidgets;
+  return unsafeWidgets || [];
 }
diff --git a/web/src/beta/lib/unsafeBuiltinPlugins/.gitignore b/web/src/beta/lib/unsafeBuiltinPlugins/.gitignore
diff --git a/web/src/beta/lib/unsafeBuiltinPlugins/README.md b/web/src/beta/lib/unsafeBuiltinPlugins/README.md
diff --git a/web/src/beta/lib/unsafeBuiltinPlugins/index.ts b/web/src/beta/lib/unsafeBuiltinPlugins/index.ts
diff --git a/web/src/services/config/index.ts b/web/src/services/config/index.ts
@@ -44,6 +44,7 @@ export type Config = {
   documentationUrl?: string;
   marketplaceUrl?: string;
   extensionUrls?: string[];
+  unsafePluginUrls?: string[];
   extensions?: Extensions;
   unsafeBuiltinPlugins?: UnsafeBuiltinPlugin[];
 };
@@ -60,7 +61,7 @@ declare global {
 export default async function loadConfig() {
   if (window.REEARTH_CONFIG) return;
   window.REEARTH_CONFIG = defaultConfig;
-  const config = {
+  const config: Config = {
     ...defaultConfig,
     ...(await (await fetch("/reearth_config.json")).json()),
   };
@@ -80,7 +81,9 @@ export default async function loadConfig() {
     config.extensions = extensions;
   }
 
-  config.unsafeBuiltinPlugins = await loadUnsafeBuiltinPlugins();
+  if (config.unsafePluginUrls) {
+    config.unsafeBuiltinPlugins = await loadUnsafeBuiltinPlugins(config.unsafePluginUrls);
+  }
 
   window.REEARTH_CONFIG = config;
 }

diff --git a/web/src/services/config/unsafeBuiltinPlugin.ts b/web/src/services/config/unsafeBuiltinPlugin.ts
@@ -1,8 +1,10 @@
+import { FC } from "react";
+
 export type UnsafeBuiltinPlugin = {
   id: string;
   name: string;
-  widgets: UnsafeBuiltinWidget[];
-  blocks: UnsafeBuiltinBlock[];
+  widgets?: UnsafeBuiltinWidget[];
+  blocks?: UnsafeBuiltinBlock[];
 };
 
 type UnsafeBuiltinWidget = UnsafeBuiltinPluginExtension<"widget">;
@@ -13,19 +15,22 @@ type UnsafeBuiltinPluginExtension<T extends "widget" | "block"> = {
   type: T;
   extensionId: string;
   name: string;
-  component: React.FC;
+  component: FC;
 };
 
 export type UnsafeBuiltinWidgets<T = unknown> = Record<string, T>;
 
-export async function loadUnsafeBuiltinPlugins() {
-  try {
-    const unsafeBuiltinPlugins = (
-      await import(/* @vite-ignore */ "src/beta/lib/unsafeBuiltinPlugins")
-    ).default as UnsafeBuiltinPlugin[];
-    return unsafeBuiltinPlugins;
-  } catch (e) {
-    console.error("unsafe builtin plugin load failed", e);
-  }
-  return undefined;
-}
+export const loadUnsafeBuiltinPlugins = async (urls: string[]) => {
+  return (
+    await Promise.all(
+      urls.map(async url => {
+        try {
+          const plugin: UnsafeBuiltinPlugin = (await import(/* @vite-ignore */ url)).default;
+          return plugin;
+        } catch (e) {
+          throw new Error(`Specified unsafe built-in module could not find: ${url} ${e}`);
+        }
+      }),
+    )
+  ).filter(Boolean);
+};