refactor(config): use conventional naming

swagger-api · May 6, 2024 · fe6c1b8 · fe6c1b8
1 parent a56643f
commit fe6c1b8
Show file tree

Hide file tree

Showing 4 changed files with 66 additions and 58 deletions.
diff --git a/src/core/config/factorization/store.js → src/core/config/factorization/system.js b/src/core/config/factorization/store.js → src/core/config/factorization/system.js
@@ -3,7 +3,7 @@
  */
 import deepExtend from "deep-extend"
 
-const storeFactorization = (options) => {
+const systemFactorization = (options) => {
   const state = deepExtend(
     {
       layout: {
@@ -42,4 +42,4 @@ const storeFactorization = (options) => {
   }
 }
 
-export default storeFactorization
+export default systemFactorization
diff --git a/src/core/config/index.js b/src/core/config/index.js
@@ -2,7 +2,7 @@
  * @prettier
  */
 export { default as inlinePluginOptionsFactorization } from "./factorization/inline-plugin"
-export { default as storeOptionsFactorization } from "./factorization/store"
+export { default as systemOptionsFactorization } from "./factorization/system"
 export { default as optionsFromQuery } from "./sources/query"
 export { default as optionsFromURL } from "./sources/url"
 export { default as optionsFromRuntime } from "./sources/runtime"

diff --git a/src/core/config/sources/url.js b/src/core/config/sources/url.js
@@ -2,19 +2,24 @@
  * @prettier
  * Receives options from a remote URL.
  */
+const makeDeferred = () => {
+  const deferred = {}
+  deferred.promise = new Promise((resolve, reject) => {
+    deferred.resolve = resolve
+    deferred.reject = reject
+  })
+  return deferred
+}
 
 const optionsFromURL =
   ({ url, system }) =>
   async (options) => {
     if (!url) return {}
     if (typeof system.configsActions?.getConfigByUrl !== "function") return {}
-    let resolve
-    const deferred = new Promise((res) => {
-      resolve = res
-    })
+    const deferred = makeDeferred()
     const callback = (fetchedOptions) => {
       // receives null on remote URL fetch failure
-      resolve(fetchedOptions)
+      deferred.resolve(fetchedOptions)
     }
 
     system.configsActions.getConfigByUrl(
@@ -27,7 +32,7 @@ const optionsFromURL =
       callback
     )
 
-    return deferred
+    return deferred.promise
   }
 
 export default optionsFromURL
diff --git a/src/core/index.js b/src/core/index.js
@@ -39,7 +39,7 @@ import {
   optionsFromRuntime,
   mergeOptions,
   inlinePluginOptionsFactorization,
-  storeOptionsFactorization,
+  systemOptionsFactorization,
   typeCastOptions,
   typeCastMappings,
 } from "./config"
@@ -54,65 +54,68 @@ function SwaggerUI(userOptions) {
     userOptions,
     queryOptions
   )
-  const storeOptions = storeOptionsFactorization(mergedOptions)
+  const storeOptions = systemOptionsFactorization(mergedOptions)
   const InlinePlugin = inlinePluginOptionsFactorization(mergedOptions)
 
-  const store = new System(storeOptions)
-  store.register([mergedOptions.plugins, InlinePlugin])
-  const system = store.getSystem()
+  const system = new System(storeOptions)
+  system.register([mergedOptions.plugins, InlinePlugin])
 
-  optionsFromURL({ url: mergedOptions.configUrl, system })(mergedOptions).then(
-    (urlOptions) => {
-      const urlOptionsFailedToFetch = urlOptions === null
+  const boundSystem = system.getSystem()
 
-      mergedOptions = SwaggerUI.config.merge(
-        {},
-        mergedOptions,
-        urlOptions,
-        queryOptions
-      )
-      store.setConfigs(mergedOptions)
-      system.configsActions.loaded()
+  optionsFromURL({ url: mergedOptions.configUrl, system: boundSystem })(
+    mergedOptions
+  ).then((urlOptions) => {
+    const urlOptionsFailedToFetch = urlOptions === null
 
-      if (!urlOptionsFailedToFetch) {
-        if (
-          !queryOptions.url &&
-          typeof mergedOptions.spec === "object" &&
-          Object.keys(mergedOptions.spec).length > 0
-        ) {
-          system.specActions.updateUrl("")
-          system.specActions.updateLoadingStatus("success")
-          system.specActions.updateSpec(JSON.stringify(mergedOptions.spec))
-        } else if (
-          typeof system.specActions.download === "function" &&
-          mergedOptions.url &&
-          !mergedOptions.urls
-        ) {
-          system.specActions.updateUrl(mergedOptions.url)
-          system.specActions.download(mergedOptions.url)
-        }
-      }
+    mergedOptions = SwaggerUI.config.merge(
+      {},
+      mergedOptions,
+      urlOptions,
+      queryOptions
+    )
+    system.setConfigs(mergedOptions)
+    boundSystem.configsActions.loaded()
 
-      if (mergedOptions.domNode) {
-        system.render(mergedOptions.domNode, "App")
-      } else if (mergedOptions.dom_id) {
-        let domNode = document.querySelector(mergedOptions.dom_id)
-        system.render(domNode, "App")
+    if (!urlOptionsFailedToFetch) {
+      if (
+        !queryOptions.url &&
+        typeof mergedOptions.spec === "object" &&
+        Object.keys(mergedOptions.spec).length > 0
+      ) {
+        boundSystem.specActions.updateUrl("")
+        boundSystem.specActions.updateLoadingStatus("success")
+        boundSystem.specActions.updateSpec(JSON.stringify(mergedOptions.spec))
       } else if (
-        mergedOptions.dom_id === null ||
-        mergedOptions.domNode === null
+        typeof boundSystem.specActions.download === "function" &&
+        mergedOptions.url &&
+        !mergedOptions.urls
       ) {
-        // do nothing
-        // this is useful for testing that does not need to do any rendering
-      } else {
-        console.error(
-          "Skipped rendering: no `dom_id` or `domNode` was specified"
-        )
+        boundSystem.specActions.updateUrl(mergedOptions.url)
+        boundSystem.specActions.download(mergedOptions.url)
       }
     }
-  )
 
-  return system
+    if (mergedOptions.domNode) {
+      boundSystem.render(mergedOptions.domNode, "App")
+    } else if (mergedOptions.dom_id) {
+      const domNode = document.querySelector(mergedOptions.dom_id)
+      boundSystem.render(domNode, "App")
+    } else if (
+      mergedOptions.dom_id === null ||
+      mergedOptions.domNode === null
+    ) {
+      /**
+       * noop
+       *
+       * SwaggerUI instance can be created without any rendering involved.
+       * This is also useful for lazy rendering or testing.
+       */
+    } else {
+      console.error("Skipped rendering: no `dom_id` or `domNode` was specified")
+    }
+  })
+
+  return boundSystem
 }
 
 SwaggerUI.System = System