@friggframework/core 2.0.0-next.12 → 2.0.0-next.121

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 (410) hide show
  1. package/.eslintrc.json +18 -1
  2. package/CLAUDE.md +830 -0
  3. package/README.md +996 -50
  4. package/admin-scripts/index.js +52 -0
  5. package/admin-scripts/repositories/admin-script-execution-repository-documentdb.js +21 -0
  6. package/admin-scripts/repositories/admin-script-execution-repository-factory.js +51 -0
  7. package/admin-scripts/repositories/admin-script-execution-repository-interface.js +171 -0
  8. package/admin-scripts/repositories/admin-script-execution-repository-mongo.js +238 -0
  9. package/admin-scripts/repositories/admin-script-execution-repository-postgres.js +278 -0
  10. package/admin-scripts/repositories/script-schedule-repository-documentdb.js +21 -0
  11. package/admin-scripts/repositories/script-schedule-repository-factory.js +51 -0
  12. package/admin-scripts/repositories/script-schedule-repository-interface.js +108 -0
  13. package/admin-scripts/repositories/script-schedule-repository-mongo.js +179 -0
  14. package/admin-scripts/repositories/script-schedule-repository-postgres.js +210 -0
  15. package/application/commands/README.md +451 -0
  16. package/application/commands/admin-script-commands.js +359 -0
  17. package/application/commands/credential-commands.js +262 -0
  18. package/application/commands/entity-commands.js +294 -0
  19. package/application/commands/integration-commands.js +419 -0
  20. package/application/commands/integration-mapping-commands.js +25 -0
  21. package/application/commands/process-commands.js +135 -0
  22. package/application/commands/report-commands.js +188 -0
  23. package/application/commands/scheduler-commands.js +263 -0
  24. package/application/commands/usage-commands.js +56 -0
  25. package/application/commands/user-commands.js +312 -0
  26. package/application/index.js +83 -0
  27. package/artifacts/repositories/artifact-repository-factory.js +19 -0
  28. package/artifacts/repositories/artifact-repository-interface.js +27 -0
  29. package/artifacts/repositories/artifact-repository-local.js +42 -0
  30. package/artifacts/repositories/artifact-repository-s3.js +61 -0
  31. package/assertions/index.js +0 -3
  32. package/core/CLAUDE.md +715 -0
  33. package/core/Worker.js +55 -24
  34. package/core/create-handler.js +121 -38
  35. package/core/index.js +8 -1
  36. package/core/invocation-scope.js +225 -0
  37. package/core/parameters-to-env.js +257 -0
  38. package/core/secrets-to-env.js +7 -6
  39. package/core/ssm-preload.mjs +34 -0
  40. package/credential/repositories/credential-active-type.js +32 -0
  41. package/credential/repositories/credential-repository-documentdb.js +355 -0
  42. package/credential/repositories/credential-repository-factory.js +54 -0
  43. package/credential/repositories/credential-repository-interface.js +113 -0
  44. package/credential/repositories/credential-repository-mongo.js +294 -0
  45. package/credential/repositories/credential-repository-postgres.js +312 -0
  46. package/credential/repositories/credential-repository.js +300 -0
  47. package/credential/use-cases/get-credential-for-user.js +25 -0
  48. package/credential/use-cases/update-authentication-status.js +15 -0
  49. package/database/MONGODB_TRANSACTION_FIX.md +198 -0
  50. package/database/adapters/lambda-invoker.js +97 -0
  51. package/database/config.js +147 -0
  52. package/database/documentdb-encryption-service.js +334 -0
  53. package/database/documentdb-utils.js +196 -0
  54. package/database/encryption/README.md +863 -0
  55. package/database/encryption/documentdb-encryption-service.md +3575 -0
  56. package/database/encryption/encryption-schema-registry.js +404 -0
  57. package/database/encryption/field-encryption-service.js +254 -0
  58. package/database/encryption/integration-mapping-encryption.js +97 -0
  59. package/database/encryption/logger.js +82 -0
  60. package/database/encryption/prisma-encryption-extension.js +241 -0
  61. package/database/index.js +21 -21
  62. package/database/prisma.js +182 -0
  63. package/database/repositories/health-check-repository-documentdb.js +138 -0
  64. package/database/repositories/health-check-repository-factory.js +48 -0
  65. package/database/repositories/health-check-repository-interface.js +82 -0
  66. package/database/repositories/health-check-repository-mongodb.js +89 -0
  67. package/database/repositories/health-check-repository-postgres.js +82 -0
  68. package/database/repositories/migration-status-repository-s3.js +137 -0
  69. package/database/use-cases/check-database-health-use-case.js +29 -0
  70. package/database/use-cases/check-database-state-use-case.js +81 -0
  71. package/database/use-cases/check-encryption-health-use-case.js +83 -0
  72. package/database/use-cases/get-database-state-via-worker-use-case.js +61 -0
  73. package/database/use-cases/get-migration-status-use-case.js +93 -0
  74. package/database/use-cases/resolve-migration-via-worker-use-case.js +49 -0
  75. package/database/use-cases/run-database-migration-use-case.js +139 -0
  76. package/database/use-cases/test-encryption-use-case.js +253 -0
  77. package/database/use-cases/trigger-database-migration-use-case.js +157 -0
  78. package/database/utils/mongodb-collection-utils.js +94 -0
  79. package/database/utils/mongodb-schema-init.js +108 -0
  80. package/database/utils/prisma-runner.js +491 -0
  81. package/database/utils/prisma-schema-parser.js +182 -0
  82. package/docs/PROCESS_MANAGEMENT_QUEUE_SPEC.md +517 -0
  83. package/encrypt/Cryptor.js +34 -168
  84. package/encrypt/index.js +1 -2
  85. package/errors/client-safe-error.js +26 -0
  86. package/errors/fetch-error.js +59 -57
  87. package/errors/index.js +6 -0
  88. package/errors/mapping-already-exists-error.js +14 -0
  89. package/generated/prisma-mongodb/client.d.ts +1 -0
  90. package/generated/prisma-mongodb/client.js +5 -0
  91. package/generated/prisma-mongodb/default.d.ts +1 -0
  92. package/generated/prisma-mongodb/default.js +5 -0
  93. package/generated/prisma-mongodb/edge.d.ts +1 -0
  94. package/generated/prisma-mongodb/edge.js +386 -0
  95. package/generated/prisma-mongodb/index-browser.js +368 -0
  96. package/generated/prisma-mongodb/index.d.ts +27065 -0
  97. package/generated/prisma-mongodb/index.js +411 -0
  98. package/generated/prisma-mongodb/libquery_engine-debian-openssl-3.0.x.so.node +0 -0
  99. package/generated/prisma-mongodb/libquery_engine-rhel-openssl-3.0.x.so.node +0 -0
  100. package/generated/prisma-mongodb/package.json +183 -0
  101. package/generated/prisma-mongodb/runtime/edge-esm.js +35 -0
  102. package/generated/prisma-mongodb/runtime/edge.js +35 -0
  103. package/generated/prisma-mongodb/runtime/index-browser.d.ts +370 -0
  104. package/generated/prisma-mongodb/runtime/index-browser.js +17 -0
  105. package/generated/prisma-mongodb/runtime/library.d.ts +3982 -0
  106. package/generated/prisma-mongodb/runtime/library.js +147 -0
  107. package/generated/prisma-mongodb/runtime/react-native.js +84 -0
  108. package/generated/prisma-mongodb/runtime/wasm-compiler-edge.js +85 -0
  109. package/generated/prisma-mongodb/runtime/wasm-engine-edge.js +38 -0
  110. package/generated/prisma-mongodb/schema.prisma +455 -0
  111. package/generated/prisma-mongodb/wasm-edge-light-loader.mjs +5 -0
  112. package/generated/prisma-mongodb/wasm-worker-loader.mjs +5 -0
  113. package/generated/prisma-mongodb/wasm.d.ts +1 -0
  114. package/generated/prisma-mongodb/wasm.js +393 -0
  115. package/generated/prisma-postgresql/client.d.ts +1 -0
  116. package/generated/prisma-postgresql/client.js +5 -0
  117. package/generated/prisma-postgresql/default.d.ts +1 -0
  118. package/generated/prisma-postgresql/default.js +5 -0
  119. package/generated/prisma-postgresql/edge.d.ts +1 -0
  120. package/generated/prisma-postgresql/edge.js +407 -0
  121. package/generated/prisma-postgresql/index-browser.js +389 -0
  122. package/generated/prisma-postgresql/index.d.ts +29904 -0
  123. package/generated/prisma-postgresql/index.js +432 -0
  124. package/generated/prisma-postgresql/libquery_engine-debian-openssl-3.0.x.so.node +0 -0
  125. package/generated/prisma-postgresql/libquery_engine-rhel-openssl-3.0.x.so.node +0 -0
  126. package/generated/prisma-postgresql/package.json +183 -0
  127. package/generated/prisma-postgresql/query_engine_bg.js +2 -0
  128. package/generated/prisma-postgresql/query_engine_bg.wasm +0 -0
  129. package/generated/prisma-postgresql/runtime/edge-esm.js +35 -0
  130. package/generated/prisma-postgresql/runtime/edge.js +35 -0
  131. package/generated/prisma-postgresql/runtime/index-browser.d.ts +370 -0
  132. package/generated/prisma-postgresql/runtime/index-browser.js +17 -0
  133. package/generated/prisma-postgresql/runtime/library.d.ts +3982 -0
  134. package/generated/prisma-postgresql/runtime/library.js +147 -0
  135. package/generated/prisma-postgresql/runtime/react-native.js +84 -0
  136. package/generated/prisma-postgresql/runtime/wasm-compiler-edge.js +85 -0
  137. package/generated/prisma-postgresql/runtime/wasm-engine-edge.js +38 -0
  138. package/generated/prisma-postgresql/schema.prisma +436 -0
  139. package/generated/prisma-postgresql/wasm-edge-light-loader.mjs +5 -0
  140. package/generated/prisma-postgresql/wasm-worker-loader.mjs +5 -0
  141. package/generated/prisma-postgresql/wasm.d.ts +1 -0
  142. package/generated/prisma-postgresql/wasm.js +414 -0
  143. package/handlers/WEBHOOKS.md +682 -0
  144. package/handlers/app-definition-loader.js +103 -0
  145. package/handlers/app-handler-helpers.js +20 -6
  146. package/handlers/backend-utils.js +272 -46
  147. package/handlers/database-migration-handler.js +236 -0
  148. package/handlers/integration-event-dispatcher.js +68 -0
  149. package/handlers/middleware/admin-auth.js +73 -0
  150. package/handlers/routers/HEALTHCHECK.md +342 -0
  151. package/handlers/routers/auth.js +4 -15
  152. package/handlers/routers/db-migration.handler.js +29 -0
  153. package/handlers/routers/db-migration.js +329 -0
  154. package/handlers/routers/health.js +518 -0
  155. package/handlers/routers/integration-defined-routers.js +85 -10
  156. package/handlers/routers/integration-webhook-routers.js +87 -0
  157. package/handlers/routers/user.js +27 -5
  158. package/handlers/routers/websocket.js +31 -9
  159. package/handlers/use-cases/check-external-apis-health-use-case.js +81 -0
  160. package/handlers/use-cases/check-integrations-health-use-case.js +44 -0
  161. package/handlers/workers/db-migration.js +438 -0
  162. package/handlers/workers/dlq-processor.js +89 -0
  163. package/handlers/workers/integration-defined-workers.js +13 -7
  164. package/index.js +123 -47
  165. package/infrastructure/scheduler/eventbridge-scheduler-adapter.js +238 -0
  166. package/infrastructure/scheduler/index.js +33 -0
  167. package/infrastructure/scheduler/mock-scheduler-adapter.js +143 -0
  168. package/infrastructure/scheduler/scheduler-service-factory.js +73 -0
  169. package/infrastructure/scheduler/scheduler-service-interface.js +47 -0
  170. package/integrations/EXTENSIONS.md +240 -0
  171. package/integrations/WEBHOOK-QUICKSTART.md +151 -0
  172. package/integrations/extension.js +254 -0
  173. package/integrations/index.js +20 -10
  174. package/integrations/integration-base.js +777 -74
  175. package/integrations/integration-router.js +399 -180
  176. package/integrations/options.js +1 -1
  177. package/integrations/repositories/config-patch-shared.js +43 -0
  178. package/integrations/repositories/integration-mapping-query-pipeline.js +152 -0
  179. package/integrations/repositories/integration-mapping-query.js +193 -0
  180. package/integrations/repositories/integration-mapping-repository-documentdb.js +406 -0
  181. package/integrations/repositories/integration-mapping-repository-factory.js +57 -0
  182. package/integrations/repositories/integration-mapping-repository-interface.js +183 -0
  183. package/integrations/repositories/integration-mapping-repository-mongo.js +284 -0
  184. package/integrations/repositories/integration-mapping-repository-postgres.js +403 -0
  185. package/integrations/repositories/integration-mapping-repository.js +185 -0
  186. package/integrations/repositories/integration-repository-documentdb.js +354 -0
  187. package/integrations/repositories/integration-repository-factory.js +51 -0
  188. package/integrations/repositories/integration-repository-interface.js +219 -0
  189. package/integrations/repositories/integration-repository-mongo.js +502 -0
  190. package/integrations/repositories/integration-repository-postgres.js +550 -0
  191. package/integrations/repositories/process-repository-documentdb.js +311 -0
  192. package/integrations/repositories/process-repository-factory.js +53 -0
  193. package/integrations/repositories/process-repository-interface.js +136 -0
  194. package/integrations/repositories/process-repository-mongo.js +262 -0
  195. package/integrations/repositories/process-repository-postgres.js +380 -0
  196. package/integrations/repositories/process-update-ops-shared.js +112 -0
  197. package/integrations/repositories/report-id.js +13 -0
  198. package/integrations/tests/doubles/config-capturing-integration.js +81 -0
  199. package/integrations/tests/doubles/dummy-integration-class.js +113 -0
  200. package/integrations/tests/doubles/test-integration-repository.js +146 -0
  201. package/integrations/use-cases/add-entities-to-integration.js +92 -0
  202. package/integrations/use-cases/create-integration.js +253 -0
  203. package/integrations/use-cases/create-process.js +130 -0
  204. package/integrations/use-cases/delete-integration-for-user.js +130 -0
  205. package/integrations/use-cases/find-integration-by-entity-external-id.js +74 -0
  206. package/integrations/use-cases/find-integration-context-by-external-entity-id.js +76 -0
  207. package/integrations/use-cases/get-integration-for-user.js +78 -0
  208. package/integrations/use-cases/get-integration-instance-by-definition.js +67 -0
  209. package/integrations/use-cases/get-integration-instance.js +83 -0
  210. package/integrations/use-cases/get-integrations-for-user.js +88 -0
  211. package/integrations/use-cases/get-possible-integrations.js +27 -0
  212. package/integrations/use-cases/get-process.js +89 -0
  213. package/integrations/use-cases/index.js +19 -0
  214. package/integrations/use-cases/list-integrations-by-entity-external-id.js +46 -0
  215. package/integrations/use-cases/load-integration-context.js +71 -0
  216. package/integrations/use-cases/patch-integration-config.js +39 -0
  217. package/integrations/use-cases/process-errors.js +28 -0
  218. package/integrations/use-cases/remove-entities-from-integration.js +70 -0
  219. package/integrations/use-cases/update-integration-config.js +32 -0
  220. package/integrations/use-cases/update-integration-messages.js +44 -0
  221. package/integrations/use-cases/update-integration-status.js +32 -0
  222. package/integrations/use-cases/update-integration.js +92 -0
  223. package/integrations/use-cases/update-process-metrics.js +222 -0
  224. package/integrations/use-cases/update-process-state.js +163 -0
  225. package/integrations/utils/assert-entity-ids-input.js +42 -0
  226. package/integrations/utils/map-integration-dto.js +37 -0
  227. package/jest-global-setup-noop.js +3 -0
  228. package/jest-global-teardown-noop.js +3 -0
  229. package/jest.config.js +2 -0
  230. package/logs/.eslintrc.json +26 -1
  231. package/logs/__fixtures__/events.js +82 -0
  232. package/logs/__fixtures__/matchers.js +45 -0
  233. package/logs/__fixtures__/secrets.js +59 -0
  234. package/logs/__fixtures__/vectors.js +329 -0
  235. package/logs/__fixtures__/with-env.js +45 -0
  236. package/logs/context.js +109 -0
  237. package/logs/contract-keys.js +67 -0
  238. package/logs/debug-shims.js +46 -0
  239. package/logs/denied-keys.js +21 -0
  240. package/logs/index.js +14 -3
  241. package/logs/jest-logger-setup.js +25 -0
  242. package/logs/levels.js +71 -0
  243. package/logs/logger-runtime.js +137 -0
  244. package/logs/logger.js +134 -46
  245. package/logs/record.js +276 -0
  246. package/logs/redact.js +328 -0
  247. package/logs/serialize.js +329 -0
  248. package/logs/sinks.js +93 -0
  249. package/logs/summarize-event.js +163 -0
  250. package/{module-plugin → modules}/index.js +0 -10
  251. package/modules/module-factory.js +56 -0
  252. package/modules/module.js +320 -0
  253. package/modules/repositories/module-repository-documentdb.js +350 -0
  254. package/modules/repositories/module-repository-factory.js +40 -0
  255. package/modules/repositories/module-repository-interface.js +145 -0
  256. package/modules/repositories/module-repository-mongo.js +436 -0
  257. package/modules/repositories/module-repository-postgres.js +481 -0
  258. package/modules/repositories/module-repository.js +369 -0
  259. package/modules/requester/api-key.js +52 -0
  260. package/modules/requester/oauth-2.js +561 -0
  261. package/modules/requester/requester.js +605 -0
  262. package/{module-plugin → modules}/test/mock-api/api.js +8 -3
  263. package/{module-plugin → modules}/test/mock-api/definition.js +14 -10
  264. package/modules/tests/doubles/test-module-factory.js +16 -0
  265. package/modules/tests/doubles/test-module-repository.js +39 -0
  266. package/modules/use-cases/get-entities-for-user.js +32 -0
  267. package/modules/use-cases/get-entity-options-by-id.js +71 -0
  268. package/modules/use-cases/get-entity-options-by-type.js +34 -0
  269. package/modules/use-cases/get-module-instance-from-type.js +34 -0
  270. package/modules/use-cases/get-module.js +74 -0
  271. package/modules/use-cases/process-authorization-callback.js +294 -0
  272. package/modules/use-cases/refresh-entity-options.js +72 -0
  273. package/modules/use-cases/test-module-auth.js +72 -0
  274. package/modules/utils/map-module-dto.js +20 -0
  275. package/modules/utils/to-credential-id.js +14 -0
  276. package/package.json +92 -52
  277. package/prisma-mongodb/schema.prisma +455 -0
  278. package/prisma-postgresql/migrations/20250930193005_init/migration.sql +315 -0
  279. package/prisma-postgresql/migrations/20251006135218_init/migration.sql +9 -0
  280. package/prisma-postgresql/migrations/20251010000000_remove_unused_entity_reference_map/migration.sql +3 -0
  281. package/prisma-postgresql/migrations/20251112195422_update_user_unique_constraints/migration.sql +25 -0
  282. package/prisma-postgresql/migrations/20260422120000_add_entity_data_column/migration.sql +10 -0
  283. package/prisma-postgresql/migrations/20260422120001_create_process_table/migration.sql +48 -0
  284. package/prisma-postgresql/migrations/20260625000000_add_user_organization_id_index/migration.sql +2 -0
  285. package/prisma-postgresql/migrations/20260703000000_add_integration_status_in_creation_in_deletion/migration.sql +11 -0
  286. package/prisma-postgresql/migrations/20260703000001_integration_status_default_in_creation/migration.sql +8 -0
  287. package/prisma-postgresql/migrations/20260705000000_create_usage_counter/migration.sql +26 -0
  288. package/prisma-postgresql/migrations/20260706000000_add_admin_script_execution_and_schedule/migration.sql +61 -0
  289. package/prisma-postgresql/migrations/migration_lock.toml +3 -0
  290. package/prisma-postgresql/schema.prisma +436 -0
  291. package/queues/queue-delivery.js +41 -0
  292. package/queues/queuer-util.js +89 -21
  293. package/reporting/README.md +154 -0
  294. package/reporting/builtin-reports.js +6 -0
  295. package/reporting/index.js +13 -0
  296. package/reporting/report-base.js +49 -0
  297. package/reporting/reports/integrations-report.js +221 -0
  298. package/syncs/manager.js +468 -443
  299. package/syncs/repositories/sync-repository-documentdb.js +240 -0
  300. package/syncs/repositories/sync-repository-factory.js +43 -0
  301. package/syncs/repositories/sync-repository-interface.js +109 -0
  302. package/syncs/repositories/sync-repository-mongo.js +239 -0
  303. package/syncs/repositories/sync-repository-postgres.js +319 -0
  304. package/syncs/sync.js +0 -1
  305. package/telemetry/README.md +331 -0
  306. package/telemetry/bind-telemetry-context.js +77 -0
  307. package/telemetry/canonical-counters.js +52 -0
  308. package/telemetry/exporters.js +85 -0
  309. package/telemetry/index.js +26 -0
  310. package/telemetry/instrument-handler.js +104 -0
  311. package/telemetry/no-op-telemetry.js +71 -0
  312. package/telemetry/north-star.js +103 -0
  313. package/telemetry/otel-telemetry.js +232 -0
  314. package/telemetry/plugin-subscribers.js +77 -0
  315. package/telemetry/telemetry-config.js +120 -0
  316. package/telemetry/telemetry-context.js +51 -0
  317. package/telemetry/telemetry-event-bus.js +58 -0
  318. package/telemetry/telemetry-runtime.js +164 -0
  319. package/telemetry/telemetry-service.js +52 -0
  320. package/telemetry/usage-rollup-subscriber.js +116 -0
  321. package/token/repositories/token-repository-documentdb.js +137 -0
  322. package/token/repositories/token-repository-factory.js +40 -0
  323. package/token/repositories/token-repository-interface.js +131 -0
  324. package/token/repositories/token-repository-mongo.js +219 -0
  325. package/token/repositories/token-repository-postgres.js +264 -0
  326. package/token/repositories/token-repository.js +219 -0
  327. package/types/associations/index.d.ts +0 -17
  328. package/types/core/index.d.ts +12 -4
  329. package/types/database/index.d.ts +10 -2
  330. package/types/encrypt/index.d.ts +5 -3
  331. package/types/errors/index.d.ts +24 -10
  332. package/types/integrations/index.d.ts +3 -8
  333. package/types/logs/index.d.ts +61 -2
  334. package/types/module-plugin/index.d.ts +20 -69
  335. package/types/syncs/index.d.ts +0 -17
  336. package/usage/README.md +54 -0
  337. package/usage/index.js +17 -0
  338. package/usage/repositories/usage-repository-documentdb.js +194 -0
  339. package/usage/repositories/usage-repository-factory.js +25 -0
  340. package/usage/repositories/usage-repository-interface.js +37 -0
  341. package/usage/repositories/usage-repository-prisma.js +146 -0
  342. package/usage/tracked-metrics.js +38 -0
  343. package/usage/usage-windows.js +24 -0
  344. package/user/repositories/user-repository-documentdb.js +426 -0
  345. package/user/repositories/user-repository-factory.js +52 -0
  346. package/user/repositories/user-repository-interface.js +214 -0
  347. package/user/repositories/user-repository-mongo.js +323 -0
  348. package/user/repositories/user-repository-postgres.js +377 -0
  349. package/user/tests/doubles/test-user-repository.js +72 -0
  350. package/user/use-cases/authenticate-user.js +143 -0
  351. package/user/use-cases/authenticate-with-shared-secret.js +48 -0
  352. package/user/use-cases/create-individual-user.js +61 -0
  353. package/user/use-cases/create-organization-user.js +47 -0
  354. package/user/use-cases/create-token-for-user-id.js +30 -0
  355. package/user/use-cases/get-user-from-adopter-jwt.js +149 -0
  356. package/user/use-cases/get-user-from-bearer-token.js +82 -0
  357. package/user/use-cases/get-user-from-x-frigg-headers.js +132 -0
  358. package/user/use-cases/login-user.js +122 -0
  359. package/user/user.js +125 -0
  360. package/utils/backend-path.js +38 -0
  361. package/utils/index.js +6 -0
  362. package/websocket/repositories/websocket-connection-repository-documentdb.js +119 -0
  363. package/websocket/repositories/websocket-connection-repository-factory.js +44 -0
  364. package/websocket/repositories/websocket-connection-repository-interface.js +106 -0
  365. package/websocket/repositories/websocket-connection-repository-mongo.js +156 -0
  366. package/websocket/repositories/websocket-connection-repository-postgres.js +196 -0
  367. package/websocket/repositories/websocket-connection-repository.js +161 -0
  368. package/assertions/is-equal.js +0 -17
  369. package/associations/model.js +0 -54
  370. package/database/models/IndividualUser.js +0 -76
  371. package/database/models/OrganizationUser.js +0 -29
  372. package/database/models/State.js +0 -9
  373. package/database/models/Token.js +0 -70
  374. package/database/models/UserModel.js +0 -7
  375. package/database/models/WebsocketConnection.js +0 -49
  376. package/database/mongo.js +0 -45
  377. package/database/mongoose.js +0 -5
  378. package/encrypt/Cryptor.test.js +0 -32
  379. package/encrypt/encrypt.js +0 -132
  380. package/encrypt/encrypt.test.js +0 -1069
  381. package/encrypt/test-encrypt.js +0 -107
  382. package/errors/base-error.test.js +0 -32
  383. package/errors/fetch-error.test.js +0 -79
  384. package/errors/halt-error.test.js +0 -11
  385. package/errors/validation-errors.test.js +0 -120
  386. package/handlers/routers/middleware/loadUser.js +0 -15
  387. package/handlers/routers/middleware/requireLoggedInUser.js +0 -12
  388. package/integrations/create-frigg-backend.js +0 -31
  389. package/integrations/integration-factory.js +0 -251
  390. package/integrations/integration-mapping.js +0 -43
  391. package/integrations/integration-model.js +0 -46
  392. package/integrations/integration-user.js +0 -144
  393. package/integrations/test/integration-base.test.js +0 -144
  394. package/lambda/TimeoutCatcher.test.js +0 -68
  395. package/logs/logger.test.js +0 -76
  396. package/module-plugin/auther.js +0 -393
  397. package/module-plugin/credential.js +0 -22
  398. package/module-plugin/entity-manager.js +0 -70
  399. package/module-plugin/entity.js +0 -46
  400. package/module-plugin/manager.js +0 -169
  401. package/module-plugin/module-factory.js +0 -61
  402. package/module-plugin/requester/api-key.js +0 -36
  403. package/module-plugin/requester/oauth-2.js +0 -219
  404. package/module-plugin/requester/requester.js +0 -165
  405. package/module-plugin/requester/requester.test.js +0 -28
  406. package/module-plugin/test/auther.test.js +0 -97
  407. package/syncs/model.js +0 -62
  408. /package/{module-plugin → modules}/ModuleConstants.js +0 -0
  409. /package/{module-plugin → modules}/requester/basic.js +0 -0
  410. /package/{module-plugin → modules}/test/mock-api/mocks/hubspot.js +0 -0
