@hile/model 2.0.2 → 3.0.1

package/README.md

@@ -101,9 +101,26 @@ const model = defineModel({
 
 - 通过 `ctx.args` 改写入参
 - 通过 `ctx.state` 在中间件间传递数据
-- 不调 `next()` 可短路，`main` 不会执行
+- `main` 的返回值会写入 `ctx.state.result`，`defineModel().handler()` 最终返回 `ctx.state.result`
+- 不调 `next()` 可短路，`main` 不会执行；只要 middleware 写入 `ctx.state.result`，`handler()` 就会返回这个值
+- `await next()` 后可改写 `ctx.state.result`，用于统一响应包装、缓存、幂等、审计等横切逻辑
 - 最后一个中间件不应调 `next()`
 
+短路示例：
+
+```typescript
+const cacheMiddleware: PipelineMiddleware<{ id: string }> = async (ctx, next) => {
+  const cached = await readCachedUser(ctx.args.id)
+  if (cached) {
+    ctx.state.result = cached
+    return
+  }
+
+  await next()
+  await writeCachedUser(ctx.args.id, ctx.state.result)
+}
+```
+
 ### 函数简写
 
 无 services 和 pipelines 时可直接传入 `main`：

package/dist/model.js

@@ -34,15 +34,14 @@ export function defineModel(optionsOrMain) {
         if (pipelines !== undefined && pipelines.length > 0) {
             const ctx = new PipelineContext(input);
             const chain = new Pipeline();
-            let result;
             for (const middleware of pipelines) {
                 chain.use(middleware);
             }
             chain.use(async (ctx) => {
-                result = await invokeMain(ctx.args);
+                ctx.state.result = await invokeMain(ctx.args);
             });
             await chain.dispatch(ctx);
-            return result;
+            return ctx.state.result;
         }
         return invokeMain(input);
     };

package/dist/model.test.js

@@ -79,6 +79,52 @@ describe('defineModel', () => {
         });
         await expect(m.handler({ id: 1 })).resolves.toBe(99);
     });
+    it('pipeline middleware 可短路并返回 ctx.state.result', async () => {
+        let mainCalled = false;
+        const m = defineModel({
+            pipelines: [
+                async (ctx) => {
+                    ctx.state.result = `cached-${ctx.args.id}`;
+                },
+            ],
+            async main(input) {
+                mainCalled = true;
+                return input.id;
+            },
+        });
+        await expect(m.handler({ id: 1 })).resolves.toBe('cached-1');
+        expect(mainCalled).toBe(false);
+    });
+    it('pipeline middleware 可在 main 后改写 ctx.state.result', async () => {
+        const m = defineModel({
+            pipelines: [
+                async (ctx, next) => {
+                    await next();
+                    ctx.state.result = ctx.state.result * 2;
+                },
+            ],
+            async main(input) {
+                return input.id + 1;
+            },
+        });
+        await expect(m.handler({ id: 3 })).resolves.toBe(8);
+    });
+    it('pipeline middleware 短路但未写 result 时返回 undefined', async () => {
+        let mainCalled = false;
+        const m = defineModel({
+            pipelines: [
+                async () => {
+                    // intentionally short-circuit without result
+                },
+            ],
+            async main(input) {
+                mainCalled = true;
+                return input.id;
+            },
+        });
+        await expect(m.handler({ id: 1 })).resolves.toBeUndefined();
+        expect(mainCalled).toBe(false);
+    });
     it('loadModel 调用 handler', async () => {
         const m = defineModel({
             services: [A],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hile/model",
-  "version": "2.0.2",
+  "version": "3.0.1",
   "type": "module",
   "main": "./dist/index.js",
   "scripts": {
@@ -22,7 +22,7 @@
     "vitest": "^4.0.18"
   },
   "dependencies": {
-    "@hile/core": "^2.0.1"
+    "@hile/core": "^2.1.1"
   },
-  "gitHead": "2c8011db01f2815e5ce34de964d5492640396828"
+  "gitHead": "ffc9f14ed2591075290c77c1bcc0afc67ecf1794"
 }