Merge branch 's7evink/fts2' into s7evink/fts

dendrite-sample.monolith.yaml

@@ -237,6 +237,10 @@ sync_api:
   # address of the client. This is likely required if Dendrite is running behind
   # a reverse proxy server.
   # real_ip_header: X-Real-IP
+  fulltext:
+    enabled: false
+    index_path: "./fulltextindex"
+    language: "en" # more possible languages can be found at https://github.com/blevesearch/bleve/tree/master/analysis/lang
 
 # Configuration for the User API.
 user_api:

dendrite-sample.polylith.yaml

@@ -295,6 +295,10 @@ sync_api:
     max_open_conns: 10
     max_idle_conns: 2
     conn_max_lifetime: -1
+  fulltext:
+    enabled: false
+    index_path: "./fulltextindex"
+    language: "en" # more possible languages can be found at https://github.com/blevesearch/bleve/tree/master/analysis/lang
 
   # This option controls which HTTP header to inspect to find the real remote IP
   # address of the client. This is likely required if Dendrite is running behind

docs/installation/7_configuration.md

@@ -138,6 +138,19 @@ room_server:
     conn_max_lifetime: -1
 ```
 
+## Fulltext search
+
+Dendrite supports experimental fulltext indexing using [Bleve](https://github.com/blevesearch/bleve), it is configured in the `sync_api` section as follows. Depending on the language most likely to be used on the server, it might make sense to change the `language` used when indexing, to ensure the returned results match the expections. A full list of possible languages can be found [here](https://github.com/blevesearch/bleve/tree/master/analysis/lang).
+
+```yaml
+sync_api:
+  # ...
+  fulltext:
+    enabled: false
+    index_path: "./fulltextindex"
+    language: "en"
+```
+
 ## Other sections
 
 There are other options which may be useful so review them all. In particular, if you are

internal/fulltext/bleve.go

@@ -12,6 +12,9 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+//go:build !wasm
+// +build !wasm
+
 package fulltext
 
 import (
@@ -64,13 +67,8 @@ func (f *Search) Close() error {
 	return f.FulltextIndex.Close()
 }
 
-// FulltextIndex indexes a given element
+// Index indexes the given elements
-func (f *Search) Index(e IndexElement) error {
+func (f *Search) Index(elements ...IndexElement) error {
-	return f.FulltextIndex.Index(e.EventID, e)
-}
-
-// BatchIndex indexes the given elements
-func (f *Search) BatchIndex(elements []IndexElement) error {
 	batch := f.FulltextIndex.NewBatch()
 
 	for _, element := range elements {

internal/fulltext/bleve_test.go

@@ -81,7 +81,7 @@ func mustAddTestData(t *testing.T, fts *fulltext.Search, firstStreamPos int64) (
 	}
 	e.SetContentType(gomatrixserverlib.MRoomTopic)
 	batchItems = append(batchItems, e)
-	if err := fts.BatchIndex(batchItems); err != nil {
+	if err := fts.Index(batchItems...); err != nil {
 		t.Fatalf("failed to batch insert elements: %v", err)
 	}
 	return eventIDs, roomIDs

internal/fulltext/bleve_wasm.go

@@ -0,0 +1,65 @@
+// Copyright 2022 The Matrix.org Foundation C.I.C.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package fulltext
+
+import (
+	"github.com/matrix-org/dendrite/setup/config"
+	"time"
+)
+
+type Search struct{}
+type IndexElement struct {
+	EventID        string
+	RoomID         string
+	Content        string
+	ContentType    string
+	StreamPosition int64
+}
+
+type SearchResult struct {
+	Status   interface{}   `json:"status"`
+	Request  *interface{}  `json:"request"`
+	Hits     []interface{} `json:"hits"`
+	Total    uint64        `json:"total_hits"`
+	MaxScore float64       `json:"max_score"`
+	Took     time.Duration `json:"took"`
+	Facets   interface{}   `json:"facets"`
+}
+
+func (i *IndexElement) SetContentType(v string) {}
+
+func New(cfg config.Fulltext) (fts *Search, err error) {
+	return &Search{}, nil
+}
+
+func (f *Search) Close() error {
+	return nil
+}
+
+func (f *Search) Index(e IndexElement) error {
+	return nil
+}
+
+func (f *Search) BatchIndex(elements []IndexElement) error {
+	return nil
+}
+
+func (f *Search) Delete(eventID string) error {
+	return nil
+}
+
+func (f *Search) Search(term string, roomIDs, keys []string, limit, from int, orderByStreamPos bool) (SearchResult, error) {
+	return SearchResult{}, nil
+}