@@ -0,0 +1,42 @@
1
+ /**
2
+ * Throws INVALID_INTEGRATION_DATA unless an integration id and a non-empty
3
+ * list of entity ids are given.
4
+ * @param {string} integrationId
5
+ * @param {string[]} entityIds
6
+ */
7
+ function assertEntityIdsInput(integrationId, entityIds) {
8
+ if (!integrationId || !Array.isArray(entityIds) || entityIds.length === 0) {
9
+ const error = new Error(
10
+ 'integrationId and a non-empty entityIds array are required'
11
+ );
12
+ error.code = 'INVALID_INTEGRATION_DATA';
13
+ throw error;
14
+ }
15
+ }
16
+
17
+ function integrationNotFound(integrationId) {
18
+ const error = new Error(`Integration ${integrationId} not found`);
19
+ error.code = 'INTEGRATION_NOT_FOUND';
20
+ return error;
21
+ }
22
+
23
+ /**
24
+ * Loads an integration, mapping the repositories' "not found" error to
25
+ * INTEGRATION_NOT_FOUND. Any other failure (connection, invalid id) is
26
+ * rethrown unchanged.
27
+ * @param {Object} integrationRepository
28
+ * @param {string} integrationId
29
+ * @returns {Promise<Object>} The integration record.
30
+ */
31
+ async function loadIntegration(integrationRepository, integrationId) {
32
+ try {
33
+ return await integrationRepository.findIntegrationById(integrationId);
34
+ } catch (error) {
35
+ if (/^Integration with id .* not found$/.test(error?.message)) {
36
+ throw integrationNotFound(integrationId);
37
+ }
38
+ throw error;
39
+ }
40
+ }
41
+
42
+ module.exports = { assertEntityIdsInput, integrationNotFound, loadIntegration };
@@ -0,0 +1,37 @@
1
+ /**
2
+ * @param {import('../integration').Integration} integration
3
+ * Convert an Integration domain instance to a plain DTO suitable for JSON responses.
4
+ * Can also accept a plain object with an 'options' property to avoid unnecessary instantiation.
5
+ */
6
+ function mapIntegrationClassToIntegrationDTO(integration) {
7
+ if (!integration) return null;
8
+
9
+ return {
10
+ id: integration.id,
11
+ userId: integration.userId,
12
+ entities: integration.entities,
13
+ config: integration.config,
14
+ status: integration.status,
15
+ version: integration.version,
16
+ messages: integration.messages,
17
+ userActions: integration.userActions,
18
+ options: integration.options || (typeof integration.getOptionDetails === 'function' ? integration.getOptionDetails() : null),
19
+ };
20
+ }
21
+
22
+
23
+ const getModulesDefinitionFromIntegrationClasses = (integrationClasses) => {
24
+ return [
25
+ ...new Set(
26
+ integrationClasses
27
+ .map((integration) =>
28
+ Object.values(integration.Definition.modules).map(
29
+ (module) => module.definition
30
+ )
31
+ )
32
+ .flat()
33
+ ),
34
+ ];
35
+ };
36
+
37
+ module.exports = { mapIntegrationClassToIntegrationDTO, getModulesDefinitionFromIntegrationClasses };
@@ -0,0 +1,3 @@
1
+ module.exports = async function noopGlobalSetup() {
2
+ // No global setup required for unit tests.
3
+ };
@@ -0,0 +1,3 @@
1
+ module.exports = async function noopGlobalTeardown() {
2
+ // No global teardown required for unit tests.
3
+ };
package/jest.config.js CHANGED
@@ -18,4 +18,6 @@ module.exports = {
18
18
 
19
19
  // A path to a module which exports an async function that is triggered once after all test suites
20
20
  globalTeardown: './jest-teardown.js',
21
+
22
+ setupFilesAfterEnv: ['./logs/jest-logger-setup.js'],
21
23
  };
