vika-cli 0.0.0-stage → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (243) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +37 -2
  3. package/dist/cli.js +32 -0
  4. package/dist/cli.js.map +1 -0
  5. package/dist/commands/approve-and-create-tickets.js +51 -0
  6. package/dist/commands/approve-and-create-tickets.js.map +1 -0
  7. package/dist/commands/create-tickets-command.js +30 -0
  8. package/dist/commands/create-tickets-command.js.map +1 -0
  9. package/dist/commands/doctor-command.js +59 -0
  10. package/dist/commands/doctor-command.js.map +1 -0
  11. package/dist/commands/init-command.js +21 -0
  12. package/dist/commands/init-command.js.map +1 -0
  13. package/dist/commands/mark-deploy-command.js +59 -0
  14. package/dist/commands/mark-deploy-command.js.map +1 -0
  15. package/dist/commands/report-command.js +40 -0
  16. package/dist/commands/report-command.js.map +1 -0
  17. package/dist/commands/run-cli.js +197 -0
  18. package/dist/commands/run-cli.js.map +1 -0
  19. package/dist/commands/run-exit-code.js +11 -0
  20. package/dist/commands/run-exit-code.js.map +1 -0
  21. package/dist/commands/serve-command.js +49 -0
  22. package/dist/commands/serve-command.js.map +1 -0
  23. package/dist/configuration/configuration-errors.js +43 -0
  24. package/dist/configuration/configuration-errors.js.map +1 -0
  25. package/dist/configuration/configuration-schema.js +69 -0
  26. package/dist/configuration/configuration-schema.js.map +1 -0
  27. package/dist/configuration/database-url-checks.js +43 -0
  28. package/dist/configuration/database-url-checks.js.map +1 -0
  29. package/dist/configuration/describe-configuration-safely.js +20 -0
  30. package/dist/configuration/describe-configuration-safely.js.map +1 -0
  31. package/dist/configuration/hide-secrets.js +44 -0
  32. package/dist/configuration/hide-secrets.js.map +1 -0
  33. package/dist/configuration/load-configuration.js +97 -0
  34. package/dist/configuration/load-configuration.js.map +1 -0
  35. package/dist/configuration/read-environment-file.js +77 -0
  36. package/dist/configuration/read-environment-file.js.map +1 -0
  37. package/dist/dashboard/dashboard-page.js +267 -0
  38. package/dist/dashboard/dashboard-page.js.map +1 -0
  39. package/dist/dashboard/dashboard-server.js +144 -0
  40. package/dist/dashboard/dashboard-server.js.map +1 -0
  41. package/dist/dashboard/github-issue-link.js +23 -0
  42. package/dist/dashboard/github-issue-link.js.map +1 -0
  43. package/dist/dashboard/request-guard.js +34 -0
  44. package/dist/dashboard/request-guard.js.map +1 -0
  45. package/dist/database/database-store.js +425 -0
  46. package/dist/database/database-store.js.map +1 -0
  47. package/dist/database/store-types.js +2 -0
  48. package/dist/database/store-types.js.map +1 -0
  49. package/dist/deploys/check-sha-on-branch.js +21 -0
  50. package/dist/deploys/check-sha-on-branch.js.map +1 -0
  51. package/dist/deploys/commits-in-range.js +31 -0
  52. package/dist/deploys/commits-in-range.js.map +1 -0
  53. package/dist/deploys/marker-deploys.js +18 -0
  54. package/dist/deploys/marker-deploys.js.map +1 -0
  55. package/dist/deploys/merge-log.js +33 -0
  56. package/dist/deploys/merge-log.js.map +1 -0
  57. package/dist/deploys/pull-request-number.js +5 -0
  58. package/dist/deploys/pull-request-number.js.map +1 -0
  59. package/dist/deploys/read-merge-deploys.js +46 -0
  60. package/dist/deploys/read-merge-deploys.js.map +1 -0
  61. package/dist/deploys/record-deploys.js +12 -0
  62. package/dist/deploys/record-deploys.js.map +1 -0
  63. package/dist/deploys/run-git.js +49 -0
  64. package/dist/deploys/run-git.js.map +1 -0
  65. package/dist/deploys/starting-point.js +5 -0
  66. package/dist/deploys/starting-point.js.map +1 -0
  67. package/dist/deploys/utc-timestamp.js +6 -0
  68. package/dist/deploys/utc-timestamp.js.map +1 -0
  69. package/dist/doctor/check-configuration.js +46 -0
  70. package/dist/doctor/check-configuration.js.map +1 -0
  71. package/dist/doctor/check-database.js +30 -0
  72. package/dist/doctor/check-database.js.map +1 -0
  73. package/dist/doctor/check-deploys.js +22 -0
  74. package/dist/doctor/check-deploys.js.map +1 -0
  75. package/dist/doctor/check-service-logs.js +107 -0
  76. package/dist/doctor/check-service-logs.js.map +1 -0
  77. package/dist/doctor/check-service-repository.js +43 -0
  78. package/dist/doctor/check-service-repository.js.map +1 -0
  79. package/dist/doctor/check-tracker.js +20 -0
  80. package/dist/doctor/check-tracker.js.map +1 -0
  81. package/dist/doctor/check-webhook.js +13 -0
  82. package/dist/doctor/check-webhook.js.map +1 -0
  83. package/dist/doctor/doctor-check-types.js +4 -0
  84. package/dist/doctor/doctor-check-types.js.map +1 -0
  85. package/dist/doctor/format-doctor-report.js +15 -0
  86. package/dist/doctor/format-doctor-report.js.map +1 -0
  87. package/dist/doctor/suggest-path-map.js +35 -0
  88. package/dist/doctor/suggest-path-map.js.map +1 -0
  89. package/dist/error-grouping/build-clusters.js +77 -0
  90. package/dist/error-grouping/build-clusters.js.map +1 -0
  91. package/dist/error-grouping/cluster-types.js +3 -0
  92. package/dist/error-grouping/cluster-types.js.map +1 -0
  93. package/dist/error-grouping/exception-type.js +6 -0
  94. package/dist/error-grouping/exception-type.js.map +1 -0
  95. package/dist/error-grouping/fingerprints.js +18 -0
  96. package/dist/error-grouping/fingerprints.js.map +1 -0
  97. package/dist/error-grouping/normalize-message.js +29 -0
  98. package/dist/error-grouping/normalize-message.js.map +1 -0
  99. package/dist/error-grouping/template-miner.js +75 -0
  100. package/dist/error-grouping/template-miner.js.map +1 -0
  101. package/dist/log-parsing/assemble-log-entries.js +49 -0
  102. package/dist/log-parsing/assemble-log-entries.js.map +1 -0
  103. package/dist/log-parsing/build-log-entry.js +33 -0
  104. package/dist/log-parsing/build-log-entry.js.map +1 -0
  105. package/dist/log-parsing/detect-log-format.js +44 -0
  106. package/dist/log-parsing/detect-log-format.js.map +1 -0
  107. package/dist/log-parsing/json-log-format.js +56 -0
  108. package/dist/log-parsing/json-log-format.js.map +1 -0
  109. package/dist/log-parsing/line-readers.js +14 -0
  110. package/dist/log-parsing/line-readers.js.map +1 -0
  111. package/dist/log-parsing/log-entry-types.js +3 -0
  112. package/dist/log-parsing/log-entry-types.js.map +1 -0
  113. package/dist/log-parsing/log-levels.js +21 -0
  114. package/dist/log-parsing/log-levels.js.map +1 -0
  115. package/dist/log-parsing/nginx-log-format.js +56 -0
  116. package/dist/log-parsing/nginx-log-format.js.map +1 -0
  117. package/dist/log-parsing/parse-log-lines.js +11 -0
  118. package/dist/log-parsing/parse-log-lines.js.map +1 -0
  119. package/dist/log-parsing/read-line-timestamp.js +21 -0
  120. package/dist/log-parsing/read-line-timestamp.js.map +1 -0
  121. package/dist/log-parsing/read-log-command.js +68 -0
  122. package/dist/log-parsing/read-log-command.js.map +1 -0
  123. package/dist/log-parsing/read-log-file.js +32 -0
  124. package/dist/log-parsing/read-log-file.js.map +1 -0
  125. package/dist/log-parsing/stack-frames.js +10 -0
  126. package/dist/log-parsing/stack-frames.js.map +1 -0
  127. package/dist/log-parsing/text-log-format.js +24 -0
  128. package/dist/log-parsing/text-log-format.js.map +1 -0
  129. package/dist/log-parsing/timestamps.js +22 -0
  130. package/dist/log-parsing/timestamps.js.map +1 -0
  131. package/dist/pipeline/analyze-service.js +45 -0
  132. package/dist/pipeline/analyze-service.js.map +1 -0
  133. package/dist/pipeline/build-stored-report.js +24 -0
  134. package/dist/pipeline/build-stored-report.js.map +1 -0
  135. package/dist/pipeline/ingest-service-logs.js +39 -0
  136. package/dist/pipeline/ingest-service-logs.js.map +1 -0
  137. package/dist/pipeline/load-deploys-for-service.js +16 -0
  138. package/dist/pipeline/load-deploys-for-service.js.map +1 -0
  139. package/dist/pipeline/prepare-ticket-drafts.js +33 -0
  140. package/dist/pipeline/prepare-ticket-drafts.js.map +1 -0
  141. package/dist/pipeline/read-new-log-lines.js +39 -0
  142. package/dist/pipeline/read-new-log-lines.js.map +1 -0
  143. package/dist/pipeline/run-all-services.js +73 -0
  144. package/dist/pipeline/run-all-services.js.map +1 -0
  145. package/dist/pipeline/timestamp-range.js +20 -0
  146. package/dist/pipeline/timestamp-range.js.map +1 -0
  147. package/dist/project-setup/detect-project.js +76 -0
  148. package/dist/project-setup/detect-project.js.map +1 -0
  149. package/dist/project-setup/write-starter-files.js +68 -0
  150. package/dist/project-setup/write-starter-files.js.map +1 -0
  151. package/dist/redaction/redact-ip-addresses.js +26 -0
  152. package/dist/redaction/redact-ip-addresses.js.map +1 -0
  153. package/dist/redaction/redact-sensitive-text.js +40 -0
  154. package/dist/redaction/redact-sensitive-text.js.map +1 -0
  155. package/dist/redaction/redaction-kinds.js +5 -0
  156. package/dist/redaction/redaction-kinds.js.map +1 -0
  157. package/dist/regression-detection/count-series.js +38 -0
  158. package/dist/regression-detection/count-series.js.map +1 -0
  159. package/dist/regression-detection/detect-regressions.js +162 -0
  160. package/dist/regression-detection/detect-regressions.js.map +1 -0
  161. package/dist/regression-detection/detection-types.js +9 -0
  162. package/dist/regression-detection/detection-types.js.map +1 -0
  163. package/dist/regression-detection/noise-check.js +7 -0
  164. package/dist/regression-detection/noise-check.js.map +1 -0
  165. package/dist/regression-detection/restore-time.js +19 -0
  166. package/dist/regression-detection/restore-time.js.map +1 -0
  167. package/dist/regression-detection/severity.js +12 -0
  168. package/dist/regression-detection/severity.js.map +1 -0
  169. package/dist/regression-detection/time-units.js +12 -0
  170. package/dist/regression-detection/time-units.js.map +1 -0
  171. package/dist/reporting/build-report.js +77 -0
  172. package/dist/reporting/build-report.js.map +1 -0
  173. package/dist/reporting/compute-metrics.js +42 -0
  174. package/dist/reporting/compute-metrics.js.map +1 -0
  175. package/dist/reporting/format-terminal-report.js +104 -0
  176. package/dist/reporting/format-terminal-report.js.map +1 -0
  177. package/dist/reporting/report-schema.js +96 -0
  178. package/dist/reporting/report-schema.js.map +1 -0
  179. package/dist/reporting/report-types.js +2 -0
  180. package/dist/reporting/report-types.js.map +1 -0
  181. package/dist/suspect-attribution/apply-path-map.js +31 -0
  182. package/dist/suspect-attribution/apply-path-map.js.map +1 -0
  183. package/dist/suspect-attribution/attribute-regression.js +176 -0
  184. package/dist/suspect-attribution/attribute-regression.js.map +1 -0
  185. package/dist/suspect-attribution/bot-authors.js +8 -0
  186. package/dist/suspect-attribution/bot-authors.js.map +1 -0
  187. package/dist/suspect-attribution/callee-files.js +53 -0
  188. package/dist/suspect-attribution/callee-files.js.map +1 -0
  189. package/dist/suspect-attribution/changed-file-categories.js +39 -0
  190. package/dist/suspect-attribution/changed-file-categories.js.map +1 -0
  191. package/dist/suspect-attribution/crash-line-inputs.js +81 -0
  192. package/dist/suspect-attribution/crash-line-inputs.js.map +1 -0
  193. package/dist/suspect-attribution/function-names.js +42 -0
  194. package/dist/suspect-attribution/function-names.js.map +1 -0
  195. package/dist/suspect-attribution/git-blame-reader.js +160 -0
  196. package/dist/suspect-attribution/git-blame-reader.js.map +1 -0
  197. package/dist/suspect-attribution/score-suspects.js +100 -0
  198. package/dist/suspect-attribution/score-suspects.js.map +1 -0
  199. package/dist/suspect-attribution/suspect-types.js +2 -0
  200. package/dist/suspect-attribution/suspect-types.js.map +1 -0
  201. package/dist/ticket-trackers/create-tracker.js +21 -0
  202. package/dist/ticket-trackers/create-tracker.js.map +1 -0
  203. package/dist/ticket-trackers/jira-document.js +34 -0
  204. package/dist/ticket-trackers/jira-document.js.map +1 -0
  205. package/dist/ticket-trackers/jira-tracker.js +65 -0
  206. package/dist/ticket-trackers/jira-tracker.js.map +1 -0
  207. package/dist/ticket-trackers/linear-tracker.js +109 -0
  208. package/dist/ticket-trackers/linear-tracker.js.map +1 -0
  209. package/dist/ticket-trackers/send-tracker-request.js +84 -0
  210. package/dist/ticket-trackers/send-tracker-request.js.map +1 -0
  211. package/dist/ticket-trackers/tracker-types.js +3 -0
  212. package/dist/ticket-trackers/tracker-types.js.map +1 -0
  213. package/dist/ticketing/build-ticket-comment.js +14 -0
  214. package/dist/ticketing/build-ticket-comment.js.map +1 -0
  215. package/dist/ticketing/build-ticket-draft.js +172 -0
  216. package/dist/ticketing/build-ticket-draft.js.map +1 -0
  217. package/dist/ticketing/choose-assignee.js +30 -0
  218. package/dist/ticketing/choose-assignee.js.map +1 -0
  219. package/dist/ticketing/create-ticket.js +92 -0
  220. package/dist/ticketing/create-ticket.js.map +1 -0
  221. package/dist/ticketing/describe-ticket-outcome.js +24 -0
  222. package/dist/ticketing/describe-ticket-outcome.js.map +1 -0
  223. package/dist/ticketing/read-code-owners.js +82 -0
  224. package/dist/ticketing/read-code-owners.js.map +1 -0
  225. package/dist/ticketing/render-ticket-text.js +22 -0
  226. package/dist/ticketing/render-ticket-text.js.map +1 -0
  227. package/dist/ticketing/ticket-types.js +2 -0
  228. package/dist/ticketing/ticket-types.js.map +1 -0
  229. package/dist/webhook/build-webhook-payload.js +29 -0
  230. package/dist/webhook/build-webhook-payload.js.map +1 -0
  231. package/dist/webhook/send-regression-webhooks.js +57 -0
  232. package/dist/webhook/send-regression-webhooks.js.map +1 -0
  233. package/dist/webhook/sign-webhook-body.js +16 -0
  234. package/dist/webhook/sign-webhook-body.js.map +1 -0
  235. package/dist/webhook/webhook-payload-schema.js +32 -0
  236. package/dist/webhook/webhook-payload-schema.js.map +1 -0
  237. package/migrations/001_init.sql +66 -0
  238. package/migrations/002_bookmark_history_start.sql +9 -0
  239. package/migrations/003_tickets.sql +20 -0
  240. package/migrations/004_ticket_comment_count.sql +10 -0
  241. package/migrations/005_webhook_events.sql +18 -0
  242. package/migrations/README.md +1 -0
  243. package/package.json +37 -3
