@speedkit/cli 4.50.5 → 4.51.0-run-control.2

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 (432) hide show
  1. package/README.md +1425 -14
  2. package/dist/base/run-control-command.d.ts +15 -0
  3. package/dist/base/run-control-command.js +20 -0
  4. package/dist/build-info.json +6 -0
  5. package/dist/commands/diff.d.ts +7 -1
  6. package/dist/commands/diff.js +9 -3
  7. package/dist/commands/login.d.ts +3 -0
  8. package/dist/commands/login.js +14 -3
  9. package/dist/commands/onboarding/browser/click.d.ts +75 -0
  10. package/dist/commands/onboarding/browser/click.js +19 -0
  11. package/dist/commands/onboarding/browser/emulate.d.ts +105 -0
  12. package/dist/commands/onboarding/browser/emulate.js +26 -0
  13. package/dist/commands/onboarding/browser/navigate.d.ts +75 -0
  14. package/dist/commands/onboarding/browser/navigate.js +19 -0
  15. package/dist/commands/onboarding/browser/panel.d.ts +63 -0
  16. package/dist/commands/onboarding/browser/panel.js +12 -0
  17. package/dist/commands/onboarding/browser/reinstall-sw.d.ts +63 -0
  18. package/dist/commands/onboarding/browser/reinstall-sw.js +14 -0
  19. package/dist/commands/onboarding/browser/reset.d.ts +71 -0
  20. package/dist/commands/onboarding/browser/reset.js +18 -0
  21. package/dist/commands/onboarding/browser/screenshot.d.ts +77 -0
  22. package/dist/commands/onboarding/browser/screenshot.js +19 -0
  23. package/dist/commands/onboarding/browser/state.d.ts +63 -0
  24. package/dist/commands/onboarding/browser/state.js +12 -0
  25. package/dist/commands/onboarding/browser/tabs.d.ts +58 -0
  26. package/dist/commands/onboarding/browser/tabs.js +16 -0
  27. package/dist/commands/onboarding/cache/clear.d.ts +58 -0
  28. package/dist/commands/onboarding/cache/clear.js +12 -0
  29. package/dist/commands/onboarding/cache/errors.d.ts +58 -0
  30. package/dist/commands/onboarding/cache/errors.js +12 -0
  31. package/dist/commands/onboarding/cache/evict.d.ts +62 -0
  32. package/dist/commands/onboarding/cache/evict.js +15 -0
  33. package/dist/commands/onboarding/cache/get.d.ts +85 -0
  34. package/dist/commands/onboarding/cache/get.js +17 -0
  35. package/dist/commands/onboarding/cache/list.d.ts +58 -0
  36. package/dist/commands/onboarding/cache/list.js +15 -0
  37. package/dist/commands/onboarding/cache/prewarm.d.ts +73 -0
  38. package/dist/commands/onboarding/cache/prewarm.js +20 -0
  39. package/dist/commands/onboarding/cache/refresh.d.ts +62 -0
  40. package/dist/commands/onboarding/cache/refresh.js +18 -0
  41. package/dist/commands/onboarding/cdp.d.ts +81 -0
  42. package/dist/commands/onboarding/cdp.js +18 -0
  43. package/dist/commands/onboarding/debug/arm.d.ts +83 -0
  44. package/dist/commands/onboarding/debug/arm.js +19 -0
  45. package/dist/commands/onboarding/debug/await.d.ts +71 -0
  46. package/dist/commands/onboarding/debug/await.js +18 -0
  47. package/dist/commands/onboarding/debug/disarm.d.ts +63 -0
  48. package/dist/commands/onboarding/debug/disarm.js +12 -0
  49. package/dist/commands/onboarding/debug/eval.d.ts +75 -0
  50. package/dist/commands/onboarding/debug/eval.js +16 -0
  51. package/dist/commands/onboarding/debug/release.d.ts +63 -0
  52. package/dist/commands/onboarding/debug/release.js +12 -0
  53. package/dist/commands/onboarding/debug/resume.d.ts +63 -0
  54. package/dist/commands/onboarding/debug/resume.js +12 -0
  55. package/dist/commands/onboarding/debug/status.d.ts +63 -0
  56. package/dist/commands/onboarding/debug/status.js +12 -0
  57. package/dist/commands/onboarding/debug/step.d.ts +67 -0
  58. package/dist/commands/onboarding/debug/step.js +15 -0
  59. package/dist/commands/onboarding/files/list.d.ts +58 -0
  60. package/dist/commands/onboarding/files/list.js +12 -0
  61. package/dist/commands/onboarding/files/read.d.ts +73 -0
  62. package/dist/commands/onboarding/files/read.js +16 -0
  63. package/dist/commands/onboarding/files/rebuild.d.ts +63 -0
  64. package/dist/commands/onboarding/files/rebuild.js +18 -0
  65. package/dist/commands/onboarding/files/validate.d.ts +58 -0
  66. package/dist/commands/onboarding/files/validate.js +12 -0
  67. package/dist/commands/onboarding/fouc.d.ts +77 -0
  68. package/dist/commands/onboarding/fouc.js +16 -0
  69. package/dist/commands/onboarding/inject/add.d.ts +89 -0
  70. package/dist/commands/onboarding/inject/add.js +17 -0
  71. package/dist/commands/onboarding/inject/clear.d.ts +63 -0
  72. package/dist/commands/onboarding/inject/clear.js +12 -0
  73. package/dist/commands/onboarding/inject/list.d.ts +63 -0
  74. package/dist/commands/onboarding/inject/list.js +12 -0
  75. package/dist/commands/onboarding/inject/read.d.ts +75 -0
  76. package/dist/commands/onboarding/inject/read.js +18 -0
  77. package/dist/commands/onboarding/inject/recipes.d.ts +63 -0
  78. package/dist/commands/onboarding/inject/recipes.js +12 -0
  79. package/dist/commands/onboarding/inject/remove.d.ts +67 -0
  80. package/dist/commands/onboarding/inject/remove.js +15 -0
  81. package/dist/commands/onboarding/list.d.ts +13 -0
  82. package/dist/commands/onboarding/list.js +12 -0
  83. package/dist/commands/onboarding/logs.d.ts +41 -0
  84. package/dist/commands/onboarding/logs.js +257 -0
  85. package/dist/commands/onboarding/navwalk.d.ts +95 -0
  86. package/dist/commands/onboarding/navwalk.js +19 -0
  87. package/dist/commands/onboarding/response.d.ts +67 -0
  88. package/dist/commands/onboarding/response.js +18 -0
  89. package/dist/commands/onboarding/rum/beacons.d.ts +75 -0
  90. package/dist/commands/onboarding/rum/beacons.js +16 -0
  91. package/dist/commands/onboarding/rum/get.d.ts +77 -0
  92. package/dist/commands/onboarding/rum/get.js +18 -0
  93. package/dist/commands/onboarding/rum/key.d.ts +67 -0
  94. package/dist/commands/onboarding/rum/key.js +13 -0
  95. package/dist/commands/onboarding/rum/previous.d.ts +63 -0
  96. package/dist/commands/onboarding/rum/previous.js +12 -0
  97. package/dist/commands/onboarding/status.d.ts +13 -0
  98. package/dist/commands/onboarding/status.js +17 -0
  99. package/dist/commands/onboarding/stop.d.ts +13 -0
  100. package/dist/commands/onboarding/stop.js +17 -0
  101. package/dist/commands/onboarding/todo.d.ts +58 -0
  102. package/dist/commands/onboarding/todo.js +12 -0
  103. package/dist/commands/onboarding/viewport.d.ts +101 -0
  104. package/dist/commands/onboarding/viewport.js +18 -0
  105. package/dist/commands/onboarding/watch.d.ts +93 -0
  106. package/dist/commands/onboarding/watch.js +16 -0
  107. package/dist/commands/onboarding.d.ts +26 -0
  108. package/dist/commands/onboarding.js +221 -4
  109. package/dist/commands/origin-request.d.ts +4 -0
  110. package/dist/commands/origin-request.js +4 -0
  111. package/dist/commands/spec/onboarding.spec.d.ts +1 -0
  112. package/dist/commands/spec/onboarding.spec.js +127 -0
  113. package/dist/services/cli/build-info.d.ts +33 -0
  114. package/dist/services/cli/build-info.js +63 -0
  115. package/dist/services/cli/cli-environment-factory.d.ts +3 -0
  116. package/dist/services/cli/cli-environment-factory.js +1 -0
  117. package/dist/services/cli/cli-service-build-context.d.ts +3 -0
  118. package/dist/services/cli/cli-service-factory.js +1 -1
  119. package/dist/services/cli/cli-service-model.d.ts +29 -10
  120. package/dist/services/cli/cli-service.d.ts +60 -11
  121. package/dist/services/cli/cli-service.js +196 -32
  122. package/dist/services/cli/index.d.ts +2 -0
  123. package/dist/services/cli/index.js +2 -0
  124. package/dist/services/cli/sink.d.ts +47 -0
  125. package/dist/services/cli/sink.js +31 -0
  126. package/dist/services/cli/spec/build-identity.spec.d.ts +1 -0
  127. package/dist/services/cli/spec/build-identity.spec.js +85 -0
  128. package/dist/services/cli/spec/build-info.spec.d.ts +1 -0
  129. package/dist/services/cli/spec/build-info.spec.js +10 -0
  130. package/dist/services/cli/spec/cli-service-log.spec.d.ts +1 -0
  131. package/dist/services/cli/spec/cli-service-log.spec.js +133 -0
  132. package/dist/services/cli/spec/cli-service.spec.js +113 -50
  133. package/dist/services/cli/spec/memory-cli.d.ts +9 -0
  134. package/dist/services/cli/spec/memory-cli.js +9 -0
  135. package/dist/services/diff/config-at-ref.d.ts +20 -0
  136. package/dist/services/diff/config-at-ref.js +33 -0
  137. package/dist/services/diff/diff-service-build-context.d.ts +12 -0
  138. package/dist/services/diff/diff-service-build-context.js +45 -1
  139. package/dist/services/diff/diff-service-factory.d.ts +2 -0
  140. package/dist/services/diff/diff-service-factory.js +65 -25
  141. package/dist/services/diff/diff-service.d.ts +11 -0
  142. package/dist/services/diff/diff-service.js +37 -11
  143. package/dist/services/diff/page-source.d.ts +12 -0
  144. package/dist/services/diff/page-source.js +16 -11
  145. package/dist/services/diff/run-runtime-config.d.ts +33 -0
  146. package/dist/services/diff/run-runtime-config.js +74 -0
  147. package/dist/services/diff/sinks/tool-diff-sink.d.ts +3 -2
  148. package/dist/services/diff/sinks/tool-diff-sink.js +3 -2
  149. package/dist/services/diff/spec/config-at-ref.spec.d.ts +1 -0
  150. package/dist/services/diff/spec/config-at-ref.spec.js +46 -0
  151. package/dist/services/diff/spec/diff-service-build-context.spec.js +19 -0
  152. package/dist/services/diff/spec/diff-service.spec.js +95 -0
  153. package/dist/services/diff/spec/run-runtime-config.spec.d.ts +1 -0
  154. package/dist/services/diff/spec/run-runtime-config.spec.js +87 -0
  155. package/dist/services/git/git-repository.d.ts +2 -0
  156. package/dist/services/git/git-repository.js +6 -0
  157. package/dist/services/integration-api/customer-config-flags.js +1 -0
  158. package/dist/services/onboarding/browse/browse-service.d.ts +13 -1
  159. package/dist/services/onboarding/browse/browse-service.js +40 -7
  160. package/dist/services/onboarding/browser/answer-dialogs.d.ts +12 -0
  161. package/dist/services/onboarding/browser/answer-dialogs.js +25 -0
  162. package/dist/services/onboarding/browser/baqend-response.d.ts +17 -1
  163. package/dist/services/onboarding/browser/baqend-response.js +23 -0
  164. package/dist/services/onboarding/browser/console-log.d.ts +9 -0
  165. package/dist/services/onboarding/browser/console-log.js +27 -0
  166. package/dist/services/onboarding/browser/emulate-device.d.ts +12 -1
  167. package/dist/services/onboarding/browser/emulate-device.js +33 -6
  168. package/dist/services/onboarding/browser/executable/executable-validator.js +4 -2
  169. package/dist/services/onboarding/browser/extension/extension-bridge.js +5 -3
  170. package/dist/services/onboarding/browser/extension/extension-downloader.js +17 -8
  171. package/dist/services/onboarding/browser/extension/extension-validator.js +9 -4
  172. package/dist/services/onboarding/browser/launch-browser.d.ts +2 -1
  173. package/dist/services/onboarding/browser/launch-browser.js +3 -1
  174. package/dist/services/onboarding/control/body-inspect.d.ts +24 -0
  175. package/dist/services/onboarding/control/body-inspect.js +106 -0
  176. package/dist/services/onboarding/control/browser-session.d.ts +535 -0
  177. package/dist/services/onboarding/control/browser-session.js +1300 -0
  178. package/dist/services/onboarding/control/config-validation.d.ts +17 -0
  179. package/dist/services/onboarding/control/config-validation.js +46 -0
  180. package/dist/services/onboarding/control/control-protocol.d.ts +1428 -0
  181. package/dist/services/onboarding/control/control-protocol.js +58 -0
  182. package/dist/services/onboarding/control/control-server.d.ts +292 -0
  183. package/dist/services/onboarding/control/control-server.js +1629 -0
  184. package/dist/services/onboarding/control/debug-session.d.ts +219 -0
  185. package/dist/services/onboarding/control/debug-session.js +897 -0
  186. package/dist/services/onboarding/control/fouc.d.ts +23 -0
  187. package/dist/services/onboarding/control/fouc.js +151 -0
  188. package/dist/services/onboarding/control/index.d.ts +4 -0
  189. package/dist/services/onboarding/control/index.js +4 -0
  190. package/dist/services/onboarding/control/navigate-wait.d.ts +33 -0
  191. package/dist/services/onboarding/control/navigate-wait.js +56 -0
  192. package/dist/services/onboarding/control/navwalk.d.ts +65 -0
  193. package/dist/services/onboarding/control/navwalk.js +248 -0
  194. package/dist/services/onboarding/control/preload-registry.d.ts +150 -0
  195. package/dist/services/onboarding/control/preload-registry.js +829 -0
  196. package/dist/services/onboarding/control/response-explainer.d.ts +24 -0
  197. package/dist/services/onboarding/control/response-explainer.js +257 -0
  198. package/dist/services/onboarding/control/rum.d.ts +8 -0
  199. package/dist/services/onboarding/control/rum.js +220 -0
  200. package/dist/services/onboarding/control/service-worker-tracker.d.ts +68 -0
  201. package/dist/services/onboarding/control/service-worker-tracker.js +120 -0
  202. package/dist/services/onboarding/control/viewport.d.ts +45 -0
  203. package/dist/services/onboarding/control/viewport.js +344 -0
  204. package/dist/services/onboarding/control/watch.d.ts +26 -0
  205. package/dist/services/onboarding/control/watch.js +157 -0
  206. package/dist/services/onboarding/dashboard/diff-against-current-page.js +3 -1
  207. package/dist/services/onboarding/dashboard/index.js +7 -2
  208. package/dist/services/onboarding/fetch-event-handler.d.ts +24 -5
  209. package/dist/services/onboarding/fetch-event-handler.js +103 -32
  210. package/dist/services/onboarding/fetch-events/speed-kit-install-js.js +11 -2
  211. package/dist/services/onboarding/fetch-events/speed-kit-rum-pi-request.d.ts +14 -0
  212. package/dist/services/onboarding/fetch-events/speed-kit-rum-pi-request.js +30 -0
  213. package/dist/services/onboarding/fetch-events/speed-kit-service-worker-js.d.ts +13 -0
  214. package/dist/services/onboarding/fetch-events/speed-kit-service-worker-js.js +28 -1
  215. package/dist/services/onboarding/file-events/file-watcher.d.ts +42 -1
  216. package/dist/services/onboarding/file-events/file-watcher.js +117 -12
  217. package/dist/services/onboarding/inject/inject-service.js +1 -1
  218. package/dist/services/onboarding/onboarding-model.d.ts +30 -0
  219. package/dist/services/onboarding/onboarding-model.js +12 -1
  220. package/dist/services/onboarding/onboarding-service-build-context.d.ts +4 -0
  221. package/dist/services/onboarding/onboarding-service-build-context.js +7 -1
  222. package/dist/services/onboarding/onboarding-service-factory.d.ts +17 -1
  223. package/dist/services/onboarding/onboarding-service-factory.js +150 -23
  224. package/dist/services/onboarding/onboarding-service.d.ts +40 -1
  225. package/dist/services/onboarding/onboarding-service.js +136 -23
  226. package/dist/services/onboarding/request-cache/asset-key.d.ts +61 -0
  227. package/dist/services/onboarding/request-cache/asset-key.js +115 -0
  228. package/dist/services/onboarding/request-cache/cache.d.ts +62 -5
  229. package/dist/services/onboarding/request-cache/cache.js +128 -17
  230. package/dist/services/onboarding/spec/browser/answer-dialogs.spec.d.ts +1 -0
  231. package/dist/services/onboarding/spec/browser/answer-dialogs.spec.js +66 -0
  232. package/dist/services/onboarding/spec/browser/console-log.spec.d.ts +1 -0
  233. package/dist/services/onboarding/spec/browser/console-log.spec.js +42 -0
  234. package/dist/services/onboarding/spec/control/browser-session.spec.d.ts +1 -0
  235. package/dist/services/onboarding/spec/control/browser-session.spec.js +651 -0
  236. package/dist/services/onboarding/spec/control/control-server.spec.d.ts +1 -0
  237. package/dist/services/onboarding/spec/control/control-server.spec.js +371 -0
  238. package/dist/services/onboarding/spec/control/debug-session.spec.d.ts +1 -0
  239. package/dist/services/onboarding/spec/control/debug-session.spec.js +751 -0
  240. package/dist/services/onboarding/spec/control/fakes.d.ts +31 -0
  241. package/dist/services/onboarding/spec/control/fakes.js +66 -0
  242. package/dist/services/onboarding/spec/control/fouc.spec.d.ts +1 -0
  243. package/dist/services/onboarding/spec/control/fouc.spec.js +167 -0
  244. package/dist/services/onboarding/spec/control/navigate-wait.spec.d.ts +1 -0
  245. package/dist/services/onboarding/spec/control/navigate-wait.spec.js +47 -0
  246. package/dist/services/onboarding/spec/control/navwalk.spec.d.ts +1 -0
  247. package/dist/services/onboarding/spec/control/navwalk.spec.js +222 -0
  248. package/dist/services/onboarding/spec/control/preload-registry.spec.d.ts +1 -0
  249. package/dist/services/onboarding/spec/control/preload-registry.spec.js +432 -0
  250. package/dist/services/onboarding/spec/control/response-explainer.spec.d.ts +1 -0
  251. package/dist/services/onboarding/spec/control/response-explainer.spec.js +324 -0
  252. package/dist/services/onboarding/spec/control/rum.spec.d.ts +1 -0
  253. package/dist/services/onboarding/spec/control/rum.spec.js +222 -0
  254. package/dist/services/onboarding/spec/control/service-worker-tracker.spec.d.ts +1 -0
  255. package/dist/services/onboarding/spec/control/service-worker-tracker.spec.js +193 -0
  256. package/dist/services/onboarding/spec/control/viewport.spec.d.ts +1 -0
  257. package/dist/services/onboarding/spec/control/viewport.spec.js +200 -0
  258. package/dist/services/onboarding/spec/control/watch.spec.d.ts +1 -0
  259. package/dist/services/onboarding/spec/control/watch.spec.js +187 -0
  260. package/dist/services/onboarding/spec/fetch-event-handler.spec.d.ts +1 -0
  261. package/dist/services/onboarding/spec/fetch-event-handler.spec.js +219 -0
  262. package/dist/services/onboarding/spec/fetch-events/speed-kit-service-worker-js.spec.d.ts +1 -0
  263. package/dist/services/onboarding/spec/fetch-events/speed-kit-service-worker-js.spec.js +41 -0
  264. package/dist/services/onboarding/spec/onboarding-model.spec.js +39 -3
  265. package/dist/services/onboarding/spec/onboarding-service-factory.spec.js +25 -1
  266. package/dist/services/onboarding/spec/request-cache/cache.spec.d.ts +1 -0
  267. package/dist/services/onboarding/spec/request-cache/cache.spec.js +107 -0
  268. package/dist/services/onboarding/spec/todo-collector.spec.d.ts +1 -0
  269. package/dist/services/onboarding/spec/todo-collector.spec.js +136 -0
  270. package/dist/services/onboarding/spec/virtual-orestes-app/virtual-orestes-app.spec.d.ts +1 -0
  271. package/dist/services/onboarding/spec/virtual-orestes-app/virtual-orestes-app.spec.js +65 -0
  272. package/dist/services/onboarding/todo-collector.d.ts +7 -2
  273. package/dist/services/onboarding/todo-collector.js +49 -12
  274. package/dist/services/onboarding/virtual-orestes-app/index.d.ts +38 -0
  275. package/dist/services/onboarding/virtual-orestes-app/index.js +113 -27
  276. package/dist/services/origin-request/asset-variations.d.ts +14 -0
  277. package/dist/services/origin-request/asset-variations.js +11 -4
  278. package/dist/services/origin-request/origin-fetcher.d.ts +7 -0
  279. package/dist/services/origin-request/origin-fetcher.js +43 -5
  280. package/dist/services/origin-request/origin-request-service-build-context.d.ts +17 -0
  281. package/dist/services/origin-request/origin-request-service-build-context.js +8 -0
  282. package/dist/services/origin-request/origin-request-service-factory.d.ts +0 -5
  283. package/dist/services/origin-request/origin-request-service-factory.js +2 -30
  284. package/dist/services/origin-request/origin-request-service.d.ts +121 -6
  285. package/dist/services/origin-request/origin-request-service.js +273 -49
  286. package/dist/services/origin-request/runtime-config-source.d.ts +6 -0
  287. package/dist/services/origin-request/runtime-config-source.js +15 -4
  288. package/dist/services/origin-request/spec/asset-variations.spec.js +20 -0
  289. package/dist/services/origin-request/spec/origin-request-service.spec.js +329 -6
  290. package/dist/services/query-builder/rules/rule-match.d.ts +35 -0
  291. package/dist/services/query-builder/rules/rule-match.js +70 -0
  292. package/dist/services/query-builder/spec/rules/rule-match.spec.d.ts +1 -0
  293. package/dist/services/query-builder/spec/rules/rule-match.spec.js +121 -0
  294. package/dist/services/run-control/browser/run-browser-contexts.d.ts +557 -0
  295. package/dist/services/run-control/browser/run-browser-contexts.js +91 -0
  296. package/dist/services/run-control/browser/run-browser-service-factory.d.ts +5 -0
  297. package/dist/services/run-control/browser/run-browser-service-factory.js +7 -0
  298. package/dist/services/run-control/browser/run-browser-service.d.ts +68 -0
  299. package/dist/services/run-control/browser/run-browser-service.js +206 -0
  300. package/dist/services/run-control/cache/run-cache-contexts.d.ts +349 -0
  301. package/dist/services/run-control/cache/run-cache-contexts.js +51 -0
  302. package/dist/services/run-control/cache/run-cache-service-factory.d.ts +6 -0
  303. package/dist/services/run-control/cache/run-cache-service-factory.js +12 -0
  304. package/dist/services/run-control/cache/run-cache-service.d.ts +35 -0
  305. package/dist/services/run-control/cache/run-cache-service.js +151 -0
  306. package/dist/services/run-control/control-client.d.ts +36 -0
  307. package/dist/services/run-control/control-client.js +147 -0
  308. package/dist/services/run-control/debug/run-debug-contexts.d.ts +416 -0
  309. package/dist/services/run-control/debug/run-debug-contexts.js +47 -0
  310. package/dist/services/run-control/debug/run-debug-service-factory.d.ts +5 -0
  311. package/dist/services/run-control/debug/run-debug-service-factory.js +7 -0
  312. package/dist/services/run-control/debug/run-debug-service.d.ts +39 -0
  313. package/dist/services/run-control/debug/run-debug-service.js +164 -0
  314. package/dist/services/run-control/files/run-files-contexts.d.ts +238 -0
  315. package/dist/services/run-control/files/run-files-contexts.js +26 -0
  316. package/dist/services/run-control/files/run-files-service-factory.d.ts +5 -0
  317. package/dist/services/run-control/files/run-files-service-factory.js +7 -0
  318. package/dist/services/run-control/files/run-files-service.d.ts +29 -0
  319. package/dist/services/run-control/files/run-files-service.js +120 -0
  320. package/dist/services/run-control/index.d.ts +32 -0
  321. package/dist/services/run-control/index.js +31 -0
  322. package/dist/services/run-control/inject/run-inject-contexts.d.ts +319 -0
  323. package/dist/services/run-control/inject/run-inject-contexts.js +38 -0
  324. package/dist/services/run-control/inject/run-inject-service-factory.d.ts +5 -0
  325. package/dist/services/run-control/inject/run-inject-service-factory.js +7 -0
  326. package/dist/services/run-control/inject/run-inject-service.d.ts +31 -0
  327. package/dist/services/run-control/inject/run-inject-service.js +227 -0
  328. package/dist/services/run-control/live-run.d.ts +37 -0
  329. package/dist/services/run-control/live-run.js +56 -0
  330. package/dist/services/run-control/probe/run-probe-contexts.d.ts +333 -0
  331. package/dist/services/run-control/probe/run-probe-contexts.js +73 -0
  332. package/dist/services/run-control/probe/run-probe-service-factory.d.ts +5 -0
  333. package/dist/services/run-control/probe/run-probe-service-factory.js +7 -0
  334. package/dist/services/run-control/probe/run-probe-service.d.ts +54 -0
  335. package/dist/services/run-control/probe/run-probe-service.js +194 -0
  336. package/dist/services/run-control/rum/run-rum-contexts.d.ts +216 -0
  337. package/dist/services/run-control/rum/run-rum-contexts.js +34 -0
  338. package/dist/services/run-control/rum/run-rum-service-factory.d.ts +5 -0
  339. package/dist/services/run-control/rum/run-rum-service-factory.js +7 -0
  340. package/dist/services/run-control/rum/run-rum-service.d.ts +36 -0
  341. package/dist/services/run-control/rum/run-rum-service.js +122 -0
  342. package/dist/services/run-control/run-answer.d.ts +28 -0
  343. package/dist/services/run-control/run-answer.js +58 -0
  344. package/dist/services/run-control/run-control-context.d.ts +102 -0
  345. package/dist/services/run-control/run-control-context.js +36 -0
  346. package/dist/services/run-control/run-control-flags.d.ts +12 -0
  347. package/dist/services/run-control/run-control-flags.js +22 -0
  348. package/dist/services/run-control/run-control-model.d.ts +9 -0
  349. package/dist/services/run-control/run-control-model.js +1 -0
  350. package/dist/services/run-control/run-control-service-factory.d.ts +14 -0
  351. package/dist/services/run-control/run-control-service-factory.js +26 -0
  352. package/dist/services/run-control/session/run-session-contexts.d.ts +25 -0
  353. package/dist/services/run-control/session/run-session-contexts.js +20 -0
  354. package/dist/services/run-control/session/run-session-service-factory.d.ts +8 -0
  355. package/dist/services/run-control/session/run-session-service-factory.js +18 -0
  356. package/dist/services/run-control/session/run-session-service.d.ts +32 -0
  357. package/dist/services/run-control/session/run-session-service.js +151 -0
  358. package/dist/services/run-control/spec/browser/run-browser-service.spec.d.ts +1 -0
  359. package/dist/services/run-control/spec/browser/run-browser-service.spec.js +327 -0
  360. package/dist/services/run-control/spec/cache/run-cache-service.spec.d.ts +1 -0
  361. package/dist/services/run-control/spec/cache/run-cache-service.spec.js +454 -0
  362. package/dist/services/run-control/spec/debug/run-debug-service.spec.d.ts +1 -0
  363. package/dist/services/run-control/spec/debug/run-debug-service.spec.js +113 -0
  364. package/dist/services/run-control/spec/files/run-files-service.spec.d.ts +1 -0
  365. package/dist/services/run-control/spec/files/run-files-service.spec.js +234 -0
  366. package/dist/services/run-control/spec/inject/run-inject-service.spec.d.ts +1 -0
  367. package/dist/services/run-control/spec/inject/run-inject-service.spec.js +251 -0
  368. package/dist/services/run-control/spec/live-run-fixture.d.ts +32 -0
  369. package/dist/services/run-control/spec/live-run-fixture.js +109 -0
  370. package/dist/services/run-control/spec/probe/run-probe-service.spec.d.ts +1 -0
  371. package/dist/services/run-control/spec/probe/run-probe-service.spec.js +108 -0
  372. package/dist/services/run-control/spec/rum/run-rum-service.spec.d.ts +1 -0
  373. package/dist/services/run-control/spec/rum/run-rum-service.spec.js +47 -0
  374. package/dist/services/run-control/spec/run-answer.spec.d.ts +1 -0
  375. package/dist/services/run-control/spec/run-answer.spec.js +57 -0
  376. package/dist/services/run-control/spec/session/run-session-service.spec.d.ts +1 -0
  377. package/dist/services/run-control/spec/session/run-session-service.spec.js +150 -0
  378. package/dist/services/run-log/crash-mirror.d.ts +31 -0
  379. package/dist/services/run-log/crash-mirror.js +69 -0
  380. package/dist/services/run-log/index.d.ts +11 -0
  381. package/dist/services/run-log/index.js +11 -0
  382. package/dist/services/run-log/jsonl-appender.d.ts +46 -0
  383. package/dist/services/run-log/jsonl-appender.js +91 -0
  384. package/dist/services/run-log/log-event-model.d.ts +104 -0
  385. package/dist/services/run-log/log-event-model.js +56 -0
  386. package/dist/services/run-log/log-query-service-factory.d.ts +11 -0
  387. package/dist/services/run-log/log-query-service-factory.js +14 -0
  388. package/dist/services/run-log/log-query-service.d.ts +59 -0
  389. package/dist/services/run-log/log-query-service.js +111 -0
  390. package/dist/services/run-log/log-reader.d.ts +84 -0
  391. package/dist/services/run-log/log-reader.js +180 -0
  392. package/dist/services/run-log/log-summary.d.ts +72 -0
  393. package/dist/services/run-log/log-summary.js +208 -0
  394. package/dist/services/run-log/redaction.d.ts +34 -0
  395. package/dist/services/run-log/redaction.js +124 -0
  396. package/dist/services/run-log/request-log.d.ts +82 -0
  397. package/dist/services/run-log/request-log.js +69 -0
  398. package/dist/services/run-log/request-summary.d.ts +76 -0
  399. package/dist/services/run-log/request-summary.js +0 -0
  400. package/dist/services/run-log/run-log.d.ts +61 -0
  401. package/dist/services/run-log/run-log.js +102 -0
  402. package/dist/services/run-log/spec/log-query-service.spec.d.ts +1 -0
  403. package/dist/services/run-log/spec/log-query-service.spec.js +197 -0
  404. package/dist/services/run-log/spec/log-reader.spec.d.ts +1 -0
  405. package/dist/services/run-log/spec/log-reader.spec.js +109 -0
  406. package/dist/services/run-log/spec/log-summary.spec.d.ts +1 -0
  407. package/dist/services/run-log/spec/log-summary.spec.js +153 -0
  408. package/dist/services/run-log/spec/redaction.spec.d.ts +1 -0
  409. package/dist/services/run-log/spec/redaction.spec.js +61 -0
  410. package/dist/services/run-log/spec/request-log.spec.d.ts +1 -0
  411. package/dist/services/run-log/spec/request-log.spec.js +101 -0
  412. package/dist/services/run-log/spec/request-summary.spec.d.ts +1 -0
  413. package/dist/services/run-log/spec/request-summary.spec.js +171 -0
  414. package/dist/services/run-log/spec/run-log.spec.d.ts +1 -0
  415. package/dist/services/run-log/spec/run-log.spec.js +122 -0
  416. package/dist/services/run-registry/exit-classification.d.ts +39 -0
  417. package/dist/services/run-registry/exit-classification.js +42 -0
  418. package/dist/services/run-registry/index.d.ts +3 -0
  419. package/dist/services/run-registry/index.js +3 -0
  420. package/dist/services/run-registry/process-identity.d.ts +28 -0
  421. package/dist/services/run-registry/process-identity.js +80 -0
  422. package/dist/services/run-registry/run-registry-model.d.ts +128 -0
  423. package/dist/services/run-registry/run-registry-model.js +16 -0
  424. package/dist/services/run-registry/run-registry.d.ts +155 -0
  425. package/dist/services/run-registry/run-registry.js +430 -0
  426. package/dist/services/run-registry/spec/exit-classification.spec.d.ts +1 -0
  427. package/dist/services/run-registry/spec/exit-classification.spec.js +82 -0
  428. package/dist/services/run-registry/spec/run-registry.spec.d.ts +1 -0
  429. package/dist/services/run-registry/spec/run-registry.spec.js +526 -0
  430. package/dist/services/setup/os/tool-registry.js +2 -2
  431. package/oclif.manifest.json +3409 -288
  432. package/package.json +20 -2
