From 12367c1fb233fa63998b7addb2d84af7c6291742 Mon Sep 17 00:00:00 2001
From: Lee Yi <leeyi45@gmail.com>
Date: Tue, 9 Apr 2024 02:07:14 -0400
Subject: [PATCH] Use fetch for docs loading exclusively (#1656)

---
 src/modules/loader/loaders.ts | 46 ++++++++++++++---------------------
 src/modules/moduleTypes.ts    |  6 +++--
 2 files changed, 22 insertions(+), 30 deletions(-)

diff --git a/src/modules/loader/loaders.ts b/src/modules/loader/loaders.ts
index 69e77e3fa..e9c6d508b 100644
--- a/src/modules/loader/loaders.ts
+++ b/src/modules/loader/loaders.ts
@@ -20,10 +20,7 @@ export function setModulesStaticURL(url: string) {
   memoizedGetModuleManifestAsync.reset()
 }
 
-function wrapImporter<T>(
-  browserFunc: (p: string) => Promise<T>,
-  nodeFunc: (p: string) => Promise<T>
-) {
+function wrapImporter<T>(func: (p: string) => Promise<T>) {
   /*
     Browsers natively support esm's import() but Jest and Node do not. So we need
     to change which import function we use based on the environment.
@@ -34,9 +31,6 @@ function wrapImporter<T>(
     Browsers automatically cache import() calls, so we add a query parameter with the
     current time to always invalidate the cache and handle the memoization ourselves
   */
-  const func =
-    typeof window !== 'undefined' && process.env.NODE_ENV !== 'test' ? browserFunc : nodeFunc
-
   return async (p: string): Promise<T> => {
     try {
       const result = await timeoutPromise(func(p), 10000)
@@ -61,27 +55,21 @@ function wrapImporter<T>(
 }
 
 // Exported for testing
-export const docsImporter = wrapImporter<{ default: any }>(
-  new Function(
-    'path',
-    // TODO Change to import attributes when supported
-    'return import(`${path}?q=${Date.now()}`, { assert: { type: "json" } })'
-  ) as any,
-  async p => {
-    // Loading JSON using require/import with node is still very inconsistent
-    // So we will have to fallback to fetch
-    const resp = await fetch(p)
-    if (resp.status !== 200 && resp.status !== 304) {
-      throw new ModuleConnectionError()
-    }
-
-    const result = await resp.json()
-    return { default: result }
+export const docsImporter = wrapImporter<{ default: any }>(async p => {
+  // TODO: USe import attributes when they become supported
+  // Import Assertions and Attributes are not widely supported by all
+  // browsers yet, so we use fetch in the meantime
+  const resp = await fetch(p)
+  if (resp.status !== 200 && resp.status !== 304) {
+    throw new ModuleConnectionError()
   }
-)
+
+  const result = await resp.json()
+  return { default: result }
+})
 
 // lodash's memoize function memoizes on errors. This is undesirable,
-// so we have out own custom memoization that won't memoize on errors
+// so we have our own custom memoization that won't memoize on errors
 function getManifestImporter() {
   let manifest: ModuleManifest | null = null
 
@@ -133,8 +121,9 @@ export const memoizedGetModuleManifestAsync = getManifestImporter()
 export const memoizedGetModuleDocsAsync = getMemoizedDocsImporter()
 
 const bundleAndTabImporter = wrapImporter<{ default: ModuleBundle }>(
-  new Function('path', 'return import(`${path}?q=${Date.now()}`)') as any,
-  p => Promise.resolve(require(p))
+  typeof window !== 'undefined' && process.env.NODE_ENV !== 'test'
+    ? (new Function('path', 'return import(`${path}?q=${Date.now()}`)') as any)
+    : p => Promise.resolve(require(p))
 )
 
 export async function loadModuleBundleAsync(
@@ -146,7 +135,8 @@ export async function loadModuleBundleAsync(
     `${MODULES_STATIC_URL}/bundles/${moduleName}.js`
   )
   try {
-    return Object.entries(result(getRequireProvider(context))).reduce((res, [name, value]) => {
+    const loadedModule = result(getRequireProvider(context))
+    return Object.entries(loadedModule).reduce((res, [name, value]) => {
       if (typeof value === 'function') {
         const repr = `function ${name} {\n\t[Function from ${moduleName}\n\tImplementation hidden]\n}`
         value[Symbol.toStringTag] = () => repr
diff --git a/src/modules/moduleTypes.ts b/src/modules/moduleTypes.ts
index 1dae64a7c..7b37fa2e1 100644
--- a/src/modules/moduleTypes.ts
+++ b/src/modules/moduleTypes.ts
@@ -11,7 +11,7 @@ export type ModuleManifest = {
 export type ModuleBundle = (require: RequireProvider) => ModuleFunctions
 
 export type ModuleFunctions = {
-  [functionName: string]: Function
+  [name: string]: any
 }
 
 export interface FunctionDocumentation {
@@ -35,7 +35,9 @@ export const unknownDocs: UnknownDocumentation = { kind: 'unknown' }
 
 export type ModuleDocsEntry = FunctionDocumentation | VariableDocumentation | UnknownDocumentation
 
-export type ModuleDocumentation = Record<string, ModuleDocsEntry>
+export type ModuleDocumentation = {
+  [name: string]: ModuleDocsEntry
+}
 
 export type ImportOptions = {
   loadTabs: boolean