summaryrefslogtreecommitdiff
path: root/internal/transport/finger_test.go
blob: dd3449b7390ab9301a2dc1fee319c8149e544a2e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
// GoToSocial
// Copyright (C) GoToSocial Authors admin@gotosocial.org
// SPDX-License-Identifier: AGPL-3.0-or-later
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.

package transport_test

import (
	"context"
	"os"
	"testing"
	"time"

	"github.com/stretchr/testify/suite"
)

type FingerTestSuite struct {
	TransportTestSuite
}

func (suite *FingerTestSuite) TestFinger() {
	wc := suite.state.Caches.Webfinger
	suite.Equal(0, wc.Len(), "expect webfinger cache to be empty")

	_, err := suite.transport.Finger(context.TODO(), "brand_new_person", "unknown-instance.com")
	if err != nil {
		suite.FailNow(err.Error())
	}

	suite.Equal(0, wc.Len(), "expect webfinger cache to be empty for normal webfinger request")
}

func (suite *FingerTestSuite) TestFingerPunycode() {
	wc := suite.state.Caches.Webfinger
	suite.Equal(0, wc.Len(), "expect webfinger cache to be empty")

	_, err := suite.transport.Finger(context.TODO(), "brand_new_person", "pünycöde.example.org")
	if err != nil {
		suite.FailNow(err.Error())
	}

	suite.Equal(0, wc.Len(), "expect webfinger cache to be empty for normal webfinger request")
}

func (suite *FingerTestSuite) TestFingerWithHostMeta() {
	wc := suite.state.Caches.Webfinger
	suite.Equal(0, wc.Len(), "expect webfinger cache to be empty")

	_, err := suite.transport.Finger(context.TODO(), "someone", "misconfigured-instance.com")
	if err != nil {
		suite.FailNow(err.Error())
	}

	suite.Equal(1, wc.Len(), "expect webfinger cache to hold one entry")
	suite.True(wc.Has("misconfigured-instance.com"), "expect webfinger cache to have entry for misconfigured-instance.com")
}

func (suite *FingerTestSuite) TestFingerWithHostMetaCacheStrategy() {
	if os.Getenv("CI") == "true" {
		suite.T().Skip("this test is flaky on CI for as of yet unknown reasons")
	}

	wc := suite.state.Caches.Webfinger

	// Reset the sweep frequency so nothing interferes with the test
	wc.Stop()
	wc.SetTTL(1*time.Hour, false)
	wc.Start(1 * time.Hour)

	suite.Equal(0, wc.Len(), "expect webfinger cache to be empty")

	_, err := suite.transport.Finger(context.TODO(), "someone", "misconfigured-instance.com")
	if err != nil {
		suite.FailNow(err.Error())
	}

	suite.Equal(1, wc.Len(), "expect webfinger cache to hold one entry")
	wc.Lock()
	suite.True(wc.Cache.Has("misconfigured-instance.com"), "expect webfinger cache to have entry for misconfigured-instance.com")
	ent, _ := wc.Cache.Get("misconfigured-instance.com")
	wc.Unlock()

	initialTime := ent.Expiry

	// finger them again
	_, err = suite.transport.Finger(context.TODO(), "someone", "misconfigured-instance.com")
	if err != nil {
		suite.FailNow(err.Error())
	}

	// there should still only be 1 cache entry
	suite.Equal(1, wc.Len(), "expect webfinger cache to hold one entry")
	wc.Lock()
	suite.True(wc.Cache.Has("misconfigured-instance.com"), "expect webfinger cache to have entry for misconfigured-instance.com")
	rep, _ := wc.Cache.Get("misconfigured-instance.com")
	wc.Unlock()

	repeatTime := rep.Expiry

	// the TTL of the entry should have extended because we did a second
	// successful finger
	if repeatTime == initialTime {
		suite.FailNowf("expected webfinger cache entry to have different expiry times", "initial: '%s', repeat: '%s'", initialTime, repeatTime)
	} else if repeatTime < initialTime {
		suite.FailNowf("expected webfinger cache entry to not be a time traveller", "initial: '%s', repeat: '%s'", initialTime, repeatTime)
	}

	// finger a non-existing user on that same instance which will return an error
	_, err = suite.transport.Finger(context.TODO(), "invalid", "misconfigured-instance.com")
	if err == nil {
		suite.FailNow("expected request for invalid user to fail")
	}

	// there should still only be 1 cache entry, because we don't evict from cache on failure
	suite.Equal(1, wc.Len(), "expect webfinger cache to hold one entry")
	wc.Lock()
	suite.True(wc.Cache.Has("misconfigured-instance.com"), "expect webfinger cache to have entry for misconfigured-instance.com")
	last, _ := wc.Cache.Get("misconfigured-instance.com")
	wc.Unlock()

	lastTime := last.Expiry

	// The TTL of the previous and new entry should be the same since
	// a failed request must not extend the entry TTL
	suite.Equal(repeatTime, lastTime)
}

func TestFingerTestSuite(t *testing.T) {
	suite.Run(t, &FingerTestSuite{})
}