nodejs-structure-cli 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (243) hide show
  1. package/README.md +32 -0
  2. package/bin/index.js +143 -0
  3. package/lib/generator.js +145 -0
  4. package/lib/modules/app-setup.js +479 -0
  5. package/lib/modules/caching-setup.js +76 -0
  6. package/lib/modules/config-files.js +151 -0
  7. package/lib/modules/database-setup.js +116 -0
  8. package/lib/modules/kafka-setup.js +249 -0
  9. package/lib/modules/project-setup.js +32 -0
  10. package/lib/prompts.js +128 -0
  11. package/package.json +66 -0
  12. package/templates/clean-architecture/js/src/domain/models/User.js.ejs +11 -0
  13. package/templates/clean-architecture/js/src/errors/ApiError.js +14 -0
  14. package/templates/clean-architecture/js/src/errors/BadRequestError.js +11 -0
  15. package/templates/clean-architecture/js/src/errors/BadRequestError.spec.js.ejs +22 -0
  16. package/templates/clean-architecture/js/src/errors/NotFoundError.js +11 -0
  17. package/templates/clean-architecture/js/src/errors/NotFoundError.spec.js.ejs +22 -0
  18. package/templates/clean-architecture/js/src/index.js.ejs +56 -0
  19. package/templates/clean-architecture/js/src/infrastructure/config/env.js.ejs +47 -0
  20. package/templates/clean-architecture/js/src/infrastructure/log/logger.js +36 -0
  21. package/templates/clean-architecture/js/src/infrastructure/log/logger.spec.js.ejs +63 -0
  22. package/templates/clean-architecture/js/src/infrastructure/repositories/UserRepository.js.ejs +88 -0
  23. package/templates/clean-architecture/js/src/infrastructure/repositories/UserRepository.spec.js.ejs +142 -0
  24. package/templates/clean-architecture/js/src/infrastructure/webserver/middleware/errorMiddleware.js +30 -0
  25. package/templates/clean-architecture/js/src/infrastructure/webserver/server.js.ejs +93 -0
  26. package/templates/clean-architecture/js/src/infrastructure/webserver/swagger.js.ejs +6 -0
  27. package/templates/clean-architecture/js/src/interfaces/controllers/userController.js.ejs +190 -0
  28. package/templates/clean-architecture/js/src/interfaces/controllers/userController.spec.js.ejs +234 -0
  29. package/templates/clean-architecture/js/src/interfaces/graphql/context.js.ejs +13 -0
  30. package/templates/clean-architecture/js/src/interfaces/graphql/context.spec.js.ejs +31 -0
  31. package/templates/clean-architecture/js/src/interfaces/graphql/index.js.ejs +5 -0
  32. package/templates/clean-architecture/js/src/interfaces/graphql/resolvers/index.js.ejs +6 -0
  33. package/templates/clean-architecture/js/src/interfaces/graphql/resolvers/user.resolvers.js.ejs +27 -0
  34. package/templates/clean-architecture/js/src/interfaces/graphql/resolvers/user.resolvers.spec.js.ejs +66 -0
  35. package/templates/clean-architecture/js/src/interfaces/graphql/typeDefs/index.js.ejs +6 -0
  36. package/templates/clean-architecture/js/src/interfaces/graphql/typeDefs/user.types.js.ejs +19 -0
  37. package/templates/clean-architecture/js/src/interfaces/routes/api.js.ejs +17 -0
  38. package/templates/clean-architecture/js/src/interfaces/routes/api.spec.js.ejs +38 -0
  39. package/templates/clean-architecture/js/src/usecases/CreateUser.js.ejs +14 -0
  40. package/templates/clean-architecture/js/src/usecases/CreateUser.spec.js.ejs +51 -0
  41. package/templates/clean-architecture/js/src/usecases/DeleteUser.js +11 -0
  42. package/templates/clean-architecture/js/src/usecases/DeleteUser.spec.js.ejs +47 -0
  43. package/templates/clean-architecture/js/src/usecases/GetAllUsers.js +12 -0
  44. package/templates/clean-architecture/js/src/usecases/GetAllUsers.spec.js.ejs +61 -0
  45. package/templates/clean-architecture/js/src/usecases/UpdateUser.js.ejs +11 -0
  46. package/templates/clean-architecture/js/src/usecases/UpdateUser.spec.js.ejs +48 -0
  47. package/templates/clean-architecture/js/src/utils/errorMessages.js +14 -0
  48. package/templates/clean-architecture/js/src/utils/httpCodes.js +9 -0
  49. package/templates/clean-architecture/ts/src/config/env.ts.ejs +46 -0
  50. package/templates/clean-architecture/ts/src/config/swagger.ts.ejs +6 -0
  51. package/templates/clean-architecture/ts/src/domain/user.ts.ejs +9 -0
  52. package/templates/clean-architecture/ts/src/errors/ApiError.ts +15 -0
  53. package/templates/clean-architecture/ts/src/errors/BadRequestError.spec.ts.ejs +22 -0
  54. package/templates/clean-architecture/ts/src/errors/BadRequestError.ts +9 -0
  55. package/templates/clean-architecture/ts/src/errors/NotFoundError.spec.ts.ejs +22 -0
  56. package/templates/clean-architecture/ts/src/errors/NotFoundError.ts +9 -0
  57. package/templates/clean-architecture/ts/src/index.ts.ejs +144 -0
  58. package/templates/clean-architecture/ts/src/infrastructure/log/logger.spec.ts.ejs +63 -0
  59. package/templates/clean-architecture/ts/src/infrastructure/log/logger.ts +36 -0
  60. package/templates/clean-architecture/ts/src/infrastructure/repositories/UserRepository.spec.ts.ejs +175 -0
  61. package/templates/clean-architecture/ts/src/infrastructure/repositories/userRepository.ts.ejs +125 -0
  62. package/templates/clean-architecture/ts/src/interfaces/controllers/userController.spec.ts.ejs +331 -0
  63. package/templates/clean-architecture/ts/src/interfaces/controllers/userController.ts.ejs +208 -0
  64. package/templates/clean-architecture/ts/src/interfaces/graphql/context.spec.ts.ejs +32 -0
  65. package/templates/clean-architecture/ts/src/interfaces/graphql/context.ts.ejs +17 -0
  66. package/templates/clean-architecture/ts/src/interfaces/graphql/index.ts.ejs +3 -0
  67. package/templates/clean-architecture/ts/src/interfaces/graphql/resolvers/index.ts.ejs +4 -0
  68. package/templates/clean-architecture/ts/src/interfaces/graphql/resolvers/user.resolvers.spec.ts.ejs +68 -0
  69. package/templates/clean-architecture/ts/src/interfaces/graphql/resolvers/user.resolvers.ts.ejs +29 -0
  70. package/templates/clean-architecture/ts/src/interfaces/graphql/typeDefs/index.ts.ejs +4 -0
  71. package/templates/clean-architecture/ts/src/interfaces/graphql/typeDefs/user.types.ts.ejs +17 -0
  72. package/templates/clean-architecture/ts/src/interfaces/routes/userRoutes.spec.ts.ejs +40 -0
  73. package/templates/clean-architecture/ts/src/interfaces/routes/userRoutes.ts.ejs +18 -0
  74. package/templates/clean-architecture/ts/src/usecases/createUser.spec.ts.ejs +51 -0
  75. package/templates/clean-architecture/ts/src/usecases/createUser.ts.ejs +11 -0
  76. package/templates/clean-architecture/ts/src/usecases/deleteUser.spec.ts.ejs +47 -0
  77. package/templates/clean-architecture/ts/src/usecases/deleteUser.ts +9 -0
  78. package/templates/clean-architecture/ts/src/usecases/getAllUsers.spec.ts.ejs +63 -0
  79. package/templates/clean-architecture/ts/src/usecases/getAllUsers.ts +10 -0
  80. package/templates/clean-architecture/ts/src/usecases/updateUser.spec.ts.ejs +48 -0
  81. package/templates/clean-architecture/ts/src/usecases/updateUser.ts.ejs +10 -0
  82. package/templates/clean-architecture/ts/src/utils/errorMessages.ts +12 -0
  83. package/templates/clean-architecture/ts/src/utils/errorMiddleware.ts.ejs +27 -0
  84. package/templates/clean-architecture/ts/src/utils/httpCodes.ts +7 -0
  85. package/templates/common/.cursorrules.ejs +60 -0
  86. package/templates/common/.dockerignore +12 -0
  87. package/templates/common/.env.example.ejs +60 -0
  88. package/templates/common/.gitattributes +46 -0
  89. package/templates/common/.gitlab-ci.yml.ejs +86 -0
  90. package/templates/common/.lintstagedrc +6 -0
  91. package/templates/common/.prettierrc +7 -0
  92. package/templates/common/.snyk.ejs +45 -0
  93. package/templates/common/Dockerfile +73 -0
  94. package/templates/common/Jenkinsfile.ejs +87 -0
  95. package/templates/common/README.md.ejs +148 -0
  96. package/templates/common/_github/workflows/ci.yml.ejs +46 -0
  97. package/templates/common/_github/workflows/security.yml.ejs +36 -0
  98. package/templates/common/_gitignore +5 -0
  99. package/templates/common/_husky/pre-commit +4 -0
  100. package/templates/common/caching/clean/js/CreateUser.js.ejs +29 -0
  101. package/templates/common/caching/clean/js/DeleteUser.js.ejs +27 -0
  102. package/templates/common/caching/clean/js/GetAllUsers.js.ejs +37 -0
  103. package/templates/common/caching/clean/js/UpdateUser.js.ejs +27 -0
  104. package/templates/common/caching/clean/ts/createUser.ts.ejs +27 -0
  105. package/templates/common/caching/clean/ts/deleteUser.ts.ejs +24 -0
  106. package/templates/common/caching/clean/ts/getAllUsers.ts.ejs +34 -0
  107. package/templates/common/caching/clean/ts/updateUser.ts.ejs +25 -0
  108. package/templates/common/caching/js/memoryCache.js.ejs +60 -0
  109. package/templates/common/caching/js/memoryCache.spec.js.ejs +101 -0
  110. package/templates/common/caching/js/redisClient.js.ejs +75 -0
  111. package/templates/common/caching/js/redisClient.spec.js.ejs +147 -0
  112. package/templates/common/caching/ts/memoryCache.spec.ts.ejs +102 -0
  113. package/templates/common/caching/ts/memoryCache.ts.ejs +73 -0
  114. package/templates/common/caching/ts/redisClient.spec.ts.ejs +157 -0
  115. package/templates/common/caching/ts/redisClient.ts.ejs +89 -0
  116. package/templates/common/database/js/database.js.ejs +19 -0
  117. package/templates/common/database/js/database.spec.js.ejs +56 -0
  118. package/templates/common/database/js/models/User.js.ejs +91 -0
  119. package/templates/common/database/js/models/User.js.mongoose.ejs +35 -0
  120. package/templates/common/database/js/models/User.spec.js.ejs +94 -0
  121. package/templates/common/database/js/mongoose.js.ejs +33 -0
  122. package/templates/common/database/js/mongoose.spec.js.ejs +43 -0
  123. package/templates/common/database/ts/database.spec.ts.ejs +56 -0
  124. package/templates/common/database/ts/database.ts.ejs +21 -0
  125. package/templates/common/database/ts/models/User.spec.ts.ejs +100 -0
  126. package/templates/common/database/ts/models/User.ts.ejs +102 -0
  127. package/templates/common/database/ts/models/User.ts.mongoose.ejs +34 -0
  128. package/templates/common/database/ts/mongoose.spec.ts.ejs +42 -0
  129. package/templates/common/database/ts/mongoose.ts.ejs +28 -0
  130. package/templates/common/docker-compose.yml.ejs +159 -0
  131. package/templates/common/ecosystem.config.js.ejs +40 -0
  132. package/templates/common/eslint.config.mjs.ejs +77 -0
  133. package/templates/common/health/js/healthRoute.js.ejs +50 -0
  134. package/templates/common/health/js/healthRoute.spec.js.ejs +70 -0
  135. package/templates/common/health/ts/healthRoute.spec.ts.ejs +76 -0
  136. package/templates/common/health/ts/healthRoute.ts.ejs +49 -0
  137. package/templates/common/jest.config.js.ejs +32 -0
  138. package/templates/common/jest.e2e.config.js.ejs +8 -0
  139. package/templates/common/kafka/js/config/kafka.js +9 -0
  140. package/templates/common/kafka/js/config/kafka.spec.js.ejs +27 -0
  141. package/templates/common/kafka/js/messaging/baseConsumer.js.ejs +30 -0
  142. package/templates/common/kafka/js/messaging/baseConsumer.spec.js.ejs +58 -0
  143. package/templates/common/kafka/js/messaging/userEventSchema.js.ejs +12 -0
  144. package/templates/common/kafka/js/messaging/userEventSchema.spec.js.ejs +27 -0
  145. package/templates/common/kafka/js/messaging/welcomeEmailConsumer.js.ejs +44 -0
  146. package/templates/common/kafka/js/messaging/welcomeEmailConsumer.spec.js.ejs +86 -0
  147. package/templates/common/kafka/js/services/kafkaService.js.ejs +93 -0
  148. package/templates/common/kafka/js/services/kafkaService.spec.js.ejs +106 -0
  149. package/templates/common/kafka/js/utils/kafkaEvents.js.ejs +7 -0
  150. package/templates/common/kafka/ts/config/kafka.spec.ts.ejs +27 -0
  151. package/templates/common/kafka/ts/config/kafka.ts +7 -0
  152. package/templates/common/kafka/ts/messaging/baseConsumer.spec.ts.ejs +50 -0
  153. package/templates/common/kafka/ts/messaging/baseConsumer.ts.ejs +27 -0
  154. package/templates/common/kafka/ts/messaging/userEventSchema.spec.ts.ejs +51 -0
  155. package/templates/common/kafka/ts/messaging/userEventSchema.ts.ejs +12 -0
  156. package/templates/common/kafka/ts/messaging/welcomeEmailConsumer.spec.ts.ejs +86 -0
  157. package/templates/common/kafka/ts/messaging/welcomeEmailConsumer.ts.ejs +38 -0
  158. package/templates/common/kafka/ts/services/kafkaService.spec.ts.ejs +81 -0
  159. package/templates/common/kafka/ts/services/kafkaService.ts.ejs +95 -0
  160. package/templates/common/kafka/ts/utils/kafkaEvents.ts.ejs +5 -0
  161. package/templates/common/migrate-mongo-config.js.ejs +31 -0
  162. package/templates/common/migrations/init.js.ejs +23 -0
  163. package/templates/common/package.json.ejs +137 -0
  164. package/templates/common/prompts/add-feature.md.ejs +26 -0
  165. package/templates/common/prompts/project-context.md.ejs +43 -0
  166. package/templates/common/prompts/troubleshoot.md.ejs +28 -0
  167. package/templates/common/public/css/style.css +147 -0
  168. package/templates/common/scripts/run-e2e.js.ejs +63 -0
  169. package/templates/common/shutdown/js/gracefulShutdown.js.ejs +65 -0
  170. package/templates/common/shutdown/js/gracefulShutdown.spec.js.ejs +149 -0
  171. package/templates/common/shutdown/ts/gracefulShutdown.spec.ts.ejs +179 -0
  172. package/templates/common/shutdown/ts/gracefulShutdown.ts.ejs +59 -0
  173. package/templates/common/sonar-project.properties.ejs +27 -0
  174. package/templates/common/src/config/auth.js.ejs +19 -0
  175. package/templates/common/src/config/auth.ts.ejs +19 -0
  176. package/templates/common/src/controllers/authController.js.ejs +101 -0
  177. package/templates/common/src/controllers/authController.ts.ejs +101 -0
  178. package/templates/common/src/middleware/auth.js.ejs +20 -0
  179. package/templates/common/src/middleware/auth.ts.ejs +25 -0
  180. package/templates/common/src/middleware/upload.js.ejs +31 -0
  181. package/templates/common/src/middleware/upload.ts.ejs +32 -0
  182. package/templates/common/src/routes/authRoutes.js.ejs +20 -0
  183. package/templates/common/src/routes/authRoutes.ts.ejs +20 -0
  184. package/templates/common/src/tests/e2e/e2e.users.test.js.ejs +120 -0
  185. package/templates/common/src/tests/e2e/e2e.users.test.ts.ejs +120 -0
  186. package/templates/common/src/utils/errorMiddleware.spec.js.ejs +79 -0
  187. package/templates/common/src/utils/errorMiddleware.spec.ts.ejs +94 -0
  188. package/templates/common/swagger.yml.ejs +118 -0
  189. package/templates/common/tsconfig.json +23 -0
  190. package/templates/common/views/ejs/index.ejs +55 -0
  191. package/templates/common/views/pug/index.pug +40 -0
  192. package/templates/db/mysql/V1__Initial_Setup.sql.ejs +10 -0
  193. package/templates/db/postgres/V1__Initial_Setup.sql.ejs +10 -0
  194. package/templates/mvc/js/src/config/env.js.ejs +46 -0
  195. package/templates/mvc/js/src/config/swagger.js.ejs +6 -0
  196. package/templates/mvc/js/src/controllers/userController.js.ejs +288 -0
  197. package/templates/mvc/js/src/controllers/userController.spec.js.ejs +481 -0
  198. package/templates/mvc/js/src/errors/ApiError.js +14 -0
  199. package/templates/mvc/js/src/errors/BadRequestError.js +11 -0
  200. package/templates/mvc/js/src/errors/BadRequestError.spec.js.ejs +22 -0
  201. package/templates/mvc/js/src/errors/NotFoundError.js +11 -0
  202. package/templates/mvc/js/src/errors/NotFoundError.spec.js.ejs +22 -0
  203. package/templates/mvc/js/src/graphql/context.js.ejs +7 -0
  204. package/templates/mvc/js/src/graphql/context.spec.js.ejs +29 -0
  205. package/templates/mvc/js/src/graphql/index.js.ejs +5 -0
  206. package/templates/mvc/js/src/graphql/resolvers/index.js.ejs +6 -0
  207. package/templates/mvc/js/src/graphql/resolvers/user.resolvers.js.ejs +25 -0
  208. package/templates/mvc/js/src/graphql/resolvers/user.resolvers.spec.js.ejs +64 -0
  209. package/templates/mvc/js/src/graphql/typeDefs/index.js.ejs +6 -0
  210. package/templates/mvc/js/src/graphql/typeDefs/user.types.js.ejs +19 -0
  211. package/templates/mvc/js/src/index.js.ejs +141 -0
  212. package/templates/mvc/js/src/routes/api.js.ejs +15 -0
  213. package/templates/mvc/js/src/routes/api.spec.js.ejs +41 -0
  214. package/templates/mvc/js/src/utils/errorMessages.js +14 -0
  215. package/templates/mvc/js/src/utils/errorMiddleware.js +29 -0
  216. package/templates/mvc/js/src/utils/httpCodes.js +9 -0
  217. package/templates/mvc/js/src/utils/logger.js +40 -0
  218. package/templates/mvc/js/src/utils/logger.spec.js.ejs +63 -0
  219. package/templates/mvc/ts/src/config/env.ts.ejs +45 -0
  220. package/templates/mvc/ts/src/config/swagger.ts.ejs +6 -0
  221. package/templates/mvc/ts/src/controllers/userController.spec.ts.ejs +481 -0
  222. package/templates/mvc/ts/src/controllers/userController.ts.ejs +292 -0
  223. package/templates/mvc/ts/src/errors/ApiError.ts +15 -0
  224. package/templates/mvc/ts/src/errors/BadRequestError.spec.ts.ejs +22 -0
  225. package/templates/mvc/ts/src/errors/BadRequestError.ts +9 -0
  226. package/templates/mvc/ts/src/errors/NotFoundError.spec.ts.ejs +27 -0
  227. package/templates/mvc/ts/src/errors/NotFoundError.ts +9 -0
  228. package/templates/mvc/ts/src/graphql/context.spec.ts.ejs +30 -0
  229. package/templates/mvc/ts/src/graphql/context.ts.ejs +12 -0
  230. package/templates/mvc/ts/src/graphql/index.ts.ejs +3 -0
  231. package/templates/mvc/ts/src/graphql/resolvers/index.ts.ejs +4 -0
  232. package/templates/mvc/ts/src/graphql/resolvers/user.resolvers.spec.ts.ejs +68 -0
  233. package/templates/mvc/ts/src/graphql/resolvers/user.resolvers.ts.ejs +29 -0
  234. package/templates/mvc/ts/src/graphql/typeDefs/index.ts.ejs +4 -0
  235. package/templates/mvc/ts/src/graphql/typeDefs/user.types.ts.ejs +17 -0
  236. package/templates/mvc/ts/src/index.ts.ejs +157 -0
  237. package/templates/mvc/ts/src/routes/api.spec.ts.ejs +59 -0
  238. package/templates/mvc/ts/src/routes/api.ts.ejs +17 -0
  239. package/templates/mvc/ts/src/utils/errorMessages.ts +12 -0
  240. package/templates/mvc/ts/src/utils/errorMiddleware.ts.ejs +27 -0
  241. package/templates/mvc/ts/src/utils/httpCodes.ts +7 -0
  242. package/templates/mvc/ts/src/utils/logger.spec.ts.ejs +63 -0
  243. package/templates/mvc/ts/src/utils/logger.ts +36 -0
