dnsge / twitch-eventsub-framework

A small framework for creating Twitch EventSub applications

twitch-eventsub-framework

A small framework for creating Twitch EventSub applications with an HTTP transport.

Note: At the moment, this library does not support the WebSocket transport.

Features

This package has two main features:

1. A SubClient to subscribe to, unsubscribe to, and list subscriptions created with EventSub
2. A SubHandler to handle webhook verification requests and dispatch webhook notifications

Examples

1. See examples/sub_client/main.go for an example usage of creating a new webhook subscription.
2. See examples/sub_handler/main.go for an example usage of receiving webhook notifications from Twitch.

twitch-eventsub-framework's Issues

Add version support

Some eventsub types have version, and some of versions can be deprecrated and unavailable for subscribe, for example follow: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelfollow

We should care about version in subscribe request.

I can do PR later, but not sure when.

[Help wanted] Usage with ngrok

Are you familar with ngrok?

I have a problem with that tunnel, my events in dev mode is repeated (retried) by twitch.

I'm used helper for getting tunnel for eventsub client

func GetAppTunnel(ctx context.Context, cfg *config.Config) (net.Listener, error) {
	if cfg.AppEnv != "production" {
		tun, err := ngrok.Listen(ctx,
			ngrok_config.HTTPEndpoint(),
		)
		if err != nil {
			return nil, err
		}

		return tun, nil
	} else {
		tun, err := net.Listen("tcp", ":3003")
		if err != nil {
			return nil, err
		}
		return tun, nil
	}
}

After that using it like:

	appTun, err := helpers.GetAppTunnel(appCtx, cfg)
	if err != nil {
		panic(err)
	}

	appAddr := lo.
		If(cfg.AppEnv != "production", appTun.Addr().String()).
		Else(fmt.Sprintf("eventsub.%s", cfg.HostName))

	eventSubHandler := handler.NewHandler(services)
		go func() {
                         // manager here is *eventsub_framework.SubHandler
			if err := http.Serve(appTun, eventSubHandler.Manager); err != nil {
				panic(err)
			}
		}()

	fmt.Println("Listening on %s", appAddr)

Raw http request in handle functions

Might be good to get raw http request for own need, for example tracing.
Also might be good to pass ctx from request to handlers

What do you think?

Unreacheble code, so we cannot respond to twitch and twitch will retry requests

twitch-eventsub-framework/handler.go

Line 492 in 6778902

w.WriteHeader(http.StatusOK)

This code never executes, because you have return in each case statement. So, we not returning anything to twitch, and twitch will retry their request 3 times.

Add new channel.chat.message subscription

The channel.chat.message subscription type sends a notification when any user sends a message to a specific chat room.

channel.chat.message