lucabernstein / beancount-bot-tg Goto Github PK

• Evaluation needed whether this is an improved UX behavior.
• Maybe create a beta version for this (branch) or add a feature toggle to beta test this

Impl

• Store resulting message ID in cache
• Delete user messages once processed?
• Add status / error messages inline?
• Formatting for message (bold, italics, colors?, ...)

Few suggestions to improve usability :)

• Specifying the type of suggestion you want to remove shouldn't be necessary. From the user's perspective, the suggestions accounts should be unique anyway (and are not confusable with a description?)
• Brackets [] to remove accounts seems counterintuitive (Why necessary to remove but not to add?) --> Fix inconsistency :D
• List suggestions with /suggestions list w/o parameters (prints a list with all suggestions for accTo, accFrom and txDesc)
• I don't think there is a need for a suggested date? (Please provide use case :D)
• Last date used in simple tx does not need to become a suggestion for next simple tx

/config about or /config version.

With commit and if applicable version tag.

• #71

Describe the bug
/suggestions rm accTo [Expenses:Test] does not remove the suggestion from the list

To Reproduce
Steps to reproduce the behavior:

1. Add multiple accounts as suggestions
2. List the accounts
3. Remove account from the list
4. Account still appears in suggestions

Expected behavior
Expenses:Test is removed from the suggestions

Screenshots

• https://github.com/go-telegram-bot-api/telegram-bot-api
• https://github.com/tucnak/telebot

• Write test case: Start tx, enter amount, type /help, expect last input help to be sent (also for other commands)
• Fix

/simple transactions do not ask for date but take today as default.

If user wants to specify date though, this can be done in the initial /simple [date] call like /simple 2021-11-24

From @Fawerki on #21

List suggestions with /suggestions list w/o parameters (prints a list with all suggestions for accTo, accFrom and txDesc)

Change /suggestions list to /suggestions_list or add additional command. Do not require account type but list all (as table).

Idea: Use inline buttons

• Also add for delete in the same way

• Write test case
• Fix

/list archived shows all archived transactions

Help text: Are you missing transactions? You might want to check '/list archived'

e.g. 123.45 USD

• to be on top of the hour
• to use UTC
  • state so in the info messages

Need to recheck gocron module functionality or switch lib...

Allow inputs like 3.50+4.20+3,80 ('+' operator) and 3.80*10 ('*' operator)

Use case: On the christmas market drinking multiple beverages it might be easier to use telegram's draft mode and let the bot calculate the sum.

See #75

• Send service notification to users if feature is available

• currency
• vacation mode: set tag to use by default on all transactions
• generate comments tags on templated transactions
  • only add comments tags on /list on the fly. Do not hard-code, but use metadata instead.
• Reminders for open transactions: Let user define schedule (daily, weekly (+ time?)) to be reminded by bot for open (not deleted or archived)
  • Be reminded for transactions that are open for longer than x hours

Describe the bug
At the moment for a /simple tx you get not asked for an amount.

• Export log stats in last 24 hours
  • warning, error and up count
• number of open, archived transactions
• user count
• number of cache entries
• job stats (last run, next run, run count) (not done yet)

• As comands are valid for each user, there are multiple ways on how to implement this
  • Bind commands in multiple languages simultaneously
  • Only use .OnText binding, check user language (cached?), lookup command and execute. Might require a custom command handler, we might even be able to reuse the subcommands handler.

• Check for possible library to use, e.g. https://github.com/nicksnyder/go-i18n
• translation files in an i18n/translations directory
• Translate existing project (extract EN)
• Check that everything works for one langauge
• Add another language (DE)
• Make configurable in /config
  • e.g. /config lang [de|en|...]
• implement PoC regarding handling translated commands for both possibilities suggested above
  • decide for one possibility
• implement decided solution, write tests

• Add admin user flag
• Add additional commands for sending notifications for all users (broadcast) / to some user directly
• (Optional): User can subscribe to notification channel (service, release, ...)
• Template sending info about new version

This command should fail:

/suggestions add txDesc "This should be escaped:\""

• 8.8 does not become 8.80

Just a thought, needs confirmation. Then a fix: Either take everything as one string or require quotes? Also, fail for too many args (write common function to specify min/max args)

• Investigate (2021-12-14 20:30), reproduce
• Optional: Write test
• Fix

• To keep amount summing open add + to end of amount input

• If last amount input reached, leave the + out (alternatively: add 0 to go to next input)

• unit is only allowed on last input

• write test and cover edge cases

• (Nightly or on manual trigger: build test db with data filled)
• Spin up a db in GH Actions step
• Write and run tests against this db
• Spin down

Followup of #15

Example message history:

/suggestions add accFrom

Assets:Cash
Assets:Depot:Example1

Functioning

• CHange generic text handling to use different states
• Use interface{} and a type switch to route the handling

e.g. /currency USD

See #11

• add numbered option to list
• delete and archive by number
• number numbers txs in order by date asc
• help text reflects usage numbered

• ReplyKeyboardMarkup:
  • https://core.telegram.org/bots#keyboards
  • https://github.com/tucnak/telebot#keyboards

• Ask for default currency
• Ask for other /configs
• Ask for language (#31)

Next to /archiveAll also add a command like /deleteAll to hard delete transactions from the db.

Require confirmation: /deleteAll yes

• Remove email field from db (unless needed, bc. password for web can be set so that email and tg auth login work?)
  • No passwords though, at max token to Telegram
• #83
• Add configuration map to read config / settings
• Add configuration map to write config / settings
• List transactions (with metadata)
• delete single and all transactions
• admin section: error logs and warnings with filters for level, from and to
• add tests

• Add database table to log errors to
• Add log levels (following best practises)
• Use existing logging framework?
• Add chatID and userID from tb.Message to every log entry (pass message, if != nil, add to message at front)
• Use custom logger and replace existing logs to log.Print, ...

• Add numpad keyboard and show on amount
• If user uses numpad keyboard, add sth. like amount: ____,__ to last sent message.
• Update on numpad input
• if user (then) uses keyboard to enter amount, remove display in message and use value instead.
• DIsallow custom units (?)
• Build PoC on branch, present to @Fawerki and discuss.

• Emoji: <insert package to use>
• Markdown: Pass tb.ModeMarkdown as additional send option to bot.Send()
  • Needs some more testing though, as formatting seems to sometimes silently fail (depending on message content?)
  • tb.ModeMarkdownV2 somehow did not work at all. Maybe RCA is needed here, possibly an issue.