@pikku/core 0.12.78 → 0.12.80

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.
Files changed (341) hide show
  1. package/CHANGELOG.md +234 -0
  2. package/dist/dev/hot-reload.js +1 -6
  3. package/dist/ecosystem.d.ts +27 -0
  4. package/dist/ecosystem.js +26 -0
  5. package/dist/errors/error-handler.js +4 -2
  6. package/dist/function/function-runner.js +20 -42
  7. package/dist/function/functions.types.d.ts +9 -5
  8. package/dist/index.d.ts +4 -9
  9. package/dist/index.js +3 -8
  10. package/dist/middleware/auth-cookie.d.ts +0 -4
  11. package/dist/middleware/auth-cookie.js +38 -2
  12. package/dist/middleware/cors.js +1 -0
  13. package/dist/middleware/index.d.ts +1 -1
  14. package/dist/middleware/index.js +1 -1
  15. package/dist/middleware/remote-auth.js +14 -3
  16. package/dist/permissions.d.ts +8 -10
  17. package/dist/permissions.js +0 -11
  18. package/dist/pikku-state.js +12 -5
  19. package/dist/schema.js +35 -1
  20. package/dist/services/ai-run-state-service.d.ts +7 -1
  21. package/dist/services/in-memory-ai-run-state-service.d.ts +1 -1
  22. package/dist/services/in-memory-ai-run-state-service.js +2 -1
  23. package/dist/services/in-memory-workflow-service.d.ts +10 -0
  24. package/dist/services/in-memory-workflow-service.js +25 -0
  25. package/dist/services/local-content-request-handler.d.ts +21 -0
  26. package/dist/services/local-content-request-handler.js +72 -53
  27. package/dist/services/local-content.d.ts +6 -0
  28. package/dist/services/local-content.js +14 -1
  29. package/dist/services/workflow-service.d.ts +4 -2
  30. package/dist/testing/service-tests/agent-run-service-tests.d.ts +10 -0
  31. package/dist/testing/service-tests/agent-run-service-tests.js +72 -0
  32. package/dist/testing/service-tests/ai-storage-service-tests.d.ts +3 -0
  33. package/dist/testing/service-tests/ai-storage-service-tests.js +226 -0
  34. package/dist/testing/service-tests/channel-store-tests.d.ts +3 -0
  35. package/dist/testing/service-tests/channel-store-tests.js +72 -0
  36. package/dist/testing/service-tests/credential-service-tests.d.ts +3 -0
  37. package/dist/testing/service-tests/credential-service-tests.js +109 -0
  38. package/dist/testing/service-tests/deployment-service-tests.d.ts +3 -0
  39. package/dist/testing/service-tests/deployment-service-tests.js +21 -0
  40. package/dist/testing/service-tests/event-hub-store-tests.d.ts +3 -0
  41. package/dist/testing/service-tests/event-hub-store-tests.js +34 -0
  42. package/dist/testing/service-tests/secret-service-tests.d.ts +3 -0
  43. package/dist/testing/service-tests/secret-service-tests.js +80 -0
  44. package/dist/testing/service-tests/session-store-tests.d.ts +3 -0
  45. package/dist/testing/service-tests/session-store-tests.js +43 -0
  46. package/dist/testing/service-tests/workflow-run-service-tests.d.ts +3 -0
  47. package/dist/testing/service-tests/workflow-run-service-tests.js +42 -0
  48. package/dist/testing/service-tests/workflow-service-tests.d.ts +3 -0
  49. package/dist/testing/service-tests/workflow-service-tests.js +150 -0
  50. package/dist/testing/service-tests.d.ts +6 -0
  51. package/dist/testing/service-tests.js +26 -791
  52. package/dist/types/core.types.d.ts +11 -1
  53. package/dist/types/state.types.d.ts +1 -1
  54. package/dist/utils/node-host-resolver.d.ts +12 -0
  55. package/dist/utils/node-host-resolver.js +16 -0
  56. package/dist/utils/safe-fetch.d.ts +18 -0
  57. package/dist/utils/safe-fetch.js +167 -29
  58. package/dist/wirings/actor-flow/run-conversation.js +1 -6
  59. package/dist/wirings/ai-agent/agent-rpc.d.ts +15 -0
  60. package/dist/wirings/ai-agent/agent-rpc.js +53 -0
  61. package/dist/wirings/ai-agent/ai-agent-agui.js +1 -5
  62. package/dist/wirings/ai-agent/ai-agent-memory.js +3 -1
  63. package/dist/wirings/ai-agent/ai-agent-prepare.js +3 -9
  64. package/dist/wirings/ai-agent/ai-agent-runner.js +28 -107
  65. package/dist/wirings/ai-agent/ai-agent-stream.js +20 -61
  66. package/dist/wirings/ai-agent/ai-agent-turn.d.ts +56 -0
  67. package/dist/wirings/ai-agent/ai-agent-turn.js +81 -0
  68. package/dist/wirings/ai-agent/ai-agent.types.d.ts +1 -1
  69. package/dist/wirings/ai-agent/voice-input.js +1 -6
  70. package/dist/wirings/ai-agent/voice-output.js +2 -12
  71. package/dist/wirings/channel/channel-common.js +1 -0
  72. package/dist/wirings/channel/channel-handler.js +3 -5
  73. package/dist/wirings/channel/channel-rpc-service.d.ts +0 -6
  74. package/dist/wirings/channel/channel-rpc-service.js +0 -8
  75. package/dist/wirings/channel/channel-rpc.types.d.ts +6 -0
  76. package/dist/wirings/channel/channel-rpc.types.js +8 -0
  77. package/dist/wirings/channel/channel-runner.d.ts +1 -3
  78. package/dist/wirings/channel/channel-runner.js +16 -8
  79. package/dist/wirings/channel/channel.types.d.ts +2 -0
  80. package/dist/wirings/channel/pikku-abstract-channel-handler.js +1 -0
  81. package/dist/wirings/channel/serverless/serverless-channel-runner.js +3 -0
  82. package/dist/wirings/cli/channel/cli-channel-runner.js +2 -0
  83. package/dist/wirings/cli/cli-runner.js +4 -2
  84. package/dist/wirings/cli/cli.types.d.ts +0 -8
  85. package/dist/wirings/cli/command-parser.js +13 -0
  86. package/dist/wirings/gateway/gateway-runner.js +41 -5
  87. package/dist/wirings/http/http-routes.js +2 -0
  88. package/dist/wirings/http/http-runner.d.ts +0 -10
  89. package/dist/wirings/http/http-runner.js +6 -13
  90. package/dist/wirings/http/http.types.d.ts +0 -10
  91. package/dist/wirings/http/index.d.ts +1 -1
  92. package/dist/wirings/http/index.js +1 -1
  93. package/dist/wirings/mcp/mcp-runner.d.ts +0 -7
  94. package/dist/wirings/mcp/mcp-runner.js +0 -6
  95. package/dist/wirings/rpc/rpc-runner.d.ts +8 -51
  96. package/dist/wirings/rpc/rpc-runner.js +53 -86
  97. package/dist/wirings/rpc/rpc-types.d.ts +3 -0
  98. package/dist/wirings/secret/validate-secret-definitions.js +2 -0
  99. package/dist/wirings/trigger/pikku-trigger-service.d.ts +0 -4
  100. package/dist/wirings/trigger/trigger-runner.js +1 -0
  101. package/dist/wirings/virtual-user/run-virtual-user.js +11 -11
  102. package/dist/wirings/virtual-user/virtual-user-derive.js +4 -25
  103. package/dist/wirings/virtual-user/virtual-user-dispositions.js +1 -4
  104. package/dist/wirings/workflow/dsl/workflow-dsl.types.d.ts +29 -2
  105. package/dist/wirings/workflow/feature.js +7 -4
  106. package/dist/wirings/workflow/graph/graph-runner.d.ts +1 -2
  107. package/dist/wirings/workflow/graph/graph-runner.js +8 -7
  108. package/dist/wirings/workflow/graph/workflow-graph.types.d.ts +0 -4
  109. package/dist/wirings/workflow/index.d.ts +7 -2
  110. package/dist/wirings/workflow/index.js +5 -1
  111. package/dist/wirings/workflow/pikku-scenario-service.d.ts +17 -3
  112. package/dist/wirings/workflow/pikku-scenario-service.js +38 -10
  113. package/dist/wirings/workflow/pikku-workflow-service.d.ts +44 -111
  114. package/dist/wirings/workflow/pikku-workflow-service.js +86 -404
  115. package/dist/wirings/workflow/workflow-approval.d.ts +39 -0
  116. package/dist/wirings/workflow/workflow-approval.js +114 -0
  117. package/dist/wirings/workflow/workflow-constants.d.ts +26 -0
  118. package/dist/wirings/workflow/workflow-constants.js +35 -0
  119. package/dist/wirings/workflow/workflow-errors.d.ts +58 -0
  120. package/dist/wirings/workflow/workflow-errors.js +112 -0
  121. package/dist/wirings/workflow/workflow-meta-resolver.d.ts +11 -0
  122. package/dist/wirings/workflow/workflow-meta-resolver.js +31 -0
  123. package/dist/wirings/workflow/workflow-queue-routing.d.ts +8 -0
  124. package/dist/wirings/workflow/workflow-queue-routing.js +38 -0
  125. package/dist/wirings/workflow/workflow-queue-wiring.d.ts +20 -0
  126. package/dist/wirings/workflow/workflow-queue-wiring.js +79 -0
  127. package/dist/wirings/workflow/workflow-recovery.d.ts +68 -0
  128. package/dist/wirings/workflow/workflow-recovery.js +101 -0
  129. package/dist/wirings/workflow/workflow-run-engine.types.d.ts +54 -0
  130. package/dist/wirings/workflow/workflow-run-engine.types.js +1 -0
  131. package/dist/wirings/workflow/workflow-run-ownership.d.ts +16 -0
  132. package/dist/wirings/workflow/workflow-run-ownership.js +29 -0
  133. package/dist/wirings/workflow/workflow-suspend.d.ts +12 -0
  134. package/dist/wirings/workflow/workflow-suspend.js +33 -0
  135. package/dist/wirings/workflow/workflow.types.d.ts +7 -0
  136. package/knowledge/decisions/internals/a-non-streaming-agent-run-registers-with-airunstate-too.md +22 -0
  137. package/knowledge/decisions/internals/a-resumed-agent-turn-is-as-interruptible-as-the-first.md +20 -0
  138. package/knowledge/decisions/internals/a-scenario-step-template-is-offered-unfilled.md +21 -0
  139. package/knowledge/decisions/internals/a-virtual-user-decides-whether-to-trust-memory-once-per-turn.md +21 -0
  140. package/knowledge/decisions/internals/a-wall-clock-threshold-is-a-load-test-in-disguise.md +46 -0
  141. package/knowledge/decisions/internals/a-workflow-wire-is-built-from-the-run-not-from-the-rpc-service.md +45 -0
  142. package/knowledge/decisions/internals/agent-context-waits-for-a-tool-result-still-being-written.md +21 -0
  143. package/knowledge/decisions/internals/agent-speech-travels-as-a-custom-agui-event.md +22 -0
  144. package/knowledge/decisions/internals/an-agent-interrupt-is-not-a-failure.md +23 -0
  145. package/knowledge/decisions/internals/an-agent-run-owned-by-another-instance-says-so.md +25 -0
  146. package/knowledge/decisions/internals/an-agent-stream-send-must-return-the-inner-sends-promise.md +22 -0
  147. package/knowledge/decisions/internals/an-empty-text-part-is-omitted-from-an-agent-message.md +20 -0
  148. package/knowledge/decisions/internals/an-empty-transcript-is-not-recorded.md +22 -0
  149. package/knowledge/decisions/internals/an-unref-d-timer-cannot-be-awaited-under-node-test.md +66 -0
  150. package/knowledge/decisions/internals/channel-state-accessors-are-unsound-generics-that-every-implementation-asserts.md +33 -0
  151. package/knowledge/decisions/internals/gateway-listener-middleware-runs-without-an-rpc-on-the-wire.md +43 -0
  152. package/knowledge/decisions/internals/hot-reload-writes-into-the-function-map-captured-at-startup.md +26 -0
  153. package/knowledge/decisions/internals/index.md +38 -26
  154. package/knowledge/decisions/internals/only-exposed-functions-enter-a-virtual-user-catalogue.md +21 -0
  155. package/knowledge/decisions/internals/scenario-given-and-when-are-sugar-but-then-is-not.md +24 -0
  156. package/knowledge/decisions/internals/side-effects-are-an-allowlist-not-a-boolean.md +34 -0
  157. package/knowledge/decisions/internals/speech-synthesis-picks-a-voice-per-sentence-and-warns-once.md +24 -0
  158. package/knowledge/decisions/internals/the-actor-prompt-says-json-because-of-json-object-mode.md +22 -0
  159. package/knowledge/decisions/internals/the-agent-done-event-goes-through-the-middleware-and-is-awaited.md +26 -0
  160. package/knowledge/decisions/internals/the-api-report-pins-members-not-just-names.md +43 -0
  161. package/knowledge/decisions/internals/the-ecosystem-entry-point-carries-the-adapter-surface.md +58 -0
  162. package/knowledge/decisions/internals/the-middleware-resolution-cache-is-deliberately-unbounded.md +40 -0
  163. package/knowledge/decisions/internals/the-per-invocation-rpc-view-is-a-class.md +40 -0
  164. package/knowledge/decisions/internals/the-persona-runtime-is-exported-from-the-persona-entry-point.md +28 -0
  165. package/knowledge/decisions/internals/the-transcript-event-is-sent-ahead-of-the-run.md +25 -0
  166. package/knowledge/decisions/internals/the-virtual-user-catalogue-is-the-only-gate-on-what-may-be-called.md +21 -0
  167. package/knowledge/decisions/internals/the-worker-disposition-is-the-one-that-is-not-testing.md +22 -0
  168. package/knowledge/decisions/internals/thread-history-records-the-transcript-not-the-audio.md +25 -0
  169. package/knowledge/decisions/internals/virtual-user-step-order-comes-from-insertion-order.md +21 -0
  170. package/knowledge/decisions/internals/voice-output-speaks-unless-voice-input-explicitly-says-otherwise.md +24 -0
  171. package/knowledge/decisions/internals/wiring-registries-erase-the-generics-their-wire-functions-capture.md +35 -0
  172. package/knowledge/decisions/security/a-dropped-audit-write-is-always-logged.md +4 -2
  173. package/knowledge/decisions/security/a-graph-run-starts-at-an-entry-node-the-graph-declared.md +33 -0
  174. package/knowledge/decisions/security/a-permission-gets-a-wire-it-cannot-reply-on.md +33 -0
  175. package/knowledge/decisions/security/a-step-runs-the-function-the-workflow-dispatched-it-with.md +37 -0
  176. package/knowledge/decisions/security/a-virtual-user-is-never-offered-a-step-that-would-forge-its-own-oracle.md +28 -0
  177. package/knowledge/decisions/security/a-workflow-run-is-read-and-approved-by-its-owner.md +34 -0
  178. package/knowledge/decisions/security/an-agent-approval-is-claimed-before-the-tool-runs.md +33 -0
  179. package/knowledge/decisions/security/an-upload-is-counted-as-it-arrives-not-buffered-then-measured.md +24 -0
  180. package/knowledge/decisions/security/gateway-handlers-run-through-the-function-runner-gate.md +13 -3
  181. package/knowledge/decisions/security/index.md +7 -0
  182. package/knowledge/questions/channel-middleware-accepts-bare-factories-that-nothing-resolves.md +35 -0
  183. package/knowledge/questions/index.md +2 -1
  184. package/knowledge/questions/unauthorized-channel-replies-escape-the-declared-out-type.md +44 -0
  185. package/package.json +14 -3
  186. package/scripts/generate-api-report.d.mts +1 -0
  187. package/scripts/generate-api-report.mjs +89 -0
  188. package/scripts/generate-api-report.mts +218 -0
  189. package/src/api-report.test.ts +69 -0
  190. package/src/column-form.ts +1 -4
  191. package/src/crypto-utils.test.ts +15 -2
  192. package/src/dev/hot-reload.ts +2 -7
  193. package/src/ecosystem.ts +40 -0
  194. package/src/errors/error-handler.ts +5 -3
  195. package/src/errors/error.test.ts +4 -1
  196. package/src/function/function-runner.test.ts +1 -1
  197. package/src/function/function-runner.ts +28 -39
  198. package/src/function/functions.types.ts +15 -9
  199. package/src/handle-error.ts +1 -1
  200. package/src/index.ts +3 -22
  201. package/src/middleware/auth-cookie.test.ts +50 -0
  202. package/src/middleware/auth-cookie.ts +38 -2
  203. package/src/middleware/cors.ts +2 -1
  204. package/src/middleware/index.ts +1 -1
  205. package/src/middleware/remote-auth.test.ts +43 -0
  206. package/src/middleware/remote-auth.ts +17 -3
  207. package/src/middleware-runner.ts +4 -2
  208. package/src/no-any-casts.test.ts +57 -0
  209. package/src/permissions.test.ts +3 -1
  210. package/src/permissions.ts +22 -24
  211. package/src/pikku-state.ts +17 -6
  212. package/src/public-surface.json +578 -0
  213. package/src/public-surface.json.README +25 -0
  214. package/src/public-surface.test.ts +105 -0
  215. package/src/removed-legacy-exports.test.ts +62 -0
  216. package/src/schema.test.ts +78 -0
  217. package/src/schema.ts +36 -1
  218. package/src/services/ai-run-state-service.ts +7 -1
  219. package/src/services/audit-service.ts +2 -2
  220. package/src/services/in-memory-ai-run-state-service.ts +3 -2
  221. package/src/services/in-memory-workflow-service.ts +25 -0
  222. package/src/services/index.ts +1 -4
  223. package/src/services/local-content-request-handler.test.ts +43 -5
  224. package/src/services/local-content-request-handler.ts +103 -74
  225. package/src/services/local-content.ts +15 -1
  226. package/src/services/local-email-service.ts +5 -1
  227. package/src/services/system-role-guard.test.ts +4 -1
  228. package/src/services/workflow-service.ts +9 -2
  229. package/src/side-effects-are-declared.test.ts +84 -0
  230. package/src/source-files-stay-composable.test.ts +41 -0
  231. package/src/testing/service-tests/agent-run-service-tests.ts +98 -0
  232. package/src/testing/service-tests/ai-storage-service-tests.ts +286 -0
  233. package/src/testing/service-tests/channel-store-tests.ts +98 -0
  234. package/src/testing/service-tests/credential-service-tests.ts +143 -0
  235. package/src/testing/service-tests/deployment-service-tests.ts +33 -0
  236. package/src/testing/service-tests/event-hub-store-tests.ts +48 -0
  237. package/src/testing/service-tests/secret-service-tests.ts +105 -0
  238. package/src/testing/service-tests/session-store-tests.ts +62 -0
  239. package/src/testing/service-tests/workflow-run-service-tests.ts +59 -0
  240. package/src/testing/service-tests/workflow-service-tests.ts +308 -0
  241. package/src/testing/service-tests.ts +31 -1111
  242. package/src/types/core.types.ts +15 -1
  243. package/src/types/state.types.ts +1 -1
  244. package/src/utils/node-host-resolver.ts +20 -0
  245. package/src/utils/safe-fetch.test.ts +143 -1
  246. package/src/utils/safe-fetch.ts +200 -25
  247. package/src/wirings/actor-flow/run-conversation.ts +1 -6
  248. package/src/wirings/ai-agent/agent-rpc.ts +120 -0
  249. package/src/wirings/ai-agent/ai-agent-agui.ts +1 -5
  250. package/src/wirings/ai-agent/ai-agent-interrupt.test.ts +2 -1
  251. package/src/wirings/ai-agent/ai-agent-memory.ts +8 -1
  252. package/src/wirings/ai-agent/ai-agent-prepare.ts +10 -12
  253. package/src/wirings/ai-agent/ai-agent-resume-authorization.test.ts +1 -0
  254. package/src/wirings/ai-agent/ai-agent-runner.test.ts +82 -2
  255. package/src/wirings/ai-agent/ai-agent-runner.ts +49 -120
  256. package/src/wirings/ai-agent/ai-agent-stream.test.ts +2 -0
  257. package/src/wirings/ai-agent/ai-agent-stream.ts +36 -63
  258. package/src/wirings/ai-agent/ai-agent-thread-ownership.test.ts +1 -1
  259. package/src/wirings/ai-agent/ai-agent-turn.ts +121 -0
  260. package/src/wirings/ai-agent/ai-agent.types.ts +1 -1
  261. package/src/wirings/ai-agent/voice-input.ts +1 -6
  262. package/src/wirings/ai-agent/voice-output.ts +2 -12
  263. package/src/wirings/channel/channel-common.ts +5 -2
  264. package/src/wirings/channel/channel-handler-shapes.test.ts +72 -0
  265. package/src/wirings/channel/channel-handler.ts +7 -7
  266. package/src/wirings/channel/channel-rpc-service.ts +0 -14
  267. package/src/wirings/channel/channel-rpc.test.ts +25 -4
  268. package/src/wirings/channel/channel-rpc.types.ts +14 -0
  269. package/src/wirings/channel/channel-runner.ts +33 -20
  270. package/src/wirings/channel/channel.types.ts +2 -0
  271. package/src/wirings/channel/local/local-channel-runner.ts +1 -1
  272. package/src/wirings/channel/pikku-abstract-channel-handler.ts +2 -1
  273. package/src/wirings/channel/serverless/serverless-channel-runner.ts +6 -3
  274. package/src/wirings/cli/channel/cli-channel-runner.ts +3 -1
  275. package/src/wirings/cli/channel/cli-raw-client-runner.ts +4 -1
  276. package/src/wirings/cli/cli-runner.ts +7 -4
  277. package/src/wirings/cli/cli.types.ts +0 -39
  278. package/src/wirings/cli/command-parser.test.ts +19 -0
  279. package/src/wirings/cli/command-parser.ts +17 -1
  280. package/src/wirings/gateway/gateway-authorization.test.ts +131 -0
  281. package/src/wirings/gateway/gateway-channel-meta.test.ts +44 -0
  282. package/src/wirings/gateway/gateway-runner.ts +62 -22
  283. package/src/wirings/http/http-routes.ts +4 -1
  284. package/src/wirings/http/http-runner.ts +11 -26
  285. package/src/wirings/http/http.types.ts +0 -15
  286. package/src/wirings/http/index.ts +1 -7
  287. package/src/wirings/http/pikku-fetch-http-request.ts +2 -2
  288. package/src/wirings/http/web-request.ts +1 -1
  289. package/src/wirings/mcp/mcp-runner.ts +2 -16
  290. package/src/wirings/persona/persona-environments.test.ts +14 -3
  291. package/src/wirings/persona/persona.test.ts +13 -3
  292. package/src/wirings/persona/validate-personas.ts +5 -1
  293. package/src/wirings/queue/queue-runner.ts +1 -1
  294. package/src/wirings/rpc/addon-auth-tags.test.ts +1 -5
  295. package/src/wirings/rpc/rpc-runner.ts +58 -136
  296. package/src/wirings/rpc/rpc-types.ts +7 -0
  297. package/src/wirings/rpc/wire-addon.ts +3 -1
  298. package/src/wirings/secret/validate-secret-definitions.test.ts +69 -0
  299. package/src/wirings/secret/validate-secret-definitions.ts +2 -0
  300. package/src/wirings/trigger/pikku-trigger-service.ts +0 -5
  301. package/src/wirings/trigger/trigger-runner.ts +7 -5
  302. package/src/wirings/virtual-user/run-virtual-user.test.ts +18 -9
  303. package/src/wirings/virtual-user/run-virtual-user.ts +28 -15
  304. package/src/wirings/virtual-user/virtual-user-agents.test.ts +4 -1
  305. package/src/wirings/virtual-user/virtual-user-derive.ts +4 -25
  306. package/src/wirings/virtual-user/virtual-user-dispositions.test.ts +7 -2
  307. package/src/wirings/virtual-user/virtual-user-dispositions.ts +1 -4
  308. package/src/wirings/virtual-user/virtual-user-intents.test.ts +13 -3
  309. package/src/wirings/workflow/dsl/workflow-dsl.types.ts +35 -2
  310. package/src/wirings/workflow/feature.ts +7 -4
  311. package/src/wirings/workflow/graph/graph-node.ts +1 -1
  312. package/src/wirings/workflow/graph/graph-runner.test.ts +4 -2
  313. package/src/wirings/workflow/graph/graph-runner.ts +13 -16
  314. package/src/wirings/workflow/graph/workflow-graph.types.ts +0 -5
  315. package/src/wirings/workflow/index.ts +12 -4
  316. package/src/wirings/workflow/pikku-scenario-service.ts +54 -25
  317. package/src/wirings/workflow/pikku-workflow-service.test.ts +2 -2
  318. package/src/wirings/workflow/pikku-workflow-service.ts +208 -630
  319. package/src/wirings/workflow/scenario-hooks.test.ts +51 -0
  320. package/src/wirings/workflow/workflow-approval.ts +185 -0
  321. package/src/wirings/workflow/workflow-child-run-session.test.ts +89 -0
  322. package/src/wirings/workflow/workflow-constants.ts +47 -0
  323. package/src/wirings/workflow/workflow-dispatch-durability.test.ts +1 -1
  324. package/src/wirings/workflow/workflow-dispatch-relay.test.ts +128 -0
  325. package/src/wirings/workflow/workflow-errors.ts +128 -0
  326. package/src/wirings/workflow/workflow-inline-authority.test.ts +12 -6
  327. package/src/wirings/workflow/workflow-meta-resolver.ts +45 -0
  328. package/src/wirings/workflow/workflow-missing-meta.test.ts +92 -0
  329. package/src/wirings/workflow/workflow-queue-routing.ts +85 -0
  330. package/src/wirings/workflow/workflow-queue-wiring.ts +149 -0
  331. package/src/wirings/workflow/workflow-recovery.ts +162 -0
  332. package/src/wirings/workflow/workflow-retry-policy.test.ts +1 -1
  333. package/src/wirings/workflow/workflow-run-authority.test.ts +215 -0
  334. package/src/wirings/workflow/workflow-run-engine.types.ts +91 -0
  335. package/src/wirings/workflow/workflow-run-ownership.ts +36 -0
  336. package/src/wirings/workflow/workflow-suspend.ts +61 -0
  337. package/src/wirings/workflow/workflow.types.ts +7 -0
  338. package/src/wirings-stay-decoupled.test.ts +123 -0
  339. package/tsconfig.json +1 -1
  340. package/tsconfig.tsbuildinfo +1 -1
  341. package/src/internal.ts +0 -10