@@ -0,0 +1,30 @@
1
+ const logger = require('<%- loggerPath %>');
2
+
3
+ class BaseConsumer {
4
+ constructor() {
5
+ if (this.constructor === BaseConsumer) {
6
+ throw new Error("Abstract class 'BaseConsumer' cannot be instantiated.");
7
+ }
8
+ }
9
+
10
+ get topic() { throw new Error("Property 'topic' must be implemented"); }
11
+ get groupId() { throw new Error("Property 'groupId' must be implemented"); }
12
+
13
+ async onMessage({ message }) {
14
+ try {
15
+ const rawValue = message.value?.toString();
16
+ if (!rawValue) return;
17
+
18
+ const data = JSON.parse(rawValue);
19
+ await this.handle(data);
20
+ } catch (error) {
21
+ logger.error(`[Kafka] Error processing message on topic ${this.topic}:`, error);
22
+ }
23
+ }
24
+
25
+ async handle(data) {
26
+ throw new Error("Method 'handle()' must be implemented");
27
+ }
28
+ }
29
+
30
+ module.exports = BaseConsumer;
@@ -0,0 +1,58 @@
1
+ const BaseConsumer = require('<% if (architecture === "Clean Architecture") { %>@/interfaces/messaging/baseConsumer<% } else { %>@/messaging/baseConsumer<% } %>');
2
+ const logger = require('<% if (architecture === "Clean Architecture") { %>@/infrastructure/log/logger<% } else { %>@/utils/logger<% } %>');
3
+
4
+ jest.mock('<% if (architecture === "Clean Architecture") { %>@/infrastructure/log/logger<% } else { %>@/utils/logger<% } %>');
5
+
6
+ class TestConsumer extends BaseConsumer {
7
+ constructor() {
8
+ super();
9
+ this._topic = 'test-topic';
10
+ }
11
+ get topic() { return this._topic; }
12
+ get groupId() { return 'test-group'; }
13
+ async handle(data) {
14
+ logger.info('Handled', data);
15
+ }
16
+ }
17
+
18
+ describe('BaseConsumer', () => {
19
+ let consumer;
20
+
21
+ beforeEach(() => {
22
+ jest.clearAllMocks();
23
+ consumer = new TestConsumer();
24
+ });
25
+
26
+ it('should throw error if instantiated directly', () => {
27
+ expect(() => new BaseConsumer()).toThrow("Abstract class 'BaseConsumer' cannot be instantiated.");
28
+ });
29
+
30
+ it('should process a valid message', async () => {
31
+ const message = { value: Buffer.from(JSON.stringify({ test: 'data' })) };
32
+ await consumer.onMessage({ message });
33
+ expect(logger.info).toHaveBeenCalledWith('Handled', { test: 'data' });
34
+ });
35
+
36
+ it('should handle invalid JSON', async () => {
37
+ const message = { value: Buffer.from('invalid-json') };
38
+ await consumer.onMessage({ message });
39
+ expect(logger.error).toHaveBeenCalledWith(
40
+ expect.stringContaining('[Kafka] Error processing message on topic test-topic:'),
41
+ expect.anything()
42
+ );
43
+ });
44
+
45
+ it('should skip empty messages', async () => {
46
+ const message = { value: null };
47
+ await consumer.onMessage({ message });
48
+ expect(logger.info).not.toHaveBeenCalled();
49
+ });
50
+
51
+ it('should throw if topic, groupId or handle are not implemented', async () => {
52
+ class IncompleteConsumer extends BaseConsumer {}
53
+ const incomplete = new IncompleteConsumer();
54
+ expect(() => incomplete.topic).toThrow("Property 'topic' must be implemented");
55
+ expect(() => incomplete.groupId).toThrow("Property 'groupId' must be implemented");
56
+ await expect(incomplete.handle({})).rejects.toThrow("Method 'handle()' must be implemented");
57
+ });
58
+ });
@@ -0,0 +1,12 @@
1
+ const { z } = require('zod');
2
+ const { KAFKA_ACTIONS } = require('<%- kafkaEventsPath %>');
3
+
4
+ const UserEventSchema = z.object({
5
+ action: z.enum(Object.values(KAFKA_ACTIONS)),
6
+ payload: z.object({
7
+ id: z.union([z.string(), z.number()]),
8
+ email: z.string().email().optional(),
9
+ }),
10
+ });
11
+
12
+ module.exports = { UserEventSchema };
@@ -0,0 +1,27 @@
1
+ const { UserEventSchema } = require('<% if (architecture === "Clean Architecture") { %>@/interfaces/messaging/schemas/userEventSchema<% } else { %>@/messaging/schemas/userEventSchema<% } %>');
2
+
3
+ describe('UserEventSchema', () => {
4
+ it('should validate a correct USER_CREATED event', () => {
5
+ const validEvent = {
6
+ action: 'USER_CREATED',
7
+ payload: {
8
+ id: 1,
9
+ email: 'test@example.com'
10
+ }
11
+ };
12
+ const result = UserEventSchema.safeParse(validEvent);
13
+ expect(result.success).toBe(true);
14
+ });
15
+
16
+ it('should fail validation for invalid email', () => {
17
+ const invalidEvent = {
18
+ action: 'USER_CREATED',
19
+ payload: {
20
+ id: 1,
21
+ email: 'invalid-email'
22
+ }
23
+ };
24
+ const result = UserEventSchema.safeParse(invalidEvent);
25
+ expect(result.success).toBe(false);
26
+ });
27
+ });
@@ -0,0 +1,44 @@
1
+ const BaseConsumer = require('<%- baseConsumerPath %>');
2
+ const logger = require('<%- loggerPath %>');
3
+ const { UserEventSchema } = require('<%- userEventSchemaPath %>');
4
+ const ERROR_MESSAGES = require('<%- errorMessagesPath %>');
5
+ const { KAFKA_ACTIONS } = require('<%- kafkaEventsPath %>');
6
+
7
+ class WelcomeEmailConsumer extends BaseConsumer {
8
+ constructor() {
9
+ super();
10
+ }
11
+
12
+ get topic() { return 'user-topic'; }
13
+ get groupId() { return 'welcome-email-group'; }
14
+
15
+ async handle(data) {
16
+ const result = UserEventSchema.safeParse(data);
17
+
18
+ if (!result.success) {
19
+ logger.error(`[Kafka] ${ERROR_MESSAGES.INVALID_USER_DATA}:`, result.error.format());
20
+ return;
21
+ }
22
+
23
+ const { action, payload } = result.data;
24
+
25
+ switch (action) {
26
+ case KAFKA_ACTIONS.USER_CREATED:
27
+ logger.info(`[Kafka] Consumer: Received ${KAFKA_ACTIONS.USER_CREATED}.`);
28
+ logger.info(`[Kafka] Consumer: 📧 Sending welcome email to '${payload.email}'... Done!`);
29
+ break;
30
+ case KAFKA_ACTIONS.USER_UPDATED:
31
+ logger.info(`[Kafka] Consumer: Received ${KAFKA_ACTIONS.USER_UPDATED}.`);
32
+ logger.info(`[Kafka] Consumer: 🔄 Updating user records for '${payload.id}' (Email: ${payload.email})... Done!`);
33
+ break;
34
+ case KAFKA_ACTIONS.USER_DELETED:
35
+ logger.info(`[Kafka] Consumer: Received ${KAFKA_ACTIONS.USER_DELETED}.`);
36
+ logger.info(`[Kafka] Consumer: 🗑️ Cleaning up data for user '${payload.id}'... Done!`);
37
+ break;
38
+ default:
39
+ logger.warn(`[Kafka] Unknown action: ${action}`);
40
+ }
41
+ }
42
+ }
43
+
44
+ module.exports = WelcomeEmailConsumer;
@@ -0,0 +1,86 @@
1
+ const WelcomeEmailConsumer = require('<% if (architecture === "Clean Architecture") { %>@/interfaces/messaging/consumers/instances/welcomeEmailConsumer<% } else { %>@/messaging/consumers/instances/welcomeEmailConsumer<% } %>');
2
+ const logger = require('<% if (architecture === "Clean Architecture") { %>@/infrastructure/log/logger<% } else { %>@/utils/logger<% } %>');
3
+
4
+ jest.mock('<% if (architecture === "Clean Architecture") { %>@/infrastructure/log/logger<% } else { %>@/utils/logger<% } %>');
5
+
6
+ describe('WelcomeEmailConsumer', () => {
7
+ let consumer;
8
+
9
+ beforeEach(() => {
10
+ jest.clearAllMocks();
11
+ consumer = new WelcomeEmailConsumer();
12
+ });
13
+
14
+ it('should log welcome email simulation for USER_CREATED action', async () => {
15
+ const data = {
16
+ action: 'USER_CREATED',
17
+ payload: {
18
+ id: 1,
19
+ email: 'test@example.com'
20
+ }
21
+ };
22
+
23
+ await consumer.handle(data);
24
+
25
+ expect(logger.info).toHaveBeenCalledWith(
26
+ expect.stringContaining('[Kafka] Consumer: Received USER_CREATED.')
27
+ );
28
+ expect(logger.info).toHaveBeenCalledWith(
29
+ expect.stringContaining('📧 Sending welcome email to \'test@example.com\'... Done!')
30
+ );
31
+ });
32
+
33
+ it('should log update simulation for USER_UPDATED action', async () => {
34
+ const data = {
35
+ action: 'USER_UPDATED',
36
+ payload: {
37
+ id: 1,
38
+ email: 'updated@example.com'
39
+ }
40
+ };
41
+
42
+ await consumer.handle(data);
43
+
44
+ expect(logger.info).toHaveBeenCalledWith(
45
+ expect.stringContaining('[Kafka] Consumer: Received USER_UPDATED.')
46
+ );
47
+ expect(logger.info).toHaveBeenCalledWith(
48
+ expect.stringContaining('🔄 Updating user records for \'1\' (Email: updated@example.com)... Done!')
49
+ );
50
+ });
51
+
52
+ it('should log deletion simulation for USER_DELETED action', async () => {
53
+ const data = {
54
+ action: 'USER_DELETED',
55
+ payload: {
56
+ id: 1
57
+ }
58
+ };
59
+
60
+ await consumer.handle(data);
61
+
62
+ expect(logger.info).toHaveBeenCalledWith(
63
+ expect.stringContaining('[Kafka] Consumer: Received USER_DELETED.')
64
+ );
65
+ expect(logger.info).toHaveBeenCalledWith(
66
+ expect.stringContaining('🗑️ Cleaning up data for user \'1\'... Done!')
67
+ );
68
+ });
69
+
70
+ it('should log error for invalid data', async () => {
71
+ const data = {
72
+ action: 'USER_CREATED',
73
+ payload: {
74
+ id: 1,
75
+ email: 'invalid-email'
76
+ }
77
+ };
78
+
79
+ await consumer.handle(data);
80
+
81
+ expect(logger.error).toHaveBeenCalledWith(
82
+ expect.stringContaining('[Kafka] Invalid user event data:'),
83
+ expect.anything()
84
+ );
85
+ });
86
+ });
@@ -0,0 +1,93 @@
1
+ const { kafka } = require('../config/kafka');
2
+ const logger = require('<% if (architecture === "Clean Architecture") { %>../log/logger<% } else { %>../utils/logger<% } %>');
3
+
4
+ let producer = null;
5
+ let consumer = null;
6
+ let isConnected = false;
7
+ let connectionPromise = null;
8
+
9
+ const connectKafka = async (retries = 10) => {
10
+ if (connectionPromise) return connectionPromise;
11
+
12
+ connectionPromise = (async () => {
13
+ if (!producer) producer = kafka.producer();
14
+ if (!consumer) consumer = kafka.consumer({ groupId: 'test-group' });
15
+
16
+ let attempt = 0;
17
+ // Auto-register WelcomeEmailConsumer if it exists
18
+ // Note: Dynamic import used here for simplicity and to avoid startup crashes.
19
+ // In enterprise production, consider using Dependency Injection.
20
+ const WelcomeEmailConsumer = require('<% if (architecture === "Clean Architecture") { %>../../interfaces/messaging/consumers/instances/welcomeEmailConsumer<% } else { %>../messaging/consumers/instances/welcomeEmailConsumer<% } %>');
21
+ while (attempt < retries) {
22
+ try {
23
+ await producer.connect();
24
+ await consumer.connect();
25
+ logger.info('[Kafka] Producer connected successfully');
26
+ logger.info('[Kafka] Consumer connected successfully');
27
+ isConnected = true;
28
+
29
+ try {
30
+ const welcomeConsumer = new WelcomeEmailConsumer();
31
+ await consumer.subscribe({ topic: welcomeConsumer.topic, fromBeginning: true });
32
+ logger.info(`[Kafka] Registered consumer for topic: ${welcomeConsumer.topic}`);
33
+
34
+ await consumer.run({
35
+ eachMessage: async (payload) => welcomeConsumer.onMessage(payload),
36
+ });
37
+ } catch (error) {
38
+ // Fallback or no consumers found
39
+ await consumer.subscribe({ topic: 'user-topic', fromBeginning: true });
40
+ await consumer.run({
41
+ eachMessage: async ({ message }) => {
42
+ logger.info({ value: message.value.toString() });
43
+ },
44
+ });
45
+ }
46
+ return; // Success
47
+ } catch (error) {
48
+ attempt++;
49
+ logger.error(`[Kafka] Connection attempt ${attempt} failed:`, error.message);
50
+ if (attempt >= retries) {
51
+ throw error; // Rethrow after final attempt
52
+ }
53
+ await new Promise(res => setTimeout(res, 3000)); // Wait 3s between retries
54
+ }
55
+ }
56
+ })();
57
+
58
+ return connectionPromise;
59
+ };
60
+
61
+ const sendMessage = async (topic, message, key) => {
62
+ if (connectionPromise) {
63
+ await connectionPromise;
64
+ }
65
+
66
+ if (!isConnected) {
67
+ throw new Error('[Kafka] Producer not connected. Check logs for connection errors.');
68
+ }
69
+
70
+ try {
71
+ await producer.send({
72
+ topic,
73
+ messages: [{ key, value: message }],
74
+ });
75
+
76
+ try {
77
+ const parsed = JSON.parse(message);
78
+ logger.info(`[Kafka] Producer: Sent ${parsed.action} event for '${parsed.payload?.email || 'unknown'}'`);
79
+ } catch (error) {
80
+ logger.info(`[Kafka] Producer: Sent message to ${topic}`, error);
81
+ }
82
+ } catch (error) {
83
+ logger.error(`[Kafka] Failed to send message to ${topic}:`, error.message);
84
+ throw error;
85
+ }
86
+ };
87
+
88
+ const disconnectKafka = async () => {
89
+ if (producer) await producer.disconnect();
90
+ if (consumer) await consumer.disconnect();
91
+ };
92
+
93
+ module.exports = { connectKafka, sendMessage, disconnectKafka };
@@ -0,0 +1,106 @@
1
+ let kafka;
2
+ let connectKafka, sendMessage, disconnectKafka;
3
+
4
+ jest.mock('<% if (architecture === "Clean Architecture") { %>@/infrastructure/config/kafka<% } else { %>@/config/kafka<% } %>', () => ({
5
+ kafka: {
6
+ producer: jest.fn().mockReturnValue({
7
+ connect: jest.fn().mockResolvedValue(undefined),
8
+ send: jest.fn().mockResolvedValue(undefined),
9
+ disconnect: jest.fn().mockResolvedValue(undefined),
10
+ }),
11
+ consumer: jest.fn().mockReturnValue({
12
+ connect: jest.fn().mockResolvedValue(undefined),
13
+ subscribe: jest.fn().mockResolvedValue(undefined),
14
+ run: jest.fn().mockResolvedValue(undefined),
15
+ disconnect: jest.fn().mockResolvedValue(undefined),
16
+ }),
17
+ },
18
+ }));
19
+
20
+ jest.mock('<% if (architecture === "Clean Architecture") { %>@/infrastructure/log/logger<% } else { %>@/utils/logger<% } %>');
21
+
22
+ describe('Kafka Client', () => {
23
+ beforeEach(async () => {
24
+ jest.resetModules();
25
+ jest.clearAllMocks();
26
+ jest.useFakeTimers();
27
+ jest.spyOn(global, 'setTimeout');
28
+ kafka = require('<% if (architecture === "Clean Architecture") { %>@/infrastructure/config/kafka<% } else { %>@/config/kafka<% } %>').kafka;
29
+ ({ connectKafka, sendMessage, disconnectKafka } = require('<% if (architecture === "Clean Architecture") { %>@/infrastructure/messaging/kafkaClient<% } else { %>@/services/kafkaService<% } %>'));
30
+ });
31
+
32
+ it('should connect producer and consumer', async () => {
33
+ await connectKafka();
34
+ const producer = kafka.producer.mock.results[0].value;
35
+ const consumer = kafka.consumer.mock.results[0].value;
36
+
37
+ expect(producer.connect).toHaveBeenCalled();
38
+ expect(consumer.connect).toHaveBeenCalled();
39
+ expect(consumer.subscribe).toHaveBeenCalledWith(expect.objectContaining({ fromBeginning: true }));
40
+ const subscribeCall = consumer.subscribe.mock.calls.find(call => call[0].topic === 'user-topic' || call[0].topic === 'test-topic');
41
+ expect(subscribeCall).toBeDefined();
42
+ });
43
+
44
+ it('should send a message', async () => {
45
+ await connectKafka();
46
+ const topic = 'test-topic';
47
+ const message = JSON.stringify({ action: 'TEST', payload: { email: 'test@example.com' } });
48
+ await sendMessage(topic, message);
49
+ const producer = kafka.producer.mock.results[0].value;
50
+
51
+ expect(producer.send).toHaveBeenCalledWith({
52
+ topic,
53
+ messages: [{ value: message }],
54
+ });
55
+ });
56
+
57
+ it('should retry connection on failure', async () => {
58
+ // We need to re-require to get a fresh state
59
+ jest.resetModules();
60
+ const { connectKafka: retryConnectKafka } = require('<% if (architecture === "Clean Architecture") { %>@/infrastructure/messaging/kafkaClient<% } else { %>@/services/kafkaService<% } %>');
61
+ const kafkaConfig = require('<% if (architecture === "Clean Architecture") { %>@/infrastructure/config/kafka<% } else { %>@/config/kafka<% } %>');
62
+
63
+ const newProducer = kafkaConfig.kafka.producer();
64
+ // Mock the next producer creation to return our controlled producer
65
+ kafkaConfig.kafka.producer.mockReturnValueOnce(newProducer);
66
+
67
+ newProducer.connect
68
+ .mockRejectedValueOnce(new Error('Connection failed'))
69
+ .mockResolvedValueOnce(undefined);
70
+
71
+ const connectPromise = retryConnectKafka(2);
72
+
73
+ await jest.advanceTimersByTimeAsync(10000);
74
+ await connectPromise;
75
+ expect(newProducer.connect).toHaveBeenCalledTimes(2);
76
+ });
77
+
78
+ it('should throw error if producer not connected', async () => {
79
+ await expect(sendMessage('topic', 'msg')).rejects.toThrow('[Kafka] Producer not connected');
80
+ });
81
+
82
+ it('should log error when sendMessage fails', async () => {
83
+ await connectKafka();
84
+ const producer = kafka.producer.mock.results[0].value;
85
+ producer.send.mockRejectedValue(new Error('Send failed'));
86
+
87
+ await expect(sendMessage('test-topic', 'msg')).rejects.toThrow('Send failed');
88
+ });
89
+
90
+ it('should disconnect Kafka', async () => {
91
+ await connectKafka();
92
+ const producer = kafka.producer.mock.results[0].value;
93
+ const consumer = kafka.consumer.mock.results[0].value;
94
+
95
+ await disconnectKafka();
96
+
97
+ expect(producer.disconnect).toHaveBeenCalled();
98
+ expect(consumer.disconnect).toHaveBeenCalled();
99
+ });
100
+
101
+ it('should allow connecting with custom retries', async () => {
102
+ await connectKafka(5);
103
+ // This is mainly for coverage of the retries parameter
104
+ expect(kafka.producer).toHaveBeenCalled();
105
+ });
106
+ });
@@ -0,0 +1,7 @@
1
+ const KAFKA_ACTIONS = {
2
+ USER_CREATED: 'USER_CREATED',
3
+ USER_UPDATED: 'USER_UPDATED',
4
+ USER_DELETED: 'USER_DELETED',
5
+ };
6
+
7
+ module.exports = { KAFKA_ACTIONS };
@@ -0,0 +1,27 @@
1
+ import { Kafka } from 'kafkajs';
2
+
3
+ jest.mock('kafkajs', () => {
4
+ return {
5
+ Kafka: jest.fn().mockImplementation(() => ({
6
+ producer: jest.fn(),
7
+ consumer: jest.fn(),
8
+ })),
9
+ };
10
+ });
11
+
12
+ jest.mock('@/config/env', () => ({
13
+ env: {
14
+ KAFKA_BROKER: 'localhost:9092'
15
+ }
16
+ }));
17
+
18
+ describe('Kafka Configuration', () => {
19
+ beforeEach(() => {
20
+ jest.clearAllMocks();
21
+ });
22
+
23
+ it('should initialize Kafka', () => {
24
+ require('<% if (architecture === "MVC") { %>@/config/kafka<% } else { %>@/infrastructure/config/kafka<% } %>');
25
+ expect(Kafka).toHaveBeenCalled();
26
+ });
27
+ });
@@ -0,0 +1,7 @@
1
+ import { Kafka } from 'kafkajs';
2
+ import { env } from '@/config/env';
3
+
4
+ export const kafka = new Kafka({
5
+ clientId: 'nodejs-service',
6
+ brokers: [env.KAFKA_BROKER]
7
+ });
@@ -0,0 +1,50 @@
1
+ import { BaseConsumer } from '<% if (architecture === "Clean Architecture") { %>@/interfaces/messaging/baseConsumer<% } else { %>@/messaging/baseConsumer<% } %>';
2
+ import logger from '<%= loggerPath %>';
3
+
4
+ jest.mock('<%= loggerPath %>');
5
+
6
+ class TestConsumer extends BaseConsumer {
7
+ constructor() {
8
+ super();
9
+ }
10
+ get topic() { return 'test-topic'; }
11
+ get groupId() { return 'test-group'; }
12
+ async handle(data: any) {
13
+ logger.info('Handled', data);
14
+ }
15
+ }
16
+
17
+ describe('BaseConsumer', () => {
18
+ let consumer: TestConsumer;
19
+
20
+ beforeEach(() => {
21
+ jest.clearAllMocks();
22
+ consumer = new TestConsumer();
23
+ });
24
+
25
+ it('should throw error if instantiated directly', () => {
26
+ // @ts-expect-error: Abstract class cannot be instantiated
27
+ expect(() => new BaseConsumer()).toThrow("Abstract class 'BaseConsumer' cannot be instantiated.");
28
+ });
29
+
30
+ it('should process a valid message', async () => {
31
+ const message = { value: Buffer.from(JSON.stringify({ test: 'data' })) };
32
+ await consumer.onMessage({ message } as any);
33
+ expect(logger.info).toHaveBeenCalledWith('Handled', { test: 'data' });
34
+ });
35
+
36
+ it('should handle invalid JSON', async () => {
37
+ const message = { value: Buffer.from('invalid-json') };
38
+ await consumer.onMessage({ message } as any);
39
+ expect(logger.error).toHaveBeenCalledWith(
40
+ expect.stringContaining('[Kafka] Error processing message on topic test-topic:'),
41
+ expect.anything()
42
+ );
43
+ });
44
+
45
+ it('should skip empty messages', async () => {
46
+ const message = { value: null };
47
+ await consumer.onMessage({ message } as any);
48
+ expect(logger.info).not.toHaveBeenCalled();
49
+ });
50
+ });
@@ -0,0 +1,27 @@
1
+ import { EachMessagePayload } from 'kafkajs';
2
+ import logger from '<%= loggerPath %>';
3
+
4
+ export abstract class BaseConsumer {
5
+ abstract topic: string;
6
+ abstract groupId: string;
7
+
8
+ public constructor() {
9
+ if (new.target === BaseConsumer) {
10
+ throw new Error("Abstract class 'BaseConsumer' cannot be instantiated.");
11
+ }
12
+ }
13
+
14
+ async onMessage({ message }: EachMessagePayload) {
15
+ try {
16
+ const rawValue = message.value?.toString();
17
+ if (!rawValue) return;
18
+
19
+ const data = JSON.parse(rawValue);
20
+ await this.handle(data);
21
+ } catch (error) {
22
+ logger.error(`[Kafka] Error processing message on topic ${this.topic}:`, error);
23
+ }
24
+ }
25
+
26
+ abstract handle(data: unknown): Promise<void>;
27
+ }
@@ -0,0 +1,51 @@
1
+ import { UserEventSchema } from '<% if (architecture === "Clean Architecture") { %>@/interfaces/messaging/schemas/userEventSchema<% } else { %>@/messaging/schemas/userEventSchema<% } %>';
2
+
3
+ describe('UserEventSchema', () => {
4
+ it('should validate a correct USER_CREATED event', () => {
5
+ const validEvent = {
6
+ action: 'USER_CREATED',
7
+ payload: {
8
+ id: 1,
9
+ email: 'test@example.com'
10
+ }
11
+ };
12
+ const result = UserEventSchema.safeParse(validEvent);
13
+ expect(result.success).toBe(true);
14
+ });
15
+
16
+ it('should validate a correct UPDATE_USER event', () => {
17
+ const validEvent = {
18
+ action: 'USER_UPDATED',
19
+ payload: {
20
+ id: 'abc-123',
21
+ email: 'test@example.com'
22
+ }
23
+ };
24
+ const result = UserEventSchema.safeParse(validEvent);
25
+ expect(result.success).toBe(true);
26
+ });
27
+
28
+ it('should fail validation for invalid email', () => {
29
+ const invalidEvent = {
30
+ action: 'USER_CREATED',
31
+ payload: {
32
+ id: 1,
33
+ email: 'invalid-email'
34
+ }
35
+ };
36
+ const result = UserEventSchema.safeParse(invalidEvent);
37
+ expect(result.success).toBe(false);
38
+ });
39
+
40
+ it('should fail validation for invalid action', () => {
41
+ const invalidEvent = {
42
+ action: 'INVALID_ACTION',
43
+ payload: {
44
+ id: 1,
45
+ email: 'test@example.com'
46
+ }
47
+ };
48
+ const result = UserEventSchema.safeParse(invalidEvent);
49
+ expect(result.success).toBe(false);
50
+ });
51
+ });
@@ -0,0 +1,12 @@
1
+ import { z } from 'zod';
2
+ import { KAFKA_ACTIONS } from '@/utils/kafkaEvents';
3
+
4
+ export const UserEventSchema = z.object({
5
+ action: z.nativeEnum(KAFKA_ACTIONS),
6
+ payload: z.object({
7
+ id: z.union([z.string(), z.number()]),
8
+ email: z.string().email().optional(),
9
+ }),
10
+ });
11
+
12
+ export type UserEvent = z.infer<typeof UserEventSchema>;