rename prehandling (#121)

Co-authored-by: Igor Savin <[email protected]>

Author: Dosexe

.github/dependabot.yml

@@ -13,6 +13,7 @@ updates:
     open-pull-requests-limit: 10
     ignore:
       - dependency-name: "eslint"
+      - dependency-name: "eslint-plugin-vitest"
     groups:
       lint:
         patterns:

packages/amqp/.eslintrc.json

@@ -6,18 +6,16 @@
     "project": "./tsconfig.json"
   },
   "ignorePatterns": ["node_modules"],
-  "plugins": ["@typescript-eslint", "prettier", "vitest", "import"],
+  "plugins": ["@typescript-eslint", "vitest", "import"],
   "extends": [
     "eslint:recommended",
     "plugin:@typescript-eslint/recommended",
     "plugin:@typescript-eslint/recommended-requiring-type-checking",
-    "plugin:prettier/recommended",
     "plugin:import/recommended",
     "plugin:import/typescript",
     "plugin:vitest/recommended"
   ],
   "rules": {
-    "prettier/prettier": "error",
     "@typescript-eslint/no-empty-interface": "warn",
     "@typescript-eslint/ban-ts-comment": "off",
     "@typescript-eslint/no-use-before-define": "off",

packages/amqp/lib/AbstractAmqpConsumer.ts

@@ -3,7 +3,7 @@ import type {
   BarrierResult,
   DeadLetterQueueOptions,
   Prehandler,
-  PrehandlingOutputs,
+  PreHandlingOutputs,
   QueueConsumer,
   QueueConsumerOptions,
   TransactionObservabilityManager,
@@ -169,12 +169,12 @@ export abstract class AbstractAmqpConsumer<
     message: MessagePayloadType,
     messageType: string,
   ): Promise<Either<'retryLater', 'success'>> {
-    const prehandlerOutput = await this.processPrehandlers(message, messageType)
-    const barrierResult = await this.preHandlerBarrier(message, messageType, prehandlerOutput)
+    const preHandlerOutput = await this.processPrehandlers(message, messageType)
+    const barrierResult = await this.preHandlerBarrier(message, messageType, preHandlerOutput)
 
     if (barrierResult.isPassing) {
       return this.processMessage(message, messageType, {
-        prehandlerOutput,
+        preHandlerOutput,
         barrierOutput: barrierResult.output,
       })
     }
@@ -185,22 +185,22 @@ export abstract class AbstractAmqpConsumer<
     message: MessagePayloadType,
     messageType: string,
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    prehandlingOutputs: PrehandlingOutputs<PrehandlerOutput, any>,
+    preHandlingOutputs: PreHandlingOutputs<PrehandlerOutput, any>,
   ): Promise<Either<'retryLater', 'success'>> {
     const handler = this.handlerContainer.resolveHandler<PrehandlerOutput>(messageType)
-    return handler.handler(message, this.executionContext, prehandlingOutputs)
+    return handler.handler(message, this.executionContext, preHandlingOutputs)
   }
 
   protected override processPrehandlers(message: MessagePayloadType, messageType: string) {
     const handlerConfig = this.handlerContainer.resolveHandler<PrehandlerOutput>(messageType)
 
-    return this.processPrehandlersInternal(handlerConfig.prehandlers, message)
+    return this.processPrehandlersInternal(handlerConfig.preHandlers, message)
   }
 
   protected override async preHandlerBarrier<BarrierOutput>(
     message: MessagePayloadType,
     messageType: string,
-    prehandlerOutput: PrehandlerOutput,
+    preHandlerOutput: PrehandlerOutput,
   ): Promise<BarrierResult<BarrierOutput>> {
     const handler = this.handlerContainer.resolveHandler<PrehandlerOutput, BarrierOutput>(
       messageType,
@@ -210,7 +210,7 @@ export abstract class AbstractAmqpConsumer<
       handler.preHandlerBarrier,
       message,
       this.executionContext,
-      prehandlerOutput,
+      preHandlerOutput,
     )
   }
 
@@ -225,19 +225,19 @@ export abstract class AbstractAmqpConsumer<
 
   // eslint-disable-next-line max-params
   protected override resolveNextFunction(
-    prehandlers: Prehandler<MessagePayloadType, ExecutionContext, unknown>[],
+    preHandlers: Prehandler<MessagePayloadType, ExecutionContext, unknown>[],
     message: MessagePayloadType,
     index: number,
-    prehandlerOutput: PrehandlerOutput,
+    preHandlerOutput: PrehandlerOutput,
     resolve: (value: PrehandlerOutput | PromiseLike<PrehandlerOutput>) => void,
     reject: (err: Error) => void,
   ) {
     return this.resolveNextPreHandlerFunctionInternal(
-      prehandlers,
+      preHandlers,
       this.executionContext,
       message,
       index,
-      prehandlerOutput,
+      preHandlerOutput,
       resolve,
       reject,
     )

packages/amqp/package.json

@@ -36,21 +36,19 @@
     "@message-queue-toolkit/core": "*",
     "@types/amqplib": "^0.10.4",
     "@types/node": "^20.11.25",
-    "@typescript-eslint/eslint-plugin": "^7.1.1",
-    "@typescript-eslint/parser": "^7.1.1",
-    "@vitest/coverage-v8": "^1.4.0",
+    "@typescript-eslint/eslint-plugin": "^7.7.1",
+    "@typescript-eslint/parser": "^7.7.1",
+    "@vitest/coverage-v8": "^1.5.0",
     "amqplib": "^0.10.3",
     "awilix": "^10.0.1",
     "awilix-manager": "^5.1.0",
     "del-cli": "^5.1.0",
     "eslint": "^8.57.0",
-    "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-import": "^2.29.1",
-    "eslint-plugin-prettier": "^5.1.3",
-    "eslint-plugin-vitest": "^0.5.4",
+    "eslint-plugin-vitest": "0.4.1",
     "prettier": "^3.2.5",
-    "typescript": "^5.4.2",
-    "vitest": "^1.4.0"
+    "typescript": "^5.4.5",
+    "vitest": "^1.5.0"
   },
   "homepage": "https://github.com/kibertoad/message-queue-toolkit",
   "repository": {

packages/amqp/test/consumers/AmqpPermissionConsumer.spec.ts

@@ -177,7 +177,7 @@ describe('AmqpPermissionConsumer', () => {
     })
   })
 
