@lark-apaas/devtool-kits 1.0.5-alpha.2 → 1.0.5-alpha.4

package/dist/index.d.cts

@@ -30,6 +30,8 @@ interface ProxyErrorOptions {
     retryInterval?: number;
     /** 目标服务器地址，用于检查服务是否恢复，格式：http://localhost:3000 */
     target?: string;
+    /** 客户端基础路径，默认 '/' */
+    clientBasePath?: string;
 }
 /**
  * HTTP Proxy 错误处理器
@@ -197,6 +199,37 @@ interface DevLogsMiddlewareOptions {
  */
 declare function createCollectLogsMiddleware(options?: DevLogsMiddlewareOptions): RouteMiddleware;
 
+interface HealthCheckMiddlewareOptions {
+    /** 目标服务端口，默认 3000 */
+    targetPort?: number;
+    /** 目标服务主机，默认 localhost */
+    targetHost?: string;
+    /** 健康检查超时时间（毫秒），默认 2000ms */
+    timeout?: number;
+}
+/**
+ * Creates health check middleware for checking service availability
+ * Supports both rspack/webpack and Vite dev servers
+ *
+ * @example
+ * ```typescript
+ * // In rspack/webpack setupMiddlewares
+ * registerMiddlewares(devServer.app, [
+ *   createHealthCheckMiddleware({ targetPort: 3000 })
+ * ]);
+ *
+ * // Check health at: GET /dev/health
+ * // Response:
+ * // {
+ * //   "status": "healthy",
+ * //   "service": "localhost:3000",
+ * //   "responseTime": 15,
+ * //   "timestamp": "2025-01-10T12:00:00.000Z"
+ * // }
+ * ```
+ */
+declare function createHealthCheckMiddleware(options?: HealthCheckMiddlewareOptions): RouteMiddleware;
+
 /**
  * Register middlewares for Express-compatible servers or Vite
  * @param server - Express app or Vite middleware instance
@@ -236,4 +269,4 @@ declare function createCollectLogsMiddleware(options?: DevLogsMiddlewareOptions)
  */
 declare function registerMiddlewares(server: ExpressApp | ViteMiddleware, middlewares: Middleware[], options?: Partial<MiddlewareContext>): Promise<void>;
 
-export { type GlobalMiddleware, type Middleware, type MiddlewareContext, type RouteInfo, type RouteMiddleware, createCollectLogsMiddleware, createDevLogsMiddleware, createOpenapiMiddleware, handleDevProxyError, normalizeBasePath, postprocessDrizzleSchema, registerMiddlewares };
+export { type GlobalMiddleware, type Middleware, type MiddlewareContext, type RouteInfo, type RouteMiddleware, createCollectLogsMiddleware, createDevLogsMiddleware, createHealthCheckMiddleware, createOpenapiMiddleware, handleDevProxyError, normalizeBasePath, postprocessDrizzleSchema, registerMiddlewares };

package/dist/index.d.ts

@@ -30,6 +30,8 @@ interface ProxyErrorOptions {
     retryInterval?: number;
     /** 目标服务器地址，用于检查服务是否恢复，格式：http://localhost:3000 */
     target?: string;
+    /** 客户端基础路径，默认 '/' */
+    clientBasePath?: string;
 }
 /**
  * HTTP Proxy 错误处理器
@@ -197,6 +199,37 @@ interface DevLogsMiddlewareOptions {
  */
 declare function createCollectLogsMiddleware(options?: DevLogsMiddlewareOptions): RouteMiddleware;
 
