@lark-apaas/devtool-kits 1.0.5-alpha.3 → 1.0.5-alpha.5

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 http2 = __require("http");
+    var http3 = __require("http");
     module.exports = getCurrentNodeMethods() || getBasicNodeMethods();
     function getCurrentNodeMethods() {
-      return http2.METHODS && http2.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 http2 = __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 = http2.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 http2 = __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(http2.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 http2 = __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(http2.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;
@@ -28392,8 +28392,6 @@ __name(collapseExtraBlankLines, "collapseExtraBlankLines");
 // src/helpers/proxy-error/index.ts
 import fs2 from "fs";
 import path2 from "path";
-import { createReadStream } from "fs";
-import { createInterface } from "readline";
 import http from "http";
 import https from "https";
 var errorHtmlTemplate = null;
@@ -28469,63 +28467,82 @@ function parseLogLine(line) {
   if (!trimmed) return null;
   const match = trimmed.match(/^\[\d{4}-\d{2}-\d{2}\s+\d{2}:\d{2}:\d{2}\]\s+\[server\]\s+(.*)$/);
   if (match) {
-    return match[1];
+    const content = match[1].trim();
+    return content || null;
   }
-  return trimmed;
+  return null;
 }
 __name(parseLogLine, "parseLogLine");
 async function readRecentErrorLogs(logDir, maxLogs, fileName) {
   const logFilePath = path2.join(logDir, fileName);
+  let fileStats;
   try {
-    await fs2.promises.access(logFilePath);
+    fileStats = await fs2.promises.stat(logFilePath);
   } catch {
     return {
       logs: [],
       hasCompileError: false
     };
   }
-  const allLines = [];
-  const stream = createReadStream(logFilePath, {
-    encoding: "utf8"
-  });
-  const rl = createInterface({
-    input: stream,
-    crlfDelay: Infinity
-  });
+  const fileSize = fileStats.size;
+  const maxReadSize = 1024 * 1024;
+  const readSize = Math.min(fileSize, maxReadSize);
+  const startPosition = Math.max(0, fileSize - readSize);
+  const buffer = Buffer.allocUnsafe(readSize);
+  let fileHandle;
   try {
-    for await (const line of rl) {
-      const parsed = parseLogLine(line);
-      if (parsed !== null) {
-        allLines.push(parsed);
-      }
-    }
+    fileHandle = await fs2.promises.open(logFilePath, "r");
+    await fileHandle.read(buffer, 0, readSize, startPosition);
+  } catch (error) {
+    console.error("[Proxy Error]: Failed to read log file:", error);
+    return {
+      logs: [],
+      hasCompileError: false
+    };
   } finally {
-    rl.close();
-    stream.destroy();
+    if (fileHandle) {
+      await fileHandle.close();
+    }
+  }
+  const content = buffer.toString("utf8");
+  const lines = content.split("\n");
+  if (startPosition > 0 && lines.length > 0) {
+    lines.shift();
+  }
+  const allLines = [];
+  for (const line of lines) {
+    const parsed = parseLogLine(line);
+    if (parsed !== null) {
+      allLines.push(parsed);
+    }
   }
   let startIndex = -1;
   for (let i = allLines.length - 1; i >= 0; i--) {
-    if (allLines[i].includes("dev:server")) {
+    const line = allLines[i];
+    if (line.includes("Starting compilation in watch mode") || line.includes("File change detected. Starting incremental compilation")) {
       startIndex = i;
       break;
     }
   }
   if (startIndex === -1) {
+    console.log("[Proxy Error]: No compilation start marker found, returning last logs");
+    const fallbackLogs = allLines.slice(-maxLogs);
+    const hasCompileError2 = checkForErrors(fallbackLogs);
     return {
-      logs: [],
-      hasCompileError: false
+      logs: fallbackLogs,
+      hasCompileError: hasCompileError2
     };
   }
   let endIndex = allLines.length;
-  let hasCompileError = false;
-  for (let i = startIndex; i < allLines.length; i++) {
-    if (/Found \d+ errors?\./.test(allLines[i])) {
-      endIndex = i + 1;
-      hasCompileError = true;
+  for (let i = startIndex + 1; i < allLines.length; i++) {
+    const line = allLines[i];
+    if (line.includes("Starting compilation in watch mode") || line.includes("File change detected. Starting incremental compilation")) {
+      endIndex = i;
       break;
     }
   }
   const errorSection = allLines.slice(startIndex, endIndex);
+  const hasCompileError = checkForErrors(errorSection);
   const logs = errorSection.length > maxLogs ? errorSection.slice(-maxLogs) : errorSection;
   return {
     logs,
@@ -28533,7 +28550,21 @@ async function readRecentErrorLogs(logDir, maxLogs, fileName) {
   };
 }
 __name(readRecentErrorLogs, "readRecentErrorLogs");
-function injectErrorData(template, errorLogs) {
+function checkForErrors(logs) {
+  for (const line of logs) {
+    const compileErrorMatch = line.match(/Found (\d+) errors?\. Watching for file changes/);
+    if (compileErrorMatch) {
+      const errorCount = parseInt(compileErrorMatch[1], 10);
+      if (errorCount > 0) {
+        console.log(`[Proxy Error]: Found ${errorCount} compilation error(s)`);
+        return true;
+      }
+    }
+  }
+  return false;
+}
+__name(checkForErrors, "checkForErrors");
+function injectErrorData(template, errorLogs, clientBasePath) {
   let logsText = "";
   if (errorLogs.length > 0) {
     logsText = errorLogs.join("\n");
@@ -28541,11 +28572,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");
@@ -28578,7 +28610,7 @@ function handleDevProxyError(err, req, res, options) {
         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",
@@ -28612,8 +28644,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";
@@ -28860,7 +28983,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;
@@ -28894,7 +29017,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";
@@ -29032,18 +29155,18 @@ __name(serializeError, "serializeError");
 import { join as join2 } from "path";
 
 // src/middlewares/dev-logs/services.ts
-import { createReadStream as createReadStream2, promises as fs7 } from "fs";
-import { createInterface as createInterface2 } from "readline";
+import { createReadStream, promises as fs7 } from "fs";
+import { createInterface } from "readline";
 async function readLogEntriesByTrace(filePath, traceId, limit) {
   const exists = await fileExists(filePath);
   if (!exists) {
     return void 0;
   }
   const matches = [];
-  const stream = createReadStream2(filePath, {
+  const stream = createReadStream(filePath, {
     encoding: "utf8"
   });
-  const rl = createInterface2({
+  const rl = createInterface({
     input: stream,
     crlfDelay: Infinity
   });
@@ -29194,10 +29317,10 @@ async function readLogFilePage(filePath, page, pageSize) {
   const capacity = page * pageSize;
   const buffer = [];
   let totalLines = 0;
-  const stream = createReadStream2(filePath, {
+  const stream = createReadStream(filePath, {
     encoding: "utf8"
   });
-  const rl = createInterface2({
+  const rl = createInterface({
     input: stream,
     crlfDelay: Infinity
   });
@@ -29339,7 +29462,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));
@@ -29382,7 +29505,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";
@@ -29481,9 +29604,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");
@@ -29566,7 +29689,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;
     }
@@ -29592,6 +29723,7 @@ __name(registerMiddlewares, "registerMiddlewares");
 export {
   createCollectLogsMiddleware,
   createDevLogsMiddleware,
+  createHealthCheckMiddleware,
   createOpenapiMiddleware,
   handleDevProxyError,
   normalizeBasePath,