@flusys/nestjs-shared 7.0.2 → 8.0.0-beta.1

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 (339) hide show
  1. package/classes/api-controller.class.d.ts +4 -4
  2. package/classes/api-service.class.d.ts +7 -7
  3. package/classes/disabled-event-bus.class.d.ts +1 -1
  4. package/classes/domain-event.publisher.d.ts +1 -1
  5. package/classes/event-bus.registry.d.ts +1 -1
  6. package/classes/event-transports/event-transport.registry.d.ts +1 -1
  7. package/classes/event-transports/index.d.ts +2 -2
  8. package/classes/event-transports/kafka-transport.optional.d.ts +1 -1
  9. package/classes/event-transports/memory-transport.d.ts +1 -1
  10. package/classes/event-transports/rabbitmq-transport.optional.d.ts +1 -1
  11. package/classes/hybrid-event-bus.class.d.ts +1 -1
  12. package/classes/index.d.ts +11 -11
  13. package/constants/index.d.ts +2 -2
  14. package/constants/permissions.d.ts +12 -0
  15. package/decorators/api-response.decorator.d.ts +1 -1
  16. package/decorators/current-user.decorator.d.ts +1 -1
  17. package/decorators/index.d.ts +6 -6
  18. package/decorators/require-permission.decorator.d.ts +1 -1
  19. package/dtos/filter-and-pagination.dto.d.ts +1 -1
  20. package/dtos/index.d.ts +6 -6
  21. package/entities/index.d.ts +3 -3
  22. package/enums/index.d.ts +3 -3
  23. package/exceptions/index.d.ts +2 -2
  24. package/fesm/470.js +2713 -0
  25. package/fesm/509.js +793 -0
  26. package/fesm/667.js +606 -0
  27. package/fesm/67.js +808 -0
  28. package/fesm/720.js +914 -0
  29. package/{cjs/classes/event-transports/rabbitmq-transport.optional.js → fesm/chunks/123.js} +78 -55
  30. package/fesm/{classes/event-transports/kafka-transport.optional.js → chunks/37.js} +74 -41
  31. package/fesm/classes/index.js +62 -12
  32. package/fesm/constants/index.js +445 -17
  33. package/fesm/decorators/index.js +341 -6
  34. package/fesm/dtos/index.js +23 -6
  35. package/fesm/entities/index.js +336 -3
  36. package/fesm/enums/index.js +57 -3
  37. package/fesm/exceptions/index.js +280 -2
  38. package/fesm/guards/index.js +1003 -3
  39. package/fesm/index.js +1524 -14
  40. package/fesm/interceptors/index.js +924 -5
  41. package/fesm/interfaces/index.js +57 -11
  42. package/fesm/middlewares/index.js +33 -1
  43. package/fesm/modules/index.js +432 -9
  44. package/fesm/runtime.js +134 -0
  45. package/fesm/utils/index.js +1045 -8
  46. package/filters/global-exception.filter.d.ts +1 -1
  47. package/filters/index.d.ts +1 -1
  48. package/guards/index.d.ts +3 -3
  49. package/guards/jwt-auth.guard.d.ts +1 -1
  50. package/guards/optional-jwt-auth.guard.d.ts +1 -1
  51. package/guards/permission.guard.d.ts +2 -2
  52. package/index.d.ts +14 -14
  53. package/interceptors/delete-empty-id-from-body.interceptor.d.ts +1 -1
  54. package/interceptors/idempotency.interceptor.d.ts +2 -2
  55. package/interceptors/index.d.ts +5 -5
  56. package/interceptors/response-meta.interceptor.d.ts +1 -1
  57. package/interceptors/set-user-field-on-body.interceptor.d.ts +1 -1
  58. package/interceptors/slug.interceptor.d.ts +2 -2
  59. package/interfaces/ai-assistant-adapter.interface.d.ts +1 -1
  60. package/interfaces/api.interface.d.ts +2 -2
  61. package/interfaces/datasource.interface.d.ts +1 -1
  62. package/interfaces/event-manager-adapter.interface.d.ts +2 -2
  63. package/interfaces/index.d.ts +11 -11
  64. package/interfaces/module-config.interface.d.ts +1 -1
  65. package/interfaces/notification-adapter.interface.d.ts +1 -1
  66. package/middlewares/index.d.ts +1 -1
  67. package/middlewares/logger.middleware.d.ts +2 -2
  68. package/modules/cache/cache.module.d.ts +1 -1
  69. package/modules/datasource/index.d.ts +1 -1
  70. package/modules/datasource/multi-tenant-datasource.service.d.ts +4 -4
  71. package/modules/event-bus/event-bus.explorer.d.ts +2 -2
  72. package/modules/event-bus/event-bus.module.d.ts +2 -2
  73. package/modules/event-bus/module-events.provider.d.ts +1 -1
  74. package/modules/index.d.ts +9 -9
  75. package/modules/shared-permission-cache/shared-permission-cache.service.d.ts +3 -3
  76. package/modules/utils/utils.service.d.ts +1 -1
  77. package/package.json +30 -44
  78. package/utils/index.d.ts +8 -8
  79. package/utils/permission-cache-key.util.d.ts +1 -1
  80. package/utils/query-helpers.util.d.ts +2 -2
  81. package/utils/request.util.d.ts +1 -1
  82. package/cjs/classes/api-controller.class.js +0 -728
  83. package/cjs/classes/api-controller.class.spec.js +0 -684
  84. package/cjs/classes/api-service.class.js +0 -631
  85. package/cjs/classes/api-service.class.spec.js +0 -1137
  86. package/cjs/classes/disabled-event-bus.class.js +0 -15
  87. package/cjs/classes/disabled-event-bus.class.spec.js +0 -40
  88. package/cjs/classes/domain-event.publisher.js +0 -76
  89. package/cjs/classes/domain-event.publisher.spec.js +0 -234
  90. package/cjs/classes/event-bus.registry.js +0 -68
  91. package/cjs/classes/event-bus.registry.spec.js +0 -141
  92. package/cjs/classes/event-transports/event-transport.registry.js +0 -41
  93. package/cjs/classes/event-transports/event-transport.registry.spec.js +0 -31
  94. package/cjs/classes/event-transports/index.js +0 -23
  95. package/cjs/classes/event-transports/kafka-transport.optional.js +0 -151
  96. package/cjs/classes/event-transports/kafka-transport.optional.spec.js +0 -198
  97. package/cjs/classes/event-transports/memory-transport.js +0 -53
  98. package/cjs/classes/event-transports/memory-transport.spec.js +0 -57
  99. package/cjs/classes/event-transports/rabbitmq-transport.optional.spec.js +0 -255
  100. package/cjs/classes/handle-custome-db.js +0 -37
  101. package/cjs/classes/handle-custome-db.spec.js +0 -82
  102. package/cjs/classes/hybrid-cache.class.js +0 -96
  103. package/cjs/classes/hybrid-cache.class.spec.js +0 -168
  104. package/cjs/classes/hybrid-event-bus.class.js +0 -281
  105. package/cjs/classes/hybrid-event-bus.class.spec.js +0 -218
  106. package/cjs/classes/index.js +0 -28
  107. package/cjs/classes/winston.logger.class.js +0 -274
  108. package/cjs/classes/winston.logger.class.spec.js +0 -330
  109. package/cjs/constants/index.js +0 -88
  110. package/cjs/constants/message-keys.js +0 -68
  111. package/cjs/constants/permissions.js +0 -297
  112. package/cjs/decorators/api-response.decorator.js +0 -52
  113. package/cjs/decorators/api-response.decorator.spec.js +0 -126
  114. package/cjs/decorators/current-user.decorator.js +0 -16
  115. package/cjs/decorators/current-user.decorator.spec.js +0 -74
  116. package/cjs/decorators/index.js +0 -23
  117. package/cjs/decorators/log-action.decorator.js +0 -149
  118. package/cjs/decorators/log-action.decorator.spec.js +0 -353
  119. package/cjs/decorators/on-domain-event.decorator.js +0 -13
  120. package/cjs/decorators/on-domain-event.decorator.spec.js +0 -50
  121. package/cjs/decorators/public.decorator.js +0 -13
  122. package/cjs/decorators/public.decorator.spec.js +0 -50
  123. package/cjs/decorators/require-permission.decorator.js +0 -32
  124. package/cjs/decorators/require-permission.decorator.spec.js +0 -147
  125. package/cjs/dtos/delete.dto.js +0 -92
  126. package/cjs/dtos/filter-and-pagination.dto.js +0 -164
  127. package/cjs/dtos/get-by-ids.dto.js +0 -65
  128. package/cjs/dtos/identity-response.dto.js +0 -108
  129. package/cjs/dtos/index.js +0 -23
  130. package/cjs/dtos/pagination.dto.js +0 -67
  131. package/cjs/dtos/response-payload.dto.js +0 -369
  132. package/cjs/entities/identity.js +0 -100
  133. package/cjs/entities/index.js +0 -20
  134. package/cjs/entities/raw-type.js +0 -4
  135. package/cjs/entities/user-root.js +0 -189
  136. package/cjs/enums/index.js +0 -20
  137. package/cjs/enums/notification-type.enum.js +0 -17
  138. package/cjs/enums/participant-status.enum.js +0 -17
  139. package/cjs/enums/recurrence-type.enum.js +0 -18
  140. package/cjs/exceptions/base-app.exception.js +0 -151
  141. package/cjs/exceptions/base-app.exception.spec.js +0 -157
  142. package/cjs/exceptions/index.js +0 -19
  143. package/cjs/exceptions/permission.exception.js +0 -56
  144. package/cjs/exceptions/permission.exception.spec.js +0 -82
  145. package/cjs/filters/global-exception.filter.js +0 -279
  146. package/cjs/filters/global-exception.filter.spec.js +0 -440
  147. package/cjs/filters/index.js +0 -18
  148. package/cjs/guards/index.js +0 -20
  149. package/cjs/guards/jwt-auth.guard.js +0 -75
  150. package/cjs/guards/jwt-auth.guard.spec.js +0 -75
  151. package/cjs/guards/optional-jwt-auth.guard.js +0 -67
  152. package/cjs/guards/optional-jwt-auth.guard.spec.js +0 -55
  153. package/cjs/guards/permission.guard.js +0 -179
  154. package/cjs/guards/permission.guard.spec.js +0 -373
  155. package/cjs/index.js +0 -31
  156. package/cjs/interceptors/delete-empty-id-from-body.interceptor.js +0 -40
  157. package/cjs/interceptors/delete-empty-id-from-body.interceptor.spec.js +0 -107
  158. package/cjs/interceptors/idempotency.interceptor.js +0 -96
  159. package/cjs/interceptors/idempotency.interceptor.spec.js +0 -116
  160. package/cjs/interceptors/index.js +0 -22
  161. package/cjs/interceptors/response-meta.interceptor.js +0 -47
  162. package/cjs/interceptors/response-meta.interceptor.spec.js +0 -89
  163. package/cjs/interceptors/set-user-field-on-body.interceptor.js +0 -60
  164. package/cjs/interceptors/set-user-field-on-body.interceptor.spec.js +0 -128
  165. package/cjs/interceptors/slug.interceptor.js +0 -75
  166. package/cjs/interceptors/slug.interceptor.spec.js +0 -110
  167. package/cjs/interfaces/ai-assistant-adapter.interface.js +0 -24
  168. package/cjs/interfaces/api.interface.js +0 -4
  169. package/cjs/interfaces/datasource.interface.js +0 -4
  170. package/cjs/interfaces/event-bus.interface.js +0 -4
  171. package/cjs/interfaces/event-manager-adapter.interface.js +0 -11
  172. package/cjs/interfaces/identity.interface.js +0 -4
  173. package/cjs/interfaces/index.js +0 -28
  174. package/cjs/interfaces/logged-user-info.interface.js +0 -6
  175. package/cjs/interfaces/module-config.interface.js +0 -4
  176. package/cjs/interfaces/notification-adapter.interface.js +0 -11
  177. package/cjs/interfaces/permission-sync-adapter.interface.js +0 -11
  178. package/cjs/interfaces/permission.interface.js +0 -4
  179. package/cjs/middlewares/index.js +0 -18
  180. package/cjs/middlewares/logger.middleware.js +0 -264
  181. package/cjs/middlewares/logger.middleware.spec.js +0 -462
  182. package/cjs/modules/cache/cache.module.js +0 -39
  183. package/cjs/modules/cache/cache.module.spec.js +0 -48
  184. package/cjs/modules/datasource/index.js +0 -18
  185. package/cjs/modules/datasource/multi-tenant-datasource.service.js +0 -222
  186. package/cjs/modules/datasource/multi-tenant-datasource.service.spec.js +0 -381
  187. package/cjs/modules/event-bus/event-bus.explorer.js +0 -124
  188. package/cjs/modules/event-bus/event-bus.explorer.spec.js +0 -189
  189. package/cjs/modules/event-bus/event-bus.integration.spec.js +0 -253
  190. package/cjs/modules/event-bus/event-bus.module.js +0 -94
  191. package/cjs/modules/event-bus/event-bus.module.spec.js +0 -149
  192. package/cjs/modules/event-bus/module-events.provider.js +0 -39
  193. package/cjs/modules/event-bus/module-events.provider.spec.js +0 -56
  194. package/cjs/modules/index.js +0 -26
  195. package/cjs/modules/shared-permission-cache/shared-permission-cache.module.js +0 -32
  196. package/cjs/modules/shared-permission-cache/shared-permission-cache.service.js +0 -101
  197. package/cjs/modules/shared-permission-cache/shared-permission-cache.service.spec.js +0 -165
  198. package/cjs/modules/utils/utils.module.js +0 -32
  199. package/cjs/modules/utils/utils.service.js +0 -76
  200. package/cjs/modules/utils/utils.service.spec.js +0 -169
  201. package/cjs/utils/date-time.util.js +0 -94
  202. package/cjs/utils/date-time.util.spec.js +0 -84
  203. package/cjs/utils/event-pattern.util.js +0 -103
  204. package/cjs/utils/event-pattern.util.spec.js +0 -251
  205. package/cjs/utils/html-sanitizer.util.js +0 -64
  206. package/cjs/utils/html-sanitizer.util.spec.js +0 -76
  207. package/cjs/utils/index.js +0 -25
  208. package/cjs/utils/optional-module.util.js +0 -35
  209. package/cjs/utils/optional-module.util.spec.js +0 -14
  210. package/cjs/utils/permission-cache-key.util.js +0 -31
  211. package/cjs/utils/permission-cache-key.util.spec.js +0 -88
  212. package/cjs/utils/query-helpers.util.js +0 -60
  213. package/cjs/utils/query-helpers.util.spec.js +0 -209
  214. package/cjs/utils/request.util.js +0 -96
  215. package/cjs/utils/request.util.spec.js +0 -249
  216. package/cjs/utils/string.util.js +0 -63
  217. package/cjs/utils/string.util.spec.js +0 -63
  218. package/fesm/classes/api-controller.class.js +0 -718
  219. package/fesm/classes/api-controller.class.spec.js +0 -680
  220. package/fesm/classes/api-service.class.js +0 -621
  221. package/fesm/classes/api-service.class.spec.js +0 -1133
  222. package/fesm/classes/disabled-event-bus.class.js +0 -11
  223. package/fesm/classes/disabled-event-bus.class.spec.js +0 -36
  224. package/fesm/classes/domain-event.publisher.js +0 -63
  225. package/fesm/classes/domain-event.publisher.spec.js +0 -230
  226. package/fesm/classes/event-bus.registry.js +0 -64
  227. package/fesm/classes/event-bus.registry.spec.js +0 -137
  228. package/fesm/classes/event-transports/event-transport.registry.js +0 -35
  229. package/fesm/classes/event-transports/event-transport.registry.spec.js +0 -27
  230. package/fesm/classes/event-transports/index.js +0 -6
  231. package/fesm/classes/event-transports/kafka-transport.optional.spec.js +0 -194
  232. package/fesm/classes/event-transports/memory-transport.js +0 -49
  233. package/fesm/classes/event-transports/memory-transport.spec.js +0 -53
  234. package/fesm/classes/event-transports/rabbitmq-transport.optional.js +0 -174
  235. package/fesm/classes/event-transports/rabbitmq-transport.optional.spec.js +0 -251
  236. package/fesm/classes/handle-custome-db.js +0 -19
  237. package/fesm/classes/handle-custome-db.spec.js +0 -78
  238. package/fesm/classes/hybrid-cache.class.js +0 -81
  239. package/fesm/classes/hybrid-cache.class.spec.js +0 -164
  240. package/fesm/classes/hybrid-event-bus.class.js +0 -237
  241. package/fesm/classes/hybrid-event-bus.class.spec.js +0 -214
  242. package/fesm/classes/winston.logger.class.js +0 -228
  243. package/fesm/classes/winston.logger.class.spec.js +0 -327
  244. package/fesm/constants/message-keys.js +0 -49
  245. package/fesm/constants/permissions.js +0 -208
  246. package/fesm/decorators/api-response.decorator.js +0 -42
  247. package/fesm/decorators/api-response.decorator.spec.js +0 -122
  248. package/fesm/decorators/current-user.decorator.js +0 -18
  249. package/fesm/decorators/current-user.decorator.spec.js +0 -73
  250. package/fesm/decorators/log-action.decorator.js +0 -139
  251. package/fesm/decorators/log-action.decorator.spec.js +0 -349
  252. package/fesm/decorators/on-domain-event.decorator.js +0 -10
  253. package/fesm/decorators/on-domain-event.decorator.spec.js +0 -46
  254. package/fesm/decorators/public.decorator.js +0 -20
  255. package/fesm/decorators/public.decorator.spec.js +0 -46
  256. package/fesm/decorators/require-permission.decorator.js +0 -27
  257. package/fesm/decorators/require-permission.decorator.spec.js +0 -143
  258. package/fesm/dtos/delete.dto.js +0 -82
  259. package/fesm/dtos/filter-and-pagination.dto.js +0 -148
  260. package/fesm/dtos/get-by-ids.dto.js +0 -55
  261. package/fesm/dtos/identity-response.dto.js +0 -98
  262. package/fesm/dtos/pagination.dto.js +0 -57
  263. package/fesm/dtos/response-payload.dto.js +0 -336
  264. package/fesm/entities/identity.js +0 -90
  265. package/fesm/entities/raw-type.js +0 -1
  266. package/fesm/entities/user-root.js +0 -179
  267. package/fesm/enums/notification-type.enum.js +0 -7
  268. package/fesm/enums/participant-status.enum.js +0 -7
  269. package/fesm/enums/recurrence-type.enum.js +0 -8
  270. package/fesm/exceptions/base-app.exception.js +0 -115
  271. package/fesm/exceptions/base-app.exception.spec.js +0 -153
  272. package/fesm/exceptions/permission.exception.js +0 -35
  273. package/fesm/exceptions/permission.exception.spec.js +0 -78
  274. package/fesm/filters/global-exception.filter.js +0 -269
  275. package/fesm/filters/global-exception.filter.spec.js +0 -436
  276. package/fesm/filters/index.js +0 -1
  277. package/fesm/guards/jwt-auth.guard.js +0 -65
  278. package/fesm/guards/jwt-auth.guard.spec.js +0 -71
  279. package/fesm/guards/optional-jwt-auth.guard.js +0 -57
  280. package/fesm/guards/optional-jwt-auth.guard.spec.js +0 -51
  281. package/fesm/guards/permission.guard.js +0 -169
  282. package/fesm/guards/permission.guard.spec.js +0 -369
  283. package/fesm/interceptors/delete-empty-id-from-body.interceptor.js +0 -30
  284. package/fesm/interceptors/delete-empty-id-from-body.interceptor.spec.js +0 -103
  285. package/fesm/interceptors/idempotency.interceptor.js +0 -86
  286. package/fesm/interceptors/idempotency.interceptor.spec.js +0 -112
  287. package/fesm/interceptors/response-meta.interceptor.js +0 -37
  288. package/fesm/interceptors/response-meta.interceptor.spec.js +0 -85
  289. package/fesm/interceptors/set-user-field-on-body.interceptor.js +0 -39
  290. package/fesm/interceptors/set-user-field-on-body.interceptor.spec.js +0 -124
  291. package/fesm/interceptors/slug.interceptor.js +0 -65
  292. package/fesm/interceptors/slug.interceptor.spec.js +0 -106
  293. package/fesm/interfaces/ai-assistant-adapter.interface.js +0 -3
  294. package/fesm/interfaces/api.interface.js +0 -1
  295. package/fesm/interfaces/datasource.interface.js +0 -1
  296. package/fesm/interfaces/event-bus.interface.js +0 -1
  297. package/fesm/interfaces/event-manager-adapter.interface.js +0 -1
  298. package/fesm/interfaces/identity.interface.js +0 -1
  299. package/fesm/interfaces/logged-user-info.interface.js +0 -3
  300. package/fesm/interfaces/module-config.interface.js +0 -5
  301. package/fesm/interfaces/notification-adapter.interface.js +0 -1
  302. package/fesm/interfaces/permission-sync-adapter.interface.js +0 -1
  303. package/fesm/interfaces/permission.interface.js +0 -1
  304. package/fesm/middlewares/logger.middleware.js +0 -235
  305. package/fesm/middlewares/logger.middleware.spec.js +0 -459
  306. package/fesm/modules/cache/cache.module.js +0 -29
  307. package/fesm/modules/cache/cache.module.spec.js +0 -44
  308. package/fesm/modules/datasource/index.js +0 -1
  309. package/fesm/modules/datasource/multi-tenant-datasource.service.js +0 -212
  310. package/fesm/modules/datasource/multi-tenant-datasource.service.spec.js +0 -377
  311. package/fesm/modules/event-bus/event-bus.explorer.js +0 -114
  312. package/fesm/modules/event-bus/event-bus.explorer.spec.js +0 -185
  313. package/fesm/modules/event-bus/event-bus.integration.spec.js +0 -249
  314. package/fesm/modules/event-bus/event-bus.module.js +0 -84
  315. package/fesm/modules/event-bus/event-bus.module.spec.js +0 -145
  316. package/fesm/modules/event-bus/module-events.provider.js +0 -26
  317. package/fesm/modules/event-bus/module-events.provider.spec.js +0 -52
  318. package/fesm/modules/shared-permission-cache/shared-permission-cache.module.js +0 -22
  319. package/fesm/modules/shared-permission-cache/shared-permission-cache.service.js +0 -91
  320. package/fesm/modules/shared-permission-cache/shared-permission-cache.service.spec.js +0 -161
  321. package/fesm/modules/utils/utils.module.js +0 -22
  322. package/fesm/modules/utils/utils.service.js +0 -66
  323. package/fesm/modules/utils/utils.service.spec.js +0 -165
  324. package/fesm/utils/date-time.util.js +0 -70
  325. package/fesm/utils/date-time.util.spec.js +0 -80
  326. package/fesm/utils/event-pattern.util.js +0 -91
  327. package/fesm/utils/event-pattern.util.spec.js +0 -247
  328. package/fesm/utils/html-sanitizer.util.js +0 -69
  329. package/fesm/utils/html-sanitizer.util.spec.js +0 -72
  330. package/fesm/utils/optional-module.util.js +0 -25
  331. package/fesm/utils/optional-module.util.spec.js +0 -10
  332. package/fesm/utils/permission-cache-key.util.js +0 -10
  333. package/fesm/utils/permission-cache-key.util.spec.js +0 -84
  334. package/fesm/utils/query-helpers.util.js +0 -85
  335. package/fesm/utils/query-helpers.util.spec.js +0 -205
  336. package/fesm/utils/request.util.js +0 -81
  337. package/fesm/utils/request.util.spec.js +0 -245
  338. package/fesm/utils/string.util.js +0 -71
  339. package/fesm/utils/string.util.spec.js +0 -59