+interface HealthCheckMiddlewareOptions {
+    /** 目标服务端口，默认 3000 */
+    targetPort?: number;
+    /** 目标服务主机，默认 localhost */
+    targetHost?: string;
+    /** 健康检查超时时间（毫秒），默认 2000ms */
+    timeout?: number;
+}
+/**
+ * Creates health check middleware for checking service availability
+ * Supports both rspack/webpack and Vite dev servers
+ *
+ * @example
+ * ```typescript
+ * // In rspack/webpack setupMiddlewares
+ * registerMiddlewares(devServer.app, [
+ *   createHealthCheckMiddleware({ targetPort: 3000 })
+ * ]);
+ *
+ * // Check health at: GET /dev/health
+ * // Response:
+ * // {
+ * //   "status": "healthy",
+ * //   "service": "localhost:3000",
+ * //   "responseTime": 15,
+ * //   "timestamp": "2025-01-10T12:00:00.000Z"
+ * // }
+ * ```
+ */
+declare function createHealthCheckMiddleware(options?: HealthCheckMiddlewareOptions): RouteMiddleware;
+
 /**
  * Register middlewares for Express-compatible servers or Vite
  * @param server - Express app or Vite middleware instance
@@ -236,4 +269,4 @@ declare function createCollectLogsMiddleware(options?: DevLogsMiddlewareOptions)
  */
 declare function registerMiddlewares(server: ExpressApp | ViteMiddleware, middlewares: Middleware[], options?: Partial<MiddlewareContext>): Promise<void>;
 
-export { type GlobalMiddleware, type Middleware, type MiddlewareContext, type RouteInfo, type RouteMiddleware, createCollectLogsMiddleware, createDevLogsMiddleware, createOpenapiMiddleware, handleDevProxyError, normalizeBasePath, postprocessDrizzleSchema, registerMiddlewares };
+export { type GlobalMiddleware, type Middleware, type MiddlewareContext, type RouteInfo, type RouteMiddleware, createCollectLogsMiddleware, createDevLogsMiddleware, createHealthCheckMiddleware, createOpenapiMiddleware, handleDevProxyError, normalizeBasePath, postprocessDrizzleSchema, registerMiddlewares };

package/dist/index.js