@@ -0,0 +1,114 @@
1
+ import { getDurationInMilliseconds } from '../../time-utils.js';
2
+ import { WorkflowApprovalResolvedError, WorkflowSuspendedException, } from './workflow-errors.js';
3
+ /** The durable step name an approval point is recorded under. */
4
+ export const approvalStepNameFor = (reason) => `__workflow_approval:${reason}`;
5
+ /**
6
+ * The run-state key holding an approval's decision.
7
+ *
8
+ * Hex-encoded because the key is composed from a caller-supplied reason, and
9
+ * run state is a flat record — an unescaped reason could collide with, or
10
+ * shadow, another key.
11
+ */
12
+ export const approvalStateKey = (stepName) => {
13
+ let hex = '';
14
+ for (const byte of new TextEncoder().encode(stepName)) {
15
+ hex += byte.toString(16).padStart(2, '0');
16
+ }
17
+ return `__approval_${hex}`;
18
+ };
19
+ /**
20
+ * Record a decision against an approval point and wake the run.
21
+ *
22
+ * A decision arriving for an already-settled approval is refused rather than
23
+ * overwriting it: the run has moved on, and a second answer would be recorded
24
+ * against a gate nobody is waiting at.
25
+ */
26
+ export const recordApprovalDecision = async (store, runId, reason, decision) => {
27
+ const stepName = approvalStepNameFor(reason);
28
+ const stateKey = approvalStateKey(stepName);
29
+ let resolved;
30
+ try {
31
+ resolved = await store.getStepState(runId, stepName);
32
+ }
33
+ catch {
34
+ // knowledge: decisions/security/workflow-approval-payloads-are-validated-on-replay-inside-the-workflow.md
35
+ }
36
+ if (resolved?.stepId && resolved.status === 'succeeded') {
37
+ const outcome = resolved.result;
38
+ throw new WorkflowApprovalResolvedError(reason, outcome?.status ?? 'decided');
39
+ }
40
+ const state = await store.getRunState(runId);
41
+ const record = (state[stateKey] ?? {});
42
+ await store.updateRunState(runId, stateKey, {
43
+ ...record,
44
+ decision,
45
+ decidedAt: new Date().toISOString(),
46
+ error: undefined,
47
+ });
48
+ await store.resumeWorkflow(runId);
49
+ };
50
+ /**
51
+ * Evaluate an approval gate on replay.
52
+ *
53
+ * The payload is validated here rather than where it was submitted, because the
54
+ * schema is a value on the workflow and only the workflow has it. A payload
55
+ * that fails validation is cleared and the run suspends again, so a bad
56
+ * submission cannot settle the gate.
57
+ */
58
+ export const evaluateApprovalStep = async (store, runId, reason, approvalStepName, fromStepName, options) => {
59
+ const insert = () => store.insertStepState(runId, approvalStepName, 'pikkuWorkflowApproval', { reason, expiry: options.expiry }, undefined, fromStepName);
60
+ let stepState;
61
+ try {
62
+ stepState = await store.getStepState(runId, approvalStepName);
63
+ }
64
+ catch {
65
+ stepState = await insert();
66
+ }
67
+ if (!stepState.stepId) {
68
+ stepState = await insert();
69
+ }
70
+ if (stepState.status === 'succeeded') {
71
+ return stepState.result;
72
+ }
73
+ const stateKey = approvalStateKey(approvalStepName);
74
+ let record = ((await store.getRunState(runId))[stateKey] ?? {});
75
+ if (stepState.status === 'pending') {
76
+ await store.setStepRunning(stepState.stepId);
77
+ if (options.expiry !== undefined && !record.expiresAt) {
78
+ const expiry = getDurationInMilliseconds(options.expiry);
79
+ record = {
80
+ ...record,
81
+ expiresAt: new Date(Date.now() + expiry).toISOString(),
82
+ };
83
+ await store.updateRunState(runId, stateKey, record);
84
+ await store.scheduleRunWake(runId, expiry);
85
+ }
86
+ }
87
+ if (record.decision !== undefined) {
88
+ const validation = await options.schema['~standard'].validate(record.decision);
89
+ if (validation.issues) {
90
+ await store.updateRunState(runId, stateKey, {
91
+ ...record,
92
+ decision: undefined,
93
+ decidedAt: undefined,
94
+ error: validation.issues.map((issue) => ({
95
+ message: issue.message,
96
+ path: issue.path?.map((segment) => typeof segment === 'object' ? segment.key : segment),
97
+ })),
98
+ });
99
+ throw new WorkflowSuspendedException(runId, reason);
100
+ }
101
+ const outcome = {
102
+ status: 'decided',
103
+ data: validation.value,
104
+ };
105
+ await store.setStepResult(stepState.stepId, outcome);
106
+ return outcome;
107
+ }
108
+ if (record.expiresAt && Date.now() >= Date.parse(record.expiresAt)) {
109
+ const outcome = { status: 'expired' };
110
+ await store.setStepResult(stepState.stepId, outcome);
111
+ return outcome;
112
+ }
113
+ throw new WorkflowSuspendedException(runId, reason);
114
+ };
@@ -0,0 +1,26 @@
1
+ export declare const DEFAULT_STEP_RETRIES = 5;
2
+ /** Statuses from which a run never advances again on its own. */
3
+ export declare const WORKFLOW_END_STATES: ReadonlySet<string>;
4
+ /** Statuses a run cannot leave at all. */
5
+ export declare const WORKFLOW_TERMINAL_STATES: ReadonlySet<string>;
6
+ export declare const WORKFLOW_POLL_MIN_MS = 10;
7
+ export declare const WORKFLOW_POLL_FACTOR = 1.6;
8
+ export declare const WORKFLOW_CHILD_POLL_MAX_MS = 500;
9
+ /** Idle window before a `running` run with nothing in flight is treated as stalled. */
10
+ export declare const DEFAULT_STALLED_RUN_MS: number;
11
+ /** Runs re-driven per `recoverStalledRuns` call, so one sweep is bounded. */
12
+ export declare const DEFAULT_STALLED_RUN_LIMIT = 100;
13
+ /**
14
+ * How long a step may sit `pending` before the relay assumes its dispatch was
15
+ * lost. This is a bet that no healthy queue takes this long to move a job from
16
+ * `pending` to `running`; set it above the observed p99 of that latency.
17
+ */
18
+ export declare const DEFAULT_UNDISPATCHED_STEP_MS = 30000;
19
+ /** Steps re-driven per `relayUndispatchedSteps` call, so one tick is bounded. */
20
+ export declare const DEFAULT_UNDISPATCHED_STEP_LIMIT = 100;
21
+ /** First wait before a step already re-dispatched once is re-dispatched again. */
22
+ export declare const REDISPATCH_BACKOFF_MS = 30000;
23
+ /** Ceiling on the doubling backoff, so a permanently stuck step still gets swept. */
24
+ export declare const REDISPATCH_BACKOFF_MAX_MS: number;
25
+ /** Bound on the in-process backoff map, so a long-lived process cannot grow it without bound. */
26
+ export declare const REDISPATCH_BACKOFF_MAX_ENTRIES = 10000;
@@ -0,0 +1,35 @@
1
+ export const DEFAULT_STEP_RETRIES = 5;
2
+ /** Statuses from which a run never advances again on its own. */
3
+ export const WORKFLOW_END_STATES = new Set([
4
+ 'completed',
5
+ 'failed',
6
+ 'cancelled',
7
+ 'suspended',
8
+ ]);
9
+ /** Statuses a run cannot leave at all. */
10
+ export const WORKFLOW_TERMINAL_STATES = new Set([
11
+ 'completed',
12
+ 'failed',
13
+ 'cancelled',
14
+ ]);
15
+ export const WORKFLOW_POLL_MIN_MS = 10;
16
+ export const WORKFLOW_POLL_FACTOR = 1.6;
17
+ export const WORKFLOW_CHILD_POLL_MAX_MS = 500;
18
+ /** Idle window before a `running` run with nothing in flight is treated as stalled. */
19
+ export const DEFAULT_STALLED_RUN_MS = 5 * 60_000;
20
+ /** Runs re-driven per `recoverStalledRuns` call, so one sweep is bounded. */
21
+ export const DEFAULT_STALLED_RUN_LIMIT = 100;
22
+ /**
23
+ * How long a step may sit `pending` before the relay assumes its dispatch was
24
+ * lost. This is a bet that no healthy queue takes this long to move a job from
25
+ * `pending` to `running`; set it above the observed p99 of that latency.
26
+ */
27
+ export const DEFAULT_UNDISPATCHED_STEP_MS = 30_000;
28
+ /** Steps re-driven per `relayUndispatchedSteps` call, so one tick is bounded. */
29
+ export const DEFAULT_UNDISPATCHED_STEP_LIMIT = 100;
30
+ /** First wait before a step already re-dispatched once is re-dispatched again. */
31
+ export const REDISPATCH_BACKOFF_MS = 30_000;
32
+ /** Ceiling on the doubling backoff, so a permanently stuck step still gets swept. */
33
+ export const REDISPATCH_BACKOFF_MAX_MS = 10 * 60_000;
34
+ /** Bound on the in-process backoff map, so a long-lived process cannot grow it without bound. */
35
+ export const REDISPATCH_BACKOFF_MAX_ENTRIES = 10_000;
@@ -0,0 +1,58 @@
1
+ import { PikkuError } from '../../errors/error-handler.js';
2
+ import type { ApprovalOutcome } from './workflow.types.js';
3
+ /**
4
+ * Thrown to unwind a run that cannot continue on this tick. Not a failure:
5
+ * the run resumes from its recorded step state.
6
+ */
7
+ export declare class WorkflowAsyncException extends Error {
8
+ readonly runId: string;
9
+ readonly stepName: string;
10
+ constructor(runId: string, stepName: string);
11
+ }
12
+ export declare class WorkflowCancelledException extends Error {
13
+ readonly runId: string;
14
+ readonly reason?: string | undefined;
15
+ constructor(runId: string, reason?: string | undefined);
16
+ }
17
+ export declare class WorkflowSuspendedException extends Error {
18
+ readonly runId: string;
19
+ readonly reason: string;
20
+ constructor(runId: string, reason: string);
21
+ }
22
+ export declare class WorkflowDispatchException extends Error {
23
+ readonly runId: string;
24
+ readonly stepName: string;
25
+ constructor(runId: string, stepName: string, options?: {
26
+ cause?: unknown;
27
+ });
28
+ }
29
+ export declare class WorkflowNotFoundError extends PikkuError {
30
+ constructor(name: string);
31
+ }
32
+ export declare class WorkflowRunNotFoundError extends PikkuError {
33
+ constructor(runId: string);
34
+ }
35
+ export declare class WorkflowRunFailedError extends PikkuError {
36
+ payload: {
37
+ message?: string;
38
+ };
39
+ constructor(message?: string);
40
+ }
41
+ export declare class WorkflowRunCancelledError extends PikkuError {
42
+ constructor();
43
+ }
44
+ export declare class WorkflowApprovalResolvedError extends PikkuError {
45
+ payload: {
46
+ reason: string;
47
+ outcome: ApprovalOutcome<unknown>['status'];
48
+ };
49
+ constructor(reason: string, outcome: ApprovalOutcome<unknown>['status']);
50
+ }
51
+ export declare class WorkflowStepFunctionMismatchError extends PikkuError {
52
+ readonly runId: string;
53
+ readonly stepName: string;
54
+ constructor(runId: string, stepName: string);
55
+ }
56
+ export declare class WorkflowStepNameNotString extends Error {
57
+ constructor(stepName: unknown);
58
+ }
@@ -0,0 +1,112 @@
1
+ import { PikkuError, addError } from '../../errors/error-handler.js';
2
+ /**
3
+ * Thrown to unwind a run that cannot continue on this tick. Not a failure:
4
+ * the run resumes from its recorded step state.
5
+ */
6
+ export class WorkflowAsyncException extends Error {
7
+ runId;
8
+ stepName;
9
+ constructor(runId, stepName) {
10
+ super(`Workflow paused at step: ${stepName}`);
11
+ this.runId = runId;
12
+ this.stepName = stepName;
13
+ this.name = 'WorkflowAsyncException';
14
+ }
15
+ }
16
+ export class WorkflowCancelledException extends Error {
17
+ runId;
18
+ reason;
19
+ constructor(runId, reason) {
20
+ super(reason || 'Workflow cancelled');
21
+ this.runId = runId;
22
+ this.reason = reason;
23
+ this.name = 'WorkflowCancelledException';
24
+ }
25
+ }
26
+ export class WorkflowSuspendedException extends Error {
27
+ runId;
28
+ reason;
29
+ constructor(runId, reason) {
30
+ super(reason || 'Workflow suspended');
31
+ this.runId = runId;
32
+ this.reason = reason;
33
+ this.name = 'WorkflowSuspendedException';
34
+ }
35
+ }
36
+ export class WorkflowDispatchException extends Error {
37
+ runId;
38
+ stepName;
39
+ constructor(runId, stepName, options) {
40
+ super(`Failed to dispatch workflow step '${stepName}' (run ${runId})`, options);
41
+ this.runId = runId;
42
+ this.stepName = stepName;
43
+ this.name = 'WorkflowDispatchException';
44
+ }
45
+ }
46
+ export class WorkflowNotFoundError extends PikkuError {
47
+ constructor(name) {
48
+ super(`Workflow not found: ${name}`);
49
+ }
50
+ }
51
+ addError(WorkflowNotFoundError, {
52
+ status: 404,
53
+ message: 'Workflow not found.',
54
+ });
55
+ export class WorkflowRunNotFoundError extends PikkuError {
56
+ constructor(runId) {
57
+ super(`Workflow run not found: ${runId}`);
58
+ }
59
+ }
60
+ addError(WorkflowRunNotFoundError, {
61
+ status: 404,
62
+ message: 'Workflow run not found.',
63
+ });
64
+ export class WorkflowRunFailedError extends PikkuError {
65
+ payload;
66
+ constructor(message) {
67
+ super(`Workflow run failed: ${message ?? 'unknown'}`);
68
+ this.payload = { message };
69
+ }
70
+ }
71
+ addError(WorkflowRunFailedError, {
72
+ status: 422,
73
+ message: 'Workflow run failed.',
74
+ });
75
+ export class WorkflowRunCancelledError extends PikkuError {
76
+ constructor() {
77
+ super('Workflow was cancelled');
78
+ }
79
+ }
80
+ addError(WorkflowRunCancelledError, {
81
+ status: 409,
82
+ message: 'Workflow was cancelled.',
83
+ });
84
+ export class WorkflowApprovalResolvedError extends PikkuError {
85
+ payload;
86
+ constructor(reason, outcome) {
87
+ super(`Approval already ${outcome}: ${reason}`);
88
+ this.payload = { reason, outcome };
89
+ }
90
+ }
91
+ addError(WorkflowApprovalResolvedError, {
92
+ status: 409,
93
+ message: 'Approval has already been resolved.',
94
+ });
95
+ export class WorkflowStepFunctionMismatchError extends PikkuError {
96
+ runId;
97
+ stepName;
98
+ constructor(runId, stepName) {
99
+ super(`Workflow step '${stepName}' (run ${runId}) was dispatched with a different function`);
100
+ this.runId = runId;
101
+ this.stepName = stepName;
102
+ }
103
+ }
104
+ addError(WorkflowStepFunctionMismatchError, {
105
+ status: 409,
106
+ message: 'Workflow step was dispatched with a different function.',
107
+ });
108
+ export class WorkflowStepNameNotString extends Error {
109
+ constructor(stepName) {
110
+ super(`Workflow step name must be a string. Received: ${typeof stepName}`);
111
+ }
112
+ }
@@ -0,0 +1,11 @@
1
+ import type { WorkflowRuntimeMeta } from './workflow.types.js';
2
+ export type ResolvedWorkflowMeta = {
3
+ meta: WorkflowRuntimeMeta;
4
+ packageName: string | null;
5
+ resolvedName: string;
6
+ };
7
+ /**
8
+ * Resolves a workflow name against the root registry, then — for a
9
+ * `namespace:name` form — against the addon package that claims the namespace.
10
+ */
11
+ export declare const resolveWorkflowMeta: (name: string) => ResolvedWorkflowMeta | null;
@@ -0,0 +1,31 @@
1
+ import { pikkuState } from '../../pikku-state.js';
2
+ /**
3
+ * Resolves a workflow name against the root registry, then — for a
4
+ * `namespace:name` form — against the addon package that claims the namespace.
5
+ */
6
+ export const resolveWorkflowMeta = (name) => {
7
+ const rootMeta = pikkuState(null, 'workflows', 'meta');
8
+ if (rootMeta[name]) {
9
+ return { meta: rootMeta[name], packageName: null, resolvedName: name };
10
+ }
11
+ const colonIndex = name.indexOf(':');
12
+ if (colonIndex === -1) {
13
+ return null;
14
+ }
15
+ const namespace = name.substring(0, colonIndex);
16
+ const localName = name.substring(colonIndex + 1);
17
+ const addons = pikkuState(null, 'addons', 'packages');
18
+ const pkgConfig = addons?.get(namespace);
19
+ if (!pkgConfig) {
20
+ return null;
21
+ }
22
+ const addonMeta = pikkuState(pkgConfig.package, 'workflows', 'meta');
23
+ if (!addonMeta?.[localName]) {
24
+ return null;
25
+ }
26
+ return {
27
+ meta: addonMeta[localName],
28
+ packageName: pkgConfig.package,
29
+ resolvedName: localName,
30
+ };
31
+ };
@@ -0,0 +1,8 @@
1
+ import type { JobGroup, JobOptions } from '../queue/queue.types.js';
2
+ import type { WorkflowServiceConfig, WorkflowStepOptions } from './workflow.types.js';
3
+ export type WorkflowQueueStrategy = 'per-workflow' | 'shared-groups';
4
+ export declare const resolveWorkflowConfig: () => WorkflowServiceConfig;
5
+ export declare const orchestratorQueueName: (strategy: WorkflowQueueStrategy, workflowName?: string) => string;
6
+ export declare const stepWorkerQueueName: (strategy: WorkflowQueueStrategy, rpcName?: string) => string;
7
+ export declare const jobGroupFor: (strategy: WorkflowQueueStrategy, id?: string) => JobGroup | undefined;
8
+ export declare const stepJobOptions: (stepOptions?: WorkflowStepOptions) => JobOptions;
@@ -0,0 +1,38 @@
1
+ import { getSingletonServices, pikkuState } from '../../pikku-state.js';
2
+ import { getDurationInMilliseconds } from '../../time-utils.js';
3
+ import { DEFAULT_STEP_RETRIES } from './workflow-constants.js';
4
+ const toKebab = (s) => s.replace(/([a-z0-9])([A-Z])/g, '$1-$2').toLowerCase();
5
+ export const resolveWorkflowConfig = () => {
6
+ const workflow = getSingletonServices().config?.workflow;
7
+ return {
8
+ retries: workflow?.retries ?? DEFAULT_STEP_RETRIES,
9
+ retryDelay: workflow?.retryDelay ?? 0,
10
+ orchestratorQueueName: workflow?.orchestratorQueueName ?? 'pikku-workflow-orchestrator',
11
+ stepWorkerQueueName: workflow?.stepWorkerQueueName ?? 'pikku-workflow-step-worker',
12
+ sleeperRPCName: workflow?.sleeperRPCName ?? 'pikkuWorkflowSleeper',
13
+ };
14
+ };
15
+ /**
16
+ * Falls back to the shared queue whenever the dedicated one was not generated
17
+ * into queue meta, so a workflow added without a rebuild still runs.
18
+ */
19
+ const dedicatedQueueName = (prefix, name, strategy, fallback) => {
20
+ if (!name || strategy === 'shared-groups') {
21
+ return fallback;
22
+ }
23
+ const dedicated = `${prefix}${toKebab(name)}`;
24
+ return pikkuState(null, 'queue', 'meta')[dedicated] ? dedicated : fallback;
25
+ };
26
+ export const orchestratorQueueName = (strategy, workflowName) => dedicatedQueueName('wf-orchestrator-', workflowName, strategy, resolveWorkflowConfig().orchestratorQueueName);
27
+ export const stepWorkerQueueName = (strategy, rpcName) => dedicatedQueueName('wf-step-', rpcName, strategy, resolveWorkflowConfig().stepWorkerQueueName);
28
+ export const jobGroupFor = (strategy, id) => id && strategy === 'shared-groups' ? { id, tier: id } : undefined;
29
+ export const stepJobOptions = (stepOptions) => {
30
+ const retries = stepOptions?.retries ?? DEFAULT_STEP_RETRIES;
31
+ const retryDelay = stepOptions?.retryDelay;
32
+ const backoff = retryDelay !== undefined && retryDelay !== 'exponential'
33
+ ? { type: 'fixed', delay: getDurationInMilliseconds(retryDelay) }
34
+ : retries > 0 || retryDelay === 'exponential'
35
+ ? 'exponential'
36
+ : undefined;
37
+ return { attempts: retries + 1, ...(backoff ? { backoff } : {}) };
38
+ };
@@ -0,0 +1,20 @@
1
+ import type { GroupConcurrencyConfig } from '../queue/queue.types.js';
2
+ import type { Logger } from '../../services/logger.js';
3
+ import type { WorkflowQueueStrategy } from './workflow-queue-routing.js';
4
+ export type WorkflowQueueWiringOptions = {
5
+ strategy: WorkflowQueueStrategy;
6
+ concurrency: number;
7
+ groupConcurrency: number | GroupConcurrencyConfig;
8
+ /**
9
+ * Resolved only when there is something to warn about: reading the logger
10
+ * throws while singleton services are uninitialized, and wiring queues before
11
+ * that point is legitimate.
12
+ */
13
+ getLogger: () => Logger | undefined;
14
+ };
15
+ /**
16
+ * Registers the orchestrator, step-worker and sleeper functions and binds them
17
+ * to their queues. Idempotent: a queue already carrying a registered function
18
+ * is left alone.
19
+ */
20
+ export declare const wireWorkflowQueueWorkers: ({ strategy, concurrency, groupConcurrency, getLogger, }: WorkflowQueueWiringOptions) => void;
@@ -0,0 +1,79 @@
1
+ import { addFunction } from '../../function/function-runner.js';
2
+ import { pikkuState } from '../../pikku-state.js';
3
+ import { wireQueueWorker } from '../queue/queue-runner.js';
4
+ import { pikkuWorkflowOrchestratorFunc, pikkuWorkflowSleeperFunc, pikkuWorkflowWorkerFunc, } from './workflow-queue-workers.js';
5
+ const ORCHESTRATOR_QUEUE_PREFIX = 'wf-orchestrator-';
6
+ const STEP_QUEUE_PREFIX = 'wf-step-';
7
+ const helperFunctionMeta = (funcId) => ({
8
+ pikkuFuncId: funcId,
9
+ sessionless: true,
10
+ functionType: 'helper',
11
+ inputSchemaName: null,
12
+ outputSchemaName: null,
13
+ });
14
+ /**
15
+ * Registers the orchestrator, step-worker and sleeper functions and binds them
16
+ * to their queues. Idempotent: a queue already carrying a registered function
17
+ * is left alone.
18
+ */
19
+ export const wireWorkflowQueueWorkers = ({ strategy, concurrency, groupConcurrency, getLogger, }) => {
20
+ const functions = pikkuState(null, 'function', 'functions');
21
+ const functionsMeta = pikkuState(null, 'function', 'meta');
22
+ const queueMeta = pikkuState(null, 'queue', 'meta');
23
+ const registerWorkflowFunc = (funcId, func, queueName, config) => {
24
+ if (functions.has(funcId))
25
+ return;
26
+ addFunction(funcId, func);
27
+ if (!queueMeta[queueName]) {
28
+ queueMeta[queueName] = { pikkuFuncId: funcId, name: queueName };
29
+ }
30
+ wireQueueWorker({ name: queueName, func, config });
31
+ if (!functionsMeta[funcId]) {
32
+ functionsMeta[funcId] = helperFunctionMeta(funcId);
33
+ }
34
+ };
35
+ const sharedGroups = strategy === 'shared-groups';
36
+ const sharedQueueConfig = sharedGroups
37
+ ? { batchSize: concurrency, groupConcurrency }
38
+ : undefined;
39
+ registerWorkflowFunc('pikkuWorkflowOrchestrator', { func: pikkuWorkflowOrchestratorFunc }, 'pikku-workflow-orchestrator', sharedQueueConfig);
40
+ registerWorkflowFunc('pikkuWorkflowStepWorker', { func: pikkuWorkflowWorkerFunc }, 'pikku-workflow-step-worker', sharedQueueConfig);
41
+ const registerDedicatedQueues = (meta) => {
42
+ for (const [queueName, entry] of Object.entries(meta)) {
43
+ if (functions.has(entry.pikkuFuncId))
44
+ continue;
45
+ if (queueName.startsWith(ORCHESTRATOR_QUEUE_PREFIX)) {
46
+ registerWorkflowFunc(entry.pikkuFuncId, { func: pikkuWorkflowOrchestratorFunc }, queueName);
47
+ }
48
+ else if (queueName.startsWith(STEP_QUEUE_PREFIX)) {
49
+ registerWorkflowFunc(entry.pikkuFuncId, { func: pikkuWorkflowWorkerFunc }, queueName);
50
+ }
51
+ }
52
+ };
53
+ if (!sharedGroups) {
54
+ registerDedicatedQueues(pikkuState(null, 'queue', 'meta'));
55
+ const addons = pikkuState(null, 'addons', 'packages');
56
+ for (const [, addon] of addons ?? []) {
57
+ const addonQueueMeta = pikkuState(addon.package, 'queue', 'meta');
58
+ if (addonQueueMeta) {
59
+ registerDedicatedQueues(addonQueueMeta);
60
+ }
61
+ }
62
+ }
63
+ warnOnMissingDedicatedQueues(queueMeta, getLogger);
64
+ if (!functions.has('pikkuWorkflowSleeper')) {
65
+ addFunction('pikkuWorkflowSleeper', { func: pikkuWorkflowSleeperFunc });
66
+ }
67
+ if (!functionsMeta.pikkuWorkflowSleeper) {
68
+ functionsMeta.pikkuWorkflowSleeper = helperFunctionMeta('pikkuWorkflowSleeper');
69
+ }
70
+ };
71
+ const warnOnMissingDedicatedQueues = (queueMeta, getLogger) => {
72
+ const workflowCount = Object.keys(pikkuState(null, 'workflows', 'meta') ?? {}).length;
73
+ const dedicatedQueues = Object.keys(queueMeta).filter((name) => name.startsWith(ORCHESTRATOR_QUEUE_PREFIX)).length;
74
+ if (workflowCount > 0 && dedicatedQueues === 0) {
75
+ getLogger()?.warn?.(`[pikku] ${workflowCount} workflow(s) registered but no per-workflow orchestrator queues were found in queue meta. ` +
76
+ `All workflows will share a single orchestrator queue, where one slow step blocks every other workflow behind it. ` +
77
+ `Check that the generated bootstrap imports the queue-workers meta (pikku-queue-workers-wirings-meta.gen.js).`);
78
+ }
79
+ };
@@ -0,0 +1,68 @@
1
+ import type { Logger } from '../../services/logger.js';
2
+ /**
3
+ * Per-process, advisory record of when a run may next be re-dispatched.
4
+ *
5
+ * Keyed by run rather than by step because the run is the unit of re-drive:
6
+ * `resumeWorkflow` replays the whole run and re-dispatches every step still
7
+ * owed a job, so holding off a single step while resuming its run would
8
+ * suppress nothing.
9
+ *
10
+ * Losing this on restart costs extra dispatches, never correctness.
11
+ */
12
+ export declare class RedispatchBackoff {
13
+ private readonly eligibleAt;
14
+ private readonly delays;
15
+ isEligible(runId: string, now: number): boolean;
16
+ note(runId: string, now: number): void;
17
+ }
18
+ type SweepDeps = {
19
+ resume: (runId: string) => Promise<void>;
20
+ logger?: Logger;
21
+ };
22
+ /**
23
+ * Re-drive runs whose next move was lost, and report which were resumed.
24
+ *
25
+ * Arming a step is two writes to two systems — the step row, then the queue or
26
+ * scheduler job — so a process that dies between them leaves a run that is
27
+ * `running` with nothing in flight. Nothing notices: the run parks on a step
28
+ * that will never complete and never error, so it neither finishes nor fails.
29
+ * (Seen on a `workflow.sleep()`: a deploy restart landed between the sleep
30
+ * step's insert and its timer, parking the run permanently.)
31
+ *
32
+ * Replay is the recovery — `resumeWorkflow` re-orchestrates from persisted step
33
+ * state, and every settled step is memoized, so resuming a run that was not
34
+ * actually stuck costs an orchestration pass and changes nothing. That
35
+ * idempotence is what makes an idle-time heuristic safe here; a run that is
36
+ * legitimately mid-sleep is excluded anyway, since its step is `scheduled`.
37
+ */
38
+ export declare const sweepStalledRuns: (findStalledRunIds: (before: Date, limit: number) => Promise<string[]>, options: {
39
+ stalledAfterMs?: number;
40
+ limit?: number;
41
+ } | undefined, deps: SweepDeps) => Promise<{
42
+ resumed: string[];
43
+ }>;
44
+ /**
45
+ * Re-drive steps whose dispatch was lost, and report which runs were nudged.
46
+ *
47
+ * The step row is the outbox record and this is the relay. Age is the only
48
+ * signal available — a step `pending` because its dispatch was lost is
49
+ * indistinguishable from one whose job is merely still queued — so a step past
50
+ * `undispatchedAfterMs` is re-dispatched regardless, and correctness rests on
51
+ * the claim in `executeWorkflowStepInner` rather than on the guess being right.
52
+ * A redundant dispatch costs one queue message: the loser reads `running` and
53
+ * returns without invoking anything.
54
+ *
55
+ * Re-dispatches back off per run (doubling from 30s, capped at 10m) so a
56
+ * genuine queue backlog is not amplified by a tick that keeps firing at the
57
+ * steps the backlog is already delaying.
58
+ */
59
+ export declare const sweepUndispatchedSteps: (findUndispatchedSteps: (before: Date, limit: number) => Promise<Array<{
60
+ runId: string;
61
+ stepId: string;
62
+ }>>, backoff: RedispatchBackoff, options: {
63
+ undispatchedAfterMs?: number;
64
+ limit?: number;
65
+ } | undefined, deps: SweepDeps) => Promise<{
66
+ redispatched: string[];
67
+ }>;
68
+ export {};