@@ -1,10 +1,13 @@
1
1
  import { Config } from "@oclif/core";
2
2
  import { CliEnvironment } from "./cli-environment.js";
3
+ import type { CliSink } from "./sink.js";
3
4
  export interface CliEnvironmentOptions {
4
5
  /** The customer the command works on, for its documentHandler's node modules. */
5
6
  readonly customerPath?: string;
6
7
  /** Keep the CLI to what `--quiet` allows: no spinners, default answers. */
7
8
  readonly quiet?: boolean;
9
+ /** Where the CLI's output goes. Defaults to the terminal. */
10
+ readonly sink?: CliSink;
8
11
  }
9
12
  /**
10
13
  * Builds the environment of one invocation, with its one CLI.
@@ -24,6 +24,7 @@ export class CliEnvironmentFactory {
24
24
  const cli = new CliServiceFactory(new CliServiceBuildContext({
25
25
  environment,
26
26
  quiet: this.options.quiet ?? false,
27
+ sink: this.options.sink,
27
28
  })).getService();
28
29
  return environment.attachCli(cli);
29
30
  }
@@ -1,7 +1,10 @@
1
1
  import type { CommandContextValues } from "./command-build-context.js";
2
+ import type { CliSink } from "./sink.js";
2
3
  export interface CliServiceBuildContextValues extends CommandContextValues {
3
4
  /** Keep to what `--quiet` allows: no spinners, default answers. */
