The highest tagged major version is $$GODISCOVERY_LATESTMAJORVERSION$$.
diff --git a/internal/datasource.go b/internal/datasource.go
index 6f886c177..bd16f0a3c 100644
--- a/internal/datasource.go
+++ b/internal/datasource.go
@@ -11,8 +11,14 @@ type DataSource interface {
// See the internal/postgres package for further documentation of these
// methods, particularly as they pertain to the main postgres implementation.
- // GetLatestMajorVersion returns the latest major version of a series path.
- GetLatestMajorVersion(ctx context.Context, seriesPath string) (_ string, err error)
+ // GetLatestMajorVersion returns the latest module path and the full package path
+ // of the latest version found, given the fullPath and the modulePath.
+ // For example, in the module path "github.com/casbin/casbin", there
+ // is another module path with a greater major version "github.com/casbin/casbin/v3".
+ // This function will return "github.com/casbin/casbin/v3" or the input module path
+ // if no later module path was found. It also returns the full package path at the
+ // latest module version if it exists. If not, it returns the module path.
+ GetLatestMajorVersion(ctx context.Context, fullPath, modulePath string) (_ string, _ string, err error)
// GetNestedModules returns the latest major version of all nested modules
// given a modulePath path prefix.
GetNestedModules(ctx context.Context, modulePath string) ([]*ModuleInfo, error)
diff --git a/internal/frontend/latest_version.go b/internal/frontend/latest_version.go
index 24aa684cd..e0d24256a 100644
--- a/internal/frontend/latest_version.go
+++ b/internal/frontend/latest_version.go
@@ -13,19 +13,18 @@ import (
"golang.org/x/pkgsite/internal/log"
)
-// GetLatestMajorVersion returns the major version of a package or module.
-// If a module isn't found from the series path or an error ocurs, an empty string is returned
+// GetLatestMajorVersion returns the latest module path and the full package path
+// of any major version found given the fullPath and the modulePath.
// It is intended to be used as an argument to middleware.LatestVersions.
-func (s *Server) GetLatestMajorVersion(ctx context.Context, seriesPath string) string {
- mv, err := s.getDataSource(ctx).GetLatestMajorVersion(ctx, seriesPath)
+func (s *Server) GetLatestMajorVersion(ctx context.Context, fullPath, modulePath string) (_ string, _ string) {
+ latestModulePath, latestPackagePath, err := s.getDataSource(ctx).GetLatestMajorVersion(ctx, fullPath, modulePath)
if err != nil {
if !errors.Is(err, derrors.NotFound) {
log.Errorf(ctx, "GetLatestMajorVersion: %v", err)
}
- return ""
+ return "", ""
}
-
- return mv
+ return latestModulePath, latestPackagePath
}
// GetLatestMinorVersion returns the latest minor version of the package or module.
diff --git a/internal/frontend/server_test.go b/internal/frontend/server_test.go
index 707d1e90d..7b8bb061e 100644
--- a/internal/frontend/server_test.go
+++ b/internal/frontend/server_test.go
@@ -114,6 +114,52 @@ var testModules = []testModule{
},
},
},
+ {
+ // A module with a greater major version available.
+ path: "github.com/v2major/module_name",
+ redistributable: true,
+ versions: []string{"v1.0.0"},
+ packages: []testPackage{
+ {
+ suffix: "bar",
+ doc: sample.DocumentationHTML.String(),
+ readmeContents: sample.ReadmeContents,
+ readmeFilePath: sample.ReadmeFilePath,
+ },
+ {
+ suffix: "bar/directory/hello",
+ doc: `io.Writer`,
+ },
+ {
+ suffix: "buz",
+ doc: sample.DocumentationHTML.String(),
+ readmeContents: sample.ReadmeContents,
+ readmeFilePath: sample.ReadmeFilePath,
+ },
+ {
+ suffix: "buz/directory/hello",
+ doc: `io.Writer`,
+ },
+ },
+ },
+ {
+ // A v2 of the previous module, with one version.
+ path: "github.com/v2major/module_name/v2",
+ redistributable: true,
+ versions: []string{"v2.0.0"},
+ packages: []testPackage{
+ {
+ suffix: "bar",
+ doc: sample.DocumentationHTML.String(),
+ readmeContents: sample.ReadmeContents,
+ readmeFilePath: sample.ReadmeFilePath,
+ },
+ {
+ suffix: "bar/directory/hello",
+ doc: `io.Writer`,
+ },
+ },
+ },
{
// A non-redistributable module.
path: "github.com/non_redistributable",
@@ -271,18 +317,59 @@ func serverTestCases() []serverTestCase {
)
pkgV100 := &pagecheck.Page{
- Title: "foo",
- ModulePath: sample.ModulePath,
- Version: sample.VersionString,
- FormattedVersion: sample.VersionString,
- Suffix: sample.Suffix,
- IsLatest: true,
- LatestLink: "/" + sample.ModulePath + "@" + sample.VersionString + "/" + sample.Suffix,
- LicenseType: sample.LicenseType,
- LicenseFilePath: sample.LicenseFilePath,
- PackageURLFormat: "/" + sample.ModulePath + "%s/" + sample.Suffix,
- ModuleURL: "/" + sample.ModulePath,
+ Title: "foo",
+ ModulePath: sample.ModulePath,
+ Version: sample.VersionString,
+ FormattedVersion: sample.VersionString,
+ Suffix: sample.Suffix,
+ IsLatest: true,
+ LatestLink: "/" + sample.ModulePath + "@" + sample.VersionString + "/" + sample.Suffix,
+ LatestMajorVersionLink: "/" + sample.ModulePath + "/" + sample.Suffix,
+ LicenseType: sample.LicenseType,
+ LicenseFilePath: sample.LicenseFilePath,
+ PackageURLFormat: "/" + sample.ModulePath + "%s/" + sample.Suffix,
+ ModuleURL: "/" + sample.ModulePath,
+ }
+
+ v2pkgV100 := &pagecheck.Page{
+ Title: "bar",
+ ModulePath: "github.com/v2major/module_name",
+ Version: "v1.0.0",
+ FormattedVersion: "v1.0.0",
+ Suffix: "bar",
+ IsLatest: false,
+ LatestLink: "/github.com/v2major/module_name@v1.0.0/bar",
+ LatestMajorVersion: "v2",
+ LatestMajorVersionLink: "/github.com/v2major/module_name/v2/bar",
+ LicenseType: sample.LicenseType,
+ LicenseFilePath: sample.LicenseFilePath,
+ PackageURLFormat: "/github.com/v2major/module_name%s/bar",
+ ModuleURL: "/github.com/v2major/module_name",
}
+
+ v2pkgV1Buz := *v2pkgV100
+ v2pkgV1Buz.Title = "buz"
+ v2pkgV1Buz.Suffix = "buz"
+ v2pkgV1Buz.LatestLink = "/github.com/v2major/module_name@v1.0.0/buz"
+ v2pkgV1Buz.LatestMajorVersionLink = "/github.com/v2major/module_name/v2"
+ v2pkgV1Buz.PackageURLFormat = "/github.com/v2major/module_name%s/buz"
+
+ v2pkgV200 := &pagecheck.Page{
+ Title: "bar",
+ ModulePath: "github.com/v2major/module_name/v2",
+ Version: "v2.0.0",
+ FormattedVersion: "v2.0.0",
+ Suffix: "bar",
+ IsLatest: true,
+ LatestLink: "/github.com/v2major/module_name/v2@v2.0.0/bar",
+ LatestMajorVersion: "v2",
+ LatestMajorVersionLink: "/github.com/v2major/module_name/v2/bar",
+ LicenseType: sample.LicenseType,
+ LicenseFilePath: sample.LicenseFilePath,
+ PackageURLFormat: "/github.com/v2major/module_name/v2%s/bar",
+ ModuleURL: "/github.com/v2major/module_name/v2",
+ }
+
p9 := *pkgV100
p9.Version = "v0.9.0"
p9.FormattedVersion = "v0.9.0"
@@ -296,54 +383,58 @@ func serverTestCases() []serverTestCase {
pkgPseudo := &pp
pkgInc := &pagecheck.Page{
- Title: "inc",
- ModulePath: "github.com/incompatible",
- Version: "v1.0.0+incompatible",
- FormattedVersion: "v1.0.0+incompatible",
- Suffix: "dir/inc",
- IsLatest: true,
- LatestLink: "/github.com/incompatible@v1.0.0+incompatible/dir/inc",
- LicenseType: "MIT",
- LicenseFilePath: "LICENSE",
- PackageURLFormat: "/github.com/incompatible%s/dir/inc",
- ModuleURL: "/github.com/incompatible",
+ Title: "inc",
+ ModulePath: "github.com/incompatible",
+ Version: "v1.0.0+incompatible",
+ FormattedVersion: "v1.0.0+incompatible",
+ Suffix: "dir/inc",
+ IsLatest: true,
+ LatestLink: "/github.com/incompatible@v1.0.0+incompatible/dir/inc",
+ LatestMajorVersionLink: "/github.com/incompatible/dir/inc",
+ LicenseType: "MIT",
+ LicenseFilePath: "LICENSE",
+ PackageURLFormat: "/github.com/incompatible%s/dir/inc",
+ ModuleURL: "/github.com/incompatible",
}
pkgNonRedist := &pagecheck.Page{
- Title: "bar",
- ModulePath: "github.com/non_redistributable",
- Version: "v1.0.0",
- FormattedVersion: "v1.0.0",
- Suffix: "bar",
- IsLatest: true,
- LatestLink: "/github.com/non_redistributable@v1.0.0/bar",
- LicenseType: "",
- PackageURLFormat: "/github.com/non_redistributable%s/bar",
- ModuleURL: "/github.com/non_redistributable",
+ Title: "bar",
+ ModulePath: "github.com/non_redistributable",
+ Version: "v1.0.0",
+ FormattedVersion: "v1.0.0",
+ Suffix: "bar",
+ IsLatest: true,
+ LatestLink: "/github.com/non_redistributable@v1.0.0/bar",
+ LatestMajorVersionLink: "/github.com/non_redistributable/bar",
+ LicenseType: "",
+ PackageURLFormat: "/github.com/non_redistributable%s/bar",
+ ModuleURL: "/github.com/non_redistributable",
}
dir := &pagecheck.Page{
- Title: "directory/",
- ModulePath: sample.ModulePath,
- Version: "v1.0.0",
- FormattedVersion: "v1.0.0",
- Suffix: "foo/directory",
- LicenseType: "MIT",
- LicenseFilePath: "LICENSE",
- ModuleURL: "/" + sample.ModulePath,
- PackageURLFormat: "/" + sample.ModulePath + "%s/foo/directory",
+ Title: "directory/",
+ ModulePath: sample.ModulePath,
+ Version: "v1.0.0",
+ FormattedVersion: "v1.0.0",
+ Suffix: "foo/directory",
+ LicenseType: "MIT",
+ LicenseFilePath: "LICENSE",
+ ModuleURL: "/" + sample.ModulePath,
+ PackageURLFormat: "/" + sample.ModulePath + "%s/foo/directory",
+ LatestMajorVersionLink: "/github.com/valid/module_name/foo/directory",
}
mod := &pagecheck.Page{
- ModulePath: sample.ModulePath,
- Title: "module_name",
- ModuleURL: "/" + sample.ModulePath,
- Version: "v1.0.0",
- FormattedVersion: "v1.0.0",
- LicenseType: "MIT",
- LicenseFilePath: "LICENSE",
- IsLatest: true,
- LatestLink: "/" + sample.ModulePath + "@v1.0.0",
+ ModulePath: sample.ModulePath,
+ Title: "module_name",
+ ModuleURL: "/" + sample.ModulePath,
+ Version: "v1.0.0",
+ FormattedVersion: "v1.0.0",
+ LicenseType: "MIT",
+ LicenseFilePath: "LICENSE",
+ IsLatest: true,
+ LatestLink: "/" + sample.ModulePath + "@v1.0.0",
+ LatestMajorVersionLink: "/" + sample.ModulePath,
}
mp := *mod
mp.Version = pseudoVersion
@@ -351,42 +442,45 @@ func serverTestCases() []serverTestCase {
mp.IsLatest = false
dirPseudo := &pagecheck.Page{
- ModulePath: "github.com/pseudo",
- Title: "dir/",
- ModuleURL: "/github.com/pseudo",
- LatestLink: "/github.com/pseudo@" + pseudoVersion + "/dir",
- Suffix: "dir",
- Version: pseudoVersion,
- FormattedVersion: mp.FormattedVersion,
- LicenseType: "MIT",
- LicenseFilePath: "LICENSE",
- IsLatest: true,
- PackageURLFormat: "/github.com/pseudo%s/dir",
+ ModulePath: "github.com/pseudo",
+ Title: "dir/",
+ ModuleURL: "/github.com/pseudo",
+ LatestLink: "/github.com/pseudo@" + pseudoVersion + "/dir",
+ LatestMajorVersionLink: "/github.com/pseudo/dir",
+ Suffix: "dir",
+ Version: pseudoVersion,
+ FormattedVersion: mp.FormattedVersion,
+ LicenseType: "MIT",
+ LicenseFilePath: "LICENSE",
+ IsLatest: true,
+ PackageURLFormat: "/github.com/pseudo%s/dir",
}
dirCmd := &pagecheck.Page{
- Title: "cmd",
- ModulePath: "std",
- Version: "go1.13",
- FormattedVersion: "go1.13",
- Suffix: "cmd",
- LicenseType: "MIT",
- LicenseFilePath: "LICENSE",
- ModuleURL: "/std",
- PackageURLFormat: "/cmd%s",
+ Title: "cmd",
+ ModulePath: "std",
+ Version: "go1.13",
+ FormattedVersion: "go1.13",
+ Suffix: "cmd",
+ LicenseType: "MIT",
+ LicenseFilePath: "LICENSE",
+ ModuleURL: "/std",
+ PackageURLFormat: "/cmd%s",
+ LatestMajorVersionLink: "/cmd",
}
netHttp := &pagecheck.Page{
- Title: "http",
- ModulePath: "http",
- Version: "go1.13",
- FormattedVersion: "go1.13",
- LicenseType: sample.LicenseType,
- LicenseFilePath: sample.LicenseFilePath,
- ModuleURL: "/net/http",
- PackageURLFormat: "/net/http%s",
- IsLatest: true,
- LatestLink: "/net/http@go1.13",
+ Title: "http",
+ ModulePath: "http",
+ Version: "go1.13",
+ FormattedVersion: "go1.13",
+ LicenseType: sample.LicenseType,
+ LicenseFilePath: sample.LicenseFilePath,
+ ModuleURL: "/net/http",
+ PackageURLFormat: "/net/http%s",
+ IsLatest: true,
+ LatestLink: "/net/http@go1.13",
+ LatestMajorVersionLink: "/net/http",
}
return []serverTestCase{
@@ -519,6 +613,39 @@ func serverTestCases() []serverTestCase {
in(".UnitDetails-content", hasText(`not displayed due to license restrictions`)),
),
},
+ {
+ name: "v2 package at v1",
+ urlPath: fmt.Sprintf("/%s@%s/%s", v2pkgV100.ModulePath, v2pkgV100.Version, v2pkgV100.Suffix),
+ wantStatusCode: http.StatusOK,
+ want: in("",
+ pagecheck.UnitHeader(v2pkgV100, versioned, isPackage),
+ pagecheck.UnitReadme(),
+ pagecheck.UnitDoc(),
+ pagecheck.UnitDirectories(fmt.Sprintf("/%s@%s/%s/directory/hello", v2pkgV100.ModulePath, v2pkgV100.Version, v2pkgV100.Suffix), "directory/hello"),
+ pagecheck.CanonicalURLPath("/github.com/v2major/module_name@v1.0.0/bar")),
+ },
+ {
+ name: "v2 module with v1 package that does not exist in v2",
+ urlPath: fmt.Sprintf("/%s@%s/%s", v2pkgV1Buz.ModulePath, v2pkgV1Buz.Version, v2pkgV1Buz.Suffix),
+ wantStatusCode: http.StatusOK,
+ want: in("",
+ pagecheck.UnitHeader(&v2pkgV1Buz, versioned, isPackage),
+ pagecheck.UnitReadme(),
+ pagecheck.UnitDoc(),
+ pagecheck.UnitDirectories(fmt.Sprintf("/%s@%s/%s/directory/hello", v2pkgV1Buz.ModulePath, v2pkgV1Buz.Version, v2pkgV1Buz.Suffix), "directory/hello"),
+ pagecheck.CanonicalURLPath("/github.com/v2major/module_name@v1.0.0/buz")),
+ },
+ {
+ name: "v2 package at v2",
+ urlPath: fmt.Sprintf("/%s@%s/%s", v2pkgV200.ModulePath, v2pkgV200.Version, v2pkgV200.Suffix),
+ wantStatusCode: http.StatusOK,
+ want: in("",
+ pagecheck.UnitHeader(v2pkgV200, versioned, isPackage),
+ pagecheck.UnitReadme(),
+ pagecheck.UnitDoc(),
+ pagecheck.UnitDirectories(fmt.Sprintf("/%s@%s/%s/directory/hello", v2pkgV200.ModulePath, v2pkgV200.Version, v2pkgV200.Suffix), "directory/hello"),
+ pagecheck.CanonicalURLPath("/github.com/v2major/module_name/v2@v2.0.0/bar")),
+ },
{
name: "package at version default",
urlPath: fmt.Sprintf("/%s@%s/%s", sample.ModulePath, sample.VersionString, sample.Suffix),
diff --git a/internal/localdatasource/datasource.go b/internal/localdatasource/datasource.go
index 94ee63e9f..20a8ffdc6 100644
--- a/internal/localdatasource/datasource.go
+++ b/internal/localdatasource/datasource.go
@@ -170,11 +170,12 @@ func (ds *DataSource) findModule(pkgPath string) (_ string, err error) {
return "", fmt.Errorf("%s not loaded: %w", pkgPath, derrors.NotFound)
}
-// GetLatestMajorVersion returns the latest major version of a series path.
+// GetLatestMajorVersion returns the latest major version and the full package path
+// of any major version found given the seriesPath and the v1Path.
// When fetching local modules, version is not accounted for, so an empty
// string is returned.
-func (ds *DataSource) GetLatestMajorVersion(ctx context.Context, seriesPath string) (string, error) {
- return "", nil
+func (ds *DataSource) GetLatestMajorVersion(ctx context.Context, seriesPath string, v1Path string) (string, string, error) {
+ return "", "", nil
}
// GetNestedModules is not implemented.
diff --git a/internal/middleware/latestversion.go b/internal/middleware/latestversion.go
index 24f7f5b86..c4926842b 100644
--- a/internal/middleware/latestversion.go
+++ b/internal/middleware/latestversion.go
@@ -12,7 +12,6 @@ import (
"strings"
"golang.org/x/mod/module"
- "golang.org/x/pkgsite/internal"
"golang.org/x/pkgsite/internal/log"
)
@@ -28,7 +27,7 @@ const (
var latestInfoRegexp = regexp.MustCompile(`data-version="([^"]*)" data-mpath="([^"]*)" data-ppath="([^"]*)" data-pagetype="([^"]*)"`)
type latestMinorFunc func(ctx context.Context, packagePath, modulePath, pageType string) string
-type latestMajorFunc func(ctx context.Context, seriesPath string) string
+type latestMajorFunc func(ctx context.Context, fullPath, modulePath string) (string, string)
// LatestVersions replaces the HTML placeholder values for the badge and banner
// that displays whether the version of the package or module being served is
@@ -45,7 +44,6 @@ func LatestVersions(latestMinor latestMinorFunc, latestMajor latestMajorFunc) Mi
// The template package converts '+' to its HTML entity.
version = strings.Replace(version, "+", "+", -1)
modulePath := string(matches[2])
- seriesPath := internal.SeriesPathForModule(modulePath)
_, majorVersion, _ := module.SplitPathVersion(modulePath)
packagePath := string(matches[3])
pageType := string(matches[4])
@@ -59,10 +57,11 @@ func LatestVersions(latestMinor latestMinorFunc, latestMajor latestMajorFunc) Mi
default:
latestMinorClass += "--goToLatest"
}
- latestMajorVersion := latestMajor(r.Context(), seriesPath)
- latestMajorVersionText := latestMajorVersion
- if len(latestMajorVersionText) > 0 {
- latestMajorVersionText = latestMajorVersionText[1:]
+ latestModulePath, latestPackagePath := latestMajor(r.Context(), packagePath, modulePath)
+ _, latestMajorVersion, ok := module.SplitPathVersion(latestModulePath)
+ var latestMajorVersionText string
+ if ok && len(latestMajorVersion) > 0 {
+ latestMajorVersionText = latestMajorVersion[1:]
}
latestMajorClass := ""
// If the latest major version is the same as the major version of the current
@@ -76,7 +75,7 @@ func LatestVersions(latestMinor latestMinorFunc, latestMajor latestMajorFunc) Mi
body = bytes.ReplaceAll(body, []byte(LatestMinorVersionPlaceholder), []byte(latestMinorVersion))
body = bytes.ReplaceAll(body, []byte(latestMajorClassPlaceholder), []byte(latestMajorClass))
body = bytes.ReplaceAll(body, []byte(LatestMajorVersionPlaceholder), []byte(latestMajorVersionText))
- body = bytes.ReplaceAll(body, []byte(LatestMajorVersionURL), []byte(seriesPath+latestMajorVersion))
+ body = bytes.ReplaceAll(body, []byte(LatestMajorVersionURL), []byte(latestPackagePath))
}
if _, err := w.Write(body); err != nil {
log.Errorf(r.Context(), "LatestVersions, writing: %v", err)
diff --git a/internal/middleware/latestversion_test.go b/internal/middleware/latestversion_test.go
index e83f7f2af..0d326ff27 100644
--- a/internal/middleware/latestversion_test.go
+++ b/internal/middleware/latestversion_test.go
@@ -135,7 +135,7 @@ func TestLatestMinorVersion(t *testing.T) {
handler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
fmt.Fprint(w, test.in)
})
- latestMajor := func(context.Context, string) string { return "" }
+ latestMajor := func(context.Context, string, string) (string, string) { return "", "" }
ts := httptest.NewServer(LatestVersions(test.latest, latestMajor)(handler))
defer ts.Close()
resp, err := ts.Client().Get(ts.URL)
@@ -163,8 +163,10 @@ func TestLatestMajorVersion(t *testing.T) {
want string
}{
{
- name: "module path is not at latest",
- latest: func(context.Context, string) string { return "/v3" },
+ name: "module path is not at latest",
+ latest: func(context.Context, string, string) (string, string) {
+ return "foo.com/bar/v3", "foo.com/bar/v3"
+ },
modulePaths: []string{
"foo.com/bar",
"foo.com/bar/v2",
@@ -187,7 +189,7 @@ func TestLatestMajorVersion(t *testing.T) {
},
{
name: "module path is at latest",
- latest: func(context.Context, string) string { return "/v3" },
+ latest: func(context.Context, string, string) (string, string) { return "foo.com/bar/v3", "foo.com/bar/v3" },
modulePaths: []string{
"foo.com/bar",
"foo.com/bar/v2",
@@ -208,6 +210,29 @@ func TestLatestMajorVersion(t *testing.T) {