From 4cc1487f46b8b1b14b7872de14abf35215961025 Mon Sep 17 00:00:00 2001
From: Soybean <soybeanjs@outlook.com>
Date: Wed, 12 Mar 2025 23:08:24 +0800
Subject: [PATCH] feat(projects): support proxy log in terminal

---
 .env                      |  3 +++
 build/config/proxy.ts     | 27 +++++++++++++++++++++++----
 package.json              |  2 ++
 pnpm-lock.yaml            |  6 ++++++
 src/typings/vite-env.d.ts |  2 ++
 5 files changed, 36 insertions(+), 4 deletions(-)

diff --git a/.env b/.env
index d2d7f54c..bf5baffe 100644
--- a/.env
+++ b/.env
@@ -51,3 +51,6 @@ VITE_STORAGE_PREFIX=SOY_
 
 # used to control whether the program automatically detects updates
 VITE_AUTOMATICALLY_DETECT_UPDATE=Y
+
+# show proxy url log in terminal
+VITE_PROXY_LOG=Y
diff --git a/build/config/proxy.ts b/build/config/proxy.ts
index 548ea4e7..e307d30e 100644
--- a/build/config/proxy.ts
+++ b/build/config/proxy.ts
@@ -1,4 +1,6 @@
-import type { ProxyOptions } from 'vite';
+import type { HttpProxy, ProxyOptions } from 'vite';
+import { bgRed, bgYellow, green, lightBlue } from 'kolorist';
+import { consola } from 'consola';
 import { createServiceConfig } from '../../src/utils/service';
 
 /**
@@ -12,23 +14,40 @@ export function createViteProxy(env: Env.ImportMeta, enable: boolean) {
 
   if (!isEnableHttpProxy) return undefined;
 
+  const isEnableProxyLog = env.VITE_PROXY_LOG === 'Y';
+
   const { baseURL, proxyPattern, other } = createServiceConfig(env);
 
-  const proxy: Record<string, ProxyOptions> = createProxyItem({ baseURL, proxyPattern });
+  const proxy: Record<string, ProxyOptions> = createProxyItem({ baseURL, proxyPattern }, isEnableProxyLog);
 
   other.forEach(item => {
-    Object.assign(proxy, createProxyItem(item));
+    Object.assign(proxy, createProxyItem(item, isEnableProxyLog));
   });
 
   return proxy;
 }
 
-function createProxyItem(item: App.Service.ServiceConfigItem) {
+function createProxyItem(item: App.Service.ServiceConfigItem, enableLog: boolean) {
   const proxy: Record<string, ProxyOptions> = {};
 
   proxy[item.proxyPattern] = {
     target: item.baseURL,
     changeOrigin: true,
+    configure: (_proxy: HttpProxy.Server, options: ProxyOptions) => {
+      _proxy.on('proxyReq', (_proxyReq, req, _res) => {
+        if (!enableLog) return;
+
+        const requestUrl = `${lightBlue('[proxy url]')}: ${bgYellow(` ${req.method} `)} ${green(`${item.proxyPattern}${req.url}`)}`;
+
+        const proxyUrl = `${lightBlue('[real request url]')}: ${green(`${options.target}${req.url}`)}`;
+
+        consola.log(`${requestUrl}\n${proxyUrl}`);
+      });
+      _proxy.on('error', (_err, req, _res) => {
+        if (!enableLog) return;
+        consola.log(bgRed(`Error: ${req.method} `), green(`${options.target}${req.url}`));
+      });
+    },
     rewrite: path => path.replace(new RegExp(`^${item.proxyPattern}`), '')
   };
 
diff --git a/package.json b/package.json
index 9021b5a6..3e06daa4 100644
--- a/package.json
+++ b/package.json
@@ -85,8 +85,10 @@
     "@unocss/vite": "66.0.0",
     "@vitejs/plugin-vue": "5.2.1",
     "@vitejs/plugin-vue-jsx": "4.1.1",
+    "consola": "3.4.0",
     "eslint": "9.22.0",
     "eslint-plugin-vue": "10.0.0",
+    "kolorist": "1.8.0",
     "lint-staged": "15.4.3",
     "sass": "1.85.1",
     "simple-git-hooks": "2.11.1",
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index 9abfaa7b..32f3e978 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -117,12 +117,18 @@ importers:
       '@vitejs/plugin-vue-jsx':
         specifier: 4.1.1
         version: 4.1.1(vite@6.2.1(@types/node@22.13.10)(jiti@2.4.2)(sass@1.85.1)(tsx@4.19.3)(yaml@2.7.0))(vue@3.5.13(typescript@5.8.2))
+      consola:
+        specifier: 3.4.0
+        version: 3.4.0
       eslint:
         specifier: 9.22.0
         version: 9.22.0(jiti@2.4.2)
       eslint-plugin-vue:
         specifier: 10.0.0
         version: 10.0.0(eslint@9.22.0(jiti@2.4.2))(vue-eslint-parser@10.1.1(eslint@9.22.0(jiti@2.4.2)))
+      kolorist:
+        specifier: 1.8.0
+        version: 1.8.0
       lint-staged:
         specifier: 15.4.3
         version: 15.4.3
diff --git a/src/typings/vite-env.d.ts b/src/typings/vite-env.d.ts
index 66a384ff..d6ba76f6 100644
--- a/src/typings/vite-env.d.ts
+++ b/src/typings/vite-env.d.ts
@@ -106,6 +106,8 @@ declare namespace Env {
     readonly VITE_STORAGE_PREFIX?: string;
     /** Whether to automatically detect updates after configuring application packaging */
     readonly VITE_AUTOMATICALLY_DETECT_UPDATE?: CommonType.YesOrNo;
+    /** show proxy url log in terminal */
+    readonly VITE_PROXY_LOG?: CommonType.YesOrNo;
   }
 }