internal: add support for path@main

Support requests for path@main in addition to path@master.

For golang/go#41312

Change-Id: Ie7665fbb3906e366c784a9cc592ffe37ef347671
Reviewed-on: https://go-review.googlesource.com/c/pkgsite/+/274244
Trust: Julie Qiu <[email protected]>
Reviewed-by: Jonathan Amsterdam <[email protected]>

Author: julieqiu

internal/discovery.go

@@ -20,16 +20,19 @@ const (
 	// proxy client.
 	LatestVersion = "latest"
 
-	// MasterVersion signifies the version at master.
-	MasterVersion = "master"
-
 	// UnknownModulePath signifies that the module path for a given package
 	// path is ambiguous or not known. This is because requests to the
 	// frontend can come in the form of <import-path>[@<version>], and it is
 	// not clear which part of the import-path is the module path.
 	UnknownModulePath = "unknownModulePath"
 )
 
+// DefaultBranches are default branches that are supported by pkgsite.
+var DefaultBranches = map[string]bool{
+	"main":   true,
+	"master": true,
+}
+
 // ModuleInfo holds metadata associated with a module.
 type ModuleInfo struct {
 	ModulePath        string

internal/frontend/fetch_test.go

@@ -44,7 +44,12 @@ func TestFetch(t *testing.T) {
 		{
 			name:     "path at master package is in module root",
 			fullPath: testModulePath,
-			version:  internal.MasterVersion,
+			version:  "master",
+		},
+		{
+			name:     "path at main package is in module root",
+			fullPath: testModulePath,
+			version:  "main",
 		},
 		{
 			name:     "path at latest package is in module root",
@@ -64,7 +69,12 @@ func TestFetch(t *testing.T) {
 		{
 			name:     "directory at master package is not in module root",
 			fullPath: testModulePath + "/bar",
-			version:  internal.MasterVersion,
+			version:  "master",
+		},
+		{
+			name:     "directory at main package is not in module root",
+			fullPath: testModulePath + "/bar",
+			version:  "main",
 		},
 	} {
 		t.Run(test.name, func(t *testing.T) {

internal/frontend/unit.go

@@ -95,7 +95,7 @@ func (s *Server) serveUnitPage(ctx context.Context, w http.ResponseWriter, r *ht
 	}
 
 	recordVersionTypeMetric(ctx, info.requestedVersion)
-	if info.requestedVersion == internal.MasterVersion {
+	if _, ok := internal.DefaultBranches[info.requestedVersion]; ok {
 		// Since path@master is a moving target, we don't want it to be stale.
 		// As a result, we enqueue every request of path@master to the frontend
 		// task queue, which will initiate a fetch request depending on the
@@ -106,7 +106,7 @@ func (s *Server) serveUnitPage(ctx context.Context, w http.ResponseWriter, r *ht
 		go func() {
 			ctx, cancel := context.WithTimeout(context.Background(), 1*time.Minute)
 			defer cancel()
-			if _, err := s.queue.ScheduleFetch(ctx, info.modulePath, internal.MasterVersion, ""); err != nil {
+			if _, err := s.queue.ScheduleFetch(ctx, info.modulePath, info.requestedVersion, ""); err != nil {
 				log.Errorf(ctx, "serveDetails(%q): %v", r.URL.Path, err)
 			}
 		}()

internal/frontend/urlinfo.go

@@ -170,13 +170,10 @@ func checkExcluded(ctx context.Context, ds internal.DataSource, fullPath string)
 
 // isSupportedVersion reports whether the version is supported by the frontend.
 func isSupportedVersion(fullPath, requestedVersion string) bool {
-	if stdlib.Contains(fullPath) && requestedVersion == internal.MasterVersion {
-		return false
-	}
-	if requestedVersion == internal.LatestVersion || semver.IsValid(requestedVersion) {
-		return true
+	if _, ok := internal.DefaultBranches[requestedVersion]; ok {
+		return !stdlib.Contains(fullPath)
 	}
-	return requestedVersion == internal.MasterVersion
+	return requestedVersion == internal.LatestVersion || semver.IsValid(requestedVersion)
 }
 
 func setExperimentsFromQueryParam(ctx context.Context, r *http.Request) context.Context {

internal/frontend/urlinfo_test.go

@@ -188,10 +188,12 @@ func TestIsSupportedVersion(t *testing.T) {
 		{sample.ModulePath, "v1.2.bad", false},
 		{sample.ModulePath, "latest", true},
 		{sample.ModulePath, "master", true},
+		{sample.ModulePath, "main", true},
 		{"net/http", "v1.2.3", true}, // isSupportedVersion expects the goTag is already converted to semver
 		{"net/http", "v1.2.3.bad", false},
 		{"net/http", "latest", true},
 		{"net/http", "master", false},
+		{"net/http", "main", false},
 	}
 	for _, test := range tests {
 		got := isSupportedVersion(test.path, test.version)

internal/postgres/path_test.go

@@ -43,7 +43,7 @@ func TestGetUnitMeta(t *testing.T) {
 		}
 		requested := m.Version
 		if testModule.isMaster {
-			requested = internal.MasterVersion
+			requested = "master"
 		}
 		if err := testDB.UpsertVersionMap(ctx, &internal.VersionMap{
 			ModulePath:       m.ModulePath,
@@ -224,7 +224,7 @@ func TestGetUnitMetaBypass(t *testing.T) {
 		}
 		requested := m.Version
 		if testModule.isMaster {
-			requested = internal.MasterVersion
+			requested = "master"
 		}
 		if err := bypassDB.UpsertVersionMap(ctx, &internal.VersionMap{
 			ModulePath:       m.ModulePath,

internal/postgres/unit.go

@@ -47,11 +47,9 @@ func (db *DB) GetUnitMeta(ctx context.Context, fullPath, requestedModulePath, re
 	if requestedModulePath != internal.UnknownModulePath {
 		query = query.Where(squirrel.Eq{"m.module_path": requestedModulePath})
 	}
-	switch requestedVersion {
-	case internal.LatestVersion:
-	case internal.MasterVersion:
-		query = query.Join("version_map vm ON m.id = vm.module_id").Where("vm.requested_version = 'master'")
-	default:
+	if _, ok := internal.DefaultBranches[requestedVersion]; ok {
+		query = query.Join("version_map vm ON m.id = vm.module_id").Where("vm.requested_version = ? ", requestedVersion)
+	} else if requestedVersion != internal.LatestVersion {
 		query = query.Where(squirrel.Eq{"version": requestedVersion})
 	}
 	var (

internal/proxy/server.go

@@ -118,8 +118,9 @@ func (s *Server) AddModule(m *Module) {
 		s.handleList(m.ModulePath)
 		s.handleLatest(m.ModulePath, fmt.Sprintf("/%s/@latest", m.ModulePath))
 		// TODO(https://golang.org/issue/39985): Add endpoint for handling
-		// master version.
+		// master and main versions.
 		s.handleLatest(m.ModulePath, fmt.Sprintf("/%s/@v/master.info", m.ModulePath))
+		s.handleLatest(m.ModulePath, fmt.Sprintf("/%s/@v/main.info", m.ModulePath))
 	}
 	s.handleInfo(m.ModulePath, m.Version)
 	s.handleMod(m)