Merge pull request #450 from hearchco/as/feat/categoryless

feat!: remove categories from config and instead pass them as base64 encoded json param

docs/example_category.json

@@ -0,0 +1,54 @@
+{
+  "engines": {
+    "google": {
+      "enabled": true,
+      "required": false,
+      "requiredbyorigin": true,
+      "preferred": false,
+      "preferredbyorigin": false
+    },
+    "bing": {
+      "enabled": true,
+      "required": false,
+      "requiredbyorigin": true,
+      "preferred": false,
+      "preferredbyorigin": false
+    },
+    "brave": {
+      "enabled": true,
+      "required": false,
+      "requiredbyorigin": false,
+      "preferred": true,
+      "preferredbyorigin": false
+    }
+  },
+  "ranking": {
+    "rankexp": 0.5,
+    "rankmul": 1,
+    "rankconst": 0,
+    "rankscoremul": 1,
+    "rankscoreadd": 0,
+    "timesreturnedmul": 1,
+    "timesreturnedadd": 0,
+    "timesreturnedscoremul": 1,
+    "timesreturnedscoreadd": 0,
+    "engines": {
+      "google": {
+        "mul": 1,
+        "add": 0
+      },
+      "bing": {
+        "mul": 1,
+        "add": 0
+      },
+      "brave": {
+        "mul": 1,
+        "add": 0
+      }
+    }
+  },
+  "timings": {
+    "preferredtimeout": "500",
+    "hardtimeout": "1500"
+  }
+}

generate/enginer/enginer.go

@@ -25,8 +25,8 @@ var (
 	interfacesImport       = flag.String("interfacesimport", "github.com/hearchco/agent/src/search/scraper", "source of the interface import, which is prefixed to interfaces; default github.com/hearchco/agent/src/search/scraper")
 	interfacesPackage      = flag.String("interfacespackage", "scraper", "name of the package for the interfaces; default scraper")
 	interfaceEnginer       = flag.String("interfaceenginer", "Enginer", "name of the nginer interface; default scraper.Enginer")
-	interfaceSearcher      = flag.String("interfacesearcher", "Searcher", "name of the searcher interface; default scraper.Searcher")
-	interfaceImageSearcher = flag.String("interfaceimagesearcher", "ImageSearcher", "name of the searcher interface; default scraper.ImageSearcher")
+	interfaceWebSearcher   = flag.String("interfacewebsearcher", "WebSearcher", "name of the web searcher interface; default scraper.WebSearcher")
+	interfaceImageSearcher = flag.String("interfaceimagesearcher", "ImageSearcher", "name of the image searcher interface; default scraper.ImageSearcher")
 	interfaceSuggester     = flag.String("interfacesuggester", "Suggester", "name of the suggester interface; default scraper.Suggester")
 	enginesImport          = flag.String("enginesimport", "github.com/hearchco/agent/src/search/engines", "source of the engines import, which is prefixed to imports for engines; default github.com/hearchco/agent/src/search/engines")
 )
@@ -201,7 +201,7 @@ func (g *Generator) generate(typeName string) {
 
 	g.printEnginerLen(values)
 	g.printInterfaces(values, *interfaceEnginer)
-	g.printInterfaces(values, *interfaceSearcher)
+	g.printInterfaces(values, *interfaceWebSearcher)
 	g.printInterfaces(values, *interfaceImageSearcher)
 	g.printInterfaces(values, *interfaceSuggester)
 }

hearchco_example.yaml

@@ -4,16 +4,8 @@ server:
     type: none
   imageproxy:
     secretkey: changemepls
-# categories:
-#   general:
-#     engines:
-#       duckduckgo:
-#         enabled: false
-#     ranking:
-#       engines:
-#         google:
-#           mul: 2
-#   images:
-#     engines:
-#       bing:
-#         enabled: false
+# engines:
+#   google:
+#     noweb: true # Disables web search for this engine
+#     noimages: true # Disables image search for this engine
+#     nosuggestions: true # Disables suggestions for this engine

src/config/defaults.go

@@ -3,7 +3,8 @@ package config
 import (
 	"time"
 
-	"github.com/hearchco/agent/src/search/category"
+	exchengines "github.com/hearchco/agent/src/exchange/engines"
+	"github.com/hearchco/agent/src/search/engines"
 	"github.com/hearchco/agent/src/utils/moretime"
 )
 
@@ -31,57 +32,21 @@ func New() Config {
 				Timeout: 3 * time.Second,
 			},
 		},
-		Categories: map[category.Name]Category{
-			category.SUGGESTIONS: {
-				Engines:                  suggestionsEngines,
-				RequiredEngines:          suggestionsRequiredEngines,
-				RequiredByOriginEngines:  suggestionsRequiredByOriginEngines,
-				PreferredEngines:         suggestionsPreferredEngines,
-				PreferredByOriginEngines: suggestionsPreferredByOriginEngines,
-				Ranking:                  suggestionsRanking(),
-				Timings:                  suggestionsTimings,
-			},
-			category.GENERAL: {
-				Engines:                  generalEngines,
-				RequiredEngines:          generalRequiredEngines,
-				RequiredByOriginEngines:  generalRequiredByOriginEngines,
-				PreferredEngines:         generalPreferredEngines,
-				PreferredByOriginEngines: generalPreferredByOriginEngines,
-				Ranking:                  generalRanking(),
-				Timings:                  generalTimings,
-			},
-			category.IMAGES: {
-				Engines:                  imagesEngines,
-				RequiredEngines:          imagesRequiredEngines,
-				RequiredByOriginEngines:  imagesRequiredByOriginEngines,
-				PreferredEngines:         imagesPreferredEngines,
-				PreferredByOriginEngines: imagesPreferredByOriginEngines,
-				Ranking:                  imagesRanking(),
-				Timings:                  imagesTimings,
-			},
-			category.SCIENCE: {
-				Engines:                  scienceEngines,
-				RequiredEngines:          scienceRequiredEngines,
-				RequiredByOriginEngines:  scienceRequiredByOriginEngines,
-				PreferredEngines:         sciencePreferredEngines,
-				PreferredByOriginEngines: sciencePreferredByOriginEngines,
-				Ranking:                  scienceRanking(),
-				Timings:                  scienceTimings,
-			},
-			category.THOROUGH: {
-				Engines:                  thoroughEngines,
-				RequiredEngines:          thoroughRequiredEngines,
-				RequiredByOriginEngines:  thoroughRequiredByOriginEngines,
-				PreferredEngines:         thoroughPreferredEngines,
-				PreferredByOriginEngines: thoroughPreferredByOriginEngines,
-				Ranking:                  thoroughRanking(),
-				Timings:                  thoroughTimings,
-			},
+		Engines: EngineConfig{
+			NoWeb:         []engines.Name{},
+			NoImages:      []engines.Name{},
+			NoSuggestions: []engines.Name{},
 		},
 		Exchange: Exchange{
 			BaseCurrency: "EUR",
-			Engines:      exchangeEngines,
-			Timings:      exchangeTimings,
+			Engines: []exchengines.Name{
+				exchengines.CURRENCYAPI,
+				exchengines.EXCHANGERATEAPI,
+				exchengines.FRANKFURTER,
+			},
+			Timings: ExchangeTimings{
+				HardTimeout: 1 * time.Second,
+			},
 		},
 	}
 }