codeply-cli 0.5.0 → 0.5.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (387) hide show
  1. package/LICENSE +21 -0
  2. package/THIRD_PARTY_NOTICES.md +65 -63
  3. package/bin/codeply.js +1 -1
  4. package/lib/agent.mjs +133 -24
  5. package/lib/ai.js +268 -9
  6. package/lib/ai.mjs +6 -6
  7. package/lib/apply-patch.js +217 -217
  8. package/lib/arity-table.json +138 -138
  9. package/lib/arity.js +70 -70
  10. package/lib/auth.mjs +6 -6
  11. package/lib/bots.js +493 -16
  12. package/lib/chatgpt.js +282 -0
  13. package/lib/cloud-browser.mjs +143 -143
  14. package/lib/cloud.mjs +1186 -1105
  15. package/lib/commands.js +103 -103
  16. package/lib/config.js +83 -3
  17. package/lib/design-library/assemble-artifact.mjs +21 -21
  18. package/lib/design-library/cleanup.mjs +45 -45
  19. package/lib/design-library/index.json +22379 -22379
  20. package/lib/design-library/make-table-data.mjs +39 -39
  21. package/lib/diagnostics.js +192 -192
  22. package/lib/edit-engine.js +364 -364
  23. package/lib/github-agent.mjs +311 -311
  24. package/lib/history.js +75 -75
  25. package/lib/mail-watch.js +504 -0
  26. package/lib/mcp.js +258 -258
  27. package/lib/model-sync.js +114 -0
  28. package/lib/native-tools.mjs +16 -1
  29. package/lib/oauth-connectors.js +146 -24
  30. package/lib/permissions.js +109 -109
  31. package/lib/plugins.js +353 -353
  32. package/lib/publish.js +916 -0
  33. package/lib/reach.js +67 -0
  34. package/lib/server.mjs +457 -457
  35. package/lib/session-db.js +220 -220
  36. package/lib/share.js +168 -168
  37. package/lib/skills.js +2 -0
  38. package/lib/snapshot.js +146 -146
  39. package/lib/telemetry.js +102 -0
  40. package/lib/terminal-hints.js +154 -154
  41. package/lib/tools.mjs +316 -14
  42. package/lib/typecheck-worker.js +147 -147
  43. package/lib/web-tools.js +209 -158
  44. package/package.json +49 -49
  45. package/skills/SOURCE.md +58 -58
  46. package/skills/accessibility/SKILL.md +147 -147
  47. package/skills/agent-architecture-audit/SKILL.md +257 -257
  48. package/skills/agent-eval/SKILL.md +147 -147
  49. package/skills/agent-harness-construction/SKILL.md +74 -74
  50. package/skills/agent-introspection-debugging/SKILL.md +154 -154
  51. package/skills/agent-payment-x402/SKILL.md +225 -225
  52. package/skills/agent-self-evaluation/SKILL.md +182 -182
  53. package/skills/agent-self-evaluation/references/evaluation-criteria.md +71 -71
  54. package/skills/agent-self-evaluation/references/hook-integration.md +64 -64
  55. package/skills/agent-sort/SKILL.md +216 -216
  56. package/skills/agentic-engineering/SKILL.md +64 -64
  57. package/skills/agentic-os/SKILL.md +388 -388
  58. package/skills/ai-first-engineering/SKILL.md +52 -52
  59. package/skills/ai-regression-testing/SKILL.md +386 -386
  60. package/skills/android-clean-architecture/SKILL.md +340 -340
  61. package/skills/angular-developer/SKILL.md +155 -155
  62. package/skills/angular-developer/references/angular-animations.md +160 -160
  63. package/skills/angular-developer/references/angular-aria.md +410 -410
  64. package/skills/angular-developer/references/cli.md +86 -86
  65. package/skills/angular-developer/references/component-harnesses.md +59 -59
  66. package/skills/angular-developer/references/component-styling.md +91 -91
  67. package/skills/angular-developer/references/components.md +117 -117
  68. package/skills/angular-developer/references/creating-services.md +97 -97
  69. package/skills/angular-developer/references/data-resolvers.md +69 -69
  70. package/skills/angular-developer/references/define-routes.md +67 -67
  71. package/skills/angular-developer/references/defining-providers.md +72 -72
  72. package/skills/angular-developer/references/di-fundamentals.md +120 -120
  73. package/skills/angular-developer/references/e2e-testing.md +56 -56
  74. package/skills/angular-developer/references/effects.md +83 -83
  75. package/skills/angular-developer/references/hierarchical-injectors.md +43 -43
  76. package/skills/angular-developer/references/host-elements.md +80 -80
  77. package/skills/angular-developer/references/injection-context.md +63 -63
  78. package/skills/angular-developer/references/inputs.md +101 -101
  79. package/skills/angular-developer/references/linked-signal.md +59 -59
  80. package/skills/angular-developer/references/loading-strategies.md +61 -61
  81. package/skills/angular-developer/references/mcp.md +108 -108
  82. package/skills/angular-developer/references/navigate-to-routes.md +69 -69
  83. package/skills/angular-developer/references/outputs.md +86 -86
  84. package/skills/angular-developer/references/reactive-forms.md +122 -122
  85. package/skills/angular-developer/references/rendering-strategies.md +44 -44
  86. package/skills/angular-developer/references/resource.md +77 -77
  87. package/skills/angular-developer/references/route-animations.md +56 -56
  88. package/skills/angular-developer/references/route-guards.md +52 -52
  89. package/skills/angular-developer/references/router-lifecycle.md +45 -45
  90. package/skills/angular-developer/references/router-testing.md +87 -87
  91. package/skills/angular-developer/references/show-routes-with-outlets.md +68 -68
  92. package/skills/angular-developer/references/signal-forms.md +795 -795
  93. package/skills/angular-developer/references/signals-overview.md +94 -94
  94. package/skills/angular-developer/references/tailwind-css.md +69 -69
  95. package/skills/angular-developer/references/template-driven-forms.md +114 -114
  96. package/skills/angular-developer/references/testing-fundamentals.md +65 -65
  97. package/skills/api-connector-builder/SKILL.md +121 -121
  98. package/skills/api-design/SKILL.md +524 -524
  99. package/skills/architecture-decision-records/SKILL.md +180 -180
  100. package/skills/article-writing/SKILL.md +80 -80
  101. package/skills/automation-audit-ops/SKILL.md +143 -143
  102. package/skills/autonomous-agent-harness/SKILL.md +274 -274
  103. package/skills/autonomous-loops/SKILL.md +611 -611
  104. package/skills/backend-patterns/SKILL.md +562 -562
  105. package/skills/benchmark/SKILL.md +95 -95
  106. package/skills/benchmark-methodology/SKILL.md +191 -191
  107. package/skills/benchmark-optimization-loop/SKILL.md +71 -71
  108. package/skills/blender-motion-state-inspection/SKILL.md +165 -165
  109. package/skills/blueprint/SKILL.md +106 -106
  110. package/skills/brand-discovery/SKILL.md +145 -145
  111. package/skills/brand-discovery/references/10_purpose-why.md +40 -40
  112. package/skills/brand-discovery/references/20_positioning.md +44 -44
  113. package/skills/brand-discovery/references/30_audience-niche.md +52 -52
  114. package/skills/brand-discovery/references/40_personality-archetype.md +57 -57
  115. package/skills/brand-discovery/references/50_voice-tone.md +59 -59
  116. package/skills/brand-discovery/references/60_narrative-story.md +50 -50
  117. package/skills/brand-discovery/references/70_founder-tension.md +49 -49
  118. package/skills/brand-discovery/references/90_SYNTHESIS.md +133 -133
  119. package/skills/brand-voice/SKILL.md +98 -98
  120. package/skills/brand-voice/references/voice-profile-schema.md +55 -55
  121. package/skills/browser-qa/SKILL.md +105 -105
  122. package/skills/bun-runtime/SKILL.md +85 -85
  123. package/skills/canary-watch/SKILL.md +108 -108
  124. package/skills/carrier-relationship-management/SKILL.md +212 -212
  125. package/skills/cisco-ios-patterns/SKILL.md +164 -164
  126. package/skills/ck/SKILL.md +148 -148
  127. package/skills/claude-devfleet/SKILL.md +112 -112
  128. package/skills/click-path-audit/SKILL.md +245 -245
  129. package/skills/clickhouse-io/SKILL.md +445 -445
  130. package/skills/code-tour/SKILL.md +254 -254
  131. package/skills/codebase-onboarding/SKILL.md +234 -234
  132. package/skills/codehealth-mcp/SKILL.md +167 -167
  133. package/skills/coding-standards/SKILL.md +551 -551
  134. package/skills/competitive-platform-analysis/SKILL.md +214 -214
  135. package/skills/competitive-report-structure/SKILL.md +162 -162
  136. package/skills/compose-multiplatform-patterns/SKILL.md +300 -300
  137. package/skills/config-gc/SKILL.md +120 -120
  138. package/skills/configure-ecc/SKILL.md +385 -385
  139. package/skills/connections-optimizer/SKILL.md +190 -190
  140. package/skills/content-engine/SKILL.md +132 -132
  141. package/skills/content-hash-cache-pattern/SKILL.md +162 -162
  142. package/skills/context-budget/SKILL.md +136 -136
  143. package/skills/continuous-agent-loop/SKILL.md +46 -46
  144. package/skills/continuous-learning/SKILL.md +132 -132
  145. package/skills/continuous-learning-v2/SKILL.md +361 -361
  146. package/skills/contract-first/SKILL.md +287 -287
  147. package/skills/cost-aware-llm-pipeline/SKILL.md +184 -184
  148. package/skills/cost-tracking/SKILL.md +97 -97
  149. package/skills/council/SKILL.md +204 -204
  150. package/skills/cpp-coding-standards/SKILL.md +724 -724
  151. package/skills/cpp-testing/SKILL.md +325 -325
  152. package/skills/crosspost/SKILL.md +112 -112
  153. package/skills/csharp-testing/SKILL.md +322 -322
  154. package/skills/customer-billing-ops/SKILL.md +141 -141
  155. package/skills/customs-trade-compliance/SKILL.md +263 -263
  156. package/skills/dart-flutter-patterns/SKILL.md +564 -564
  157. package/skills/dashboard-builder/SKILL.md +109 -109
  158. package/skills/data-scraper-agent/SKILL.md +765 -765
  159. package/skills/data-throughput-accelerator/SKILL.md +74 -74
  160. package/skills/database-migrations/SKILL.md +430 -430
  161. package/skills/deep-research/SKILL.md +160 -160
  162. package/skills/defi-amm-security/SKILL.md +167 -167
  163. package/skills/delivery-gate/SKILL.md +126 -126
  164. package/skills/deployment-patterns/SKILL.md +428 -428
  165. package/skills/design-system/SKILL.md +83 -83
  166. package/skills/django-celery/SKILL.md +458 -458
  167. package/skills/django-patterns/SKILL.md +735 -735
  168. package/skills/django-security/SKILL.md +644 -644
  169. package/skills/django-tdd/SKILL.md +730 -730
  170. package/skills/django-verification/SKILL.md +470 -470
  171. package/skills/dmux-workflows/SKILL.md +192 -192
  172. package/skills/docker-patterns/SKILL.md +365 -365
  173. package/skills/documentation-lookup/SKILL.md +91 -91
  174. package/skills/dotnet-patterns/SKILL.md +322 -322
  175. package/skills/dynamic-workflow-mode/SKILL.md +124 -124
  176. package/skills/e2e-testing/SKILL.md +327 -327
  177. package/skills/ecc-guide/SKILL.md +190 -190
  178. package/skills/ecc-recipes/SKILL.md +149 -149
  179. package/skills/ecc-tools-cost-audit/SKILL.md +161 -161
  180. package/skills/email-ops/SKILL.md +122 -122
  181. package/skills/energy-procurement/SKILL.md +228 -228
  182. package/skills/enterprise-agent-ops/SKILL.md +51 -51
  183. package/skills/error-handling/SKILL.md +377 -377
  184. package/skills/eval-harness/SKILL.md +271 -271
  185. package/skills/evm-token-decimals/SKILL.md +131 -131
  186. package/skills/exa-search/SKILL.md +108 -108
  187. package/skills/fal-ai-media/SKILL.md +289 -289
  188. package/skills/fastapi-patterns/SKILL.md +514 -514
  189. package/skills/finance-billing-ops/SKILL.md +128 -128
  190. package/skills/flox-environments/SKILL.md +497 -497
  191. package/skills/flutter-dart-code-review/SKILL.md +436 -436
  192. package/skills/foundation-models-on-device/SKILL.md +243 -243
  193. package/skills/frontend-a11y/SKILL.md +446 -446
  194. package/skills/frontend-design-direction/SKILL.md +93 -93
  195. package/skills/frontend-patterns/SKILL.md +657 -657
  196. package/skills/frontend-slides/SKILL.md +185 -185
  197. package/skills/fsharp-testing/SKILL.md +281 -281
  198. package/skills/gan-style-harness/SKILL.md +279 -279
  199. package/skills/gateguard/SKILL.md +133 -133
  200. package/skills/generating-python-installer/SKILL.md +820 -820
  201. package/skills/git-workflow/SKILL.md +716 -716
  202. package/skills/github-ops/SKILL.md +145 -145
  203. package/skills/golang-patterns/SKILL.md +676 -676
  204. package/skills/golang-testing/SKILL.md +721 -721
  205. package/skills/google-workspace-ops/SKILL.md +96 -96
  206. package/skills/growth-log/SKILL.md +128 -128
  207. package/skills/healthcare-cdss-patterns/SKILL.md +246 -246
  208. package/skills/healthcare-emr-patterns/SKILL.md +160 -160
  209. package/skills/healthcare-eval-harness/SKILL.md +208 -208
  210. package/skills/healthcare-phi-compliance/SKILL.md +146 -146
  211. package/skills/hermes-imports/SKILL.md +89 -89
  212. package/skills/hexagonal-architecture/SKILL.md +277 -277
  213. package/skills/hipaa-compliance/SKILL.md +79 -79
  214. package/skills/homelab-network-readiness/SKILL.md +170 -170
  215. package/skills/homelab-network-setup/SKILL.md +130 -130
  216. package/skills/homelab-pihole-dns/SKILL.md +275 -275
  217. package/skills/homelab-vlan-segmentation/SKILL.md +312 -312
  218. package/skills/homelab-wireguard-vpn/SKILL.md +306 -306
  219. package/skills/hookify-rules/SKILL.md +128 -128
  220. package/skills/inherit-legacy-style/SKILL.md +157 -157
  221. package/skills/intent-driven-development/SKILL.md +360 -360
  222. package/skills/inventory-demand-planning/SKILL.md +247 -247
  223. package/skills/investor-materials/SKILL.md +97 -97
  224. package/skills/investor-outreach/SKILL.md +92 -92
  225. package/skills/ios-icon-gen/SKILL.md +158 -158
  226. package/skills/iterative-retrieval/SKILL.md +212 -212
  227. package/skills/ito-basket-compare/SKILL.md +64 -64
  228. package/skills/ito-compute/SKILL.md +129 -129
  229. package/skills/ito-data-atlas-agent/SKILL.md +64 -64
  230. package/skills/ito-market-intelligence/SKILL.md +61 -61
  231. package/skills/ito-trade-planner/SKILL.md +68 -68
  232. package/skills/java-coding-standards/SKILL.md +384 -384
  233. package/skills/jira-integration/SKILL.md +303 -303
  234. package/skills/jpa-patterns/SKILL.md +152 -152
  235. package/skills/knowledge-ops/SKILL.md +155 -155
  236. package/skills/kotlin-coroutines-flows/SKILL.md +285 -285
  237. package/skills/kotlin-exposed-patterns/SKILL.md +720 -720
  238. package/skills/kotlin-ktor-patterns/SKILL.md +690 -690
  239. package/skills/kotlin-patterns/SKILL.md +712 -712
  240. package/skills/kotlin-testing/SKILL.md +825 -825
  241. package/skills/kubernetes-patterns/SKILL.md +756 -756
  242. package/skills/laravel-patterns/SKILL.md +416 -416
  243. package/skills/laravel-plugin-discovery/SKILL.md +230 -230
  244. package/skills/laravel-security/SKILL.md +948 -948
  245. package/skills/laravel-tdd/SKILL.md +675 -675
  246. package/skills/laravel-verification/SKILL.md +180 -180
  247. package/skills/latency-critical-systems/SKILL.md +75 -75
  248. package/skills/lead-intelligence/SKILL.md +322 -322
  249. package/skills/liquid-glass-design/SKILL.md +279 -279
  250. package/skills/llm-trading-agent-security/SKILL.md +147 -147
  251. package/skills/logistics-exception-management/SKILL.md +222 -222
  252. package/skills/loop-design-check/SKILL.md +143 -143
  253. package/skills/mailtrap-email-integration/SKILL.md +77 -77
  254. package/skills/make-interfaces-feel-better/SKILL.md +152 -152
  255. package/skills/manim-video/SKILL.md +90 -90
  256. package/skills/market-research/SKILL.md +76 -76
  257. package/skills/marketing-campaign/SKILL.md +114 -114
  258. package/skills/mcp-server-patterns/SKILL.md +70 -70
  259. package/skills/messages-ops/SKILL.md +105 -105
  260. package/skills/ml-adoption-playbook/SKILL.md +57 -57
  261. package/skills/mle-workflow/SKILL.md +348 -348
  262. package/skills/motion-advanced/SKILL.md +596 -596
  263. package/skills/motion-foundations/SKILL.md +299 -299
  264. package/skills/motion-patterns/SKILL.md +434 -434
  265. package/skills/motion-ui/SKILL.md +576 -576
  266. package/skills/mysql-patterns/SKILL.md +413 -413
  267. package/skills/nanoclaw-repl/SKILL.md +34 -34
  268. package/skills/nestjs-patterns/SKILL.md +231 -231
  269. package/skills/netmiko-ssh-automation/SKILL.md +174 -174
  270. package/skills/network-bgp-diagnostics/SKILL.md +168 -168
  271. package/skills/network-config-validation/SKILL.md +211 -211
  272. package/skills/network-interface-health/SKILL.md +153 -153
  273. package/skills/nextjs-turbopack/SKILL.md +58 -58
  274. package/skills/nodejs-keccak256/SKILL.md +103 -103
  275. package/skills/nutrient-document-processing/SKILL.md +168 -168
  276. package/skills/nuxt4-patterns/SKILL.md +101 -101
  277. package/skills/openclaw-persona-forge/SKILL.md +289 -289
  278. package/skills/openclaw-persona-forge/references/avatar-style.md +124 -124
  279. package/skills/openclaw-persona-forge/references/boundary-rules.md +53 -53
  280. package/skills/openclaw-persona-forge/references/error-handling.md +53 -53
  281. package/skills/openclaw-persona-forge/references/identity-tension.md +48 -48
  282. package/skills/openclaw-persona-forge/references/naming-system.md +39 -39
  283. package/skills/openclaw-persona-forge/references/output-template.md +166 -166
  284. package/skills/opensource-pipeline/SKILL.md +256 -256
  285. package/skills/orch-add-feature/SKILL.md +45 -45
  286. package/skills/orch-build-mvp/SKILL.md +49 -49
  287. package/skills/orch-change-feature/SKILL.md +43 -43
  288. package/skills/orch-fix-defect/SKILL.md +43 -43
  289. package/skills/orch-pipeline/SKILL.md +121 -121
  290. package/skills/orch-refine-code/SKILL.md +44 -44
  291. package/skills/parallel-execution-optimizer/SKILL.md +74 -74
  292. package/skills/perl-patterns/SKILL.md +505 -505
  293. package/skills/perl-security/SKILL.md +504 -504
  294. package/skills/perl-testing/SKILL.md +476 -476
  295. package/skills/plan-canvas/SKILL.md +153 -153
  296. package/skills/plan-orchestrate/SKILL.md +263 -263
  297. package/skills/plankton-code-quality/SKILL.md +237 -237
  298. package/skills/postgres-patterns/SKILL.md +148 -148
  299. package/skills/prediction-market-oracle-research/SKILL.md +64 -64
  300. package/skills/prediction-market-risk-review/SKILL.md +61 -61
  301. package/skills/premium-web-design/SKILL.md +154 -154
  302. package/skills/prisma-patterns/SKILL.md +401 -401
  303. package/skills/product-capability/SKILL.md +142 -142
  304. package/skills/product-lens/SKILL.md +93 -93
  305. package/skills/production-audit/SKILL.md +207 -207
  306. package/skills/production-scheduling/SKILL.md +238 -238
  307. package/skills/project-flow-ops/SKILL.md +112 -112
  308. package/skills/prompt-optimizer/SKILL.md +398 -398
  309. package/skills/publish-website/SKILL.md +76 -0
  310. package/skills/python-patterns/SKILL.md +751 -751
  311. package/skills/python-testing/SKILL.md +817 -817
  312. package/skills/pytorch-patterns/SKILL.md +397 -397
  313. package/skills/quality-nonconformance/SKILL.md +260 -260
  314. package/skills/quarkus-patterns/SKILL.md +723 -723
  315. package/skills/quarkus-security/SKILL.md +468 -468
  316. package/skills/quarkus-tdd/SKILL.md +812 -812
  317. package/skills/quarkus-verification/SKILL.md +480 -480
  318. package/skills/ralphinho-rfc-pipeline/SKILL.md +68 -68
  319. package/skills/react-native-patterns/SKILL.md +326 -326
  320. package/skills/react-patterns/SKILL.md +342 -342
  321. package/skills/react-performance/SKILL.md +575 -575
  322. package/skills/react-testing/SKILL.md +424 -424
  323. package/skills/recsys-pipeline-architect/SKILL.md +115 -115
  324. package/skills/recursive-decision-ledger/SKILL.md +81 -81
  325. package/skills/redis-patterns/SKILL.md +404 -404
  326. package/skills/regex-vs-llm-structured-text/SKILL.md +221 -221
  327. package/skills/remotion-video-creation/SKILL.md +43 -43
  328. package/skills/repo-scan/SKILL.md +79 -79
  329. package/skills/research-ops/SKILL.md +113 -113
  330. package/skills/returns-reverse-logistics/SKILL.md +240 -240
  331. package/skills/rules-distill/SKILL.md +265 -265
  332. package/skills/rust-patterns/SKILL.md +500 -500
  333. package/skills/rust-testing/SKILL.md +501 -501
  334. package/skills/safety-guard/SKILL.md +76 -76
  335. package/skills/santa-method/SKILL.md +307 -307
  336. package/skills/scientific-db-pubmed-database/SKILL.md +176 -176
  337. package/skills/scientific-db-uspto-database/SKILL.md +178 -178
  338. package/skills/scientific-pkg-gget/SKILL.md +167 -167
  339. package/skills/scientific-thinking-literature-review/SKILL.md +193 -193
  340. package/skills/scientific-thinking-scholar-evaluation/SKILL.md +161 -161
  341. package/skills/search-first/SKILL.md +183 -183
  342. package/skills/security-bounty-hunter/SKILL.md +100 -100
  343. package/skills/security-review/SKILL.md +504 -504
  344. package/skills/security-scan/SKILL.md +166 -166
  345. package/skills/seo/SKILL.md +155 -155
  346. package/skills/skill-comply/SKILL.md +59 -59
  347. package/skills/skill-scout/SKILL.md +141 -141
  348. package/skills/skill-stocktake/SKILL.md +195 -195
  349. package/skills/social-graph-ranker/SKILL.md +155 -155
  350. package/skills/social-publisher/SKILL.md +130 -130
  351. package/skills/springboot-patterns/SKILL.md +315 -315
  352. package/skills/springboot-security/SKILL.md +273 -273
  353. package/skills/springboot-tdd/SKILL.md +159 -159
  354. package/skills/springboot-verification/SKILL.md +232 -232
  355. package/skills/strategic-compact/SKILL.md +142 -142
  356. package/skills/swift-actor-persistence/SKILL.md +144 -144
  357. package/skills/swift-concurrency-6-2/SKILL.md +216 -216
  358. package/skills/swift-protocol-di-testing/SKILL.md +191 -191
  359. package/skills/swiftui-patterns/SKILL.md +259 -259
  360. package/skills/taste/SKILL.md +264 -264
  361. package/skills/taste/references/genre-taxonomy.md +87 -87
  362. package/skills/tdd-workflow/SKILL.md +583 -583
  363. package/skills/team-agent-orchestration/SKILL.md +111 -111
  364. package/skills/team-builder/SKILL.md +169 -169
  365. package/skills/terminal-ops/SKILL.md +110 -110
  366. package/skills/tinystruct-patterns/SKILL.md +279 -279
  367. package/skills/tinystruct-patterns/references/architecture.md +90 -90
  368. package/skills/tinystruct-patterns/references/data-handling.md +60 -60
  369. package/skills/tinystruct-patterns/references/database.md +99 -99
  370. package/skills/tinystruct-patterns/references/routing.md +64 -64
  371. package/skills/tinystruct-patterns/references/system-usage.md +97 -97
  372. package/skills/tinystruct-patterns/references/testing.md +72 -72
  373. package/skills/token-budget-advisor/SKILL.md +134 -134
  374. package/skills/ui-demo/SKILL.md +466 -466
  375. package/skills/ui-to-vue/SKILL.md +135 -135
  376. package/skills/uncloud/SKILL.md +344 -344
  377. package/skills/unified-memory/SKILL.md +170 -170
  378. package/skills/unified-notifications-ops/SKILL.md +188 -188
  379. package/skills/verification-loop/SKILL.md +129 -129
  380. package/skills/video-editing/SKILL.md +311 -311
  381. package/skills/videodb/SKILL.md +375 -375
  382. package/skills/visa-doc-translate/SKILL.md +117 -117
  383. package/skills/vite-patterns/SKILL.md +450 -450
  384. package/skills/vue-patterns/SKILL.md +471 -471
  385. package/skills/windows-desktop-e2e/SKILL.md +888 -888
  386. package/skills/workspace-surface-audit/SKILL.md +126 -126
  387. package/skills/x-api/SKILL.md +235 -235
