Feat/317/verbose /admin announce summary

[Vyvy-vi]

Resolves #317

This PR adds a summary report file that is sent when the /admin announce command is used. We might need to refactor this a bit in future and use the praise username instead of discord ids.

[mattyg]

Awesome!

I think we need to replace the discord ids with user names before it effectively resolves #317.

[Vyvy-vi]

I think we need to replace the discord ids with user names before it effectively resolves #317.

This can be resolved when #377 is implemented. We can't use discord usernames if the user isn't present in the discord.
One temp. solution may be to fetch all the UserAccounts associated with the User and to return a more detailed output -

User	DiscordUsername	TelegramUsername	Status	Reason
A	A_on_discord_old_account	A_on_Telegram	Undelivered	User Not Found in discord
B	B_on_discord	B_on_Telegram	Delivered	-
C	C_on_discord	C_on_Telegram	Undelivered	Can't DM User

Would this add a significant overhead to the process?

[kristoferlund]

This can be resolved when #377 is implemented. We can't use discord usernames if the user isn't present in the discord.

How could the user not be on Discord? In order to be a quantifier you need to activate your account, linking UserAccount to User.

[Vyvy-vi]

How could the user not be on Discord? In order to be a quantifier, you need to activate your account, linking UserAccount to User.

People can leave the discord server after activating, or they can be kicked/banned for some reason, or their discord account might have been deleted.

[kristoferlund]

People can leave the discord server after activating, or they can be kicked/banned for some reason, or their discord account might have been deleted.

Sure. But we will still have a UserAccount in our database we can use to provide a username.

[Vyvy-vi]

That's true. It might add some extra API calls, but we can add that 👍

[Vyvy-vi]

The code isn't as DRY as I'd like, however, I think we can work on that when we make a separate function for tabularisation (or if we opt to use a CSV file, instead).

Here's the new version -

[Vyvy-vi]

also, how to type this properly? -

interface FailedToDmUsersList {
  invalidUsers: string[];
  notFoundUsers: string[];
  closedDmUsers: string[];
  unknownErrorUsers: string[];
}

const failed: FailedToDmUsersList = {
  invalidUsers: <string[]>[],
  notFoundUsers: <string[]>[],
  closedDmUsers: <string[]>[],
  unknownErrorUsers: <string[]>[]
};

__
 Summary: 🛠️ This code needs a fix

[mattyg]

also, how to type this properly? -

Since you already defined the type in the interface, you can just create an object that implements that type. The type string[] allows for an empty array (as long as any items you subsequently add to it are strings).

So like this:

interface FailedToDmUsersList {
  invalidUsers: string[];
  notFoundUsers: string[];
  closedDmUsers: string[];
  unknownErrorUsers: string[];
}

const failed: FailedToDmUsersList = {
  invalidUsers: [],
  notFoundUsers: [],
  closedDmUsers: [],
  unknownErrorUsers: []
};

[mattyg]

awesome!

[kristoferlund]

Looks great @Vyvy-vi! I made two small text changes. Now merging.