isr-engine 4.3.0 → 4.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -0
- package/dist/cli/cli.js +1 -1
- package/dist/{createCacheInspectorMiddleware-glgtcBcQ.js → createCacheInspectorMiddleware-DUYq46J4.js} +2 -2
- package/dist/{createCacheInspectorMiddleware-glgtcBcQ.js.map → createCacheInspectorMiddleware-DUYq46J4.js.map} +1 -1
- package/dist/{createISRApp-BG-s3uuL.js → createISRApp-yBEBvYD5.js} +4 -4
- package/dist/createISRApp-yBEBvYD5.js.map +1 -0
- package/dist/defaults/runtime/defineSiteHooks.d.ts +5 -2
- package/dist/defaults/runtime/defineSiteHooks.d.ts.map +1 -1
- package/dist/defaults/runtime/defineSiteHooks.js +76 -15
- package/dist/defaults/runtime/defineSiteHooks.js.map +1 -1
- package/dist/isr-engine.js +1 -1
- package/dist/types/ISRConfig.d.ts +12 -0
- package/dist/types/ISRConfig.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/defaults/runtime/defineSiteHooks.ts +98 -21
- package/src/types/ISRConfig.ts +14 -0
- package/dist/createISRApp-BG-s3uuL.js.map +0 -1
package/README.md
CHANGED
|
@@ -134,6 +134,8 @@ TTL 与 SWR 单位为秒。`routes` 控制渲染策略;页面路由可使用 `
|
|
|
134
134
|
|
|
135
135
|
临时降级或使用过期字典及 SEO 数据的响应跳过 ISR 写入。动态 sitemap 刷新失败时,默认可在目录过期后的 5 分钟内沿用上一份有效结果,可用 `runtime.seo.sitemap.staleIfErrorMs` 调整。发布事件会丢弃旧目录,缺少可用目录时返回 `503`。
|
|
136
136
|
|
|
137
|
+
在模块初始化时创建 `siteHooks = applyRuntimeToServerHooks({}, runtime)`,再用 `siteHooks.loadLanguageCatalog?.()` 读取 `runtime.i18n.locales` 的显示名称。可选的 `runtime.i18n.catalog.endpoint` 一次返回 `{ locale, name }[]`,缺少的名称按语言自身的显示名补齐。引擎合并并发加载,语言发布时刷新目录。
|
|
138
|
+
|
|
137
139
|
请求期扩展可放在可选的 `src/entry.server.tsx`,默认导出 `defineAdminSiteHooks({ beforeRequest, onError })`(从 `isr-engine/site-hooks` 导入)。部署配置留在 `ssr.config.ts`;Server Component 用 `getRequestContext()` 读取 hooks 注入的上下文。
|
|
138
140
|
|
|
139
141
|
`Logger.spin()` 返回 Ora 10 对象。`prefixText`、`suffixText` 可为字符串或生成函数;`color` 接受颜色名、`false` 或 `undefined`;自定义 spinner 的 `interval` 必须是正安全整数。
|
package/dist/cli/cli.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
|
-
import { D as loadConfig, G as DEFAULT_PORT, K as package_default, W as logger, a as closeServer, c as prepareProductionBuild, o as startServer, s as createProductionRuntime, t as createISRApp } from "../createISRApp-
|
|
2
|
+
import { D as loadConfig, G as DEFAULT_PORT, K as package_default, W as logger, a as closeServer, c as prepareProductionBuild, o as startServer, s as createProductionRuntime, t as createISRApp } from "../createISRApp-yBEBvYD5.js";
|
|
3
3
|
import { extname, join, resolve, sep } from "node:path";
|
|
4
4
|
import { open, readFile } from "node:fs/promises";
|
|
5
5
|
import http from "node:http";
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { E as getOpsRequestLimiter, T as createOpsAuthMiddleware } from "./createISRApp-
|
|
1
|
+
import { E as getOpsRequestLimiter, T as createOpsAuthMiddleware } from "./createISRApp-yBEBvYD5.js";
|
|
2
2
|
import express from "express";
|
|
3
3
|
/** L1 单次响应最多条目数(硬上限),避免极端情况返回 5MB+ JSON */
|
|
4
4
|
var HARD_LIMIT = 1e3;
|
|
@@ -106,4 +106,4 @@ function createCacheInspectorMiddleware(handler, opsConfig) {
|
|
|
106
106
|
}
|
|
107
107
|
export { createCacheInspectorMiddleware };
|
|
108
108
|
|
|
109
|
-
//# sourceMappingURL=createCacheInspectorMiddleware-
|
|
109
|
+
//# sourceMappingURL=createCacheInspectorMiddleware-DUYq46J4.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"createCacheInspectorMiddleware-
|
|
1
|
+
{"version":3,"file":"createCacheInspectorMiddleware-DUYq46J4.js","names":[],"sources":["../src/plugin/createCacheInspectorMiddleware.ts"],"sourcesContent":["/**\n * ISR cache inventory 端点 —— 暴露当前 L1 缓存条目元数据 + 最近 invalidate 时间。\n *\n * 用途:回答 “这一刻,哪些页面的缓存是 stale?某 path/tag 上次什么时候被 revalidate?”\n * 这类 *库存视角* 问题。流量视角(按路由 cache 状态分布)走 Prometheus\n * `isr_http_requests_total{cache=\"STALE\",route=...}`;本端点是补充而非替代。\n *\n * 边界(明确写在这里防止滑坡):\n * ✅ 只读 L1(in-process LRU),永不 SCAN Redis(SCAN 阻塞,量大不该走 engine)\n * ✅ 只返回元数据:key / 时间戳 / size / tags;body 一字节都不返回\n * ✅ 只给 JSON,不给 HTML 浏览器(漂亮 UI 走业务自建或单独包)\n * ✅ 鉴权复用 opsConfig.authToken,不引入 SSO/RBAC(那是业务网关的事)\n * ✅ 端点路径 /__isr/cache/inventory 已在 isrCacheMiddleware.isBypassPath 列表,\n * 自身永远不会被 ISR 缓存\n *\n * 查询参数:\n * ?status=fresh|stale|expired|all 过滤 L1 条目状态(默认 all)\n * ?limit=N L1 条目数上限(默认 100,硬上限 1000)\n * ?l2=true|false 是否包含 L2(Redis)SCAN 视图(默认 true,\n * hybrid 模式才有内容;memory 模式恒为 [] 不发请求)\n * ?l2Limit=N L2 SCAN 条目数上限(默认 200,硬上限 500,防 SCAN 流量过大)\n *\n * 响应示例(hybrid 模式):\n * {\n * \"now\": 1715760000000,\n * \"backend\": \"hybrid\",\n * \"size\": 234, // L1 条目数\n * \"max\": 1000, // L1 容量\n * \"filtered\": 12, // L1 过滤后条目数\n * \"entries\": [...], // L1 条目(含 fresh/stale/expired 状态)\n * \"invalidations\": [...], // 最近 invalidate 时间\n * \"l2\": {\n * \"scanned\": 234,\n * \"items\": [\n * { \"key\": \"GET:/books/1\", \"sizeBytes\": 12450, \"ttlSecondsRemaining\": 1800, \"onlyInL2\": false },\n * { \"key\": \"GET:/cold-page\", \"sizeBytes\": 800, \"ttlSecondsRemaining\": 7200, \"onlyInL2\": true }\n * ]\n * }\n * }\n */\nimport type { IncomingMessage, ServerResponse } from 'node:http';\nimport type { Connect } from 'vite';\nimport express from 'express';\nimport type { IsrCacheHandler, IsrCacheInspectionEntry } from './isrCacheMiddleware';\nimport type { ResolvedOpsConfig } from '../server/opsConfig';\nimport { createOpsAuthMiddleware, getOpsRequestLimiter } from '../server/opsConfig';\n\n/** Inventory 端点路径常量 —— 与 isrCacheMiddleware.isBypassPath 中的 /__isr 前缀对齐 */\nexport const CACHE_INVENTORY_PATH = '/__isr/cache/inventory';\n\n/** L1 单次响应最多条目数(硬上限),避免极端情况返回 5MB+ JSON */\nconst HARD_LIMIT = 1000;\n/** L1 默认 limit */\nconst DEFAULT_LIMIT = 100;\n/** L2 SCAN 单次返回硬上限 —— 比 L1 更严,因为每个 entry 一次 STRLEN+TTL 是 2 个 Redis 命令 */\nconst L2_HARD_LIMIT = 500;\n/** L2 默认 limit */\nconst L2_DEFAULT_LIMIT = 200;\n\ntype StatusFilter = 'fresh' | 'stale' | 'expired' | 'all';\n\nfunction parseStatusFilter(raw: string | null): StatusFilter {\n if (raw === 'fresh' || raw === 'stale' || raw === 'expired' || raw === 'all') return raw;\n return 'all';\n}\n\nfunction parseLimit(raw: string | null): number {\n if (!raw) return DEFAULT_LIMIT;\n const n = parseInt(raw, 10);\n if (!Number.isFinite(n) || n <= 0) return DEFAULT_LIMIT;\n return Math.min(n, HARD_LIMIT);\n}\n\nfunction parseL2Limit(raw: string | null): number {\n if (!raw) return L2_DEFAULT_LIMIT;\n const n = parseInt(raw, 10);\n if (!Number.isFinite(n) || n <= 0) return L2_DEFAULT_LIMIT;\n return Math.min(n, L2_HARD_LIMIT);\n}\n\nfunction parseBoolFlag(raw: string | null, defaultValue: boolean): boolean {\n if (raw === null) return defaultValue;\n const v = raw.toLowerCase();\n if (v === 'true' || v === '1' || v === 'yes') return true;\n if (v === 'false' || v === '0' || v === 'no') return false;\n return defaultValue;\n}\n\n/**\n * 创建 inventory 中间件。\n *\n * 必须在 ISR cache middleware 之前挂(路径已在 isBypassPath 但提前挂可以避开\n * cache handler 内部 metric 记录这次 admin 请求)。\n *\n * @param handler ISR cache handler,必须支持 getCacheInspection()\n * @param opsConfig resolveOpsConfig 的输出 —— inventory.enabled 控制端点是否生效\n */\nexport function createCacheInspectorMiddleware(\n handler: IsrCacheHandler,\n opsConfig: ResolvedOpsConfig\n): Connect.NextHandleFunction {\n // disabled 时直接返回 no-op,运行期不引入任何分支开销\n if (!opsConfig.inventory.enabled) {\n return (_req, _res, next) => next();\n }\n\n const auth = createOpsAuthMiddleware('inventory', opsConfig);\n const guarded = express.Router();\n guarded.use(getOpsRequestLimiter(opsConfig));\n guarded.use(auth);\n guarded.use((req, res) => {\n void respond(req, res, handler);\n });\n\n return (req: IncomingMessage, res: ServerResponse, next: Connect.NextFunction) => {\n if (req.method !== 'GET' && req.method !== 'HEAD') {\n next();\n return;\n }\n // 用 URL 解析路径(剥 query string)。req.url 一定有,但形态可能含 query。\n const url = req.url ?? '/';\n const pathOnly = url.split('?')[0];\n if (pathOnly !== CACHE_INVENTORY_PATH) {\n next();\n return;\n }\n\n // Admission precedes both authentication and any Redis inspection, including on Connect.\n guarded(req as express.Request, res as express.Response, next);\n };\n\n async function respond(\n req: IncomingMessage,\n res: ServerResponse,\n h: IsrCacheHandler\n ): Promise<void> {\n try {\n const snapshot = h.getCacheInspection();\n const params = new URLSearchParams((req.url ?? '').split('?')[1] ?? '');\n const statusFilter = parseStatusFilter(params.get('status'));\n const limit = parseLimit(params.get('limit'));\n const includeL2 = parseBoolFlag(params.get('l2'), true);\n const l2Limit = parseL2Limit(params.get('l2Limit'));\n\n const filtered: IsrCacheInspectionEntry[] =\n statusFilter === 'all'\n ? snapshot.entries\n : snapshot.entries.filter(e => e.status === statusFilter);\n\n // 排序:fresh 先返回最新入缓存的;stale/expired 先返回最旧的(最该被关注)。\n // 对于 all:按 ageSeconds 降序(旧的优先),方便排错时一眼看到长期未刷新的条目。\n const sorted = [...filtered].sort((a, b) => b.ageSeconds - a.ageSeconds);\n const limited = sorted.slice(0, limit);\n\n const sortedInvalidations = [...snapshot.invalidations].sort(\n (a, b) => b.lastInvalidatedMs - a.lastInvalidatedMs\n );\n\n // L2 视图(仅 hybrid 模式有内容)—— 异步 SCAN 拉取\n const l2Items =\n includeL2 && snapshot.backend === 'hybrid' ? await h.getL2Inspection(l2Limit) : [];\n\n const body = JSON.stringify(\n {\n now: snapshot.now,\n backend: snapshot.backend,\n size: snapshot.size,\n max: snapshot.max,\n filter: { status: statusFilter, limit, l2: includeL2, l2Limit },\n filtered: filtered.length,\n entries: limited,\n invalidations: sortedInvalidations,\n l2: { scanned: l2Items.length, items: l2Items },\n },\n null,\n 2\n );\n\n if (res.headersSent) return;\n res.statusCode = 200;\n res.setHeader('content-type', 'application/json; charset=utf-8');\n res.setHeader('cache-control', 'no-store');\n res.end(body);\n } catch (err) {\n if (res.headersSent) return;\n res.statusCode = 500;\n res.setHeader('content-type', 'application/json; charset=utf-8');\n res.end(JSON.stringify({ error: (err as Error).message }));\n }\n }\n}\n"],"mappings":";;;AAmDA,IAAM,aAAa;;AAEnB,IAAM,gBAAgB;;AAEtB,IAAM,gBAAgB;;AAEtB,IAAM,mBAAmB;AAIzB,SAAS,kBAAkB,KAAkC;CAC3D,IAAI,QAAQ,WAAW,QAAQ,WAAW,QAAQ,aAAa,QAAQ,OAAO,OAAO;CACrF,OAAO;AACT;AAEA,SAAS,WAAW,KAA4B;CAC9C,IAAI,CAAC,KAAK,OAAO;CACjB,MAAM,IAAI,SAAS,KAAK,EAAE;CAC1B,IAAI,CAAC,OAAO,SAAS,CAAC,KAAK,KAAK,GAAG,OAAO;CAC1C,OAAO,KAAK,IAAI,GAAG,UAAU;AAC/B;AAEA,SAAS,aAAa,KAA4B;CAChD,IAAI,CAAC,KAAK,OAAO;CACjB,MAAM,IAAI,SAAS,KAAK,EAAE;CAC1B,IAAI,CAAC,OAAO,SAAS,CAAC,KAAK,KAAK,GAAG,OAAO;CAC1C,OAAO,KAAK,IAAI,GAAG,aAAa;AAClC;AAEA,SAAS,cAAc,KAAoB,cAAgC;CACzE,IAAI,QAAQ,MAAM,OAAO;CACzB,MAAM,IAAI,IAAI,YAAY;CAC1B,IAAI,MAAM,UAAU,MAAM,OAAO,MAAM,OAAO,OAAO;CACrD,IAAI,MAAM,WAAW,MAAM,OAAO,MAAM,MAAM,OAAO;CACrD,OAAO;AACT;;;;;;;;;;AAWA,SAAgB,+BACd,SACA,WAC4B;CAE5B,IAAI,CAAC,UAAU,UAAU,SACvB,QAAQ,MAAM,MAAM,SAAS,KAAK;CAGpC,MAAM,OAAO,wBAAwB,aAAa,SAAS;CAC3D,MAAM,UAAU,QAAQ,OAAO;CAC/B,QAAQ,IAAI,qBAAqB,SAAS,CAAC;CAC3C,QAAQ,IAAI,IAAI;CAChB,QAAQ,KAAK,KAAK,QAAQ;EACxB,QAAa,KAAK,KAAK,OAAO;CAChC,CAAC;CAED,QAAQ,KAAsB,KAAqB,SAA+B;EAChF,IAAI,IAAI,WAAW,SAAS,IAAI,WAAW,QAAQ;GACjD,KAAK;GACL;EACF;EAIA,KAFY,IAAI,OAAO,IAAA,CACF,MAAM,GAAG,CAAC,CAAC,OAAA,0BACO;GACrC,KAAK;GACL;EACF;EAGA,QAAQ,KAAwB,KAAyB,IAAI;CAC/D;CAEA,eAAe,QACb,KACA,KACA,GACe;EACf,IAAI;GACF,MAAM,WAAW,EAAE,mBAAmB;GACtC,MAAM,SAAS,IAAI,iBAAiB,IAAI,OAAO,GAAA,CAAI,MAAM,GAAG,CAAC,CAAC,MAAM,EAAE;GACtE,MAAM,eAAe,kBAAkB,OAAO,IAAI,QAAQ,CAAC;GAC3D,MAAM,QAAQ,WAAW,OAAO,IAAI,OAAO,CAAC;GAC5C,MAAM,YAAY,cAAc,OAAO,IAAI,IAAI,GAAG,IAAI;GACtD,MAAM,UAAU,aAAa,OAAO,IAAI,SAAS,CAAC;GAElD,MAAM,WACJ,iBAAiB,QACb,SAAS,UACT,SAAS,QAAQ,QAAO,MAAK,EAAE,WAAW,YAAY;GAK5D,MAAM,UADS,CAAC,GAAG,QAAQ,CAAC,CAAC,MAAM,GAAG,MAAM,EAAE,aAAa,EAAE,UAC7C,CAAA,CAAO,MAAM,GAAG,KAAK;GAErC,MAAM,sBAAsB,CAAC,GAAG,SAAS,aAAa,CAAC,CAAC,MACrD,GAAG,MAAM,EAAE,oBAAoB,EAAE,iBACpC;GAGA,MAAM,UACJ,aAAa,SAAS,YAAY,WAAW,MAAM,EAAE,gBAAgB,OAAO,IAAI,CAAC;GAEnF,MAAM,OAAO,KAAK,UAChB;IACE,KAAK,SAAS;IACd,SAAS,SAAS;IAClB,MAAM,SAAS;IACf,KAAK,SAAS;IACd,QAAQ;KAAE,QAAQ;KAAc;KAAO,IAAI;KAAW;IAAQ;IAC9D,UAAU,SAAS;IACnB,SAAS;IACT,eAAe;IACf,IAAI;KAAE,SAAS,QAAQ;KAAQ,OAAO;IAAQ;GAChD,GACA,MACA,CACF;GAEA,IAAI,IAAI,aAAa;GACrB,IAAI,aAAa;GACjB,IAAI,UAAU,gBAAgB,iCAAiC;GAC/D,IAAI,UAAU,iBAAiB,UAAU;GACzC,IAAI,IAAI,IAAI;EACd,SAAS,KAAK;GACZ,IAAI,IAAI,aAAa;GACrB,IAAI,aAAa;GACjB,IAAI,UAAU,gBAAgB,iCAAiC;GAC/D,IAAI,IAAI,KAAK,UAAU,EAAE,OAAQ,IAAc,QAAQ,CAAC,CAAC;EAC3D;CACF;AACF"}
|
|
@@ -1615,7 +1615,7 @@ function resolveFetchHandler(module) {
|
|
|
1615
1615
|
}
|
|
1616
1616
|
var package_default = {
|
|
1617
1617
|
name: "isr-engine",
|
|
1618
|
-
version: "4.
|
|
1618
|
+
version: "4.4.0",
|
|
1619
1619
|
description: "ISR/SSG/Fallback rendering orchestration on Vite + React 19 RSC.",
|
|
1620
1620
|
license: "UNLICENSED",
|
|
1621
1621
|
repository: {
|
|
@@ -4961,7 +4961,7 @@ function createIsrCacheMiddleware(explicitConfig, options = {}) {
|
|
|
4961
4961
|
development: true
|
|
4962
4962
|
}));
|
|
4963
4963
|
try {
|
|
4964
|
-
const inspector = opsConfig.inventory.enabled ? (await import("./createCacheInspectorMiddleware-
|
|
4964
|
+
const inspector = opsConfig.inventory.enabled ? (await import("./createCacheInspectorMiddleware-DUYq46J4.js")).createCacheInspectorMiddleware(nextHandler, opsConfig) : void 0;
|
|
4965
4965
|
handler = nextHandler;
|
|
4966
4966
|
server.middlewares.use((req, res, next) => {
|
|
4967
4967
|
if (handler !== nextHandler) return next();
|
|
@@ -7620,7 +7620,7 @@ async function createProductionRuntime(config, options = {}) {
|
|
|
7620
7620
|
});
|
|
7621
7621
|
cleanups.push(() => cache.destroy());
|
|
7622
7622
|
if (opsConfig.inventory.enabled) {
|
|
7623
|
-
const { createCacheInspectorMiddleware } = await import("./createCacheInspectorMiddleware-
|
|
7623
|
+
const { createCacheInspectorMiddleware } = await import("./createCacheInspectorMiddleware-DUYq46J4.js");
|
|
7624
7624
|
app.use(createCacheInspectorMiddleware(cache, opsConfig));
|
|
7625
7625
|
logger$8.info("🔍 ISR cache inventory 已启用:GET /__isr/cache/inventory");
|
|
7626
7626
|
}
|
|
@@ -8536,4 +8536,4 @@ async function createISRApp(appOption) {
|
|
|
8536
8536
|
}
|
|
8537
8537
|
export { parseComponents as $, invalidatorRunsTotal as A, InternalStrategies as B, createCoherentCacheStore as C, loadConfig as D, getOpsRequestLimiter as E, getFallbackChain as F, DEFAULT_PORT as G, extractSsgRoutes as H, getRouteFallbackChain as I, DEFAULT_SCAN_CONFIG as J, package_default as K, matchRoutePattern as L, recordHttpRequest as M, createHybridCacheStore as N, createPrometheusMetricsMiddleware as O, createMemoryCacheStore as P, parseComponentFromFile as Q, resolveRenderMode as R, MemoryCacheAdapter as S, createOpsAuthMiddleware as T, spiderSsgRoutes as U, RenderModes as V, logger$8 as W, scanProject as X, scanComponents as Y, scanRoutes as Z, requestPinnedImage as _, closeServer as a, isDev as at, RedisInvalidationBus as b, prepareProductionBuild as c, CacheCleanup as ct, SEOEngine as d, parseRouteFromFile as et, createSEOEngine as f, createImagePlugin as g, createImageMiddleware as h, startAppServer as i, readDirRecursive as it, promRegistry as j, invalidatorFailuresTotal as k, generateStaticCspManifest as l, Logger as lt, mergeSEOConfig as m, ISREngine as n, isCodeFile as nt, startServer as o, isProd as ot, DEFAULT_SEO_CONFIG as p, resolveFetchHandler as q, shutdownServer as r, isTestFile as rt, createProductionRuntime as s, getEnv as st, createISRApp as t, parseRoutes as tt, createABVariantMiddleware as u, resolveImageOptions as ut, createIsrCacheHandler as v, createDevAssetRequestMiddleware as w, RedisCacheAdapter as x, createIsrCacheMiddleware as y, FallbackChain as z };
|
|
8538
8538
|
|
|
8539
|
-
//# sourceMappingURL=createISRApp-
|
|
8539
|
+
//# sourceMappingURL=createISRApp-yBEBvYD5.js.map
|