imean-service-engine 1.6.0 → 1.7.1

package/dist/mod.js

@@ -6,6 +6,7 @@ import { serve } from '@hono/node-server';
 import { Etcd3 } from 'etcd3';
 import fs from 'fs-extra';
 import { Hono } from 'hono';
+import { timing } from 'hono/timing';
 import { trace, SpanStatusCode } from '@opentelemetry/api';
 import winston, { format } from 'winston';
 import prettier from 'prettier';
@@ -17,6 +18,8 @@ import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
 import { JSONRPCMessageSchema } from '@modelcontextprotocol/sdk/types.js';
 import { streamSSE } from 'hono/streaming';
 import { ulid } from 'ulid';
+import { html } from 'hono/html';
+import { jsx, jsxs } from 'hono/jsx/jsx-runtime';
 export { default as dayjs } from 'dayjs';
 
 // mod.ts
@@ -586,6 +589,62 @@ var ActionHandler = class {
 function isAsyncIterable(obj) {
   return obj != null && typeof obj[Symbol.asyncIterator] === "function";
 }
+
+// decorators/page.ts
+var PAGE_METADATA = Symbol("page:metadata");
+function Page(options) {
+  return function(_target, context) {
+    const methodName = context.name;
+    context.addInitializer(function() {
+      const prototype = this.constructor.prototype;
+      const existingMetadata = prototype[PAGE_METADATA] || {};
+      existingMetadata[methodName] = {
+        name: methodName,
+        description: options.description || "",
+        method: options.method,
+        path: options.path
+      };
+      prototype[PAGE_METADATA] = existingMetadata;
+    });
+  };
+}
+function getPageMetadata(target) {
+  return target.constructor.prototype[PAGE_METADATA] ?? {};
+}
+var tracer3 = trace.getTracer("page-handler");
+var PageHandler = class {
+  constructor(moduleInstance, options, moduleName) {
+    this.moduleInstance = moduleInstance;
+    this.options = options;
+    this.moduleName = moduleName;
+  }
+  async handle(ctx) {
+    return await tracer3.startActiveSpan(
+      `handle ${this.moduleName}.${this.options.name}`,
+      async (span) => {
+        span.setAttribute("module", this.moduleName);
+        span.setAttribute("page", this.options.name);
+        span.setAttribute("path", this.options.path);
+        try {
+          const result = await this.moduleInstance[this.options.name].apply(
+            this.moduleInstance,
+            [ctx]
+          );
+          return ctx.html(result);
+        } catch (error) {
+          span.recordException(error);
+          span.setStatus({
+            code: SpanStatusCode.ERROR,
+            message: error.message
+          });
+          throw error;
+        } finally {
+          span.end();
+        }
+      }
+    );
+  }
+};
 var WebSocketHandler = class {
   constructor(microservice, options) {
     this.microservice = microservice;
@@ -773,6 +832,7 @@ var Microservice = class {
   statisticsTimer;
   wsHandler;
   actionHandlers = /* @__PURE__ */ new Map();
+  pageHandlers = /* @__PURE__ */ new Map();
   activeRequests = /* @__PURE__ */ new Map();
   status = "running";
   modules = /* @__PURE__ */ new Map();
@@ -782,6 +842,7 @@ var Microservice = class {
   serviceId;
   constructor(options) {
     this.app = new Hono();
+    this.app.use(timing());
     this.nodeWebSocket = createNodeWebSocket({ app: this.app });
     this.serviceId = crypto.randomUUID();
     this.options = {
@@ -820,6 +881,11 @@ var Microservice = class {
     }
     await this.registerService(true);
     await this.initPlugins();
+    this.app.get(this.options.prefix, (ctx) => {
+      const name = this.options.name ?? "Microservice";
+      const version = this.options.version ?? "1.0.0";
+      return ctx.text(`${name} is ${this.status}. version: ${version}`);
+    });
   }
   async initModules() {
     for (const ModuleClass of this.options.modules) {
@@ -834,6 +900,7 @@ var Microservice = class {
       logger_default.info(`[ \u6CE8\u518C\u6A21\u5757 ] ${moduleName} ${metadata.options.description}`);
       this.modules.set(moduleName, moduleInstance);
       const actions = getActionMetadata(ModuleClass.prototype);
+      const pages = getPageMetadata(ModuleClass.prototype);
       for (const [actionName, actionMetadata] of Object.entries(actions)) {
         const handler = new ActionHandler(
           moduleInstance,
@@ -847,6 +914,18 @@ var Microservice = class {
           `[ \u6CE8\u518C\u52A8\u4F5C ] ${moduleName}.${actionName} ${actionMetadata.description} ${actionMetadata.mcp ? "MCP:" + actionMetadata.mcp?.type : ""}`
         );
       }
+      for (const [_, page] of Object.entries(pages)) {
+        const handler = new PageHandler(
+          moduleInstance,
+          page,
+          moduleName
+        );
+        this.pageHandlers.set(`${moduleName}.${page.name}`, handler);
+        this.app[page.method](`${this.options.prefix}${page.path}`, (ctx) => handler.handle(ctx));
+        logger_default.info(
+          `[ \u6CE8\u518C\u9875\u9762 ] ${moduleName}.${page.name} ${page.method.toUpperCase()} ${page.path} ${page.description}`
+        );
+      }
       const schedules = getScheduleMetadata(ModuleClass.prototype);
       if (schedules && Object.keys(schedules).length > 0) {
         if (!this.scheduler && this.etcdClient) {
@@ -876,11 +955,6 @@ var Microservice = class {
   initRoutes() {
     const startTime = Date.now();
     const prefix = this.options.prefix || "/api";
-    this.app.get(prefix, (ctx) => {
-      const name = this.options.name ?? "Microservice";
-      const version = this.options.version ?? "1.0.0";
-      return ctx.text(`${name} is ${this.status}. version: ${version}`);
-    });
     this.app.get(`${prefix}/health`, (ctx) => {
       return ctx.json({
         status: "ok",
@@ -1323,28 +1397,6 @@ Received SIGTERM signal`);
     await this.waitingInitialization;
   }
 };
-
-// utils/checker.ts
-async function startCheck(checkers, pass) {
-  logger_default.info("[ \u9884\u68C0\u5F00\u59CB ]");
-  for (const [index, checker] of checkers.entries()) {
-    const seq = index + 1;
-    logger_default.info(`${seq}. ${checker.name}`);
-    try {
-      if (checker.skip) {
-        logger_default.warn(`${seq}. ${checker.name} [\u8DF3\u8FC7]`);
-        continue;
-      }
-      await checker.check();
-      logger_default.info(`${seq}. ${checker.name} [\u6210\u529F]`);
-    } catch (error) {
-      logger_default.error(`${seq}. ${checker.name} [\u5931\u8D25]`);
-      throw error;
-    }
-  }
-  logger_default.info("[ \u9884\u68C0\u5B8C\u6210 ]");
-  if (pass) await pass();
-}
 var HonoTransport = class {
   constructor(url, stream, closeStream) {
     this.url = url;
@@ -1460,5 +1512,204 @@ var ModelContextProtocolPlugin = class extends Plugin {
     );
   };
 };
+var DEFAULT_FAVICON = /* @__PURE__ */ jsx(
+  "link",
+  {
+    rel: "icon",
+    href: "data:image/svg+xml;utf8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 100 100' width='100' height='100'><defs><linearGradient id='nodeGradient' x1='0%' y1='0%' x2='100%' y2='100%'><stop offset='0%' stop-color='%233498db'/><stop offset='100%' stop-color='%232980b9'/></linearGradient><linearGradient id='centerNodeGradient' x1='0%' y1='0%' x2='100%' y2='100%'><stop offset='0%' stop-color='%232ecc71'/><stop offset='100%' stop-color='%2327ae60'/></linearGradient></defs><circle cx='50' cy='50' r='45' fill='%23f5f7fa'/><path d='M30,30 L50,50' stroke='%23bdc3c7' stroke-width='2' stroke-linecap='round'/><path d='M70,30 L50,50' stroke='%23bdc3c7' stroke-width='2' stroke-linecap='round'/><path d='M30,70 L50,50' stroke='%23bdc3c7' stroke-width='2' stroke-linecap='round'/><path d='M70,70 L50,50' stroke='%23bdc3c7' stroke-width='2' stroke-linecap='round'/><polygon points='30,15 45,25 45,45 30,55 15,45 15,25' fill='url(%23nodeGradient)' stroke='%232980b9' stroke-width='1.5'/><polygon points='70,15 85,25 85,45 70,55 55,45 55,25' fill='url(%23nodeGradient)' stroke='%232980b9' stroke-width='1.5'/><polygon points='30,45 45,55 45,75 30,85 15,75 15,55' fill='url(%23nodeGradient)' stroke='%232980b9' stroke-width='1.5'/><polygon points='70,45 85,55 85,75 70,85 55,75 55,55' fill='url(%23nodeGradient)' stroke='%232980b9' stroke-width='1.5'/><polygon points='50,30 65,40 65,60 50,70 35,60 35,40' fill='url(%23centerNodeGradient)' stroke='%2327ae60' stroke-width='2'/><circle cx='30' cy='30' r='3' fill='%23ffffff'/><circle cx='70' cy='30' r='3' fill='%23ffffff'/><circle cx='30' cy='70' r='3' fill='%23ffffff'/><circle cx='70' cy='70' r='3' fill='%23ffffff'/><circle cx='50' cy='50' r='4' fill='%23ffffff'/></svg>",
+    type: "image/svg+xml"
+  }
+);
+var BaseLayout = (props = {
+  title: "Microservice Template"
+}) => html`<!DOCTYPE html>
+    <html>
+      <head>
+        <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+        <title>${props.title}</title>
+        ${props.heads}
+      </head>
+      <body>
+        ${props.children}
+      </body>
+    </html>`;
+var HtmxLayout = (props = {
+  title: "Microservice Template"
+}) => BaseLayout({
+  title: props.title,
+  heads: html`
+      <script src="https://unpkg.com/htmx.org@latest"></script>
+      <script src="https://unpkg.com/hyperscript.org@latest"></script>
+      <script src="https://cdn.tailwindcss.com"></script>
+      ${props.favicon || DEFAULT_FAVICON}
+    `,
+  children: props.children
+});
+var InfoCard = ({
+  icon,
+  iconColor,
+  bgColor,
+  label,
+  value
+}) => /* @__PURE__ */ jsxs("div", { className: `${bgColor} p-4 rounded-lg`, children: [
+  /* @__PURE__ */ jsxs("div", { className: "flex items-center mb-2", children: [
+    /* @__PURE__ */ jsx(
+      "svg",
+      {
+        className: `w-5 h-5 ${iconColor} mr-2`,
+        fill: "none",
+        stroke: "currentColor",
+        viewBox: "0 0 24 24",
+        children: /* @__PURE__ */ jsx(
+          "path",
+          {
+            strokeLinecap: "round",
+            strokeLinejoin: "round",
+            strokeWidth: 2,
+            d: icon
+          }
+        )
+      }
+    ),
+    /* @__PURE__ */ jsx("span", { className: "text-sm font-medium text-gray-600", children: label })
+  ] }),
+  /* @__PURE__ */ jsx("p", { className: `text-xl font-semibold text-gray-900`, children: value })
+] });
+var getEnvironmentBadgeClass = (env) => {
+  switch (env) {
+    case "prod":
+      return "bg-red-100 text-red-800";
+    case "stg":
+      return "bg-yellow-100 text-yellow-800";
+    case "dev":
+    default:
+      return "bg-blue-100 text-blue-800";
+  }
+};
+var ServiceInfoCards = ({
+  serviceInfo
+}) => {
+  const infoCards = [
+    {
+      icon: "M7 4V2a1 1 0 011-1h8a1 1 0 011 1v2m-9 0h10m-10 0a2 2 0 00-2 2v14a2 2 0 002 2h10a2 2 0 002-2V6a2 2 0 00-2-2",
+      iconColor: "text-blue-600",
+      bgColor: "bg-blue-50",
+      label: "\u670D\u52A1\u540D\u79F0",
+      value: serviceInfo.name
+    },
+    {
+      icon: "M13.828 10.172a4 4 0 00-5.656 0l-4 4a4 4 0 105.656 5.656l1.102-1.101m-.758-4.899a4 4 0 005.656 0l4-4a4 4 0 00-5.656-5.656l-1.1 1.1",
+      iconColor: "text-orange-600",
+      bgColor: "bg-orange-50",
+      label: "\u670D\u52A1\u8DEF\u5F84",
+      value: serviceInfo.prefix || "/",
+      isMonospace: true
+    },
+    {
+      icon: "M9 12l2 2 4-4m6 2a9 9 0 11-18 0 9 9 0 0118 0z",
+      iconColor: "text-green-600",
+      bgColor: "bg-green-50",
+      label: "\u8FD0\u884C\u73AF\u5883",
+      value: /* @__PURE__ */ jsx(
+        "span",
+        {
+          className: `px-2 py-1 rounded-full text-sm ${getEnvironmentBadgeClass(serviceInfo.env ?? "dev")}`,
+          children: serviceInfo.env ?? "dev"
+        }
+      )
+    },
+    {
+      icon: "M7 7h.01M7 3h5c.512 0 1.024.195 1.414.586l7 7a2 2 0 010 2.828l-7 7a2 2 0 01-2.828 0l-7-7A1.994 1.994 0 013 12V7a4 4 0 014-4z",
+      iconColor: "text-purple-600",
+      bgColor: "bg-purple-50",
+      label: "\u7248\u672C\u53F7",
+      value: serviceInfo.version || "unknown"
+    }
+  ];
+  return /* @__PURE__ */ jsxs("div", { className: "bg-white rounded-lg shadow-md p-6 mb-8", children: [
+    /* @__PURE__ */ jsxs("h2", { className: "text-2xl font-semibold text-gray-800 mb-6 flex items-center", children: [
+      /* @__PURE__ */ jsx(
+        "svg",
+        {
+          className: "w-6 h-6 mr-2 text-blue-600",
+          fill: "none",
+          stroke: "currentColor",
+          viewBox: "0 0 24 24",
+          children: /* @__PURE__ */ jsx(
+            "path",
+            {
+              strokeLinecap: "round",
+              strokeLinejoin: "round",
+              strokeWidth: 2,
+              d: "M13 10V3L4 14h7v7l9-11h-7z"
+            }
+          )
+        }
+      ),
+      "\u670D\u52A1\u57FA\u672C\u4FE1\u606F"
+    ] }),
+    /* @__PURE__ */ jsx("div", { className: "grid grid-cols-1 md:grid-cols-2 lg:grid-cols-2 gap-6", children: infoCards.map((card, index) => /* @__PURE__ */ jsx(InfoCard, { ...card }, index)) })
+  ] });
+};
+var ServiceStatusPage = ({
+  serviceInfo
+}) => {
+  return /* @__PURE__ */ jsx("div", { className: "min-h-screen bg-gray-50 py-8", children: /* @__PURE__ */ jsxs("div", { className: "max-w-6xl mx-auto px-4", children: [
+    /* @__PURE__ */ jsx("div", { className: "mb-8", children: /* @__PURE__ */ jsx("h1", { className: "text-4xl font-bold text-gray-900 mb-2", children: "Service Status" }) }),
+    /* @__PURE__ */ jsx(ServiceInfoCards, { serviceInfo })
+  ] }) });
+};
+var ServiceStatusPage_default = ServiceStatusPage;
+
+// core/plugins/page/mod.ts
+var PageRenderPlugin = class extends Plugin {
+  constructor(options = {}) {
+    super();
+    this.options = options;
+  }
+  initialize = async (engine) => {
+    const app = engine.getApp();
+    if (this.options.useDefaultStatusPage) {
+      app.get(`${engine.options.prefix}`, async (ctx) => {
+        return ctx.html(HtmxLayout({
+          title: engine.options.name,
+          children: ServiceStatusPage_default({
+            serviceInfo: {
+              name: engine.options.name,
+              prefix: engine.options.prefix,
+              version: engine.options.version,
+              env: engine.options.env,
+              id: engine.serviceId,
+              modules: engine.getModules(false)
+            }
+          })
+        }));
+      });
+    }
+    logger_default.info(`PageRenderPlugin enabled`);
+  };
+};
+
+// utils/checker.ts
+async function startCheck(checkers, pass) {
+  logger_default.info("[ \u9884\u68C0\u5F00\u59CB ]");
+  for (const [index, checker] of checkers.entries()) {
+    const seq = index + 1;
+    logger_default.info(`${seq}. ${checker.name}`);
+    try {
+      if (checker.skip) {
+        logger_default.warn(`${seq}. ${checker.name} [\u8DF3\u8FC7]`);
+        continue;
+      }
+      await checker.check();
+      logger_default.info(`${seq}. ${checker.name} [\u6210\u529F]`);
+    } catch (error) {
+      logger_default.error(`${seq}. ${checker.name} [\u5931\u8D25]`);
+      throw error;
+    }
+  }
+  logger_default.info("[ \u9884\u68C0\u5B8C\u6210 ]");
+  if (pass) await pass();
+}
 
-export { Action, CacheAdapter, MemoryCacheAdapter, Microservice, ModelContextProtocolPlugin, Module, Plugin, RedisCacheAdapter, Schedule, ScheduleMode, ServiceContext, logger_default as logger, startCheck };
+export { Action, BaseLayout, CacheAdapter, HtmxLayout, MemoryCacheAdapter, Microservice, ModelContextProtocolPlugin, Module, Page, PageRenderPlugin, Plugin, RedisCacheAdapter, Schedule, ScheduleMode, ServiceContext, ServiceInfoCards, ServiceStatusPage, logger_default as logger, startCheck };

package/package.json

@@ -1,87 +1,86 @@
-{
-  "name": "imean-service-engine",
-  "version": "1.6.0",
-  "description": "microservice engine",
-  "keywords": [
-    "microservice",
-    "websocket",
-    "http",
-    "node"
-  ],
-  "author": "imean",
-  "type": "module",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "git+https://git.imean.tech/imean/imean-microservice-framework.git"
-  },
-  "main": "dist/mod.js",
-  "module": "dist/mod.js",
-  "types": "dist/mod.d.ts",
-  "exports": {
-    ".": {
-      "types": "./dist/mod.d.ts",
-      "import": "./dist/mod.js",
-      "require": "./dist/mod.cjs"
-    }
-  },
-  "files": [
-    "dist",
-    "README.md",
-    "LICENSE"
-  ],
-  "scripts": {
-    "dev": "tsx watch dev/index.ts",
-    "build": "tsup",
-    "test": "vitest run",
-    "prepublishOnly": "npm run build && npm run test"
-  },
-  "dependencies": {
-    "@hono/node-server": "^1.13.7",
-    "@hono/node-ws": "^1.0.6",
-    "@modelcontextprotocol/sdk": "^1.8.0",
-    "dayjs": "^1.11.13",
-    "ejson": "^2.2.3",
-    "etcd3": "^1.1.2",
-    "fs-extra": "^11.3.0",
-    "hono": "^4.6.17",
-    "lru-cache": "^11.0.2",
-    "prettier": "^3.4.2",
-    "ulid": "^3.0.0",
-    "winston": "^3.17.0",
-    "zod": "^3.24.1"
-  },
-  "peerDependencies": {
-    "@opentelemetry/api": "^1.x",
-    "ioredis": "^5.6.0"
-  },
-  "devDependencies": {
-    "@opentelemetry/auto-instrumentations-node": "^0.55.3",
-    "@opentelemetry/exporter-logs-otlp-proto": "^0.57.1",
-    "@opentelemetry/exporter-metrics-otlp-proto": "^0.57.1",
-    "@opentelemetry/exporter-trace-otlp-proto": "^0.57.1",
-    "@opentelemetry/instrumentation-winston": "^0.44.0",
-    "@opentelemetry/sdk-logs": "^0.57.1",
-    "@opentelemetry/sdk-metrics": "^1.30.1",
-    "@opentelemetry/sdk-node": "^0.57.1",
-    "@opentelemetry/sdk-trace-node": "^1.30.1",
-    "@opentelemetry/winston-transport": "^0.10.0",
-    "@types/ejson": "^2.2.2",
-    "@types/fs-extra": "^11.0.4",
-    "@types/ioredis-mock": "^8.2.5",
-    "@types/node": "^20.0.0",
-    "@vitest/coverage-v8": "^3.0.4",
-    "imean-service-client": "^1.5.0",
-    "ioredis-mock": "^8.9.0",
-    "opentelemetry-instrumentation-fetch-node": "^1.2.3",
-    "tslib": "^2.8.1",
-    "tsup": "^8.0.1",
-    "tsx": "^4.19.2",
-    "typescript": "^5.3.3",
-    "vite-tsconfig-paths": "^5.1.4",
-    "vitest": "^3.0.3"
-  },
-  "engines": {
-    "node": ">=20"
-  }
-}
+{
+  "name": "imean-service-engine",
+  "version": "1.7.1",
+  "description": "microservice engine",
+  "keywords": [
+    "microservice",
+    "websocket",
+    "http",
+    "node"
+  ],
+  "author": "imean",
+  "type": "module",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://git.imean.tech/imean/imean-microservice-framework.git"
+  },
+  "main": "dist/mod.js",
+  "module": "dist/mod.js",
+  "types": "dist/mod.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/mod.d.ts",
+      "import": "./dist/mod.js",
+      "require": "./dist/mod.cjs"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "dependencies": {
+    "@hono/node-server": "^1.13.7",
+    "@hono/node-ws": "^1.0.6",
+    "@modelcontextprotocol/sdk": "^1.8.0",
+    "dayjs": "^1.11.13",
+    "ejson": "^2.2.3",
+    "etcd3": "^1.1.2",
+    "fs-extra": "^11.3.0",
+    "hono": "^4.6.17",
+    "lru-cache": "^11.0.2",
+    "prettier": "^3.4.2",
+    "ulid": "^3.0.0",
+    "winston": "^3.17.0",
+    "zod": "^3.24.1"
+  },
+  "peerDependencies": {
+    "@opentelemetry/api": "^1.x",
+    "ioredis": "^5.6.0"
+  },
+  "devDependencies": {
+    "@opentelemetry/auto-instrumentations-node": "^0.55.3",
+    "@opentelemetry/exporter-logs-otlp-proto": "^0.57.1",
+    "@opentelemetry/exporter-metrics-otlp-proto": "^0.57.1",
+    "@opentelemetry/exporter-trace-otlp-proto": "^0.57.1",
+    "@opentelemetry/instrumentation-winston": "^0.44.0",
+    "@opentelemetry/sdk-logs": "^0.57.1",
+    "@opentelemetry/sdk-metrics": "^1.30.1",
+    "@opentelemetry/sdk-node": "^0.57.1",
+    "@opentelemetry/sdk-trace-node": "^1.30.1",
+    "@opentelemetry/winston-transport": "^0.10.0",
+    "@types/ejson": "^2.2.2",
+    "@types/fs-extra": "^11.0.4",
+    "@types/ioredis-mock": "^8.2.5",
+    "@types/node": "^20.0.0",
+    "@vitest/coverage-v8": "^3.0.4",
+    "imean-service-client": "^1.5.0",
+    "ioredis-mock": "^8.9.0",
+    "opentelemetry-instrumentation-fetch-node": "^1.2.3",
+    "tslib": "^2.8.1",
+    "tsup": "^8.0.1",
+    "tsx": "^4.19.2",
+    "typescript": "^5.3.3",
+    "vite-tsconfig-paths": "^5.1.4",
+    "vitest": "^3.0.3"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "scripts": {
+    "dev": "tsx watch dev/index.ts",
+    "build": "tsup",
+    "test": "vitest run"
+  }
+}