Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

x/pkgsite: searching exact standard library package names #64358

Open
Deleplace opened this issue Nov 23, 2023 · 4 comments
Open

x/pkgsite: searching exact standard library package names #64358

Deleplace opened this issue Nov 23, 2023 · 4 comments
Assignees
@jba
Labels
pkgsite/search Issues related to pkg.go.dev search functionality pkgsite
Milestone
pkgsite/backlog

Comments

@Deleplace
Copy link
Contributor

Deleplace commented Nov 23, 2023 •
edited

What is the URL of the page with the issue?

https://pkg.go.dev/search?q=path&m=

What is your user agent?

Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36

What did you do?

Searched the exact full name of a package of the standard library : "path"

What did you expect to see?

https://pkg.go.dev/path should be the first result

What did you see instead?

there are many results, but https://pkg.go.dev/path is not in the list at all

General problem

This is similar to #41369 but more specific: when exact search terms fail to show the relevant standard library package as 1st result.

The following rule should always hold:

IF a package exists in the standard library with name FOO, AND a user is searching the exact term "FOO" in pkg.go.dev, THEN the standard library package FOO must be the 1st result in the list

I tried 284 such searches, here are my findings.

  • When the full package name contains a "/" e.g. "compress/bzip", and the user is searching for the exact full name "compress/bzip", then no result list is displayed. Instead, the page is redirected to the correct stdlib package. This works 100% of the time
  • When the full package name is a single word e.g. "time", and the user is searching for the exact word, then a result list is displayed. The correct stdlib package is most often the 1st result, with 5 annoying exceptions
  • When the full package name contains a "/" e.g. "compress/bzip", and the user is searching for the exact last word e.g. "bzip", then a result list is displayed. The correct stdlib package is often the 1st result, with 16 annoying exceptions

The results of these 5 single-word searches are buggy:

Package Search link Result
path search path NOT FOUND
cmp search cmp 2nd pos
maps search maps 8th pos
plugin search plugin 2nd pos
slices search slices 4th pos

The results of these 16 single-word searches are buggy too, according to the rule:

Package Search link Result
runtime/coverage search coverage NOT FOUND
go/build/constraint search constraint 3rd pos
go/constant search constant 3rd pos
go/doc/comment search comment 6th pos
go/format search format 2nd pos
go/importer search importer 2nd pos
go/types search types 4th pos
image/color search color 2nd pos
net/rpc search rpc 3rd pos
regexp/syntax search syntax 4th pos
runtime/cgo search cgo 2nd pos
runtime/metrics search metrics 21st pos
runtime/race search race 5th pos
runtime/trace search trace 5th pos
testing/slogtest search slogtest 2nd pos
text/template/parse search parse 11th pos
@gopherbot gopherbot added this to the Unreleased milestone Nov 23, 2023
@Deleplace
Copy link
Contributor Author

I could clone go.googlesource.com/pkgsite, analyze the code, run the server locally and observe how the stdlib is not always prioritized.

However, I don't have the same datasources as production (postgres?) so a quick fix like "boost the Score of all stdlib results" might not be the best move.

@Deleplace
Copy link
Contributor Author

cc @matloob @jamalc @tatianab

@Deleplace Deleplace mentioned this issue Nov 23, 2023
Open
@komuw
Copy link
Contributor

komuw commented Nov 23, 2023 •
edited

Related;

  1. x/pkgsite: builtin should be ranked higher in search #40622
  2. x/pkgsite: standard library packages should be prioritized in search results #41369

@bcmills bcmills added the pkgsite/search Issues related to pkg.go.dev search functionality label Nov 27, 2023
@hyangah
Copy link
Contributor

hyangah commented Dec 7, 2023

According to https://pkg.go.dev/search-help

"If the package path you specified is complete enough, matching a full package import path, you will be brought directly to the details page for the latest version of that package."

Directing to the stdlib package automatically may be too risky, but at least, I think we need to make it correctly considered as exact match and rank it the highest.

cc @jba Do you want to track this separate from #41369?

@hyangah hyangah modified the milestones: Unreleased, pkgsite/backlog Dec 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jba jba

Labels
pkgsite/search Issues related to pkg.go.dev search functionality pkgsite
Projects
None yet
Milestone
pkgsite/backlog
Development

No branches or pull requests
6 participants
@hyangah @komuw @bcmills @gopherbot @Deleplace @jba