j-maas/xkcd-for-that-bot

There's a relevant xkcd-for-that-bot!

xkcd for that bot

There's a relevant xkcd-for-that-bot! It helps you find relevant xkcd comics in Telegram.

The bot is available as @xkcdForThatBot.

Original Bot

The original bot by GingerPlusPlus is the inspiration for this bot. Its code is available on GitHub.

Deployment

Quick start:

npm install
npm start

Build

While the build is run automatically on install, you can also run it manually.

npm run build:prod

This will build the bot for production, which entails compiling the Elm code and then the TypeScript code. The generated JavaScript code sits in dist/.

Run

After building the project, it can be run with

npm start

This executes the entry file dist/index.js.

Development

npm run launch:dev

This will run the bot directly from the TypeScript files and disable webhooks, instead using polling. No need for an extra compilation step or setting up the server for webhooks.

npm run launch:prod

This will compile and start the bot, close to what npm install && npm start would do. Use this to reproduce the server environment more closely.

xkcd-for-that-bot's Issues

Use webhooks

Glitch does not wake up when polling. Use webhooks instead.

Allow caching of inline query results

https://github.com/Y0hy0h/xkcd-for-that-bot/blob/master/src/bot/RelevantXkcdBot.elm#L151 disables caching for debuggin purposes.

This logic should probably move to elmegram.js.

Recreate repo

The code was completely replaced. It is not a fork anymore.

Cache xkcds

Prevent unnecessary requests.

Tests

Set up CD

Automatically deploy to Glitch on merge into master.

Investigate whether Task.sequence can be improved

The requests for xkcd comics can be parallelized, but need to be aggregated into one list in the end. I suspect Task.sequence does them sequentially. Ask, whether there is something like Task.parallel.

Functional tests

Fetch relevant xkcds for numbers

Currently, when a number is entered, it is treated as an id. For inline queries, what follows are the newest comics.

Instead of the newest comics, a search for the xkcds most relevant to the query should be done.