Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add peer provider plugin registration #5926

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions common/config/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@ type (
Config struct {
// Ringpop is the ringpop related configuration
Ringpop ringpopprovider.Config `yaml:"ringpop"`
// Membership is used to configure peer provider plugin
Membership Membership `yaml:"membership"`
// Persistence contains the configuration for cadence datastores
Persistence Persistence `yaml:"persistence"`
// Log is the logging config
Expand Down Expand Up @@ -84,6 +86,14 @@ type (
AsyncWorkflowQueues map[string]AsyncWorkflowQueueProvider `yaml:"asyncWorkflowQueues"`
}

// Membership holds peer provider configuration.
Membership struct {
Provider PeerProvider `yaml:"provider"`
}

// PeerProvider is provider config. Contents depends on plugin in use
PeerProvider map[string]*YamlNode

HeaderRule struct {
Add bool // if false, matching headers are removed if previously matched.
Match *regexp.Regexp
Expand Down
98 changes: 98 additions & 0 deletions common/peerprovider/plugin.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
// The MIT License (MIT)

// Copyright (c) 2017-2020 Uber Technologies Inc.

// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

package peerprovider

import (
"fmt"

"go.uber.org/yarpc/transport/tchannel"

"github.com/uber/cadence/common/config"
"github.com/uber/cadence/common/log"
"github.com/uber/cadence/common/membership"
"github.com/uber/cadence/common/syncmap"
)

const key = "peerprovider"

// Container is passed to peer provider plugin
type Container struct {
Service string
// Channel is required by ringpop
Channel tchannel.Channel
Logger log.Logger
Portmap membership.PortMap
}

type constructorFn func(cfg *config.YamlNode, container Container) (membership.PeerProvider, error)

var plugins = syncmap.New[string, plugin]()

type plugin struct {
fn constructorFn
configKey string
}

type Provider struct {
config config.PeerProvider
container Container
}

func New(config config.PeerProvider, container Container) *Provider {
return &Provider{
config: config,
container: container,
}
}

func Register(configKey string, constructor constructorFn) error {

inserted := plugins.Put(key, plugin{
fn: constructor,
configKey: configKey,
})

// only one plugin is allowed to be registered
if !inserted {
registeredPlugin, _ := plugins.Get(key)
return fmt.Errorf("cannot register %q provider, %q is already registered", configKey, registeredPlugin.configKey)
}

return nil
}

func (p *Provider) Provider() (membership.PeerProvider, error) {
registeredPlugin, found := plugins.Get(key)

if !found {
return nil, fmt.Errorf("no configured peer providers found")
}

for configKey, cfg := range p.config {
mantas-sidlauskas marked this conversation as resolved.
Show resolved Hide resolved
if configKey == registeredPlugin.configKey {
return registeredPlugin.fn(cfg, p.container)
}
}

return nil, fmt.Errorf("no configuration for %q peer provider found", registeredPlugin.configKey)
}
86 changes: 86 additions & 0 deletions common/peerprovider/plugin_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
// The MIT License (MIT)

// Copyright (c) 2017-2020 Uber Technologies Inc.

// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

package peerprovider

import (
"testing"

"github.com/stretchr/testify/assert"

"github.com/uber/cadence/common/config"
"github.com/uber/cadence/common/membership"
"github.com/uber/cadence/common/syncmap"
)

func TestProviderRetrunsErrorWhenNoProviderRegistered(t *testing.T) {
// Reset plugins
plugins = syncmap.New[string, plugin]()
a := Provider{
config: nil,
container: Container{},
}
p, err := a.Provider()
assert.Nil(t, p)
assert.EqualError(t, err, "no configured peer providers found")
}

func TestProviderRetrunsErrorWhenPluginAlreadyRegistered(t *testing.T) {
// Reset plugins
plugins = syncmap.New[string, plugin]()
err := Register("provider1", func(cfg *config.YamlNode, container Container) (membership.PeerProvider, error) {
return nil, nil
})
assert.NoError(t, err)
err = Register("provider2", func(cfg *config.YamlNode, container Container) (membership.PeerProvider, error) {
return nil, nil
})
assert.Error(t, err)
}

func TestConfigIsPickedUp(t *testing.T) {
// Reset plugins
plugins = syncmap.New[string, plugin]()

peerProviderConfig := map[string]*config.YamlNode{}
peerProviderConfig["provider1"] = &config.YamlNode{}

pp := New(peerProviderConfig, Container{})
err := Register("provider1", func(cfg *config.YamlNode, container Container) (membership.PeerProvider, error) {
return nil, nil
})
assert.NoError(t, err)
_, err = pp.Provider()
assert.NoError(t, err)
}

func TestErrorWhenConfigIsNotProvided(t *testing.T) {
// Reset plugins
plugins = syncmap.New[string, plugin]()
pp := New(config.PeerProvider{}, Container{})
err := Register("provider1", func(cfg *config.YamlNode, container Container) (membership.PeerProvider, error) {
return nil, nil
})
p, err := pp.Provider()
assert.Nil(t, p)
assert.EqualError(t, err, "no configuration for \"provider1\" peer provider found")
}
Loading