[draft] refactor for readable and add tests

.eslintignore

@@ -1,6 +1,7 @@
 node_modules/
 dist/
 lib/
+coverage/
 
 docs/.docusaurus/
 docs/build/

.gitignore

@@ -1,4 +1,5 @@
 node_modules
 .vscode
 lib
-.env
+.env
+coverage/

.npmignore

@@ -3,6 +3,7 @@ node_modules
 src
 .gitignore
 .prettierrc
+coverage/
 
 *.md
 !README*.md

.prettierignore

@@ -1,6 +1,7 @@
 node_modules/
 dist/
 lib/
+coverage/
 
 docs/.docusaurus/
 docs/build/

jest.config.ts

@@ -1,4 +1,9 @@
 module.exports = {
     preset: 'ts-jest',
     testEnvironment: 'node',
+    coverageThreshold: {
+        global: {
+            lines: 80,
+        },
+    },
 };

package.json

@@ -16,6 +16,7 @@
         "build": "rimraf ./lib && tsc",
         "prepare": "npm run build",
         "test": "jest",
+        "test:cov": "jest --coverage",
         "release": "npm version patch && git push --follow-tags",
         "lint": "eslint .",
         "lint:fix": "eslint . --fix",

src/utils/common.ts

@@ -1,10 +1,10 @@
-import timezone from 'moment-timezone';
+import { tz } from 'moment-timezone';
+import crypto, { BinaryLike } from 'node:crypto';
 import { RESPONSE_MAP } from '../constants/response-map.constant';
 import { HashAlgorithm, VnpLocale } from '../enums';
-import crypto, { BinaryLike } from 'crypto';
 
