jangross/toho-miku

Part of this project are

• Toho-Mon Bot status monitoring with webhook alerts
• Toho-Reno Godot render node
• Toho-Jose Jobserver managing render jobs

Run dev container

$ docker-compose -f docker-compose.yml -f docker-compose.dev.yml up

Sequelize migrations

$npx sequelize db:migrate
$npx sequelize db:seed:all

API

API docs can be found in Docs/api/README.md

toho-miku's Issues

History: Queries should be committed in a single transaction

To preserve atomicity.
See https://sequelize.org/docs/v6/other-topics/transactions/

Move nodemon to dev dependencies

https://github.com/JanGross/bandbot/blob/cfc9e2ba6b164377d35d874127f474d121687a42/package.json#L18

Wishlist Implementation

• Add/Remove wishlisted
• Ping on wishlist drop
• Make ping optional
• View wishlist
• Compare wishlist with user collection
• Wishlist upgrades

Drop: Claim buttons go out of sync

If cards are claimed too quickly, the claim / claimed states go out of sync.
It should only be a visual bug, however, we should probably check all card states before pushing component updates.
This either works with the Card instances held in memory or we need to set-up a system to debounce queries.

Drop: Cards can be viewed before the stack is revealed

Drop: admins still have a cooldown

but they shouldn't

Move image assets out of the repository

LFS is nice and all, but I don't want all the assets inside the repo

Rendering: Short animations not looping if composed after longer one

Any animation preceded by a longer one blanks out instead of looping.

E.g.: KMNZ Lita preceding KMNZ Liz in the profile slots

Characters need alias fields

Some characters have multiple aliases and a real name.
They should be considered before implementing character search

Drop: Ping users when 1st prints or shinies drop

If a user has notifications turned on, they should be pinged when a first print, shiny or wishlisted card drops in one of their servers.

Add field to keep track of copyright

This should be displayed on character and/or card views

Import: Band imageURLs are not imported

They are always NULL instead

Trade: Missing history

Trade history is missing

Profile: rendering doesn't handle an empty customStatus

https://github.com/JanGross/bandbot/blob/254aa8ea31601aa115eedf9bb331b6271ea11ae2/commands/profile.js#L28
replace throws as customStatus is null

DB: Sync throwing on first first run / new DB

Sequelize Sync complains about Duplicate column names such as 'UserId' when running on a new instance
Recreating and migrating the DB using the migrations works fine
Probably because the model associations are fucked

Caching: cached files stay forever

We could:

• Keep track of the previous hash and delete once the new render finished
• Use last accessed metadata to clean up old files in fixed intervals
• Change hashing strategy to overwrite existing files instead

Drop: picking random characters based on IDs broken

Randomly choosing character IDs based only on character count doesn't account for disabled cards
or gaps in card IDs since they are not continuous.
Native Sequelize / DB functions should be used instead.

Empty collection message no longer works with the new embed flow

https://github.com/JanGross/bandbot/blob/91e038d88e511edb7617b7e01d77333e136db15b/commands/collection.js#L99-L103

Instead of returning we should remove the footer and components

Drop: stack rendering causes unnecessary file IO

Instead of the image path, we should pass either the buffer or sharp object

Drop: Only the interaction owner can claim cards

Drops can only be claimed by the interaction initiator

View/Character: Invalid form body for non elevated users

Might be because of the missing edit button if the components array is still passed.

Fontconfig error: No writable cache directories

Might be related to #8 (Docker Permissions)

Generalize everything

• Tables, Models and Fields
• Labels and Options
• Repo Name
• Readme and docs

View/Edit: no option to pass attachments

Required for editing the imageIdentifier.

Drop: multiple drops can be triggered if executed in quick succession

View: input sanitization

Empty or bogus card ID's need to be handled

DB: Migrate bands and characters to autoincrement IDs

Using Discogs IDs was a stupid idea.
All the existing references and records need to be migrated

• Enable auto_increment
• Migrate existing character and group IDs

Drop: Claimed card text not updating

Possible race condition when claiming very late

Translations

We should consider implementing a system for supporting multiple languages as early as possible.

Collection: Additional filter params

Implement the following filters:

• Name
• Group
• Rarity

Sorting options:

• Quality
• Print Nr.

Edit: follow up edits interaction-id mismatch

Some follow up edits fail due to interaction id mismatches.
Presumably when previous dialogs have been dismissed without submission.
https://github.com/JanGross/bandbot/blob/0afedc86e54e1402bc01feab33672997d6e73c04/commands/edit.js#L180-L181

Heavy SQL Queries

Tag queries that need to be optimized/refactored in this issue

Badges: Manually assigned badges

Implement manually assigned badges visible on the user profile

Docker: permissions broken

Running as root breaks the sharp installation step
Running as a non-root user breaks other setup steps (symlinking some semver stuff)

Caching: profile compositor ignores cache

Currently we completely disregard existing files when compositing profile images

Badges: Band completion badges

Implement band completion badges and badge selection for profile display.

Cooldowns: cooldown string displays 0 states for anything less than a minute

it should switch to seconds instead

Prebuilt Imagemagick from the alpine repositories doesn't have OpenMP enabled

If installed via the package manager, imagemagick doesn't have the OpenMP feature enabled,
which is required for multicore processing.

Only alternative is building from source.

Import: FK contraints failing on first import of a new dataset

Probably due to characters being imported before the band has been committed successfully.

Trade: Locking twice throws interaction error

Need to handle lock and accept events coming from the same user hitting the buttons twice.

Drop: Grayscale does not apply to card border

https://github.com/JanGross/bandbot/blob/31b2836a45a4344adb58307133007dccee3e93c8/util/rendering.js#L81-L87

Collection: component events not filtered by author

Everyone can change dupe settings on any /collection view

Collection: Group dupes pagination issues

Completely fucked

Trade: Add jump to trade button

Trades get lost easily. Add a jump button to each related message

Add testcases

so we can at least test for regression >.<

Stack image cache mismatch if dropped too quickly

If two or more drops happen at the same time, the deck image is the same.
Looking at one incident, it seems like whatever deck rendered most recently is being displayed.
If drop A is still rendering while drop B is already finished, both will display the deck of drop B.

Cooldown: discord formatted timestamps

Use discord formatted timestamps to display more dynamic countdowns and localized times.
<t:tstamp> and <t:tstamp:R>

Cards: Long character names overflow

History: Drop history is missing the initiators userID

We only store the userId associated to claimed cards but not who actually dropped the stack.
The overall dropData needs some reworking. Things to consider are:
User who dropped
Drop Channel and Guild
Split claim events into sparate row

Refactor component collector timeout values

Instead of magic numbers, we should unify and move them to a central place.