Skip to content

Commit

Permalink
Allow unregistration of discovery listener
Browse files Browse the repository at this point in the history
Signed-off-by: Magnus Jungsbluth <magnus.jungsbluth@zalando.de>
  • Loading branch information
mjungsbluth committed Jul 4, 2024
1 parent ec03879 commit d511518
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 0 deletions.
8 changes: 8 additions & 0 deletions plugins/discovery/discovery.go
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,14 @@ func (c *Discovery) RegisterListener(name interface{}, f func(bundle.Status)) {
c.listeners[name] = f
}

// Unregister a listener to stop receiving status updates.
func (c *Discovery) Unregister(name interface{}) {
c.listenersMtx.Lock()
defer c.listenersMtx.Unlock()

delete(c.listeners, name)
}

func (c *Discovery) getBundlePersistPath() (string, error) {
persistDir, err := c.manager.Config.GetPersistenceDirectory()
if err != nil {
Expand Down
49 changes: 49 additions & 0 deletions plugins/discovery/discovery_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ import (
"github.com/open-policy-agent/opa/logging/test"
"github.com/open-policy-agent/opa/metrics"
"github.com/open-policy-agent/opa/plugins"
"github.com/open-policy-agent/opa/plugins/bundle"
bundlePlugin "github.com/open-policy-agent/opa/plugins/bundle"
"github.com/open-policy-agent/opa/plugins/logs"
"github.com/open-policy-agent/opa/plugins/status"
Expand Down Expand Up @@ -3765,6 +3766,54 @@ func TestPluginManualTriggerLifecycle(t *testing.T) {
fixture.testDiscoReconfigurationScenario(ctx, m)
}

func TestListeners(t *testing.T) {
manager, err := plugins.New([]byte(`{
"labels": {"x": "y"},
"services": {
"localhost": {
"url": "http://localhost:9999"
}
},
"discovery": {"name": "config", "persist": true},
}`), "test-id", inmem.New())
if err != nil {
t.Fatal(err)
}

testPlugin := &reconfigureTestPlugin{counts: map[string]int{}}
testFactory := testFactory{p: testPlugin}

disco, err := New(manager, Factories(map[string]plugins.Factory{"test_plugin": testFactory}))
if err != nil {
t.Fatal(err)
}

ctx := context.Background()

ensurePluginState(t, disco, plugins.StateNotReady)

var status *bundle.Status
disco.RegisterListener("testlistener", func(s bundle.Status) {
status = &s
})

// simulate a bundle download error
disco.oneShot(ctx, download.Update{Error: fmt.Errorf("unknown error")})

if status == nil {
t.Fatalf("Expected discovery listener to receive status but was nil")
}

status = nil
disco.Unregister("testlistener")

// simulate a bundle download error
disco.oneShot(ctx, download.Update{Error: fmt.Errorf("unknown error")})
if status != nil {
t.Fatalf("Expected discovery listener to be removed but received %v", status)
}
}

type testFixture struct {
manager *plugins.Manager
plugin *Discovery
Expand Down

0 comments on commit d511518

Please sign in to comment.