core-services-sdk 1.3.35 → 1.3.37

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "core-services-sdk",
-  "version": "1.3.35",
+  "version": "1.3.37",
   "main": "src/index.js",
   "type": "module",
   "types": "types/index.d.ts",

package/src/fastify/error-codes.js

@@ -5,14 +5,12 @@ import httpStatus from 'http-status'
  * Useful as a fallback error descriptor for unhandled or unexpected failures.
  *
  * @typedef {Object} GeneralError
- * @property {number} httpStatusCode - The HTTP status code (500).
- * @property {string} httpStatusText - The human-readable status text ("Internal Server Error").
+ * @property {number} status - The HTTP status code (500).
  * @property {string} code - An application-specific error code in the format "GENERAL.<StatusText>".
  */
 
 /** @type {GeneralError} */
 export const GENERAL_ERROR = {
-  httpStatusCode: httpStatus.INTERNAL_SERVER_ERROR,
-  httpStatusText: httpStatus[httpStatus.INTERNAL_SERVER_ERROR],
+  status: httpStatus.INTERNAL_SERVER_ERROR,
   code: `GENERAL.${httpStatus[httpStatus.INTERNAL_SERVER_ERROR]}`,
 }

package/src/fastify/error-handlers/with-error-handling.js

@@ -48,8 +48,8 @@ export const withErrorHandlingReply =
     try {
       return await withErrorHandling(log, defaultError)(funcToInvoke)
     } catch (error) {
-      const { code, httpStatusText, httpStatusCode } = error
-      reply.status(httpStatusCode).send({ code, httpStatusText })
+      const { code, status } = error
+      reply.status(status).send({ code })
     }
   }
 
@@ -81,12 +81,11 @@ export const replyOnErrorOnly =
         errorMerged.stack = error.stack
       }
 
-      const exposed =
-        errorMerged.message ?? errorMerged.code ?? GENERAL_ERROR.httpStatusText
+      const exposed = errorMerged.message ?? errorMerged.code
 
       const status =
-        errorMerged.httpStatusCode && errorMerged.httpStatusCode in httpStatus
-          ? errorMerged.httpStatusCode
+        errorMerged.status && errorMerged.status in httpStatus
+          ? errorMerged.status
           : httpStatus.INTERNAL_SERVER_ERROR
 
       reply.status(status).send({ error: exposed })

package/src/http/HttpError.js