4
5
  readonly quiet: boolean;
6
+ /** Where output goes. Defaults to the terminal. */
7
+ readonly sink?: CliSink;
5
8
  }
6
9
  declare const CliServiceBuildContext_base: new (values: CliServiceBuildContextValues) => Readonly<CliServiceBuildContextValues>;
7
10
  /** What the invocation's one CLI is built from. */
@@ -15,6 +15,6 @@ export class CliServiceFactory {
15
15
  this.context = context;
16
16
  }
17
17
  getService() {
18
- return new CliService(new ClipboardService(), this.context.environment, this.context.quiet);
18
+ return new CliService(new ClipboardService(), this.context.environment, this.context.quiet, this.context.sink);
19
19
  }
20
20
  }
@@ -1,6 +1,7 @@
1
1
  import { Options } from "cli-progress";
2
2
  import { ExecSyncOptions } from "node:child_process";
3
3
  import { ChalkInstance } from "chalk";
4
+ import { LogLevel, LogMeta, RunLogInterface } from "../run-log/index.js";
4
5
  export declare enum CliActionStatus {
5
6
  COMPLETED = "completed",
6
7
  FAILED = "failed",
@@ -25,14 +26,30 @@ export interface CliServiceInterface {
25
26
  readonly quiet: boolean;
26
27
  /** True when this shell cannot be prompted (CI, no TTY, SK_NON_INTERACTIVE). */
27
28
  readonly nonInteractive: boolean;
28
- code(code: string, buffered?: boolean): void;
29
+ /**
30
+ * Also record everything from here on into a run's log.
31
+ *
32
+ * Attached rather than constructed with, because the two have different
33
+ * lifetimes: the service exists from the first line of the command, and the
34
+ * run directory does not exist until the command has decided there is going
35
+ * to be a run — `sk onboarding` asks about colliding runs first, and a
36
+ * declined start must leave nothing behind on disk.
37
+ */
38
+ attachLog(log: RunLogInterface): void;
39
+ /**
40
+ * Record a line into the run's log only, never on the terminal: what is
41
+ * too much to print, such as the page's console.
42
+ */
43
+ logOnly(level: LogLevel, message: string, meta?: LogMeta): void;
44
+ code(code: string, buffered?: boolean, meta?: LogMeta): void;
29
45
  codeStyle(code: string): string;
30
- comment(message: string, buffered?: boolean): void;
46
+ comment(message: string, buffered?: boolean, meta?: LogMeta): void;
31
47
  confirm(message: string, defaultAnswer?: boolean): Promise<boolean>;
32
48
  exit(code?: number): void;
33
49
  prompt(message: string, options?: {
34
50
  defaultAnswer?: any;
35
51
  validator?: any;
52
+ sensitive?: boolean;
36
53
  }): Promise<string>;
37
54
  select(message: string, choices: any, defaultValue?: string): Promise<string>;
38
55
  multiSelect<T>(message: string, choices: {
@@ -49,19 +66,21 @@ export interface CliServiceInterface {
49
66
  pipe(data: string): void;
50
67
  /** A human-facing line that must stay out of the data channel. */
51
68
  note(message: string): void;
69
+ /** Put the terminal back — shows the cursor a spinner hid. */
70
+ restoreTerminal(): void;
52
71
  spacer(): void;
53
- startAction(name: string, message: string): void;
54
- endAction(name: string, message?: string): void;
55
- successAction(name: string, message?: string): void;
56
- failAction(name: string, message?: string): void;
72
+ startAction(name: string, message: string, meta?: LogMeta): void;
73
+ endAction(name: string, message?: string, meta?: LogMeta): void;
74
+ successAction(name: string, message?: string, meta?: LogMeta): void;
75
+ failAction(name: string, message?: string, meta?: LogMeta): void;
57
76
  startProgress(total: number, start?: number, payload?: object, config?: Options): void;
58
77
  stopProgress(): void;
59
78
  table<T extends Record<string, unknown>>(data: T[], columns: CliTableColumns<T>, options?: CliTableOptions): void;
60
79
  updateProgress(current: number, payload?: object): void;
61
- write(message: string, buffered?: boolean): void;
80
+ write(message: string, buffered?: boolean, meta?: LogMeta): void;
62
81
  writeBuffer(): void;
63
- writeError(message: string, buffered?: boolean): void;
64
- writeSuccess(message: string, buffered?: boolean): void;
65
- writeWarning(message: string, buffered?: boolean): void;
82
+ writeError(message: string, buffered?: boolean, meta?: LogMeta): void;
83
+ writeSuccess(message: string, buffered?: boolean, meta?: LogMeta): void;
84
+ writeWarning(message: string, buffered?: boolean, meta?: LogMeta): void;
66
85
  execSync(command: string, options?: ExecSyncOptions): string;
67
86
  }
@@ -1,8 +1,10 @@
1
1
  import { ChalkInstance } from "chalk";
2
2
  import { Options } from "cli-progress";
3
3
  import { CliServiceInterface, CliTableColumns } from "./cli-service-model.js";
4
+ import { LogLevel, LogMeta, RunLogInterface } from "../run-log/index.js";
4
5
  import { ClipboardService } from "./clipboard/index.js";
5
6
  import type { CliEnvironment } from "./cli-environment.js";
7
+ import { CliSink } from "./sink.js";
6
8
  import { ExecSyncOptions } from "node:child_process";
7
9
  /** What the CLI needs to know about where it runs. */
8
10
  export type CliTerminal = Pick<CliEnvironment, "isCI" | "nonInteractive">;
@@ -10,6 +12,7 @@ export declare class CliService implements CliServiceInterface {
10
12
  private readonly clipboard;
11
13
  private readonly terminal;
12
14
  readonly quiet: boolean;
15
+ private readonly sink;
13
16
  style: ChalkInstance;
14
17
  private buffer;
15
18
  private progressBar?;
@@ -26,6 +29,8 @@ export declare class CliService implements CliServiceInterface {
26
29
  private readonly animates;
27
30
  /** The text of each running action, for the log line that replaces it. */
28
31
  private readonly actions;
32
+ /** Where a structured copy of the output goes, once a run owns one. */
33
+ private log?;
29
34
  /**
30
35
  * True when this shell cannot be asked a question: CI, no TTY on either end,
31
36
  * or SK_NON_INTERACTIVE. Callers that would otherwise block on a prompt check
@@ -33,15 +38,54 @@ export declare class CliService implements CliServiceInterface {
33
38
  * than being re-derived wherever a prompt happens to be.
34
39
  */
35
40
  get nonInteractive(): boolean;
36
- constructor(clipboard: ClipboardService, terminal: CliTerminal, quiet?: boolean);
37
- code(code: string, buffered?: boolean): void;
41
+ constructor(clipboard: ClipboardService, terminal: CliTerminal, quiet?: boolean, sink?: CliSink);
42
+ /**
43
+ * Put the terminal back the way it was found.
44
+ *
45
+ * Spinnies hides the cursor while a spinner runs and shows it again only
46
+ * when the last one ends. A shutdown that happens mid-spinner would otherwise
47
+ * leave the user with an invisible cursor — which is what spinnies' own
48
+ * SIGINT handler existed to prevent, and that handler is gone for the reasons
49
+ * in {@link createSpinners}. Owning the cleanup is the price of owning the
50
+ * signal.
51
+ */
52
+ restoreTerminal(): void;
53
+ attachLog(log: RunLogInterface): void;
54
+ logOnly(level: LogLevel, message: string, meta?: LogMeta): void;
55
+ /**
56
+ * Record one line, if a run is listening.
57
+ *
58
+ * Everything the CLI prints goes through here as well as through the sink,
59
+ * which is what makes the log a copy of the session rather than a second
60
+ * account of it. The level comes from the method that was called — a
61
+ * `writeWarning` is a `warn` — and a caller that knows better overrides it in
62
+ * `meta`.
63
+ *
64
+ * **Deliberately upstream of `quiet`.** A quiet run prints nothing and still
65
+ * happened; the log is not the terminal, and a `--quiet` session with an
66
+ * empty log would be the most misleading file in the directory.
67
+ */
68
+ private record;
69
+ code(code: string, buffered?: boolean, meta?: LogMeta): void;
38
70
  codeStyle(code: string): string;
39
- comment(message: string, buffered?: boolean): void;
71
+ comment(message: string, buffered?: boolean, meta?: LogMeta): void;
40
72
  confirm(message: string, defaultAnswer?: boolean): Promise<boolean>;
73
+ /**
74
+ * A question that is now on screen, waiting.
75
+ *
76
+ * Logged before the answer exists, and again once it arrives, because an
77
+ * append-only file cannot go back and fill one in — and a run that died
78
+ * waiting at a prompt is exactly the run whose log has to show the question.
79
+ * The cost is two lines per prompt; the alternative is a log that ends in
80
+ * silence with no indication that anything was being asked.
81
+ */
82
+ private asked;
83
+ private answered;
41
84
  exit(code?: number): void;
42
85
  prompt(message: string, options?: {
43
86
  defaultAnswer?: any;
44
87
  validator?: any;
88
+ sensitive?: boolean;
45
89
  }): Promise<string>;
46
90
  select(message: string, choices: any, defaultValue?: string): Promise<string>;
47
91
  multiSelect<T>(message: string, choices: {
@@ -80,10 +124,10 @@ export declare class CliService implements CliServiceInterface {
80
124
  */
81
125
  note(message: string): void;
82
126
  spacer(): void;
83
- startAction(name: string, message: string): void;
84
- endAction(name: string, message?: string): void;
85
- failAction(name: string, message?: string): void;
86
- successAction(name: string, message?: string): void;
127
+ startAction(name: string, message: string, meta?: LogMeta): void;
128
+ endAction(name: string, message?: string, meta?: LogMeta): void;
129
+ failAction(name: string, message?: string, meta?: LogMeta): void;
130
+ successAction(name: string, message?: string, meta?: LogMeta): void;
87
131
  /**
88
132
  * One line for an action that ended, where a spinner cannot be drawn. The
89
133
  * text comes from the action that started, so a caller that ends one without
@@ -94,11 +138,16 @@ export declare class CliService implements CliServiceInterface {
94
138
  updateProgress(current: number, payload?: object): void;
95
139
  stopProgress(): void;
96
140
  table<T extends Record<string, unknown>>(data: T[], columns: CliTableColumns<T>): void;
97
- write(message: string, buffered?: boolean): void;
141
+ write(message: string, buffered?: boolean, meta?: LogMeta): void;
142
+ /**
143
+ * Flush what was buffered. Nothing is recorded here: each line was logged
144
+ * with its own level when it was buffered, and logging the joined block
145
+ * again would report a page of mixed warnings and successes as one `info`.
146
+ */
98
147
  writeBuffer(): void;
99
- writeError(message: string, buffered?: boolean): void;
100
- writeSuccess(message: string, buffered?: boolean): void;
101
- writeWarning(message: string, buffered?: boolean): void;
148
+ writeError(message: string, buffered?: boolean, meta?: LogMeta): void;
149
+ writeSuccess(message: string, buffered?: boolean, meta?: LogMeta): void;
150
+ writeWarning(message: string, buffered?: boolean, meta?: LogMeta): void;
102
151
  execSync(command: string, options?: ExecSyncOptions): string;
103
152
  private getFormattedMessage;
104
153
  }
@@ -3,9 +3,12 @@ import { Chalk } from "chalk";
3
3
  import Table from "tty-table";
4
4
  import { Presets, SingleBar } from "cli-progress";
5
5
  import Spinnies from "spinnies";
6
+ import { ConsoleSink } from "./sink.js";
6
7
  import { safe } from "../../helpers/safe.js";
7
8
  import { execSync } from "node:child_process";
8
9
  import ApplicationError from "../error-handling/error/application-error.js";
10
+ /** How many table rows reach the log. A terminal table is never longer than this. */
11
+ const TABLE_ROWS = 100;
9
12
  /** The padding and the gutter that a table draws inside every column. */
10
13
  const CELL_OVERHEAD = 3;
11
14
  /** The left margin and the outer borders of a table. */
@@ -43,10 +46,38 @@ function columnWidths(entries, rows) {
43
46
  }
44
47
  return widths;
45
48
  }
49
+ /**
50
+ * Construct Spinnies without letting it take SIGINT.
51
+ *
52
+ * Its constructor calls `bindSigint()` unconditionally, and that begins with
53
+ * `process.removeAllListeners("SIGINT")` before installing one that calls
54
+ * `process.exit(0)`. There is no option to turn it off. So a CLI that
55
+ * registered a SIGINT handler — `sk onboarding` does, before the browser
56
+ * launches — silently loses it the moment anything constructs a CliService,
57
+ * and its shutdown is replaced by a bare exit. That cost three test sessions to
58
+ * find, because every symptom pointed at the CLI's own handler being wrong.
59
+ *
60
+ * Registering later cannot help: `removeAllListeners` deletes whatever exists
61
+ * at that moment. So the listeners are snapshotted and put back, and spinnies'
62
+ * own is dropped. `rawListeners` rather than `listeners`, so a `once`
63
+ * registration goes back as a `once`.
64
+ */
65
+ function createSpinners() {
66
+ const ours = process.rawListeners("SIGINT");
67
+ const spinners = new Spinnies();
68
+ for (const listener of process.rawListeners("SIGINT")) {
69
+ process.off("SIGINT", listener);
70
+ }
71
+ for (const listener of ours) {
72
+ process.on("SIGINT", listener);
73
+ }
74
+ return spinners;
75
+ }
46
76
  export class CliService {
47
77
  clipboard;
48
78
  terminal;
49
79
  quiet;
80
+ sink;
50
81
  style;
51
82
  buffer = [];
52
83
  progressBar;
@@ -63,6 +94,8 @@ export class CliService {
63
94
  animates;
64
95
  /** The text of each running action, for the log line that replaces it. */
65
96
  actions = new Map();
97
+ /** Where a structured copy of the output goes, once a run owns one. */
98
+ log;
66
99
  /**
67
100
  * True when this shell cannot be asked a question: CI, no TTY on either end,
68
101
  * or SK_NON_INTERACTIVE. Callers that would otherwise block on a prompt check
@@ -72,51 +105,138 @@ export class CliService {
72
105
  get nonInteractive() {
73
106
  return this.terminal.nonInteractive;
74
107
  }
75
- constructor(clipboard, terminal, quiet = false) {
108
+ constructor(clipboard, terminal, quiet = false, sink = new ConsoleSink()) {
76
109
  this.clipboard = clipboard;
77
110
  this.terminal = terminal;
78
111
  this.quiet = quiet;
112
+ this.sink = sink;
79
113
  this.animates = Boolean(!terminal.isCI && process.stderr && process.stderr.isTTY);
80
- this.spinners = new Spinnies();
114
+ this.spinners = createSpinners();
81
115
  this.style = new Chalk();
82
116
  }
83
- code(code, buffered = false) {
117
+ /**
118
+ * Put the terminal back the way it was found.
119
+ *
120
+ * Spinnies hides the cursor while a spinner runs and shows it again only
121
+ * when the last one ends. A shutdown that happens mid-spinner would otherwise
122
+ * leave the user with an invisible cursor — which is what spinnies' own
123
+ * SIGINT handler existed to prevent, and that handler is gone for the reasons
124
+ * in {@link createSpinners}. Owning the cleanup is the price of owning the
125
+ * signal.
126
+ */
127
+ restoreTerminal() {
128
+ if (this.animates) {
129
+ this.spinners.stopAll();
130
+ }
131
+ }
132
+ attachLog(log) {
133
+ this.log = log;
134
+ }
135
+ logOnly(level, message, meta) {
136
+ this.record(level, message, meta);
137
+ }
138
+ /**
139
+ * Record one line, if a run is listening.
140
+ *
141
+ * Everything the CLI prints goes through here as well as through the sink,
142
+ * which is what makes the log a copy of the session rather than a second
143
+ * account of it. The level comes from the method that was called — a
144
+ * `writeWarning` is a `warn` — and a caller that knows better overrides it in
145
+ * `meta`.
146
+ *
147
+ * **Deliberately upstream of `quiet`.** A quiet run prints nothing and still
148
+ * happened; the log is not the terminal, and a `--quiet` session with an
149
+ * empty log would be the most misleading file in the directory.
150
+ */
151
+ record(level, message, meta, extra) {
152
+ this.log?.event({
153
+ level: meta?.level ?? level,
154
+ scope: meta?.scope,
155
+ msg: message,
156
+ data: meta?.data,
157
+ ...extra,
158
+ });
159
+ }
160
+ code(code, buffered = false, meta) {
161
+ this.record("info", code, meta);
84
162
  code = ` ${code} `;
85
163
  if (buffered) {
86
164
  this.buffer.push(this.style.bgBlack.white(code));
87
165
  return;
88
166
  }
89
- console.log(this.style.bgBlack.white(code));
167
+ this.sink.line(this.style.bgBlack.white(code));
90
168
  }
91
169
  codeStyle(code) {
92
170
  const padding = " ";
93
171
  return this.style.bgGray.rgb(230, 126, 0)(`${padding}${code}${padding}`);
94
172
  }
95
- comment(message, buffered = false) {
173
+ comment(message, buffered = false, meta) {
174
+ this.record("info", message, meta);
96
175
  if (buffered) {
97
176
  this.buffer.push(this.style.grey.italic(message));
98
177
  return;
99
178
  }
100
- this.write(this.style.grey.italic(message));
179
+ // Straight to the sink rather than through `write`, which would record the
180
+ // same line a second time — once as a comment and once as a bare write.
181
+ this.sink.line(this.style.grey.italic(message));
101
182
  }
102
183
  async confirm(message, defaultAnswer = true) {
103
184
  if (this.quiet) {
185
+ this.answered("confirm", message, defaultAnswer, { defaulted: true });
104
186
  return defaultAnswer;
105
187
  }
106
- return confirm({
188
+ this.asked("confirm", message);
189
+ const answer = await confirm({
107
190
  default: defaultAnswer,
108
191
  message: this.getFormattedMessage(message),
109
192
  });
193
+ this.answered("confirm", message, answer);
194
+ return answer;
195
+ }
196
+ /**
197
+ * A question that is now on screen, waiting.
198
+ *
199
+ * Logged before the answer exists, and again once it arrives, because an
200
+ * append-only file cannot go back and fill one in — and a run that died
201
+ * waiting at a prompt is exactly the run whose log has to show the question.
202
+ * The cost is two lines per prompt; the alternative is a log that ends in
203
+ * silence with no indication that anything was being asked.
204
+ */
205
+ asked(kind, question) {
206
+ this.record("info", question, undefined, {
207
+ interaction: { kind, question, pending: true },
208
+ });
209
+ }
210
+ answered(kind, question, answer, options) {
211
+ this.record("info", question, undefined, {
212
+ interaction: {
213
+ kind,
214
+ question,
215
+ answer: options?.sensitive ? undefined : answer,
216
+ ...options,
217
+ },
218
+ });
110
219
  }
111
220
  exit(code = 0) {
112
221
  process.exit(code);
113
222
  }
114
223
  async prompt(message, options) {
224
+ // `sensitive` is declared here, by the caller collecting the value, and
225
+ // never inferred from the wording of the question. A redactor that guessed
226
+ // would eventually guess wrong in the direction that writes a password to
227
+ // disk, and this file is read by agents.
228
+ const sensitive = Boolean(options?.sensitive);
115
229
  if (this.quiet) {
116
- return options?.defaultAnswer || "";
230
+ const defaulted = options?.defaultAnswer || "";
231
+ this.answered("prompt", message, defaulted, {
232
+ defaulted: true,
233
+ sensitive,
234
+ });
235
+ return defaulted;
117
236
  }
118
237
  const { defaultAnswer, validator } = options;
119
- return input({
238
+ this.asked("prompt", message);
239
+ const answer = await input({
120
240
  default: defaultAnswer,
121
241
  message: this.getFormattedMessage(message),
122
242
  validate: (input) => {
@@ -129,25 +249,37 @@ export class CliService {
129
249
  return this.style.red(`${errorMessage}. Please try again.`);
130
250
  },
131
251
  });
252
+ this.answered("prompt", message, answer, { sensitive });
253
+ return answer;
132
254
  }
133
255
  async select(message, choices, defaultValue) {
134
- return select({
256
+ this.asked("select", message);
257
+ // `choices` is untyped here, so inquirer infers `unknown` for the answer;
258
+ // the signature has always promised a string and the callers rely on it.
259
+ const answer = (await select({
135
260
  choices,
136
261
  default: defaultValue,
137
262
  message: this.getFormattedMessage(message),
138
- });
263
+ }));
264
+ this.answered("select", message, answer);
265
+ return answer;
139
266
  }
140
267
  async multiSelect(message, choices, validate) {
141
268
  if (this.quiet) {
142
- return choices.filter((c) => c.checked).map((c) => c.value);
269
+ const defaulted = choices.filter((c) => c.checked).map((c) => c.value);
270
+ this.answered("multiSelect", message, defaulted, { defaulted: true });
271
+ return defaulted;
143
272
  }
144
- return checkbox({
273
+ this.asked("multiSelect", message);
274
+ const answer = await checkbox({
145
275
  choices,
146
276
  message: this.getFormattedMessage(message),
147
277
  validate: validate
148
278
  ? (chosen) => validate(chosen.map((choice) => choice.value))
149
279
  : undefined,
150
280
  });
281
+ this.answered("multiSelect", message, answer);
282
+ return answer;
151
283
  }
152
284
  /**
153
285
  * Put text on the system clipboard.
@@ -173,7 +305,12 @@ export class CliService {
173
305
  * for a terminal) or `note` (stderr, alongside a payload).
174
306
  */
175
307
  pipe(data) {
176
- process.stdout.write(data);
308
+ // The payload itself is not logged. It is a result, not narration, and it
309
+ // is routinely a whole SQL query or a config file — the log records that
310
+ // one was produced and how big it was, and the caller redirecting stdout
311
+ // already has the bytes.
312
+ this.record("debug", `payload written (${data.length} bytes)`);
313
+ this.sink.payload(data);
177
314
  }
178
315
  /**
179
316
  * A human-facing line that must stay out of the data channel.
@@ -182,12 +319,15 @@ export class CliService {
182
319
  * being redirected — and so it can never corrupt the payload.
183
320
  */
184
321
  note(message) {
185
- process.stderr.write(`${message}\n`);
322
+ this.sink.aside(message);
186
323
  }
187
324
  spacer() {
188
- console.log("");
325
+ this.sink.line("");
189
326
  }
190
- startAction(name, message) {
327
+ startAction(name, message, meta) {
328
+ this.record("info", message, meta, {
329
+ action: { name, state: "start" },
330
+ });
191
331
  if (this.quiet) {
192
332
  return;
193
333
  }
@@ -199,7 +339,10 @@ export class CliService {
199
339
  }
200
340
  this.spinners.add(name, { text: message });
201
341
  }
202
- endAction(name, message) {
342
+ endAction(name, message, meta) {
343
+ this.record("info", message ?? this.actions.get(name) ?? name, meta, {
344
+ action: { name, state: "end" },
345
+ });
203
346
  if (this.quiet) {
204
347
  return;
205
348
  }
@@ -212,7 +355,10 @@ export class CliService {
212
355
  }
213
356
  this.spinners.update(name, { status: "stopped", text: message });
214
357
  }
215
- failAction(name, message) {
358
+ failAction(name, message, meta) {
359
+ this.record("error", message ?? this.actions.get(name) ?? name, meta, {
360
+ action: { name, state: "fail" },
361
+ });
216
362
  if (this.quiet) {
217
363
  return;
218
364
  }
@@ -225,7 +371,10 @@ export class CliService {
225
371
  }
226
372
  this.spinners.fail(name, { text: message });
227
373
  }
228
- successAction(name, message) {
374
+ successAction(name, message, meta) {
375
+ this.record("success", message ?? this.actions.get(name) ?? name, meta, {
376
+ action: { name, state: "success" },
377
+ });
229
378
  if (this.quiet) {
230
379
  return;
231
380
  }
@@ -248,7 +397,7 @@ export class CliService {
248
397
  if (!this.actions.delete(name) && !message) {
249
398
  return;
250
399
  }
251
- console.log(`${symbol} ${text}`);
400
+ this.sink.line(`${symbol} ${text}`);
252
401
  }
253
402
  startProgress(total, start = 0, payload, config) {
254
403
  if (this.quiet) {
@@ -270,6 +419,12 @@ export class CliService {
270
419
  this.progressBar.stop();
271
420
  }
272
421
  table(data, columns) {
422
+ // The rows go in as data, not as the rendered grid: box-drawing characters
423
+ // and column padding are for a terminal, and anything reading the log wants
424
+ // the values. Capped, because a table is occasionally a whole url list.
425
+ this.record("info", `table of ${data.length} rows`, {
426
+ data: { columns: Object.keys(columns), rows: data.slice(0, TABLE_ROWS) },
427
+ });
273
428
  this.spacer();
274
429
  const entries = Object.entries(columns);
275
430
  const rows = data.map((row) => entries.map(([key, col]) => String(col?.get ? col.get(row) : (row[key] ?? ""))));
@@ -282,41 +437,50 @@ export class CliService {
282
437
  width: widths[index],
283
438
  }));
284
439
  const t = Table(header, rows, { compact: true });
285
- console.log(t.render());
440
+ this.sink.line(t.render());
286
441
  this.spacer();
287
442
  }
288
- write(message, buffered = false) {
443
+ write(message, buffered = false, meta) {
444
+ this.record("info", message, meta);
289
445
  if (buffered) {
290
446
  this.buffer.push(this.style.white(message));
291
447
  return;
292
448
  }
293
- console.log(message);
449
+ this.sink.line(message);
294
450
  }
451
+ /**
452
+ * Flush what was buffered. Nothing is recorded here: each line was logged
453
+ * with its own level when it was buffered, and logging the joined block
454
+ * again would report a page of mixed warnings and successes as one `info`.
455
+ */
295
456
  writeBuffer() {
296
- console.log(this.buffer.join(`\n`));
297
- console.log();
457
+ this.sink.line(this.buffer.join(`\n`));
458
+ this.sink.line("");
298
459
  this.buffer = [];
299
460
  }
300
- writeError(message, buffered = false) {
461
+ writeError(message, buffered = false, meta) {
462
+ this.record("error", message, meta);
301
463
  if (buffered) {
302
464
  this.buffer.push(this.style.red(message));
303
465
  return;
304
466
  }
305
- this.write(this.style.red(message));
467
+ this.sink.line(this.style.red(message));
306
468
  }
307
- writeSuccess(message, buffered = false) {
469
+ writeSuccess(message, buffered = false, meta) {
470
+ this.record("success", message, meta);
308
471
  if (buffered) {
309
472
  this.buffer.push(this.style.green(message));
310
473
  return;
311
474
  }
312
- this.write(this.style.green(message));
475
+ this.sink.line(this.style.green(message));
313
476
  }
314
- writeWarning(message, buffered = false) {
477
+ writeWarning(message, buffered = false, meta) {
478
+ this.record("warn", message, meta);
315
479
  if (buffered) {
316
480
  this.buffer.push(this.style.yellow(message));
317
481
  return;
318
482
  }
319
- this.write(this.style.yellow(message));
483
+ this.sink.line(this.style.yellow(message));
320
484
  }
321
485
  execSync(command, options) {
322
486
  const result = safe(() => {
@@ -6,3 +6,5 @@ export * from "./cli-environment.js";
6
6
  export * from "./cli-environment-factory.js";
7
7
  export * from "./cli-settings.js";
8
8
  export * from "./command-build-context.js";
9
+ export * from "./sink.js";
10
+ export * from "./build-info.js";
@@ -6,3 +6,5 @@ export * from "./cli-environment.js";
6
6
  export * from "./cli-environment-factory.js";
7
7
  export * from "./cli-settings.js";
8
8
  export * from "./command-build-context.js";
9
+ export * from "./sink.js";
10
+ export * from "./build-info.js";