@modern-js/prod-server 2.47.1 → 2.48.0

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

@@ -89,7 +89,7 @@ const render = async (ctx, renderOptions, runner) => {
   runner.extendSSRContext(context);
   const bundleJSContent = await Promise.resolve(require(bundleJS));
   const serverRender = bundleJSContent[import_utils.SERVER_RENDER_FUNCTION_NAME];
-  const content = await (0, import_ssrCache.ssrCache)(ctx.req, serverRender, context);
+  const { data: content, status: cacheStatus } = await (0, import_ssrCache.ssrCache)(ctx.req, serverRender, context);
   const { url, status = 302 } = context.redirection;
   if (url) {
     return {
@@ -99,10 +99,13 @@ const render = async (ctx, renderOptions, runner) => {
       redirect: true
     };
   }
+  const headers = {};
+  cacheStatus && (headers["x-render-cache"] = cacheStatus);
   if (typeof content === "string") {
     return {
       content: (0, import_utils2.injectServerData)(content, ctx),
-      contentType: import_utils.mime.contentType("html")
+      contentType: import_utils.mime.contentType("html"),
+      headers
     };
   } else {
     let contentStream = (0, import_utils2.injectServerDataStream)(content, ctx);
@@ -116,7 +119,8 @@ const render = async (ctx, renderOptions, runner) => {
     return {
       content: "",
       contentStream,
-      contentType: import_utils.mime.contentType("html")
+      contentType: import_utils.mime.contentType("html"),
+      headers
     };
   }
 };

package/dist/cjs/libs/render/ssrCache/index.js

@@ -35,9 +35,13 @@ async function ssrCache(req, render, ssrContext) {
   } else {
     const renderResult = await render(ssrContext);
     if (!renderResult) {
-      return "";
+      return {
+        data: ""
+      };
     } else if (typeof renderResult === "string") {
-      return renderResult;
+      return {
+        data: renderResult
+      };
     } else {
       const stream = new import_stream.Transform({
         write(chunk, _, callback) {
@@ -45,7 +49,10 @@ async function ssrCache(req, render, ssrContext) {
           callback();
         }
       });
-      return renderResult(stream);
+      const data = await renderResult(stream);
+      return {
+        data
+      };
     }
   }
 }

package/dist/cjs/libs/render/ssrCache/manager.js

@@ -33,21 +33,29 @@ class CacheManager {
       const cache = JSON.parse(value);
       const interval = Date.now() - cache.cursor;
       if (interval <= maxAge) {
-        return cache.val;
+        return {
+          data: cache.val,
+          status: "hit"
+        };
       } else if (interval <= staleWhileRevalidate + maxAge) {
         this.processCache(key, render, ssrContext, ttl);
-        return cache.val;
+        return {
+          data: cache.val,
+          status: "stale"
+        };
       } else {
-        return this.processCache(key, render, ssrContext, ttl);
+        return this.processCache(key, render, ssrContext, ttl, "expired");
       }
     } else {
-      return this.processCache(key, render, ssrContext, ttl);
+      return this.processCache(key, render, ssrContext, ttl, "miss");
     }
   }
-  async processCache(key, render, ssrContext, ttl) {
+  async processCache(key, render, ssrContext, ttl, status) {
     const renderResult = await render(ssrContext);
     if (!renderResult) {
-      return "";
+      return {
+        data: ""
+      };
     } else if (typeof renderResult === "string") {
       const current = Date.now();
       const cache = {
@@ -57,7 +65,10 @@ class CacheManager {
       await this.container.set(key, JSON.stringify(cache), {
         ttl
       });
-      return renderResult;
+      return {
+        data: renderResult,
+        status
+      };
     } else {
       let html = "";
       const stream = new import_stream.Transform({
@@ -77,7 +88,11 @@ class CacheManager {
           ttl
         });
       });
-      return renderResult(stream);
+      const readable = await renderResult(stream);
+      return {
+        data: readable,
+        status
+      };
     }
   }
   computedKey(req, cacheControl) {

package/dist/cjs/server/modernServer.js

@@ -360,7 +360,13 @@ class ModernServer {
     if (!renderResult) {
       return;
     }
-    const { contentStream: responseStream } = renderResult;
+    const { contentStream: responseStream, headers } = renderResult;
+    if (headers) {
+      for (const name in headers) {
+        const value = headers[name];
+        res.setHeader(name, value);
+      }
+    }
     let { content: response } = renderResult;
     if (route.entryName && responseStream) {
       responseStream.pipe(res);

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

@@ -10,7 +10,7 @@ import { injectServerDataStream, injectServerData } from "./utils";
 import { ssrCache } from "./ssrCache";
 var render = function() {
   var _ref = _async_to_generator(function(ctx, renderOptions, runner) {
-    var _ctx_res, distDir, route, template, staticGenerate, _renderOptions_enableUnsafeCtx, enableUnsafeCtx, nonce, urlPath, bundle, entryName, bundleJS, loadableUri, loadableStats, routesManifestUri, routeManifest, isSpider, context, bundleJSContent, serverRender, content, _context_redirection, url, _context_redirection_status, status, contentStream, afterStreamingRenderContext;
+    var _ctx_res, distDir, route, template, staticGenerate, _renderOptions_enableUnsafeCtx, enableUnsafeCtx, nonce, urlPath, bundle, entryName, bundleJS, loadableUri, loadableStats, routesManifestUri, routeManifest, isSpider, context, bundleJSContent, serverRender, _ref2, content, cacheStatus, _context_redirection, url, _context_redirection_status, status, headers, contentStream, afterStreamingRenderContext;
     return _ts_generator(this, function(_state) {
       switch (_state.label) {
         case 0:
@@ -72,7 +72,7 @@ var render = function() {
             ssrCache(ctx.req, serverRender, context)
           ];
         case 2:
-          content = _state.sent();
+          _ref2 = _state.sent(), content = _ref2.data, cacheStatus = _ref2.status;
           _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) {
             return [
@@ -85,12 +85,15 @@ var render = function() {
               }
             ];
           }
+          headers = {};
+          cacheStatus && (headers["x-render-cache"] = cacheStatus);
           if (typeof content === "string") {
             return [
               2,
               {
                 content: injectServerData(content, ctx),
-                contentType: mime.contentType("html")
+                contentType: mime.contentType("html"),
+                headers
               }
             ];
           } else {
@@ -110,7 +113,8 @@ var render = function() {
               {
                 content: "",
                 contentStream,
-                contentType: mime.contentType("html")
+                contentType: mime.contentType("html"),
+                headers
               }
             ];
           }

package/dist/esm/libs/render/ssrCache/index.js

@@ -11,7 +11,7 @@ function ssrCache(req, render, ssrContext) {
 }
 function _ssrCache() {
   _ssrCache = _async_to_generator(function(req, render, ssrContext) {
-    var customContainer, cacheOption, cacheControl, cacheManager, renderResult, stream;
+    var customContainer, cacheOption, cacheControl, cacheManager, renderResult, stream, data;
     return _ts_generator(this, function(_state) {
       switch (_state.label) {
         case 0:
@@ -39,30 +39,49 @@ function _ssrCache() {
           ];
         case 3:
           renderResult = _state.sent();
-          if (!renderResult) {
+          if (!!renderResult)
             return [
-              2,
-              ""
-            ];
-          } else if (typeof renderResult === "string") {
-            return [
-              2,
-              renderResult
+              3,
+              4
             ];
-          } else {
-            stream = new Transform({
-              write: function write(chunk, _, callback) {
-                this.push(chunk);
-                callback();
-              }
-            });
+          return [
+            2,
+            {
+              data: ""
+            }
+          ];
+        case 4:
+          if (!(typeof renderResult === "string"))
             return [
-              2,
-              renderResult(stream)
+              3,
+              5
             ];
-          }
-          _state.label = 4;
-        case 4:
+          return [
+            2,
+            {
+              data: renderResult
+            }
+          ];
+        case 5:
+          stream = new Transform({
+            write: function write(chunk, _, callback) {
+              this.push(chunk);
+              callback();
+            }
+          });
+          return [
+            4,
+            renderResult(stream)
+          ];
+        case 6:
+          data = _state.sent();
+          return [
+            2,
+            {
+              data
+            }
+          ];
+        case 7:
           return [
             2
           ];

package/dist/esm/libs/render/ssrCache/manager.js

@@ -37,24 +37,30 @@ var CacheManager = /* @__PURE__ */ function() {
                   if (interval <= maxAge) {
                     return [
                       2,
-                      cache.val
+                      {
+                        data: cache.val,
+                        status: "hit"
+                      }
                     ];
                   } else if (interval <= staleWhileRevalidate + maxAge) {
                     _this.processCache(key, render, ssrContext, ttl);
                     return [
                       2,
-                      cache.val
+                      {
+                        data: cache.val,
+                        status: "stale"
+                      }
                     ];
                   } else {
                     return [
                       2,
-                      _this.processCache(key, render, ssrContext, ttl)
+                      _this.processCache(key, render, ssrContext, ttl, "expired")
                     ];
                   }
                 } else {
                   return [
                     2,
-                    _this.processCache(key, render, ssrContext, ttl)
+                    _this.processCache(key, render, ssrContext, ttl, "miss")
                   ];
                 }
                 return [
@@ -67,10 +73,10 @@ var CacheManager = /* @__PURE__ */ function() {
     },
     {
       key: "processCache",
-      value: function processCache(key, render, ssrContext, ttl) {
+      value: function processCache(key, render, ssrContext, ttl, status) {
         var _this = this;
         return _async_to_generator(function() {
-          var renderResult, current, cache, html, stream;
+          var renderResult, current, cache, html, stream, readable;
           return _ts_generator(this, function(_state) {
             switch (_state.label) {
               case 0:
@@ -87,7 +93,9 @@ var CacheManager = /* @__PURE__ */ function() {
                   ];
                 return [
                   2,
-                  ""
+                  {
+                    data: ""
+                  }
                 ];
               case 2:
                 if (!(typeof renderResult === "string"))
@@ -110,7 +118,10 @@ var CacheManager = /* @__PURE__ */ function() {
                 _state.sent();
                 return [
                   2,
-                  renderResult
+                  {
+                    data: renderResult,
+                    status
+                  }
                 ];
               case 4:
                 html = "";
@@ -132,10 +143,19 @@ var CacheManager = /* @__PURE__ */ function() {
                   });
                 });
                 return [
-                  2,
+                  4,
                   renderResult(stream)
                 ];
               case 5:
+                readable = _state.sent();
+                return [
+                  2,
+                  {
+                    data: readable,
+                    status
+                  }
+                ];
+              case 6:
                 return [
                   2
                 ];

package/dist/esm/server/modernServer.js

@@ -660,7 +660,7 @@ var ModernServer = /* @__PURE__ */ function() {
         function routeHandler(context) {
           var _this = this;
           return _async_to_generator(function() {
-            var res, reporter, matched, end, route, afterMatchContext, end1, cost, _afterMatchContext_router, current, url, status, matched1, middlewareContext, end2, cost1, renderResult, responseStream, response, afterRenderContext, end3, cost2;
+            var res, reporter, matched, end, route, afterMatchContext, end1, cost, _afterMatchContext_router, current, url, status, matched1, middlewareContext, end2, cost1, renderResult, responseStream, headers, name, value, response, afterRenderContext, end3, cost2;
             return _ts_generator(this, function(_state) {
               switch (_state.label) {
                 case 0:
@@ -777,7 +777,13 @@ var ModernServer = /* @__PURE__ */ function() {
                       2
                     ];
                   }
-                  responseStream = renderResult.contentStream;
+                  responseStream = renderResult.contentStream, headers = renderResult.headers;
+                  if (headers) {
+                    for (var name2 in headers) {
+                      value = headers[name2];
+                      res.setHeader(name2, value);
+                    }
+                  }
                   response = renderResult.content;
                   if (route.entryName && responseStream) {
                     responseStream.pipe(res);

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

@@ -56,7 +56,7 @@ const render = async (ctx, renderOptions, runner) => {
   runner.extendSSRContext(context);
   const bundleJSContent = await Promise.resolve(require(bundleJS));
   const serverRender = bundleJSContent[SERVER_RENDER_FUNCTION_NAME];
-  const content = await ssrCache(ctx.req, serverRender, context);
+  const { data: content, status: cacheStatus } = await ssrCache(ctx.req, serverRender, context);
   const { url, status = 302 } = context.redirection;
   if (url) {
     return {
@@ -66,10 +66,13 @@ const render = async (ctx, renderOptions, runner) => {
       redirect: true
     };
   }
+  const headers = {};
+  cacheStatus && (headers["x-render-cache"] = cacheStatus);
   if (typeof content === "string") {
     return {
       content: injectServerData(content, ctx),
-      contentType: mime.contentType("html")
+      contentType: mime.contentType("html"),
+      headers
     };
   } else {
     let contentStream = injectServerDataStream(content, ctx);
@@ -83,7 +86,8 @@ const render = async (ctx, renderOptions, runner) => {
     return {
       content: "",
       contentStream,
-      contentType: mime.contentType("html")
+      contentType: mime.contentType("html"),
+      headers
     };
   }
 };

package/dist/esm-node/libs/render/ssrCache/index.js

@@ -12,9 +12,13 @@ async function ssrCache(req, render, ssrContext) {
   } else {
     const renderResult = await render(ssrContext);
     if (!renderResult) {
-      return "";
+      return {
+        data: ""
+      };
     } else if (typeof renderResult === "string") {
-      return renderResult;
+      return {
+        data: renderResult
+      };
     } else {
       const stream = new Transform({
         write(chunk, _, callback) {
@@ -22,7 +26,10 @@ async function ssrCache(req, render, ssrContext) {
           callback();
         }
       });
-      return renderResult(stream);
+      const data = await renderResult(stream);
+      return {
+        data
+      };
     }
   }
 }

package/dist/esm-node/libs/render/ssrCache/manager.js

@@ -10,21 +10,29 @@ class CacheManager {
       const cache = JSON.parse(value);
       const interval = Date.now() - cache.cursor;
       if (interval <= maxAge) {
-        return cache.val;
+        return {
+          data: cache.val,
+          status: "hit"
+        };
       } else if (interval <= staleWhileRevalidate + maxAge) {
         this.processCache(key, render, ssrContext, ttl);
-        return cache.val;
+        return {
+          data: cache.val,
+          status: "stale"
+        };
       } else {
-        return this.processCache(key, render, ssrContext, ttl);
+        return this.processCache(key, render, ssrContext, ttl, "expired");
       }
     } else {
-      return this.processCache(key, render, ssrContext, ttl);
+      return this.processCache(key, render, ssrContext, ttl, "miss");
     }
   }
-  async processCache(key, render, ssrContext, ttl) {
+  async processCache(key, render, ssrContext, ttl, status) {
     const renderResult = await render(ssrContext);
     if (!renderResult) {
-      return "";
+      return {
+        data: ""
+      };
     } else if (typeof renderResult === "string") {
       const current = Date.now();
       const cache = {
@@ -34,7 +42,10 @@ class CacheManager {
       await this.container.set(key, JSON.stringify(cache), {
         ttl
       });
-      return renderResult;
+      return {
+        data: renderResult,
+        status
+      };
     } else {
       let html = "";
       const stream = new Transform({
@@ -54,7 +65,11 @@ class CacheManager {
           ttl
         });
       });
-      return renderResult(stream);
+      const readable = await renderResult(stream);
+      return {
+        data: readable,
+        status
+      };
     }
   }
   computedKey(req, cacheControl) {

package/dist/esm-node/server/modernServer.js

@@ -327,7 +327,13 @@ class ModernServer {
     if (!renderResult) {
       return;
     }
-    const { contentStream: responseStream } = renderResult;
+    const { contentStream: responseStream, headers } = renderResult;
+    if (headers) {
+      for (const name in headers) {
+        const value = headers[name];
+        res.setHeader(name, value);
+      }
+    }
     let { content: response } = renderResult;
     if (route.entryName && responseStream) {
       responseStream.pipe(res);

package/dist/types/libs/render/ssrCache/index.d.ts

@@ -1,7 +1,6 @@
-/// <reference types="node" />
 /// <reference types="node/http" />
 /// <reference types="dist/types/type" />
 import { IncomingMessage } from 'http';
-import { type Readable } from 'stream';
 import { RenderFunction, SSRServerContext } from '../type';
-export declare function ssrCache(req: IncomingMessage, render: RenderFunction, ssrContext: SSRServerContext): Promise<string | Readable>;
+import { CacheResult } from './manager';
+export declare function ssrCache(req: IncomingMessage, render: RenderFunction, ssrContext: SSRServerContext): Promise<CacheResult>;

package/dist/types/libs/render/ssrCache/manager.d.ts

@@ -5,10 +5,16 @@ import { IncomingMessage } from 'http';
 import { Readable } from 'stream';
 import { CacheControl, Container } from '@modern-js/types';
 import { RenderFunction, SSRServerContext } from '../type';
+type CacheStatus = 'hit' | 'stale' | 'expired' | 'miss';
+export type CacheResult = {
+    data: string | Readable;
+    status?: CacheStatus;
+};
 export declare class CacheManager {
     private container;
     constructor(container: Container<string, string>);
-    getCacheResult(req: IncomingMessage, cacheControl: CacheControl, render: RenderFunction, ssrContext: SSRServerContext): Promise<string | Readable>;
+    getCacheResult(req: IncomingMessage, cacheControl: CacheControl, render: RenderFunction, ssrContext: SSRServerContext): Promise<CacheResult>;
     private processCache;
     private computedKey;
 }
+export {};

package/dist/types/type.d.ts

@@ -49,6 +49,7 @@ export type RenderResult = {
     contentType: string;
     contentStream?: Readable;
     statusCode?: number;
+    headers?: Record<string, string>;
     redirect?: boolean;
 };
 export type ConfWithBFF = {

package/package.json

@@ -15,7 +15,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "2.47.1",
+  "version": "2.48.0",
   "jsnext:source": "./src/index.ts",
   "types": "./dist/types/index.d.ts",
   "main": "./dist/cjs/index.js",
@@ -74,10 +74,10 @@
     "node-html-parser": "^6.1.5",
     "path-to-regexp": "^6.2.0",
     "serve-static": "^1.14.1",
-    "@modern-js/plugin": "2.47.1",
-    "@modern-js/server-core": "2.47.1",
-    "@modern-js/runtime-utils": "2.47.1",
-    "@modern-js/utils": "2.47.1"
+    "@modern-js/plugin": "2.48.0",
+    "@modern-js/utils": "2.48.0",
+    "@modern-js/server-core": "2.48.0",
+    "@modern-js/runtime-utils": "2.48.0"
   },
   "devDependencies": {
     "@types/cookie": "0.5.1",
@@ -95,9 +95,9 @@
     "portfinder": "^1.0.28",
     "typescript": "^5",
     "ws": "^8.13.0",
-    "@scripts/build": "2.47.1",
-    "@modern-js/types": "2.47.1",
-    "@scripts/jest-config": "2.47.1"
+    "@modern-js/types": "2.48.0",
+    "@scripts/build": "2.48.0",
+    "@scripts/jest-config": "2.48.0"
   },
   "sideEffects": false,
   "publishConfig": {