@@ -1,3 +1,28 @@
1
1
  {
2
- "extends": "@friggframework/eslint-config"
2
+ "extends": "@friggframework/eslint-config",
3
+ "rules": {
4
+ "no-console": "error",
5
+ "no-restricted-syntax": [
6
+ "error",
7
+ {
8
+ "selector": "CallExpression[callee.object.object.name='process'][callee.object.property.name=/^(stdout|stderr)$/][callee.property.name='write']",
9
+ "message": "Write through the logger; only logs/sinks.js writes to fd 1"
10
+ }
11
+ ]
12
+ },
13
+ "overrides": [
14
+ {
15
+ "files": ["*.test.js", "__fixtures__/**", "jest-logger-setup.js"],
16
+ "rules": {
17
+ "no-console": "off",
18
+ "no-restricted-syntax": "off"
19
+ }
20
+ },
21
+ {
22
+ "files": ["sinks.js"],
23
+ "rules": {
24
+ "no-restricted-syntax": "off"
25
+ }
26
+ }
27
+ ]
3
28
  }
@@ -0,0 +1,82 @@
1
+ const { SECRETS } = require('./secrets');
2
+
3
+ function httpApiV2Event() {
4
+ return {
5
+ version: '2.0',
6
+ routeKey: 'GET /api/authorize',
7
+ rawPath: '/api/authorize',
8
+ rawQueryString: `code=${SECRETS.oauthCode}&state=abc123&api_key=${SECRETS.apiKeyQuery}`,
9
+ cookies: [`session=${SECRETS.cookie}`],
10
+ headers: {
11
+ 'x-frigg-api-key': SECRETS.friggApiKey,
12
+ authorization: `Bearer ${SECRETS.bearer}`,
13
+ cookie: `session=${SECRETS.cookie}`,
14
+ 'content-type': 'application/json',
15
+ },
16
+ queryStringParameters: {
17
+ code: SECRETS.oauthCode,
18
+ state: 'abc123',
19
+ api_key: SECRETS.apiKeyQuery,
20
+ },
21
+ requestContext: {
22
+ http: { method: 'GET', path: '/api/authorize', sourceIp: '203.0.113.9' },
23
+ requestId: 'req-v2-1',
24
+ },
25
+ body: JSON.stringify({
26
+ code: SECRETS.oauthCode,
27
+ code_verifier: SECRETS.codeVerifier,
28
+ client_secret: SECRETS.clientSecret,
29
+ }),
30
+ isBase64Encoded: false,
31
+ };
32
+ }
33
+
34
+ function restV1Event() {
35
+ return {
36
+ resource: '/api/{proxy+}',
37
+ path: '/api/integrations',
38
+ httpMethod: 'POST',
39
+ headers: {
40
+ Authorization: `Basic ${Buffer.from(`user:${SECRETS.password}`).toString('base64')}`,
41
+ 'X-Frigg-Api-Key': SECRETS.friggApiKey,
42
+ Cookie: `session=${SECRETS.cookie}`,
43
+ },
44
+ multiValueHeaders: {
45
+ Authorization: [`Basic ${Buffer.from(`user:${SECRETS.password}`).toString('base64')}`],
46
+ 'Set-Cookie': [`session=${SECRETS.cookie}`],
47
+ },
48
+ queryStringParameters: { access_token: SECRETS.accessToken },
49
+ multiValueQueryStringParameters: { access_token: [SECRETS.accessToken] },
50
+ requestContext: { requestId: 'req-v1-1', stage: 'dev' },
51
+ body: JSON.stringify({ password: SECRETS.password, refresh_token: SECRETS.refreshToken }),
52
+ isBase64Encoded: false,
53
+ };
54
+ }
55
+
56
+ function sqsEvent() {
57
+ return {
58
+ Records: [
59
+ {
60
+ messageId: 'msg-1',
61
+ receiptHandle: 'receipt-1',
62
+ attributes: { ApproximateReceiveCount: '1' },
63
+ body: JSON.stringify({
64
+ event: 'PROCESS_BATCH',
65
+ data: {
66
+ processId: 'proc-1',
67
+ integrationId: 'int-1',
68
+ access_token: SECRETS.accessToken,
69
+ credentials: { client_secret: SECRETS.clientSecret },
70
+ },
71
+ }),
72
+ },
73
+ {
74
+ messageId: 'msg-2',
75
+ attributes: { ApproximateReceiveCount: '3' },
76
+ body: `not json Authorization: Bearer ${SECRETS.bearer}`,
77
+ },
78
+ ],
79
+ };
80
+ }
81
+
82
+ module.exports = { httpApiV2Event, restV1Event, sqsEvent };
@@ -0,0 +1,45 @@
1
+ const WINDOW = 8;
2
+
3
+ function forms(secret) {
4
+ return [
5
+ secret,
6
+ encodeURIComponent(secret),
7
+ Buffer.from(secret).toString('base64'),
8
+ ];
9
+ }
10
+
11
+ function windows(value) {
12
+ if (value.length <= WINDOW) return [value];
13
+ const result = [];
14
+ for (let i = 0; i + WINDOW <= value.length; i += 1) {
15
+ result.push(value.slice(i, i + WINDOW));
16
+ }
17
+ return result;
18
+ }
19
+
20
+ function findSecretWindow(received, secrets) {
21
+ const haystack =
22
+ typeof received === 'string' ? received : JSON.stringify(received);
23
+ for (const secret of secrets) {
24
+ for (const form of forms(secret)) {
25
+ for (const w of windows(form)) {
26
+ if (haystack.includes(w)) return { secret, window: w };
27
+ }
28
+ }
29
+ }
30
+ return null;
31
+ }
32
+
33
+ function toContainNoSecretWindow(received, secrets) {
34
+ const list = Array.isArray(secrets) ? secrets : Object.values(secrets);
35
+ const hit = findSecretWindow(received, list);
36
+ return {
37
+ pass: hit === null,
38
+ message: () =>
39
+ hit
40
+ ? `expected no ${WINDOW}-char window of a secret, found "${hit.window}" (from a secret of length ${hit.secret.length})`
41
+ : 'expected a secret window, found none',
42
+ };
43
+ }
44
+
45
+ module.exports = { toContainNoSecretWindow, findSecretWindow, WINDOW };
@@ -0,0 +1,59 @@
1
+ // Fake values, generated at load time so secret scanners find no literal in
2
+ // the source. A fixed seed per name keeps every run identical.
3
+ const MIXED = 'BCDFGHJKLMNPQRSTVWXZbcdfghjkmnpqrstvwxz23456789';
4
+ const HEX = '0123456789abcdef';
5
+
6
+ function seededRandom(name) {
7
+ let seed = [...name].reduce(
8
+ (h, c) => Math.imul(h ^ c.charCodeAt(0), 16777619),
9
+ 2166136261
10
+ );
11
+ return () => {
12
+ seed = (seed + 0x6d2b79f5) | 0;
13
+ let t = Math.imul(seed ^ (seed >>> 15), seed | 1);
14
+ t ^= t + Math.imul(t ^ (t >>> 7), t | 61);
15
+ return ((t ^ (t >>> 14)) >>> 0) / 4294967296;
16
+ };
17
+ }
18
+
19
+ function draw(name, alphabet, length) {
20
+ const next = seededRandom(name);
21
+ let out = '';
22
+ for (let i = 0; i < length; i += 1) {
23
+ out += alphabet[Math.floor(next() * alphabet.length)];
24
+ }
25
+ return out;
26
+ }
27
+
28
+ // The fixed 'Zq' + 'B7k' start puts upper case, lower case and a digit in every token.
29
+ function fakeToken(name, length = 28) {
30
+ return `ZqB7k${draw(name, MIXED, length - 5)}`;
31
+ }
32
+
33
+ const base64url = (value) => Buffer.from(value).toString('base64url');
34
+
35
+ const SECRETS = Object.freeze({
36
+ bearer: fakeToken('bearer'),
37
+ apiKeyQuery: fakeToken('apiKeyQuery'),
38
+ friggApiKey: fakeToken('friggApiKey'),
39
+ cookie: fakeToken('cookie'),
40
+ oauthCode: fakeToken('oauthCode'),
41
+ codeVerifier: fakeToken('codeVerifier'),
42
+ password: fakeToken('password'),
43
+ clientSecret: fakeToken('clientSecret'),
44
+ accessToken: fakeToken('accessToken'),
45
+ refreshToken: fakeToken('refreshToken'),
46
+ idToken: fakeToken('idToken'),
47
+ hashword: fakeToken('hashword'),
48
+ dbPassword: fakeToken('dbPassword'),
49
+ signature: fakeToken('signature'),
50
+ jwt: [
51
+ base64url(JSON.stringify({ alg: 'HS256' })),
52
+ base64url(JSON.stringify({ sub: `fake-${draw('jwtSub', MIXED, 8)}` })),
53
+ base64url(draw('jwtSig', MIXED, 24)),
54
+ ].join('.'),
55
+ hexToken: draw('hexToken', HEX, 40),
56
+ base64Run: Buffer.from(draw('base64Run', MIXED, 42)).toString('base64'),
57
+ });
58
+
59
+ module.exports = { SECRETS, fakeToken };
@@ -0,0 +1,329 @@
1
+ // ADR-048 §14 redaction vectors. Each vector is one log call that carries
2
+ // secrets; the suite asserts that no 8-char window of them reaches a record.
3
+ const { SECRETS: S, fakeToken } = require('./secrets');
4
+ const { httpApiV2Event, restV1Event, sqsEvent } = require('./events');
5
+ const { summarizeLambdaEvent } = require('../summarize-event');
6
+
7
+ const secretUrl = `https://api.example.com/v1/items?api_key=${S.apiKeyQuery}`;
8
+ const SIGNATURE_VALUE = fakeToken('signatureValue', 27);
9
+
10
+ // Built by concatenation so push protection does not match the prefixes.
11
+ const TOKEN_TAIL = fakeToken('prefixTail', 25);
12
+ const PREFIXED_TOKENS = [
13
+ 'sk_' + 'live_' + TOKEN_TAIL,
14
+ 'whsec' + '_' + TOKEN_TAIL,
15
+ 'xox' + 'b-' + TOKEN_TAIL,
16
+ 'gh' + 'p_' + TOKEN_TAIL,
17
+ 'AK' + 'IA' + 'ZQPR3FIXTAIL8HN2',
18
+ ];
19
+
20
+ function errorWithMessage(message, name = 'Error') {
21
+ const error = new Error(message);
22
+ error.name = name;
23
+ return error;
24
+ }
25
+
26
+ function nodeFetchError() {
27
+ const { FetchError } = require('node-fetch');
28
+ return new FetchError(
29
+ `request to ${secretUrl} failed, reason: connect ECONNREFUSED Authorization: Bearer ${S.bearer}`,
30
+ 'system',
31
+ { code: 'ECONNREFUSED' }
32
+ );
33
+ }
34
+
35
+ function causeChain() {
36
+ const deepest = errorWithMessage(`token refresh failed: refresh_token=${S.refreshToken}`);
37
+ const third = new Error('third', { cause: deepest });
38
+ const second = new Error('second', { cause: third });
39
+ return new Error('top', { cause: second });
40
+ }
41
+
42
+ function cyclicObject() {
43
+ const node = { name: 'node', access_token: S.accessToken };
44
+ node.self = node;
45
+ node.list = [node, { password: S.password }];
46
+ return node;
47
+ }
48
+
49
+ function aggregateError() {
50
+ return new AggregateError(
51
+ [
52
+ errorWithMessage(`GET ${secretUrl} 401`),
53
+ errorWithMessage(`Authorization: Basic ${Buffer.from(`u:${S.password}`).toString('base64')}`),
54
+ ],
55
+ 'batch failed'
56
+ );
57
+ }
58
+
59
+ function prismaValidationError() {
60
+ const error = errorWithMessage(
61
+ [
62
+ 'Invalid `prisma.credential.create()` invocation:',
63
+ '',
64
+ `{ data: { access_token: "${S.accessToken}", refresh_token: "${S.refreshToken}" } }`,
65
+ '',
66
+ 'Argument `userId` is missing.',
67
+ ].join('\n'),
68
+ 'PrismaClientValidationError'
69
+ );
70
+ error.clientVersion = '6.19.3';
71
+ return error;
72
+ }
73
+
74
+ function vectors() {
75
+ return [
76
+ {
77
+ name: 'HTTP API v2 event through summarizeLambdaEvent',
78
+ level: 'info',
79
+ fields: () => ({ invocation: summarizeLambdaEvent(httpApiV2Event()) }),
80
+ secrets: [S.friggApiKey, S.cookie, S.oauthCode, S.bearer, S.apiKeyQuery, S.codeVerifier, S.clientSecret],
81
+ expectSanitized: (record) => {
82
+ expect(record.invocation.headerNames).toEqual(
83
+ expect.arrayContaining(['x-frigg-api-key', 'cookie', 'authorization'])
84
+ );
85
+ expect(record.invocation.queryKeys).toEqual(expect.arrayContaining(['code', 'api_key']));
86
+ },
87
+ },
88
+ {
89
+ name: 'HTTP API v2 event as a raw field',
90
+ level: 'debug',
91
+ fields: () => ({ event: httpApiV2Event() }),
92
+ secrets: [S.friggApiKey, S.cookie, S.oauthCode, S.bearer, S.apiKeyQuery, S.codeVerifier, S.clientSecret],
93
+ expectSanitized: (record) => {
94
+ expect(record.event.headers).toEqual(
95
+ expect.arrayContaining(['x-frigg-api-key', 'cookie'])
96
+ );
97
+ },
98
+ },
99
+ {
100
+ name: 'REST v1 event as a raw field',
101
+ level: 'debug',
102
+ fields: () => ({ event: restV1Event() }),
103
+ secrets: [S.friggApiKey, S.cookie, S.password, S.accessToken, S.refreshToken],
104
+ expectSanitized: (record) => {
105
+ expect(record.event.httpMethod).toBe('POST');
106
+ },
107
+ },
108
+ {
109
+ name: 'SQS event as a raw field',
110
+ level: 'debug',
111
+ fields: () => ({ event: sqsEvent() }),
112
+ secrets: [S.accessToken, S.clientSecret, S.bearer],
113
+ expectSanitized: (record) => {
114
+ expect(record.event.Records[0].messageId).toBe('msg-1');
115
+ },
116
+ },
117
+ {
118
+ name: 'node-fetch FetchError',
119
+ level: 'error',
120
+ fields: () => ({ error: nodeFetchError() }),
121
+ secrets: [S.apiKeyQuery, S.bearer],
122
+ expectSanitized: (record) => {
123
+ expect(record.error.message).toContain('api_key=REDACTED');
124
+ },
125
+ },
126
+ {
127
+ name: 'Error as the message',
128
+ level: 'error',
129
+ message: () => errorWithMessage(`GET ${secretUrl} Authorization: Bearer ${S.bearer}`),
130
+ secrets: [S.apiKeyQuery, S.bearer],
131
+ expectSanitized: (record) => {
132
+ expect(record.message).toContain('api_key=REDACTED');
133
+ },
134
+ },
135
+ {
136
+ name: 'cause chain with a secret at depth 3',
137
+ level: 'error',
138
+ fields: () => ({ error: causeChain() }),
139
+ secrets: [S.refreshToken],
140
+ expectSanitized: (record) => {
141
+ expect(record.error.cause.cause.message).toBe('third');
142
+ },
143
+ },
144
+ {
145
+ name: 'cyclic object',
146
+ level: 'warn',
147
+ fields: () => ({ node: cyclicObject() }),
148
+ secrets: [S.accessToken, S.password],
149
+ expectSanitized: (record) => {
150
+ expect(JSON.stringify(record)).toContain('[Circular]');
151
+ },
152
+ },
153
+ {
154
+ name: 'AggregateError',
155
+ level: 'error',
156
+ fields: () => ({ error: aggregateError() }),
157
+ secrets: [S.apiKeyQuery, S.password],
158
+ expectSanitized: (record) => {
159
+ expect(record.error.type).toBe('AggregateError');
160
+ },
161
+ },
162
+ {
163
+ name: 'Prisma validation error',
164
+ level: 'error',
165
+ fields: () => ({ error: prismaValidationError() }),
166
+ secrets: [S.accessToken, S.refreshToken],
167
+ expectSanitized: (record) => {
168
+ expect(record.error.message).toContain('Argument `userId` is missing.');
169
+ },
170
+ },
171
+ {
172
+ name: 'connection strings',
173
+ level: 'warn',
174
+ message: () =>
175
+ `connect failed postgresql://frigg:${S.dbPassword}@db.internal:5432/app and mongodb+srv://frigg:${S.dbPassword}@cluster0.example.net/app`,
176
+ secrets: [S.dbPassword],
177
+ expectSanitized: (record) => {
178
+ expect(record.message).toContain('db.internal');
179
+ },
180
+ },
181
+ {
182
+ name: 'JWT',
183
+ level: 'info',
184
+ fields: () => ({ note: `id token ${S.jwt} received` }),
185
+ secrets: [S.jwt],
186
+ },
187
+ {
188
+ name: 'Bearer and Basic credentials',
189
+ level: 'info',
190
+ fields: () => ({
191
+ note: `Authorization: Bearer ${S.bearer}; Authorization: Basic ${Buffer.from(`u:${S.password}`).toString('base64')}`,
192
+ }),
193
+ secrets: [S.bearer, S.password],
194
+ },
195
+ {
196
+ name: 'base64 run',
197
+ level: 'info',
198
+ fields: () => ({ note: `blob ${S.base64Run} end` }),
199
+ secrets: [S.base64Run],
200
+ },
201
+ {
202
+ name: 'provider token prefixes',
203
+ level: 'warn',
204
+ message: () => `provider rejected ${PREFIXED_TOKENS.join(' and ')}`,
205
+ fields: () => ({ note: PREFIXED_TOKENS.join(',') }),
206
+ secrets: PREFIXED_TOKENS,
207
+ },
208
+ {
209
+ name: '40-hex token',
210
+ level: 'error',
211
+ message: () => `lookup failed for key ${S.hexToken}`,
212
+ secrets: [S.hexToken],
213
+ },
214
+ {
215
+ name: 'client_secret, signature and code pairs',
216
+ level: 'info',
217
+ fields: () => ({
218
+ note: `client_secret=${S.clientSecret} signature=${SIGNATURE_VALUE} code=${S.oauthCode}`,
219
+ }),
220
+ secrets: [S.clientSecret, SIGNATURE_VALUE, S.oauthCode],
221
+ },
222
+ {
223
+ name: 'JSON string',
224
+ level: 'info',
225
+ fields: () => ({ note: JSON.stringify({ token: S.accessToken, id: 7 }) }),
226
+ secrets: [S.accessToken],
227
+ },
228
+ {
229
+ name: 'k=v& string',
230
+ level: 'info',
231
+ fields: () => ({ note: `user=alice&password=${S.password}&next=/home` }),
232
+ secrets: [S.password],
233
+ },
234
+ {
235
+ name: 'URLSearchParams body',
236
+ level: 'debug',
237
+ fields: () => ({
238
+ body: new URLSearchParams({
239
+ grant_type: 'authorization_code',
240
+ code: S.oauthCode,
241
+ code_verifier: S.codeVerifier,
242
+ client_secret: S.clientSecret,
243
+ }),
244
+ }),
245
+ secrets: [S.oauthCode, S.codeVerifier, S.clientSecret],
246
+ expectSanitized: (record) => {
247
+ expect(JSON.stringify(record.body)).toContain('grant_type');
248
+ },
249
+ },
250
+ {
251
+ name: 'Headers, URL and Buffer',
252
+ level: 'debug',
253
+ fields: () => ({
254
+ headers: new Headers({ authorization: `Bearer ${S.bearer}`, 'x-frigg-api-key': S.friggApiKey }),
255
+ url: new URL(`https://user:${S.password}@api.example.com/x?access_token=${S.accessToken}`),
256
+ raw: Buffer.from(`secret=${S.clientSecret}`),
257
+ }),
258
+ secrets: [S.bearer, S.friggApiKey, S.password, S.accessToken, S.clientSecret],
259
+ expectSanitized: (record) => {
260
+ expect(JSON.stringify(record.url)).toContain('api.example.com');
261
+ },
262
+ },
263
+ {
264
+ name: 'OAuth callback params',
265
+ level: 'debug',
266
+ fields: () => ({ params: { code: S.oauthCode, state: 'abc123', code_verifier: S.codeVerifier } }),
267
+ secrets: [S.oauthCode, S.codeVerifier],
268
+ expectSanitized: (record) => {
269
+ expect(Object.keys(record.params)).toEqual(
270
+ expect.arrayContaining(['code', 'state'])
271
+ );
272
+ },
273
+ },
274
+ {
275
+ name: 'hashword',
276
+ level: 'info',
277
+ fields: () => ({ user: { username: 'alice', hashword: S.hashword } }),
278
+ secrets: [S.hashword],
279
+ expectSanitized: (record) => {
280
+ expect(record.user.username).toBe('alice');
281
+ },
282
+ },
283
+ {
284
+ name: 'denied keys as bindings and top-level fields',
285
+ level: 'info',
286
+ bindings: () => ({ apiKey: S.friggApiKey }),
287
+ fields: () => ({ access_token: S.accessToken, id_token: S.idToken, cookies: [S.cookie] }),
288
+ secrets: [S.friggApiKey, S.accessToken, S.idToken, S.cookie],
289
+ },
290
+ ];
291
+ }
292
+
293
+ // A real Requester call that fails with 401. The URL carries a query key and
294
+ // the request an Authorization header.
295
+ async function requesterFetchError() {
296
+ const { Requester } = require('../../modules/requester/requester');
297
+ class TestRequester extends Requester {
298
+ async addAuthHeaders(headers) {
299
+ return { ...headers, Authorization: `Bearer ${S.bearer}` };
300
+ }
301
+ }
302
+ const response = {
303
+ status: 401,
304
+ ok: false,
305
+ bodyUsed: false,
306
+ headers: {
307
+ get: () => 'application/json',
308
+ raw: () => ({ 'content-type': ['application/json'] }),
309
+ [Symbol.iterator]: function* () {
310
+ yield ['content-type', 'application/json'];
311
+ },
312
+ },
313
+ json: async () => ({ access_token: S.accessToken }),
314
+ text: async () => `{"access_token":"${S.accessToken}"}`,
315
+ };
316
+ const requester = new TestRequester({
317
+ backOff: [],
318
+ requestTimeoutMs: 0,
319
+ fetch: async () => response,
320
+ });
321
+ return requester._get({ url: secretUrl }).then(
322
+ () => {
323
+ throw new Error('expected the request to fail');
324
+ },
325
+ (error) => error
326
+ );
327
+ }
328
+
329
+ module.exports = { vectors, requesterFetchError, secretUrl };
@@ -0,0 +1,45 @@
1
+ const { createMemorySink } = require('../sinks');
2
+ const { resetLoggerForTests } = require('../logger-runtime');
3
+
4
+ function applyEnv(vars) {
5
+ const saved = {};
6
+ for (const [key, value] of Object.entries(vars)) {
7
+ saved[key] = Object.prototype.hasOwnProperty.call(process.env, key)
8
+ ? process.env[key]
9
+ : undefined;
10
+ if (value === undefined) delete process.env[key];
11
+ else process.env[key] = value;
12
+ }
13
+ return () => {
14
+ for (const [key, value] of Object.entries(saved)) {
15
+ if (value === undefined) delete process.env[key];
16
+ else process.env[key] = value;
17
+ }
18
+ };
19
+ }
20
+
21
+ // Sets env keys (undefined deletes), resets the logger to read them, and
22
+ // passes a fresh memory sink to fn. Restores env and the test logger after.
23
+ function withEnv(vars, fn) {
24
+ const restore = applyEnv(vars);
25
+ const sink = createMemorySink({ install: false });
26
+ resetLoggerForTests({ sinks: [sink] });
27
+ const done = () => {
28
+ restore();
29
+ resetLoggerForTests({ level: 'TRACE', sinks: [createMemorySink({ install: false })] });
30
+ };
31
+ let result;
32
+ try {
33
+ result = fn(sink);
34
+ } catch (error) {
35
+ done();
36
+ throw error;
37
+ }
38
+ if (result && typeof result.then === 'function') {
39
+ return result.finally(done);
40
+ }
41
+ done();
42
+ return result;
43
+ }
44
+
45
+ module.exports = { withEnv, applyEnv };