tests: convert to TS (lnp2pBot#600)

* tests: convert to TS

Convert tests to Typescript. Update CI workflow to install
types/mocha package used by tests.

* CONTRIBUTING.md: mention TypeScript

Mention using TypeScript in "Coding standards" section and
add guideline on "any" type.

.github/workflows/integrate.yaml

@@ -56,7 +56,7 @@ jobs:
           
           mongosh --eval 'db.getSiblingDB("lnp2pbot").createCollection("mycollection")'
 
-      - run: npm install @types/node @types/i18n
+      - run: npm install @types/node @types/i18n @types/mocha
       - run: npx tsc
       - run: npm ci
       - name: Run tests

CONTRIBUTING.md

@@ -41,6 +41,8 @@ Please note that Pull Requests marked `NACK` and/or GitHub's `Change requested`
 
 We ~~try to~~ use [Airbnb javascript style guide](https://github.com/airbnb/javascript) in order to have a cleaner code.
 
+All new code should be TypeScript. The use of `any` type is discouraged, except in the tests.
+
 ### Configure Git user name and email metadata
 
 See https://help.github.com/articles/setting-your-username-in-git/ for instructions.

tests/bot/bot.spec.js → tests/bot/bot.spec.ts

@@ -1,19 +1,19 @@
-const path = require('path');
-const fs = require('fs');
+import path from 'path';
+import fs from 'fs';
 const sinon = require('sinon');
 const { expect } = require('chai');
 const proxyquire = require('proxyquire');
 
 const { initialize } = require('../../bot');
-const { User, Order } = require('../../models');
-const { getCurrenciesWithPrice } = require('../../util');
-const { mockUpdatesResponseForCurrencies } = require('./mocks/currenciesResponse');
-const { mockUpdatesResponseForLanguages } = require('./mocks/languagesResponse');
+import { User, Order } from '../../models';
+import { getCurrenciesWithPrice } from '../../util';
+import { mockUpdatesResponseForCurrencies } from './mocks/currenciesResponse';
+import { mockUpdatesResponseForLanguages } from './mocks/languagesResponse';
 
 describe('Telegram bot', () => {
   const token = '123456';
-  let server;
-  let sandbox;
+  let server: any;
+  let sandbox: any;
   let order, user;
 
   beforeEach(() => {
@@ -194,7 +194,7 @@ describe('Telegram bot', () => {
     const updates = await client.getUpdates();
     expect(updates.ok).to.be.equal(true);
     let flags = 0;
-    updates.result[0].message.reply_markup.inline_keyboard.forEach(flag => {
+    updates.result[0].message.reply_markup.inline_keyboard.forEach((flag: any) => {
       flags += flag.length;
     });
     let langs = 0;
@@ -206,12 +206,12 @@ describe('Telegram bot', () => {
 });
 
 describe('Bot Initialization', () => {
-  let initialize;
-  let botStub;
-  let scheduleStub;
-  let validateUserStub;
-  let startMessageStub;
-  let attemptPendingPaymentsStub;
+  let initialize: any;
+  let botStub: any;
+  let scheduleStub: any;
+  let validateUserStub: any;
+  let startMessageStub: any;
+  let attemptPendingPaymentsStub: any;
 
   beforeEach(() => {
     botStub = {
@@ -501,7 +501,7 @@ describe('Bot Initialization', () => {
       },
     };
 
-    botStub.on = sinon.stub().callsFake((event, middleware, handler) => {
+    botStub.on = sinon.stub().callsFake((event: string, middleware: any, handler: any) => {
       if (event === 'text') {
         const capturedHandler = handler;
         capturedHandler(ctx);
@@ -563,7 +563,7 @@ describe('Bot Initialization', () => {
       },
     };
 
-    botStub.on = sinon.stub().callsFake((event, middleware, handler) => {
+    botStub.on = sinon.stub().callsFake((event: string, middleware: any, handler: any) => {
       if (event === 'text') {
         const capturedHandler = handler;
         capturedHandler(ctx);

tests/bot/mocks/currenciesResponse.js → tests/bot/mocks/currenciesResponse.ts

@@ -112,6 +112,6 @@ const mockUpdatesResponseForCurrencies = {
     ]
 };
 
-module.exports = {
+export {
     mockUpdatesResponseForCurrencies,
 };

tests/bot/mocks/languagesResponse.js → tests/bot/mocks/languagesResponse.ts

@@ -28,6 +28,6 @@ const mockUpdatesResponseForLanguages = {
         }]
 };
 
-module.exports = {
+export {
     mockUpdatesResponseForLanguages,
 };

tests/bot/modules/dispute/messages.js → tests/bot/modules/dispute/messages.ts

@@ -13,7 +13,7 @@ const mockTelegram = {
 };
 
 const mockI18n = {
-  t: sinon.stub((key, params) => {
+  t: sinon.stub((key: string, params: any) => {
     switch (key) {
       case 'dispute_started_channel':
         return `User ${params.type} @${params.initiatorUser} TG ID: ${params.initiatorTgId}