Issue 543 error displaying username with underscore

bot/modules/dispute/messages.js

@@ -1,6 +1,8 @@
 const { getDisputeChannel, getDetailedOrder } = require('../../../util');
 const { logger } = require('../../../logger');
 
+const escapeMarkdown = (text) => text.replace(/_/g, '\\_');
+
 exports.beginDispute = async (ctx, initiator, order, buyer, seller) => {
   try {
     let initiatorUser = buyer;
@@ -87,11 +89,16 @@ exports.disputeData = async (
     }
 
     const detailedOrder = getDetailedOrder(ctx.i18n, order, buyer, seller);
+
+    // Fix Issue 543: Escape underscores in usernames
+    const escapedInitiatorUsername = escapeMarkdown(initiatorUser.username);
+    const escapedCounterPartyUsername = escapeMarkdown(counterPartyUser.username);
+
     await ctx.telegram.sendMessage(
       solver.tg_id,
       ctx.i18n.t('dispute_started_channel', {
-        initiatorUser,
-        counterPartyUser,
+        initiatorUser: { ...initiatorUser, username: escapedInitiatorUsername },
+        counterPartyUser: { ...counterPartyUser, username: escapedCounterPartyUsername },
         buyer,
         seller,
         buyerDisputes,

locales/en.yaml

@@ -204,8 +204,8 @@ order_detail: |
 seller: seller
 buyer: buyer
 dispute_started_channel: |
-  User ${type} @${initiatorUser.username} 
-  has started a dispute with @${counterPartyUser.username} for the order
+  User ${type} @${initiatorUser.username} with the id: ${initiatorUser.tg_id}
+  has started a dispute with @${counterPartyUser.username} with the id: ${counterPartyUser.tg_id} for the order
 
   ${detailedOrder}
 

locales/es.yaml

@@ -202,8 +202,8 @@ order_detail: |
 seller: vendedor
 buyer: comprador
 dispute_started_channel: |
-  El ${type} @${initiatorUser.username}
-  ha iniciado una disputa con @${counterPartyUser.username} en la orden:
+  El ${type} @${initiatorUser.username} con la id: ${initiatorUser.tg_id}
+  ha iniciado una disputa con @${counterPartyUser.username} con la id: ${counterPartyUser.tg_id} en la orden:
 
   ${detailedOrder}
 

package.json

@@ -12,7 +12,7 @@
     "lint": "eslint .",
     "format": "prettier --write '**/*.js'",
     "pretest": "npx tsc",
-    "test": "export NODE_ENV=test && mocha --exit tests/"
+    "test": "export NODE_ENV=test && mocha --exit 'tests/**/*.js'"
   },
   "license": "MIT",
   "dependencies": {
@@ -53,6 +53,7 @@
     "mocha": "^9.2.2",
     "nodemon": "2.0.19",
     "prettier": "^2.6.2",
+    "proxyquire": "^2.1.3",
     "sinon": "^11.1.2",
     "telegram-test-api": "^2.5.0",
     "typescript": "^5.1.6"

tests/bot/modules/dispute/messages.js

@@ -0,0 +1,108 @@
+const { expect } = require('chai');
+const sinon = require('sinon');
+const proxyquire = require('proxyquire');
+
+const getDetailedOrderStub = sinon.stub().returns('Mocked order detail');
+const { disputeData } = proxyquire('../../../../bot/modules/dispute/messages', {
+  '../../../util': { getDetailedOrder: getDetailedOrderStub }
+});
+
+// Mock dependencies
+const mockTelegram = {
+  sendMessage: sinon.stub(),
+};
+
+const mockI18n = {
+  t: sinon.stub((key, params) => {
+    switch (key) {
+      case 'dispute_started_channel':
+        return `Dispute started by ${params.initiatorUser.username} against ${params.counterPartyUser.username} with tokens ${params.sellerToken} and ${params.buyerToken}`;
+      case 'seller':
+        return 'seller';
+      case 'buyer':
+        return 'buyer';
+      case 'dispute_solver':
+        return `Dispute taken by ${params.solver} with token ${params.token}`;
+      default:
+        return '';
+    }
+  }),
+};
+
+const mockCtx = {
+  telegram: mockTelegram,
+  i18n: mockI18n,
+};
+
+const mockOrder = {
+  seller_dispute_token: 'seller_token',
+  buyer_dispute_token: 'buyer_token',
+};
+
+const mockBuyerUnderscore = { username: 'buyer_user', tg_id: '246802' };
+const mockBuyerNormal = { username: 'buyer-user', tg_id: '246802' };
+const mockSeller = { username: 'seller_user', tg_id: '567890' };
+const mockSolver = { username: 'solver', tg_id: '123456' };
+
+describe('disputeData', () => {
+  afterEach(() => {
+    sinon.restore();
+  });
+
+  it('should send a message with escaped underscores in usernames', async () => {
+    await disputeData(
+      mockCtx,
+      mockBuyerUnderscore,
+      mockSeller,
+      mockOrder,
+      'buyer',
+      mockSolver,
+      5,
+      3
+    );
+
+    expect(mockTelegram.sendMessage.calledWith(
+      mockSolver.tg_id,
+      sinon.match(/buyer\\_user/),
+      sinon.match({ parse_mode: 'MarkdownV2' })
+    )).to.be.true;
+  });
+
+  it('should send a message without underscores in usernames', async () => {
+    await disputeData(
+      mockCtx,
+      mockBuyerNormal,
+      mockSeller,
+      mockOrder,
+      'buyer',
+      mockSolver,
+      5,
+      3
+    );
+
+    expect(mockTelegram.sendMessage.calledWith(
+      mockSolver.tg_id,
+      sinon.match('buyer-user'),
+      sinon.match({ parse_mode: 'MarkdownV2' })
+    )).to.be.true;
+  });
+
+  it('should swap initiator and counterparty if initiator is seller', async () => {
+    await disputeData(
+      mockCtx,
+      mockBuyerNormal,
+      mockSeller,
+      mockOrder,
+      'seller',
+      mockSolver,
+      5,
+      3
+    );
+
+    expect(mockTelegram.sendMessage.calledWith(
+      mockSolver.tg_id,
+      sinon.match(/seller\\_user/),
+      sinon.match({ parse_mode: 'MarkdownV2' })
+    )).to.be.true;
+  });
+});