@@ -15,13 +15,7 @@ export class HttpError extends Error {
    * @type {number | undefined}
    * HTTP status code associated with the error (e.g., 400, 500).
    */
-  httpStatusCode
-
-  /**
-   * @type {string | undefined}
-   * Human-readable HTTP status text (e.g., "Bad Request").
-   */
-  httpStatusText
+  status
 
   /**
    * @type {object | undefined}
@@ -35,24 +29,16 @@ export class HttpError extends Error {
    * @param {Object} [error] - Optional error object.
    * @param {string | number} [error.code] - Application-specific error code.
    * @param {string} [error.message] - Custom error message.
-   * @param {number} [error.httpStatusCode] - HTTP status code (e.g., 404, 500).
-   * @param {string} [error.httpStatusText] - Optional human-readable HTTP status text.
+   * @param {number} [error.status] - HTTP status code (e.g., 404, 500).
    * @param {object} [error.extendInfo] - Optional extended metadata for diagnostics.
    */
   constructor(error = {}) {
-    const { code, message, httpStatusCode, httpStatusText, extendInfo } = error
+    const { code, status, message, extendInfo } = error
 
-    super(
-      message ||
-        (httpStatusCode && httpStatus[httpStatusCode]) ||
-        code ||
-        'Unknown error',
-    )
+    super(message || (status && httpStatus[status]) || code || 'Unknown error')
 
     this.code = code
-    this.httpStatusCode = httpStatusCode
-    this.httpStatusText =
-      httpStatusText || (httpStatusCode && httpStatus[httpStatusCode])
+    this.status = status
     this.extendInfo = extendInfo
 
     if (typeof Error.captureStackTrace === 'function') {
@@ -81,8 +67,7 @@ export class HttpError extends Error {
       instance &&
       typeof instance === 'object' &&
       'message' in instance &&
-      'httpStatusCode' in instance &&
-      'httpStatusText' in instance
+      'status' in instance
     )
   }
 
@@ -92,8 +77,7 @@ export class HttpError extends Error {
    * @returns {{
    *   code: string | number | undefined,
    *   message: string,
-   *   httpStatusCode: number | undefined,
-   *   httpStatusText: string | undefined,
+   *   status: number | undefined,
    *   extendInfo?: object
    * }}
    */
@@ -101,8 +85,7 @@ export class HttpError extends Error {
     return {
       code: this.code,
       message: this.message,
-      httpStatusCode: this.httpStatusCode,
-      httpStatusText: this.httpStatusText,
+      status: this.status,
       ...(this.extendInfo ? { extendInfo: this.extendInfo } : {}),
     }
   }
@@ -118,8 +101,7 @@ export class HttpError extends Error {
       error instanceof HttpError ||
       (error &&
         typeof error === 'object' &&
-        'httpStatusCode' in error &&
-        'httpStatusText' in error &&
+        'status' in error &&
         'toJSON' in error)
     )
   }
@@ -138,8 +120,7 @@ export class HttpError extends Error {
     const httpError = new HttpError({
       code: 'UNHANDLED_ERROR',
       message: error.message || 'An unexpected error occurred',
-      httpStatusCode: httpStatus.INTERNAL_SERVER_ERROR,
-      httpStatusText: httpStatus[httpStatus.INTERNAL_SERVER_ERROR],
+      status: httpStatus.INTERNAL_SERVER_ERROR,
     })
 
     httpError.stack = error.stack

package/src/http/http.js

@@ -36,11 +36,10 @@ const isOkStatus = ({ status }) =>
 const checkStatus = async (response) => {
   if (!isOkStatus(response)) {
     const text = await response.text()
-    const { status, statusText } = response
+    const { status } = response
     throw new HttpError({
+      status,
       code: status,
-      httpStatusCode: status,
-      httpStatusText: statusText,
       extendInfo: { text },
     })
   }

package/src/rabbit-mq/rabbit-mq.js

@@ -46,7 +46,7 @@ export const connectQueueService = async ({ host, log }) => {
  * Creates a channel from a RabbitMQ connection.
  *
  * @param {{ host: string, log: import('pino').Logger }} options
- * @returns {Promise<amqp.Channel>}
+ * @returns {Promise<{ channel: amqp.Channel, connection: amqp.Connection }>}
  */
 export const createChannel = async ({ host, log }) => {
   const t0 = Date.now()
@@ -65,7 +65,7 @@ export const createChannel = async ({ host, log }) => {
       ms: Date.now() - t0,
     })
 
-    return channel
+    return { channel, connection }
   } catch (err) {
     logger.error(err, {
       event: 'error',
@@ -96,7 +96,7 @@ const parseMessage = (msgInfo) => {
  * @param {boolean} [options.nackOnError=false] - Whether to nack the message on error (default: false)
  * @param {number} [options.prefetch=1] - Max unacked messages per consumer (default: 1)
  *
- * @returns {Promise<void>}
+ * @returns {Promise<string>} Returns the consumer tag for later cancellation
  */
 export const subscribeToQueue = async ({
   log,
@@ -112,7 +112,7 @@ export const subscribeToQueue = async ({
     await channel.assertQueue(queue, { durable: true })
     !!prefetch && (await channel.prefetch(prefetch))
 
-    channel.consume(queue, async (msgInfo) => {
+    const { consumerTag } = await channel.consume(queue, async (msgInfo) => {
       if (!msgInfo) {
         return
       }
@@ -143,6 +143,9 @@ export const subscribeToQueue = async ({
         return
       }
     })
+
+    logger.debug({ consumerTag }, 'consumer-started')
+    return consumerTag
   } catch (err) {
     logger.error(err, {
       event: 'error',
@@ -164,12 +167,14 @@ export const subscribeToQueue = async ({
  *     queue: string,
  *     onReceive: (data: any, correlationId?: string) => Promise<void>,
  *     nackOnError?: boolean
- *   }) => Promise<void>,
- *   channel: amqp.Channel
+ *   }) => Promise<string>,
+ *   channel: amqp.Channel,
+ *   connection: amqp.Connection,
+ *   close: () => Promise<void>
  * }>}
  */
 export const initializeQueue = async ({ host, log }) => {
-  const channel = await createChannel({ host, log })
+  const { channel, connection } = await createChannel({ host, log })
   const logger = log.child({ op: 'initializeQueue', host: mask(host) })
 
   /**
@@ -224,16 +229,45 @@ export const initializeQueue = async ({ host, log }) => {
    *   onReceive: (data: any, correlationId?: string) => Promise<void>,
    *   nackOnError?: boolean
    * }} options
-   * @returns {Promise<void>}
+   * @returns {Promise<string>} Returns the consumer tag for later cancellation
    */
   const subscribe = async ({ queue, onReceive, nackOnError = false }) => {
     return subscribeToQueue({ channel, queue, onReceive, log, nackOnError })
   }
 
+  /**
+   * Gracefully closes the RabbitMQ channel and connection.
+   *
+   * @returns {Promise<void>}
+   */
+  const close = async () => {
+    const t0 = Date.now()
+    const logChild = logger.child({ op: 'close' })
+
+    try {
+      logChild.debug('closing-channel-and-connection')
+      await channel.close()
+      await connection.close()
+
+      logChild.info({
+        event: 'ok',
+        ms: Date.now() - t0,
+      })
+    } catch (err) {
+      logChild.error(err, {
+        event: 'error',
+        ms: Date.now() - t0,
+      })
+      throw err
+    }
+  }
+
   return {
     channel,
+    connection,
     publish,
     subscribe,
+    close,
   }
 }
 

package/tests/fastify/error-handler.unit.test.js

@@ -5,13 +5,7 @@ import { GENERAL_ERROR } from '../../src/fastify/error-codes.js'
 
 describe('GENERAL_ERROR', () => {
   it('should have correct status code', () => {
-    expect(GENERAL_ERROR.httpStatusCode).toBe(httpStatus.INTERNAL_SERVER_ERROR)
-  })
-
-  it('should have correct status text', () => {
-    expect(GENERAL_ERROR.httpStatusText).toBe(
-      httpStatus[httpStatus.INTERNAL_SERVER_ERROR],
-    )
+    expect(GENERAL_ERROR.status).toBe(httpStatus.INTERNAL_SERVER_ERROR)
   })
 
   it('should have correct code format', () => {
@@ -22,15 +16,13 @@ describe('GENERAL_ERROR', () => {
   })
 
   it('should have all required properties and types', () => {
-    expect(typeof GENERAL_ERROR.httpStatusCode).toBe('number')
-    expect(typeof GENERAL_ERROR.httpStatusText).toBe('string')
+    expect(typeof GENERAL_ERROR.status).toBe('number')
     expect(typeof GENERAL_ERROR.code).toBe('string')
   })
 
   it('should match full expected structure', () => {
     const expected = {
-      httpStatusCode: 500,
-      httpStatusText: 'Internal Server Error',
+      status: httpStatus.INTERNAL_SERVER_ERROR,
       code: 'GENERAL.Internal Server Error',
     }
 

package/tests/fastify/error-handlers/with-error-handling.test.js

@@ -25,7 +25,7 @@ describe('withErrorHandling', () => {
   it('should rethrow HttpError', async () => {
     const err = new HttpError({
       message: 'Bad',
-      httpStatusCode: httpStatus.BAD_REQUEST,
+      status: httpStatus.BAD_REQUEST,
     })
     const fn = vi.fn().mockRejectedValue(err)
 
@@ -65,8 +65,7 @@ describe('withErrorHandlingReply', () => {
     const err = new HttpError({
       message: 'not found',
       code: 'NOT_FOUND',
-      httpStatusCode: httpStatus.NOT_FOUND,
-      httpStatusText: httpStatus[httpStatus.NOT_FOUND],
+      status: httpStatus.NOT_FOUND,
     })
 
     const fn = vi.fn().mockRejectedValue(err)
@@ -75,7 +74,6 @@ describe('withErrorHandlingReply', () => {
     expect(reply.status).toHaveBeenCalledWith(httpStatus.NOT_FOUND)
     expect(reply.send).toHaveBeenCalledWith({
       code: 'NOT_FOUND',
-      httpStatusText: 'Not Found',
     })
   })
 })
@@ -112,8 +110,7 @@ describe('replyOnErrorOnly', () => {
     const err = new HttpError({
       message: 'forbidden',
       code: 'NO_ACCESS',
-      httpStatusCode: httpStatus.FORBIDDEN,
-      httpStatusText: httpStatus[httpStatus.FORBIDDEN],
+      status: httpStatus.FORBIDDEN,
     })
 
     const fn = vi.fn().mockRejectedValue(err)

package/tests/http/HttpError.unit.test.js

@@ -8,26 +8,24 @@ describe('HttpError', () => {
     const error = new HttpError({
       code: 'INVALID_INPUT',
       message: 'Invalid input provided',
-      httpStatusCode: 400,
+      status: httpStatus.BAD_REQUEST,
       extendInfo: { field: 'email', reason: 'missing' },
     })
 
     expect(error).toBeInstanceOf(HttpError)
     expect(error.message).toBe('Invalid input provided')
     expect(error.code).toBe('INVALID_INPUT')
-    expect(error.httpStatusCode).toBe(400)
-    expect(error.httpStatusText).toBe(httpStatus[400])
+    expect(error.status).toBe(httpStatus.BAD_REQUEST)
     expect(error.extendInfo).toEqual({ field: 'email', reason: 'missing' })
   })
 
   it('should fallback to default message from status if message is missing', () => {
     const error = new HttpError({
       code: 'BAD_REQUEST',
-      httpStatusCode: 400,
+      status: httpStatus.BAD_REQUEST,
     })
 
-    expect(error.message).toBe(httpStatus[400])
-    expect(error.httpStatusText).toBe(httpStatus[400])
+    expect(error.message).toBe(httpStatus[httpStatus.BAD_REQUEST])
     expect(error.extendInfo).toBeUndefined()
   })
 
@@ -35,7 +33,7 @@ describe('HttpError', () => {
     const error = new HttpError({ code: 'ERROR_CODE_ONLY' })
 
     expect(error.message).toBe('ERROR_CODE_ONLY')
-    expect(error.httpStatusCode).toBeUndefined()
+    expect(error.status).toBeUndefined()
     expect(error.extendInfo).toBeUndefined()
   })
 
@@ -50,14 +48,13 @@ describe('HttpError', () => {
     const error = new HttpError({
       code: 'NOT_FOUND',
       message: 'Resource not found',
-      httpStatusCode: 404,
+      status: httpStatus.NOT_FOUND,
     })
 
     expect(error.toJSON()).toEqual({
       code: 'NOT_FOUND',
       message: 'Resource not found',
-      httpStatusCode: 404,
-      httpStatusText: httpStatus[404],
+      status: httpStatus.NOT_FOUND,
     })
   })
 
@@ -65,15 +62,14 @@ describe('HttpError', () => {
     const error = new HttpError({
       code: 'NOT_FOUND',
       message: 'Resource not found',
-      httpStatusCode: 404,
+      status: httpStatus.NOT_FOUND,
       extendInfo: { resource: 'user', id: 123 },
     })
 
     expect(error.toJSON()).toEqual({
       code: 'NOT_FOUND',
       message: 'Resource not found',
-      httpStatusCode: 404,
-      httpStatusText: httpStatus[404],
+      status: httpStatus.NOT_FOUND,
       extendInfo: { resource: 'user', id: 123 },
     })
   })
@@ -81,7 +77,7 @@ describe('HttpError', () => {
   it('should detect instance using isHttpError', () => {
     const error = new HttpError({
       code: 'TEST',
-      httpStatusCode: 500,
+      status: httpStatus.INTERNAL_SERVER_ERROR,
     })
 
     expect(HttpError.isHttpError(error)).toBe(true)
@@ -91,7 +87,7 @@ describe('HttpError', () => {
   it('FromError should return same instance if already HttpError', () => {
     const original = new HttpError({
       code: 'ALREADY_HTTP',
-      httpStatusCode: 401,
+      status: httpStatus.UNAUTHORIZED,
     })
     const result = HttpError.FromError(original)
 
@@ -105,8 +101,8 @@ describe('HttpError', () => {
     expect(httpError).toBeInstanceOf(HttpError)
     expect(httpError.message).toBe('Boom!')
     expect(httpError.code).toBe('UNHANDLED_ERROR')
-    expect(httpError.httpStatusCode).toBe(500)
-    expect(httpError.httpStatusText).toBe(httpStatus[500])
+    expect(httpError.status).toBe(httpStatus.INTERNAL_SERVER_ERROR)
+
     expect(httpError.extendInfo).toBeUndefined()
   })
 })

package/types/fastify/error-codes.d.ts

@@ -3,27 +3,22 @@
  * Useful as a fallback error descriptor for unhandled or unexpected failures.
  *
  * @typedef {Object} GeneralError
- * @property {number} httpStatusCode - The HTTP status code (500).
- * @property {string} httpStatusText - The human-readable status text ("Internal Server Error").
+ * @property {number} status - The HTTP status code (500).
  * @property {string} code - An application-specific error code in the format "GENERAL.<StatusText>".
  */
 /** @type {GeneralError} */
-export const GENERAL_ERROR: GeneralError;
+export const GENERAL_ERROR: GeneralError
 /**
  * A reusable generic error object representing a server-side failure (HTTP 500).
  * Useful as a fallback error descriptor for unhandled or unexpected failures.
  */
 export type GeneralError = {
-    /**
-     * - The HTTP status code (500).
-     */
-    httpStatusCode: number;
-    /**
-     * - The human-readable status text ("Internal Server Error").
-     */
-    httpStatusText: string;
-    /**
-     * - An application-specific error code in the format "GENERAL.<StatusText>".
-     */
-    code: string;
-};
+  /**
+   * - The HTTP status code (500).
+   */
+  status: number
+  /**
+   * - An application-specific error code in the format "GENERAL.<StatusText>".
+   */
+  code: string
+}

package/types/http/HttpError.d.ts

@@ -3,80 +3,72 @@
  * Useful for consistent error handling across services.
  */
 export class HttpError extends Error {
-    /**
-     * Checks if a given object is an instance of `HttpError`.
-     *
-     * @param {*} instance - The object to check.
-     * @returns {boolean} True if `instance` is an instance of `HttpError`.
-     */
-    static isInstanceOf(instance: any): boolean;
-    /**
-     * Checks if the error is an instance of `HttpError` or has similar shape.
-     *
-     * @param {object} error
-     * @returns {error is HttpError}
-     */
-    static isHttpError(error: object): error is HttpError;
-    /**
-     * Creates an HttpError from a generic Error instance or returns it if already an HttpError.
-     *
-     * @param {Error | HttpError} error
-     * @returns {HttpError}
-     */
-    static FromError(error: Error | HttpError): HttpError;
-    /**
-     * Creates an instance of HttpError.
-     *
-     * @param {Object} [error] - Optional error object.
-     * @param {string | number} [error.code] - Application-specific error code.
-     * @param {string} [error.message] - Custom error message.
-     * @param {number} [error.httpStatusCode] - HTTP status code (e.g., 404, 500).
-     * @param {string} [error.httpStatusText] - Optional human-readable HTTP status text.
-     * @param {object} [error.extendInfo] - Optional extended metadata for diagnostics.
-     */
-    constructor(error?: {
-        code?: string | number;
-        message?: string;
-        httpStatusCode?: number;
-        httpStatusText?: string;
-        extendInfo?: object;
-    });
-    /**
-     * @type {string | number | undefined}
-     * A short application-specific error code (e.g., "INVALID_INPUT" or a numeric code).
-     */
-    code: string | number | undefined;
-    /**
-     * @type {number | undefined}
-     * HTTP status code associated with the error (e.g., 400, 500).
-     */
-    httpStatusCode: number | undefined;
-    /**
-     * @type {string | undefined}
-     * Human-readable HTTP status text (e.g., "Bad Request").
-     */
-    httpStatusText: string | undefined;
-    /**
-     * @type {object | undefined}
-     * Optional metadata for debugging/logging (e.g., request ID, user ID, retryAfter).
-     */
-    extendInfo: object | undefined;
-    /**
-     * Converts the error to a plain object (useful for logging or sending as JSON).
-     *
-     * @returns {{
-     *   code: string | number | undefined,
-     *   message: string,
-     *   httpStatusCode: number | undefined,
-     *   httpStatusText: string | undefined,
-     *   extendInfo?: object
-     * }}
-     */
-    toJSON(): {
-        code: string | number | undefined;
-        message: string;
-        httpStatusCode: number | undefined;
-        httpStatusText: string | undefined;
-        extendInfo?: object;
-    };
+  /**
+   * Checks if a given object is an instance of `HttpError`.
+   *
+   * @param {*} instance - The object to check.
+   * @returns {boolean} True if `instance` is an instance of `HttpError`.
+   */
+  static isInstanceOf(instance: any): boolean
+  /**
+   * Checks if the error is an instance of `HttpError` or has similar shape.
+   *
+   * @param {object} error
+   * @returns {error is HttpError}
+   */
+  static isHttpError(error: object): error is HttpError
+  /**
+   * Creates an HttpError from a generic Error instance or returns it if already an HttpError.
+   *
+   * @param {Error | HttpError} error
+   * @returns {HttpError}
+   */
+  static FromError(error: Error | HttpError): HttpError
+  /**
+   * Creates an instance of HttpError.
+   *
+   * @param {Object} [error] - Optional error object.
+   * @param {string | number} [error.code] - Application-specific error code.
+   * @param {string} [error.message] - Custom error message.
+   * @param {number} [error.status] - HTTP status code (e.g., 404, 500).
+   * @param {object} [error.extendInfo] - Optional extended metadata for diagnostics.
+   */
+  constructor(error?: {
+    code?: string | number
+    message?: string
+    status?: number
+
+    extendInfo?: object
+  })
+  /**
+   * @type {string | number | undefined}
+   * A short application-specific error code (e.g., "INVALID_INPUT" or a numeric code).
+   */
+  code: string | number | undefined
+  /**
+   * @type {number | undefined}
+   * HTTP status code associated with the error (e.g., 400, 500).
+   */
+  httpStatusCode: number | undefined
+  /**
+   * @type {string | undefined}
+   * Human-readable HTTP status text (e.g., "Bad Request").
+   */
+  extendInfo: object | undefined
+  /**
+   * Converts the error to a plain object (useful for logging or sending as JSON).
+   *
+   * @returns {{
+   *   code: string | number | undefined,
+   *   message: string,
+   *   status: number | undefined,
+   *   extendInfo?: object
+   * }}
+   */
+  toJSON(): {
+    code: string | number | undefined
+    message: string
+    status: number | undefined
+    extendInfo?: object
+  }
 }