feat: add unit tests for discord invite resolver (#711)

Author: pajlada

CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## Unreleased
 
+- Minor: Server perks are now sorted alphabetically. (#711)
+- Dev: Added unit tests for the Discord invite resolver. (#711)
+
 ## 2.0.5
 
 - Fix: Release script not working. (#704)

internal/resolvers/discord/data_test.go

@@ -0,0 +1,34 @@
+package discord
+
+import (
+	"net/http"
+	"net/http/httptest"
+
+	"github.com/go-chi/chi/v5"
+)
+
+var (
+	data_raw = map[string][]byte{}
+)
+
+func init() {
+	data_raw["bad"] = []byte(`xD`)
+	data_raw["forsen"] = []byte(`{"type":0,"code":"forsen","expires_at":null,"flags":2,"guild":{"id":"97034666673975296","name":"Forsen","splash":"05b8f7eb7f06f11da324945b0bac65ee","banner":"a_b10dd2b4e2c25b002ad9c303432a373c","description":null,"icon":"a_ea433153b6ce120e0fb518efc084dc38","features":["SEVEN_DAY_THREAD_ARCHIVE","MEMBER_PROFILES","PRIVATE_THREADS","ANIMATED_ICON","VANITY_URL","THREE_DAY_THREAD_ARCHIVE","ROLE_ICONS","AUTO_MODERATION","ANIMATED_BANNER","NEW_THREAD_PERMISSIONS","INVITE_SPLASH","THREADS_ENABLED","CHANNEL_ICON_EMOJIS_GENERATED","NON_COMMUNITY_RAID_ALERTS","BANNER","SOUNDBOARD"],"verification_level":3,"vanity_url_code":"forsen","nsfw_level":0,"nsfw":false,"premium_subscription_count":107},"guild_id":"97034666673975296","channel":{"id":"97034666673975296","type":0,"name":"readme"},"approximate_member_count":44960,"approximate_presence_count":13730}`)
+	data_raw["qbRE8WR"] = []byte(`{"type":0,"code":"qbRE8WR","inviter":{"id":"85699361769553920","username":"pajlada","avatar":"e75df3dbe6cb04b3c9f0e090b3adb190","discriminator":"0","public_flags":512,"flags":512,"banner":null,"accent_color":13387007,"global_name":"pajlada","avatar_decoration_data":null,"banner_color":"#cc44ff","clan":null},"expires_at":null,"flags":2,"guild":{"id":"138009976613502976","name":"pajlada","splash":null,"banner":null,"description":null,"icon":"dcbac612ccdd3ffa2fbf89647e26f929","features":["CHANNEL_ICON_EMOJIS_GENERATED","INVITE_SPLASH","THREE_DAY_THREAD_ARCHIVE","COMMUNITY","ANIMATED_ICON","SOUNDBOARD","NEW_THREAD_PERMISSIONS","ACTIVITY_FEED_DISABLED_BY_USER","THREADS_ENABLED","NEWS"],"verification_level":1,"vanity_url_code":null,"nsfw_level":0,"nsfw":false,"premium_subscription_count":6},"guild_id":"138009976613502976","channel":{"id":"138009976613502976","type":0,"name":"general"},"approximate_member_count":1515,"approximate_presence_count":563}`)
+}
+
+func testServer() *httptest.Server {
+	r := chi.NewRouter()
+	r.Get("/api/v9/invites/{invite}", func(w http.ResponseWriter, r *http.Request) {
+		invite := chi.URLParam(r, "invite")
+
+		w.Header().Set("Content-Type", "application/json")
+
+		if response, ok := data_raw[invite]; ok {
+			w.Write(response)
+		} else {
+			http.Error(w, http.StatusText(404), 404)
+		}
+	})
+	return httptest.NewServer(r)
+}

internal/resolvers/discord/initialize.go

@@ -11,11 +11,10 @@ import (
 	"github.com/Chatterino/api/internal/logger"
 	"github.com/Chatterino/api/pkg/config"
 	"github.com/Chatterino/api/pkg/resolver"
+	"github.com/Chatterino/api/pkg/utils"
 )
 
 const (
-	discordInviteAPIURL = "https://discord.com/api/v9/invites/%s"
-
 	discordInviteTooltip = `<div style="text-align: left;">
 <b>{{.ServerName}}</b>
 <br>
@@ -48,5 +47,7 @@ func Initialize(ctx context.Context, cfg config.APIConfig, pool db.Pool, resolve
 		return
 	}
 
-	*resolvers = append(*resolvers, NewInviteResolver(ctx, cfg, pool))
+	apiURL := utils.MustParseURL("https://discord.com/api/v9/invites/")
+
+	*resolvers = append(*resolvers, NewInviteResolver(ctx, cfg, pool, apiURL))
 }

internal/resolvers/discord/invite_loader.go

@@ -8,6 +8,7 @@ import (
 	"io"
 	"net/http"
 	"net/url"
+	"slices"
 	"strconv"
 	"strings"
 	"time"
@@ -49,16 +50,37 @@ type DiscordInviteData struct {
 }
 
 type InviteLoader struct {
+	baseURL *url.URL
+
 	token string
 }
 
+func NewInviteLoader(baseURL *url.URL, token string) *InviteLoader {
+	l := &InviteLoader{
+		baseURL: baseURL,
+
+		token: token,
+	}
+
+	return l
+}
+
+func (l *InviteLoader) buildURL(inviteCode string) *url.URL {
+	relativeURL := &url.URL{
+		Path: inviteCode,
+	}
+	finalURL := l.baseURL.ResolveReference(relativeURL)
+
+	return finalURL
+}
+
 func (l *InviteLoader) Load(ctx context.Context, inviteCode string, r *http.Request) (*resolver.Response, time.Duration, error) {
 	log := logger.FromContext(ctx)
 	log.Debugw("[DiscordInvite] Get invite",
 		"inviteCode", inviteCode,
 	)
 
-	apiURL, _ := url.Parse(fmt.Sprintf(discordInviteAPIURL, inviteCode))
+	apiURL := l.buildURL(inviteCode)
 	apiURLVariables := url.Values{}
 	apiURLVariables.Set("with_counts", "true")
 	apiURL.RawQuery = apiURLVariables.Encode()
@@ -121,6 +143,9 @@ func (l *InviteLoader) Load(ctx context.Context, inviteCode string, r *http.Requ
 	// An example of a server that has pretty much all the perks: https://discord.com/api/invites/test
 	parsedPerks := ""
 	accpetedPerks := []string{"PARTNERED", "PUBLIC", "ANIMATED_ICON", "BANNER", "INVITE_SPLASH", "VIP_REGIONS", "VANITY_URL", "COMMUNITY"}
+	slices.SortStableFunc(jsonResponse.Guild.Features, func(a, b string) int {
+		return strings.Compare(a, b)
+	})
 	for _, elem := range jsonResponse.Guild.Features {
 		if utils.Contains(accpetedPerks, elem) {
 			if parsedPerks != "" {

internal/resolvers/discord/invite_loader_test.go

@@ -0,0 +1,53 @@
+package discord
+
+import (
+	"net/url"
+	"testing"
+
+	"github.com/Chatterino/api/pkg/utils"
+	qt "github.com/frankban/quicktest"
+)
+
+func TestBuildURL(t *testing.T) {
+	c := qt.New(t)
+
+	tests := []struct {
+		label      string
+		baseURL    *url.URL
+		inviteCode string
+		expected   string
+	}{
+		{
+			"Real URL 1",
+			utils.MustParseURL("https://discord.com/api/v9/invites/"),
+			"forsen",
+			"https://discord.com/api/v9/invites/forsen",
+		},
+		{
+			"Real URL 2",
+			utils.MustParseURL("https://discord.com/api/v9/invites/"),
+			"qbRE8WR",
+			"https://discord.com/api/v9/invites/qbRE8WR",
+		},
+		{
+			"Test URL 1",
+			utils.MustParseURL("http://127.0.0.1:5934/api/v9/invites/"),
+			"forsen",
+			"http://127.0.0.1:5934/api/v9/invites/forsen",
+		},
+		{
+			"Test URL 2",
+			utils.MustParseURL("http://127.0.0.1:5934/api/v9/invites/"),
+			"qbRE8WR",
+			"http://127.0.0.1:5934/api/v9/invites/qbRE8WR",
+		},
+	}
+
+	for _, t := range tests {
+		c.Run(t.label, func(c *qt.C) {
+			loader := NewInviteLoader(t.baseURL, "fakecode")
+			actual := loader.buildURL(t.inviteCode)
+			c.Assert(actual.String(), qt.Equals, t.expected)
+		})
+	}
+}

internal/resolvers/discord/invite_resolver.go

@@ -36,10 +36,8 @@ func (r *InviteResolver) Name() string {
 	return "discord:invite"
 }
 
-func NewInviteResolver(ctx context.Context, cfg config.APIConfig, pool db.Pool) *InviteResolver {
-	inviteLoader := &InviteLoader{
-		token: cfg.DiscordToken,
-	}
+func NewInviteResolver(ctx context.Context, cfg config.APIConfig, pool db.Pool, baseURL *url.URL) *InviteResolver {
+	inviteLoader := NewInviteLoader(baseURL, cfg.DiscordToken)
 
 	// We cache invites longer on purpose as the API is pretty strict with its rate limiting, and the information changes very seldomly anyway
 	// TODO: Log 429 errors from the loader