@@ -1,723 +1,723 @@
1
- ---
2
- name: quarkus-patterns
3
- description: Quarkus 3.x LTS architecture patterns with Camel for messaging, RESTful API design, CDI services, data access with Panache, and async processing. Use for Java Quarkus backend work with event-driven architectures.
4
- metadata:
5
- origin: ECC
6
- ---
7
-
8
- # Quarkus Development Patterns
9
-
10
- Quarkus 3.x architecture and API patterns for cloud-native, event-driven services with Apache Camel.
11
-
12
- ## When to Activate
13
-
14
- - Building REST APIs with JAX-RS or RESTEasy Reactive
15
- - Structuring resource → service → repository layers
16
- - Implementing event-driven patterns with Apache Camel and RabbitMQ
17
- - Configuring Hibernate Panache, caching, or reactive streams
18
- - Adding validation, exception mapping, or pagination
19
- - Setting up profiles for dev/staging/production environments (YAML config)
20
- - Custom logging with LogContext and Logback/Logstash encoder
21
- - Working with CompletableFuture for async operations
22
- - Implementing conditional flow processing
23
- - Working with GraalVM native compilation
24
-
25
- ## Service Layer with Multiple Dependencies
26
-
27
- ```java
28
- @Slf4j
29
- @ApplicationScoped
30
- @RequiredArgsConstructor
31
- public class OrderProcessingService {
32
-
33
- private final OrderValidator orderValidator;
34
- private final EventService eventService;
35
- private final OrderRepository orderRepository;
36
- private final FulfillmentPublisher fulfillmentPublisher;
37
- private final AuditPublisher auditPublisher;
38
-
39
- @Transactional
40
- public OrderReceipt process(CreateOrderCommand command) {
41
- ValidationResult validation = orderValidator.validate(command);
42
- if (!validation.valid()) {
43
- eventService.createErrorEvent(command, "ORDER_REJECTED", validation.message());
44
- throw new WebApplicationException(validation.message(), Response.Status.BAD_REQUEST);
45
- }
46
-
47
- Order order = Order.from(command);
48
- orderRepository.persist(order);
49
-
50
- OrderReceipt receipt = OrderReceipt.from(order);
51
- fulfillmentPublisher.publishAsync(receipt);
52
- auditPublisher.publish("ORDER_ACCEPTED", receipt);
53
- eventService.createSuccessEvent(receipt, "ORDER_ACCEPTED");
54
-
55
- log.info("Processed order {}", order.id);
56
- return receipt;
57
- }
58
- }
59
- ```
60
-
61
- **Key Patterns:**
62
- - `@RequiredArgsConstructor` for constructor injection via Lombok
63
- - `@Slf4j` for Logback logging
64
- - `@Transactional` on service methods that write through Panache or repositories
65
- - Validate input before persistence or message publication
66
- - Event tracking for success/error scenarios
67
- - Async Camel message publishing
68
-
69
- ## Custom Logging Context Pattern (Logback)
70
-
71
- ```java
72
- @ApplicationScoped
73
- public class ProcessingService {
74
-
75
- public void processDocument(Document doc) {
76
- LogContext logContext = CustomLog.getCurrentContext();
77
- try (SafeAutoCloseable ignored = CustomLog.startScope(logContext)) {
78
- // Add context to all log statements
79
- logContext.put("documentId", doc.getId().toString());
80
- logContext.put("documentType", doc.getType());
81
- logContext.put("userId", SecurityContext.getUserId());
82
-
83
- log.info("Starting document processing");
84
-
85
- // All logs within this scope inherit the context
86
- processInternal(doc);
87
-
88
- log.info("Document processing completed");
89
- } catch (Exception e) {
90
- log.error("Document processing failed", e);
91
- throw e;
92
- }
93
- }
94
- }
95
- ```
96
-
97
- **Logback Configuration (logback.xml):**
98
-
99
- ```xml
100
- <configuration>
101
- <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
102
- <encoder class="net.logstash.logback.encoder.LogstashEncoder">
103
- <includeContext>true</includeContext>
104
- <includeMdc>true</includeMdc>
105
- </encoder>
106
- </appender>
107
-
108
- <logger name="com.example" level="INFO"/>
109
- <root level="WARN">
110
- <appender-ref ref="CONSOLE"/>
111
- </root>
112
- </configuration>
113
- ```
114
-
115
- ## Event Service Pattern
116
-
117
- ```java
118
- @Slf4j
119
- @ApplicationScoped
120
- @RequiredArgsConstructor
121
- public class EventService {
122
- private final EventRepository eventRepository;
123
- private final ObjectMapper objectMapper;
124
-
125
- public void createSuccessEvent(Object payload, String eventType) {
126
- Objects.requireNonNull(payload, "Payload cannot be null");
127
- Event event = new Event();
128
- event.setType(eventType);
129
- event.setStatus(EventStatus.SUCCESS);
130
- event.setPayload(serializePayload(payload));
131
- event.setTimestamp(Instant.now());
132
-
133
- eventRepository.persist(event);
134
- log.info("Success event created: {}", eventType);
135
- }
136
-
137
- public void createErrorEvent(Object payload, String eventType, String errorMessage) {
138
- Objects.requireNonNull(payload, "Payload cannot be null");
139
- if (errorMessage == null || errorMessage.isBlank()) {
140
- throw new IllegalArgumentException("Error message cannot be blank");
141
- }
142
- Event event = new Event();
143
- event.setType(eventType);
144
- event.setStatus(EventStatus.ERROR);
145
- event.setErrorMessage(errorMessage);
146
- event.setPayload(serializePayload(payload));
147
- event.setTimestamp(Instant.now());
148
-
149
- eventRepository.persist(event);
150
- log.error("Error event created: {} - {}", eventType, errorMessage);
151
- }
152
-
153
- private String serializePayload(Object payload) {
154
- try {
155
- return objectMapper.writeValueAsString(payload);
156
- } catch (JsonProcessingException e) {
157
- throw new IllegalStateException("Failed to serialize event payload", e);
158
- }
159
- }
160
- }
161
- ```
162
-
163
- ## Camel Message Publishing (RabbitMQ)
164
-
165
- ```java
166
- @Slf4j
167
- @ApplicationScoped
168
- @RequiredArgsConstructor
169
- public class BusinessRulesPublisher {
170
- private final ProducerTemplate producerTemplate;
171
-
172
- public void publishSync(BusinessRulesPayload payload) {
173
- producerTemplate.sendBody(
174
- "direct:business-rules-publisher",
175
- payload
176
- );
177
- }
178
- }
179
- ```
180
-
181
- **Camel Route Configuration:**
182
-
183
- ```java
184
- @ApplicationScoped
185
- public class BusinessRulesRoute extends RouteBuilder {
186
-
187
- @ConfigProperty(name = "camel.rabbitmq.queue.business-rules")
188
- String businessRulesQueue;
189
-
190
- @ConfigProperty(name = "rabbitmq.host")
191
- String rabbitHost;
192
-
193
- @ConfigProperty(name = "rabbitmq.port")
194
- Integer rabbitPort;
195
-
196
- @Override
197
- public void configure() {
198
- from("direct:business-rules-publisher")
199
- .routeId("business-rules-publisher")
200
- .log("Publishing message to RabbitMQ: ${body}")
201
- .marshal().json(JsonLibrary.Jackson)
202
- .toF("spring-rabbitmq:%s?hostname=%s&portNumber=%d",
203
- businessRulesQueue, rabbitHost, rabbitPort);
204
- }
205
- }
206
- ```
207
-
208
- ## Camel Direct Routes (In-Memory)
209
-
210
- ```java
211
- @ApplicationScoped
212
- public class DocumentProcessingRoute extends RouteBuilder {
213
-
214
- @Override
215
- public void configure() {
216
- // Error handling
217
- onException(ValidationException.class)
218
- .handled(true)
219
- .to("direct:validation-error-handler")
220
- .log("Validation error: ${exception.message}");
221
-
222
- // Main processing route
223
- from("direct:process-document")
224
- .routeId("document-processing")
225
- .log("Processing document: ${header.documentId}")
226
- .bean(DocumentValidator.class, "validate")
227
- .bean(DocumentTransformer.class, "transform")
228
- .choice()
229
- .when(header("documentType").isEqualTo("INVOICE"))
230
- .to("direct:process-invoice")
231
- .when(header("documentType").isEqualTo("CREDIT_NOTE"))
232
- .to("direct:process-credit-note")
233
- .otherwise()
234
- .to("direct:process-generic")
235
- .end();
236
-
237
- from("direct:validation-error-handler")
238
- .bean(EventService.class, "createErrorEvent")
239
- .log("Validation error handled");
240
- }
241
- }
242
- ```
243
-
244
- ## Camel File Processing
245
-
246
- ```java
247
- @ApplicationScoped
248
- public class FileMonitoringRoute extends RouteBuilder {
249
-
250
- @ConfigProperty(name = "file.input.directory")
251
- String inputDirectory;
252
-
253
- @ConfigProperty(name = "file.processed.directory")
254
- String processedDirectory;
255
-
256
- @ConfigProperty(name = "file.error.directory")
257
- String errorDirectory;
258
-
259
- @Override
260
- public void configure() {
261
- from("file:" + inputDirectory + "?move=" + processedDirectory +
262
- "&moveFailed=" + errorDirectory + "&delay=5000")
263
- .routeId("file-monitor")
264
- .log("Processing file: ${header.CamelFileName}")
265
- .to("direct:process-file");
266
-
267
- from("direct:process-file")
268
- .bean(OrderProcessingService.class, "processFile")
269
- .log("File processing completed");
270
- }
271
- }
272
- ```
273
-
274
- ## Camel Bean Invocation
275
-
276
- ```java
277
- @ApplicationScoped
278
- public class InvoiceRoute extends RouteBuilder {
279
-
280
- @Override
281
- public void configure() {
282
- from("direct:invoice-validation")
283
- .bean(InvoiceFlowValidator.class, "validateFlowWithConfig")
284
- .log("Validation result: ${body}");
285
-
286
- from("direct:persist-and-publish")
287
- .bean(DocumentJobService.class, "createDocumentAndJobEntities")
288
- .bean(BusinessRulesPublisher.class, "publishAsync")
289
- .bean(EventService.class, "createSuccessEvent(${body}, 'PUBLISHED')");
290
- }
291
- }
292
- ```
293
-
294
- ## REST API Structure
295
-
296
- ```java
297
- @Path("/api/documents")
298
- @Produces(MediaType.APPLICATION_JSON)
299
- @Consumes(MediaType.APPLICATION_JSON)
300
- @RequiredArgsConstructor
301
- public class DocumentResource {
302
- private final DocumentService documentService;
303
-
304
- @GET
305
- public Response list(
306
- @QueryParam("page") @DefaultValue("0") int page,
307
- @QueryParam("size") @DefaultValue("20") int size) {
308
- List<Document> documents = documentService.list(page, size);
309
- return Response.ok(documents).build();
310
- }
311
-
312
- @POST
313
- public Response create(@Valid CreateDocumentRequest request, @Context UriInfo uriInfo) {
314
- Document document = documentService.create(request);
315
- URI location = uriInfo.getAbsolutePathBuilder()
316
- .path(String.valueOf(document.id))
317
- .build();
318
- return Response.created(location).entity(DocumentResponse.from(document)).build();
319
- }
320
-
321
- @GET
322
- @Path("/{id}")
323
- public Response getById(@PathParam("id") Long id) {
324
- return documentService.findById(id)
325
- .map(DocumentResponse::from)
326
- .map(Response::ok)
327
- .orElse(Response.status(Response.Status.NOT_FOUND))
328
- .build();
329
- }
330
- }
331
- ```
332
-
333
- ## Repository Pattern (Panache Repository)
334
-
335
- ```java
336
- @ApplicationScoped
337
- public class DocumentRepository implements PanacheRepository<Document> {
338
-
339
- public List<Document> findByStatus(DocumentStatus status, int page, int size) {
340
- return find("status = ?1 order by createdAt desc", status)
341
- .page(page, size)
342
- .list();
343
- }
344
-
345
- public Optional<Document> findByReferenceNumber(String referenceNumber) {
346
- return find("referenceNumber", referenceNumber).firstResultOptional();
347
- }
348
-
349
- public long countByStatusAndDate(DocumentStatus status, LocalDate date) {
350
- return count("status = ?1 and createdAt >= ?2", status, date.atStartOfDay());
351
- }
352
- }
353
- ```
354
-
355
- ## Service Layer with Transactions
356
-
357
- ```java
358
- @ApplicationScoped
359
- @RequiredArgsConstructor
360
- public class DocumentService {
361
- private final DocumentRepository repo;
362
- private final EventService eventService;
363
-
364
- @Transactional
365
- public Document create(CreateDocumentRequest request) {
366
- Document document = new Document();
367
- document.setReferenceNumber(request.referenceNumber());
368
- document.setDescription(request.description());
369
- document.setStatus(DocumentStatus.PENDING);
370
- document.setCreatedAt(Instant.now());
371
-
372
- repo.persist(document);
373
-
374
- eventService.createSuccessEvent(document, "DOCUMENT_CREATED");
375
-
376
- return document;
377
- }
378
-
379
- public Optional<Document> findById(Long id) {
380
- return repo.findByIdOptional(id);
381
- }
382
-
383
- public List<Document> list(int page, int size) {
384
- return repo.findAll()
385
- .page(page, size)
386
- .list();
387
- }
388
- }
389
- ```
390
-
391
- ## DTOs and Validation
392
-
393
- ```java
394
- public record CreateDocumentRequest(
395
- @NotBlank @Size(max = 200) String referenceNumber,
396
- @NotBlank @Size(max = 2000) String description,
397
- @NotNull @FutureOrPresent Instant validUntil,
398
- @NotEmpty List<@NotBlank String> categories) {}
399
-
400
- public record DocumentResponse(Long id, String referenceNumber, DocumentStatus status) {
401
- public static DocumentResponse from(Document document) {
402
- return new DocumentResponse(document.getId(), document.getReferenceNumber(),
403
- document.getStatus());
404
- }
405
- }
406
- ```
407
-
408
- ## Exception Mapping
409
-
410
- ```java
411
- @Provider
412
- public class ValidationExceptionMapper implements ExceptionMapper<ConstraintViolationException> {
413
- @Override
414
- public Response toResponse(ConstraintViolationException exception) {
415
- String message = exception.getConstraintViolations().stream()
416
- .map(cv -> cv.getPropertyPath() + ": " + cv.getMessage())
417
- .collect(Collectors.joining(", "));
418
-
419
- return Response.status(Response.Status.BAD_REQUEST)
420
- .entity(Map.of("error", "validation_error", "message", message))
421
- .build();
422
- }
423
- }
424
-
425
- @Provider
426
- @Slf4j
427
- public class GenericExceptionMapper implements ExceptionMapper<Exception> {
428
-
429
- @Override
430
- public Response toResponse(Exception exception) {
431
- log.error("Unhandled exception", exception);
432
- return Response.status(Response.Status.INTERNAL_SERVER_ERROR)
433
- .entity(Map.of("error", "internal_error", "message", "An unexpected error occurred"))
434
- .build();
435
- }
436
- }
437
- ```
438
-
439
- ## CompletableFuture Async Operations
440
-
441
- ```java
442
- @Slf4j
443
- @ApplicationScoped
444
- @RequiredArgsConstructor
445
- public class FileStorageService {
446
- private final S3Client s3Client;
447
- private final ExecutorService executorService;
448
-
449
- @ConfigProperty(name = "storage.bucket-name")
450
- String bucketName;
451
-
452
- public CompletableFuture<StoredDocumentInfo> uploadOriginalFile(
453
- InputStream inputStream,
454
- long size,
455
- LogContext logContext,
456
- InvoiceFormat format) {
457
-
458
- return CompletableFuture.supplyAsync(() -> {
459
- try (SafeAutoCloseable ignored = CustomLog.startScope(logContext)) {
460
- String path = generateStoragePath(format);
461
-
462
- PutObjectRequest request = PutObjectRequest.builder()
463
- .bucket(bucketName)
464
- .key(path)
465
- .contentLength(size)
466
- .build();
467
-
468
- s3Client.putObject(request, RequestBody.fromInputStream(inputStream, size));
469
-
470
- log.info("File uploaded to S3: {}", path);
471
-
472
- return new StoredDocumentInfo(path, size, Instant.now());
473
- } catch (Exception e) {
474
- log.error("Failed to upload file to S3", e);
475
- throw new StorageException("Upload failed", e);
476
- }
477
- }, executorService);
478
- }
479
- }
480
- ```
481
-
482
- ## Caching
483
-
484
- ```java
485
- @ApplicationScoped
486
- @RequiredArgsConstructor
487
- public class DocumentCacheService {
488
- private final DocumentRepository repo;
489
-
490
- @CacheResult(cacheName = "document-cache")
491
- public Optional<Document> getById(@CacheKey Long id) {
492
- return repo.findByIdOptional(id);
493
- }
494
-
495
- @CacheInvalidate(cacheName = "document-cache")
496
- public void evict(@CacheKey Long id) {}
497
-
498
- @CacheInvalidateAll(cacheName = "document-cache")
499
- public void evictAll() {}
500
- }
501
- ```
502
-
503
- ## Configuration as YAML
504
-
505
- ```yaml
506
- # application.yml
507
- "%dev":
508
- quarkus:
509
- datasource:
510
- jdbc:
511
- url: jdbc:postgresql://localhost:5432/dev_db
512
- username: dev_user
513
- password: ${DB_PASSWORD}
514
- hibernate-orm:
515
- database:
516
- generation: drop-and-create
517
-
518
- rabbitmq:
519
- host: localhost
520
- port: 5672
521
- username: ${RABBITMQ_USER}
522
- password: ${RABBITMQ_PASSWORD}
523
-
524
- "%test":
525
- quarkus:
526
- datasource:
527
- jdbc:
528
- url: jdbc:h2:mem:test
529
- hibernate-orm:
530
- database:
531
- generation: drop-and-create
532
-
533
- "%prod":
534
- quarkus:
535
- datasource:
536
- jdbc:
537
- url: ${DATABASE_URL}
538
- username: ${DB_USER}
539
- password: ${DB_PASSWORD}
540
- hibernate-orm:
541
- database:
542
- generation: validate
543
-
544
- rabbitmq:
545
- host: ${RABBITMQ_HOST}
546
- port: ${RABBITMQ_PORT}
547
- username: ${RABBITMQ_USER}
548
- password: ${RABBITMQ_PASSWORD}
549
-
550
- # Camel configuration
551
- camel:
552
- rabbitmq:
553
- queue:
554
- business-rules: business-rules-queue
555
- invoice-processing: invoice-processing-queue
556
- ```
557
-
558
- ## Health Checks
559
-
560
- ```java
561
- @Readiness
562
- @ApplicationScoped
563
- @RequiredArgsConstructor
564
- public class DatabaseHealthCheck implements HealthCheck {
565
- private final AgroalDataSource dataSource;
566
-
567
- @Override
568
- public HealthCheckResponse call() {
569
- try (Connection conn = dataSource.getConnection()) {
570
- boolean valid = conn.isValid(2);
571
- return HealthCheckResponse.named("Database connection")
572
- .status(valid)
573
- .build();
574
- } catch (SQLException e) {
575
- return HealthCheckResponse.down("Database connection");
576
- }
577
- }
578
- }
579
-
580
- @Liveness
581
- @ApplicationScoped
582
- public class CamelHealthCheck implements HealthCheck {
583
- @Inject
584
- CamelContext camelContext;
585
-
586
- @Override
587
- public HealthCheckResponse call() {
588
- boolean isStarted = camelContext.getStatus().isStarted();
589
- return HealthCheckResponse.named("Camel Context")
590
- .status(isStarted)
591
- .build();
592
- }
593
- }
594
- ```
595
-
596
- ## Dependencies (Maven)
597
-
598
- ```xml
599
- <properties>
600
- <quarkus.platform.version>3.27.0</quarkus.platform.version>
601
- <lombok.version>1.18.42</lombok.version>
602
- <assertj-core.version>3.24.2</assertj-core.version>
603
- <jacoco-maven-plugin.version>0.8.13</jacoco-maven-plugin.version>
604
- <maven.compiler.release>17</maven.compiler.release>
605
- </properties>
606
-
607
- <dependencyManagement>
608
- <dependencies>
609
- <dependency>
610
- <groupId>io.quarkus.platform</groupId>
611
- <artifactId>quarkus-bom</artifactId>
612
- <version>${quarkus.platform.version}</version>
613
- <type>pom</type>
614
- <scope>import</scope>
615
- </dependency>
616
- <dependency>
617
- <groupId>io.quarkus.platform</groupId>
618
- <artifactId>quarkus-camel-bom</artifactId>
619
- <version>${quarkus.platform.version}</version>
620
- <type>pom</type>
621
- <scope>import</scope>
622
- </dependency>
623
- </dependencies>
624
- </dependencyManagement>
625
-
626
- <dependencies>
627
- <!-- Quarkus Core -->
628
- <dependency>
629
- <groupId>io.quarkus</groupId>
630
- <artifactId>quarkus-arc</artifactId>
631
- </dependency>
632
- <dependency>
633
- <groupId>io.quarkus</groupId>
634
- <artifactId>quarkus-config-yaml</artifactId>
635
- </dependency>
636
-
637
- <!-- Camel Extensions -->
638
- <dependency>
639
- <groupId>org.apache.camel.quarkus</groupId>
640
- <artifactId>camel-quarkus-spring-rabbitmq</artifactId>
641
- </dependency>
642
- <dependency>
643
- <groupId>org.apache.camel.quarkus</groupId>
644
- <artifactId>camel-quarkus-direct</artifactId>
645
- </dependency>
646
- <dependency>
647
- <groupId>org.apache.camel.quarkus</groupId>
648
- <artifactId>camel-quarkus-bean</artifactId>
649
- </dependency>
650
-
651
- <!-- Lombok -->
652
- <dependency>
653
- <groupId>org.projectlombok</groupId>
654
- <artifactId>lombok</artifactId>
655
- <version>${lombok.version}</version>
656
- <scope>provided</scope>
657
- </dependency>
658
-
659
- <!-- Logging -->
660
- <dependency>
661
- <groupId>io.quarkiverse.logging.logback</groupId>
662
- <artifactId>quarkus-logging-logback</artifactId>
663
- </dependency>
664
- <dependency>
665
- <groupId>net.logstash.logback</groupId>
666
- <artifactId>logstash-logback-encoder</artifactId>
667
- </dependency>
668
- </dependencies>
669
- ```
670
-
671
- ## Best Practices
672
-
673
- ### Architecture
674
- - Use `@RequiredArgsConstructor` with Lombok for constructor injection
675
- - Keep service layer thin; delegate complex logic to specialized classes
676
- - Use Camel routes for message routing and integration patterns
677
- - Prefer Panache Repository pattern for data access
678
-
679
- ### Event-Driven
680
- - Always track operations with EventService (success/error events)
681
- - Use Camel `direct:` endpoints for in-memory routing
682
- - Use `spring-rabbitmq` component for RabbitMQ integration
683
- - Implement async publishing with `ProducerTemplate.asyncSendBody()`
684
-
685
- ### Logging
686
- - Use Logback with Logstash encoder for structured logging
687
- - Propagate LogContext through service calls with `SafeAutoCloseable`
688
- - Add contextual information to LogContext for request tracing
689
- - Use `@Slf4j` instead of manual logger instantiation
690
-
691
- ### Async Operations
692
- - Use CompletableFuture for non-blocking I/O operations
693
- - Call `.join()` when you need to wait for completion
694
- - Handle exceptions from CompletableFuture properly
695
- - Pass LogContext to async operations for tracing
696
-
697
- ### Configuration
698
- - Use YAML configuration (`quarkus-config-yaml`)
699
- - Profile-aware configuration for dev/test/prod environments
700
- - Externalize sensitive configuration to environment variables
701
- - Use `@ConfigProperty` for type-safe config injection
702
-
703
- ### Validation
704
- - Validate at resource layer with `@Valid`
705
- - Use Bean Validation annotations on DTOs
706
- - Map exceptions to proper HTTP responses with `@Provider`
707
-
708
- ### Transactions
709
- - Use `@Transactional` on service methods that modify data
710
- - Keep transactions short and focused
711
- - Avoid calling async operations within transactions
712
-
713
- ### Testing
714
- - Use `camel-quarkus-junit5` for route testing
715
- - Use AssertJ for assertions
716
- - Mock all external dependencies
717
- - Test conditional flow logic thoroughly
718
-
719
- ### Quarkus-Specific
720
- - Stay on latest LTS version (3.x)
721
- - Use Quarkus dev mode for hot reload
722
- - Add health checks for production readiness
723
- - Test native compilation compatibility periodically
1
+ ---
2
+ name: quarkus-patterns
3
+ description: Quarkus 3.x LTS architecture patterns with Camel for messaging, RESTful API design, CDI services, data access with Panache, and async processing. Use for Java Quarkus backend work with event-driven architectures.
4
+ metadata:
5
+ origin: ECC
6
+ ---
7
+
8
+ # Quarkus Development Patterns
9
+
10
+ Quarkus 3.x architecture and API patterns for cloud-native, event-driven services with Apache Camel.
11
+
12
+ ## When to Activate
13
+
14
+ - Building REST APIs with JAX-RS or RESTEasy Reactive
15
+ - Structuring resource → service → repository layers
16
+ - Implementing event-driven patterns with Apache Camel and RabbitMQ
17
+ - Configuring Hibernate Panache, caching, or reactive streams
18
+ - Adding validation, exception mapping, or pagination
19
+ - Setting up profiles for dev/staging/production environments (YAML config)
20
+ - Custom logging with LogContext and Logback/Logstash encoder
21
+ - Working with CompletableFuture for async operations
22
+ - Implementing conditional flow processing
23
+ - Working with GraalVM native compilation
24
+
25
+ ## Service Layer with Multiple Dependencies
26
+
27
+ ```java
28
+ @Slf4j
29
+ @ApplicationScoped
30
+ @RequiredArgsConstructor
31
+ public class OrderProcessingService {
32
+
33
+ private final OrderValidator orderValidator;
34
+ private final EventService eventService;
35
+ private final OrderRepository orderRepository;
36
+ private final FulfillmentPublisher fulfillmentPublisher;
37
+ private final AuditPublisher auditPublisher;
38
+
39
+ @Transactional
40
+ public OrderReceipt process(CreateOrderCommand command) {
41
+ ValidationResult validation = orderValidator.validate(command);
42
+ if (!validation.valid()) {
43
+ eventService.createErrorEvent(command, "ORDER_REJECTED", validation.message());
44
+ throw new WebApplicationException(validation.message(), Response.Status.BAD_REQUEST);
45
+ }
46
+
47
+ Order order = Order.from(command);
48
+ orderRepository.persist(order);
49
+
50
+ OrderReceipt receipt = OrderReceipt.from(order);
51
+ fulfillmentPublisher.publishAsync(receipt);
52
+ auditPublisher.publish("ORDER_ACCEPTED", receipt);
53
+ eventService.createSuccessEvent(receipt, "ORDER_ACCEPTED");
54
+
55
+ log.info("Processed order {}", order.id);
56
+ return receipt;
57
+ }
58
+ }
59
+ ```
60
+
61
+ **Key Patterns:**
62
+ - `@RequiredArgsConstructor` for constructor injection via Lombok
63
+ - `@Slf4j` for Logback logging
64
+ - `@Transactional` on service methods that write through Panache or repositories
65
+ - Validate input before persistence or message publication
66
+ - Event tracking for success/error scenarios
67
+ - Async Camel message publishing
68
+
69
+ ## Custom Logging Context Pattern (Logback)
70
+
71
+ ```java
72
+ @ApplicationScoped
73
+ public class ProcessingService {
74
+
75
+ public void processDocument(Document doc) {
76
+ LogContext logContext = CustomLog.getCurrentContext();
77
+ try (SafeAutoCloseable ignored = CustomLog.startScope(logContext)) {
78
+ // Add context to all log statements
79
+ logContext.put("documentId", doc.getId().toString());
80
+ logContext.put("documentType", doc.getType());
81
+ logContext.put("userId", SecurityContext.getUserId());
82
+
83
+ log.info("Starting document processing");
84
+
85
+ // All logs within this scope inherit the context
86
+ processInternal(doc);
87
+
88
+ log.info("Document processing completed");
89
+ } catch (Exception e) {
90
+ log.error("Document processing failed", e);
91
+ throw e;
92
+ }
93
+ }
94
+ }
95
+ ```
96
+
97
+ **Logback Configuration (logback.xml):**
98
+
99
+ ```xml
100
+ <configuration>
101
+ <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
102
+ <encoder class="net.logstash.logback.encoder.LogstashEncoder">
103
+ <includeContext>true</includeContext>
104
+ <includeMdc>true</includeMdc>
105
+ </encoder>
106
+ </appender>
107
+
108
+ <logger name="com.example" level="INFO"/>
109
+ <root level="WARN">
110
+ <appender-ref ref="CONSOLE"/>
111
+ </root>
112
+ </configuration>
113
+ ```
114
+
115
+ ## Event Service Pattern
116
+
117
+ ```java
118
+ @Slf4j
119
+ @ApplicationScoped
120
+ @RequiredArgsConstructor
121
+ public class EventService {
122
+ private final EventRepository eventRepository;
123
+ private final ObjectMapper objectMapper;
124
+
125
+ public void createSuccessEvent(Object payload, String eventType) {
126
+ Objects.requireNonNull(payload, "Payload cannot be null");
127
+ Event event = new Event();
128
+ event.setType(eventType);
129
+ event.setStatus(EventStatus.SUCCESS);
130
+ event.setPayload(serializePayload(payload));
131
+ event.setTimestamp(Instant.now());
132
+
133
+ eventRepository.persist(event);
134
+ log.info("Success event created: {}", eventType);
135
+ }
136
+
137
+ public void createErrorEvent(Object payload, String eventType, String errorMessage) {
138
+ Objects.requireNonNull(payload, "Payload cannot be null");
139
+ if (errorMessage == null || errorMessage.isBlank()) {
140
+ throw new IllegalArgumentException("Error message cannot be blank");
141
+ }
142
+ Event event = new Event();
143
+ event.setType(eventType);
144
+ event.setStatus(EventStatus.ERROR);
145
+ event.setErrorMessage(errorMessage);
146
+ event.setPayload(serializePayload(payload));
147
+ event.setTimestamp(Instant.now());
148
+
149
+ eventRepository.persist(event);
150
+ log.error("Error event created: {} - {}", eventType, errorMessage);
151
+ }
152
+
153
+ private String serializePayload(Object payload) {
154
+ try {
155
+ return objectMapper.writeValueAsString(payload);
156
+ } catch (JsonProcessingException e) {
157
+ throw new IllegalStateException("Failed to serialize event payload", e);
158
+ }
159
+ }
160
+ }
161
+ ```
162
+
163
+ ## Camel Message Publishing (RabbitMQ)
164
+
165
+ ```java
166
+ @Slf4j
167
+ @ApplicationScoped
168
+ @RequiredArgsConstructor
169
+ public class BusinessRulesPublisher {
170
+ private final ProducerTemplate producerTemplate;
171
+
172
+ public void publishSync(BusinessRulesPayload payload) {
173
+ producerTemplate.sendBody(
174
+ "direct:business-rules-publisher",
175
+ payload
176
+ );
177
+ }
178
+ }
179
+ ```
180
+
181
+ **Camel Route Configuration:**
182
+
183
+ ```java
184
+ @ApplicationScoped
185
+ public class BusinessRulesRoute extends RouteBuilder {
186
+
187
+ @ConfigProperty(name = "camel.rabbitmq.queue.business-rules")
188
+ String businessRulesQueue;
189
+
190
+ @ConfigProperty(name = "rabbitmq.host")
191
+ String rabbitHost;
192
+
193
+ @ConfigProperty(name = "rabbitmq.port")
194
+ Integer rabbitPort;
195
+
196
+ @Override
197
+ public void configure() {
198
+ from("direct:business-rules-publisher")
199
+ .routeId("business-rules-publisher")
200
+ .log("Publishing message to RabbitMQ: ${body}")
201
+ .marshal().json(JsonLibrary.Jackson)
202
+ .toF("spring-rabbitmq:%s?hostname=%s&portNumber=%d",
203
+ businessRulesQueue, rabbitHost, rabbitPort);
204
+ }
205
+ }
206
+ ```
207
+
208
+ ## Camel Direct Routes (In-Memory)
209
+
210
+ ```java
211
+ @ApplicationScoped
212
+ public class DocumentProcessingRoute extends RouteBuilder {
213
+
214
+ @Override
215
+ public void configure() {
216
+ // Error handling
217
+ onException(ValidationException.class)
218
+ .handled(true)
219
+ .to("direct:validation-error-handler")
220
+ .log("Validation error: ${exception.message}");
221
+
222
+ // Main processing route
223
+ from("direct:process-document")
224
+ .routeId("document-processing")
225
+ .log("Processing document: ${header.documentId}")
226
+ .bean(DocumentValidator.class, "validate")
227
+ .bean(DocumentTransformer.class, "transform")
228
+ .choice()
229
+ .when(header("documentType").isEqualTo("INVOICE"))
230
+ .to("direct:process-invoice")
231
+ .when(header("documentType").isEqualTo("CREDIT_NOTE"))
232
+ .to("direct:process-credit-note")
233
+ .otherwise()
234
+ .to("direct:process-generic")
235
+ .end();
236
+
237
+ from("direct:validation-error-handler")
238
+ .bean(EventService.class, "createErrorEvent")
239
+ .log("Validation error handled");
240
+ }
241
+ }
242
+ ```
243
+
244
+ ## Camel File Processing
245
+
246
+ ```java
247
+ @ApplicationScoped
248
+ public class FileMonitoringRoute extends RouteBuilder {
249
+
250
+ @ConfigProperty(name = "file.input.directory")
251
+ String inputDirectory;
252
+
253
+ @ConfigProperty(name = "file.processed.directory")
254
+ String processedDirectory;
255
+
256
+ @ConfigProperty(name = "file.error.directory")
257
+ String errorDirectory;
258
+
259
+ @Override
260
+ public void configure() {
261
+ from("file:" + inputDirectory + "?move=" + processedDirectory +
262
+ "&moveFailed=" + errorDirectory + "&delay=5000")
263
+ .routeId("file-monitor")
264
+ .log("Processing file: ${header.CamelFileName}")
265
+ .to("direct:process-file");
266
+
267
+ from("direct:process-file")
268
+ .bean(OrderProcessingService.class, "processFile")
269
+ .log("File processing completed");
270
+ }
271
+ }
272
+ ```
273
+
274
+ ## Camel Bean Invocation
275
+
276
+ ```java
277
+ @ApplicationScoped
278
+ public class InvoiceRoute extends RouteBuilder {
279
+
280
+ @Override
281
+ public void configure() {
282
+ from("direct:invoice-validation")
283
+ .bean(InvoiceFlowValidator.class, "validateFlowWithConfig")
284
+ .log("Validation result: ${body}");
285
+
286
+ from("direct:persist-and-publish")
287
+ .bean(DocumentJobService.class, "createDocumentAndJobEntities")
288
+ .bean(BusinessRulesPublisher.class, "publishAsync")
289
+ .bean(EventService.class, "createSuccessEvent(${body}, 'PUBLISHED')");
290
+ }
291
+ }
292
+ ```
293
+
294
+ ## REST API Structure
295
+
296
+ ```java
297
+ @Path("/api/documents")
298
+ @Produces(MediaType.APPLICATION_JSON)
299
+ @Consumes(MediaType.APPLICATION_JSON)
300
+ @RequiredArgsConstructor
301
+ public class DocumentResource {
302
+ private final DocumentService documentService;
303
+
304
+ @GET
305
+ public Response list(
306
+ @QueryParam("page") @DefaultValue("0") int page,
307
+ @QueryParam("size") @DefaultValue("20") int size) {
308
+ List<Document> documents = documentService.list(page, size);
309
+ return Response.ok(documents).build();
310
+ }
311
+
312
+ @POST
313
+ public Response create(@Valid CreateDocumentRequest request, @Context UriInfo uriInfo) {
314
+ Document document = documentService.create(request);
315
+ URI location = uriInfo.getAbsolutePathBuilder()
316
+ .path(String.valueOf(document.id))
317
+ .build();
318
+ return Response.created(location).entity(DocumentResponse.from(document)).build();
319
+ }
320
+
321
+ @GET
322
+ @Path("/{id}")
323
+ public Response getById(@PathParam("id") Long id) {
324
+ return documentService.findById(id)
325
+ .map(DocumentResponse::from)
326
+ .map(Response::ok)
327
+ .orElse(Response.status(Response.Status.NOT_FOUND))
328
+ .build();
329
+ }
330
+ }
331
+ ```
332
+
333
+ ## Repository Pattern (Panache Repository)
334
+
335
+ ```java
336
+ @ApplicationScoped
337
+ public class DocumentRepository implements PanacheRepository<Document> {
338
+
339
+ public List<Document> findByStatus(DocumentStatus status, int page, int size) {
340
+ return find("status = ?1 order by createdAt desc", status)
341
+ .page(page, size)
342
+ .list();
343
+ }
344
+
345
+ public Optional<Document> findByReferenceNumber(String referenceNumber) {
346
+ return find("referenceNumber", referenceNumber).firstResultOptional();
347
+ }
348
+
349
+ public long countByStatusAndDate(DocumentStatus status, LocalDate date) {
350
+ return count("status = ?1 and createdAt >= ?2", status, date.atStartOfDay());
351
+ }
352
+ }
353
+ ```
354
+
355
+ ## Service Layer with Transactions
356
+
357
+ ```java
358
+ @ApplicationScoped
359
+ @RequiredArgsConstructor
360
+ public class DocumentService {
361
+ private final DocumentRepository repo;
362
+ private final EventService eventService;
363
+
364
+ @Transactional
365
+ public Document create(CreateDocumentRequest request) {
366
+ Document document = new Document();
367
+ document.setReferenceNumber(request.referenceNumber());
368
+ document.setDescription(request.description());
369
+ document.setStatus(DocumentStatus.PENDING);
370
+ document.setCreatedAt(Instant.now());
371
+
372
+ repo.persist(document);
373
+
374
+ eventService.createSuccessEvent(document, "DOCUMENT_CREATED");
375
+
376
+ return document;
377
+ }
378
+
379
+ public Optional<Document> findById(Long id) {
380
+ return repo.findByIdOptional(id);
381
+ }
382
+
383
+ public List<Document> list(int page, int size) {
384
+ return repo.findAll()
385
+ .page(page, size)
386
+ .list();
387
+ }
388
+ }
389
+ ```
390
+
391
+ ## DTOs and Validation
392
+
393
+ ```java
394
+ public record CreateDocumentRequest(
395
+ @NotBlank @Size(max = 200) String referenceNumber,
396
+ @NotBlank @Size(max = 2000) String description,
397
+ @NotNull @FutureOrPresent Instant validUntil,
398
+ @NotEmpty List<@NotBlank String> categories) {}
399
+
400
+ public record DocumentResponse(Long id, String referenceNumber, DocumentStatus status) {
401
+ public static DocumentResponse from(Document document) {
402
+ return new DocumentResponse(document.getId(), document.getReferenceNumber(),
403
+ document.getStatus());
404
+ }
405
+ }
406
+ ```
407
+
408
+ ## Exception Mapping
409
+
410
+ ```java
411
+ @Provider
412
+ public class ValidationExceptionMapper implements ExceptionMapper<ConstraintViolationException> {
413
+ @Override
414
+ public Response toResponse(ConstraintViolationException exception) {
415
+ String message = exception.getConstraintViolations().stream()
416
+ .map(cv -> cv.getPropertyPath() + ": " + cv.getMessage())
417
+ .collect(Collectors.joining(", "));
418
+
419
+ return Response.status(Response.Status.BAD_REQUEST)
420
+ .entity(Map.of("error", "validation_error", "message", message))
421
+ .build();
422
+ }
423
+ }
424
+
425
+ @Provider
426
+ @Slf4j
427
+ public class GenericExceptionMapper implements ExceptionMapper<Exception> {
428
+
429
+ @Override
430
+ public Response toResponse(Exception exception) {
431
+ log.error("Unhandled exception", exception);
432
+ return Response.status(Response.Status.INTERNAL_SERVER_ERROR)
433
+ .entity(Map.of("error", "internal_error", "message", "An unexpected error occurred"))
434
+ .build();
435
+ }
436
+ }
437
+ ```
438
+
439
+ ## CompletableFuture Async Operations
440
+
441
+ ```java
442
+ @Slf4j
443
+ @ApplicationScoped
444
+ @RequiredArgsConstructor
445
+ public class FileStorageService {
446
+ private final S3Client s3Client;
447
+ private final ExecutorService executorService;
448
+
449
+ @ConfigProperty(name = "storage.bucket-name")
450
+ String bucketName;
451
+
452
+ public CompletableFuture<StoredDocumentInfo> uploadOriginalFile(
453
+ InputStream inputStream,
454
+ long size,
455
+ LogContext logContext,
456
+ InvoiceFormat format) {
457
+
458
+ return CompletableFuture.supplyAsync(() -> {
459
+ try (SafeAutoCloseable ignored = CustomLog.startScope(logContext)) {
460
+ String path = generateStoragePath(format);
461
+
462
+ PutObjectRequest request = PutObjectRequest.builder()
463
+ .bucket(bucketName)
464
+ .key(path)
465
+ .contentLength(size)
466
+ .build();
467
+
468
+ s3Client.putObject(request, RequestBody.fromInputStream(inputStream, size));
469
+
470
+ log.info("File uploaded to S3: {}", path);
471
+
472
+ return new StoredDocumentInfo(path, size, Instant.now());
473
+ } catch (Exception e) {
474
+ log.error("Failed to upload file to S3", e);
475
+ throw new StorageException("Upload failed", e);
476
+ }
477
+ }, executorService);
478
+ }
479
+ }
480
+ ```
481
+
482
+ ## Caching
483
+
484
+ ```java
485
+ @ApplicationScoped
486
+ @RequiredArgsConstructor
487
+ public class DocumentCacheService {
488
+ private final DocumentRepository repo;
489
+
490
+ @CacheResult(cacheName = "document-cache")
491
+ public Optional<Document> getById(@CacheKey Long id) {
492
+ return repo.findByIdOptional(id);
493
+ }
494
+
495
+ @CacheInvalidate(cacheName = "document-cache")
496
+ public void evict(@CacheKey Long id) {}
497
+
498
+ @CacheInvalidateAll(cacheName = "document-cache")
499
+ public void evictAll() {}
500
+ }
501
+ ```
502
+
503
+ ## Configuration as YAML
504
+
505
+ ```yaml
506
+ # application.yml
507
+ "%dev":
508
+ quarkus:
509
+ datasource:
510
+ jdbc:
511
+ url: jdbc:postgresql://localhost:5432/dev_db
512
+ username: dev_user
513
+ password: ${DB_PASSWORD}
514
+ hibernate-orm:
515
+ database:
516
+ generation: drop-and-create
517
+
518
+ rabbitmq:
519
+ host: localhost
520
+ port: 5672
521
+ username: ${RABBITMQ_USER}
522
+ password: ${RABBITMQ_PASSWORD}
523
+
524
+ "%test":
525
+ quarkus:
526
+ datasource:
527
+ jdbc:
528
+ url: jdbc:h2:mem:test
529
+ hibernate-orm:
530
+ database:
531
+ generation: drop-and-create
532
+
533
+ "%prod":
534
+ quarkus:
535
+ datasource:
536
+ jdbc:
537
+ url: ${DATABASE_URL}
538
+ username: ${DB_USER}
539
+ password: ${DB_PASSWORD}
540
+ hibernate-orm:
541
+ database:
542
+ generation: validate
543
+
544
+ rabbitmq:
545
+ host: ${RABBITMQ_HOST}
546
+ port: ${RABBITMQ_PORT}
547
+ username: ${RABBITMQ_USER}
548
+ password: ${RABBITMQ_PASSWORD}
549
+
550
+ # Camel configuration
551
+ camel:
552
+ rabbitmq:
553
+ queue:
554
+ business-rules: business-rules-queue
555
+ invoice-processing: invoice-processing-queue
556
+ ```
557
+
558
+ ## Health Checks
559
+
560
+ ```java
561
+ @Readiness
562
+ @ApplicationScoped
563
+ @RequiredArgsConstructor
564
+ public class DatabaseHealthCheck implements HealthCheck {
565
+ private final AgroalDataSource dataSource;
566
+
567
+ @Override
568
+ public HealthCheckResponse call() {
569
+ try (Connection conn = dataSource.getConnection()) {
570
+ boolean valid = conn.isValid(2);
571
+ return HealthCheckResponse.named("Database connection")
572
+ .status(valid)
573
+ .build();
574
+ } catch (SQLException e) {
575
+ return HealthCheckResponse.down("Database connection");
576
+ }
577
+ }
578
+ }
579
+
580
+ @Liveness
581
+ @ApplicationScoped
582
+ public class CamelHealthCheck implements HealthCheck {
583
+ @Inject
584
+ CamelContext camelContext;
585
+
586
+ @Override
587
+ public HealthCheckResponse call() {
588
+ boolean isStarted = camelContext.getStatus().isStarted();
589
+ return HealthCheckResponse.named("Camel Context")
590
+ .status(isStarted)
591
+ .build();
592
+ }
593
+ }
594
+ ```
595
+
596
+ ## Dependencies (Maven)
597
+
598
+ ```xml
599
+ <properties>
600
+ <quarkus.platform.version>3.27.0</quarkus.platform.version>
601
+ <lombok.version>1.18.42</lombok.version>
602
+ <assertj-core.version>3.24.2</assertj-core.version>
603
+ <jacoco-maven-plugin.version>0.8.13</jacoco-maven-plugin.version>
604
+ <maven.compiler.release>17</maven.compiler.release>
605
+ </properties>
606
+
607
+ <dependencyManagement>
608
+ <dependencies>
609
+ <dependency>
610
+ <groupId>io.quarkus.platform</groupId>
611
+ <artifactId>quarkus-bom</artifactId>
612
+ <version>${quarkus.platform.version}</version>
613
+ <type>pom</type>
614
+ <scope>import</scope>
615
+ </dependency>
616
+ <dependency>
617
+ <groupId>io.quarkus.platform</groupId>
618
+ <artifactId>quarkus-camel-bom</artifactId>
619
+ <version>${quarkus.platform.version}</version>
620
+ <type>pom</type>
621
+ <scope>import</scope>
622
+ </dependency>
623
+ </dependencies>
624
+ </dependencyManagement>
625
+
626
+ <dependencies>
627
+ <!-- Quarkus Core -->
628
+ <dependency>
629
+ <groupId>io.quarkus</groupId>
630
+ <artifactId>quarkus-arc</artifactId>
631
+ </dependency>
632
+ <dependency>
633
+ <groupId>io.quarkus</groupId>
634
+ <artifactId>quarkus-config-yaml</artifactId>
635
+ </dependency>
636
+
637
+ <!-- Camel Extensions -->
638
+ <dependency>
639
+ <groupId>org.apache.camel.quarkus</groupId>
640
+ <artifactId>camel-quarkus-spring-rabbitmq</artifactId>
641
+ </dependency>
642
+ <dependency>
643
+ <groupId>org.apache.camel.quarkus</groupId>
644
+ <artifactId>camel-quarkus-direct</artifactId>
645
+ </dependency>
646
+ <dependency>
647
+ <groupId>org.apache.camel.quarkus</groupId>
648
+ <artifactId>camel-quarkus-bean</artifactId>
649
+ </dependency>
650
+
651
+ <!-- Lombok -->
652
+ <dependency>
653
+ <groupId>org.projectlombok</groupId>
654
+ <artifactId>lombok</artifactId>
655
+ <version>${lombok.version}</version>
656
+ <scope>provided</scope>
657
+ </dependency>
658
+
659
+ <!-- Logging -->
660
+ <dependency>
661
+ <groupId>io.quarkiverse.logging.logback</groupId>
662
+ <artifactId>quarkus-logging-logback</artifactId>
663
+ </dependency>
664
+ <dependency>
665
+ <groupId>net.logstash.logback</groupId>
666
+ <artifactId>logstash-logback-encoder</artifactId>
667
+ </dependency>
668
+ </dependencies>
669
+ ```
670
+
671
+ ## Best Practices
672
+
673
+ ### Architecture
674
+ - Use `@RequiredArgsConstructor` with Lombok for constructor injection
675
+ - Keep service layer thin; delegate complex logic to specialized classes
676
+ - Use Camel routes for message routing and integration patterns
677
+ - Prefer Panache Repository pattern for data access
678
+
679
+ ### Event-Driven
680
+ - Always track operations with EventService (success/error events)
681
+ - Use Camel `direct:` endpoints for in-memory routing
682
+ - Use `spring-rabbitmq` component for RabbitMQ integration
683
+ - Implement async publishing with `ProducerTemplate.asyncSendBody()`
684
+
685
+ ### Logging
686
+ - Use Logback with Logstash encoder for structured logging
687
+ - Propagate LogContext through service calls with `SafeAutoCloseable`
688
+ - Add contextual information to LogContext for request tracing
689
+ - Use `@Slf4j` instead of manual logger instantiation
690
+
691
+ ### Async Operations
692
+ - Use CompletableFuture for non-blocking I/O operations
693
+ - Call `.join()` when you need to wait for completion
694
+ - Handle exceptions from CompletableFuture properly
695
+ - Pass LogContext to async operations for tracing
696
+
697
+ ### Configuration
698
+ - Use YAML configuration (`quarkus-config-yaml`)
699
+ - Profile-aware configuration for dev/test/prod environments
700
+ - Externalize sensitive configuration to environment variables
701
+ - Use `@ConfigProperty` for type-safe config injection
702
+
703
+ ### Validation
704
+ - Validate at resource layer with `@Valid`
705
+ - Use Bean Validation annotations on DTOs
706
+ - Map exceptions to proper HTTP responses with `@Provider`
707
+
708
+ ### Transactions
709
+ - Use `@Transactional` on service methods that modify data
710
+ - Keep transactions short and focused
711
+ - Avoid calling async operations within transactions
712
+
713
+ ### Testing
714
+ - Use `camel-quarkus-junit5` for route testing
715
+ - Use AssertJ for assertions
716
+ - Mock all external dependencies
717
+ - Test conditional flow logic thoroughly
718
+
719
+ ### Quarkus-Specific
720
+ - Stay on latest LTS version (3.x)
721
+ - Use Quarkus dev mode for hot reload
722
+ - Add health checks for production readiness
723
+ - Test native compilation compatibility periodically