jfet97 / ntfm

A node telegram bots flow manager

Who is jfet97?

I'm Andrea 😄, a freelance software developer with strong skills in JavaScript and TypeScript. Additionally, I'm a huge fan of functional programming and I extensively use libraries like Effect in my daily work.

I'm a student

At the moment, I'm a master's student in theoretical CS at the University of Pisa. I'm strongly drawn to the theoretical aspects of Computer Science. Lately, I have been delving into type systems.

I'm an educator

I also have a strong passion for sharing my knowledge through articles, videos, and training courses. You can find more by browsing through my website!

Who cares about jfet97?

My grandma 👵🏻❤️

ntfm's Issues

unable to process third action

It is found that it is unable to run the third action, test cases are created below.

    it("registers and executes a series of actions, with proper executeCall data and previousResult correctly stored", done => {

        const passedData1 = {};
        const returnedData1 = {};
        const passedData2 = {};
        const returnedData2 = {};
        const passedData3 = {};

        flow.register(id,
            data => {
                expect(passedData1).toBe(data.executeCallData);
                return returnedData1;
            },
            data => {
                expect(passedData2).toBe(data.executeCallData);
                expect(returnedData1).toBe(data.previousResult);
                done();
            },
            data => {
                expect(passedData3).toBe(data.executeCallData);
                expect(returnedData2).toBe(data.previousResult);
                done();
            }
        );

        flow.execute(id, passedData1);
        flow.execute(id, passedData2);
        flow.execute(id, passedData3);
    });

    it("registers and executes a series of async actions, with proper executeCall data and previousResult correctly stored", done => {

        const passedData1 = {};
        const returnedData1 = {};
        const passedData2 = {};
        const returnedData2 = {};
        const passedData3 = {};

        flow.register(id,
            async data => {
                expect(passedData1).toBe(data.executeCallData);
                await delay(300);
                return returnedData1;
            },
            async data => {
                expect(passedData2).toBe(data.executeCallData);
                expect(returnedData1).toBe(data.previousResult);
                await delay(300);
                done();
            },
            async data => {
                expect(passedData3).toBe(data.executeCallData);
                expect(returnedData2).toBe(data.previousResult);
                await delay(300);
                done();
            });

        flow.execute(id, passedData1);
        flow.execute(id, passedData2);
        flow.execute(id, passedData3);
    });

On message event not firing automatically on NTBA?

Do I need to explicitly listen to

bot.on('message')

event on every new file.

Doesn't this event fire whenever bot receive the message?

how to abort the flow?

flow.register(
  userId,
  data => {
    // how can I abort and clear user flow here and not go to next action?
  },
  data => {
  }
);

cannot process text contains "/"

I use the following code to perform a broadcast. However, if I input broadcast message with "/", for example "please type /help for help.", the broadcast message will not be prompted.
I found that when the input contains "/", the message will be treated as command. At this point, I don't know what is the cause and don't know how can I fix that.

Do anyone can help? Thanks a lot!

'use strict';
const { bot, flow } = require('../bot');
const db = require('../db');
const util = require('../util');

bot.onText(/^\/broadcast$/, msg => {
  const chatId = msg.from.id;

  // flow guard
  if(!flow.hasInQueue(chatId)) {
    const isAdminUser = db.isAdminUser(chatId);
    if(!isAdminUser) {
      return;
    }

    bot.sendMessage(chatId, 'Please input broadcast message');

    // after 180 second, the operation will be forcibly cleared
    const timer = setTimeout(flow.clear.bind(flow), 180000, chatId);

    flow.register(
      chatId,
      async data => {
        const msg = data.executeCallData;

        util.notifyRoles(chatId, ['admin', 'poweruser'], '🔔BROADCAST MESSAGE🔔\n🔔PLEASE DO NOT REPLY🔔\n' + msg.text, true, false);

        bot.sendMessage(chatId, 'done');

        clearTimeout(timer);
      },
    );
  } else {
    bot.sendMessage(chatId, 'Unable to execute this command. First complete the previous operation or type /clear.');
  }
});