diff options
Diffstat (limited to 'internal')
-rw-r--r-- | internal/components/combined.go | 4 | ||||
-rw-r--r-- | internal/components/markdown.go | 2 | ||||
-rw-r--r-- | internal/components/options.go | 6 | ||||
-rw-r--r-- | internal/components/packages.go | 6 | ||||
-rw-r--r-- | internal/components/page.go | 5 | ||||
-rw-r--r-- | internal/components/search.go | 27 | ||||
-rw-r--r-- | internal/index/indexer.go | 15 | ||||
-rw-r--r-- | internal/index/search.go | 27 | ||||
-rw-r--r-- | internal/index/search_test.go | 150 | ||||
-rw-r--r-- | internal/server/mux.go | 22 |
10 files changed, 224 insertions, 40 deletions
diff --git a/internal/components/combined.go b/internal/components/combined.go index fe97e14..8c2dc34 100644 --- a/internal/components/combined.go +++ b/internal/components/combined.go @@ -31,7 +31,7 @@ func Combined(result *index.Result) g.Node { Th(Scope("col"), g.Text("Attribute")), Th(Scope("col"), g.Text("Description")), g.If(config.DevMode, - Th(Scope("col"), g.Text("Score")), + Th(Scope("col"), Class("score"), g.Text("Score")), ), ), ), @@ -41,7 +41,7 @@ func Combined(result *index.Result) g.Node { Td( openCombinedDialogLink(nix.GetKey(hit.Data)), ), - Td( + Td(Class("description"), CombinedData(hit.Data), ), g.If(config.DevMode, diff --git a/internal/components/markdown.go b/internal/components/markdown.go index 405ab52..a26fe3d 100644 --- a/internal/components/markdown.go +++ b/internal/components/markdown.go @@ -4,7 +4,7 @@ import ( "regexp" ) -var firstSentenceRegexp = regexp.MustCompile(`^.*?\.[[:space:]]`) +var firstSentenceRegexp = regexp.MustCompile(`^.+?(\.[[:space:]]|:\n)`) func firstSentence[T ~string](text T) T { if fs := firstSentenceRegexp.FindString(string(text)); fs != "" { diff --git a/internal/components/options.go b/internal/components/options.go index 1d01784..630fecd 100644 --- a/internal/components/options.go +++ b/internal/components/options.go @@ -14,9 +14,9 @@ func Options(result *index.Result) g.Node { THead( Tr( Th(Scope("col"), g.Text("Title")), - Th(Scope("col"), g.Text("Description")), + Th(Scope("col"), Class("description"), g.Text("Description")), g.If(config.DevMode, - Th(Scope("col"), g.Text("Score")), + Th(Scope("col"), Class("score"), g.Text("Score")), ), ), ), @@ -37,7 +37,7 @@ func optionRow(hit index.DocumentMatch, o nix.Option) g.Node { Td( openDialogLink(o.Name), ), - Td( + Td(Class("description"), firstSentence(o.Description), Dialog(ID(o.Name)), ), diff --git a/internal/components/packages.go b/internal/components/packages.go index db45302..90bf92d 100644 --- a/internal/components/packages.go +++ b/internal/components/packages.go @@ -15,9 +15,9 @@ func Packages(result *index.Result) g.Node { Tr( Th(Scope("col"), g.Text("Attribute")), Th(Scope("col"), g.Text("Name")), - Th(Scope("col"), g.Text("Description")), + Th(Scope("col"), Class("description"), g.Text("Description")), g.If(config.DevMode, - Th(Scope("col"), g.Text("Score")), + Th(Scope("col"), Class("score"), g.Text("Score")), ), ), ), @@ -41,7 +41,7 @@ func packageRow(hit index.DocumentMatch, p nix.Package) g.Node { Td( g.Text(p.Name), ), - Td( + Td(Class("description"), g.Text(p.Description), ), g.If(config.DevMode, diff --git a/internal/components/page.go b/internal/components/page.go index 6830247..06e16ae 100644 --- a/internal/components/page.go +++ b/internal/components/page.go @@ -90,7 +90,10 @@ func Page(tdata TemplateData, children ...g.Node) g.Node { g.Group([]g.Node{ g.Text("Searchix "), A( - Href("https://git.sr.ht/~alanpearce/searchix/refs/"+config.Version), + Href( + "https://git.sr.ht/~alanpearce/searchix/tree/"+config.Version+"/CHANGELOG.md", + ), + TitleAttr("View changelog"), g.Text(config.Version), ), g.Text(" "), diff --git a/internal/components/search.go b/internal/components/search.go index b4ef7bd..3db1cd4 100644 --- a/internal/components/search.go +++ b/internal/components/search.go @@ -19,6 +19,7 @@ func SearchForm(tdata TemplateData, r ResultData) g.Node { Input( ID("query"), Aria("labelledby", "legend"), + MinLength("2"), Name("query"), Type("search"), Value(r.Query), @@ -45,31 +46,33 @@ func SearchPage(tdata TemplateData, r ResultData, children ...g.Node) g.Node { g.Text("Indexing in progress, started "), Time( DateTime(Indexing.StartedAt.Format(time.RFC3339)), - Title(Indexing.StartedAt.Format(time.RFC3339)), + Title(Indexing.StartedAt.Format(time.DateTime)), g.Text(time.Since(Indexing.StartedAt).Round(time.Second).String()), ), g.Text(" ago. "), g.If(!Indexing.FinishedAt.IsZero(), - g.Text("Last run took "), - Time( - DateTime(Indexing.FinishedAt.Format(time.RFC3339)), - Title(Indexing.FinishedAt.Format(time.RFC3339)), - g.Text(time.Since(Indexing.FinishedAt).Round(time.Minute).String()), - ), + g.Group([]g.Node{ + g.Text("Last run took "), + Time( + DateTime(Indexing.FinishedAt.Format(time.RFC3339)), + Title(Indexing.FinishedAt.Format(time.DateTime)), + g.Text(time.Since(Indexing.FinishedAt).Round(time.Minute).String()), + ), + }), ), ), P( g.Text("Indexing last ran "), Time( DateTime(Indexing.FinishedAt.Format(time.RFC3339)), - Title(Indexing.FinishedAt.Format(time.RFC3339)), - g.Text(time.Since(Indexing.FinishedAt).Round(time.Minute).String()), + Title(Indexing.FinishedAt.Format(time.DateTime)), + g.Textf("%.0f hours ago", time.Since(Indexing.FinishedAt).Hours()), ), - g.Text(" ago, will run again in "), + g.Text(", will run again in "), Time( DateTime(Indexing.NextRun.Format(time.RFC3339)), - Title(Indexing.NextRun.Format(time.RFC3339)), - g.Text(time.Until(Indexing.NextRun).Round(time.Minute).String()), + Title(Indexing.NextRun.Format(time.DateTime)), + g.Textf("%.0f hours", time.Until(Indexing.NextRun).Hours()), ), g.Text("."), ), diff --git a/internal/index/indexer.go b/internal/index/indexer.go index 8cbc8e2..c4032e8 100644 --- a/internal/index/indexer.go +++ b/internal/index/indexer.go @@ -8,6 +8,7 @@ import ( "math" "os" "path" + "path/filepath" "slices" "go.alanpearce.eu/searchix/internal/file" @@ -93,13 +94,6 @@ func createIndexMapping() (mapping.IndexMapping, errors.E) { if err != nil { return nil, errors.WithMessage(err, "could not add custom analyser") } - err = indexMapping.AddCustomAnalyzer("keyword_single", map[string]any{ - "type": keyword.Name, - "tokenizer": letter.Name, - }) - if err != nil { - return nil, errors.WithMessage(err, "could not add custom analyser") - } identityFieldMapping := bleve.NewKeywordFieldMapping() @@ -222,6 +216,13 @@ func OpenOrCreate( ) (*ReadIndex, *WriteIndex, bool, errors.E) { var err errors.E bleve.SetLog(zap.NewStdLog(options.Logger.Named("bleve").GetLogger())) + if !filepath.IsAbs(dataRoot) { + wd, err := os.Getwd() + if err != nil { + return nil, nil, false, errors.WithMessagef(err, "could not get working directory") + } + dataRoot = filepath.Join(wd, dataRoot) + } indexPath := path.Join(dataRoot, indexBaseName) metaPath := path.Join(dataRoot, metaBaseName) diff --git a/internal/index/search.go b/internal/index/search.go index 292661e..a8124c7 100644 --- a/internal/index/search.go +++ b/internal/index/search.go @@ -128,8 +128,8 @@ func (index *ReadIndex) Search( // match the user's query in any field ... query.AddMust(bleve.NewDisjunctionQuery( - bleve.NewTermQuery(keyword), - bleve.NewPrefixQuery(keyword), + setBoost(bleve.NewTermQuery(keyword), 50), + setBoost(bleve.NewPrefixQuery(keyword), 25), bleve.NewMatchPhraseQuery(keyword), bleve.NewMatchQuery(keyword), )) @@ -140,13 +140,23 @@ func (index *ReadIndex) Search( ) } else { q := bleve.NewDisjunctionQuery( - setBoost(setField(bleve.NewTermQuery("nixpkgs"), "Source"), -150), - setBoost(setField(bleve.NewTermQuery("nur"), "Source"), -200), + setBoost(setField(bleve.NewTermQuery("nixpkgs"), "Source"), -1000), + setBoost(setField(bleve.NewTermQuery("nur"), "Source"), -5000), ) query.AddShould(q) } + mainProgramQuery := bleve.NewMatchQuery(keyword) + mainProgramQuery.SetField("MainProgram") + mainProgramQuery.SetBoost(50) + query.AddShould(mainProgramQuery) + + mainProgramLiteralQuery := bleve.NewTermQuery(keyword) + mainProgramLiteralQuery.SetField("MainProgram") + mainProgramLiteralQuery.SetBoost(100) + query.AddShould(mainProgramLiteralQuery) + programsQuery := bleve.NewMatchQuery(keyword) programsQuery.SetField("Programs") programsQuery.SetBoost(2) @@ -215,3 +225,12 @@ func (index *ReadIndex) GetDocument( return nil, err } + +func (index *ReadIndex) Close() error { + err := index.index.Close() + if err != nil { + return errors.WithStack(err) + } + + return nil +} diff --git a/internal/index/search_test.go b/internal/index/search_test.go new file mode 100644 index 0000000..339a0de --- /dev/null +++ b/internal/index/search_test.go @@ -0,0 +1,150 @@ +package index_test + +import ( + "context" + "maps" + "math" + "slices" + "testing" + "time" + + "go.alanpearce.eu/searchix/internal/config" + "go.alanpearce.eu/searchix/internal/index" + "go.alanpearce.eu/searchix/internal/nix" + "go.alanpearce.eu/x/log" +) + +const dataRoot = "../../data" + +func TestSearchGitPackagesFirst(t *testing.T) { + log := log.Configure(false) + cfg := config.DefaultConfig + + read, _, exists, err := index.OpenOrCreate(dataRoot, false, &index.Options{ + Logger: log.Named("index"), + LowMemory: false, + }) + defer read.Close() + if err != nil { + t.Fatal(err) + } + if !exists { + t.Fatal("expected index to exist") + } + + ctx, cancel := context.WithTimeout(context.Background(), 1*time.Second) + defer cancel() + + source := cfg.Importer.Sources["nixpkgs"] + if source == nil || !source.Enable { + t.Fatal("expected source to exist and be enabled") + } + + result, err := read.Search( + ctx, + source, + "git", + 0, + 100, + ) + if err != nil { + t.Fatal(err) + } + + if result.Total < 4 { + t.Errorf("Expected at least 4 results, got %d", result.Total) + } + important := map[string]int{ + "git": 0, + "git-doc": 0, + "gitFull": 0, + "gitMinimal": 0, + "gitSVN": 0, + } + var i int + for hit := range result.Hits { + data := hit.Data.(nix.Package) + if _, found := important[data.Attribute]; found { + important[data.Attribute] = i + } + i++ + } + if slices.Max(slices.Collect(maps.Values(important))) > len(important) { + t.Errorf( + "Expected all of %s to be the first %d matches, got %v", + slices.Collect(maps.Keys(important)), + len(important), + important, + ) + } +} + +func TestSearchJujutsuPackagesFirst(t *testing.T) { + log := log.Configure(false) + cfg := config.DefaultConfig + + read, _, exists, err := index.OpenOrCreate(dataRoot, false, &index.Options{ + Logger: log.Named("index"), + LowMemory: false, + }) + defer read.Close() + if err != nil { + t.Fatal(err) + } + if !exists { + t.Fatal("expected index to exist") + } + + ctx, cancel := context.WithTimeout(context.Background(), 1*time.Second) + defer cancel() + + source := cfg.Importer.Sources["nixpkgs"] + if source == nil || !source.Enable { + t.Fatal("expected source to exist and be enabled") + } + + result, err := read.Search( + ctx, + source, + "jj", + 0, + 100, + ) + if err != nil { + t.Fatal(err) + } + + if result.Total < 4 { + t.Errorf("Expected at least 4 results, got %d", result.Total) + } + important := map[string]int{ + "jj": 0, + "jujutsu": 0, + "lazyjj": 0, + "jjui": 0, + "jj-fzf": 0, + } + matches := []string{} + unwanted := "javacc" + unwantedIndex := math.MaxInt + var i int + for hit := range result.Hits { + data := hit.Data.(nix.Package) + if _, found := important[data.Attribute]; found { + matches = append(matches, data.Attribute) + } else if data.Attribute == unwanted { + unwantedIndex = i + matches = append(matches, data.Attribute) + } + i++ + } + if slices.Max(slices.Collect(maps.Values(important))) > unwantedIndex { + t.Errorf( + "Expected all of %s to be above unwanted result %s at index %d. Results: %v", + slices.Collect(maps.Keys(important)), + unwanted, + unwantedIndex, + matches, + ) + } +} diff --git a/internal/server/mux.go b/internal/server/mux.go index f7a82d8..968b37c 100644 --- a/internal/server/mux.go +++ b/internal/server/mux.go @@ -93,12 +93,15 @@ func NewMux( } } - ctx, cancel := context.WithTimeout(r.Context(), searchTimeout) - defer cancel() - if r.URL.Query().Has("query") { qs := r.URL.Query().Get("query") + if len(qs) < 2 { + errorHandler(w, r, "Query too short", http.StatusBadRequest) + + return + } + var pageSize int = search.DefaultPageSize var pageNumber = 1 if pg := r.URL.Query().Get("page"); pg != "" { @@ -110,11 +113,15 @@ func NewMux( } if pageNumber == 0 { pageNumber = 1 - pageSize = math.MaxInt + pageSize = config.MaxResultsShowAll } } page := pagination.New(pageNumber, pageSize) + + ctx, cancel := context.WithTimeout(r.Context(), searchTimeout) results, err := index.Search(ctx, source, qs, page.From, page.Size) + cancel() + if err != nil { if err == context.DeadlineExceeded { errorHandler(w, r, "Search timed out", http.StatusInternalServerError) @@ -126,7 +133,8 @@ func NewMux( return } - if pageSize == math.MaxInt && results.Total > config.MaxResultsShowAll { + if pageSize == config.MaxResultsShowAll && + results.Total > config.MaxResultsShowAll { errorHandler(w, r, "Too many results, use pagination", http.StatusBadRequest) } @@ -219,9 +227,9 @@ func NewMux( importerSingular := importerType.Singular() ctx, cancel := context.WithTimeout(r.Context(), searchTimeout) - defer cancel() - doc, err := index.GetDocument(ctx, source, r.PathValue("id")) + cancel() + if err != nil { errorHandler( w, |