Add DiscordStartGameWebhook and DiscordPhaseUpdateWebhook to Game

[johnpooch]

Adds DiscordWebhookfield to Game:

These webhooks will be invoked when the game is started, and when the phase is updated.

By using webhooks, the server doesn't need to know what needs to happen when certain updates happen. Instead, the Dipcord NodeJS server will listen for these webhook messages, and carry out any necessary actions.

@zond is this all I need to do to add optional fields to a data model? I want the fields to be either nil or an empty string if not specified. I don't want this to break existing create game endpoint.

[johnpooch]

In fact, I might update it to take { id: string, token: string } for each webhook. This will mean I can invoke the webhook using discordgo library which should be a bit neater.

[zond]

Do I understand it correctly, that this (and the previous PR) is to push events from the game service to Discord? Or is it from the game service to the bot service?

[johnpooch]

Do I understand it correctly, that this (and the previous PR) is to push events from the game service to Discord? Or is it from the game service to the bot service?

@zond I briefly made a PR to have the Diplicity service integrate with the bot directly to update the server when the game is created or phase starts. But I decided it would be a bit of a headache to continue that way. Mainly because it's hard to test.

In this approach, Diplicity service is set up to simply invoke a webhook when certain events happen. The Dipcord bot service will "hear" the webhook being invoked and will know that an update has happened, so it will then fetch the new state from Diplicity service again.

It's a bit more roundabout, but it's much easier to test (can just invoke webhook to test, don't need to actually create a game and finish phase) and easier to maintain (all bot stuff in the one service and language)

[zond]

So the webhook is on the Discord servers, and will trigger an event that via WebSocket reaches the bot?

Fair enough :D

[johnpooch]

So the webhook is on the Discord servers, and will trigger an event that via WebSocket reaches the bot?

Fair enough :D

Here is the related code in the NodeJS server:

(client as Client<true>).on(Events.MessageCreate, async (message) => {
  if (message.webhookId) {
    const webhook = await message.fetchWebhook();
    if (webhookHandlers.gameStarted.name === webhook.name)
      webhookHandlers.gameStarted.execute(webhook);
  }
});

So basically it is just listening for any message with a webhookId, and then using the webhook name to determine what to do. The webhook will be created in the first place by the bot when creating the game.

Like I said, it's a bit roundabout, but I think ultimately easier.

[zond]

Cool, but it feels a bit Rube Goldberg-y :D