@@ -0,0 +1,11 @@
1
+ export const EXIT_CODE_OK = 0;
2
+ export const EXIT_CODE_FAILURE = 1;
3
+ export const EXIT_CODE_BUSY = 2;
4
+ export function chooseRunExitCode(serviceStatuses, hasTicketFailure) {
5
+ if (hasTicketFailure || serviceStatuses.some((serviceStatus) => serviceStatus.status === "failed"))
6
+ return EXIT_CODE_FAILURE;
7
+ if (serviceStatuses.some((serviceStatus) => serviceStatus.status === "busy"))
8
+ return EXIT_CODE_BUSY;
9
+ return EXIT_CODE_OK;
10
+ }
11
+ //# sourceMappingURL=run-exit-code.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"run-exit-code.js","sourceRoot":"","sources":["../../src/commands/run-exit-code.ts"],"names":[],"mappings":"AAOA,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,CAAC;AAC9B,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC;AACnC,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC;AAEhC,MAAM,UAAU,iBAAiB,CAAC,eAAmC,EAAE,gBAAyB;IAC9F,IAAI,gBAAgB,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,EAAE,CAAC,aAAa,CAAC,MAAM,KAAK,QAAQ,CAAC;QAAE,OAAO,iBAAiB,CAAC;IAC7H,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,EAAE,CAAC,aAAa,CAAC,MAAM,KAAK,MAAM,CAAC;QAAE,OAAO,cAAc,CAAC;IACpG,OAAO,YAAY,CAAC;AACtB,CAAC"}
@@ -0,0 +1,49 @@
1
+ // `vika serve`: starts the local dashboard on 127.0.0.1 and keeps it running
2
+ // until stop() (Ctrl+C in the CLI). Opening the store may apply pending
3
+ // migrations to vika's own tables; nothing else is ever written except
4
+ // tickets someone files from the page.
5
+ import { collectSecrets, runWithSecretsHidden } from "../configuration/hide-secrets.js";
6
+ import { loadConfiguration } from "../configuration/load-configuration.js";
7
+ import { openStore } from "../database/database-store.js";
8
+ import { startDashboardServer } from "../dashboard/dashboard-server.js";
9
+ export function parsePort(text) {
10
+ const port = Number(text);
11
+ if (!Number.isInteger(port) || port < 0 || port > 65_535)
12
+ throw new Error(`--port must be a whole number from 0 to 65535 (got "${text}")`);
13
+ return port;
14
+ }
15
+ export async function runServeCommand(options) {
16
+ const configuration = loadConfiguration({
17
+ workingDirectory: options.workingDirectory,
18
+ ...(options.configurationPath === undefined ? {} : { configurationPath: options.configurationPath }),
19
+ ...(options.environment === undefined ? {} : { environment: options.environment }),
20
+ });
21
+ return runWithSecretsHidden(configuration, async () => {
22
+ const store = await openStore(configuration.databaseUrl, options.storeOptions);
23
+ try {
24
+ const dashboard = await startDashboardServer({
25
+ configuration,
26
+ store,
27
+ fetchFunction: options.fetchFunction,
28
+ secrets: collectSecrets(configuration),
29
+ port: options.port,
30
+ });
31
+ return {
32
+ dashboard,
33
+ configuration,
34
+ stop: async () => {
35
+ await dashboard.close();
36
+ await store.close();
37
+ },
38
+ };
39
+ }
40
+ catch (error) {
41
+ await store.close();
42
+ // The most common reason, said plainly.
43
+ if (error.code === "EADDRINUSE")
44
+ throw new Error(`port ${options.port} is already in use; pick another with --port`);
45
+ throw error;
46
+ }
47
+ });
48
+ }
49
+ //# sourceMappingURL=serve-command.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"serve-command.js","sourceRoot":"","sources":["../../src/commands/serve-command.ts"],"names":[],"mappings":"AAAA,6EAA6E;AAC7E,wEAAwE;AACxE,uEAAuE;AACvE,uCAAuC;AACvC,OAAO,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AACxF,OAAO,EAAE,iBAAiB,EAA4B,MAAM,wCAAwC,CAAC;AACrG,OAAO,EAAE,SAAS,EAAE,MAAM,+BAA+B,CAAC;AAE1D,OAAO,EAAE,oBAAoB,EAAyB,MAAM,kCAAkC,CAAC;AAkB/F,MAAM,UAAU,SAAS,CAAC,IAAY;IACpC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;IAC1B,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,IAAI,GAAG,CAAC,IAAI,IAAI,GAAG,MAAM;QAAE,MAAM,IAAI,KAAK,CAAC,uDAAuD,IAAI,IAAI,CAAC,CAAC;IAC3I,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,OAA4B;IAChE,MAAM,aAAa,GAAG,iBAAiB,CAAC;QACtC,gBAAgB,EAAE,OAAO,CAAC,gBAAgB;QAC1C,GAAG,CAAC,OAAO,CAAC,iBAAiB,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,OAAO,CAAC,iBAAiB,EAAE,CAAC;QACpG,GAAG,CAAC,OAAO,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,CAAC;KACnF,CAAC,CAAC;IACH,OAAO,oBAAoB,CAAC,aAAa,EAAE,KAAK,IAAI,EAAE;QACpD,MAAM,KAAK,GAAG,MAAM,SAAS,CAAC,aAAa,CAAC,WAAW,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;QAC/E,IAAI,CAAC;YACH,MAAM,SAAS,GAAG,MAAM,oBAAoB,CAAC;gBAC3C,aAAa;gBACb,KAAK;gBACL,aAAa,EAAE,OAAO,CAAC,aAAa;gBACpC,OAAO,EAAE,cAAc,CAAC,aAAa,CAAC;gBACtC,IAAI,EAAE,OAAO,CAAC,IAAI;aACnB,CAAC,CAAC;YACH,OAAO;gBACL,SAAS;gBACT,aAAa;gBACb,IAAI,EAAE,KAAK,IAAI,EAAE;oBACf,MAAM,SAAS,CAAC,KAAK,EAAE,CAAC;oBACxB,MAAM,KAAK,CAAC,KAAK,EAAE,CAAC;gBACtB,CAAC;aACF,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,KAAK,CAAC,KAAK,EAAE,CAAC;YACpB,wCAAwC;YACxC,IAAK,KAA+B,CAAC,IAAI,KAAK,YAAY;gBAAE,MAAM,IAAI,KAAK,CAAC,QAAQ,OAAO,CAAC,IAAI,8CAA8C,CAAC,CAAC;YAChJ,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC"}
@@ -0,0 +1,43 @@
1
+ export class ConfigurationError extends Error {
2
+ problems;
3
+ constructor(heading, problems) {
4
+ super(`${heading}\n${problems.map((problem) => ` - ${problem}`).join("\n")}`);
5
+ this.name = "ConfigurationError";
6
+ this.problems = problems;
7
+ }
8
+ }
9
+ // ["services", "api", "logs"] -> "services.api.logs"; ["redact", 0] -> "redact[0]".
10
+ function formatSettingName(path) {
11
+ let settingName = "";
12
+ for (const part of path) {
13
+ if (typeof part === "number")
14
+ settingName += `[${part}]`;
15
+ else
16
+ settingName += settingName === "" ? String(part) : `.${String(part)}`;
17
+ }
18
+ return settingName === "" ? "vika.yaml" : settingName;
19
+ }
20
+ // zod issues (parsed with reportInput: true) -> plain-English problems.
21
+ // The input is only ever echoed for short choice values, never for whole objects.
22
+ export function describeSchemaIssues(issues) {
23
+ return issues.flatMap((issue) => {
24
+ const settingName = formatSettingName(issue.path);
25
+ if (issue.code === "unrecognized_keys") {
26
+ return issue.keys.map((key) => `${formatSettingName([...issue.path, key])} is not a known setting (check the spelling)`);
27
+ }
28
+ if (issue.code === "invalid_key") {
29
+ return [`service name "${String(issue.input)}" is not allowed: use lowercase letters, digits and dashes only`];
30
+ }
31
+ // A setting that isn't there at all.
32
+ if ((issue.code === "invalid_type" || issue.code === "invalid_union") && issue.input === undefined) {
33
+ return [`${settingName} is missing`];
34
+ }
35
+ if (issue.code === "invalid_value") {
36
+ const choices = issue.values.map((value) => `"${String(value)}"`).join(", ");
37
+ return [`${settingName} must be one of ${choices} (got "${String(issue.input)}")`];
38
+ }
39
+ // Every other message comes from the schema and reads after the name.
40
+ return [`${settingName} ${issue.message}`];
41
+ });
42
+ }
43
+ //# sourceMappingURL=configuration-errors.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"configuration-errors.js","sourceRoot":"","sources":["../../src/configuration/configuration-errors.ts"],"names":[],"mappings":"AAKA,MAAM,OAAO,kBAAmB,SAAQ,KAAK;IAClC,QAAQ,CAAW;IAE5B,YAAY,OAAe,EAAE,QAAkB;QAC7C,KAAK,CAAC,GAAG,OAAO,KAAK,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC/E,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC;QACjC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;CACF;AAED,oFAAoF;AACpF,SAAS,iBAAiB,CAAC,IAAmB;IAC5C,IAAI,WAAW,GAAG,EAAE,CAAC;IACrB,KAAK,MAAM,IAAI,IAAI,IAAI,EAAE,CAAC;QACxB,IAAI,OAAO,IAAI,KAAK,QAAQ;YAAE,WAAW,IAAI,IAAI,IAAI,GAAG,CAAC;;YACpD,WAAW,IAAI,WAAW,KAAK,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;IAC7E,CAAC;IACD,OAAO,WAAW,KAAK,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC;AACxD,CAAC;AAED,wEAAwE;AACxE,kFAAkF;AAClF,MAAM,UAAU,oBAAoB,CAAC,MAA0B;IAC7D,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAY,EAAE;QACxC,MAAM,WAAW,GAAG,iBAAiB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAClD,IAAI,KAAK,CAAC,IAAI,KAAK,mBAAmB,EAAE,CAAC;YACvC,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,iBAAiB,CAAC,CAAC,GAAG,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,8CAA8C,CAAC,CAAC;QAC3H,CAAC;QACD,IAAI,KAAK,CAAC,IAAI,KAAK,aAAa,EAAE,CAAC;YACjC,OAAO,CAAC,iBAAiB,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,iEAAiE,CAAC,CAAC;QACjH,CAAC;QACD,qCAAqC;QACrC,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,cAAc,IAAI,KAAK,CAAC,IAAI,KAAK,eAAe,CAAC,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YACnG,OAAO,CAAC,GAAG,WAAW,aAAa,CAAC,CAAC;QACvC,CAAC;QACD,IAAI,KAAK,CAAC,IAAI,KAAK,eAAe,EAAE,CAAC;YACnC,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC7E,OAAO,CAAC,GAAG,WAAW,mBAAmB,OAAO,UAAU,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACrF,CAAC;QACD,sEAAsE;QACtE,OAAO,CAAC,GAAG,WAAW,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;IAC7C,CAAC,CAAC,CAAC;AACL,CAAC"}
@@ -0,0 +1,69 @@
1
+ // The shape of vika.yaml, as a zod schema, and the TypeScript types it gives.
2
+ //
3
+ // The keys here (services, repo, logs, command, pathMap, branch, pathPrefix,
4
+ // deploys, source, tracker, type, project, team, redact) are what customers
5
+ // write in vika.yaml. Never rename them: that would break existing files.
6
+ //
7
+ // Every check has its own plain-English message ("must not be empty"), so
8
+ // configuration-errors.ts can print "services.api.branch must not be empty".
9
+ // Unknown keys are rejected, so a typo like "brnach:" is caught instead of
10
+ // silently falling back to the default.
11
+ import { z } from "zod";
12
+ import { REDACTION_KINDS } from "../redaction/redaction-kinds.js";
13
+ // Service names become labels and database keys, so keep them simple.
14
+ export const SERVICE_NAME_PATTERN = /^[a-z0-9-]+$/;
15
+ export const DEPLOY_SOURCES = ["merges", "marker", "logs-version", "github"];
16
+ const requiredText = () => z.string({ error: "must be text" }).min(1, { error: "must not be empty" });
17
+ const logsSchema = z.union([requiredText(), z.strictObject({ command: requiredText() })], {
18
+ error: 'must be a log file path (or glob), or { command: "..." } with the command that prints the logs',
19
+ });
20
+ const serviceSchema = z.strictObject({
21
+ repo: requiredText(), // path to the git checkout
22
+ logs: logsSchema,
23
+ pathMap: z.record(z.string(), z.string({ error: "must be text" }), { error: "must be a map of prefix: prefix" }).optional(),
24
+ branch: requiredText().default("main"),
25
+ pathPrefix: requiredText().optional(), // monorepo: the service lives under this folder
26
+ deploys: z
27
+ .strictObject({ source: z.enum(DEPLOY_SOURCES) }, { error: "must be { source: ... }" })
28
+ .default(() => ({ source: "merges" })),
29
+ }, { error: "must be a map of settings (repo, logs, ...)" });
30
+ const trackerSchema = z
31
+ .discriminatedUnion("type", [
32
+ z.strictObject({ type: z.literal("jira"), project: requiredText(), issueType: requiredText().default("Bug") }),
33
+ z.strictObject({ type: z.literal("linear"), team: requiredText() }),
34
+ z.strictObject({ type: z.literal("none") }),
35
+ ], { error: 'must be "jira", "linear" or "none"' })
36
+ .default(() => ({ type: "none" }));
37
+ // Plain http would send regressions (and the signature) in the clear, so
38
+ // only https is allowed, except to this computer itself.
39
+ const LOCAL_HOSTS = new Set(["localhost", "127.0.0.1", "[::1]"]);
40
+ const webhookSchema = z.strictObject({
41
+ url: z.string({ error: "must be text" }).superRefine((text, context) => {
42
+ let parsedUrl;
43
+ try {
44
+ parsedUrl = new URL(text);
45
+ }
46
+ catch {
47
+ context.addIssue({ code: "custom", message: "must be a full URL, like https://hooks.example.com/vika" });
48
+ return;
49
+ }
50
+ const isLocal = LOCAL_HOSTS.has(parsedUrl.hostname);
51
+ if (parsedUrl.protocol !== "https:" && !(parsedUrl.protocol === "http:" && isLocal)) {
52
+ context.addIssue({ code: "custom", message: "must use https (plain http is only allowed for localhost)" });
53
+ }
54
+ }),
55
+ // The signing secret is a secret: it belongs in .env, never in vika.yaml.
56
+ secret: z.undefined({ error: "must not be in vika.yaml: put it in .env as VIKA_WEBHOOK_SECRET" }).optional(),
57
+ }, { error: "must be { url: ... }" });
58
+ export const vikaYamlSchema = z.strictObject({
59
+ services: z
60
+ .record(z.string().regex(SERVICE_NAME_PATTERN), serviceSchema, { error: "must be a map of service names to their settings" })
61
+ .refine((services) => Object.keys(services).length > 0, { error: "must list at least one service" }),
62
+ tracker: trackerSchema,
63
+ redact: z
64
+ .array(z.enum(REDACTION_KINDS), { error: "must be a list" })
65
+ .min(1, { error: "must list at least one kind (email, jwt, ip, cardlike): redacting nothing is unsafe" })
66
+ .default(() => [...REDACTION_KINDS]),
67
+ webhook: webhookSchema.optional(),
68
+ }, { error: "must be a map of settings (services, tracker, redact, webhook)" });
69
+ //# sourceMappingURL=configuration-schema.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"configuration-schema.js","sourceRoot":"","sources":["../../src/configuration/configuration-schema.ts"],"names":[],"mappings":"AAAA,8EAA8E;AAC9E,EAAE;AACF,6EAA6E;AAC7E,4EAA4E;AAC5E,0EAA0E;AAC1E,EAAE;AACF,0EAA0E;AAC1E,6EAA6E;AAC7E,2EAA2E;AAC3E,wCAAwC;AACxC,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAElE,sEAAsE;AACtE,MAAM,CAAC,MAAM,oBAAoB,GAAG,cAAc,CAAC;AACnD,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,QAAQ,EAAE,QAAQ,EAAE,cAAc,EAAE,QAAQ,CAAU,CAAC;AAEtF,MAAM,YAAY,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,cAAc,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,KAAK,EAAE,mBAAmB,EAAE,CAAC,CAAC;AAEtG,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC,YAAY,CAAC,EAAE,OAAO,EAAE,YAAY,EAAE,EAAE,CAAC,CAAC,EAAE;IACxF,KAAK,EAAE,gGAAgG;CACxG,CAAC,CAAC;AAEH,MAAM,aAAa,GAAG,CAAC,CAAC,YAAY,CAClC;IACE,IAAI,EAAE,YAAY,EAAE,EAAE,2BAA2B;IACjD,IAAI,EAAE,UAAU;IAChB,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,cAAc,EAAE,CAAC,EAAE,EAAE,KAAK,EAAE,iCAAiC,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC3H,MAAM,EAAE,YAAY,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC;IACtC,UAAU,EAAE,YAAY,EAAE,CAAC,QAAQ,EAAE,EAAE,gDAAgD;IACvF,OAAO,EAAE,CAAC;SACP,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,yBAAyB,EAAE,CAAC;SACtF,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,QAAiB,EAAE,CAAC,CAAC;CAClD,EACD,EAAE,KAAK,EAAE,6CAA6C,EAAE,CACzD,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC;KACpB,kBAAkB,CACjB,MAAM,EACN;IACE,CAAC,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,YAAY,EAAE,EAAE,SAAS,EAAE,YAAY,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;IAC9G,CAAC,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,EAAE,CAAC;IACnE,CAAC,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;CAC5C,EACD,EAAE,KAAK,EAAE,oCAAoC,EAAE,CAChD;KACA,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,MAAe,EAAE,CAAC,CAAC,CAAC;AAE9C,yEAAyE;AACzE,yDAAyD;AACzD,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,CAAC,WAAW,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC,CAAC;AAEjE,MAAM,aAAa,GAAG,CAAC,CAAC,YAAY,CAClC;IACE,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,cAAc,EAAE,CAAC,CAAC,WAAW,CAAC,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE;QACrE,IAAI,SAAc,CAAC;QACnB,IAAI,CAAC;YACH,SAAS,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC;QAC5B,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,yDAAyD,EAAE,CAAC,CAAC;YACzG,OAAO;QACT,CAAC;QACD,MAAM,OAAO,GAAG,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QACpD,IAAI,SAAS,CAAC,QAAQ,KAAK,QAAQ,IAAI,CAAC,CAAC,SAAS,CAAC,QAAQ,KAAK,OAAO,IAAI,OAAO,CAAC,EAAE,CAAC;YACpF,OAAO,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,2DAA2D,EAAE,CAAC,CAAC;QAC7G,CAAC;IACH,CAAC,CAAC;IACF,0EAA0E;IAC1E,MAAM,EAAE,CAAC,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,iEAAiE,EAAE,CAAC,CAAC,QAAQ,EAAE;CAC7G,EACD,EAAE,KAAK,EAAE,sBAAsB,EAAE,CAClC,CAAC;AAEF,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,YAAY,CAC1C;IACE,QAAQ,EAAE,CAAC;SACR,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,oBAAoB,CAAC,EAAE,aAAa,EAAE,EAAE,KAAK,EAAE,kDAAkD,EAAE,CAAC;SAC5H,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,EAAE,KAAK,EAAE,gCAAgC,EAAE,CAAC;IACtG,OAAO,EAAE,aAAa;IACtB,MAAM,EAAE,CAAC;SACN,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE,EAAE,KAAK,EAAE,gBAAgB,EAAE,CAAC;SAC3D,GAAG,CAAC,CAAC,EAAE,EAAE,KAAK,EAAE,qFAAqF,EAAE,CAAC;SACxG,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,GAAG,eAAe,CAAC,CAAC;IACtC,OAAO,EAAE,aAAa,CAAC,QAAQ,EAAE;CAClC,EACD,EAAE,KAAK,EAAE,gEAAgE,EAAE,CAC5E,CAAC"}
@@ -0,0 +1,43 @@
1
+ // Checks on DATABASE_URL that don't need a connection: is it a URL at all,
2
+ // and is it set up in a way known to cause trouble. Never echoes the URL,
3
+ // since it holds a password.
4
+ const LOCAL_HOSTS = new Set(["localhost", "127.0.0.1", "::1", "[::1]"]);
5
+ // Query parameters that can carry a secret.
6
+ const SECRET_PARAMETERS = new Set(["password", "sslpassword", "sslkey"]);
7
+ const MASK = "****";
8
+ export function parseDatabaseUrl(databaseUrl) {
9
+ try {
10
+ return new URL(databaseUrl);
11
+ }
12
+ catch {
13
+ return undefined;
14
+ }
15
+ }
16
+ // Advice, not errors: vika still runs, but the operator should know.
17
+ export function findDatabaseUrlWarnings(databaseUrl) {
18
+ const warnings = [];
19
+ const hostname = databaseUrl.hostname.toLowerCase();
20
+ if (hostname.includes("-pooler")) {
21
+ warnings.push('DATABASE_URL points at a connection pooler ("-pooler" in the host). Advisory locks can break through a pooler; use the direct connection string.');
22
+ }
23
+ // An empty host means a local Unix socket.
24
+ const isLocal = hostname === "" || LOCAL_HOSTS.has(hostname);
25
+ if (!isLocal && !databaseUrl.searchParams.has("sslmode")) {
26
+ warnings.push("DATABASE_URL is not on localhost and has no sslmode. Add ?sslmode=require so the connection is encrypted.");
27
+ }
28
+ return warnings;
29
+ }
30
+ // The URL with its password (and any secret query parameter) replaced by "****".
31
+ export function maskDatabaseUrl(databaseUrl) {
32
+ const parsedUrl = parseDatabaseUrl(databaseUrl);
33
+ if (parsedUrl === undefined)
34
+ return "(hidden: not a valid URL)";
35
+ if (parsedUrl.password !== "")
36
+ parsedUrl.password = MASK;
37
+ for (const parameterName of [...parsedUrl.searchParams.keys()]) {
38
+ if (SECRET_PARAMETERS.has(parameterName.toLowerCase()))
39
+ parsedUrl.searchParams.set(parameterName, MASK);
40
+ }
41
+ return parsedUrl.toString();
42
+ }
43
+ //# sourceMappingURL=database-url-checks.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"database-url-checks.js","sourceRoot":"","sources":["../../src/configuration/database-url-checks.ts"],"names":[],"mappings":"AAAA,2EAA2E;AAC3E,0EAA0E;AAC1E,6BAA6B;AAE7B,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,CAAC,WAAW,EAAE,WAAW,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;AACxE,4CAA4C;AAC5C,MAAM,iBAAiB,GAAG,IAAI,GAAG,CAAC,CAAC,UAAU,EAAE,aAAa,EAAE,QAAQ,CAAC,CAAC,CAAC;AACzE,MAAM,IAAI,GAAG,MAAM,CAAC;AAEpB,MAAM,UAAU,gBAAgB,CAAC,WAAmB;IAClD,IAAI,CAAC;QACH,OAAO,IAAI,GAAG,CAAC,WAAW,CAAC,CAAC;IAC9B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,qEAAqE;AACrE,MAAM,UAAU,uBAAuB,CAAC,WAAgB;IACtD,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;IACpD,IAAI,QAAQ,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;QACjC,QAAQ,CAAC,IAAI,CACX,kJAAkJ,CACnJ,CAAC;IACJ,CAAC;IACD,2CAA2C;IAC3C,MAAM,OAAO,GAAG,QAAQ,KAAK,EAAE,IAAI,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC7D,IAAI,CAAC,OAAO,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;QACzD,QAAQ,CAAC,IAAI,CAAC,2GAA2G,CAAC,CAAC;IAC7H,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,iFAAiF;AACjF,MAAM,UAAU,eAAe,CAAC,WAAmB;IACjD,MAAM,SAAS,GAAG,gBAAgB,CAAC,WAAW,CAAC,CAAC;IAChD,IAAI,SAAS,KAAK,SAAS;QAAE,OAAO,2BAA2B,CAAC;IAChE,IAAI,SAAS,CAAC,QAAQ,KAAK,EAAE;QAAE,SAAS,CAAC,QAAQ,GAAG,IAAI,CAAC;IACzD,KAAK,MAAM,aAAa,IAAI,CAAC,GAAG,SAAS,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC;QAC/D,IAAI,iBAAiB,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC;YAAE,SAAS,CAAC,YAAY,CAAC,GAAG,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;IAC1G,CAAC;IACD,OAAO,SAAS,CAAC,QAAQ,EAAE,CAAC;AAC9B,CAAC"}
@@ -0,0 +1,20 @@
1
+ import { maskDatabaseUrl } from "./database-url-checks.js";
2
+ const HIDDEN = "(set, hidden)";
3
+ export function describeConfigurationSafely(configuration) {
4
+ const credentials = configuration.trackerCredentials;
5
+ const trackerCredentials = credentials.type === "jira"
6
+ ? { type: "jira", baseUrl: credentials.baseUrl, email: credentials.email, apiToken: HIDDEN }
7
+ : credentials.type === "linear"
8
+ ? { type: "linear", apiKey: HIDDEN }
9
+ : { type: "none" };
10
+ return {
11
+ ...configuration,
12
+ databaseUrl: maskDatabaseUrl(configuration.databaseUrl),
13
+ trackerCredentials,
14
+ // The URL can carry a token too (many webhook URLs do), so show only its host.
15
+ webhook: configuration.webhook === null
16
+ ? null
17
+ : { url: `${new URL(configuration.webhook.url).origin}/(path hidden)`, secret: configuration.webhook.secret === null ? null : HIDDEN },
18
+ };
19
+ }
20
+ //# sourceMappingURL=describe-configuration-safely.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"describe-configuration-safely.js","sourceRoot":"","sources":["../../src/configuration/describe-configuration-safely.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAG3D,MAAM,MAAM,GAAG,eAAe,CAAC;AAM/B,MAAM,UAAU,2BAA2B,CAAC,aAAkC;IAC5E,MAAM,WAAW,GAAG,aAAa,CAAC,kBAAkB,CAAC;IACrD,MAAM,kBAAkB,GACtB,WAAW,CAAC,IAAI,KAAK,MAAM;QACzB,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,CAAC,OAAO,EAAE,KAAK,EAAE,WAAW,CAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE;QAC5F,CAAC,CAAC,WAAW,CAAC,IAAI,KAAK,QAAQ;YAC7B,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE;YACpC,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IACzB,OAAO;QACL,GAAG,aAAa;QAChB,WAAW,EAAE,eAAe,CAAC,aAAa,CAAC,WAAW,CAAC;QACvD,kBAAkB;QAClB,+EAA+E;QAC/E,OAAO,EACL,aAAa,CAAC,OAAO,KAAK,IAAI;YAC5B,CAAC,CAAC,IAAI;YACN,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,IAAI,GAAG,CAAC,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,gBAAgB,EAAE,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,EAAE;KAC3I,CAAC;AACJ,CAAC"}
@@ -0,0 +1,44 @@
1
+ import { parseDatabaseUrl } from "./database-url-checks.js";
2
+ const MASK = "****";
3
+ // A password shorter than this (like the docker-compose default "vika") is
4
+ // masked only where it appears as "user:password@": masking a short common
5
+ // word everywhere would garble every message and ticket that contains it.
6
+ // The full URL and every tracker token are always masked wherever they appear.
7
+ const MIN_FREESTANDING_SECRET_LENGTH = 6;
8
+ // The secret values in a configuration, longest first (so a password that
9
+ // contains another secret is masked whole).
10
+ export function collectSecrets(configuration) {
11
+ const secrets = [configuration.databaseUrl];
12
+ const parsedDatabaseUrl = parseDatabaseUrl(configuration.databaseUrl);
13
+ if (parsedDatabaseUrl !== undefined && parsedDatabaseUrl.password !== "") {
14
+ for (const password of [parsedDatabaseUrl.password, decodeURIComponent(parsedDatabaseUrl.password)]) {
15
+ secrets.push(password.length >= MIN_FREESTANDING_SECRET_LENGTH ? password : `${parsedDatabaseUrl.username}:${password}@`);
16
+ }
17
+ }
18
+ const credentials = configuration.trackerCredentials;
19
+ if (credentials.type === "jira")
20
+ secrets.push(credentials.apiToken);
21
+ if (credentials.type === "linear")
22
+ secrets.push(credentials.apiKey);
23
+ // Webhook URLs often carry a token in their path, so the whole URL is a secret.
24
+ if (configuration.webhook !== null) {
25
+ secrets.push(configuration.webhook.url);
26
+ if (configuration.webhook.secret !== null)
27
+ secrets.push(configuration.webhook.secret);
28
+ }
29
+ return [...new Set(secrets.filter((secret) => secret !== ""))].sort((left, right) => right.length - left.length);
30
+ }
31
+ export function hideSecrets(text, secrets) {
32
+ return secrets.reduce((maskedText, secret) => maskedText.split(secret).join(MASK), text);
33
+ }
34
+ // Runs the work; if it throws, throws the same message with secrets masked.
35
+ export async function runWithSecretsHidden(configuration, work) {
36
+ try {
37
+ return await work();
38
+ }
39
+ catch (error) {
40
+ const secrets = collectSecrets(configuration);
41
+ throw new Error(hideSecrets(error instanceof Error ? error.message : String(error), secrets));
42
+ }
43
+ }
44
+ //# sourceMappingURL=hide-secrets.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"hide-secrets.js","sourceRoot":"","sources":["../../src/configuration/hide-secrets.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAE5D,MAAM,IAAI,GAAG,MAAM,CAAC;AAEpB,2EAA2E;AAC3E,2EAA2E;AAC3E,0EAA0E;AAC1E,+EAA+E;AAC/E,MAAM,8BAA8B,GAAG,CAAC,CAAC;AAEzC,0EAA0E;AAC1E,4CAA4C;AAC5C,MAAM,UAAU,cAAc,CAAC,aAAkC;IAC/D,MAAM,OAAO,GAAG,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;IAC5C,MAAM,iBAAiB,GAAG,gBAAgB,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;IACtE,IAAI,iBAAiB,KAAK,SAAS,IAAI,iBAAiB,CAAC,QAAQ,KAAK,EAAE,EAAE,CAAC;QACzE,KAAK,MAAM,QAAQ,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE,kBAAkB,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC;YACpG,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,IAAI,8BAA8B,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,iBAAiB,CAAC,QAAQ,IAAI,QAAQ,GAAG,CAAC,CAAC;QAC5H,CAAC;IACH,CAAC;IACD,MAAM,WAAW,GAAG,aAAa,CAAC,kBAAkB,CAAC;IACrD,IAAI,WAAW,CAAC,IAAI,KAAK,MAAM;QAAE,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IACpE,IAAI,WAAW,CAAC,IAAI,KAAK,QAAQ;QAAE,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IACpE,gFAAgF;IAChF,IAAI,aAAa,CAAC,OAAO,KAAK,IAAI,EAAE,CAAC;QACnC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACxC,IAAI,aAAa,CAAC,OAAO,CAAC,MAAM,KAAK,IAAI;YAAE,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACxF,CAAC;IACD,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;AACnH,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,IAAY,EAAE,OAAiB;IACzD,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC;AAC3F,CAAC;AAED,4EAA4E;AAC5E,MAAM,CAAC,KAAK,UAAU,oBAAoB,CAAS,aAAkC,EAAE,IAA2B;IAChH,IAAI,CAAC;QACH,OAAO,MAAM,IAAI,EAAE,CAAC;IACtB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,OAAO,GAAG,cAAc,CAAC,aAAa,CAAC,CAAC;QAC9C,MAAM,IAAI,KAAK,CAAC,WAAW,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;IAChG,CAAC;AACH,CAAC"}
@@ -0,0 +1,97 @@
1
+ // Finds and loads vika.yaml and the .env next to it, checks both, and
2
+ // returns plain data. No database, no git, nothing is started.
3
+ //
4
+ // All problems found at one stage are reported together in one error:
5
+ // first everything wrong in vika.yaml, then every missing environment
6
+ // variable. Errors never include a secret value.
7
+ import { existsSync, readFileSync } from "node:fs";
8
+ import { dirname, join, resolve } from "node:path";
9
+ import { parse as parseYaml } from "yaml";
10
+ import { ConfigurationError, describeSchemaIssues } from "./configuration-errors.js";
11
+ import { vikaYamlSchema } from "./configuration-schema.js";
12
+ import { findDatabaseUrlWarnings, parseDatabaseUrl } from "./database-url-checks.js";
13
+ import { mergeEnvironment, readEnvironmentFile } from "./read-environment-file.js";
14
+ export const CONFIGURATION_FILE_NAME = "vika.yaml";
15
+ export const ENVIRONMENT_FILE_NAME = ".env";
16
+ // Where each tracker's secrets come from.
17
+ const TRACKER_VARIABLES = {
18
+ jira: ["JIRA_BASE_URL", "JIRA_EMAIL", "JIRA_API_TOKEN"],
19
+ linear: ["LINEAR_API_KEY"],
20
+ none: [],
21
+ };
22
+ function readYamlFile(configurationFilePath) {
23
+ let fileText;
24
+ try {
25
+ fileText = readFileSync(configurationFilePath, "utf8");
26
+ }
27
+ catch (error) {
28
+ throw new ConfigurationError(`Cannot read ${configurationFilePath}:`, [error.message]);
29
+ }
30
+ try {
31
+ // An empty file parses as null; treat it as an empty map so the
32
+ // message is "services is missing".
33
+ return parseYaml(fileText) ?? {};
34
+ }
35
+ catch (error) {
36
+ throw new ConfigurationError(`${configurationFilePath} is not valid YAML:`, [error.message]);
37
+ }
38
+ }
39
+ export function loadConfiguration(options) {
40
+ const workingDirectory = resolve(options.workingDirectory);
41
+ const configurationFilePath = resolve(workingDirectory, options.configurationPath ?? CONFIGURATION_FILE_NAME);
42
+ if (!existsSync(configurationFilePath)) {
43
+ throw new ConfigurationError("Configuration file not found:", [
44
+ `looked for ${configurationFilePath}` +
45
+ (options.configurationPath === undefined ? ` (pass a path to use a ${CONFIGURATION_FILE_NAME} somewhere else)` : ""),
46
+ ]);
47
+ }
48
+ const configurationDirectory = dirname(configurationFilePath);
49
+ // 1. vika.yaml
50
+ const parseResult = vikaYamlSchema.safeParse(readYamlFile(configurationFilePath), { reportInput: true });
51
+ if (!parseResult.success) {
52
+ throw new ConfigurationError(`Problems in ${configurationFilePath}:`, describeSchemaIssues(parseResult.error.issues));
53
+ }
54
+ const vikaYaml = parseResult.data;
55
+ // Relative repo paths mean "relative to vika.yaml", not to wherever vika was started.
56
+ const services = {};
57
+ for (const [serviceName, serviceSettings] of Object.entries(vikaYaml.services)) {
58
+ services[serviceName] = { ...serviceSettings, repo: resolve(configurationDirectory, serviceSettings.repo) };
59
+ }
60
+ // 2. The environment: the real one wins over .env.
61
+ const environment = mergeEnvironment(options.environment ?? process.env, readEnvironmentFile(join(configurationDirectory, ENVIRONMENT_FILE_NAME)));
62
+ const readVariable = (name) => {
63
+ const value = environment[name];
64
+ return value === undefined || value === "" ? undefined : value;
65
+ };
66
+ const trackerType = vikaYaml.tracker.type;
67
+ const missingProblems = ["DATABASE_URL", ...TRACKER_VARIABLES[trackerType]]
68
+ .filter((name) => readVariable(name) === undefined)
69
+ .map((name) => name === "DATABASE_URL"
70
+ ? "DATABASE_URL is not set (put it in .env)"
71
+ : `${name} is not set (put it in .env; needed because tracker.type is "${trackerType}")`);
72
+ if (missingProblems.length > 0)
73
+ throw new ConfigurationError("Missing environment variables:", missingProblems);
74
+ const databaseUrl = readVariable("DATABASE_URL");
75
+ const parsedDatabaseUrl = parseDatabaseUrl(databaseUrl);
76
+ if (parsedDatabaseUrl === undefined) {
77
+ throw new ConfigurationError("Bad environment variable:", [
78
+ "DATABASE_URL is not a valid URL (expected postgres://user:password@host:5432/database)",
79
+ ]);
80
+ }
81
+ const trackerCredentials = trackerType === "jira"
82
+ ? { type: "jira", baseUrl: readVariable("JIRA_BASE_URL"), email: readVariable("JIRA_EMAIL"), apiToken: readVariable("JIRA_API_TOKEN") }
83
+ : trackerType === "linear"
84
+ ? { type: "linear", apiKey: readVariable("LINEAR_API_KEY") }
85
+ : { type: "none" };
86
+ return {
87
+ services,
88
+ tracker: vikaYaml.tracker,
89
+ redact: vikaYaml.redact,
90
+ databaseUrl,
91
+ trackerCredentials,
92
+ webhook: vikaYaml.webhook === undefined ? null : { url: vikaYaml.webhook.url, secret: readVariable("VIKA_WEBHOOK_SECRET") ?? null },
93
+ configurationFilePath,
94
+ warnings: findDatabaseUrlWarnings(parsedDatabaseUrl),
95
+ };
96
+ }
97
+ //# sourceMappingURL=load-configuration.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"load-configuration.js","sourceRoot":"","sources":["../../src/configuration/load-configuration.ts"],"names":[],"mappings":"AAAA,sEAAsE;AACtE,+DAA+D;AAC/D,EAAE;AACF,sEAAsE;AACtE,sEAAsE;AACtE,iDAAiD;AACjD,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACnD,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACnD,OAAO,EAAE,KAAK,IAAI,SAAS,EAAE,MAAM,MAAM,CAAC;AAC1C,OAAO,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACrF,OAAO,EAAE,cAAc,EAAkE,MAAM,2BAA2B,CAAC;AAC3H,OAAO,EAAE,uBAAuB,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AACrF,OAAO,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AAEnF,MAAM,CAAC,MAAM,uBAAuB,GAAG,WAAW,CAAC;AACnD,MAAM,CAAC,MAAM,qBAAqB,GAAG,MAAM,CAAC;AA2B5C,0CAA0C;AAC1C,MAAM,iBAAiB,GAAG;IACxB,IAAI,EAAE,CAAC,eAAe,EAAE,YAAY,EAAE,gBAAgB,CAAC;IACvD,MAAM,EAAE,CAAC,gBAAgB,CAAC;IAC1B,IAAI,EAAE,EAAE;CACA,CAAC;AAEX,SAAS,YAAY,CAAC,qBAA6B;IACjD,IAAI,QAAgB,CAAC;IACrB,IAAI,CAAC;QACH,QAAQ,GAAG,YAAY,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC;IACzD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,kBAAkB,CAAC,eAAe,qBAAqB,GAAG,EAAE,CAAE,KAAe,CAAC,OAAO,CAAC,CAAC,CAAC;IACpG,CAAC;IACD,IAAI,CAAC;QACH,gEAAgE;QAChE,oCAAoC;QACpC,OAAO,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;IACnC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,kBAAkB,CAAC,GAAG,qBAAqB,qBAAqB,EAAE,CAAE,KAAe,CAAC,OAAO,CAAC,CAAC,CAAC;IAC1G,CAAC;AACH,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,OAAiC;IACjE,MAAM,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAC3D,MAAM,qBAAqB,GAAG,OAAO,CAAC,gBAAgB,EAAE,OAAO,CAAC,iBAAiB,IAAI,uBAAuB,CAAC,CAAC;IAC9G,IAAI,CAAC,UAAU,CAAC,qBAAqB,CAAC,EAAE,CAAC;QACvC,MAAM,IAAI,kBAAkB,CAAC,+BAA+B,EAAE;YAC5D,cAAc,qBAAqB,EAAE;gBACnC,CAAC,OAAO,CAAC,iBAAiB,KAAK,SAAS,CAAC,CAAC,CAAC,0BAA0B,uBAAuB,kBAAkB,CAAC,CAAC,CAAC,EAAE,CAAC;SACvH,CAAC,CAAC;IACL,CAAC;IACD,MAAM,sBAAsB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAE9D,eAAe;IACf,MAAM,WAAW,GAAG,cAAc,CAAC,SAAS,CAAC,YAAY,CAAC,qBAAqB,CAAC,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;IACzG,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC;QACzB,MAAM,IAAI,kBAAkB,CAAC,eAAe,qBAAqB,GAAG,EAAE,oBAAoB,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;IACxH,CAAC;IACD,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC;IAElC,sFAAsF;IACtF,MAAM,QAAQ,GAAoC,EAAE,CAAC;IACrD,KAAK,MAAM,CAAC,WAAW,EAAE,eAAe,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC/E,QAAQ,CAAC,WAAW,CAAC,GAAG,EAAE,GAAG,eAAe,EAAE,IAAI,EAAE,OAAO,CAAC,sBAAsB,EAAE,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC;IAC9G,CAAC;IAED,mDAAmD;IACnD,MAAM,WAAW,GAAG,gBAAgB,CAClC,OAAO,CAAC,WAAW,IAAI,OAAO,CAAC,GAAG,EAClC,mBAAmB,CAAC,IAAI,CAAC,sBAAsB,EAAE,qBAAqB,CAAC,CAAC,CACzE,CAAC;IACF,MAAM,YAAY,GAAG,CAAC,IAAY,EAAE,EAAE;QACpC,MAAM,KAAK,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;QAChC,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC;IACjE,CAAC,CAAC;IACF,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC;IAC1C,MAAM,eAAe,GAAG,CAAC,cAAc,EAAE,GAAG,iBAAiB,CAAC,WAAW,CAAC,CAAC;SACxE,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,SAAS,CAAC;SAClD,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CACZ,IAAI,KAAK,cAAc;QACrB,CAAC,CAAC,0CAA0C;QAC5C,CAAC,CAAC,GAAG,IAAI,gEAAgE,WAAW,IAAI,CAC3F,CAAC;IACJ,IAAI,eAAe,CAAC,MAAM,GAAG,CAAC;QAAE,MAAM,IAAI,kBAAkB,CAAC,gCAAgC,EAAE,eAAe,CAAC,CAAC;IAEhH,MAAM,WAAW,GAAG,YAAY,CAAC,cAAc,CAAE,CAAC;IAClD,MAAM,iBAAiB,GAAG,gBAAgB,CAAC,WAAW,CAAC,CAAC;IACxD,IAAI,iBAAiB,KAAK,SAAS,EAAE,CAAC;QACpC,MAAM,IAAI,kBAAkB,CAAC,2BAA2B,EAAE;YACxD,wFAAwF;SACzF,CAAC,CAAC;IACL,CAAC;IAED,MAAM,kBAAkB,GACtB,WAAW,KAAK,MAAM;QACpB,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,YAAY,CAAC,eAAe,CAAE,EAAE,KAAK,EAAE,YAAY,CAAC,YAAY,CAAE,EAAE,QAAQ,EAAE,YAAY,CAAC,gBAAgB,CAAE,EAAE;QAC1I,CAAC,CAAC,WAAW,KAAK,QAAQ;YACxB,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,YAAY,CAAC,gBAAgB,CAAE,EAAE;YAC7D,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAEzB,OAAO;QACL,QAAQ;QACR,OAAO,EAAE,QAAQ,CAAC,OAAO;QACzB,MAAM,EAAE,QAAQ,CAAC,MAAM;QACvB,WAAW;QACX,kBAAkB;QAClB,OAAO,EAAE,QAAQ,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,CAAC,qBAAqB,CAAC,IAAI,IAAI,EAAE;QACnI,qBAAqB;QACrB,QAAQ,EAAE,uBAAuB,CAAC,iBAAiB,CAAC;KACrD,CAAC;AACJ,CAAC"}
@@ -0,0 +1,77 @@
1
+ // A tiny .env reader. Supports:
2
+ // KEY=value
3
+ // KEY="value with spaces and \n escapes" KEY='literal value'
4
+ // KEY=value # a comment after a space # a whole-line comment
5
+ // blank lines
6
+ // Values already set in the real environment always win: a .env file is a
7
+ // convenience for local runs, never a way to override what the operator set.
8
+ // Error messages give the line number but never the line, which may hold a secret.
9
+ import { existsSync, readFileSync } from "node:fs";
10
+ import { ConfigurationError } from "./configuration-errors.js";
11
+ const ENVIRONMENT_LINE = /^([A-Za-z_][A-Za-z0-9_]*)\s*=\s*(.*)$/;
12
+ function readDoubleQuoted(innerText) {
13
+ return innerText.replace(/\\([nrt"\\])/g, (_escape, character) => character === "n" ? "\n" : character === "r" ? "\r" : character === "t" ? "\t" : character);
14
+ }
15
+ // The index of the quote that closes a double-quoted value; \" doesn't close it.
16
+ function findClosingDoubleQuote(value) {
17
+ for (let characterIndex = 1; characterIndex < value.length; characterIndex++) {
18
+ if (value[characterIndex] === "\\")
19
+ characterIndex++; // skip the escaped character
20
+ else if (value[characterIndex] === '"')
21
+ return characterIndex;
22
+ }
23
+ return -1;
24
+ }
25
+ // The value part of a line, or undefined if it is broken (unclosed quote,
26
+ // or something other than a comment after the closing quote).
27
+ function readValue(rawValue) {
28
+ const value = rawValue.trim();
29
+ const quote = value[0];
30
+ if (quote !== '"' && quote !== "'") {
31
+ // Unquoted: " #" starts a comment, so "a#b" keeps its "#".
32
+ return value.replace(/\s+#.*$/, "");
33
+ }
34
+ const closingIndex = quote === '"' ? findClosingDoubleQuote(value) : value.indexOf("'", 1);
35
+ if (closingIndex === -1)
36
+ return undefined;
37
+ const afterClosingQuote = value.slice(closingIndex + 1).trim();
38
+ if (afterClosingQuote !== "" && !afterClosingQuote.startsWith("#"))
39
+ return undefined;
40
+ const innerText = value.slice(1, closingIndex);
41
+ return quote === '"' ? readDoubleQuoted(innerText) : innerText;
42
+ }
43
+ // Variable name -> value, from the text of a .env file.
44
+ export function parseEnvironmentFile(fileText, fileLabel) {
45
+ const values = {};
46
+ const problems = [];
47
+ for (const [lineIndex, rawLine] of fileText.split(/\r?\n/).entries()) {
48
+ const line = rawLine.trim();
49
+ if (line === "" || line.startsWith("#"))
50
+ continue;
51
+ const lineMatch = ENVIRONMENT_LINE.exec(line);
52
+ const value = lineMatch ? readValue(lineMatch[2]) : undefined;
53
+ if (!lineMatch || value === undefined) {
54
+ problems.push(`${fileLabel} line ${lineIndex + 1} is not KEY=value (or has an unclosed quote)`);
55
+ continue;
56
+ }
57
+ values[lineMatch[1]] = value;
58
+ }
59
+ if (problems.length > 0)
60
+ throw new ConfigurationError(`Problems in ${fileLabel}:`, problems);
61
+ return values;
62
+ }
63
+ // The .env file's values, or nothing if there is no file.
64
+ export function readEnvironmentFile(filePath) {
65
+ if (!existsSync(filePath))
66
+ return {};
67
+ return parseEnvironmentFile(readFileSync(filePath, "utf8"), filePath);
68
+ }
69
+ // The real environment plus the file's values for variables it doesn't set.
70
+ export function mergeEnvironment(realEnvironment, fileValues) {
71
+ const merged = { ...fileValues };
72
+ for (const [name, value] of Object.entries(realEnvironment))
73
+ if (value !== undefined)
74
+ merged[name] = value;
75
+ return merged;
76
+ }
77
+ //# sourceMappingURL=read-environment-file.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"read-environment-file.js","sourceRoot":"","sources":["../../src/configuration/read-environment-file.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,cAAc;AACd,iEAAiE;AACjE,oEAAoE;AACpE,gBAAgB;AAChB,0EAA0E;AAC1E,6EAA6E;AAC7E,mFAAmF;AACnF,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACnD,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAE/D,MAAM,gBAAgB,GAAG,uCAAuC,CAAC;AAEjE,SAAS,gBAAgB,CAAC,SAAiB;IACzC,OAAO,SAAS,CAAC,OAAO,CAAC,eAAe,EAAE,CAAC,OAAO,EAAE,SAAiB,EAAE,EAAE,CACvE,SAAS,KAAK,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,KAAK,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,KAAK,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAC3F,CAAC;AACJ,CAAC;AAED,iFAAiF;AACjF,SAAS,sBAAsB,CAAC,KAAa;IAC3C,KAAK,IAAI,cAAc,GAAG,CAAC,EAAE,cAAc,GAAG,KAAK,CAAC,MAAM,EAAE,cAAc,EAAE,EAAE,CAAC;QAC7E,IAAI,KAAK,CAAC,cAAc,CAAC,KAAK,IAAI;YAAE,cAAc,EAAE,CAAC,CAAC,6BAA6B;aAC9E,IAAI,KAAK,CAAC,cAAc,CAAC,KAAK,GAAG;YAAE,OAAO,cAAc,CAAC;IAChE,CAAC;IACD,OAAO,CAAC,CAAC,CAAC;AACZ,CAAC;AAED,0EAA0E;AAC1E,8DAA8D;AAC9D,SAAS,SAAS,CAAC,QAAgB;IACjC,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;IAC9B,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IACvB,IAAI,KAAK,KAAK,GAAG,IAAI,KAAK,KAAK,GAAG,EAAE,CAAC;QACnC,2DAA2D;QAC3D,OAAO,KAAK,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;IACtC,CAAC;IACD,MAAM,YAAY,GAAG,KAAK,KAAK,GAAG,CAAC,CAAC,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;IAC3F,IAAI,YAAY,KAAK,CAAC,CAAC;QAAE,OAAO,SAAS,CAAC;IAC1C,MAAM,iBAAiB,GAAG,KAAK,CAAC,KAAK,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAC/D,IAAI,iBAAiB,KAAK,EAAE,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,GAAG,CAAC;QAAE,OAAO,SAAS,CAAC;IACrF,MAAM,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC;IAC/C,OAAO,KAAK,KAAK,GAAG,CAAC,CAAC,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AACjE,CAAC;AAED,wDAAwD;AACxD,MAAM,UAAU,oBAAoB,CAAC,QAAgB,EAAE,SAAiB;IACtE,MAAM,MAAM,GAA2B,EAAE,CAAC;IAC1C,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,KAAK,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC;QACrE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;QAC5B,IAAI,IAAI,KAAK,EAAE,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;YAAE,SAAS;QAClD,MAAM,SAAS,GAAG,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9C,MAAM,KAAK,GAAG,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC/D,IAAI,CAAC,SAAS,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACtC,QAAQ,CAAC,IAAI,CAAC,GAAG,SAAS,SAAS,SAAS,GAAG,CAAC,8CAA8C,CAAC,CAAC;YAChG,SAAS;QACX,CAAC;QACD,MAAM,CAAC,SAAS,CAAC,CAAC,CAAE,CAAC,GAAG,KAAK,CAAC;IAChC,CAAC;IACD,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC;QAAE,MAAM,IAAI,kBAAkB,CAAC,eAAe,SAAS,GAAG,EAAE,QAAQ,CAAC,CAAC;IAC7F,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,0DAA0D;AAC1D,MAAM,UAAU,mBAAmB,CAAC,QAAgB;IAClD,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC;QAAE,OAAO,EAAE,CAAC;IACrC,OAAO,oBAAoB,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,QAAQ,CAAC,CAAC;AACxE,CAAC;AAED,4EAA4E;AAC5E,MAAM,UAAU,gBAAgB,CAC9B,eAAmD,EACnD,UAAkC;IAElC,MAAM,MAAM,GAAuC,EAAE,GAAG,UAAU,EAAE,CAAC;IACrE,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC;QAAE,IAAI,KAAK,KAAK,SAAS;YAAE,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;IAC3G,OAAO,MAAM,CAAC;AAChB,CAAC"}