feat(core): add runtime config

loicduong · loicduong · commit efbe9cb22a1d · 2024-09-08T12:08:21.000+07:00
diff --git a/index.html b/index.html
@@ -6,6 +6,7 @@
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <meta name="color-scheme" content="light dark" />
     <title>%VITE_APP_TITLE%</title>
+    <script src="/runtime.config.js"></script>
   </head>
   <body>
     <div id="app"></div>
diff --git a/public/runtime.config.js b/public/runtime.config.js
@@ -1,3 +1,5 @@
 window.config = {
   VITE_BUILD_PREFIX: '',
+  VITE_SERVICE_BASE_URL: '',
+  VITE_OTHER_SERVICE_BASE_URL: '',
 }
diff --git a/src/locales/langs/en-us.ts b/src/locales/langs/en-us.ts
@@ -221,7 +221,7 @@ const local: App.I18n.Schema = {
       projectNews: {
         title: 'Project News',
         moreNews: 'More News',
-        desc1: 'Loic Duong created the open source project vue-naive-admin on May 28, 2021!',
+        desc1: 'Loic Duong created the open source project vue-naive-admin on May 28, 2024!',
         desc2: 'Loic Duong submitted a bug to vue-naive-admin, the multi-tab bar will not adapt.',
         desc3: 'Loic Duong is ready to do sufficient preparation for the release of vue-naive-admin!',
         desc4: 'Loic Duong is busy writing project documentation for vue-naive-admin!',
diff --git a/src/utils/env.ts b/src/utils/env.ts
@@ -1,3 +1,5 @@
-export function getEnvVariable(name: Env.Runtime, env?: Env.ImportMeta): CommonType.NullableString {
-  return window.config?.[name] || (env ? env[name] : import.meta.env[name])
+export function getEnvVariable(name: Env.Runtime, env?: Env.ImportMeta): string {
+  return typeof window === 'undefined'
+    ? env?.[name] || import.meta.env[name]
+    : window.config?.[name] || env?.[name] || import.meta.env[name]
 }
diff --git a/src/utils/service.ts b/src/utils/service.ts
@@ -1,23 +1,22 @@
 import json5 from 'json5'
+import { getEnvVariable } from './env'
 
 /**
  * Create service config by current env
  *
  * @param env The current env
  */
 export function createServiceConfig(env: Env.ImportMeta) {
-  const { VITE_SERVICE_BASE_URL, VITE_OTHER_SERVICE_BASE_URL } = env
-
   let other = {} as Record<App.Service.OtherBaseURLKey, string>
   try {
-    other = json5.parse(VITE_OTHER_SERVICE_BASE_URL)
+    other = json5.parse(getEnvVariable('VITE_OTHER_SERVICE_BASE_URL', env))
   }
   catch {
     console.error('VITE_OTHER_SERVICE_BASE_URL is not a valid json5 string')
   }
 
   const httpConfig: App.Service.SimpleServiceConfig = {
-    baseURL: VITE_SERVICE_BASE_URL,
+    baseURL: getEnvVariable('VITE_SERVICE_BASE_URL', env),
     other,
   }
 

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
`1`	`1`	`window.config = {`
`2`	`2`	`VITE_BUILD_PREFIX: '',`
	`3`	`+ VITE_SERVICE_BASE_URL: '',`
	`4`	`+ VITE_OTHER_SERVICE_BASE_URL: '',`
`3`	`5`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
`1`		`-export function getEnvVariable(name: Env.Runtime, env?: Env.ImportMeta): CommonType.NullableString {`
`2`		`- return window.config?.[name] \|\| (env ? env[name] : import.meta.env[name])`
	`1`	`+export function getEnvVariable(name: Env.Runtime, env?: Env.ImportMeta): string {`
	`2`	`+ return typeof window === 'undefined'`
	`3`	`+ ? env?.[name] \|\| import.meta.env[name]`
	`4`	`+ : window.config?.[name] \|\| env?.[name] \|\| import.meta.env[name]`
`3`	`5`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,23 +1,22 @@`
`1`	`1`	`import json5 from 'json5'`
	`2`	`+import { getEnvVariable } from './env'`
`2`	`3`
`3`	`4`	`/**`
`4`	`5`	`* Create service config by current env`
`5`	`6`	`*`
`6`	`7`	`* @param env The current env`
`7`	`8`	`*/`
`8`	`9`	`export function createServiceConfig(env: Env.ImportMeta) {`
`9`		`- const { VITE_SERVICE_BASE_URL, VITE_OTHER_SERVICE_BASE_URL } = env`
`10`		`-`
`11`	`10`	`let other = {} as Record<App.Service.OtherBaseURLKey, string>`
`12`	`11`	`try {`
`13`		`- other = json5.parse(VITE_OTHER_SERVICE_BASE_URL)`
	`12`	`+ other = json5.parse(getEnvVariable('VITE_OTHER_SERVICE_BASE_URL', env))`
`14`	`13`	`}`
`15`	`14`	`catch {`
`16`	`15`	`console.error('VITE_OTHER_SERVICE_BASE_URL is not a valid json5 string')`
`17`	`16`	`}`
`18`	`17`
`19`	`18`	`const httpConfig: App.Service.SimpleServiceConfig = {`
`20`		`- baseURL: VITE_SERVICE_BASE_URL,`
	`19`	`+ baseURL: getEnvVariable('VITE_SERVICE_BASE_URL', env),`
`21`	`20`	`other,`
`22`	`21`	`}`
`23`	`22`