mirror of
https://github.com/juanfont/headscale.git
synced 2026-11-19 11:57:07 +09:00
hscontrol: refresh the DERP map without blocking other scheduled tasks
Updates #1926
This commit is contained in:
1 parent
29c4269866
commit
5af7d585bd
2 files changed
+100
-35
No files matched your search
+46
-35
@@ -322,13 +322,10 @@ func (h *Headscale) scheduledTasks(ctx context.Context) {
|
||||
|
||||
lastExpiryCheck := time.Unix(0, 0)
|
||||
|
||||
var derpTickerChan <-chan time.Time
|
||||
|
||||
if h.cfg.DERP.AutoUpdate && h.cfg.DERP.UpdateFrequency != 0 {
|
||||
derpTicker := time.NewTicker(h.cfg.DERP.UpdateFrequency)
|
||||
defer derpTicker.Stop()
|
||||
|
||||
derpTickerChan = derpTicker.C
|
||||
// A refresh retries for minutes when a source is unreachable; the
|
||||
// tasks below must not wait for it.
|
||||
go h.refreshDERPMap(ctx)
|
||||
}
|
||||
|
||||
var extraRecordsUpdate <-chan []tailcfg.DNSRecord
|
||||
@@ -414,35 +411,6 @@ func (h *Headscale) scheduledTasks(ctx context.Context) {
|
||||
}
|
||||
}
|
||||
|
||||
case <-derpTickerChan:
|
||||
log.Info().Msg("fetching DERPMap updates")
|
||||
|
||||
derpMap, err := backoff.Retry(ctx, func() (*tailcfg.DERPMap, error) { //nolint:contextcheck
|
||||
derpMap, err := derp.GetDERPMap(h.cfg.DERP, h.cfg.DNSConfig.BaseDomain)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
if h.cfg.DERP.Server.Enabled && h.cfg.DERP.Server.AutomaticallyAddEmbeddedDerpRegion {
|
||||
region, err := h.DERPServer.GenerateRegion()
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("generating embedded DERP region: %w", err)
|
||||
}
|
||||
|
||||
derpMap.Regions[region.RegionID] = ®ion
|
||||
}
|
||||
|
||||
return derpMap, nil
|
||||
}, backoff.WithBackOff(backoff.NewExponentialBackOff()))
|
||||
if err != nil {
|
||||
log.Error().Err(err).Msg("failed to build new DERPMap, retrying later")
|
||||
continue
|
||||
}
|
||||
|
||||
h.state.SetDERPMap(derpMap)
|
||||
|
||||
h.Change(change.DERPMap())
|
||||
|
||||
case records, ok := <-extraRecordsUpdate:
|
||||
if !ok {
|
||||
continue
|
||||
@@ -459,6 +427,49 @@ func (h *Headscale) scheduledTasks(ctx context.Context) {
|
||||
}
|
||||
}
|
||||
|
||||
// refreshDERPMap reloads the DERP map every derp.update_frequency until
|
||||
// ctx ends.
|
||||
func (h *Headscale) refreshDERPMap(ctx context.Context) {
|
||||
ticker := time.NewTicker(h.cfg.DERP.UpdateFrequency)
|
||||
defer ticker.Stop()
|
||||
|
||||
for {
|
||||
select {
|
||||
case <-ctx.Done():
|
||||
return
|
||||
case <-ticker.C:
|
||||
}
|
||||
|
||||
log.Info().Msg("fetching DERPMap updates")
|
||||
|
||||
derpMap, err := backoff.Retry(ctx, func() (*tailcfg.DERPMap, error) { //nolint:contextcheck
|
||||
derpMap, err := derp.GetDERPMap(h.cfg.DERP, h.cfg.DNSConfig.BaseDomain)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
if h.cfg.DERP.Server.Enabled && h.cfg.DERP.Server.AutomaticallyAddEmbeddedDerpRegion {
|
||||
region, err := h.DERPServer.GenerateRegion()
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("generating embedded DERP region: %w", err)
|
||||
}
|
||||
|
||||
derpMap.Regions[region.RegionID] = ®ion
|
||||
}
|
||||
|
||||
return derpMap, nil
|
||||
}, backoff.WithBackOff(backoff.NewExponentialBackOff()))
|
||||
if err != nil {
|
||||
log.Error().Err(err).Msg("failed to build new DERPMap, retrying later")
|
||||
continue
|
||||
}
|
||||
|
||||
h.state.SetDERPMap(derpMap)
|
||||
|
||||
h.Change(change.DERPMap())
|
||||
}
|
||||
}
|
||||
|
||||
// ensureUnixSocketIsAbsent will check if the given path for headscales unix socket is clear
|
||||
// and will remove it if it is not.
|
||||
func (h *Headscale) ensureUnixSocketIsAbsent() error {
|
||||
|
||||
@@ -427,3 +427,57 @@ func TestNewHeadscaleGoOnlyProvider(t *testing.T) {
|
||||
|
||||
assert.Same(t, provider, cfg.DNSProvider())
|
||||
}
|
||||
|
||||
// TestDERPRefreshDoesNotBlockScheduledTasks: a DERP refresh stuck on an
|
||||
// unreachable source leaves the other scheduled tasks running.
|
||||
func TestDERPRefreshDoesNotBlockScheduledTasks(t *testing.T) {
|
||||
requested := make(chan struct{}, 1)
|
||||
release := make(chan struct{})
|
||||
stuck := httptest.NewServer(http.HandlerFunc(func(_ http.ResponseWriter, r *http.Request) {
|
||||
select {
|
||||
case requested <- struct{}{}:
|
||||
default:
|
||||
}
|
||||
|
||||
select {
|
||||
case <-release:
|
||||
case <-r.Context().Done():
|
||||
}
|
||||
}))
|
||||
t.Cleanup(stuck.Close)
|
||||
t.Cleanup(func() { close(release) })
|
||||
|
||||
app := createTestApp(t, func(c *types.Config) {
|
||||
c.DERP.URLs = []types.HTTPURL{types.HTTPURL(stuck.URL)}
|
||||
c.DERP.AutoUpdate = true
|
||||
c.DERP.UpdateFrequency = time.Millisecond
|
||||
})
|
||||
|
||||
records := filepath.Join(t.TempDir(), "records.json")
|
||||
require.NoError(t, os.WriteFile(records, []byte("[]"), 0o600))
|
||||
|
||||
var err error
|
||||
|
||||
app.extraRecordMan, err = dns.NewExtraRecordsManager(records)
|
||||
require.NoError(t, err)
|
||||
|
||||
go app.extraRecordMan.Run()
|
||||
|
||||
t.Cleanup(app.extraRecordMan.Close)
|
||||
|
||||
ctx, cancel := context.WithCancel(t.Context())
|
||||
t.Cleanup(cancel)
|
||||
|
||||
go app.scheduledTasks(ctx)
|
||||
|
||||
select {
|
||||
case <-requested:
|
||||
case <-time.After(10 * time.Second):
|
||||
t.Fatal("no DERP refresh started")
|
||||
}
|
||||
|
||||
require.NoError(t, os.WriteFile(records, []byte(`[{"name":"a.example.com","type":"A","value":"100.64.0.1"}]`), 0o600))
|
||||
|
||||
assert.Eventually(t, func() bool { return app.cfg.HasExtraRecord("a.example.com") }, 10*time.Second, 50*time.Millisecond,
|
||||
"extra records not reloaded while the DERP refresh is stuck")
|
||||
}
|
||||
Reference in new issue
Block a user