siesa-agents 2.1.40 → 2.1.41

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 (552) hide show
  1. package/README.md +147 -147
  2. package/bin/install.js +534 -534
  3. package/bin/prepare-publish.js +26 -26
  4. package/bin/restore-folders.js +26 -26
  5. package/bmad/_config/agent-manifest.csv +20 -20
  6. package/bmad/_config/agents/bmb-agent-builder.customize.yaml +41 -41
  7. package/bmad/_config/agents/bmb-module-builder.customize.yaml +41 -41
  8. package/bmad/_config/agents/bmb-workflow-builder.customize.yaml +41 -41
  9. package/bmad/_config/files-manifest.csv +469 -469
  10. package/bmad/_config/ides/claude-code.yaml +6 -6
  11. package/bmad/_config/manifest.yaml +14 -14
  12. package/bmad/_config/task-manifest.csv +6 -6
  13. package/bmad/_config/tool-manifest.csv +1 -1
  14. package/bmad/_config/workflow-manifest.csv +45 -45
  15. package/bmad/_memory/config.yaml +11 -11
  16. package/bmad/bmb/README.md +25 -25
  17. package/bmad/bmb/agents/agent-builder.md +57 -57
  18. package/bmad/bmb/agents/module-builder.md +60 -60
  19. package/bmad/bmb/agents/workflow-builder.md +56 -56
  20. package/bmad/bmb/config.yaml +12 -12
  21. package/bmad/bmb/docs/workflows/architecture.md +220 -220
  22. package/bmad/bmb/docs/workflows/common-workflow-tools.csv +18 -18
  23. package/bmad/bmb/docs/workflows/csv-data-file-standards.md +206 -206
  24. package/bmad/bmb/docs/workflows/intent-vs-prescriptive-spectrum.md +220 -220
  25. package/bmad/bmb/docs/workflows/step-file-rules.md +469 -469
  26. package/bmad/bmb/docs/workflows/templates/step-01-init-continuable-template.md +241 -241
  27. package/bmad/bmb/docs/workflows/templates/step-1b-template.md +223 -223
  28. package/bmad/bmb/docs/workflows/templates/step-file.md +139 -139
  29. package/bmad/bmb/docs/workflows/templates/step-template.md +290 -290
  30. package/bmad/bmb/docs/workflows/templates/workflow-template.md +104 -104
  31. package/bmad/bmb/docs/workflows/templates/workflow.md +58 -58
  32. package/bmad/bmb/docs/workflows/terms.md +97 -97
  33. package/bmad/bmb/reference/agents/simple-examples/README.md +223 -223
  34. package/bmad/bmb/reference/readme.md +3 -3
  35. package/bmad/bmb/reference/workflows/meal-prep-nutrition/data/dietary-restrictions.csv +17 -17
  36. package/bmad/bmb/reference/workflows/meal-prep-nutrition/data/macro-calculator.csv +15 -15
  37. package/bmad/bmb/reference/workflows/meal-prep-nutrition/data/recipe-database.csv +27 -27
  38. package/bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-01-init.md +177 -177
  39. package/bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-01b-continue.md +121 -121
  40. package/bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-02-profile.md +165 -165
  41. package/bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-03-assessment.md +154 -154
  42. package/bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-04-strategy.md +183 -183
  43. package/bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-05-shopping.md +168 -168
  44. package/bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-06-prep-schedule.md +195 -195
  45. package/bmad/bmb/reference/workflows/meal-prep-nutrition/templates/assessment-section.md +25 -25
  46. package/bmad/bmb/reference/workflows/meal-prep-nutrition/templates/nutrition-plan.md +68 -68
  47. package/bmad/bmb/reference/workflows/meal-prep-nutrition/templates/prep-schedule-section.md +29 -29
  48. package/bmad/bmb/reference/workflows/meal-prep-nutrition/templates/profile-section.md +47 -47
  49. package/bmad/bmb/reference/workflows/meal-prep-nutrition/templates/shopping-section.md +37 -37
  50. package/bmad/bmb/reference/workflows/meal-prep-nutrition/templates/strategy-section.md +18 -18
  51. package/bmad/bmb/reference/workflows/meal-prep-nutrition/workflow.md +59 -59
  52. package/bmad/bmb/workflows/agent/data/agent-compilation.md +273 -273
  53. package/bmad/bmb/workflows/agent/data/agent-menu-patterns.md +233 -233
  54. package/bmad/bmb/workflows/agent/data/agent-metadata.md +208 -208
  55. package/bmad/bmb/workflows/agent/data/brainstorm-context.md +146 -146
  56. package/bmad/bmb/workflows/agent/data/communication-presets.csv +61 -61
  57. package/bmad/bmb/workflows/agent/data/critical-actions.md +120 -120
  58. package/bmad/bmb/workflows/agent/data/expert-agent-architecture.md +236 -236
  59. package/bmad/bmb/workflows/agent/data/expert-agent-validation.md +173 -173
  60. package/bmad/bmb/workflows/agent/data/module-agent-validation.md +124 -124
  61. package/bmad/bmb/workflows/agent/data/persona-properties.md +266 -266
  62. package/bmad/bmb/workflows/agent/data/principles-crafting.md +292 -292
  63. package/bmad/bmb/workflows/agent/data/reference/expert-examples/journal-keeper/journal-keeper-sidecar/entries/yy-mm-dd-entry-template.md +16 -16
  64. package/bmad/bmb/workflows/agent/data/reference/module-examples/architect.md +68 -68
  65. package/bmad/bmb/workflows/agent/data/simple-agent-architecture.md +204 -204
  66. package/bmad/bmb/workflows/agent/data/simple-agent-validation.md +132 -132
  67. package/bmad/bmb/workflows/agent/data/understanding-agent-types.md +222 -222
  68. package/bmad/bmb/workflows/agent/steps-c/step-01-brainstorm.md +126 -126
  69. package/bmad/bmb/workflows/agent/steps-c/step-02-discovery.md +168 -168
  70. package/bmad/bmb/workflows/agent/steps-c/step-03-type-metadata.md +294 -294
  71. package/bmad/bmb/workflows/agent/steps-c/step-04-persona.md +210 -210
  72. package/bmad/bmb/workflows/agent/steps-c/step-05-commands-menu.md +176 -176
  73. package/bmad/bmb/workflows/agent/steps-c/step-06-activation.md +275 -275
  74. package/bmad/bmb/workflows/agent/steps-c/step-07a-build-simple.md +185 -185
  75. package/bmad/bmb/workflows/agent/steps-c/step-07b-build-expert.md +201 -201
  76. package/bmad/bmb/workflows/agent/steps-c/step-07c-build-module.md +258 -258
  77. package/bmad/bmb/workflows/agent/steps-c/step-08a-plan-traceability.md +203 -203
  78. package/bmad/bmb/workflows/agent/steps-c/step-08b-metadata-validation.md +135 -135
  79. package/bmad/bmb/workflows/agent/steps-c/step-08c-persona-validation.md +161 -161
  80. package/bmad/bmb/workflows/agent/steps-c/step-08d-menu-validation.md +158 -158
  81. package/bmad/bmb/workflows/agent/steps-c/step-08e-structure-validation.md +306 -306
  82. package/bmad/bmb/workflows/agent/steps-c/step-08f-sidecar-validation.md +462 -462
  83. package/bmad/bmb/workflows/agent/steps-c/step-09-celebrate.md +244 -244
  84. package/bmad/bmb/workflows/agent/steps-e/e-01-load-existing.md +214 -214
  85. package/bmad/bmb/workflows/agent/steps-e/e-02-discover-edits.md +191 -191
  86. package/bmad/bmb/workflows/agent/steps-e/e-03a-validate-metadata.md +78 -78
  87. package/bmad/bmb/workflows/agent/steps-e/e-03b-validate-persona.md +76 -76
  88. package/bmad/bmb/workflows/agent/steps-e/e-03c-validate-menu.md +75 -75
  89. package/bmad/bmb/workflows/agent/steps-e/e-03d-validate-structure.md +75 -75
  90. package/bmad/bmb/workflows/agent/steps-e/e-03e-validate-sidecar.md +78 -78
  91. package/bmad/bmb/workflows/agent/steps-e/e-03f-validation-summary.md +119 -119
  92. package/bmad/bmb/workflows/agent/steps-e/e-04-type-metadata.md +122 -122
  93. package/bmad/bmb/workflows/agent/steps-e/e-05-persona.md +132 -132
  94. package/bmad/bmb/workflows/agent/steps-e/e-06-commands-menu.md +120 -120
  95. package/bmad/bmb/workflows/agent/steps-e/e-07-activation.md +122 -122
  96. package/bmad/bmb/workflows/agent/steps-e/e-08a-edit-simple.md +134 -134
  97. package/bmad/bmb/workflows/agent/steps-e/e-08b-edit-expert.md +117 -117
  98. package/bmad/bmb/workflows/agent/steps-e/e-08c-edit-module.md +120 -120
  99. package/bmad/bmb/workflows/agent/steps-e/e-09a-validate-metadata.md +70 -70
  100. package/bmad/bmb/workflows/agent/steps-e/e-09b-validate-persona.md +70 -70
  101. package/bmad/bmb/workflows/agent/steps-e/e-09c-validate-menu.md +69 -69
  102. package/bmad/bmb/workflows/agent/steps-e/e-09d-validate-structure.md +69 -69
  103. package/bmad/bmb/workflows/agent/steps-e/e-09e-validate-sidecar.md +70 -70
  104. package/bmad/bmb/workflows/agent/steps-e/e-09f-validation-summary.md +111 -111
  105. package/bmad/bmb/workflows/agent/steps-e/e-10-celebrate.md +150 -150
  106. package/bmad/bmb/workflows/agent/steps-v/v-01-load-review.md +128 -128
  107. package/bmad/bmb/workflows/agent/steps-v/v-02a-validate-metadata.md +73 -73
  108. package/bmad/bmb/workflows/agent/steps-v/v-02b-validate-persona.md +72 -72
  109. package/bmad/bmb/workflows/agent/steps-v/v-02c-validate-menu.md +71 -71
  110. package/bmad/bmb/workflows/agent/steps-v/v-02d-validate-structure.md +71 -71
  111. package/bmad/bmb/workflows/agent/steps-v/v-02e-validate-sidecar.md +76 -76
  112. package/bmad/bmb/workflows/agent/steps-v/v-03-summary.md +100 -100
  113. package/bmad/bmb/workflows/agent/templates/agent-plan.template.md +5 -5
  114. package/bmad/bmb/workflows/agent/templates/expert-agent-template/expert-agent.template.md +76 -76
  115. package/bmad/bmb/workflows/agent/templates/simple-agent.template.md +71 -71
  116. package/bmad/bmb/workflows/agent/workflow.md +123 -123
  117. package/bmad/bmb/workflows/create-module/steps/step-01-init.md +156 -156
  118. package/bmad/bmb/workflows/create-module/steps/step-01b-continue.md +170 -170
  119. package/bmad/bmb/workflows/create-module/steps/step-02-concept.md +218 -218
  120. package/bmad/bmb/workflows/create-module/steps/step-03-components.md +268 -268
  121. package/bmad/bmb/workflows/create-module/steps/step-04-structure.md +229 -229
  122. package/bmad/bmb/workflows/create-module/steps/step-05-config.md +234 -234
  123. package/bmad/bmb/workflows/create-module/steps/step-06-agents.md +297 -297
  124. package/bmad/bmb/workflows/create-module/steps/step-07-workflows.md +229 -229
  125. package/bmad/bmb/workflows/create-module/steps/step-08-installer.md +187 -187
  126. package/bmad/bmb/workflows/create-module/steps/step-09-documentation.md +310 -310
  127. package/bmad/bmb/workflows/create-module/steps/step-10-roadmap.md +338 -338
  128. package/bmad/bmb/workflows/create-module/steps/step-11-validate.md +336 -336
  129. package/bmad/bmb/workflows/create-module/templates/agent.template.md +313 -313
  130. package/bmad/bmb/workflows/create-module/templates/installer.template.js +47 -47
  131. package/bmad/bmb/workflows/create-module/templates/module-plan.template.md +5 -5
  132. package/bmad/bmb/workflows/create-module/templates/module.template.yaml +53 -53
  133. package/bmad/bmb/workflows/create-module/templates/workflow-plan-template.md +23 -23
  134. package/bmad/bmb/workflows/create-module/validation.md +126 -126
  135. package/bmad/bmb/workflows/create-module/workflow.md +56 -56
  136. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/data/dietary-restrictions.csv +17 -17
  137. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/data/macro-calculator.csv +15 -15
  138. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/data/recipe-database.csv +27 -27
  139. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-01-init.md +177 -177
  140. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-01b-continue.md +150 -150
  141. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-02-profile.md +164 -164
  142. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-03-assessment.md +152 -152
  143. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-04-strategy.md +182 -182
  144. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-05-shopping.md +167 -167
  145. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-06-prep-schedule.md +194 -194
  146. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/assessment-section.md +25 -25
  147. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/nutrition-plan.md +68 -68
  148. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/prep-schedule-section.md +29 -29
  149. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/profile-section.md +47 -47
  150. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/shopping-section.md +37 -37
  151. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/strategy-section.md +18 -18
  152. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/workflow.md +58 -58
  153. package/bmad/bmb/workflows/create-workflow/steps/step-01-init.md +158 -158
  154. package/bmad/bmb/workflows/create-workflow/steps/step-02-gather.md +212 -212
  155. package/bmad/bmb/workflows/create-workflow/steps/step-03-tools-configuration.md +251 -251
  156. package/bmad/bmb/workflows/create-workflow/steps/step-04-plan-review.md +217 -217
  157. package/bmad/bmb/workflows/create-workflow/steps/step-05-output-format-design.md +290 -290
  158. package/bmad/bmb/workflows/create-workflow/steps/step-06-design.md +272 -272
  159. package/bmad/bmb/workflows/create-workflow/steps/step-07-build.md +323 -323
  160. package/bmad/bmb/workflows/create-workflow/steps/step-08-review.md +285 -285
  161. package/bmad/bmb/workflows/create-workflow/steps/step-09-complete.md +188 -188
  162. package/bmad/bmb/workflows/create-workflow/workflow.md +59 -59
  163. package/bmad/bmb/workflows/edit-workflow/steps/step-01-analyze.md +217 -217
  164. package/bmad/bmb/workflows/edit-workflow/steps/step-02-discover.md +254 -254
  165. package/bmad/bmb/workflows/edit-workflow/steps/step-03-improve.md +218 -218
  166. package/bmad/bmb/workflows/edit-workflow/steps/step-04-validate.md +194 -194
  167. package/bmad/bmb/workflows/edit-workflow/steps/step-05-compliance-check.md +246 -246
  168. package/bmad/bmb/workflows/edit-workflow/templates/completion-summary.md +75 -75
  169. package/bmad/bmb/workflows/edit-workflow/templates/improvement-goals.md +68 -68
  170. package/bmad/bmb/workflows/edit-workflow/templates/improvement-log.md +40 -40
  171. package/bmad/bmb/workflows/edit-workflow/templates/validation-results.md +51 -51
  172. package/bmad/bmb/workflows/edit-workflow/templates/workflow-analysis.md +56 -56
  173. package/bmad/bmb/workflows/edit-workflow/workflow.md +59 -59
  174. package/bmad/bmb/workflows/workflow-compliance-check/steps/step-01-validate-goal.md +153 -153
  175. package/bmad/bmb/workflows/workflow-compliance-check/steps/step-02-workflow-validation.md +244 -244
  176. package/bmad/bmb/workflows/workflow-compliance-check/steps/step-03-step-validation.md +275 -275
  177. package/bmad/bmb/workflows/workflow-compliance-check/steps/step-04-file-validation.md +296 -296
  178. package/bmad/bmb/workflows/workflow-compliance-check/steps/step-05-intent-spectrum-validation.md +265 -265
  179. package/bmad/bmb/workflows/workflow-compliance-check/steps/step-06-web-subprocess-validation.md +361 -361
  180. package/bmad/bmb/workflows/workflow-compliance-check/steps/step-07-holistic-analysis.md +259 -259
  181. package/bmad/bmb/workflows/workflow-compliance-check/steps/step-08-generate-report.md +302 -302
  182. package/bmad/bmb/workflows/workflow-compliance-check/templates/compliance-report.md +140 -140
  183. package/bmad/bmb/workflows/workflow-compliance-check/workflow.md +59 -59
  184. package/bmad/bmb/workflows-legacy/edit-module/README.md +171 -171
  185. package/bmad/bmb/workflows-legacy/edit-module/checklist.md +163 -163
  186. package/bmad/bmb/workflows-legacy/edit-module/instructions.md +340 -340
  187. package/bmad/bmb/workflows-legacy/edit-module/workflow.yaml +32 -32
  188. package/bmad/bmb/workflows-legacy/module-brief/README.md +264 -264
  189. package/bmad/bmb/workflows-legacy/module-brief/checklist.md +116 -116
  190. package/bmad/bmb/workflows-legacy/module-brief/instructions.md +268 -268
  191. package/bmad/bmb/workflows-legacy/module-brief/template.md +275 -275
  192. package/bmad/bmb/workflows-legacy/module-brief/workflow.yaml +34 -34
  193. package/bmad/bmm/agents/analyst.md +76 -76
  194. package/bmad/bmm/agents/architect.md +68 -68
  195. package/bmad/bmm/agents/dev.md +70 -70
  196. package/bmad/bmm/agents/pm.md +70 -70
  197. package/bmad/bmm/agents/quick-flow-solo-dev.md +68 -68
  198. package/bmad/bmm/agents/sm.md +71 -71
  199. package/bmad/bmm/agents/tea.md +71 -71
  200. package/bmad/bmm/agents/tech-writer.md +72 -72
  201. package/bmad/bmm/agents/ux-designer.md +68 -68
  202. package/bmad/bmm/config.yaml +18 -18
  203. package/bmad/bmm/data/README.md +29 -29
  204. package/bmad/bmm/data/documentation-standards.md +262 -262
  205. package/bmad/bmm/data/project-context-template.md +40 -40
  206. package/bmad/bmm/teams/default-party.csv +21 -21
  207. package/bmad/bmm/teams/team-fullstack.yaml +12 -12
  208. package/bmad/bmm/testarch/knowledge/api-request.md +303 -303
  209. package/bmad/bmm/testarch/knowledge/auth-session.md +356 -356
  210. package/bmad/bmm/testarch/knowledge/burn-in.md +273 -273
  211. package/bmad/bmm/testarch/knowledge/ci-burn-in.md +675 -675
  212. package/bmad/bmm/testarch/knowledge/component-tdd.md +486 -486
  213. package/bmad/bmm/testarch/knowledge/contract-testing.md +957 -957
  214. package/bmad/bmm/testarch/knowledge/data-factories.md +500 -500
  215. package/bmad/bmm/testarch/knowledge/email-auth.md +721 -721
  216. package/bmad/bmm/testarch/knowledge/error-handling.md +725 -725
  217. package/bmad/bmm/testarch/knowledge/feature-flags.md +750 -750
  218. package/bmad/bmm/testarch/knowledge/file-utils.md +260 -260
  219. package/bmad/bmm/testarch/knowledge/fixture-architecture.md +401 -401
  220. package/bmad/bmm/testarch/knowledge/fixtures-composition.md +382 -382
  221. package/bmad/bmm/testarch/knowledge/intercept-network-call.md +280 -280
  222. package/bmad/bmm/testarch/knowledge/log.md +294 -294
  223. package/bmad/bmm/testarch/knowledge/network-error-monitor.md +272 -272
  224. package/bmad/bmm/testarch/knowledge/network-first.md +486 -486
  225. package/bmad/bmm/testarch/knowledge/network-recorder.md +265 -265
  226. package/bmad/bmm/testarch/knowledge/nfr-criteria.md +670 -670
  227. package/bmad/bmm/testarch/knowledge/overview.md +283 -283
  228. package/bmad/bmm/testarch/knowledge/playwright-config.md +730 -730
  229. package/bmad/bmm/testarch/knowledge/probability-impact.md +601 -601
  230. package/bmad/bmm/testarch/knowledge/recurse.md +296 -296
  231. package/bmad/bmm/testarch/knowledge/risk-governance.md +615 -615
  232. package/bmad/bmm/testarch/knowledge/selective-testing.md +732 -732
  233. package/bmad/bmm/testarch/knowledge/selector-resilience.md +527 -527
  234. package/bmad/bmm/testarch/knowledge/test-healing-patterns.md +644 -644
  235. package/bmad/bmm/testarch/knowledge/test-levels-framework.md +473 -473
  236. package/bmad/bmm/testarch/knowledge/test-priorities-matrix.md +373 -373
  237. package/bmad/bmm/testarch/knowledge/test-quality.md +664 -664
  238. package/bmad/bmm/testarch/knowledge/timing-debugging.md +372 -372
  239. package/bmad/bmm/testarch/knowledge/visual-debugging.md +524 -524
  240. package/bmad/bmm/testarch/tea-index.csv +33 -33
  241. package/bmad/bmm/workflows/1-analysis/create-product-brief/product-brief.template.md +10 -10
  242. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-01-init.md +182 -182
  243. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-01b-continue.md +166 -166
  244. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-02-vision.md +204 -204
  245. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-03-users.md +207 -207
  246. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-04-metrics.md +210 -210
  247. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-05-scope.md +224 -224
  248. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-06-complete.md +199 -199
  249. package/bmad/bmm/workflows/1-analysis/create-product-brief/workflow.md +58 -58
  250. package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-01-init.md +137 -137
  251. package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-02-domain-analysis.md +229 -229
  252. package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-03-competitive-landscape.md +238 -238
  253. package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-04-regulatory-focus.md +206 -206
  254. package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-05-technical-trends.md +234 -234
  255. package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-06-research-synthesis.md +443 -443
  256. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-01-init.md +182 -182
  257. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-02-customer-behavior.md +237 -237
  258. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-02-customer-insights.md +200 -200
  259. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-03-customer-pain-points.md +249 -249
  260. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-04-customer-decisions.md +259 -259
  261. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-05-competitive-analysis.md +177 -177
  262. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-06-research-completion.md +475 -475
  263. package/bmad/bmm/workflows/1-analysis/research/research.template.md +29 -29
  264. package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-01-init.md +137 -137
  265. package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-02-technical-overview.md +239 -239
  266. package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-03-integration-patterns.md +248 -248
  267. package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-04-architectural-patterns.md +202 -202
  268. package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-05-implementation-research.md +239 -239
  269. package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-06-research-synthesis.md +486 -486
  270. package/bmad/bmm/workflows/1-analysis/research/workflow.md +173 -173
  271. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01-init.md +135 -135
  272. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01b-continue.md +127 -127
  273. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-02-discovery.md +190 -190
  274. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-03-core-experience.md +216 -216
  275. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-04-emotional-response.md +219 -219
  276. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-05-inspiration.md +234 -234
  277. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-06-design-system.md +252 -252
  278. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-07-defining-experience.md +254 -254
  279. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-08-visual-foundation.md +224 -224
  280. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-09-design-directions.md +224 -224
  281. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-10-user-journeys.md +241 -241
  282. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-11-component-strategy.md +248 -248
  283. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-12-ux-patterns.md +237 -237
  284. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-13-responsive-accessibility.md +264 -264
  285. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-14-complete.md +228 -228
  286. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/ux-design-template.md +13 -13
  287. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md +43 -43
  288. package/bmad/bmm/workflows/2-plan-workflows/prd/domain-complexity.csv +12 -12
  289. package/bmad/bmm/workflows/2-plan-workflows/prd/prd-template.md +11 -11
  290. package/bmad/bmm/workflows/2-plan-workflows/prd/project-types.csv +10 -10
  291. package/bmad/bmm/workflows/2-plan-workflows/prd/steps/step-01-init.md +197 -197
  292. package/bmad/bmm/workflows/2-plan-workflows/prd/steps/step-01b-continue.md +166 -166
  293. package/bmad/bmm/workflows/2-plan-workflows/prd/steps/step-02-discovery.md +421 -421
  294. package/bmad/bmm/workflows/2-plan-workflows/prd/steps/step-03-success.md +290 -290
  295. package/bmad/bmm/workflows/2-plan-workflows/prd/steps/step-04-journeys.md +291 -291
  296. package/bmad/bmm/workflows/2-plan-workflows/prd/steps/step-05-domain.md +271 -271
  297. package/bmad/bmm/workflows/2-plan-workflows/prd/steps/step-06-innovation.md +262 -262
  298. package/bmad/bmm/workflows/2-plan-workflows/prd/steps/step-07-project-type.md +258 -258
  299. package/bmad/bmm/workflows/2-plan-workflows/prd/steps/step-08-scoping.md +299 -299
  300. package/bmad/bmm/workflows/2-plan-workflows/prd/steps/step-09-functional.md +270 -270
  301. package/bmad/bmm/workflows/2-plan-workflows/prd/steps/step-10-nonfunctional.md +294 -294
  302. package/bmad/bmm/workflows/2-plan-workflows/prd/steps/step-11-complete.md +186 -186
  303. package/bmad/bmm/workflows/2-plan-workflows/prd/workflow.md +63 -63
  304. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-01-document-discovery.md +190 -190
  305. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-02-prd-analysis.md +178 -178
  306. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-03-epic-coverage-validation.md +179 -179
  307. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-04-ux-alignment.md +139 -139
  308. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-05-epic-quality-review.md +252 -252
  309. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-06-final-assessment.md +133 -133
  310. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/templates/readiness-report-template.md +4 -4
  311. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md +55 -55
  312. package/bmad/bmm/workflows/3-solutioning/create-architecture/architecture-decision-template.md +12 -12
  313. package/bmad/bmm/workflows/3-solutioning/create-architecture/data/company-standards/architecture-patterns.md +415 -415
  314. package/bmad/bmm/workflows/3-solutioning/create-architecture/data/company-standards/backend-standards.md +811 -811
  315. package/bmad/bmm/workflows/3-solutioning/create-architecture/data/company-standards/frontend-standards.md +375 -375
  316. package/bmad/bmm/workflows/3-solutioning/create-architecture/data/company-standards/technical-preferences-ux.md +422 -422
  317. package/bmad/bmm/workflows/3-solutioning/create-architecture/data/company-standards/technology-stack.md +235 -235
  318. package/bmad/bmm/workflows/3-solutioning/create-architecture/data/domain-complexity.csv +10 -10
  319. package/bmad/bmm/workflows/3-solutioning/create-architecture/data/project-types.csv +6 -6
  320. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-01-init.md +166 -166
  321. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-01b-continue.md +164 -164
  322. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-02-context.md +224 -224
  323. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-03-starter.md +342 -342
  324. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-04-decisions.md +328 -328
  325. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-05-patterns.md +368 -368
  326. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-06-structure.md +379 -379
  327. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-07-validation.md +366 -366
  328. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-08-complete.md +352 -352
  329. package/bmad/bmm/workflows/3-solutioning/create-architecture/workflow.md +51 -51
  330. package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-01-validate-prerequisites.md +259 -259
  331. package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-02-design-epics.md +233 -233
  332. package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-03-create-stories.md +272 -272
  333. package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-04-final-validation.md +145 -145
  334. package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/templates/epics-template.md +57 -57
  335. package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md +59 -59
  336. package/bmad/bmm/workflows/4-implementation/code-review/checklist.md +23 -23
  337. package/bmad/bmm/workflows/4-implementation/code-review/instructions.xml +224 -224
  338. package/bmad/bmm/workflows/4-implementation/code-review/workflow.yaml +49 -49
  339. package/bmad/bmm/workflows/4-implementation/correct-course/checklist.md +279 -279
  340. package/bmad/bmm/workflows/4-implementation/correct-course/instructions.md +206 -206
  341. package/bmad/bmm/workflows/4-implementation/correct-course/workflow.yaml +58 -58
  342. package/bmad/bmm/workflows/4-implementation/create-story/checklist.md +358 -358
  343. package/bmad/bmm/workflows/4-implementation/create-story/steps/step-01-determine-story.md +85 -85
  344. package/bmad/bmm/workflows/4-implementation/create-story/steps/step-02-analyze.md +67 -67
  345. package/bmad/bmm/workflows/4-implementation/create-story/steps/step-03-architecture.md +71 -71
  346. package/bmad/bmm/workflows/4-implementation/create-story/steps/step-04-web-research.md +58 -58
  347. package/bmad/bmm/workflows/4-implementation/create-story/steps/step-05-create-file.md +76 -76
  348. package/bmad/bmm/workflows/4-implementation/create-story/steps/step-06-finalize.md +66 -66
  349. package/bmad/bmm/workflows/4-implementation/create-story/template.md +49 -49
  350. package/bmad/bmm/workflows/4-implementation/create-story/workflow.md +58 -58
  351. package/bmad/bmm/workflows/4-implementation/create-story/workflow.yaml.bak +63 -63
  352. package/bmad/bmm/workflows/4-implementation/dev-story/checklist.md +85 -85
  353. package/bmad/bmm/workflows/4-implementation/dev-story/instructions.xml +470 -470
  354. package/bmad/bmm/workflows/4-implementation/dev-story/workflow.yaml +25 -25
  355. package/bmad/bmm/workflows/4-implementation/retrospective/instructions.md +1443 -1443
  356. package/bmad/bmm/workflows/4-implementation/retrospective/workflow.yaml +56 -56
  357. package/bmad/bmm/workflows/4-implementation/sprint-planning/checklist.md +33 -33
  358. package/bmad/bmm/workflows/4-implementation/sprint-planning/instructions.md +225 -225
  359. package/bmad/bmm/workflows/4-implementation/sprint-planning/sprint-status-template.yaml +55 -55
  360. package/bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml +52 -52
  361. package/bmad/bmm/workflows/4-implementation/sprint-status/instructions.md +229 -229
  362. package/bmad/bmm/workflows/4-implementation/sprint-status/workflow.yaml +34 -34
  363. package/bmad/bmm/workflows/bmad-quick-flow/create-tech-spec/steps/step-01-understand.md +189 -189
  364. package/bmad/bmm/workflows/bmad-quick-flow/create-tech-spec/steps/step-02-investigate.md +144 -144
  365. package/bmad/bmm/workflows/bmad-quick-flow/create-tech-spec/steps/step-03-generate.md +128 -128
  366. package/bmad/bmm/workflows/bmad-quick-flow/create-tech-spec/steps/step-04-review.md +173 -173
  367. package/bmad/bmm/workflows/bmad-quick-flow/create-tech-spec/tech-spec-template.md +74 -74
  368. package/bmad/bmm/workflows/bmad-quick-flow/create-tech-spec/workflow.md +79 -79
  369. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-01-mode-detection.md +156 -156
  370. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-02-context-gathering.md +120 -120
  371. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-03-execute.md +113 -113
  372. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-04-self-check.md +113 -113
  373. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-05-adversarial-review.md +106 -106
  374. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-06-resolve-findings.md +140 -140
  375. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/workflow.md +52 -52
  376. package/bmad/bmm/workflows/document-project/checklist.md +245 -245
  377. package/bmad/bmm/workflows/document-project/documentation-requirements.csv +12 -12
  378. package/bmad/bmm/workflows/document-project/instructions.md +221 -221
  379. package/bmad/bmm/workflows/document-project/templates/deep-dive-template.md +345 -345
  380. package/bmad/bmm/workflows/document-project/templates/index-template.md +169 -169
  381. package/bmad/bmm/workflows/document-project/templates/project-overview-template.md +103 -103
  382. package/bmad/bmm/workflows/document-project/templates/project-scan-report-schema.json +160 -160
  383. package/bmad/bmm/workflows/document-project/templates/source-tree-template.md +135 -135
  384. package/bmad/bmm/workflows/document-project/workflow.yaml +28 -28
  385. package/bmad/bmm/workflows/document-project/workflows/deep-dive-instructions.md +298 -298
  386. package/bmad/bmm/workflows/document-project/workflows/deep-dive.yaml +31 -31
  387. package/bmad/bmm/workflows/document-project/workflows/full-scan-instructions.md +1106 -1106
  388. package/bmad/bmm/workflows/document-project/workflows/full-scan.yaml +31 -31
  389. package/bmad/bmm/workflows/excalidraw-diagrams/_shared/excalidraw-library.json +90 -90
  390. package/bmad/bmm/workflows/excalidraw-diagrams/_shared/excalidraw-templates.yaml +127 -127
  391. package/bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/checklist.md +39 -39
  392. package/bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/instructions.md +130 -130
  393. package/bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/workflow.yaml +25 -25
  394. package/bmad/bmm/workflows/excalidraw-diagrams/create-diagram/checklist.md +43 -43
  395. package/bmad/bmm/workflows/excalidraw-diagrams/create-diagram/instructions.md +141 -141
  396. package/bmad/bmm/workflows/excalidraw-diagrams/create-diagram/workflow.yaml +25 -25
  397. package/bmad/bmm/workflows/excalidraw-diagrams/create-flowchart/checklist.md +49 -49
  398. package/bmad/bmm/workflows/excalidraw-diagrams/create-flowchart/instructions.md +241 -241
  399. package/bmad/bmm/workflows/excalidraw-diagrams/create-flowchart/workflow.yaml +25 -25
  400. package/bmad/bmm/workflows/excalidraw-diagrams/create-wireframe/checklist.md +38 -38
  401. package/bmad/bmm/workflows/excalidraw-diagrams/create-wireframe/instructions.md +133 -133
  402. package/bmad/bmm/workflows/excalidraw-diagrams/create-wireframe/workflow.yaml +25 -25
  403. package/bmad/bmm/workflows/generate-project-context/project-context-template.md +21 -21
  404. package/bmad/bmm/workflows/generate-project-context/steps/step-01-discover.md +218 -218
  405. package/bmad/bmm/workflows/generate-project-context/steps/step-02-generate.md +318 -318
  406. package/bmad/bmm/workflows/generate-project-context/steps/step-03-complete.md +278 -278
  407. package/bmad/bmm/workflows/generate-project-context/workflow.md +50 -50
  408. package/bmad/bmm/workflows/testarch/atdd/atdd-checklist-template.md +364 -364
  409. package/bmad/bmm/workflows/testarch/atdd/checklist.md +374 -374
  410. package/bmad/bmm/workflows/testarch/atdd/instructions.md +806 -806
  411. package/bmad/bmm/workflows/testarch/atdd/workflow.yaml +45 -45
  412. package/bmad/bmm/workflows/testarch/automate/checklist.md +582 -582
  413. package/bmad/bmm/workflows/testarch/automate/instructions.md +1324 -1324
  414. package/bmad/bmm/workflows/testarch/automate/workflow.yaml +52 -52
  415. package/bmad/bmm/workflows/testarch/ci/checklist.md +248 -248
  416. package/bmad/bmm/workflows/testarch/ci/github-actions-template.yaml +198 -198
  417. package/bmad/bmm/workflows/testarch/ci/gitlab-ci-template.yaml +149 -149
  418. package/bmad/bmm/workflows/testarch/ci/instructions.md +536 -536
  419. package/bmad/bmm/workflows/testarch/ci/workflow.yaml +45 -45
  420. package/bmad/bmm/workflows/testarch/framework/checklist.md +321 -321
  421. package/bmad/bmm/workflows/testarch/framework/instructions.md +481 -481
  422. package/bmad/bmm/workflows/testarch/framework/workflow.yaml +47 -47
  423. package/bmad/bmm/workflows/testarch/nfr-assess/checklist.md +407 -407
  424. package/bmad/bmm/workflows/testarch/nfr-assess/instructions.md +722 -722
  425. package/bmad/bmm/workflows/testarch/nfr-assess/nfr-report-template.md +445 -445
  426. package/bmad/bmm/workflows/testarch/nfr-assess/workflow.yaml +47 -47
  427. package/bmad/bmm/workflows/testarch/test-design/checklist.md +235 -235
  428. package/bmad/bmm/workflows/testarch/test-design/instructions.md +788 -788
  429. package/bmad/bmm/workflows/testarch/test-design/test-design-template.md +294 -294
  430. package/bmad/bmm/workflows/testarch/test-design/workflow.yaml +54 -54
  431. package/bmad/bmm/workflows/testarch/test-review/checklist.md +472 -472
  432. package/bmad/bmm/workflows/testarch/test-review/instructions.md +628 -628
  433. package/bmad/bmm/workflows/testarch/test-review/test-review-template.md +390 -390
  434. package/bmad/bmm/workflows/testarch/test-review/workflow.yaml +46 -46
  435. package/bmad/bmm/workflows/testarch/trace/checklist.md +655 -655
  436. package/bmad/bmm/workflows/testarch/trace/instructions.md +1047 -1047
  437. package/bmad/bmm/workflows/testarch/trace/trace-template.md +675 -675
  438. package/bmad/bmm/workflows/testarch/trace/workflow.yaml +55 -55
  439. package/bmad/bmm/workflows/workflow-status/init/instructions.md +346 -346
  440. package/bmad/bmm/workflows/workflow-status/init/workflow.yaml +28 -28
  441. package/bmad/bmm/workflows/workflow-status/instructions.md +395 -395
  442. package/bmad/bmm/workflows/workflow-status/paths/enterprise-brownfield.yaml +103 -103
  443. package/bmad/bmm/workflows/workflow-status/paths/enterprise-greenfield.yaml +100 -100
  444. package/bmad/bmm/workflows/workflow-status/paths/method-brownfield.yaml +103 -103
  445. package/bmad/bmm/workflows/workflow-status/paths/method-greenfield.yaml +100 -100
  446. package/bmad/bmm/workflows/workflow-status/project-levels.yaml +59 -59
  447. package/bmad/bmm/workflows/workflow-status/workflow-status-template.yaml +24 -24
  448. package/bmad/bmm/workflows/workflow-status/workflow.yaml +30 -30
  449. package/bmad/cis/agents/brainstorming-coach.md +60 -60
  450. package/bmad/cis/agents/creative-problem-solver.md +60 -60
  451. package/bmad/cis/agents/design-thinking-coach.md +60 -60
  452. package/bmad/cis/agents/innovation-strategist.md +60 -60
  453. package/bmad/cis/agents/presentation-master.md +66 -66
  454. package/bmad/cis/agents/storyteller/storyteller.md +57 -57
  455. package/bmad/cis/config.yaml +11 -11
  456. package/bmad/cis/teams/creative-squad.yaml +7 -7
  457. package/bmad/cis/teams/default-party.csv +12 -12
  458. package/bmad/cis/workflows/README.md +139 -139
  459. package/bmad/cis/workflows/design-thinking/README.md +56 -56
  460. package/bmad/cis/workflows/design-thinking/design-methods.csv +30 -30
  461. package/bmad/cis/workflows/design-thinking/instructions.md +202 -202
  462. package/bmad/cis/workflows/design-thinking/template.md +111 -111
  463. package/bmad/cis/workflows/design-thinking/workflow.yaml +27 -27
  464. package/bmad/cis/workflows/innovation-strategy/README.md +56 -56
  465. package/bmad/cis/workflows/innovation-strategy/innovation-frameworks.csv +30 -30
  466. package/bmad/cis/workflows/innovation-strategy/instructions.md +276 -276
  467. package/bmad/cis/workflows/innovation-strategy/template.md +189 -189
  468. package/bmad/cis/workflows/innovation-strategy/workflow.yaml +27 -27
  469. package/bmad/cis/workflows/problem-solving/README.md +56 -56
  470. package/bmad/cis/workflows/problem-solving/instructions.md +252 -252
  471. package/bmad/cis/workflows/problem-solving/solving-methods.csv +30 -30
  472. package/bmad/cis/workflows/problem-solving/template.md +165 -165
  473. package/bmad/cis/workflows/problem-solving/workflow.yaml +27 -27
  474. package/bmad/cis/workflows/storytelling/README.md +58 -58
  475. package/bmad/cis/workflows/storytelling/instructions.md +293 -293
  476. package/bmad/cis/workflows/storytelling/story-types.csv +25 -25
  477. package/bmad/cis/workflows/storytelling/template.md +113 -113
  478. package/bmad/cis/workflows/storytelling/workflow.yaml +27 -27
  479. package/bmad/core/agents/bmad-master.md +57 -57
  480. package/bmad/core/config.yaml +9 -9
  481. package/bmad/core/resources/excalidraw/README.md +160 -160
  482. package/bmad/core/resources/excalidraw/excalidraw-helpers.md +127 -127
  483. package/bmad/core/resources/excalidraw/library-loader.md +50 -50
  484. package/bmad/core/resources/excalidraw/validate-json-instructions.md +79 -79
  485. package/bmad/core/tasks/index-docs.xml +64 -64
  486. package/bmad/core/tasks/review-adversarial-general.xml +41 -41
  487. package/bmad/core/tasks/shard-doc.xml +108 -108
  488. package/bmad/core/tasks/validate-workflow.xml +88 -88
  489. package/bmad/core/tasks/workflow.xml +234 -234
  490. package/bmad/core/workflows/advanced-elicitation/methods.csv +51 -51
  491. package/bmad/core/workflows/advanced-elicitation/workflow.xml +116 -116
  492. package/bmad/core/workflows/brainstorming/brain-methods.csv +61 -61
  493. package/bmad/core/workflows/brainstorming/steps/step-01-session-setup.md +197 -197
  494. package/bmad/core/workflows/brainstorming/steps/step-01b-continue.md +122 -122
  495. package/bmad/core/workflows/brainstorming/steps/step-02a-user-selected.md +225 -225
  496. package/bmad/core/workflows/brainstorming/steps/step-02b-ai-recommended.md +237 -237
  497. package/bmad/core/workflows/brainstorming/steps/step-02c-random-selection.md +209 -209
  498. package/bmad/core/workflows/brainstorming/steps/step-02d-progressive-flow.md +264 -264
  499. package/bmad/core/workflows/brainstorming/steps/step-03-technique-execution.md +340 -340
  500. package/bmad/core/workflows/brainstorming/steps/step-04-idea-organization.md +303 -303
  501. package/bmad/core/workflows/brainstorming/template.md +15 -15
  502. package/bmad/core/workflows/brainstorming/workflow.md +51 -51
  503. package/bmad/core/workflows/party-mode/steps/step-01-agent-loading.md +139 -139
  504. package/bmad/core/workflows/party-mode/steps/step-02-discussion-orchestration.md +204 -204
  505. package/bmad/core/workflows/party-mode/steps/step-03-graceful-exit.md +159 -159
  506. package/bmad/core/workflows/party-mode/workflow.md +206 -206
  507. package/claude/hooks/file-restriction-hook.py +51 -51
  508. package/claude/hooks/track-agent.py +67 -67
  509. package/claude/settings.local.json +76 -76
  510. package/gemini/commands/BMad/agents/analyst.toml +6 -0
  511. package/gemini/commands/BMad/agents/architect.toml +6 -0
  512. package/gemini/commands/BMad/agents/bmad-master.toml +6 -0
  513. package/gemini/commands/BMad/agents/bmad-orchestrator.toml +6 -0
  514. package/gemini/commands/BMad/agents/dev.toml +6 -0
  515. package/gemini/commands/BMad/agents/pm.toml +6 -0
  516. package/gemini/commands/BMad/agents/po.toml +6 -0
  517. package/gemini/commands/BMad/agents/qa.toml +6 -0
  518. package/gemini/commands/BMad/agents/sm.toml +6 -0
  519. package/gemini/commands/BMad/agents/ux-expert.toml +6 -0
  520. package/gemini/commands/BMad/tasks/advanced-elicitation.toml +6 -0
  521. package/gemini/commands/BMad/tasks/apply-qa-fixes.toml +6 -0
  522. package/gemini/commands/BMad/tasks/brownfield-create-epic.toml +6 -0
  523. package/gemini/commands/BMad/tasks/brownfield-create-story.toml +6 -0
  524. package/gemini/commands/BMad/tasks/correct-course.toml +6 -0
  525. package/gemini/commands/BMad/tasks/create-brownfield-story.toml +6 -0
  526. package/gemini/commands/BMad/tasks/create-deep-research-prompt.toml +6 -0
  527. package/gemini/commands/BMad/tasks/create-doc.toml +6 -0
  528. package/gemini/commands/BMad/tasks/create-next-story.toml +6 -0
  529. package/gemini/commands/BMad/tasks/document-project.toml +6 -0
  530. package/gemini/commands/BMad/tasks/execute-checklist.toml +6 -0
  531. package/gemini/commands/BMad/tasks/facilitate-brainstorming-session.toml +6 -0
  532. package/gemini/commands/BMad/tasks/generate-ai-frontend-prompt.toml +6 -0
  533. package/gemini/commands/BMad/tasks/index-docs.toml +6 -0
  534. package/gemini/commands/BMad/tasks/kb-mode-interaction.toml +6 -0
  535. package/gemini/commands/BMad/tasks/nfr-assess.toml +6 -0
  536. package/gemini/commands/BMad/tasks/qa-gate.toml +6 -0
  537. package/gemini/commands/BMad/tasks/review-story.toml +6 -0
  538. package/gemini/commands/BMad/tasks/risk-profile.toml +6 -0
  539. package/gemini/commands/BMad/tasks/shard-doc.toml +6 -0
  540. package/gemini/commands/BMad/tasks/test-design.toml +6 -0
  541. package/gemini/commands/BMad/tasks/trace-requirements.toml +6 -0
  542. package/gemini/commands/BMad/tasks/validate-next-story.toml +6 -0
  543. package/github/workflows/publish.yml +150 -150
  544. package/index.js +9 -9
  545. package/mcp.json +14 -14
  546. package/package.json +41 -40
  547. package/resources/images/Siesa_Logosimbolo_Azul.svg +24 -24
  548. package/resources/images/Siesa_Logosimbolo_Blanco.svg +24 -24
  549. package/resources/images/Siesa_Simbolo_Azul.svg +14 -14
  550. package/resources/images/Siesa_Simbolo_Blanco.svg +14 -14
  551. package/vscode/mcp.json +15 -15
  552. package/vscode/settings.json +12 -12