@@ -22320,10 +22320,10 @@ var require_layer = __commonJS({
 var require_methods = __commonJS({
   "../../../node_modules/methods/index.js"(exports, module) {
     "use strict";
-    var http = __require("http");
+    var http3 = __require("http");
     module.exports = getCurrentNodeMethods() || getBasicNodeMethods();
     function getCurrentNodeMethods() {
-      return http.METHODS && http.METHODS.map(/* @__PURE__ */ __name(function lowerCaseMethod(method) {
+      return http3.METHODS && http3.METHODS.map(/* @__PURE__ */ __name(function lowerCaseMethod(method) {
         return method.toLowerCase();
       }, "lowerCaseMethod"));
     }
@@ -25995,13 +25995,13 @@ var require_application = __commonJS({
   "../../../node_modules/express/lib/application.js"(exports, module) {
     "use strict";
     var finalhandler = require_finalhandler();
-    var Router = require_router();
+    var Router2 = require_router();
     var methods = require_methods();
     var middleware = require_init();
     var query = require_query();
     var debug = require_src3()("express:application");
     var View = require_view();
-    var http = __require("http");
+    var http3 = __require("http");
     var compileETag = require_utils2().compileETag;
     var compileQueryParser = require_utils2().compileQueryParser;
     var compileTrust = require_utils2().compileTrust;
@@ -26060,7 +26060,7 @@ var require_application = __commonJS({
     }, "defaultConfiguration");
     app.lazyrouter = /* @__PURE__ */ __name(function lazyrouter() {
       if (!this._router) {
-        this._router = new Router({
+        this._router = new Router2({
           caseSensitive: this.enabled("case sensitive routing"),
           strict: this.enabled("strict routing")
         });
@@ -26250,7 +26250,7 @@ var require_application = __commonJS({
       tryRender(view, renderOptions, done);
     }, "render");
     app.listen = /* @__PURE__ */ __name(function listen() {
-      var server = http.createServer(this);
+      var server = http3.createServer(this);
       return server.listen.apply(server, arguments);
     }, "listen");
     function logerror(err) {
@@ -26913,12 +26913,12 @@ var require_request = __commonJS({
     var deprecate = require_depd()("express");
     var isIP = __require("net").isIP;
     var typeis = require_type_is();
-    var http = __require("http");
+    var http3 = __require("http");
     var fresh = require_fresh();
     var parseRange = require_range_parser();
     var parse = require_parseurl();
     var proxyaddr = require_proxy_addr();
-    var req = Object.create(http.IncomingMessage.prototype);
+    var req = Object.create(http3.IncomingMessage.prototype);
     module.exports = req;
     req.get = req.header = /* @__PURE__ */ __name(function header(name) {
       if (!name) {
@@ -27344,7 +27344,7 @@ var require_response = __commonJS({
     var deprecate = require_depd()("express");
     var encodeUrl = require_encodeurl();
     var escapeHtml = require_escape_html();
-    var http = __require("http");
+    var http3 = __require("http");
     var isAbsolute3 = require_utils2().isAbsolute;
     var onFinished = require_on_finished();
     var path6 = __require("path");
@@ -27360,7 +27360,7 @@ var require_response = __commonJS({
     var mime = send.mime;
     var resolve = path6.resolve;
     var vary = require_vary();
-    var res = Object.create(http.ServerResponse.prototype);
+    var res = Object.create(http3.ServerResponse.prototype);
     module.exports = res;
     var charsetRegExp = /;\s*charset\s*=/;
     res.status = /* @__PURE__ */ __name(function status(code) {
@@ -28009,7 +28009,7 @@ var require_express = __commonJS({
     var mixin = require_merge_descriptors();
     var proto = require_application();
     var Route = require_route();
-    var Router = require_router();
+    var Router2 = require_router();
     var req = require_request();
     var res = require_response();
     exports = module.exports = createApplication;
@@ -28043,7 +28043,7 @@ var require_express = __commonJS({
     exports.request = req;
     exports.response = res;
     exports.Route = Route;
-    exports.Router = Router;
+    exports.Router = Router2;
     exports.json = bodyParser.json;
     exports.query = require_query();
     exports.raw = bodyParser.raw;
@@ -28394,7 +28394,8 @@ import fs2 from "fs";
 import path2 from "path";
 import { createReadStream } from "fs";
 import { createInterface } from "readline";
-import { connect } from "net";
+import http from "http";
+import https from "https";
 var errorHtmlTemplate = null;
 function isConnectionError(err) {
   const code = err.code;
@@ -28408,30 +28409,40 @@ function isConnectionError(err) {
   return connectionErrorCodes.includes(code || "");
 }
 __name(isConnectionError, "isConnectionError");
-function checkServiceAvailable(host, port, timeout = 1e3) {
+function checkServiceAvailable(targetUrl, timeout = 1e3) {
   return new Promise((resolve) => {
-    const socket = connect(port, host);
-    const timer = setTimeout(() => {
-      socket.destroy();
-      resolve(false);
-    }, timeout);
-    socket.on("connect", () => {
-      clearTimeout(timer);
-      socket.destroy();
-      resolve(true);
-    });
-    socket.on("error", () => {
-      clearTimeout(timer);
-      socket.destroy();
+    try {
+      const url = new URL(targetUrl);
+      const isHttps = url.protocol === "https:";
+      const httpModule = isHttps ? https : http;
+      const req = httpModule.request({
+        hostname: url.hostname,
+        port: url.port || (isHttps ? 443 : 80),
+        path: "/",
+        method: "HEAD",
+        timeout
+      }, (res) => {
+        const available = res.statusCode !== 502 && !res.headers["x-proxy-error-page"];
+        resolve(available);
+      });
+      req.on("timeout", () => {
+        req.destroy();
+        resolve(false);
+      });
+      req.on("error", () => {
+        resolve(false);
+      });
+      req.end();
+    } catch (e) {
       resolve(false);
-    });
+    }
   });
 }
 __name(checkServiceAvailable, "checkServiceAvailable");
-async function waitForServiceRecovery(host, port, timeout, interval) {
+async function waitForServiceRecovery(targetUrl, timeout, interval) {
   const startTime = Date.now();
   while (Date.now() - startTime < timeout) {
-    const isAvailable = await checkServiceAvailable(host, port);
+    const isAvailable = await checkServiceAvailable(targetUrl, 2e3);
     if (isAvailable) {
       return true;
     }
@@ -28522,7 +28533,7 @@ async function readRecentErrorLogs(logDir, maxLogs, fileName) {
   };
 }
 __name(readRecentErrorLogs, "readRecentErrorLogs");
-function injectErrorData(template, errorLogs) {
+function injectErrorData(template, errorLogs, clientBasePath) {
   let logsText = "";
   if (errorLogs.length > 0) {
     logsText = errorLogs.join("\n");
@@ -28530,11 +28541,12 @@ function injectErrorData(template, errorLogs) {
     logsText = "\u672A\u627E\u5230\u76F8\u5173\u9519\u8BEF\u65E5\u5FD7";
   }
   return template.replace("{{.errorData.message}}", `\u670D\u52A1\u542F\u52A8\u5F02\u5E38\uFF0C\u8BF7\u6839\u636E\u65E5\u5FD7\u4FEE\u590D\u76F8\u5173\u95EE\u9898
- ${JSON.stringify(logsText)}`);
+ ${JSON.stringify(logsText)}`).replace("{{.clientBasePath}}", clientBasePath);
 }
 __name(injectErrorData, "injectErrorData");
 function handleDevProxyError(err, req, res, options) {
-  const { logDir = path2.join(process.cwd(), "logs"), maxErrorLogs = 100, logFileName = "server.log", retryTimeout = 5e3, retryInterval = 500, target } = options || {};
+  const { logDir = path2.join(process.cwd(), "logs"), maxErrorLogs = 100, logFileName = "server.log", retryTimeout = 5e3, retryInterval = 500, target, clientBasePath = process.env.CLIENT_BASE_PATH || "/" } = options || {};
+  const clientBasePathWithoutSlash = normalizeBasePath(clientBasePath);
   console.error("[Proxy Error]:", err.message);
   if (res.headersSent) {
     console.error("[Proxy Error]: Headers already sent, cannot send error page");
@@ -28546,32 +28558,32 @@ function handleDevProxyError(err, req, res, options) {
       const { logs: errorLogs, hasCompileError } = await readRecentErrorLogs(logDir, maxErrorLogs, logFileName);
       if (isConnError && !hasCompileError && target) {
         console.log("[Proxy Error]: Connection error without compile errors, possibly server restarting...");
-        let targetUrl = null;
         try {
-          targetUrl = new URL(target);
+          new URL(target);
         } catch (e) {
           console.error("[Proxy Error]: Invalid target URL:", target);
+          console.log("[Proxy Error]: Showing error page due to invalid target");
         }
-        if (targetUrl) {
-          const host = targetUrl.hostname;
-          const port = targetUrl.port ? parseInt(targetUrl.port) : targetUrl.protocol === "https:" ? 443 : 80;
-          console.log(`[Proxy Error]: Waiting for service recovery at ${host}:${port} (timeout: ${retryTimeout}ms)...`);
-          const recovered = await waitForServiceRecovery(host, port, retryTimeout, retryInterval);
-          if (recovered) {
-            console.log("[Proxy Error]: Service recovered, sending redirect");
-            sendSimpleRedirect(req, res);
-            return;
-          }
-          console.log("[Proxy Error]: Service did not recover within timeout, showing error page");
+        console.log(`[Proxy Error]: Waiting for service recovery at ${target} (timeout: ${retryTimeout}ms)...`);
+        const recovered = await waitForServiceRecovery(target, retryTimeout, retryInterval);
+        if (recovered) {
+          console.log("[Proxy Error]: Service recovered within timeout, sending 302 redirect");
+          sendSimpleRedirect(req, res);
+          return;
         }
-        console.log("[Proxy Error]: Falling back to scenario 2 (detailed error page with probe)");
+        console.log("[Proxy Error]: Service did not recover within timeout, showing error page with probe");
+      }
+      if (isConnError && !hasCompileError) {
+        console.log("[Proxy Error]: Showing error page with auto-refresh probe");
+      } else {
+        console.log("[Proxy Error]: Compile error or non-connection error, showing error page");
       }
-      console.log("[Proxy Error]: Compile error or non-connection error, showing error page");
       const template = getErrorHtmlTemplate();
-      const html = injectErrorData(template, errorLogs);
+      const html = injectErrorData(template, errorLogs, clientBasePathWithoutSlash);
       res.writeHead(502, {
         "Content-Type": "text/html; charset=utf-8",
-        "Cache-Control": "no-cache, no-store, must-revalidate"
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Proxy-Error-Page": "true"
       });
       res.end(html);
     } catch (error) {
@@ -28601,8 +28613,99 @@ __name(sendSimpleRedirect, "sendSimpleRedirect");
 // src/middlewares/index.ts
 import path5 from "path";
 
-// src/middlewares/openapi/router.ts
+// src/middlewares/health-check/router.ts
 var import_express = __toESM(require_express2(), 1);
+import http2 from "http";
+function checkServiceHealth(host, port, timeout) {
+  return new Promise((resolve) => {
+    const startTime = Date.now();
+    const req = http2.request({
+      hostname: host,
+      port,
+      path: "/",
+      method: "HEAD",
+      timeout
+    }, (_res) => {
+      const responseTime = Date.now() - startTime;
+      resolve({
+        available: true,
+        responseTime
+      });
+    });
+    req.on("timeout", () => {
+      req.destroy();
+      resolve({
+        available: false,
+        error: "Request timeout"
+      });
+    });
+    req.on("error", (err) => {
+      resolve({
+        available: false,
+        error: err.message
+      });
+    });
+    req.end();
+  });
+}
+__name(checkServiceHealth, "checkServiceHealth");
+function createHealthCheckRouter(options = {}) {
+  const { targetPort = Number(process.env.SERVER_PORT) || 3e3, targetHost = "localhost", timeout = 2e3 } = options;
+  const router = (0, import_express.Router)();
+  router.get("/", async (_req, res) => {
+    try {
+      const result = await checkServiceHealth(targetHost, targetPort, timeout);
+      if (result.available) {
+        res.status(200).json({
+          status: "healthy",
+          service: `${targetHost}:${targetPort}`,
+          responseTime: result.responseTime,
+          timestamp: (/* @__PURE__ */ new Date()).toISOString()
+        });
+      } else {
+        res.status(503).json({
+          status: "unhealthy",
+          service: `${targetHost}:${targetPort}`,
+          error: result.error,
+          timestamp: (/* @__PURE__ */ new Date()).toISOString()
+        });
+      }
+    } catch (error) {
+      res.status(500).json({
+        status: "error",
+        service: `${targetHost}:${targetPort}`,
+        error: error instanceof Error ? error.message : "Unknown error",
+        timestamp: (/* @__PURE__ */ new Date()).toISOString()
+      });
+    }
+  });
+  return router;
+}
+__name(createHealthCheckRouter, "createHealthCheckRouter");
+
+// src/middlewares/health-check/index.ts
+var HEALTH_CHECK_ROUTES = [
+  {
+    method: "GET",
+    path: "/",
+    description: "Check if target service is healthy and available"
+  }
+];
+function createHealthCheckMiddleware(options = {}) {
+  return {
+    name: "health-check",
+    mountPath: "/dev/health",
+    routes: HEALTH_CHECK_ROUTES,
+    enabled: /* @__PURE__ */ __name((context) => context.isDev, "enabled"),
+    createRouter: /* @__PURE__ */ __name((_context) => {
+      return createHealthCheckRouter(options);
+    }, "createRouter")
+  };
+}
+__name(createHealthCheckMiddleware, "createHealthCheckMiddleware");
+
+// src/middlewares/openapi/router.ts
+var import_express2 = __toESM(require_express2(), 1);
 
 // src/middlewares/openapi/controller.ts
 import fs5 from "fs/promises";
@@ -28849,7 +28952,7 @@ __name(createOpenapiHandler, "createOpenapiHandler");
 // src/middlewares/openapi/router.ts
 function createOpenapiRouter(options, context) {
   const { openapiFilePath, enableEnhancement, serverDir } = options;
-  const router = import_express.default.Router();
+  const router = import_express2.default.Router();
   const handler = createOpenapiHandler(openapiFilePath, enableEnhancement, serverDir);
   router.get("/openapi.json", (req, res) => handler(req, res, context));
   return router;
@@ -28883,7 +28986,7 @@ function createOpenapiMiddleware(options) {
 __name(createOpenapiMiddleware, "createOpenapiMiddleware");
 
 // src/middlewares/dev-logs/router.ts
-var import_express2 = __toESM(require_express2(), 1);
+var import_express3 = __toESM(require_express2(), 1);
 
 // src/middlewares/dev-logs/utils.ts
 import { promises as fs6 } from "fs";
@@ -29328,7 +29431,7 @@ __name(createGetLogFileHandler, "createGetLogFileHandler");
 // src/middlewares/dev-logs/router.ts
 function createDevLogRouter(options = {}) {
   const logDir = resolveLogDir(options.logDir);
-  const router = import_express2.default.Router();
+  const router = import_express3.default.Router();
   router.get("/app/trace/:traceId", createGetTraceEntriesHandler(logDir));
   router.get("/trace/recent", createGetRecentTracesHandler(logDir));
   router.get("/files/:fileName", createGetLogFileHandler(logDir));
@@ -29371,7 +29474,7 @@ function createDevLogsMiddleware(options = {}) {
 __name(createDevLogsMiddleware, "createDevLogsMiddleware");
 
 // src/middlewares/collect-logs/router.ts
-var import_express3 = __toESM(require_express2(), 1);
+var import_express4 = __toESM(require_express2(), 1);
 
 // src/middlewares/collect-logs/controller.ts
 import { join as join4 } from "path";
@@ -29470,9 +29573,9 @@ __name(handleError2, "handleError");
 // src/middlewares/collect-logs/router.ts
 function createDevLogRouter2(options = {}) {
   const logDir = resolveLogDir2(options.logDir);
-  const router = import_express3.default.Router();
-  router.post("/collect", import_express3.default.json(), collectLogsHandler(logDir, options.fileName || "client.log"));
-  router.post("/collect-batch", import_express3.default.json(), collectLogsBatchHandler(logDir, options.fileName || "client.log"));
+  const router = import_express4.default.Router();
+  router.post("/collect", import_express4.default.json(), collectLogsHandler(logDir, options.fileName || "client.log"));
+  router.post("/collect-batch", import_express4.default.json(), collectLogsBatchHandler(logDir, options.fileName || "client.log"));
   return router;
 }
 __name(createDevLogRouter2, "createDevLogRouter");
@@ -29555,7 +29658,15 @@ async function registerMiddlewares(server, middlewares, options) {
     rootDir: process.cwd(),
     ...options
   };
-  for (const middleware of middlewares) {
+  const defaultMiddlewares = [];
+  if (context.isDev) {
+    defaultMiddlewares.push(createHealthCheckMiddleware());
+  }
+  const allMiddlewares = [
+    ...defaultMiddlewares,
+    ...middlewares
+  ];
+  for (const middleware of allMiddlewares) {
     if (middleware.enabled && !middleware.enabled(context)) {
       continue;
     }
@@ -29581,6 +29692,7 @@ __name(registerMiddlewares, "registerMiddlewares");
 export {
   createCollectLogsMiddleware,
   createDevLogsMiddleware,
+  createHealthCheckMiddleware,
   createOpenapiMiddleware,
   handleDevProxyError,
   normalizeBasePath,