-  describe('prehandlers', () => {
+  describe('preHandlers', () => {
     let diContainer: AwilixContainer<Dependencies>
     let publisher: AmqpPermissionPublisher
     beforeEach(async () => {
@@ -191,20 +191,20 @@ describe('AmqpPermissionConsumer', () => {
       await diContainer.dispose()
     })
 
-    it('processes one prehandler', async () => {
+    it('processes one preHandler', async () => {
       expect.assertions(1)
 
       const newConsumer = new AmqpPermissionConsumer(diContainer.cradle, {
-        removeHandlerOverride: async (message, _context, prehandlerOutputs) => {
-          expect(prehandlerOutputs.prehandlerOutput.prehandlerCount).toBe(1)
+        removeHandlerOverride: async (message, _context, preHandlerOutputs) => {
+          expect(preHandlerOutputs.preHandlerOutput.preHandlerCount).toBe(1)
           return {
             result: 'success',
           }
         },
         removePreHandlers: [
-          (message, context, prehandlerOutput, next) => {
-            prehandlerOutput.prehandlerCount = prehandlerOutput.prehandlerCount
-              ? prehandlerOutput.prehandlerCount + 1
+          (message, context, preHandlerOutput, next) => {
+            preHandlerOutput.preHandlerCount = preHandlerOutput.preHandlerCount
+              ? preHandlerOutput.preHandlerCount + 1
               : 1
             next({
               result: 'success',
@@ -224,29 +224,29 @@ describe('AmqpPermissionConsumer', () => {
       await newConsumer.close()
     })
 
-    it('processes two prehandlers', async () => {
+    it('processes two preHandlers', async () => {
       expect.assertions(1)
 
       const newConsumer = new AmqpPermissionConsumer(diContainer.cradle, {
-        removeHandlerOverride: async (message, _context, prehandlerOutputs) => {
-          expect(prehandlerOutputs.prehandlerOutput.prehandlerCount).toBe(11)
+        removeHandlerOverride: async (message, _context, preHandlerOutputs) => {
+          expect(preHandlerOutputs.preHandlerOutput.preHandlerCount).toBe(11)
           return {
             result: 'success',
           }
         },
         removePreHandlers: [
-          (message, context, prehandlerOutput, next) => {
-            prehandlerOutput.prehandlerCount = prehandlerOutput.prehandlerCount
-              ? prehandlerOutput.prehandlerCount + 10
+          (message, context, preHandlerOutput, next) => {
+            preHandlerOutput.preHandlerCount = preHandlerOutput.preHandlerCount
+              ? preHandlerOutput.preHandlerCount + 10
               : 10
             next({
               result: 'success',
             })
           },
 
-          (message, context, prehandlerOutput, next) => {
-            prehandlerOutput.prehandlerCount = prehandlerOutput.prehandlerCount
-              ? prehandlerOutput.prehandlerCount + 1
+          (message, context, preHandlerOutput, next) => {
+            preHandlerOutput.preHandlerCount = preHandlerOutput.preHandlerCount
+              ? preHandlerOutput.preHandlerCount + 1
               : 1
             next({
               result: 'success',

packages/amqp/test/consumers/AmqpPermissionConsumer.ts

@@ -1,5 +1,5 @@
 import type { Either } from '@lokalise/node-core'
-import type { BarrierResult, Prehandler, PrehandlingOutputs } from '@message-queue-toolkit/core'
+import type { BarrierResult, Prehandler, PreHandlingOutputs } from '@message-queue-toolkit/core'
 import { MessageHandlerConfigBuilder } from '@message-queue-toolkit/core'
 
 import type { AMQPConsumerOptions } from '../../lib/AbstractAmqpConsumer'
@@ -20,7 +20,7 @@ type ExecutionContext = {
   incrementAmount: number
 }
 type PrehandlerOutput = {
-  prehandlerCount: number
+  preHandlerCount: number
 }
 
 type AmqpPermissionConsumerOptions = Pick<
@@ -31,7 +31,7 @@ type AmqpPermissionConsumerOptions = Pick<
   removeHandlerOverride?: (
     _message: SupportedEvents,
     context: ExecutionContext,
-    prehandlingOutputs: PrehandlingOutputs<PrehandlerOutput, number>,
+    preHandlingOutputs: PreHandlingOutputs<PrehandlerOutput, number>,
   ) => Promise<Either<'retryLater', 'success'>>
   removePreHandlers?: Prehandler<SupportedEvents, ExecutionContext, PrehandlerOutput>[]
 }
@@ -50,7 +50,7 @@ export class AmqpPermissionConsumer extends AbstractAmqpConsumer<
     const defaultRemoveHandler = async (
       _message: SupportedEvents,
       context: ExecutionContext,
-      _prehandlingOutputs: PrehandlingOutputs<PrehandlerOutput, number>,
+      _preHandlingOutputs: PreHandlingOutputs<PrehandlerOutput, number>,
     ): Promise<Either<'retryLater', 'success'>> => {
       this.removeCounter += context.incrementAmount
       return {
@@ -103,7 +103,7 @@ export class AmqpPermissionConsumer extends AbstractAmqpConsumer<
             PERMISSIONS_REMOVE_MESSAGE_SCHEMA,
             options?.removeHandlerOverride ?? defaultRemoveHandler,
             {
-              prehandlers: options?.removePreHandlers,
+              preHandlers: options?.removePreHandlers,
             },
           )
           .build(),

packages/core/.eslintrc.json

@@ -6,18 +6,16 @@
     "project": "./tsconfig.json"
   },
   "ignorePatterns": ["node_modules"],
-  "plugins": ["@typescript-eslint", "prettier", "vitest", "import"],
+  "plugins": ["@typescript-eslint", "vitest", "import"],
   "extends": [
     "eslint:recommended",
     "plugin:@typescript-eslint/recommended",
     "plugin:@typescript-eslint/recommended-requiring-type-checking",
-    "plugin:prettier/recommended",
     "plugin:import/recommended",
     "plugin:import/typescript",
     "plugin:vitest/recommended"
   ],
   "rules": {
-    "prettier/prettier": "error",
     "@typescript-eslint/no-empty-interface": "warn",
     "@typescript-eslint/ban-ts-comment": "off",
     "@typescript-eslint/no-use-before-define": "off",

packages/core/index.ts

@@ -37,7 +37,7 @@ export type {
   HandlerContainerOptions,
   Handler,
   Prehandler,
-  PrehandlingOutputs,
+  PreHandlingOutputs,
 } from './lib/queues/HandlerContainer'
 export { HandlerSpy } from './lib/queues/HandlerSpy'
 export type { SpyResult, HandlerSpyParams, PublicHandlerSpy } from './lib/queues/HandlerSpy'