@@ -1,725 +1,725 @@
1
- # Error Handling and Resilience Checks
2
-
3
- ## Principle
4
-
5
- Treat expected failures explicitly: intercept network errors, assert UI fallbacks (error messages visible, retries triggered), and use scoped exception handling to ignore known errors while catching regressions. Test retry/backoff logic by forcing sequential failures (500 → timeout → success) and validate telemetry logging. Log captured errors with context (request payload, user/session) but redact secrets to keep artifacts safe for sharing.
6
-
7
- ## Rationale
8
-
9
- Tests fail for two reasons: genuine bugs or poor error handling in the test itself. Without explicit error handling patterns, tests become noisy (uncaught exceptions cause false failures) or silent (swallowing all errors hides real bugs). Scoped exception handling (Cypress.on('uncaught:exception'), page.on('pageerror')) allows tests to ignore documented, expected errors while surfacing unexpected ones. Resilience testing (retry logic, graceful degradation) ensures applications handle failures gracefully in production.
10
-
11
- ## Pattern Examples
12
-
13
- ### Example 1: Scoped Exception Handling (Expected Errors Only)
14
-
15
- **Context**: Handle known errors (Network failures, expected 500s) without masking unexpected bugs.
16
-
17
- **Implementation**:
18
-
19
- ```typescript
20
- // tests/e2e/error-handling.spec.ts
21
- import { test, expect } from '@playwright/test';
22
-
23
- /**
24
- * Scoped Error Handling Pattern
25
- * - Only ignore specific, documented errors
26
- * - Rethrow everything else to catch regressions
27
- * - Validate error UI and user experience
28
- */
29
-
30
- test.describe('API Error Handling', () => {
31
- test('should display error message when API returns 500', async ({ page }) => {
32
- // Scope error handling to THIS test only
33
- const consoleErrors: string[] = [];
34
- page.on('pageerror', (error) => {
35
- // Only swallow documented NetworkError
36
- if (error.message.includes('NetworkError: Failed to fetch')) {
37
- consoleErrors.push(error.message);
38
- return; // Swallow this specific error
39
- }
40
- // Rethrow all other errors (catch regressions!)
41
- throw error;
42
- });
43
-
44
- // Arrange: Mock 500 error response
45
- await page.route('**/api/users', (route) =>
46
- route.fulfill({
47
- status: 500,
48
- contentType: 'application/json',
49
- body: JSON.stringify({
50
- error: 'Internal server error',
51
- code: 'INTERNAL_ERROR',
52
- }),
53
- }),
54
- );
55
-
56
- // Act: Navigate to page that fetches users
57
- await page.goto('/dashboard');
58
-
59
- // Assert: Error UI displayed
60
- await expect(page.getByTestId('error-message')).toBeVisible();
61
- await expect(page.getByTestId('error-message')).toContainText(/error.*loading|failed.*load/i);
62
-
63
- // Assert: Retry button visible
64
- await expect(page.getByTestId('retry-button')).toBeVisible();
65
-
66
- // Assert: NetworkError was thrown and caught
67
- expect(consoleErrors).toContainEqual(expect.stringContaining('NetworkError'));
68
- });
69
-
70
- test('should NOT swallow unexpected errors', async ({ page }) => {
71
- let unexpectedError: Error | null = null;
72
-
73
- page.on('pageerror', (error) => {
74
- // Capture but don't swallow - test should fail
75
- unexpectedError = error;
76
- throw error;
77
- });
78
-
79
- // Arrange: App has JavaScript error (bug)
80
- await page.addInitScript(() => {
81
- // Simulate bug in app code
82
- (window as any).buggyFunction = () => {
83
- throw new Error('UNEXPECTED BUG: undefined is not a function');
84
- };
85
- });
86
-
87
- await page.goto('/dashboard');
88
-
89
- // Trigger buggy function
90
- await page.evaluate(() => (window as any).buggyFunction());
91
-
92
- // Assert: Test fails because unexpected error was NOT swallowed
93
- expect(unexpectedError).not.toBeNull();
94
- expect(unexpectedError?.message).toContain('UNEXPECTED BUG');
95
- });
96
- });
97
- ```
98
-
99
- **Cypress equivalent**:
100
-
101
- ```javascript
102
- // cypress/e2e/error-handling.cy.ts
103
- describe('API Error Handling', () => {
104
- it('should display error message when API returns 500', () => {
105
- // Scoped to this test only
106
- cy.on('uncaught:exception', (err) => {
107
- // Only swallow documented NetworkError
108
- if (err.message.includes('NetworkError')) {
109
- return false; // Prevent test failure
110
- }
111
- // All other errors fail the test
112
- return true;
113
- });
114
-
115
- // Arrange: Mock 500 error
116
- cy.intercept('GET', '**/api/users', {
117
- statusCode: 500,
118
- body: {
119
- error: 'Internal server error',
120
- code: 'INTERNAL_ERROR',
121
- },
122
- }).as('getUsers');
123
-
124
- // Act
125
- cy.visit('/dashboard');
126
- cy.wait('@getUsers');
127
-
128
- // Assert: Error UI
129
- cy.get('[data-cy="error-message"]').should('be.visible');
130
- cy.get('[data-cy="error-message"]').should('contain', 'error loading');
131
- cy.get('[data-cy="retry-button"]').should('be.visible');
132
- });
133
-
134
- it('should NOT swallow unexpected errors', () => {
135
- // No exception handler - test should fail on unexpected errors
136
-
137
- cy.visit('/dashboard');
138
-
139
- // Trigger unexpected error
140
- cy.window().then((win) => {
141
- // This should fail the test
142
- win.eval('throw new Error("UNEXPECTED BUG")');
143
- });
144
-
145
- // Test fails (as expected) - validates error detection works
146
- });
147
- });
148
- ```
149
-
150
- **Key Points**:
151
-
152
- - **Scoped handling**: page.on() / cy.on() scoped to specific tests
153
- - **Explicit allow-list**: Only ignore documented errors
154
- - **Rethrow unexpected**: Catch regressions by failing on unknown errors
155
- - **Error UI validation**: Assert user sees error message
156
- - **Logging**: Capture errors for debugging, don't swallow silently
157
-
158
- ---
159
-
160
- ### Example 2: Retry Validation Pattern (Network Resilience)
161
-
162
- **Context**: Test that retry/backoff logic works correctly for transient failures.
163
-
164
- **Implementation**:
165
-
166
- ```typescript
167
- // tests/e2e/retry-resilience.spec.ts
168
- import { test, expect } from '@playwright/test';
169
-
170
- /**
171
- * Retry Validation Pattern
172
- * - Force sequential failures (500 → 500 → 200)
173
- * - Validate retry attempts and backoff timing
174
- * - Assert telemetry captures retry events
175
- */
176
-
177
- test.describe('Network Retry Logic', () => {
178
- test('should retry on 500 error and succeed', async ({ page }) => {
179
- let attemptCount = 0;
180
- const attemptTimestamps: number[] = [];
181
-
182
- // Mock API: Fail twice, succeed on third attempt
183
- await page.route('**/api/products', (route) => {
184
- attemptCount++;
185
- attemptTimestamps.push(Date.now());
186
-
187
- if (attemptCount <= 2) {
188
- // First 2 attempts: 500 error
189
- route.fulfill({
190
- status: 500,
191
- body: JSON.stringify({ error: 'Server error' }),
192
- });
193
- } else {
194
- // 3rd attempt: Success
195
- route.fulfill({
196
- status: 200,
197
- contentType: 'application/json',
198
- body: JSON.stringify({ products: [{ id: 1, name: 'Product 1' }] }),
199
- });
200
- }
201
- });
202
-
203
- // Act: Navigate (should retry automatically)
204
- await page.goto('/products');
205
-
206
- // Assert: Data eventually loads after retries
207
- await expect(page.getByTestId('product-list')).toBeVisible();
208
- await expect(page.getByTestId('product-item')).toHaveCount(1);
209
-
210
- // Assert: Exactly 3 attempts made
211
- expect(attemptCount).toBe(3);
212
-
213
- // Assert: Exponential backoff timing (1s → 2s between attempts)
214
- if (attemptTimestamps.length === 3) {
215
- const delay1 = attemptTimestamps[1] - attemptTimestamps[0];
216
- const delay2 = attemptTimestamps[2] - attemptTimestamps[1];
217
-
218
- expect(delay1).toBeGreaterThanOrEqual(900); // ~1 second
219
- expect(delay1).toBeLessThan(1200);
220
- expect(delay2).toBeGreaterThanOrEqual(1900); // ~2 seconds
221
- expect(delay2).toBeLessThan(2200);
222
- }
223
-
224
- // Assert: Telemetry logged retry events
225
- const telemetryEvents = await page.evaluate(() => (window as any).__TELEMETRY_EVENTS__ || []);
226
- expect(telemetryEvents).toContainEqual(
227
- expect.objectContaining({
228
- event: 'api_retry',
229
- attempt: 1,
230
- endpoint: '/api/products',
231
- }),
232
- );
233
- expect(telemetryEvents).toContainEqual(
234
- expect.objectContaining({
235
- event: 'api_retry',
236
- attempt: 2,
237
- }),
238
- );
239
- });
240
-
241
- test('should give up after max retries and show error', async ({ page }) => {
242
- let attemptCount = 0;
243
-
244
- // Mock API: Always fail (test retry limit)
245
- await page.route('**/api/products', (route) => {
246
- attemptCount++;
247
- route.fulfill({
248
- status: 500,
249
- body: JSON.stringify({ error: 'Persistent server error' }),
250
- });
251
- });
252
-
253
- // Act
254
- await page.goto('/products');
255
-
256
- // Assert: Max retries reached (3 attempts typical)
257
- expect(attemptCount).toBe(3);
258
-
259
- // Assert: Error UI displayed after exhausting retries
260
- await expect(page.getByTestId('error-message')).toBeVisible();
261
- await expect(page.getByTestId('error-message')).toContainText(/unable.*load|failed.*after.*retries/i);
262
-
263
- // Assert: Data not displayed
264
- await expect(page.getByTestId('product-list')).not.toBeVisible();
265
- });
266
-
267
- test('should NOT retry on 404 (non-retryable error)', async ({ page }) => {
268
- let attemptCount = 0;
269
-
270
- // Mock API: 404 error (should NOT retry)
271
- await page.route('**/api/products/999', (route) => {
272
- attemptCount++;
273
- route.fulfill({
274
- status: 404,
275
- body: JSON.stringify({ error: 'Product not found' }),
276
- });
277
- });
278
-
279
- await page.goto('/products/999');
280
-
281
- // Assert: Only 1 attempt (no retries on 404)
282
- expect(attemptCount).toBe(1);
283
-
284
- // Assert: 404 error displayed immediately
285
- await expect(page.getByTestId('not-found-message')).toBeVisible();
286
- });
287
- });
288
- ```
289
-
290
- **Cypress with retry interception**:
291
-
292
- ```javascript
293
- // cypress/e2e/retry-resilience.cy.ts
294
- describe('Network Retry Logic', () => {
295
- it('should retry on 500 and succeed on 3rd attempt', () => {
296
- let attemptCount = 0;
297
-
298
- cy.intercept('GET', '**/api/products', (req) => {
299
- attemptCount++;
300
-
301
- if (attemptCount <= 2) {
302
- req.reply({ statusCode: 500, body: { error: 'Server error' } });
303
- } else {
304
- req.reply({ statusCode: 200, body: { products: [{ id: 1, name: 'Product 1' }] } });
305
- }
306
- }).as('getProducts');
307
-
308
- cy.visit('/products');
309
-
310
- // Wait for final successful request
311
- cy.wait('@getProducts').its('response.statusCode').should('eq', 200);
312
-
313
- // Assert: Data loaded
314
- cy.get('[data-cy="product-list"]').should('be.visible');
315
- cy.get('[data-cy="product-item"]').should('have.length', 1);
316
-
317
- // Validate retry count
318
- cy.wrap(attemptCount).should('eq', 3);
319
- });
320
- });
321
- ```
322
-
323
- **Key Points**:
324
-
325
- - **Sequential failures**: Test retry logic with 500 → 500 → 200
326
- - **Backoff timing**: Validate exponential backoff delays
327
- - **Retry limits**: Max attempts enforced (typically 3)
328
- - **Non-retryable errors**: 404s don't trigger retries
329
- - **Telemetry**: Log retry attempts for monitoring
330
-
331
- ---
332
-
333
- ### Example 3: Telemetry Logging with Context (Sentry Integration)
334
-
335
- **Context**: Capture errors with full context for production debugging without exposing secrets.
336
-
337
- **Implementation**:
338
-
339
- ```typescript
340
- // tests/e2e/telemetry-logging.spec.ts
341
- import { test, expect } from '@playwright/test';
342
-
343
- /**
344
- * Telemetry Logging Pattern
345
- * - Log errors with request context
346
- * - Redact sensitive data (tokens, passwords, PII)
347
- * - Integrate with monitoring (Sentry, Datadog)
348
- * - Validate error logging without exposing secrets
349
- */
350
-
351
- type ErrorLog = {
352
- level: 'error' | 'warn' | 'info';
353
- message: string;
354
- context?: {
355
- endpoint?: string;
356
- method?: string;
357
- statusCode?: number;
358
- userId?: string;
359
- sessionId?: string;
360
- };
361
- timestamp: string;
362
- };
363
-
364
- test.describe('Error Telemetry', () => {
365
- test('should log API errors with context', async ({ page }) => {
366
- const errorLogs: ErrorLog[] = [];
367
-
368
- // Capture console errors
369
- page.on('console', (msg) => {
370
- if (msg.type() === 'error') {
371
- try {
372
- const log = JSON.parse(msg.text());
373
- errorLogs.push(log);
374
- } catch {
375
- // Not a structured log, ignore
376
- }
377
- }
378
- });
379
-
380
- // Mock failing API
381
- await page.route('**/api/orders', (route) =>
382
- route.fulfill({
383
- status: 500,
384
- body: JSON.stringify({ error: 'Payment processor unavailable' }),
385
- }),
386
- );
387
-
388
- // Act: Trigger error
389
- await page.goto('/checkout');
390
- await page.getByTestId('place-order').click();
391
-
392
- // Wait for error UI
393
- await expect(page.getByTestId('error-message')).toBeVisible();
394
-
395
- // Assert: Error logged with context
396
- expect(errorLogs).toContainEqual(
397
- expect.objectContaining({
398
- level: 'error',
399
- message: expect.stringContaining('API request failed'),
400
- context: expect.objectContaining({
401
- endpoint: '/api/orders',
402
- method: 'POST',
403
- statusCode: 500,
404
- userId: expect.any(String),
405
- }),
406
- }),
407
- );
408
-
409
- // Assert: Sensitive data NOT logged
410
- const logString = JSON.stringify(errorLogs);
411
- expect(logString).not.toContain('password');
412
- expect(logString).not.toContain('token');
413
- expect(logString).not.toContain('creditCard');
414
- });
415
-
416
- test('should send errors to Sentry with breadcrumbs', async ({ page }) => {
417
- const sentryEvents: any[] = [];
418
-
419
- // Mock Sentry SDK
420
- await page.addInitScript(() => {
421
- (window as any).Sentry = {
422
- captureException: (error: Error, context?: any) => {
423
- (window as any).__SENTRY_EVENTS__ = (window as any).__SENTRY_EVENTS__ || [];
424
- (window as any).__SENTRY_EVENTS__.push({
425
- error: error.message,
426
- context,
427
- timestamp: Date.now(),
428
- });
429
- },
430
- addBreadcrumb: (breadcrumb: any) => {
431
- (window as any).__SENTRY_BREADCRUMBS__ = (window as any).__SENTRY_BREADCRUMBS__ || [];
432
- (window as any).__SENTRY_BREADCRUMBS__.push(breadcrumb);
433
- },
434
- };
435
- });
436
-
437
- // Mock failing API
438
- await page.route('**/api/users', (route) => route.fulfill({ status: 403, body: { error: 'Forbidden' } }));
439
-
440
- // Act
441
- await page.goto('/users');
442
-
443
- // Assert: Sentry captured error
444
- const events = await page.evaluate(() => (window as any).__SENTRY_EVENTS__);
445
- expect(events).toHaveLength(1);
446
- expect(events[0]).toMatchObject({
447
- error: expect.stringContaining('403'),
448
- context: expect.objectContaining({
449
- endpoint: '/api/users',
450
- statusCode: 403,
451
- }),
452
- });
453
-
454
- // Assert: Breadcrumbs include user actions
455
- const breadcrumbs = await page.evaluate(() => (window as any).__SENTRY_BREADCRUMBS__);
456
- expect(breadcrumbs).toContainEqual(
457
- expect.objectContaining({
458
- category: 'navigation',
459
- message: '/users',
460
- }),
461
- );
462
- });
463
- });
464
- ```
465
-
466
- **Cypress with Sentry**:
467
-
468
- ```javascript
469
- // cypress/e2e/telemetry-logging.cy.ts
470
- describe('Error Telemetry', () => {
471
- it('should log API errors with redacted sensitive data', () => {
472
- const errorLogs = [];
473
-
474
- // Capture console errors
475
- cy.on('window:before:load', (win) => {
476
- cy.stub(win.console, 'error').callsFake((msg) => {
477
- errorLogs.push(msg);
478
- });
479
- });
480
-
481
- // Mock failing API
482
- cy.intercept('POST', '**/api/orders', {
483
- statusCode: 500,
484
- body: { error: 'Payment failed' },
485
- });
486
-
487
- // Act
488
- cy.visit('/checkout');
489
- cy.get('[data-cy="place-order"]').click();
490
-
491
- // Assert: Error logged
492
- cy.wrap(errorLogs).should('have.length.greaterThan', 0);
493
-
494
- // Assert: Context included
495
- cy.wrap(errorLogs[0]).should('include', '/api/orders');
496
-
497
- // Assert: Secrets redacted
498
- cy.wrap(JSON.stringify(errorLogs)).should('not.contain', 'password');
499
- cy.wrap(JSON.stringify(errorLogs)).should('not.contain', 'creditCard');
500
- });
501
- });
502
- ```
503
-
504
- **Error logger utility with redaction**:
505
-
506
- ```typescript
507
- // src/utils/error-logger.ts
508
- type ErrorContext = {
509
- endpoint?: string;
510
- method?: string;
511
- statusCode?: number;
512
- userId?: string;
513
- sessionId?: string;
514
- requestPayload?: any;
515
- };
516
-
517
- const SENSITIVE_KEYS = ['password', 'token', 'creditCard', 'ssn', 'apiKey'];
518
-
519
- /**
520
- * Redact sensitive data from objects
521
- */
522
- function redactSensitiveData(obj: any): any {
523
- if (typeof obj !== 'object' || obj === null) return obj;
524
-
525
- const redacted = { ...obj };
526
-
527
- for (const key of Object.keys(redacted)) {
528
- if (SENSITIVE_KEYS.some((sensitive) => key.toLowerCase().includes(sensitive))) {
529
- redacted[key] = '[REDACTED]';
530
- } else if (typeof redacted[key] === 'object') {
531
- redacted[key] = redactSensitiveData(redacted[key]);
532
- }
533
- }
534
-
535
- return redacted;
536
- }
537
-
538
- /**
539
- * Log error with context (Sentry integration)
540
- */
541
- export function logError(error: Error, context?: ErrorContext) {
542
- const safeContext = context ? redactSensitiveData(context) : {};
543
-
544
- const errorLog = {
545
- level: 'error' as const,
546
- message: error.message,
547
- stack: error.stack,
548
- context: safeContext,
549
- timestamp: new Date().toISOString(),
550
- };
551
-
552
- // Console (development)
553
- console.error(JSON.stringify(errorLog));
554
-
555
- // Sentry (production)
556
- if (typeof window !== 'undefined' && (window as any).Sentry) {
557
- (window as any).Sentry.captureException(error, {
558
- contexts: { custom: safeContext },
559
- });
560
- }
561
- }
562
- ```
563
-
564
- **Key Points**:
565
-
566
- - **Context-rich logging**: Endpoint, method, status, user ID
567
- - **Secret redaction**: Passwords, tokens, PII removed before logging
568
- - **Sentry integration**: Production monitoring with breadcrumbs
569
- - **Structured logs**: JSON format for easy parsing
570
- - **Test validation**: Assert logs contain context but not secrets
571
-
572
- ---
573
-
574
- ### Example 4: Graceful Degradation Tests (Fallback Behavior)
575
-
576
- **Context**: Validate application continues functioning when services are unavailable.
577
-
578
- **Implementation**:
579
-
580
- ```typescript
581
- // tests/e2e/graceful-degradation.spec.ts
582
- import { test, expect } from '@playwright/test';
583
-
584
- /**
585
- * Graceful Degradation Pattern
586
- * - Simulate service unavailability
587
- * - Validate fallback behavior
588
- * - Ensure user experience degrades gracefully
589
- * - Verify telemetry captures degradation events
590
- */
591
-
592
- test.describe('Service Unavailability', () => {
593
- test('should display cached data when API is down', async ({ page }) => {
594
- // Arrange: Seed localStorage with cached data
595
- await page.addInitScript(() => {
596
- localStorage.setItem(
597
- 'products_cache',
598
- JSON.stringify({
599
- data: [
600
- { id: 1, name: 'Cached Product 1' },
601
- { id: 2, name: 'Cached Product 2' },
602
- ],
603
- timestamp: Date.now(),
604
- }),
605
- );
606
- });
607
-
608
- // Mock API unavailable
609
- await page.route(
610
- '**/api/products',
611
- (route) => route.abort('connectionrefused'), // Simulate server down
612
- );
613
-
614
- // Act
615
- await page.goto('/products');
616
-
617
- // Assert: Cached data displayed
618
- await expect(page.getByTestId('product-list')).toBeVisible();
619
- await expect(page.getByText('Cached Product 1')).toBeVisible();
620
-
621
- // Assert: Stale data warning shown
622
- await expect(page.getByTestId('cache-warning')).toBeVisible();
623
- await expect(page.getByTestId('cache-warning')).toContainText(/showing.*cached|offline.*mode/i);
624
-
625
- // Assert: Retry button available
626
- await expect(page.getByTestId('refresh-button')).toBeVisible();
627
- });
628
-
629
- test('should show fallback UI when analytics service fails', async ({ page }) => {
630
- // Mock analytics service down (non-critical)
631
- await page.route('**/analytics/track', (route) => route.fulfill({ status: 503, body: 'Service unavailable' }));
632
-
633
- // Act: Navigate normally
634
- await page.goto('/dashboard');
635
-
636
- // Assert: Page loads successfully (analytics failure doesn't block)
637
- await expect(page.getByTestId('dashboard-content')).toBeVisible();
638
-
639
- // Assert: Analytics error logged but not shown to user
640
- const consoleErrors = [];
641
- page.on('console', (msg) => {
642
- if (msg.type() === 'error') consoleErrors.push(msg.text());
643
- });
644
-
645
- // Trigger analytics event
646
- await page.getByTestId('track-action-button').click();
647
-
648
- // Analytics error logged
649
- expect(consoleErrors).toContainEqual(expect.stringContaining('Analytics service unavailable'));
650
-
651
- // But user doesn't see error
652
- await expect(page.getByTestId('error-message')).not.toBeVisible();
653
- });
654
-
655
- test('should fallback to local validation when API is slow', async ({ page }) => {
656
- // Mock slow API (> 5 seconds)
657
- await page.route('**/api/validate-email', async (route) => {
658
- await new Promise((resolve) => setTimeout(resolve, 6000)); // 6 second delay
659
- route.fulfill({
660
- status: 200,
661
- body: JSON.stringify({ valid: true }),
662
- });
663
- });
664
-
665
- // Act: Fill form
666
- await page.goto('/signup');
667
- await page.getByTestId('email-input').fill('test@example.com');
668
- await page.getByTestId('email-input').blur();
669
-
670
- // Assert: Client-side validation triggers immediately (doesn't wait for API)
671
- await expect(page.getByTestId('email-valid-icon')).toBeVisible({ timeout: 1000 });
672
-
673
- // Assert: Eventually API validates too (but doesn't block UX)
674
- await expect(page.getByTestId('email-validated-badge')).toBeVisible({ timeout: 7000 });
675
- });
676
-
677
- test('should maintain functionality with third-party script failure', async ({ page }) => {
678
- // Block third-party scripts (Google Analytics, Intercom, etc.)
679
- await page.route('**/*.google-analytics.com/**', (route) => route.abort());
680
- await page.route('**/*.intercom.io/**', (route) => route.abort());
681
-
682
- // Act
683
- await page.goto('/');
684
-
685
- // Assert: App works without third-party scripts
686
- await expect(page.getByTestId('main-content')).toBeVisible();
687
- await expect(page.getByTestId('nav-menu')).toBeVisible();
688
-
689
- // Assert: Core functionality intact
690
- await page.getByTestId('nav-products').click();
691
- await expect(page).toHaveURL(/.*\/products/);
692
- });
693
- });
694
- ```
695
-
696
- **Key Points**:
697
-
698
- - **Cached fallbacks**: Display stale data when API unavailable
699
- - **Non-critical degradation**: Analytics failures don't block app
700
- - **Client-side fallbacks**: Local validation when API slow
701
- - **Third-party resilience**: App works without external scripts
702
- - **User transparency**: Stale data warnings displayed
703
-
704
- ---
705
-
706
- ## Error Handling Testing Checklist
707
-
708
- Before shipping error handling code, verify:
709
-
710
- - [ ] **Scoped exception handling**: Only ignore documented errors (NetworkError, specific codes)
711
- - [ ] **Rethrow unexpected**: Unknown errors fail tests (catch regressions)
712
- - [ ] **Error UI tested**: User sees error messages for all error states
713
- - [ ] **Retry logic validated**: Sequential failures test backoff and max attempts
714
- - [ ] **Telemetry verified**: Errors logged with context (endpoint, status, user)
715
- - [ ] **Secret redaction**: Logs don't contain passwords, tokens, PII
716
- - [ ] **Graceful degradation**: Critical services down, app shows fallback UI
717
- - [ ] **Non-critical failures**: Analytics/tracking failures don't block app
718
-
719
- ## Integration Points
720
-
721
- - Used in workflows: `*automate` (error handling test generation), `*test-review` (error pattern detection)
722
- - Related fragments: `network-first.md`, `test-quality.md`, `contract-testing.md`
723
- - Monitoring tools: Sentry, Datadog, LogRocket
724
-
725
- _Source: Murat error-handling patterns, Pact resilience guidance, SEON production error handling_
1
+ # Error Handling and Resilience Checks
2
+
3
+ ## Principle
4
+
5
+ Treat expected failures explicitly: intercept network errors, assert UI fallbacks (error messages visible, retries triggered), and use scoped exception handling to ignore known errors while catching regressions. Test retry/backoff logic by forcing sequential failures (500 → timeout → success) and validate telemetry logging. Log captured errors with context (request payload, user/session) but redact secrets to keep artifacts safe for sharing.
6
+
7
+ ## Rationale
8
+
9
+ Tests fail for two reasons: genuine bugs or poor error handling in the test itself. Without explicit error handling patterns, tests become noisy (uncaught exceptions cause false failures) or silent (swallowing all errors hides real bugs). Scoped exception handling (Cypress.on('uncaught:exception'), page.on('pageerror')) allows tests to ignore documented, expected errors while surfacing unexpected ones. Resilience testing (retry logic, graceful degradation) ensures applications handle failures gracefully in production.
10
+
11
+ ## Pattern Examples
12
+
13
+ ### Example 1: Scoped Exception Handling (Expected Errors Only)
14
+
15
+ **Context**: Handle known errors (Network failures, expected 500s) without masking unexpected bugs.
16
+
17
+ **Implementation**:
18
+
19
+ ```typescript
20
+ // tests/e2e/error-handling.spec.ts
21
+ import { test, expect } from '@playwright/test';
22
+
23
+ /**
24
+ * Scoped Error Handling Pattern
25
+ * - Only ignore specific, documented errors
26
+ * - Rethrow everything else to catch regressions
27
+ * - Validate error UI and user experience
28
+ */
29
+
30
+ test.describe('API Error Handling', () => {
31
+ test('should display error message when API returns 500', async ({ page }) => {
32
+ // Scope error handling to THIS test only
33
+ const consoleErrors: string[] = [];
34
+ page.on('pageerror', (error) => {
35
+ // Only swallow documented NetworkError
36
+ if (error.message.includes('NetworkError: Failed to fetch')) {
37
+ consoleErrors.push(error.message);
38
+ return; // Swallow this specific error
39
+ }
40
+ // Rethrow all other errors (catch regressions!)
41
+ throw error;
42
+ });
43
+
44
+ // Arrange: Mock 500 error response
45
+ await page.route('**/api/users', (route) =>
46
+ route.fulfill({
47
+ status: 500,
48
+ contentType: 'application/json',
49
+ body: JSON.stringify({
50
+ error: 'Internal server error',
51
+ code: 'INTERNAL_ERROR',
52
+ }),
53
+ }),
54
+ );
55
+
56
+ // Act: Navigate to page that fetches users
57
+ await page.goto('/dashboard');
58
+
59
+ // Assert: Error UI displayed
60
+ await expect(page.getByTestId('error-message')).toBeVisible();
61
+ await expect(page.getByTestId('error-message')).toContainText(/error.*loading|failed.*load/i);
62
+
63
+ // Assert: Retry button visible
64
+ await expect(page.getByTestId('retry-button')).toBeVisible();
65
+
66
+ // Assert: NetworkError was thrown and caught
67
+ expect(consoleErrors).toContainEqual(expect.stringContaining('NetworkError'));
68
+ });
69
+
70
+ test('should NOT swallow unexpected errors', async ({ page }) => {
71
+ let unexpectedError: Error | null = null;
72
+
73
+ page.on('pageerror', (error) => {
74
+ // Capture but don't swallow - test should fail
75
+ unexpectedError = error;
76
+ throw error;
77
+ });
78
+
79
+ // Arrange: App has JavaScript error (bug)
80
+ await page.addInitScript(() => {
81
+ // Simulate bug in app code
82
+ (window as any).buggyFunction = () => {
83
+ throw new Error('UNEXPECTED BUG: undefined is not a function');
84
+ };
85
+ });
86
+
87
+ await page.goto('/dashboard');
88
+
89
+ // Trigger buggy function
90
+ await page.evaluate(() => (window as any).buggyFunction());
91
+
92
+ // Assert: Test fails because unexpected error was NOT swallowed
93
+ expect(unexpectedError).not.toBeNull();
94
+ expect(unexpectedError?.message).toContain('UNEXPECTED BUG');
95
+ });
96
+ });
97
+ ```
98
+
99
+ **Cypress equivalent**:
100
+
101
+ ```javascript
102
+ // cypress/e2e/error-handling.cy.ts
103
+ describe('API Error Handling', () => {
104
+ it('should display error message when API returns 500', () => {
105
+ // Scoped to this test only
106
+ cy.on('uncaught:exception', (err) => {
107
+ // Only swallow documented NetworkError
108
+ if (err.message.includes('NetworkError')) {
109
+ return false; // Prevent test failure
110
+ }
111
+ // All other errors fail the test
112
+ return true;
113
+ });
114
+
115
+ // Arrange: Mock 500 error
116
+ cy.intercept('GET', '**/api/users', {
117
+ statusCode: 500,
118
+ body: {
119
+ error: 'Internal server error',
120
+ code: 'INTERNAL_ERROR',
121
+ },
122
+ }).as('getUsers');
123
+
124
+ // Act
125
+ cy.visit('/dashboard');
126
+ cy.wait('@getUsers');
127
+
128
+ // Assert: Error UI
129
+ cy.get('[data-cy="error-message"]').should('be.visible');
130
+ cy.get('[data-cy="error-message"]').should('contain', 'error loading');
131
+ cy.get('[data-cy="retry-button"]').should('be.visible');
132
+ });
133
+
134
+ it('should NOT swallow unexpected errors', () => {
135
+ // No exception handler - test should fail on unexpected errors
136
+
137
+ cy.visit('/dashboard');
138
+
139
+ // Trigger unexpected error
140
+ cy.window().then((win) => {
141
+ // This should fail the test
142
+ win.eval('throw new Error("UNEXPECTED BUG")');
143
+ });
144
+
145
+ // Test fails (as expected) - validates error detection works
146
+ });
147
+ });
148
+ ```
149
+
150
+ **Key Points**:
151
+
152
+ - **Scoped handling**: page.on() / cy.on() scoped to specific tests
153
+ - **Explicit allow-list**: Only ignore documented errors
154
+ - **Rethrow unexpected**: Catch regressions by failing on unknown errors
155
+ - **Error UI validation**: Assert user sees error message
156
+ - **Logging**: Capture errors for debugging, don't swallow silently
157
+
158
+ ---
159
+
160
+ ### Example 2: Retry Validation Pattern (Network Resilience)
161
+
162
+ **Context**: Test that retry/backoff logic works correctly for transient failures.
163
+
164
+ **Implementation**:
165
+
166
+ ```typescript
167
+ // tests/e2e/retry-resilience.spec.ts
168
+ import { test, expect } from '@playwright/test';
169
+
170
+ /**
171
+ * Retry Validation Pattern
172
+ * - Force sequential failures (500 → 500 → 200)
173
+ * - Validate retry attempts and backoff timing
174
+ * - Assert telemetry captures retry events
175
+ */
176
+
177
+ test.describe('Network Retry Logic', () => {
178
+ test('should retry on 500 error and succeed', async ({ page }) => {
179
+ let attemptCount = 0;
180
+ const attemptTimestamps: number[] = [];
181
+
182
+ // Mock API: Fail twice, succeed on third attempt
183
+ await page.route('**/api/products', (route) => {
184
+ attemptCount++;
185
+ attemptTimestamps.push(Date.now());
186
+
187
+ if (attemptCount <= 2) {
188
+ // First 2 attempts: 500 error
189
+ route.fulfill({
190
+ status: 500,
191
+ body: JSON.stringify({ error: 'Server error' }),
192
+ });
193
+ } else {
194
+ // 3rd attempt: Success
195
+ route.fulfill({
196
+ status: 200,
197
+ contentType: 'application/json',
198
+ body: JSON.stringify({ products: [{ id: 1, name: 'Product 1' }] }),
199
+ });
200
+ }
201
+ });
202
+
203
+ // Act: Navigate (should retry automatically)
204
+ await page.goto('/products');
205
+
206
+ // Assert: Data eventually loads after retries
207
+ await expect(page.getByTestId('product-list')).toBeVisible();
208
+ await expect(page.getByTestId('product-item')).toHaveCount(1);
209
+
210
+ // Assert: Exactly 3 attempts made
211
+ expect(attemptCount).toBe(3);
212
+
213
+ // Assert: Exponential backoff timing (1s → 2s between attempts)
214
+ if (attemptTimestamps.length === 3) {
215
+ const delay1 = attemptTimestamps[1] - attemptTimestamps[0];
216
+ const delay2 = attemptTimestamps[2] - attemptTimestamps[1];
217
+
218
+ expect(delay1).toBeGreaterThanOrEqual(900); // ~1 second
219
+ expect(delay1).toBeLessThan(1200);
220
+ expect(delay2).toBeGreaterThanOrEqual(1900); // ~2 seconds
221
+ expect(delay2).toBeLessThan(2200);
222
+ }
223
+
224
+ // Assert: Telemetry logged retry events
225
+ const telemetryEvents = await page.evaluate(() => (window as any).__TELEMETRY_EVENTS__ || []);
226
+ expect(telemetryEvents).toContainEqual(
227
+ expect.objectContaining({
228
+ event: 'api_retry',
229
+ attempt: 1,
230
+ endpoint: '/api/products',
231
+ }),
232
+ );
233
+ expect(telemetryEvents).toContainEqual(
234
+ expect.objectContaining({
235
+ event: 'api_retry',
236
+ attempt: 2,
237
+ }),
238
+ );
239
+ });
240
+
241
+ test('should give up after max retries and show error', async ({ page }) => {
242
+ let attemptCount = 0;
243
+
244
+ // Mock API: Always fail (test retry limit)
245
+ await page.route('**/api/products', (route) => {
246
+ attemptCount++;
247
+ route.fulfill({
248
+ status: 500,
249
+ body: JSON.stringify({ error: 'Persistent server error' }),
250
+ });
251
+ });
252
+
253
+ // Act
254
+ await page.goto('/products');
255
+
256
+ // Assert: Max retries reached (3 attempts typical)
257
+ expect(attemptCount).toBe(3);
258
+
259
+ // Assert: Error UI displayed after exhausting retries
260
+ await expect(page.getByTestId('error-message')).toBeVisible();
261
+ await expect(page.getByTestId('error-message')).toContainText(/unable.*load|failed.*after.*retries/i);
262
+
263
+ // Assert: Data not displayed
264
+ await expect(page.getByTestId('product-list')).not.toBeVisible();
265
+ });
266
+
267
+ test('should NOT retry on 404 (non-retryable error)', async ({ page }) => {
268
+ let attemptCount = 0;
269
+
270
+ // Mock API: 404 error (should NOT retry)
271
+ await page.route('**/api/products/999', (route) => {
272
+ attemptCount++;
273
+ route.fulfill({
274
+ status: 404,
275
+ body: JSON.stringify({ error: 'Product not found' }),
276
+ });
277
+ });
278
+
279
+ await page.goto('/products/999');
280
+
281
+ // Assert: Only 1 attempt (no retries on 404)
282
+ expect(attemptCount).toBe(1);
283
+
284
+ // Assert: 404 error displayed immediately
285
+ await expect(page.getByTestId('not-found-message')).toBeVisible();
286
+ });
287
+ });
288
+ ```
289
+
290
+ **Cypress with retry interception**:
291
+
292
+ ```javascript
293
+ // cypress/e2e/retry-resilience.cy.ts
294
+ describe('Network Retry Logic', () => {
295
+ it('should retry on 500 and succeed on 3rd attempt', () => {
296
+ let attemptCount = 0;
297
+
298
+ cy.intercept('GET', '**/api/products', (req) => {
299
+ attemptCount++;
300
+
301
+ if (attemptCount <= 2) {
302
+ req.reply({ statusCode: 500, body: { error: 'Server error' } });
303
+ } else {
304
+ req.reply({ statusCode: 200, body: { products: [{ id: 1, name: 'Product 1' }] } });
305
+ }
306
+ }).as('getProducts');
307
+
308
+ cy.visit('/products');
309
+
310
+ // Wait for final successful request
311
+ cy.wait('@getProducts').its('response.statusCode').should('eq', 200);
312
+
313
+ // Assert: Data loaded
314
+ cy.get('[data-cy="product-list"]').should('be.visible');
315
+ cy.get('[data-cy="product-item"]').should('have.length', 1);
316
+
317
+ // Validate retry count
318
+ cy.wrap(attemptCount).should('eq', 3);
319
+ });
320
+ });
321
+ ```
322
+
323
+ **Key Points**:
324
+
325
+ - **Sequential failures**: Test retry logic with 500 → 500 → 200
326
+ - **Backoff timing**: Validate exponential backoff delays
327
+ - **Retry limits**: Max attempts enforced (typically 3)
328
+ - **Non-retryable errors**: 404s don't trigger retries
329
+ - **Telemetry**: Log retry attempts for monitoring
330
+
331
+ ---
332
+
333
+ ### Example 3: Telemetry Logging with Context (Sentry Integration)
334
+
335
+ **Context**: Capture errors with full context for production debugging without exposing secrets.
336
+
337
+ **Implementation**:
338
+
339
+ ```typescript
340
+ // tests/e2e/telemetry-logging.spec.ts
341
+ import { test, expect } from '@playwright/test';
342
+
343
+ /**
344
+ * Telemetry Logging Pattern
345
+ * - Log errors with request context
346
+ * - Redact sensitive data (tokens, passwords, PII)
347
+ * - Integrate with monitoring (Sentry, Datadog)
348
+ * - Validate error logging without exposing secrets
349
+ */
350
+
351
+ type ErrorLog = {
352
+ level: 'error' | 'warn' | 'info';
353
+ message: string;
354
+ context?: {
355
+ endpoint?: string;
356
+ method?: string;
357
+ statusCode?: number;
358
+ userId?: string;
359
+ sessionId?: string;
360
+ };
361
+ timestamp: string;
362
+ };
363
+
364
+ test.describe('Error Telemetry', () => {
365
+ test('should log API errors with context', async ({ page }) => {
366
+ const errorLogs: ErrorLog[] = [];
367
+
368
+ // Capture console errors
369
+ page.on('console', (msg) => {
370
+ if (msg.type() === 'error') {
371
+ try {
372
+ const log = JSON.parse(msg.text());
373
+ errorLogs.push(log);
374
+ } catch {
375
+ // Not a structured log, ignore
376
+ }
377
+ }
378
+ });
379
+
380
+ // Mock failing API
381
+ await page.route('**/api/orders', (route) =>
382
+ route.fulfill({
383
+ status: 500,
384
+ body: JSON.stringify({ error: 'Payment processor unavailable' }),
385
+ }),
386
+ );
387
+
388
+ // Act: Trigger error
389
+ await page.goto('/checkout');
390
+ await page.getByTestId('place-order').click();
391
+
392
+ // Wait for error UI
393
+ await expect(page.getByTestId('error-message')).toBeVisible();
394
+
395
+ // Assert: Error logged with context
396
+ expect(errorLogs).toContainEqual(
397
+ expect.objectContaining({
398
+ level: 'error',
399
+ message: expect.stringContaining('API request failed'),
400
+ context: expect.objectContaining({
401
+ endpoint: '/api/orders',
402
+ method: 'POST',
403
+ statusCode: 500,
404
+ userId: expect.any(String),
405
+ }),
406
+ }),
407
+ );
408
+
409
+ // Assert: Sensitive data NOT logged
410
+ const logString = JSON.stringify(errorLogs);
411
+ expect(logString).not.toContain('password');
412
+ expect(logString).not.toContain('token');
413
+ expect(logString).not.toContain('creditCard');
414
+ });
415
+
416
+ test('should send errors to Sentry with breadcrumbs', async ({ page }) => {
417
+ const sentryEvents: any[] = [];
418
+
419
+ // Mock Sentry SDK
420
+ await page.addInitScript(() => {
421
+ (window as any).Sentry = {
422
+ captureException: (error: Error, context?: any) => {
423
+ (window as any).__SENTRY_EVENTS__ = (window as any).__SENTRY_EVENTS__ || [];
424
+ (window as any).__SENTRY_EVENTS__.push({
425
+ error: error.message,
426
+ context,
427
+ timestamp: Date.now(),
428
+ });
429
+ },
430
+ addBreadcrumb: (breadcrumb: any) => {
431
+ (window as any).__SENTRY_BREADCRUMBS__ = (window as any).__SENTRY_BREADCRUMBS__ || [];
432
+ (window as any).__SENTRY_BREADCRUMBS__.push(breadcrumb);
433
+ },
434
+ };
435
+ });
436
+
437
+ // Mock failing API
438
+ await page.route('**/api/users', (route) => route.fulfill({ status: 403, body: { error: 'Forbidden' } }));
439
+
440
+ // Act
441
+ await page.goto('/users');
442
+
443
+ // Assert: Sentry captured error
444
+ const events = await page.evaluate(() => (window as any).__SENTRY_EVENTS__);
445
+ expect(events).toHaveLength(1);
446
+ expect(events[0]).toMatchObject({
447
+ error: expect.stringContaining('403'),
448
+ context: expect.objectContaining({
449
+ endpoint: '/api/users',
450
+ statusCode: 403,
451
+ }),
452
+ });
453
+
454
+ // Assert: Breadcrumbs include user actions
455
+ const breadcrumbs = await page.evaluate(() => (window as any).__SENTRY_BREADCRUMBS__);
456
+ expect(breadcrumbs).toContainEqual(
457
+ expect.objectContaining({
458
+ category: 'navigation',
459
+ message: '/users',
460
+ }),
461
+ );
462
+ });
463
+ });
464
+ ```
465
+
466
+ **Cypress with Sentry**:
467
+
468
+ ```javascript
469
+ // cypress/e2e/telemetry-logging.cy.ts
470
+ describe('Error Telemetry', () => {
471
+ it('should log API errors with redacted sensitive data', () => {
472
+ const errorLogs = [];
473
+
474
+ // Capture console errors
475
+ cy.on('window:before:load', (win) => {
476
+ cy.stub(win.console, 'error').callsFake((msg) => {
477
+ errorLogs.push(msg);
478
+ });
479
+ });
480
+
481
+ // Mock failing API
482
+ cy.intercept('POST', '**/api/orders', {
483
+ statusCode: 500,
484
+ body: { error: 'Payment failed' },
485
+ });
486
+
487
+ // Act
488
+ cy.visit('/checkout');
489
+ cy.get('[data-cy="place-order"]').click();
490
+
491
+ // Assert: Error logged
492
+ cy.wrap(errorLogs).should('have.length.greaterThan', 0);
493
+
494
+ // Assert: Context included
495
+ cy.wrap(errorLogs[0]).should('include', '/api/orders');
496
+
497
+ // Assert: Secrets redacted
498
+ cy.wrap(JSON.stringify(errorLogs)).should('not.contain', 'password');
499
+ cy.wrap(JSON.stringify(errorLogs)).should('not.contain', 'creditCard');
500
+ });
501
+ });
502
+ ```
503
+
504
+ **Error logger utility with redaction**:
505
+
506
+ ```typescript
507
+ // src/utils/error-logger.ts
508
+ type ErrorContext = {
509
+ endpoint?: string;
510
+ method?: string;
511
+ statusCode?: number;
512
+ userId?: string;
513
+ sessionId?: string;
514
+ requestPayload?: any;
515
+ };
516
+
517
+ const SENSITIVE_KEYS = ['password', 'token', 'creditCard', 'ssn', 'apiKey'];
518
+
519
+ /**
520
+ * Redact sensitive data from objects
521
+ */
522
+ function redactSensitiveData(obj: any): any {
523
+ if (typeof obj !== 'object' || obj === null) return obj;
524
+
525
+ const redacted = { ...obj };
526
+
527
+ for (const key of Object.keys(redacted)) {
528
+ if (SENSITIVE_KEYS.some((sensitive) => key.toLowerCase().includes(sensitive))) {
529
+ redacted[key] = '[REDACTED]';
530
+ } else if (typeof redacted[key] === 'object') {
531
+ redacted[key] = redactSensitiveData(redacted[key]);
532
+ }
533
+ }
534
+
535
+ return redacted;
536
+ }
537
+
538
+ /**
539
+ * Log error with context (Sentry integration)
540
+ */
541
+ export function logError(error: Error, context?: ErrorContext) {
542
+ const safeContext = context ? redactSensitiveData(context) : {};
543
+
544
+ const errorLog = {
545
+ level: 'error' as const,
546
+ message: error.message,
547
+ stack: error.stack,
548
+ context: safeContext,
549
+ timestamp: new Date().toISOString(),
550
+ };
551
+
552
+ // Console (development)
553
+ console.error(JSON.stringify(errorLog));
554
+
555
+ // Sentry (production)
556
+ if (typeof window !== 'undefined' && (window as any).Sentry) {
557
+ (window as any).Sentry.captureException(error, {
558
+ contexts: { custom: safeContext },
559
+ });
560
+ }
561
+ }
562
+ ```
563
+
564
+ **Key Points**:
565
+
566
+ - **Context-rich logging**: Endpoint, method, status, user ID
567
+ - **Secret redaction**: Passwords, tokens, PII removed before logging
568
+ - **Sentry integration**: Production monitoring with breadcrumbs
569
+ - **Structured logs**: JSON format for easy parsing
570
+ - **Test validation**: Assert logs contain context but not secrets
571
+
572
+ ---
573
+
574
+ ### Example 4: Graceful Degradation Tests (Fallback Behavior)
575
+
576
+ **Context**: Validate application continues functioning when services are unavailable.
577
+
578
+ **Implementation**:
579
+
580
+ ```typescript
581
+ // tests/e2e/graceful-degradation.spec.ts
582
+ import { test, expect } from '@playwright/test';
583
+
584
+ /**
585
+ * Graceful Degradation Pattern
586
+ * - Simulate service unavailability
587
+ * - Validate fallback behavior
588
+ * - Ensure user experience degrades gracefully
589
+ * - Verify telemetry captures degradation events
590
+ */
591
+
592
+ test.describe('Service Unavailability', () => {
593
+ test('should display cached data when API is down', async ({ page }) => {
594
+ // Arrange: Seed localStorage with cached data
595
+ await page.addInitScript(() => {
596
+ localStorage.setItem(
597
+ 'products_cache',
598
+ JSON.stringify({
599
+ data: [
600
+ { id: 1, name: 'Cached Product 1' },
601
+ { id: 2, name: 'Cached Product 2' },
602
+ ],
603
+ timestamp: Date.now(),
604
+ }),
605
+ );
606
+ });
607
+
608
+ // Mock API unavailable
609
+ await page.route(
610
+ '**/api/products',
611
+ (route) => route.abort('connectionrefused'), // Simulate server down
612
+ );
613
+
614
+ // Act
615
+ await page.goto('/products');
616
+
617
+ // Assert: Cached data displayed
618
+ await expect(page.getByTestId('product-list')).toBeVisible();
619
+ await expect(page.getByText('Cached Product 1')).toBeVisible();
620
+
621
+ // Assert: Stale data warning shown
622
+ await expect(page.getByTestId('cache-warning')).toBeVisible();
623
+ await expect(page.getByTestId('cache-warning')).toContainText(/showing.*cached|offline.*mode/i);
624
+
625
+ // Assert: Retry button available
626
+ await expect(page.getByTestId('refresh-button')).toBeVisible();
627
+ });
628
+
629
+ test('should show fallback UI when analytics service fails', async ({ page }) => {
630
+ // Mock analytics service down (non-critical)
631
+ await page.route('**/analytics/track', (route) => route.fulfill({ status: 503, body: 'Service unavailable' }));
632
+
633
+ // Act: Navigate normally
634
+ await page.goto('/dashboard');
635
+
636
+ // Assert: Page loads successfully (analytics failure doesn't block)
637
+ await expect(page.getByTestId('dashboard-content')).toBeVisible();
638
+
639
+ // Assert: Analytics error logged but not shown to user
640
+ const consoleErrors = [];
641
+ page.on('console', (msg) => {
642
+ if (msg.type() === 'error') consoleErrors.push(msg.text());
643
+ });
644
+
645
+ // Trigger analytics event
646
+ await page.getByTestId('track-action-button').click();
647
+
648
+ // Analytics error logged
649
+ expect(consoleErrors).toContainEqual(expect.stringContaining('Analytics service unavailable'));
650
+
651
+ // But user doesn't see error
652
+ await expect(page.getByTestId('error-message')).not.toBeVisible();
653
+ });
654
+
655
+ test('should fallback to local validation when API is slow', async ({ page }) => {
656
+ // Mock slow API (> 5 seconds)
657
+ await page.route('**/api/validate-email', async (route) => {
658
+ await new Promise((resolve) => setTimeout(resolve, 6000)); // 6 second delay
659
+ route.fulfill({
660
+ status: 200,
661
+ body: JSON.stringify({ valid: true }),
662
+ });
663
+ });
664
+
665
+ // Act: Fill form
666
+ await page.goto('/signup');
667
+ await page.getByTestId('email-input').fill('test@example.com');
668
+ await page.getByTestId('email-input').blur();
669
+
670
+ // Assert: Client-side validation triggers immediately (doesn't wait for API)
671
+ await expect(page.getByTestId('email-valid-icon')).toBeVisible({ timeout: 1000 });
672
+
673
+ // Assert: Eventually API validates too (but doesn't block UX)
674
+ await expect(page.getByTestId('email-validated-badge')).toBeVisible({ timeout: 7000 });
675
+ });
676
+
677
+ test('should maintain functionality with third-party script failure', async ({ page }) => {
678
+ // Block third-party scripts (Google Analytics, Intercom, etc.)
679
+ await page.route('**/*.google-analytics.com/**', (route) => route.abort());
680
+ await page.route('**/*.intercom.io/**', (route) => route.abort());
681
+
682
+ // Act
683
+ await page.goto('/');
684
+
685
+ // Assert: App works without third-party scripts
686
+ await expect(page.getByTestId('main-content')).toBeVisible();
687
+ await expect(page.getByTestId('nav-menu')).toBeVisible();
688
+
689
+ // Assert: Core functionality intact
690
+ await page.getByTestId('nav-products').click();
691
+ await expect(page).toHaveURL(/.*\/products/);
692
+ });
693
+ });
694
+ ```
695
+
696
+ **Key Points**:
697
+
698
+ - **Cached fallbacks**: Display stale data when API unavailable
699
+ - **Non-critical degradation**: Analytics failures don't block app
700
+ - **Client-side fallbacks**: Local validation when API slow
701
+ - **Third-party resilience**: App works without external scripts
702
+ - **User transparency**: Stale data warnings displayed
703
+
704
+ ---
705
+
706
+ ## Error Handling Testing Checklist
707
+
708
+ Before shipping error handling code, verify:
709
+
710
+ - [ ] **Scoped exception handling**: Only ignore documented errors (NetworkError, specific codes)
711
+ - [ ] **Rethrow unexpected**: Unknown errors fail tests (catch regressions)
712
+ - [ ] **Error UI tested**: User sees error messages for all error states
713
+ - [ ] **Retry logic validated**: Sequential failures test backoff and max attempts
714
+ - [ ] **Telemetry verified**: Errors logged with context (endpoint, status, user)
715
+ - [ ] **Secret redaction**: Logs don't contain passwords, tokens, PII
716
+ - [ ] **Graceful degradation**: Critical services down, app shows fallback UI
717
+ - [ ] **Non-critical failures**: Analytics/tracking failures don't block app
718
+
719
+ ## Integration Points
720
+
721
+ - Used in workflows: `*automate` (error handling test generation), `*test-review` (error pattern detection)
722
+ - Related fragments: `network-first.md`, `test-quality.md`, `contract-testing.md`
723
+ - Monitoring tools: Sentry, Datadog, LogRocket
724
+
725
+ _Source: Murat error-handling patterns, Pact resilience guidance, SEON production error handling_