chrisdenman / id-bot

A Discord.js bot to that replies to messages that lack suitable image identifiers.

ID Bot 0.0.6

A Discord.js bot to that replies to messages that lack suitable image identifiers.

Use Cases

• Facilitating inclusivity by promoting descriptions for all message image attachments.
• Increases the meaningful contextual lifetime of images.

Running Locally

A working version of node is required (Tested on v21.6.2).

Required Environment Variables

• id_bot_id must be set to the bot's client identifier.
• id_bot_token must be set to the bot's token.

npm run start - starts the OAuth server and application proper in parallel.

QA

Tests

npm run test

• Test reports are located here.
• Coverage reports are located here.

npm run check

• Runs: linting, auditing, testing.

Linting

npm run lint

Package Auditing

npm run audit

Production Plugins

• discord.js
• express
• discord-api-types

Discord Application Intents Required

• bot
• messages.read
• guilds

Discord Permissions Required

• Send Messages
• Send Messages in Threads

Version History

See Version History

Licensing

The Unlicense

Resources Used

• discord.js
• JAVASCRIPT.INFO
• Node
• mdn web docs : JavaScript
• Vitest
• stackoverflow
• Unicode® Technical Standard #51 : Unicode Emoji
• The OAuth 2.0 Authorization Framework
• regular expressions 101

id-bot's Issues

Consider dockerising the application to provide a uniform environment for developers or production.

Add log level filtering support.

There's no filtering of log messages currently, adding a simple method to filter them would be useful and simple.

Study OAuth and understand the bot flows and the requirements for production hosting.

See if the chosen license is adequate and does not cause problems with the client.

Look into the swallowing of exceptions arising from the async/await stuff.

Terminal message identifiers are not detected.

As discord message content is trimmed of trailing whitespace, when an image identifier terminates a message e.g. ID: will not be detected correctly.

Even if the user terminated a message with ID: e.g., it will still not be detected.

Image identifiers should be detected as such when they either conform to the requisite pattern or, when messages are terminated ID:.

Document how to add the bot to a Discord channel.

`IdBotMessage` should cache values and not recalculate them.

Do we need a DB for production?

Move the regular expressions patterns for detecting image identifiers to configuration.

The regular expression patterns used for image identifier detection are likely to change both, during testing and in production. To obviate the need to re-deploy the project in such circumstances, they should be made easly configurable.

Introduce a better cache that allows for non-eternal entries.

There is a risk currently that the memory usage can ever-grow without bounds as of our use of a simple Map as a cache.

Consider implementing or importing a decent cache that allows for expiry.

Create an Action to test the bot and require this for main branch merges.

Allow the specification of secrets via enviroment variables.

Require that: inline unicode or, custom Discord emoji are subject to the same image identification requirements.

Inline emoji are opaque to screenreaders, not subjecting them to the same identification requirements only partially solves the problem at hand.

Check the image identification regular expression to ensure it catches enough cases to be useful.

Test running in multiple Guilds and/or Channels simulteneously.

Do we require slash commands?

• Possible commands:
  • /help to show the requirements for describing image attachments.
  • /historical to apply reminders to historic messages.
  • /pattern to change the identifier verification pattern.
  • /set message - to set the possible reminder message texts.
  • /on & off to enable and disable the bot in a channel.

Document how to contribute to the project.