summaryrefslogtreecommitdiff
path: root/modules/ratelimit/ratelimit.go
blob: 9588db30e0cccde34b5b54e10da2f1abaf6888be (plain) (blame)
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
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.

package ratelimit

import (
	"time"

	"github.com/philippta/flyscrape"
)

func init() {
	flyscrape.RegisterModule(Module{})
}

type Module struct {
	Rate float64 `json:"rate"`

	ticker    *time.Ticker
	semaphore chan struct{}
}

func (Module) ModuleInfo() flyscrape.ModuleInfo {
	return flyscrape.ModuleInfo{
		ID:  "ratelimit",
		New: func() flyscrape.Module { return new(Module) },
	}
}

func (m *Module) Provision(v flyscrape.Context) {
	if m.disabled() {
		return
	}

	rate := time.Duration(float64(time.Second) / m.Rate)

	m.ticker = time.NewTicker(rate)
	m.semaphore = make(chan struct{}, 1)

	go func() {
		for range m.ticker.C {
			m.semaphore <- struct{}{}
		}
	}()
}

func (m *Module) BuildRequest(_ *flyscrape.Request) {
	if m.disabled() {
		return
	}
	<-m.semaphore
}

func (m *Module) Finalize() {
	if m.disabled() {
		return
	}
	m.ticker.Stop()
}

func (m *Module) disabled() bool {
	return m.Rate == 0
}

var (
	_ flyscrape.RequestBuilder = (*Module)(nil)
	_ flyscrape.Provisioner    = (*Module)(nil)
	_ flyscrape.Finalizer      = (*Module)(nil)
)