-export function getDateInGMT7(date: Date): Date {
-    return timezone(new Date()).tz('Asia/Ho_Chi_Minh').toDate();
+export function getDateInGMT7(date?: Date): Date {
+    return tz(date ?? new Date(), 'Asia/Ho_Chi_Minh').toDate();
 }
 
 /**
@@ -40,7 +40,7 @@ export function dateFormat(date: Date, format = 'yyyyMMddHHmmss'): number {
  * @param dateNumber An vnpay date format number
  * @returns Date
  */
-export function parseDate(dateNumber: number | string): Date {
+export function parseDate(dateNumber: number | string, tz: 'utc' | 'local' = 'local'): Date {
     const dateString = dateNumber.toString();
 
     const year = parseInt(dateString.slice(0, 4));
@@ -50,7 +50,9 @@ export function parseDate(dateNumber: number | string): Date {
     const minute = parseInt(dateString.slice(10, 12));
     const second = parseInt(dateString.slice(12, 14));
 
-    return new Date(year, month, day, hour, minute, second);
+    return tz === 'local'
+        ? new Date(year, month, day, hour, minute, second)
+        : new Date(Date.UTC(year, month, day, hour, minute, second));
 }
 
 /**

src/utils/index.ts

@@ -1,2 +1,3 @@
 export * from './common';
 export * from './logger';
+export * from './payment.util';

src/utils/logger.ts

@@ -1,4 +1,4 @@
-import * as fs from 'fs';
+import * as fs from 'node:fs';
 
 /**
  * Truyền vào `loggerFn` để bỏ qua logger
@@ -14,8 +14,10 @@ export function ignoreLogger(): void {}
  * @en Log data to console
  * @param data - Data to be logged
  */
-export function consoleLogger(data: unknown): void {
-    console.log(data);
+export function consoleLogger(data: unknown, symbol: keyof Console = 'log'): void {
+    if (typeof console[symbol] === 'function') {
+        (console[symbol] as (...data: unknown[]) => void)(data);
+    }
 }
 
 /**

src/utils/payment.util.ts

@@ -0,0 +1,53 @@
+import { PAYMENT_ENDPOINT, VNPAY_GATEWAY_SANDBOX_HOST } from '../constants';
+import { HashAlgorithm } from '../enums';
+import { BuildPaymentUrl, DefaultConfig, GlobalConfig } from '../types';
+import { hash, resolveUrlString } from './common';
+
+export function buildPaymentUrlSearchParams(data: Record<string, any>): URLSearchParams {
+    const searchParams = new URLSearchParams();
+    Object.entries(data)
+        .sort(([key1], [key2]) => key1.toString().localeCompare(key2.toString()))
+        .forEach(([key, value]) => {
+            // Skip empty value
+            if (value === '' || value === undefined || value === null) {
+                return;
+            }
+            searchParams.set(key, value.toString());
+        });
+    return searchParams;
+}
+
+export function createPaymentUrl(
+    config: Pick<GlobalConfig, 'vnpayHost' | 'paymentEndpoint'>,
+    data: (BuildPaymentUrl & DefaultConfig) | Record<string, any>,
+): URL {
+    const redirectUrl = new URL(
+        resolveUrlString(
+            config.vnpayHost ?? VNPAY_GATEWAY_SANDBOX_HOST,
+            config.paymentEndpoint ?? PAYMENT_ENDPOINT,
+        ),
+    );
+    buildPaymentUrlSearchParams(data).forEach((value, key) => {
+        redirectUrl.searchParams.set(key, value);
+    });
+    return redirectUrl;
+}
+
+export function calculateSecureHash(
+    secureSecret: string,
+    data: string,
+    hashAlgorithm: HashAlgorithm,
+    bufferEncode: BufferEncoding = 'utf-8',
+): string {
+    return hash(secureSecret, Buffer.from(data, bufferEncode), hashAlgorithm);
+}
+
+export function verifySecureHash(
+    secureSecret: string,
+    data: string,
+    hashAlgorithm: HashAlgorithm,
+    receivedHash: string,
+): boolean {
+    const calculatedHash = calculateSecureHash(secureSecret, data, hashAlgorithm);
+    return calculatedHash === receivedHash;
+}

src/vnpay.ts

@@ -51,6 +51,12 @@ import { Bank } from './types/bank.type';
 import { DefaultConfig, GlobalConfig } from './types/common.type';
 import { consoleLogger, ignoreLogger } from './utils';
 import { LoggerOptions } from './types/logger.type';
+import {
+    buildPaymentUrlSearchParams,
+    calculateSecureHash,
+    createPaymentUrl,
+    verifySecureHash,
+} from './utils/payment.util';
 
 /**
  * Lớp hỗ trợ thanh toán qua VNPay
@@ -184,39 +190,25 @@ export class VNPay {
         const dataToBuild = {
             ...this.defaultConfig,
             ...data,
-        };
 
-        /**
-         * Multiply by 100 to follow VNPay standard, see docs for more detail
-         */
-        dataToBuild.vnp_Amount = dataToBuild.vnp_Amount * 100;
+            /**
+             * Multiply by 100 to follow VNPay standard, see docs for more detail
+             */
+            vnp_Amount: data.vnp_Amount * 100,
+        };
 
         if (!isValidVnpayDateFormat(dataToBuild?.vnp_CreateDate ?? 0)) {
             const timeGMT7 = timezone(new Date()).tz('Asia/Ho_Chi_Minh').format();
             dataToBuild.vnp_CreateDate = dateFormat(new Date(timeGMT7), 'yyyyMMddHHmmss');
         }
 
-        const redirectUrl = new URL(
-            resolveUrlString(
-                this.globalDefaultConfig.vnpayHost ?? VNPAY_GATEWAY_SANDBOX_HOST,
-                this.globalDefaultConfig.paymentEndpoint ?? PAYMENT_ENDPOINT,
-            ),
-        );
-        Object.entries(dataToBuild)
-            .sort(([key1], [key2]) => key1.toString().localeCompare(key2.toString()))
-            .forEach(([key, value]) => {
-                // Skip empty value
-                if (!value || value === '' || value === undefined || value === null) {
-                    return;
-                }
-
-                redirectUrl.searchParams.append(key, value.toString());
-            });
+        const redirectUrl = createPaymentUrl(this.globalDefaultConfig, dataToBuild);
 
-        const signed = hash(
+        const signed = calculateSecureHash(
             this.globalDefaultConfig.secureSecret,
-            Buffer.from(redirectUrl.search.slice(1).toString(), this.BUFFER_ENCODE),
+            redirectUrl.search.slice(1).toString(),
             this.HASH_ALGORITHM,
+            this.BUFFER_ENCODE,
         );
         redirectUrl.searchParams.append('vnp_SecureHash', signed);
 
@@ -251,49 +243,39 @@ export class VNPay {
         query: ReturnQueryFromVNPay,
         options?: VerifyReturnUrlOptions<LoggerFields>,
     ): VerifyReturnUrl {
-        const { vnp_SecureHash, vnp_SecureHashType, ...cloneQuery } = query;
+        const { vnp_SecureHash = '', vnp_SecureHashType, ...cloneQuery } = query;
 
         if (typeof cloneQuery?.vnp_Amount !== 'number') {
-            const res = numberRegex.test(cloneQuery?.vnp_Amount ?? '');
-            if (!res) {
+            const isValidAmount = numberRegex.test(cloneQuery?.vnp_Amount ?? '');
+            if (!isValidAmount) {
                 throw new Error('Invalid amount');
             }
             cloneQuery.vnp_Amount = Number(cloneQuery.vnp_Amount);
         }
 
+        const searchParams = buildPaymentUrlSearchParams(cloneQuery);
+        const isVerified = verifySecureHash(
+            this.globalDefaultConfig.secureSecret,
+            searchParams.toString(),
+            this.HASH_ALGORITHM,
+            vnp_SecureHash,
+        );
+
         const outputResults = {
-            isVerified: true,
+            isVerified,
             isSuccess: cloneQuery.vnp_ResponseCode === '00',
             message: getResponseByStatusCode(
                 cloneQuery.vnp_ResponseCode?.toString() ?? '',
                 this.globalDefaultConfig.vnp_Locale,
             ),
         };
 
-        const searchParams = new URLSearchParams();
-        Object.entries(cloneQuery)
-            .sort(([key1], [key2]) => key1.toString().localeCompare(key2.toString()))
-            .forEach(([key, value]) => {
-                // Skip empty value
-                if (value === '' || value === undefined || value === null) {
-                    return;
-                }
-
-                searchParams.append(key, value.toString());
-            });
-
-        const signed = hash(
-            this.globalDefaultConfig.secureSecret,
-            Buffer.from(searchParams.toString(), this.BUFFER_ENCODE),
-            this.HASH_ALGORITHM,
-        );
-
-        if (vnp_SecureHash !== signed) {
+        if (!isVerified) {
             Object.assign(outputResults, {
-                isVerified: false,
                 message: 'Wrong checksum',
             });
         }
+
         const result = {
             ...cloneQuery,
             ...outputResults,