summaryrefslogtreecommitdiff
path: root/plugins/broadcast/plugin.go
blob: a2390df57dd2f0cb03e72538a1673f44a16f38e2 (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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
package broadcast

import (
	"fmt"
	"sync"

	endure "github.com/spiral/endure/pkg/container"
	"github.com/spiral/errors"
	"github.com/spiral/roadrunner/v2/common/pubsub"
	"github.com/spiral/roadrunner/v2/plugins/config"
	"github.com/spiral/roadrunner/v2/plugins/logger"
)

const (
	PluginName string = "broadcast"
	// driver is the mandatory field which should present in every storage
	driver string = "driver"
)

type Plugin struct {
	sync.RWMutex

	cfg       *Config
	cfgPlugin config.Configurer
	log       logger.Logger
	// publishers implement Publisher interface
	// and able to receive a payload
	publishers   map[string]pubsub.PubSub
	constructors map[string]pubsub.Constructor
}

func (p *Plugin) Init(cfg config.Configurer, log logger.Logger) error {
	const op = errors.Op("broadcast_plugin_init")
	if !cfg.Has(PluginName) {
		return errors.E(op, errors.Disabled)
	}
	p.cfg = &Config{}
	// unmarshal config section
	err := cfg.UnmarshalKey(PluginName, &p.cfg.Data)
	if err != nil {
		return errors.E(op, err)
	}

	p.publishers = make(map[string]pubsub.PubSub)
	p.constructors = make(map[string]pubsub.Constructor)

	p.log = log
	p.cfgPlugin = cfg
	return nil
}

func (p *Plugin) Serve() chan error {
	return make(chan error)
}

func (p *Plugin) Stop() error {
	return nil
}

func (p *Plugin) Collects() []interface{} {
	return []interface{}{
		p.CollectPublishers,
	}
}

// CollectPublishers collect all plugins who implement pubsub.Publisher interface
func (p *Plugin) CollectPublishers(name endure.Named, constructor pubsub.Constructor) {
	// key redis, value - interface
	p.constructors[name.Name()] = constructor
}

// Publish is an entry point to the websocket PUBSUB
func (p *Plugin) Publish(m *pubsub.Message) error {
	p.Lock()
	defer p.Unlock()

	const op = errors.Op("broadcast_plugin_publish")

	// check if any publisher registered
	if len(p.publishers) > 0 {
		for j := range p.publishers {
			err := p.publishers[j].Publish(m)
			if err != nil {
				return errors.E(op, err)
			}
		}
		return nil
	} else {
		p.log.Warn("no publishers registered")
	}

	return nil
}

func (p *Plugin) PublishAsync(m *pubsub.Message) {
	// TODO(rustatian) channel here?
	go func() {
		p.Lock()
		defer p.Unlock()
		// check if any publisher registered
		if len(p.publishers) > 0 {
			for j := range p.publishers {
				err := p.publishers[j].Publish(m)
				if err != nil {
					p.log.Error("publishAsync", "error", err)
					// continue publishing to the other registered publishers
					continue
				}
			}
		} else {
			p.log.Warn("no publishers registered")
		}
	}()
}

func (p *Plugin) GetDriver(key string) (pubsub.SubReader, error) {
	const op = errors.Op("broadcast_plugin_get_driver")

	// choose a driver
	if val, ok := p.cfg.Data[key]; ok {
		// check type of the v
		// should be a map[string]interface{}
		switch t := val.(type) {
		// correct type
		case map[string]interface{}:
			if _, ok := t[driver]; !ok {
				panic(errors.E(op, errors.Errorf("could not find mandatory driver field in the %s storage", val)))
			}
		default:
			return nil, errors.E(op, errors.Str("wrong type detected in the configuration, please, check yaml indentation"))
		}

		// config key for the particular sub-driver kv.memcached
		configKey := fmt.Sprintf("%s.%s", PluginName, key)

		drName := val.(map[string]interface{})[driver]

		// driver name should be a string
		if drStr, ok := drName.(string); ok {
			if _, ok := p.constructors[drStr]; !ok {
				return nil, errors.E(op, errors.Errorf("no drivers with the requested name registered, registered: %s, requested: %s", p.publishers, drStr))
			}

			// try local config first
			if p.cfgPlugin.Has(configKey) {
				ps, err := p.constructors[drStr].PSConstruct(configKey)
				if err != nil {
					return nil, errors.E(op, err)
				}

				// save the initialized publisher channel
				// for the in-memory, register new publishers
				p.publishers[configKey] = ps

				return ps, nil
			} else {
				// try global driver section
				ps, err := p.constructors[drStr].PSConstruct(drStr)
				if err != nil {
					return nil, errors.E(op, err)
				}

				// save the initialized publisher channel
				// for the in-memory, register new publishers
				p.publishers[configKey] = ps

				return ps, nil
			}
		}
	}
	return nil, errors.E(op, errors.Str("could not find driver by provided key"))
}

func (p *Plugin) RPC() interface{} {
	return &rpc{
		plugin: p,
		log:    p.log,
	}
}

func (p *Plugin) Name() string {
	return PluginName
}

func (p *Plugin) Available() {}