@@ -1,1133 +0,0 @@
1
- function _define_property(obj, key, value) {
2
- if (key in obj) {
3
- Object.defineProperty(obj, key, {
4
- value: value,
5
- enumerable: true,
6
- configurable: true,
7
- writable: true
8
- });
9
- } else {
10
- obj[key] = value;
11
- }
12
- return obj;
13
- }
14
- import { Logger, InternalServerErrorException, NotFoundException } from '@nestjs/common';
15
- import { createMockRepository, createMockDataSourceProvider } from '@test-utils/mocks/repository.mock';
16
- import { buildMockUser } from '@test-utils/mocks/logged-user.mock';
17
- import { ApiService } from './api-service.class';
18
- import { EventBusRegistry } from './event-bus.registry';
19
- import { UtilsService } from '../modules/utils/utils.service';
20
- import { Identity } from '../entities';
21
- let TestEntity = class TestEntity extends Identity {
22
- constructor(...args){
23
- super(...args), _define_property(this, "name", void 0);
24
- }
25
- };
26
- let TestApiService = class TestApiService extends ApiService {
27
- /** `publishDomainAction` is protected - feature services reach it as subclasses do */ publishAction(action, metadata) {
28
- return this.publishDomainAction(action, {
29
- ids: [
30
- '1'
31
- ],
32
- metadata
33
- });
34
- }
35
- };
36
- function createMockQueryRunner() {
37
- return {
38
- connect: jest.fn(),
39
- startTransaction: jest.fn(),
40
- commitTransaction: jest.fn(),
41
- rollbackTransaction: jest.fn(),
42
- release: jest.fn(),
43
- manager: {
44
- save: jest.fn(),
45
- update: jest.fn(),
46
- delete: jest.fn(),
47
- softDelete: jest.fn(),
48
- restore: jest.fn()
49
- }
50
- };
51
- }
52
- describe('ApiService', ()=>{
53
- let mockRepo;
54
- let mockCache;
55
- let utilsService;
56
- let mockQueryRunner;
57
- let mockUser;
58
- let debugSpy;
59
- let errorLogSpy;
60
- function makeService(isCacheable = false) {
61
- const dataSourceProvider = createMockDataSourceProvider(mockRepo);
62
- return new TestApiService('test-entity', mockCache, utilsService, 'TestApiService', isCacheable, 'app', dataSourceProvider, TestEntity);
63
- }
64
- beforeEach(()=>{
65
- mockRepo = createMockRepository();
66
- mockRepo.create.mockReturnValue({});
67
- mockQueryRunner = createMockQueryRunner();
68
- mockRepo.manager.connection.createQueryRunner = jest.fn().mockReturnValue(mockQueryRunner);
69
- mockCache = {
70
- get: jest.fn(),
71
- set: jest.fn(),
72
- del: jest.fn()
73
- };
74
- utilsService = new UtilsService();
75
- mockUser = buildMockUser();
76
- // LogAction falls back to a real Nest Logger when no moduleName is set — silence it.
77
- debugSpy = jest.spyOn(Logger.prototype, 'debug').mockImplementation(()=>undefined);
78
- errorLogSpy = jest.spyOn(Logger.prototype, 'error').mockImplementation(()=>undefined);
79
- });
80
- afterEach(()=>{
81
- debugSpy.mockRestore();
82
- errorLogSpy.mockRestore();
83
- jest.clearAllMocks();
84
- });
85
- describe('insert', ()=>{
86
- it('should save a new entity and return the converted response dto', async ()=>{
87
- const service = makeService();
88
- const created = {
89
- id: undefined,
90
- name: 'x'
91
- };
92
- mockRepo.create.mockReturnValue(created);
93
- mockQueryRunner.manager.save.mockResolvedValue({
94
- id: 'new-1',
95
- name: 'Widget'
96
- });
97
- const result = await service.insert({
98
- name: 'Widget'
99
- }, mockUser);
100
- expect(mockQueryRunner.connect).toHaveBeenCalled();
101
- expect(mockQueryRunner.startTransaction).toHaveBeenCalled();
102
- expect(mockQueryRunner.manager.save).toHaveBeenCalledWith(mockRepo.target, [
103
- expect.objectContaining({
104
- name: 'Widget'
105
- })
106
- ]);
107
- expect(mockQueryRunner.commitTransaction).toHaveBeenCalled();
108
- expect(mockQueryRunner.release).toHaveBeenCalled();
109
- expect(result).toEqual({
110
- id: 'new-1',
111
- name: 'Widget'
112
- });
113
- });
114
- it('should look up and merge onto the existing entity when the dto carries an id', async ()=>{
115
- const service = makeService();
116
- const existing = {
117
- id: 'existing-1',
118
- name: 'Old'
119
- };
120
- mockRepo.findOne.mockResolvedValue(existing);
121
- mockQueryRunner.manager.save.mockImplementation((_target, entities)=>entities);
122
- await service.insert({
123
- id: 'existing-1',
124
- name: 'New'
125
- }, mockUser);
126
- expect(mockRepo.findOne).toHaveBeenCalledWith({
127
- where: {
128
- id: 'existing-1'
129
- }
130
- });
131
- expect(mockQueryRunner.manager.save).toHaveBeenCalledWith(mockRepo.target, [
132
- expect.objectContaining({
133
- id: 'existing-1',
134
- name: 'New'
135
- })
136
- ]);
137
- });
138
- it('should throw NotFoundException and roll back when the dto id does not match any entity', async ()=>{
139
- const service = makeService();
140
- mockRepo.findOne.mockResolvedValue(null);
141
- await expect(service.insert({
142
- id: 'missing',
143
- name: 'x'
144
- }, mockUser)).rejects.toThrow(NotFoundException);
145
- expect(mockQueryRunner.rollbackTransaction).toHaveBeenCalled();
146
- expect(mockQueryRunner.release).toHaveBeenCalled();
147
- });
148
- it('should roll back and rethrow when save fails', async ()=>{
149
- const service = makeService();
150
- mockQueryRunner.manager.save.mockRejectedValue(new Error('db down'));
151
- await expect(service.insert({
152
- name: 'Widget'
153
- }, mockUser)).rejects.toThrow('db down');
154
- expect(mockQueryRunner.rollbackTransaction).toHaveBeenCalled();
155
- expect(mockQueryRunner.commitTransaction).not.toHaveBeenCalled();
156
- });
157
- it('should wrap a non-Error rejection in InternalServerErrorException', async ()=>{
158
- const service = makeService();
159
- mockQueryRunner.manager.save.mockRejectedValue('raw string failure');
160
- await expect(service.insert({
161
- name: 'Widget'
162
- }, mockUser)).rejects.toThrow(InternalServerErrorException);
163
- });
164
- it('should clear cache entries only when the service is cacheable', async ()=>{
165
- const cacheableService = makeService(true);
166
- mockQueryRunner.manager.save.mockResolvedValue({
167
- id: 'new-1',
168
- name: 'Widget'
169
- });
170
- mockCache.get.mockResolvedValue([]);
171
- await cacheableService.insert({
172
- name: 'Widget'
173
- }, mockUser);
174
- expect(mockCache.del).toHaveBeenCalled();
175
- });
176
- it('should not touch the cache when the service is not cacheable', async ()=>{
177
- const service = makeService(false);
178
- mockQueryRunner.manager.save.mockResolvedValue({
179
- id: 'new-1',
180
- name: 'Widget'
181
- });
182
- await service.insert({
183
- name: 'Widget'
184
- }, mockUser);
185
- expect(mockCache.get).not.toHaveBeenCalled();
186
- expect(mockCache.del).not.toHaveBeenCalled();
187
- });
188
- });
189
- describe('insertMany', ()=>{
190
- it('should save every dto and return one response entry per saved entity', async ()=>{
191
- const service = makeService();
192
- mockQueryRunner.manager.save.mockResolvedValue([
193
- {
194
- id: '1',
195
- name: 'A'
196
- },
197
- {
198
- id: '2',
199
- name: 'B'
200
- }
201
- ]);
202
- const result = await service.insertMany([
203
- {
204
- name: 'A'
205
- },
206
- {
207
- name: 'B'
208
- }
209
- ], mockUser);
210
- expect(result).toEqual([
211
- {
212
- id: '1',
213
- name: 'A'
214
- },
215
- {
216
- id: '2',
217
- name: 'B'
218
- }
219
- ]);
220
- });
221
- });
222
- describe('update / updateMany', ()=>{
223
- it('should update a single entity in place', async ()=>{
224
- const service = makeService();
225
- mockRepo.findOne.mockResolvedValue({
226
- id: '1',
227
- name: 'Old'
228
- });
229
- mockQueryRunner.manager.save.mockResolvedValue({
230
- id: '1',
231
- name: 'Updated'
232
- });
233
- const result = await service.update({
234
- id: '1',
235
- name: 'Updated'
236
- }, mockUser);
237
- expect(result).toEqual({
238
- id: '1',
239
- name: 'Updated'
240
- });
241
- });
242
- it('should update multiple entities and return all of them', async ()=>{
243
- const service = makeService();
244
- mockRepo.findOne.mockResolvedValue({
245
- id: 'x',
246
- name: 'Old'
247
- });
248
- mockQueryRunner.manager.save.mockResolvedValue([
249
- {
250
- id: '1',
251
- name: 'A2'
252
- },
253
- {
254
- id: '2',
255
- name: 'B2'
256
- }
257
- ]);
258
- const result = await service.updateMany([
259
- {
260
- id: '1',
261
- name: 'A2'
262
- },
263
- {
264
- id: '2',
265
- name: 'B2'
266
- }
267
- ], mockUser);
268
- expect(result).toHaveLength(2);
269
- });
270
- it('should throw NotFoundException when the id to update does not exist', async ()=>{
271
- const service = makeService();
272
- mockRepo.findOne.mockResolvedValue(null);
273
- await expect(service.update({
274
- id: 'missing',
275
- name: 'x'
276
- }, mockUser)).rejects.toThrow(NotFoundException);
277
- expect(mockQueryRunner.rollbackTransaction).toHaveBeenCalled();
278
- });
279
- });
280
- describe('bulkUpsert', ()=>{
281
- it('should run insert and update phases and combine the results', async ()=>{
282
- const service = makeService();
283
- mockRepo.findOne.mockResolvedValue({
284
- id: 'existing-1',
285
- name: 'Old'
286
- });
287
- mockQueryRunner.manager.save.mockResolvedValueOnce([
288
- {
289
- id: 'new-1',
290
- name: 'Inserted'
291
- }
292
- ]).mockResolvedValueOnce([
293
- {
294
- id: 'existing-1',
295
- name: 'Updated'
296
- }
297
- ]);
298
- const result = await service.bulkUpsert([
299
- {
300
- name: 'Inserted'
301
- }
302
- ], [
303
- {
304
- id: 'existing-1',
305
- name: 'Updated'
306
- }
307
- ], mockUser);
308
- expect(result).toEqual([
309
- {
310
- id: 'new-1',
311
- name: 'Inserted'
312
- },
313
- {
314
- id: 'existing-1',
315
- name: 'Updated'
316
- }
317
- ]);
318
- expect(mockQueryRunner.manager.save).toHaveBeenCalledTimes(2);
319
- });
320
- it('should skip the insert phase entirely when there is nothing to insert', async ()=>{
321
- const service = makeService();
322
- mockRepo.findOne.mockResolvedValue({
323
- id: 'existing-1',
324
- name: 'Old'
325
- });
326
- mockQueryRunner.manager.save.mockResolvedValue([
327
- {
328
- id: 'existing-1',
329
- name: 'Updated'
330
- }
331
- ]);
332
- await service.bulkUpsert([], [
333
- {
334
- id: 'existing-1',
335
- name: 'Updated'
336
- }
337
- ], mockUser);
338
- expect(mockQueryRunner.manager.save).toHaveBeenCalledTimes(1);
339
- });
340
- it('should skip the update phase entirely when there is nothing to update', async ()=>{
341
- const service = makeService();
342
- mockQueryRunner.manager.save.mockResolvedValue([
343
- {
344
- id: 'new-1',
345
- name: 'Inserted'
346
- }
347
- ]);
348
- await service.bulkUpsert([
349
- {
350
- name: 'Inserted'
351
- }
352
- ], [], mockUser);
353
- expect(mockQueryRunner.manager.save).toHaveBeenCalledTimes(1);
354
- });
355
- });
356
- describe('findByIds', ()=>{
357
- it('should return converted results for matching ids', async ()=>{
358
- const service = makeService();
359
- const qb = mockRepo.createQueryBuilder();
360
- qb.getMany.mockResolvedValue([
361
- {
362
- id: '1',
363
- name: 'A'
364
- },
365
- {
366
- id: '2',
367
- name: 'B'
368
- }
369
- ]);
370
- const result = await service.findByIds([
371
- '1',
372
- '2'
373
- ], mockUser);
374
- const whereArg = qb.where.mock.calls[0][0];
375
- expect(whereArg.id._type).toBe('in');
376
- expect(whereArg.id._value).toEqual([
377
- '1',
378
- '2'
379
- ]);
380
- expect(result).toEqual([
381
- {
382
- id: '1',
383
- name: 'A'
384
- },
385
- {
386
- id: '2',
387
- name: 'B'
388
- }
389
- ]);
390
- });
391
- it('should accept a comma-separated select string and split it', async ()=>{
392
- const service = makeService();
393
- const qb = mockRepo.createQueryBuilder();
394
- qb.getMany.mockResolvedValue([
395
- {
396
- id: '1',
397
- name: 'A'
398
- }
399
- ]);
400
- await service.findByIds([
401
- '1'
402
- ], mockUser, 'id, name');
403
- expect(qb.select).toHaveBeenCalledWith([
404
- 'test-entity.id',
405
- 'test-entity.name'
406
- ]);
407
- });
408
- it('should throw NotFoundException when no rows match', async ()=>{
409
- const service = makeService();
410
- const qb = mockRepo.createQueryBuilder();
411
- qb.getMany.mockResolvedValue([]);
412
- await expect(service.findByIds([
413
- 'missing'
414
- ], mockUser)).rejects.toThrow(NotFoundException);
415
- });
416
- it('should wrap unexpected errors via handleError', async ()=>{
417
- const service = makeService();
418
- const qb = mockRepo.createQueryBuilder();
419
- qb.getMany.mockRejectedValue('boom');
420
- await expect(service.findByIds([
421
- '1'
422
- ], mockUser)).rejects.toThrow(InternalServerErrorException);
423
- });
424
- });
425
- describe('findById', ()=>{
426
- it('should return the converted entity when found', async ()=>{
427
- const service = makeService();
428
- const qb = mockRepo.createQueryBuilder();
429
- qb.getOne.mockResolvedValue({
430
- id: '1',
431
- name: 'A'
432
- });
433
- const result = await service.findById('1', mockUser);
434
- expect(qb.where).toHaveBeenCalledWith({
435
- id: '1'
436
- });
437
- expect(result).toEqual({
438
- id: '1',
439
- name: 'A'
440
- });
441
- });
442
- it('should throw NotFoundException when nothing matches the id', async ()=>{
443
- const service = makeService();
444
- const qb = mockRepo.createQueryBuilder();
445
- qb.getOne.mockResolvedValue(null);
446
- await expect(service.findById('missing', mockUser)).rejects.toThrow(NotFoundException);
447
- });
448
- it('should return the cached value without querying when isCacheable and the cache hits', async ()=>{
449
- const service = makeService(true);
450
- mockCache.get.mockResolvedValue({
451
- id: '1',
452
- name: 'Cached'
453
- });
454
- const qb = mockRepo.createQueryBuilder();
455
- const result = await service.findById('1', mockUser);
456
- expect(result).toEqual({
457
- id: '1',
458
- name: 'Cached'
459
- });
460
- expect(qb.getOne).not.toHaveBeenCalled();
461
- });
462
- it('should query, then populate the cache on a miss when isCacheable', async ()=>{
463
- const service = makeService(true);
464
- mockCache.get.mockResolvedValue(undefined);
465
- const qb = mockRepo.createQueryBuilder();
466
- qb.getOne.mockResolvedValue({
467
- id: '1',
468
- name: 'Fresh'
469
- });
470
- const result = await service.findById('1', mockUser);
471
- expect(result).toEqual({
472
- id: '1',
473
- name: 'Fresh'
474
- });
475
- expect(mockCache.set).toHaveBeenCalledWith(expect.any(String), {
476
- id: '1',
477
- name: 'Fresh'
478
- });
479
- });
480
- it('should never touch the cache when the service is not cacheable', async ()=>{
481
- const service = makeService(false);
482
- const qb = mockRepo.createQueryBuilder();
483
- qb.getOne.mockResolvedValue({
484
- id: '1',
485
- name: 'A'
486
- });
487
- await service.findById('1', mockUser);
488
- expect(mockCache.get).not.toHaveBeenCalled();
489
- expect(mockCache.set).not.toHaveBeenCalled();
490
- });
491
- });
492
- describe('getAll', ()=>{
493
- it('should return paginated, converted results', async ()=>{
494
- const service = makeService();
495
- const qb = mockRepo.createQueryBuilder();
496
- qb.getManyAndCount.mockResolvedValue([
497
- [
498
- {
499
- id: '1',
500
- name: 'A'
501
- }
502
- ],
503
- 1
504
- ]);
505
- const result = await service.getAll('', {
506
- pagination: {
507
- currentPage: 0,
508
- pageSize: 10
509
- }
510
- }, mockUser);
511
- expect(result.data).toEqual([
512
- {
513
- id: '1',
514
- name: 'A'
515
- }
516
- ]);
517
- expect(result.total).toBe(1);
518
- expect(qb.skip).toHaveBeenCalledWith(0);
519
- expect(qb.take).toHaveBeenCalledWith(10);
520
- });
521
- it('should compute the correct offset for page > 0', async ()=>{
522
- const service = makeService();
523
- const qb = mockRepo.createQueryBuilder();
524
- qb.getManyAndCount.mockResolvedValue([
525
- [],
526
- 0
527
- ]);
528
- await service.getAll('', {
529
- pagination: {
530
- currentPage: 2,
531
- pageSize: 25
532
- }
533
- }, mockUser);
534
- expect(qb.skip).toHaveBeenCalledWith(50);
535
- expect(qb.take).toHaveBeenCalledWith(25);
536
- });
537
- it('should apply filter conditions via andWhere', async ()=>{
538
- const service = makeService();
539
- const qb = mockRepo.createQueryBuilder();
540
- qb.getManyAndCount.mockResolvedValue([
541
- [],
542
- 0
543
- ]);
544
- await service.getAll('', {
545
- filter: {
546
- isActive: true
547
- }
548
- }, mockUser);
549
- expect(qb.andWhere).toHaveBeenCalledWith('test-entity.isActive = :value', {
550
- value: true
551
- });
552
- });
553
- it('should apply a global search filter when a search term is given', async ()=>{
554
- const service = makeService();
555
- const qb = mockRepo.createQueryBuilder();
556
- qb.getManyAndCount.mockResolvedValue([
557
- [],
558
- 0
559
- ]);
560
- await service.getAll('widget', {}, mockUser);
561
- expect(qb.andWhere).toHaveBeenCalledWith('test-entity.name LIKE :search', {
562
- search: '%widget%'
563
- });
564
- });
565
- it('should apply sort as addOrderBy', async ()=>{
566
- const service = makeService();
567
- const qb = mockRepo.createQueryBuilder();
568
- qb.getManyAndCount.mockResolvedValue([
569
- [],
570
- 0
571
- ]);
572
- await service.getAll('', {
573
- sort: {
574
- name: 'DESC'
575
- }
576
- }, mockUser);
577
- expect(qb.addOrderBy).toHaveBeenCalledWith('test-entity.name', 'DESC');
578
- });
579
- it('should include soft-deleted rows only when withDeleted is set', async ()=>{
580
- const service = makeService();
581
- const qb = mockRepo.createQueryBuilder();
582
- qb.getManyAndCount.mockResolvedValue([
583
- [],
584
- 0
585
- ]);
586
- qb.withDeleted = jest.fn().mockReturnThis();
587
- await service.getAll('', {
588
- withDeleted: true
589
- }, mockUser);
590
- expect(qb.withDeleted).toHaveBeenCalled();
591
- });
592
- it('should return the cached page without querying on a cache hit', async ()=>{
593
- const service = makeService(true);
594
- const cached = {
595
- data: [
596
- {
597
- id: '1',
598
- name: 'Cached'
599
- }
600
- ],
601
- total: 1
602
- };
603
- mockCache.get.mockResolvedValue(cached);
604
- const qb = mockRepo.createQueryBuilder();
605
- const result = await service.getAll('', {}, mockUser);
606
- expect(result).toBe(cached);
607
- expect(qb.getManyAndCount).not.toHaveBeenCalled();
608
- });
609
- it('should populate the cache after a fresh query on a miss', async ()=>{
610
- const service = makeService(true);
611
- mockCache.get.mockResolvedValue(undefined);
612
- const qb = mockRepo.createQueryBuilder();
613
- qb.getManyAndCount.mockResolvedValue([
614
- [
615
- {
616
- id: '1',
617
- name: 'A'
618
- }
619
- ],
620
- 1
621
- ]);
622
- await service.getAll('', {}, mockUser);
623
- expect(mockCache.set).toHaveBeenCalledWith(expect.any(String), {
624
- data: [
625
- {
626
- id: '1',
627
- name: 'A'
628
- }
629
- ],
630
- total: 1
631
- });
632
- });
633
- it('should wrap query errors via handleError', async ()=>{
634
- const service = makeService();
635
- const qb = mockRepo.createQueryBuilder();
636
- qb.getManyAndCount.mockRejectedValue(new Error('query failed'));
637
- await expect(service.getAll('', {}, mockUser)).rejects.toThrow('query failed');
638
- });
639
- describe('raw query mode', ()=>{
640
- let RawTestApiService = class RawTestApiService extends ApiService {
641
- async getSelectQuery(query) {
642
- return {
643
- query,
644
- isRaw: true
645
- };
646
- }
647
- };
648
- function makeRawService(dbType) {
649
- mockRepo.manager.connection.options.type = dbType;
650
- const dataSourceProvider = createMockDataSourceProvider(mockRepo);
651
- return new RawTestApiService('test-entity', mockCache, utilsService, 'RawTestApiService', false, 'app', dataSourceProvider, TestEntity);
652
- }
653
- function primeRawQueryBuilder(qb) {
654
- qb.expressionMap = {
655
- orderBys: {
656
- x: 'ASC'
657
- }
658
- };
659
- qb.getQuery.mockReturnValue('SELECT * FROM test_entity');
660
- qb.getQueryAndParameters.mockReturnValue([
661
- 'SELECT 1',
662
- []
663
- ]);
664
- qb.getParameters.mockReturnValue({});
665
- }
666
- it('should build a postgres-style positional count query and use getRawMany for data', async ()=>{
667
- const service = makeRawService('postgres');
668
- const qb = mockRepo.createQueryBuilder();
669
- primeRawQueryBuilder(qb);
670
- qb.getRawMany.mockResolvedValue([
671
- {
672
- id: '1',
673
- name: 'Raw'
674
- }
675
- ]);
676
- mockRepo.query.mockResolvedValue([
677
- {
678
- count: '3'
679
- }
680
- ]);
681
- const result = await service.getAll('', {}, mockUser);
682
- expect(mockRepo.query).toHaveBeenCalledWith(expect.stringContaining('SELECT COUNT(*)'), []);
683
- expect(result.total).toBe(3);
684
- expect(result.data).toEqual([
685
- {
686
- id: '1',
687
- name: 'Raw'
688
- }
689
- ]);
690
- });
691
- it('should convert ? placeholders positionally for postgres and throw on a missing parameter', async ()=>{
692
- const service = makeRawService('postgres');
693
- const qb = mockRepo.createQueryBuilder();
694
- primeRawQueryBuilder(qb);
695
- // simulate a parameter referenced in SQL but absent from getParameters()
696
- qb.getQuery = jest.fn().mockReturnValue('SELECT * FROM t WHERE id = :missingKey');
697
- qb.getParameters = jest.fn().mockReturnValue({});
698
- await expect(service.getAll('', {}, mockUser)).rejects.toThrow(InternalServerErrorException);
699
- });
700
- it('should use ? placeholders (unchanged) for mysql', async ()=>{
701
- const service = makeRawService('mysql');
702
- const qb = mockRepo.createQueryBuilder();
703
- primeRawQueryBuilder(qb);
704
- qb.getRawMany.mockResolvedValue([]);
705
- mockRepo.query.mockResolvedValue([
706
- {
707
- count: '0'
708
- }
709
- ]);
710
- await service.getAll('', {}, mockUser);
711
- const [sql] = mockRepo.query.mock.calls[0];
712
- expect(sql).not.toContain('$1');
713
- });
714
- });
715
- });
716
- describe('delete', ()=>{
717
- it('should soft-delete and stamp deletedById for type "delete"', async ()=>{
718
- const service = makeService();
719
- await service.delete({
720
- id: '1',
721
- type: 'delete',
722
- deletedById: 'user-1'
723
- }, mockUser);
724
- expect(mockQueryRunner.manager.softDelete).toHaveBeenCalledWith(mockRepo.target, '1');
725
- expect(mockQueryRunner.manager.update).toHaveBeenCalledWith(mockRepo.target, '1', {
726
- deletedById: 'user-1'
727
- });
728
- expect(mockQueryRunner.commitTransaction).toHaveBeenCalled();
729
- });
730
- it('should restore and stamp deletedById for type "restore"', async ()=>{
731
- const service = makeService();
732
- await service.delete({
733
- id: '1',
734
- type: 'restore'
735
- }, mockUser);
736
- expect(mockQueryRunner.manager.restore).toHaveBeenCalledWith(mockRepo.target, '1');
737
- expect(mockQueryRunner.manager.update).toHaveBeenCalled();
738
- });
739
- it('should hard-delete for any other type', async ()=>{
740
- const service = makeService();
741
- await service.delete({
742
- id: '1',
743
- type: 'permanent'
744
- }, mockUser);
745
- expect(mockQueryRunner.manager.delete).toHaveBeenCalledWith(mockRepo.target, '1');
746
- expect(mockQueryRunner.manager.softDelete).not.toHaveBeenCalled();
747
- });
748
- it('should support deleting multiple ids at once', async ()=>{
749
- const service = makeService();
750
- await service.delete({
751
- id: [
752
- '1',
753
- '2'
754
- ],
755
- type: 'permanent'
756
- }, mockUser);
757
- expect(mockQueryRunner.manager.delete).toHaveBeenCalledWith(mockRepo.target, [
758
- '1',
759
- '2'
760
- ]);
761
- });
762
- it('should roll back and rethrow when the delete operation fails', async ()=>{
763
- const service = makeService();
764
- mockQueryRunner.manager.delete.mockRejectedValue(new Error('fk violation'));
765
- await expect(service.delete({
766
- id: '1',
767
- type: 'permanent'
768
- }, mockUser)).rejects.toThrow('fk violation');
769
- expect(mockQueryRunner.rollbackTransaction).toHaveBeenCalled();
770
- expect(mockQueryRunner.release).toHaveBeenCalled();
771
- });
772
- it('should always attempt cache invalidation, even when the service is not cacheable', async ()=>{
773
- const service = makeService(false);
774
- mockCache.get.mockResolvedValue([]);
775
- await service.delete({
776
- id: '1',
777
- type: 'permanent'
778
- }, mockUser);
779
- expect(mockCache.del).toHaveBeenCalled();
780
- });
781
- it('should always release the query runner even after a successful commit', async ()=>{
782
- const service = makeService();
783
- await service.delete({
784
- id: '1',
785
- type: 'permanent'
786
- }, mockUser);
787
- expect(mockQueryRunner.release).toHaveBeenCalledTimes(1);
788
- });
789
- });
790
- describe('clearCacheForAll / clearCacheForId', ()=>{
791
- it('clearCacheForAll should delegate to utilsService.clearCache with the entity name', async ()=>{
792
- const service = makeService();
793
- const clearSpy = jest.spyOn(utilsService, 'clearCache');
794
- mockCache.get.mockResolvedValue([]);
795
- await service.clearCacheForAll();
796
- expect(clearSpy).toHaveBeenCalledWith('test-entity', mockCache);
797
- });
798
- it('clearCacheForId should clear cache per entity id', async ()=>{
799
- const service = makeService();
800
- const clearSpy = jest.spyOn(utilsService, 'clearCache');
801
- mockCache.get.mockResolvedValue([]);
802
- await service.clearCacheForId([
803
- {
804
- id: 'a'
805
- },
806
- {
807
- id: 'b'
808
- }
809
- ]);
810
- expect(clearSpy).toHaveBeenCalledWith('test-entity', mockCache, 'a');
811
- expect(clearSpy).toHaveBeenCalledWith('test-entity', mockCache, 'b');
812
- });
813
- });
814
- describe('domain events', ()=>{
815
- let publish;
816
- function makeEventService(moduleName = 'test-module') {
817
- const dataSourceProvider = createMockDataSourceProvider(mockRepo);
818
- return new TestApiService('test-entity', mockCache, utilsService, 'TestApiService', false, moduleName, dataSourceProvider, TestEntity);
819
- }
820
- beforeEach(()=>{
821
- publish = jest.fn().mockResolvedValue(undefined);
822
- EventBusRegistry.reset();
823
- EventBusRegistry.setBus({
824
- publish,
825
- subscribe: jest.fn(),
826
- close: jest.fn()
827
- });
828
- EventBusRegistry.configureModule('test-module', {
829
- enabled: true
830
- });
831
- });
832
- afterEach(()=>{
833
- EventBusRegistry.reset();
834
- });
835
- it('should publish a created event after insert commits', async ()=>{
836
- const service = makeEventService();
837
- mockQueryRunner.manager.save.mockResolvedValue({
838
- id: 'new-1',
839
- name: 'Widget'
840
- });
841
- await service.insert({
842
- name: 'Widget'
843
- }, mockUser);
844
- expect(publish).toHaveBeenCalledTimes(1);
845
- expect(publish).toHaveBeenCalledWith(expect.objectContaining({
846
- name: 'test-module.test-entity.created',
847
- module: 'test-module',
848
- entity: 'test-entity',
849
- action: 'created',
850
- payload: expect.objectContaining({
851
- ids: [
852
- 'new-1'
853
- ]
854
- })
855
- }));
856
- });
857
- it('should carry the acting user on the envelope', async ()=>{
858
- const service = makeEventService();
859
- mockQueryRunner.manager.save.mockResolvedValue({
860
- id: 'new-1',
861
- name: 'Widget'
862
- });
863
- await service.insert({
864
- name: 'Widget'
865
- }, mockUser);
866
- expect(publish.mock.calls[0][0].actor).toEqual(expect.objectContaining({
867
- userId: mockUser.id
868
- }));
869
- });
870
- it('should publish one created event carrying every id for insertMany', async ()=>{
871
- const service = makeEventService();
872
- mockQueryRunner.manager.save.mockResolvedValue([
873
- {
874
- id: 'new-1',
875
- name: 'A'
876
- },
877
- {
878
- id: 'new-2',
879
- name: 'B'
880
- }
881
- ]);
882
- await service.insertMany([
883
- {
884
- name: 'A'
885
- },
886
- {
887
- name: 'B'
888
- }
889
- ], mockUser);
890
- expect(publish).toHaveBeenCalledTimes(1);
891
- expect(publish.mock.calls[0][0]).toEqual(expect.objectContaining({
892
- action: 'created',
893
- payload: expect.objectContaining({
894
- ids: [
895
- 'new-1',
896
- 'new-2'
897
- ]
898
- })
899
- }));
900
- });
901
- it('should publish one updated event carrying every id for updateMany', async ()=>{
902
- const service = makeEventService();
903
- mockRepo.findOne.mockResolvedValue({
904
- id: '1',
905
- name: 'Old'
906
- });
907
- mockQueryRunner.manager.save.mockResolvedValue([
908
- {
909
- id: '1',
910
- name: 'A'
911
- },
912
- {
913
- id: '2',
914
- name: 'B'
915
- }
916
- ]);
917
- await service.updateMany([
918
- {
919
- id: '1',
920
- name: 'A'
921
- },
922
- {
923
- id: '2',
924
- name: 'B'
925
- }
926
- ], mockUser);
927
- expect(publish).toHaveBeenCalledTimes(1);
928
- expect(publish.mock.calls[0][0]).toEqual(expect.objectContaining({
929
- action: 'updated',
930
- payload: expect.objectContaining({
931
- ids: [
932
- '1',
933
- '2'
934
- ]
935
- })
936
- }));
937
- });
938
- it('should publish an updated event after update commits', async ()=>{
939
- const service = makeEventService();
940
- mockRepo.findOne.mockResolvedValue({
941
- id: '1',
942
- name: 'Old'
943
- });
944
- mockQueryRunner.manager.save.mockResolvedValue({
945
- id: '1',
946
- name: 'New'
947
- });
948
- await service.update({
949
- id: '1',
950
- name: 'New'
951
- }, mockUser);
952
- expect(publish.mock.calls[0][0]).toEqual(expect.objectContaining({
953
- action: 'updated'
954
- }));
955
- });
956
- it('should publish created and updated separately for a bulk upsert', async ()=>{
957
- const service = makeEventService();
958
- mockRepo.findOne.mockResolvedValue({
959
- id: '1',
960
- name: 'Old'
961
- });
962
- mockQueryRunner.manager.save.mockResolvedValueOnce([
963
- {
964
- id: 'new-1',
965
- name: 'A'
966
- }
967
- ]).mockResolvedValueOnce([
968
- {
969
- id: '1',
970
- name: 'B'
971
- }
972
- ]);
973
- await service.bulkUpsert([
974
- {
975
- name: 'A'
976
- }
977
- ], [
978
- {
979
- id: '1',
980
- name: 'B'
981
- }
982
- ], mockUser);
983
- expect(publish.mock.calls.map(([event])=>event.action)).toEqual([
984
- 'created',
985
- 'updated'
986
- ]);
987
- });
988
- it.each([
989
- [
990
- 'delete',
991
- 'deleted'
992
- ],
993
- [
994
- 'restore',
995
- 'restored'
996
- ],
997
- [
998
- 'permanent',
999
- 'purged'
1000
- ]
1001
- ])('should publish %s as the %s action', async (type, action)=>{
1002
- const service = makeEventService();
1003
- await service.delete({
1004
- id: '1',
1005
- type
1006
- }, mockUser);
1007
- expect(publish.mock.calls[0][0]).toEqual(expect.objectContaining({
1008
- action
1009
- }));
1010
- });
1011
- it('should carry only the ids for a delete, with no row data to duplicate them', async ()=>{
1012
- const service = makeEventService();
1013
- await service.delete({
1014
- id: '1',
1015
- type: 'delete'
1016
- }, mockUser);
1017
- expect(publish.mock.calls[0][0].payload).toEqual({
1018
- ids: [
1019
- '1'
1020
- ]
1021
- });
1022
- });
1023
- it('should publish a domain action under this service module and entity', async ()=>{
1024
- const service = makeEventService();
1025
- await service.publishAction('submitted', {
1026
- formId: 'form-1'
1027
- });
1028
- expect(publish.mock.calls[0][0]).toEqual(expect.objectContaining({
1029
- name: 'test-module.test-entity.submitted',
1030
- module: 'test-module',
1031
- entity: 'test-entity',
1032
- action: 'submitted',
1033
- payload: {
1034
- ids: [
1035
- '1'
1036
- ],
1037
- metadata: {
1038
- formId: 'form-1'
1039
- }
1040
- }
1041
- }));
1042
- });
1043
- it('should hold a domain action to the same allowlist as the CRUD actions', async ()=>{
1044
- EventBusRegistry.configureModule('test-module', {
1045
- enabled: true,
1046
- actions: [
1047
- 'test-entity.submitted'
1048
- ]
1049
- });
1050
- const service = makeEventService();
1051
- await service.publishAction('submitted');
1052
- await service.publishAction('draft-saved');
1053
- expect(publish).toHaveBeenCalledTimes(1);
1054
- expect(publish.mock.calls[0][0].action).toBe('submitted');
1055
- });
1056
- it('should not publish when the module has events disabled', async ()=>{
1057
- EventBusRegistry.configureModule('test-module', {
1058
- enabled: false
1059
- });
1060
- const service = makeEventService();
1061
- mockQueryRunner.manager.save.mockResolvedValue({
1062
- id: 'new-1',
1063
- name: 'Widget'
1064
- });
1065
- await service.insert({
1066
- name: 'Widget'
1067
- }, mockUser);
1068
- expect(publish).not.toHaveBeenCalled();
1069
- });
1070
- it('should not publish for an action the module excluded', async ()=>{
1071
- EventBusRegistry.configureModule('test-module', {
1072
- enabled: true,
1073
- actions: [
1074
- 'deleted'
1075
- ]
1076
- });
1077
- const service = makeEventService();
1078
- mockQueryRunner.manager.save.mockResolvedValue({
1079
- id: 'new-1',
1080
- name: 'Widget'
1081
- });
1082
- await service.insert({
1083
- name: 'Widget'
1084
- }, mockUser);
1085
- expect(publish).not.toHaveBeenCalled();
1086
- });
1087
- it('should omit the row data when the module opts out of payloads', async ()=>{
1088
- EventBusRegistry.configureModule('test-module', {
1089
- enabled: true,
1090
- includePayload: false
1091
- });
1092
- const service = makeEventService();
1093
- mockQueryRunner.manager.save.mockResolvedValue({
1094
- id: 'new-1',
1095
- name: 'Widget'
1096
- });
1097
- await service.insert({
1098
- name: 'Widget'
1099
- }, mockUser);
1100
- expect(publish.mock.calls[0][0].payload).toEqual({
1101
- ids: [
1102
- 'new-1'
1103
- ]
1104
- });
1105
- });
1106
- it('should not fail the write when publishing throws', async ()=>{
1107
- publish.mockRejectedValue(new Error('broker down'));
1108
- const service = makeEventService();
1109
- mockQueryRunner.manager.save.mockResolvedValue({
1110
- id: 'new-1',
1111
- name: 'Widget'
1112
- });
1113
- await expect(service.insert({
1114
- name: 'Widget'
1115
- }, mockUser)).resolves.toEqual({
1116
- id: 'new-1',
1117
- name: 'Widget'
1118
- });
1119
- });
1120
- it('should do nothing when no bus is registered', async ()=>{
1121
- EventBusRegistry.reset();
1122
- const service = makeEventService();
1123
- mockQueryRunner.manager.save.mockResolvedValue({
1124
- id: 'new-1',
1125
- name: 'Widget'
1126
- });
1127
- await expect(service.insert({
1128
- name: 'Widget'
1129
- }, mockUser)).resolves.toBeDefined();
1130
- expect(publish).not.toHaveBeenCalled();
1131
- });
1132
- });
1133
- });