@modern-js/prod-server 2.28.0 → 2.29.0

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @modern-js/prod-server
 
+## 2.29.0
+
+### Minor Changes
+
+- 16e5195: feat(prod-server): add body parser
+  feat(prod-server): 增加 body 解析器
+- cba7675: feat: add a server reporter that report server cost, logger about error, info etc.
+  feat: 添加一个 server 端 reporter，来报告 server 端耗时，报错等
+
+### Patch Changes
+
+- 76ace5d: fix(prod-server): bff may run bodyParser by themself, so we need't to run
+  fix(prod-server): bff 可能会在内部运行, 所以我们不需要运行
+- Updated dependencies [e6b5355]
+- Updated dependencies [93db783]
+- Updated dependencies [cba7675]
+- Updated dependencies [99052ea]
+- Updated dependencies [1d71d2e]
+  - @modern-js/utils@2.29.0
+  - @modern-js/server-core@2.29.0
+  - @modern-js/plugin@2.29.0
+
 ## 2.28.0
 
 ### Minor Changes

package/dist/cjs/libs/context/context.js

@@ -15,7 +15,10 @@ const _querystring = /* @__PURE__ */ _interop_require_default._(require("queryst
 const _buffer = require("buffer");
 const _etag = /* @__PURE__ */ _interop_require_default._(require("etag"));
 const _fresh = /* @__PURE__ */ _interop_require_default._(require("fresh"));
-const _utils = require("../../utils");
+const _utils = require("@modern-js/utils");
+const _serverTiming = require("../serverTiming");
+const _reporter = require("../reporter");
+const _utils1 = require("../../utils");
 const MOCK_URL_BASE = "https://modernjs.dev/";
 class ModernServerContext {
   get logger() {
@@ -157,18 +160,21 @@ class ModernServerContext {
     return this.res.writableEnded;
   }
   error(dig, e = "") {
-    this.logger.error(`Web Server Error - ${dig}, error = %s, req.url = %s, req.headers = %o`, e instanceof Error ? e.stack || e.message : e, this.path, (0, _utils.headersWithoutCookie)(this.headers));
+    this.logger.error(`Web Server Error - ${dig}, error = %s, req.url = %s, req.headers = %o`, e instanceof Error ? e.stack || e.message : e, this.path, (0, _utils1.headersWithoutCookie)(this.headers));
   }
   constructor(req, res, options) {
+    var _options;
     _define_property._(this, "req", void 0);
     _define_property._(this, "res", void 0);
     _define_property._(this, "params", {});
-    _define_property._(this, "serverData", void 0);
+    _define_property._(this, "reporter", _reporter.defaultReporter);
+    _define_property._(this, "serverTiming", void 0);
+    _define_property._(this, "serverData", {});
     _define_property._(this, "options", {});
     this.req = req;
     this.res = res;
     this.options = options || {};
-    this.serverData = {};
+    this.serverTiming = new _serverTiming.ServerTiming(res, (0, _utils.cutNameByHyphen)(((_options = options) === null || _options === void 0 ? void 0 : _options.metaName) || "modern-js"));
     this.bind();
   }
 }

package/dist/cjs/libs/hook-api/index.js

@@ -27,10 +27,11 @@ const _route = require("./route");
 const _template = require("./template");
 const _base = require("./base");
 const base = (context) => {
-  const { res } = context;
+  const { res, reporter } = context;
   return {
     response: new _base.BaseResponse(res),
     request: new _base.BaseRequest(context),
+    reporter,
     logger: context.logger,
     metrics: context.metrics
   };

package/dist/cjs/libs/hook-api/index.worker.js

@@ -56,7 +56,7 @@ class ServerResponse {
   }
 }
 const base = (context) => {
-  const { req, res, logger, metrics } = context;
+  const { req, res, logger, metrics, reporter } = context;
   const serverResponse = new ServerResponse(res);
   const { host, pathname, searchParams } = new URL(req.url);
   const headers = {};
@@ -65,6 +65,7 @@ const base = (context) => {
   });
   return {
     response: new _base.BaseResponse(serverResponse),
+    reporter,
     request: new _base.BaseRequest({
       url: req.url,
       host,

package/dist/cjs/libs/render/ssr.js

@@ -22,7 +22,6 @@ const render = async (ctx, renderOptions, runner) => {
   const loadableStats = _utils.fs.existsSync(loadableUri) ? require(loadableUri) : "";
   const routesManifestUri = _path.default.join(distDir, _utils.ROUTE_MANIFEST_FILE);
   const routeManifest = _utils.fs.existsSync(routesManifestUri) ? require(routesManifestUri) : void 0;
-  const body = await getRequestBody(ctx.req);
   const context = {
     request: {
       baseUrl: urlPath,
@@ -32,7 +31,7 @@ const render = async (ctx, renderOptions, runner) => {
       query: ctx.query,
       url: ctx.href,
       headers: ctx.headers,
-      body
+      body: ctx.req.body
     },
     response: {
       setHeader: (key, value) => {
@@ -51,6 +50,8 @@ const render = async (ctx, renderOptions, runner) => {
     staticGenerate,
     logger: void 0,
     metrics: void 0,
+    reporter: ctx.reporter,
+    serverTiming: ctx.serverTiming,
     req: ctx.req,
     res: ctx.res,
     enableUnsafeCtx,
@@ -84,20 +85,3 @@ const render = async (ctx, renderOptions, runner) => {
     };
   }
 };
-const getRequestBody = (req) => new Promise((resolve, reject) => {
-  var _req;
-  if (((_req = req) === null || _req === void 0 ? void 0 : _req.method) && req.method.toLowerCase() !== "get") {
-    let body = "";
-    req.on("data", (chunk) => {
-      body += chunk.toString();
-    });
-    req.on("end", () => {
-      resolve(body);
-    });
-    req.on("error", (err) => {
-      reject(err);
-    });
-  } else {
-    resolve(void 0);
-  }
-});

package/dist/cjs/libs/reporter.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "defaultReporter", {
+  enumerable: true,
+  get: function() {
+    return defaultReporter;
+  }
+});
+const defaultReporter = {
+  init() {
+  },
+  reportError() {
+  },
+  reportTiming() {
+  },
+  reportInfo() {
+  },
+  reportWarn() {
+  }
+};

package/dist/cjs/libs/serverTiming.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "ServerTiming", {
+  enumerable: true,
+  get: function() {
+    return ServerTiming;
+  }
+});
+const _define_property = require("@swc/helpers/_/_define_property");
+const SERVER_TIMING = "Server-Timing";
+class ServerTiming {
+  addServeTiming(name, dur, desc) {
+    const _name = `bd-${this.meta}-${name}`;
+    const serverTiming = this.res.getHeader(SERVER_TIMING) || this.res.getHeader(SERVER_TIMING.toLocaleLowerCase());
+    const value = `${_name};${desc ? `decs="${desc}";` : ""} dur=${dur}`;
+    this.res.setHeader(SERVER_TIMING, serverTiming ? `${serverTiming}, ${value}` : value);
+    return this;
+  }
+  constructor(res, meta) {
+    _define_property._(this, "meta", void 0);
+    _define_property._(this, "res", void 0);
+    this.meta = meta;
+    this.res = res;
+  }
+}

package/dist/cjs/server/modernServer.js

@@ -14,6 +14,7 @@ const _interop_require_wildcard = require("@swc/helpers/_/_interop_require_wildc
 const _http = require("http");
 const _path = /* @__PURE__ */ _interop_require_default._(require("path"));
 const _utils = require("@modern-js/utils");
+const _time = require("@modern-js/utils/universal/time");
 const _route = require("../libs/route");
 const _render = require("../libs/render");
 const _serveFile = require("../libs/serveFile");
@@ -76,7 +77,9 @@ class ModernServer {
   async render(req, res, url) {
     req.logger = req.logger || this.logger;
     req.metrics = req.metrics || this.metrics;
-    const context = (0, _context.createContext)(req, res);
+    const context = (0, _context.createContext)(req, res, {
+      metaName: this.metaName
+    });
     const matched = this.router.match(url || context.path);
     if (!matched) {
       return null;
@@ -277,23 +280,35 @@ class ModernServer {
   /* —————————————————————— private function —————————————————————— */
   // handler route.json, include api / csr / ssr
   async routeHandler(context) {
-    const { res } = context;
+    const { res, req, reporter } = context;
     const matched = this.router.match(context.path);
     if (!matched) {
       this.render404(context);
       return;
     }
+    await reporter.init({
+      match: matched
+    });
+    const end = (0, _time.time)();
+    res.on("finish", () => {
+      const cost = end();
+      reporter.reportTiming("server_handle_request", cost);
+    });
     let route = matched.generate(context.url);
     if (route.isApi) {
       await this.handleAPI(context);
       return;
     }
+    await (0, _utils1.bodyParser)(req);
     if (route.entryName) {
       const afterMatchContext = (0, _hookapi.createAfterMatchContext)(context, route.entryName);
       if (this.runMode === _constants.RUN_MODE.FULL) {
+        const end2 = (0, _time.time)();
         await this.runner.afterMatch(afterMatchContext, {
           onLast: _utils1.noop
         });
+        const cost = end2();
+        reporter.reportTiming("server_hook_after_render", cost);
       }
       if (this.isSend(res)) {
         return;
@@ -315,7 +330,10 @@ class ModernServer {
     if (this.frameWebHandler) {
       res.locals = res.locals || {};
       const middlewareContext = (0, _hookapi.createMiddlewareContext)(context);
+      const end2 = (0, _time.time)();
       await this.frameWebHandler(middlewareContext);
+      const cost = end2();
+      reporter.reportTiming("server_middleware", cost);
       res.locals = {
         ...res.locals,
         ...middlewareContext.response.locals
@@ -337,9 +355,12 @@ class ModernServer {
     if (route.entryName) {
       const afterRenderContext = (0, _hookapi.createAfterRenderContext)(context, response.toString());
       if (this.runMode === _constants.RUN_MODE.FULL) {
+        const end2 = (0, _time.time)();
         await this.runner.afterRender(afterRenderContext, {
           onLast: _utils1.noop
         });
+        const cost = end2();
+        reporter.reportTiming("server_hook_after_render", cost);
       }
       if (this.isSend(res)) {
         return;

package/dist/cjs/utils.js

@@ -36,6 +36,9 @@ _export(exports, {
   },
   isRedirect: function() {
     return isRedirect;
+  },
+  bodyParser: function() {
+    return bodyParser;
   }
 });
 const _utils = require("@modern-js/utils");
@@ -159,3 +162,33 @@ const isRedirect = (code) => {
     308
   ].includes(code);
 };
+function parseBodyTypes(headers, body) {
+  switch (headers["content-type"]) {
+    case "application/json":
+      return JSON.parse(body);
+    default:
+      return body;
+  }
+}
+const getRequestBody = (req) => new Promise((resolve, reject) => {
+  var _req;
+  if (((_req = req) === null || _req === void 0 ? void 0 : _req.method) && req.method.toLowerCase() !== "get") {
+    let body = "";
+    req.on("data", (chunk) => {
+      body += chunk.toString();
+    });
+    req.on("end", () => {
+      resolve(parseBodyTypes(req.headers, body));
+    });
+    req.on("error", (err) => {
+      reject(err);
+    });
+  } else {
+    resolve(void 0);
+  }
+});
+const bodyParser = async (req) => {
+  if (!req.body) {
+    req.body = await getRequestBody(req);
+  }
+};

package/dist/cjs/workerServer.js

@@ -23,6 +23,7 @@ const _indexworker = require("./libs/hook-api/index.worker");
 const _logger = require("./libs/logger");
 const _route = require("./libs/route");
 const _metrics = require("./libs/metrics");
+const _reporter = require("./libs/reporter");
 class ReturnResponse {
   /**
   * Iterate a Object
@@ -101,7 +102,8 @@ const createHandler = (manifest) => {
       level: "warn"
     });
     const metrics = _metrics.metrics;
-    const hookContext = createWorkerHookContext(request.url, logger, metrics);
+    const reporter = _reporter.defaultReporter;
+    const hookContext = createWorkerHookContext(request.url, logger, metrics, reporter);
     const afterMatchHookContext = (0, _indexworker.createAfterMatchContext)(hookContext, entryName);
     (_page = page) === null || _page === void 0 ? void 0 : (_page_serverHooks = _page.serverHooks) === null || _page_serverHooks === void 0 ? void 0 : (_page_serverHooks_afterMatch = _page_serverHooks.afterMatch) === null || _page_serverHooks_afterMatch === void 0 ? void 0 : _page_serverHooks_afterMatch.call(_page_serverHooks, afterMatchHookContext, () => void 0);
     if (checkIsSent(hookContext)) {
@@ -137,9 +139,15 @@ const createHandler = (manifest) => {
           template: page.template,
           entryName: page.entryName,
           logger,
+          reporter: _reporter.defaultReporter,
           metrics,
           // FIXME: pass correctly req & res
           req: request,
+          serverTiming: {
+            addServeTiming() {
+              return this;
+            }
+          },
           res: responseLike
         };
         const body = await page.serverRender(serverRenderContext);
@@ -184,7 +192,7 @@ function createResponse(template) {
     return RESPONSE_NOTFOUND;
   }
 }
-function createWorkerHookContext(url, logger, metrics) {
+function createWorkerHookContext(url, logger, metrics, reporter) {
   const [res, req] = [
     {
       headers: new Headers(),
@@ -198,7 +206,8 @@ function createWorkerHookContext(url, logger, metrics) {
     res,
     req,
     logger,
-    metrics
+    metrics,
+    reporter
   };
 }
 function applyMiddlewares(ctx, middleware) {

package/dist/esm/libs/context/context.js

@@ -7,21 +7,27 @@ import qs from "querystring";
 import { Buffer } from "buffer";
 import createEtag from "etag";
 import fresh from "fresh";
+import { cutNameByHyphen } from "@modern-js/utils";
+import { ServerTiming } from "../serverTiming";
+import { defaultReporter } from "../reporter";
 import { headersWithoutCookie } from "../../utils";
 var MOCK_URL_BASE = "https://modernjs.dev/";
 export var ModernServerContext = /* @__PURE__ */ function() {
   "use strict";
   function ModernServerContext2(req, res, options) {
     _class_call_check(this, ModernServerContext2);
+    var _options;
     _define_property(this, "req", void 0);
     _define_property(this, "res", void 0);
     _define_property(this, "params", {});
-    _define_property(this, "serverData", void 0);
+    _define_property(this, "reporter", defaultReporter);
+    _define_property(this, "serverTiming", void 0);
+    _define_property(this, "serverData", {});
     _define_property(this, "options", {});
     this.req = req;
     this.res = res;
     this.options = options || {};
-    this.serverData = {};
+    this.serverTiming = new ServerTiming(res, cutNameByHyphen(((_options = options) === null || _options === void 0 ? void 0 : _options.metaName) || "modern-js"));
     this.bind();
   }
   _create_class(ModernServerContext2, [

package/dist/esm/libs/hook-api/index.js

@@ -4,10 +4,11 @@ import { RouteAPI } from "./route";
 import { TemplateAPI } from "./template";
 import { BaseRequest, BaseResponse } from "./base";
 export var base = function(context) {
-  var res = context.res;
+  var res = context.res, reporter = context.reporter;
   return {
     response: new BaseResponse(res),
     request: new BaseRequest(context),
+    reporter: reporter,
     logger: context.logger,
     metrics: context.metrics
   };

package/dist/esm/libs/hook-api/index.worker.js

@@ -55,7 +55,7 @@ var ServerResponse = /* @__PURE__ */ function() {
   return ServerResponse2;
 }();
 export var base = function(context) {
-  var req = context.req, res = context.res, logger = context.logger, metrics = context.metrics;
+  var req = context.req, res = context.res, logger = context.logger, metrics = context.metrics, reporter = context.reporter;
   var serverResponse = new ServerResponse(res);
   var _ref = new URL(req.url), host = _ref.host, pathname = _ref.pathname, searchParams = _ref.searchParams;
   var headers = {};
@@ -64,6 +64,7 @@ export var base = function(context) {
   });
   return {
     response: new BaseResponse(serverResponse),
+    reporter: reporter,
     request: new BaseRequest({
       url: req.url,
       host: host,

package/dist/esm/libs/render/ssr.js

@@ -7,7 +7,7 @@ import { createLogger, createMetrics } from "./measure";
 import { injectServerDataStream, injectServerData } from "./utils";
 export var render = function() {
   var _ref = _async_to_generator(function(ctx, renderOptions, runner) {
-    var _ctx_res, urlPath, bundle, distDir, template, entryName, staticGenerate, _renderOptions_enableUnsafeCtx, enableUnsafeCtx, nonce, bundleJS, loadableUri, loadableStats, routesManifestUri, routeManifest, body, context, bundleJSContent, serverRender, content, _context_redirection, url, _context_redirection_status, status;
+    var _ctx_res, urlPath, bundle, distDir, template, entryName, staticGenerate, _renderOptions_enableUnsafeCtx, enableUnsafeCtx, nonce, bundleJS, loadableUri, loadableStats, routesManifestUri, routeManifest, context, bundleJSContent, serverRender, content, _context_redirection, url, _context_redirection_status, status;
     return _ts_generator(this, function(_state) {
       switch (_state.label) {
         case 0:
@@ -17,12 +17,6 @@ export var render = function() {
           loadableStats = fs.existsSync(loadableUri) ? require(loadableUri) : "";
           routesManifestUri = path.join(distDir, ROUTE_MANIFEST_FILE);
           routeManifest = fs.existsSync(routesManifestUri) ? require(routesManifestUri) : void 0;
-          return [
-            4,
-            getRequestBody(ctx.req)
-          ];
-        case 1:
-          body = _state.sent();
           context = {
             request: {
               baseUrl: urlPath,
@@ -32,7 +26,7 @@ export var render = function() {
               query: ctx.query,
               url: ctx.href,
               headers: ctx.headers,
-              body: body
+              body: ctx.req.body
             },
             response: {
               setHeader: function(key, value) {
@@ -51,6 +45,8 @@ export var render = function() {
             staticGenerate: staticGenerate,
             logger: void 0,
             metrics: void 0,
+            reporter: ctx.reporter,
+            serverTiming: ctx.serverTiming,
             req: ctx.req,
             res: ctx.res,
             enableUnsafeCtx: enableUnsafeCtx,
@@ -63,14 +59,14 @@ export var render = function() {
             4,
             Promise.resolve(require(bundleJS))
           ];
-        case 2:
+        case 1:
           bundleJSContent = _state.sent();
           serverRender = bundleJSContent[SERVER_RENDER_FUNCTION_NAME];
           return [
             4,
             cache(serverRender, ctx)(context)
           ];
-        case 3:
+        case 2:
           content = _state.sent();
           _context_redirection = context.redirection, url = _context_redirection.url, _context_redirection_status = _context_redirection.status, status = _context_redirection_status === void 0 ? 302 : _context_redirection_status;
           if (url) {
@@ -112,22 +108,3 @@ export var render = function() {
     return _ref.apply(this, arguments);
   };
 }();
-var getRequestBody = function(req) {
-  return new Promise(function(resolve, reject) {
-    var _req;
-    if (((_req = req) === null || _req === void 0 ? void 0 : _req.method) && req.method.toLowerCase() !== "get") {
-      var body = "";
-      req.on("data", function(chunk) {
-        body += chunk.toString();
-      });
-      req.on("end", function() {
-        resolve(body);
-      });
-      req.on("error", function(err) {
-        reject(err);
-      });
-    } else {
-      resolve(void 0);
-    }
-  });
-};

package/dist/esm/libs/reporter.js

@@ -0,0 +1,12 @@
+export var defaultReporter = {
+  init: function init() {
+  },
+  reportError: function reportError() {
+  },
+  reportTiming: function reportTiming() {
+  },
+  reportInfo: function reportInfo() {
+  },
+  reportWarn: function reportWarn() {
+  }
+};

package/dist/esm/libs/serverTiming.js

@@ -0,0 +1,27 @@
+import { _ as _class_call_check } from "@swc/helpers/_/_class_call_check";
+import { _ as _create_class } from "@swc/helpers/_/_create_class";
+import { _ as _define_property } from "@swc/helpers/_/_define_property";
+var SERVER_TIMING = "Server-Timing";
+export var ServerTiming = /* @__PURE__ */ function() {
+  "use strict";
+  function ServerTiming2(res, meta) {
+    _class_call_check(this, ServerTiming2);
+    _define_property(this, "meta", void 0);
+    _define_property(this, "res", void 0);
+    this.meta = meta;
+    this.res = res;
+  }
+  _create_class(ServerTiming2, [
+    {
+      key: "addServeTiming",
+      value: function addServeTiming(name, dur, desc) {
+        var _name = "bd-".concat(this.meta, "-").concat(name);
+        var serverTiming = this.res.getHeader(SERVER_TIMING) || this.res.getHeader(SERVER_TIMING.toLocaleLowerCase());
+        var value = "".concat(_name, ";").concat(desc ? 'decs="'.concat(desc, '";') : "", " dur=").concat(dur);
+        this.res.setHeader(SERVER_TIMING, serverTiming ? "".concat(serverTiming, ", ").concat(value) : value);
+        return this;
+      }
+    }
+  ]);
+  return ServerTiming2;
+}();