feat: add RS middleware for plugins

Author: bietkul

main.go

@@ -172,24 +172,30 @@ func main() {
 	// ES v7 and v6 clients
 	util.NewClient()
 	// map of specific plugins
-	sequencedPlugins := []string{"rules.so", "functions.so", "querytranslate.so", "analytics.so"}
+	sequencedPlugins := []string{"rules.so", "functions.so", "analytics.so"}
 	sequencedPluginsByPath := make(map[string]string)
 
-	var elasticSearchPath string
+	var elasticSearchPath, reactiveSearchPath string
 	elasticSearchMiddleware := make([]middleware.Middleware, 0)
+	reactiveSearchMiddleware := make([]middleware.Middleware, 0)
 	err := filepath.Walk(pluginDir, func(path string, info os.FileInfo, err error) error {
 		if err != nil {
 			return err
 		}
 		if !info.IsDir() && filepath.Ext(info.Name()) == ".so" && info.Name() != "elasticsearch.so" {
-			if util.IsExists(info.Name(), sequencedPlugins) {
-				sequencedPluginsByPath[info.Name()] = path
-			} else {
-				mw, err1 := LoadPluginFromFile(router, path)
-				if err1 != nil {
-					return err1
+			if info.Name() != "querytranslate.so" {
+				if util.IsExists(info.Name(), sequencedPlugins) {
+					sequencedPluginsByPath[info.Name()] = path
+				} else {
+					plugin, err1 := LoadPluginFromFile(router, path)
+					if err1 != nil {
+						return err1
+					}
+					reactiveSearchMiddleware = append(reactiveSearchMiddleware, plugin.RSMiddleware()...)
+					elasticSearchMiddleware = append(elasticSearchMiddleware, plugin.ESMiddleware()...)
 				}
-				elasticSearchMiddleware = append(elasticSearchMiddleware, mw...)
+			} else {
+				reactiveSearchPath = path
 			}
 		} else if info.Name() == "elasticsearch.so" {
 			elasticSearchPath = path
@@ -200,14 +206,19 @@ func main() {
 	for _, pluginName := range sequencedPlugins {
 		path, _ := sequencedPluginsByPath[pluginName]
 		if path != "" {
-			mw, err := LoadPluginFromFile(router, path)
+			plugin, err := LoadPluginFromFile(router, path)
 			if err != nil {
 				log.Fatal("error loading plugins: ", err)
 			}
-			elasticSearchMiddleware = append(elasticSearchMiddleware, mw...)
+			elasticSearchMiddleware = append(elasticSearchMiddleware, plugin.ESMiddleware()...)
+			reactiveSearchMiddleware = append(reactiveSearchMiddleware, plugin.RSMiddleware()...)
 		}
 	}
 	LoadESPluginFromFile(router, elasticSearchPath, elasticSearchMiddleware)
+	// Load ReactiveSearch plugin
+	if reactiveSearchPath != "" {
+		LoadESPluginFromFile(router, reactiveSearchPath, reactiveSearchMiddleware)
+	}
 	if err != nil {
 		log.Fatal("error loading plugins: ", err)
 	}
@@ -242,7 +253,7 @@ func LoadPIFromFile(path string) (plugin.Symbol, error) {
 }
 
 // LoadPluginFromFile loads a plugin at the given location
-func LoadPluginFromFile(router *mux.Router, path string) ([]middleware.Middleware, error) {
+func LoadPluginFromFile(router *mux.Router, path string) (plugins.Plugin, error) {
 	pi, err2 := LoadPIFromFile(path)
 	if err2 != nil {
 		return nil, err2
@@ -253,7 +264,7 @@ func LoadPluginFromFile(router *mux.Router, path string) ([]middleware.Middlewar
 	if err3 != nil {
 		return nil, err3
 	}
-	return p.ESMiddleware(), nil
+	return p, nil
 }
 
 func LoadESPluginFromFile(router *mux.Router, path string, mw []middleware.Middleware) error {
@@ -266,6 +277,16 @@ func LoadESPluginFromFile(router *mux.Router, path string, mw []middleware.Middl
 	return plugins.LoadESPlugin(router, p, mw)
 }
 
+func LoadRSPluginFromFile(router *mux.Router, path string, mw []middleware.Middleware) error {
+	pi, err2 := LoadPIFromFile(path)
+	if err2 != nil {
+		return err2
+	}
+	var p plugins.RSPlugin
+	p = *pi.(*plugins.RSPlugin)
+	return plugins.LoadRSPlugin(router, p, mw)
+}
+
 // LoadEnvFromFile loads env vars from envFile. Envs in the file
 // should be in KEY=VALUE format.
 func LoadEnvFromFile(envFile string) error {

plugins/auth/auth.go

@@ -135,3 +135,8 @@ func (a *Auth) Routes() []plugins.Route {
 func (a *Auth) ESMiddleware() []middleware.Middleware {
 	return make([]middleware.Middleware, 0)
 }
+
+// Default empty middleware array function
+func (a *Auth) RSMiddleware() []middleware.Middleware {
+	return make([]middleware.Middleware, 0)
+}

plugins/auth/main/auth.go

@@ -1,6 +1,8 @@
 package main
 
-import "github.com/appbaseio/arc/plugins/auth"
-import "github.com/appbaseio/arc/plugins"
+import (
+	"github.com/appbaseio/arc/plugins"
+	"github.com/appbaseio/arc/plugins/auth"
+)
 
 var PluginInstance plugins.Plugin = auth.Instance()

plugins/logs/logs.go

@@ -73,3 +73,8 @@ func (l *Logs) Routes() []plugins.Route {
 func (l *Logs) ESMiddleware() []middleware.Middleware {
 	return make([]middleware.Middleware, 0)
 }
+
+// Default empty middleware array function
+func (a *Logs) RSMiddleware() []middleware.Middleware {
+	return make([]middleware.Middleware, 0)
+}

plugins/permissions/permissions.go

@@ -65,3 +65,8 @@ func (p *permissions) Routes() []plugins.Route {
 func (p *permissions) ESMiddleware() []middleware.Middleware {
 	return make([]middleware.Middleware, 0)
 }
+
+// Default empty middleware array function
+func (p *permissions) RSMiddleware() []middleware.Middleware {
+	return make([]middleware.Middleware, 0)
+}

plugins/registry.go

@@ -39,6 +39,9 @@ type Plugin interface {
 
 	// The plugin's elastic search middleware, if any.
 	ESMiddleware() []middleware.Middleware
+
+	// The plugin's reactive search middleware, if any.
+	RSMiddleware() []middleware.Middleware
 }
 
 // ElasticSearchPlugin holds the plugin for ES
@@ -49,6 +52,14 @@ type ESPlugin interface {
 	InitFunc(mw []middleware.Middleware) error
 }
 
+// ReactiveSearchPlugin holds the plugin for ReactiveSearch API
+type RSPlugin interface {
+	nameRoutes
+
+	// mw takes a array of middleware to be intialized by ES Plugin
+	InitFunc(mw []middleware.Middleware) error
+}
+
 // RegisterPlugin plugs in plugin. All plugins must have a name:
 // preferably lowercase and one word. The name of the plugin must
 // be unique. A plugin, however, may not define any routes, but
@@ -86,6 +97,15 @@ func LoadESPlugin(router *mux.Router, p ESPlugin, mw []middleware.Middleware) er
 	return loadRoutes(router, p)
 }
 
+func LoadRSPlugin(router *mux.Router, p RSPlugin, mw []middleware.Middleware) error {
+	log.Println(logTag, ": Initializing plugin:", p.Name())
+	err := p.InitFunc(mw)
+	if err != nil {
+		return err
+	}
+	return loadRoutes(router, p)
+}
+
 // loadRoutes registers the routes to the router that are associated with
 // that plugin.
 func loadRoutes(router *mux.Router, p nameRoutes) error {

plugins/reindexer/reindexer.go

@@ -43,3 +43,8 @@ func (rx *reindexer) Routes() []plugins.Route {
 func (rx *reindexer) ESMiddleware() []middleware.Middleware {
 	return make([]middleware.Middleware, 0)
 }
+
+// Default empty middleware array function
+func (rx *reindexer) RSMiddleware() []middleware.Middleware {
+	return make([]middleware.Middleware, 0)
+}

plugins/users/users.go

@@ -67,3 +67,8 @@ func (u *Users) Routes() []plugins.Route {
 func (u *Users) ESMiddleware() []middleware.Middleware {
 	return make([]middleware.Middleware, 0)
 }
+
+// Default empty middleware array function
+func (u *Users) RSMiddleware() []middleware.Middleware {
+	return make([]middleware.Middleware, 0)
+}