From 359c119441ec75baea05161932d66cc20822bae0 Mon Sep 17 00:00:00 2001 From: Matt Date: Sat, 20 Apr 2024 00:19:34 -0700 Subject: [PATCH] Add an introduction page as the home page (#1945) A default homepage is baked into the server that uses the request host address, or in HTTP 2 the authority. This includes ports. It also checks for schema. The values are used to indicate to users how to configure their go env Of course, this won't work on all installations - especially enterprise ones. For that, we've introduced ATHENS_HOME_TEMPLATE_PATH as an environment variable along with HomeTemplatePath in the config. This value defaults to /var/lib/athens/home.html but can be configured to any location that Athens can reliably read from. This is a Go HTML template so it should use Go HTML template formatting and logic. --- cmd/proxy/actions/app_proxy.go | 2 +- cmd/proxy/actions/app_proxy_test.go | 44 +++++-- cmd/proxy/actions/home.go | 132 +++++++++++++++++++- config.dev.toml | 4 + docs/content/configuration/home-template.md | 101 +++++++++++++++ pkg/config/config.go | 2 + pkg/config/config_test.go | 37 +++--- 7 files changed, 291 insertions(+), 31 deletions(-) create mode 100644 docs/content/configuration/home-template.md diff --git a/cmd/proxy/actions/app_proxy.go b/cmd/proxy/actions/app_proxy.go index 0b9cd00db..777ad4ca6 100644 --- a/cmd/proxy/actions/app_proxy.go +++ b/cmd/proxy/actions/app_proxy.go @@ -32,7 +32,7 @@ func addProxyRoutes( l *log.Logger, c *config.Config, ) error { - r.HandleFunc("/", proxyHomeHandler) + r.HandleFunc("/", proxyHomeHandler(c)) r.HandleFunc("/healthz", healthHandler) r.HandleFunc("/readyz", getReadinessHandler(s)) r.HandleFunc("/version", versionHandler) diff --git a/cmd/proxy/actions/app_proxy_test.go b/cmd/proxy/actions/app_proxy_test.go index 7b2b37415..735aea4dd 100644 --- a/cmd/proxy/actions/app_proxy_test.go +++ b/cmd/proxy/actions/app_proxy_test.go @@ -7,6 +7,7 @@ import ( "net/http/httptest" "strings" "testing" + "text/template" "github.com/gomods/athens/pkg/build" "github.com/gomods/athens/pkg/config" @@ -21,7 +22,7 @@ type routeTest struct { method string path string body string - test func(t *testing.T, resp *http.Response) + test func(t *testing.T, req *http.Request, resp *http.Response) } func TestProxyRoutes(t *testing.T) { @@ -40,22 +41,43 @@ func TestProxyRoutes(t *testing.T) { baseURL := "https://athens.azurefd.net" + c.PathPrefix testCases := []routeTest{ - {"GET", "/", "", func(t *testing.T, resp *http.Response) { + {"GET", "/", "", func(t *testing.T, req *http.Request, resp *http.Response) { assert.Equal(t, http.StatusOK, resp.StatusCode) body, err := io.ReadAll(resp.Body) require.NoError(t, err) - assert.Equal(t, `"Welcome to The Athens Proxy"`, string(body)) + tmp, err := template.New("home").Parse(homepage) + assert.NoError(t, err) + + var templateData = make(map[string]string) + + templateData["Host"] = req.Host + + if !strings.HasPrefix(templateData["Host"], "http://") && !strings.HasPrefix(templateData["Host"], "https://") { + if req.TLS != nil { + templateData["Host"] = "https://" + templateData["Host"] + } else { + templateData["Host"] = "http://" + templateData["Host"] + } + } + + templateData["NoSumPatterns"] = strings.Join(c.NoSumPatterns, ",") + + var expected strings.Builder + err = tmp.ExecuteTemplate(&expected, "home", templateData) + require.NoError(t, err) + + assert.Equal(t, expected.String(), string(body)) }}, - {"GET", "/badz", "", func(t *testing.T, resp *http.Response) { + {"GET", "/badz", "", func(t *testing.T, req *http.Request, resp *http.Response) { assert.Equal(t, http.StatusNotFound, resp.StatusCode) }}, - {"GET", "/healthz", "", func(t *testing.T, resp *http.Response) { + {"GET", "/healthz", "", func(t *testing.T, req *http.Request, resp *http.Response) { assert.Equal(t, http.StatusOK, resp.StatusCode) }}, - {"GET", "/readyz", "", func(t *testing.T, resp *http.Response) { + {"GET", "/readyz", "", func(t *testing.T, req *http.Request, resp *http.Response) { assert.Equal(t, http.StatusOK, resp.StatusCode) }}, - {"GET", "/version", "", func(t *testing.T, resp *http.Response) { + {"GET", "/version", "", func(t *testing.T, req *http.Request, resp *http.Response) { assert.Equal(t, http.StatusOK, resp.StatusCode) details := build.Details{} err := json.NewDecoder(resp.Body).Decode(&details) @@ -64,13 +86,13 @@ func TestProxyRoutes(t *testing.T) { }}, // Default sumdb is sum.golang.org - {"GET", "/sumdb/sum.golang.org/supported", "", func(t *testing.T, resp *http.Response) { + {"GET", "/sumdb/sum.golang.org/supported", "", func(t *testing.T, req *http.Request, resp *http.Response) { assert.Equal(t, http.StatusOK, resp.StatusCode) }}, - {"GET", "/sumdb/sum.rust-lang.org/supported", "", func(t *testing.T, resp *http.Response) { + {"GET", "/sumdb/sum.rust-lang.org/supported", "", func(t *testing.T, req *http.Request, resp *http.Response) { assert.Equal(t, http.StatusNotFound, resp.StatusCode) }}, - {"GET", "/sumdb/sum.golang.org/lookup/github.com/gomods/athens", "", func(t *testing.T, resp *http.Response) { + {"GET", "/sumdb/sum.golang.org/lookup/github.com/gomods/athens", "", func(t *testing.T, req *http.Request, resp *http.Response) { assert.Equal(t, http.StatusForbidden, resp.StatusCode) }}, } @@ -84,7 +106,7 @@ func TestProxyRoutes(t *testing.T) { t.Run(req.RequestURI, func(t *testing.T) { w := httptest.NewRecorder() r.ServeHTTP(w, req) - tc.test(t, w.Result()) + tc.test(t, req, w.Result()) }) } diff --git a/cmd/proxy/actions/home.go b/cmd/proxy/actions/home.go index 94fb545f2..8f41b979e 100644 --- a/cmd/proxy/actions/home.go +++ b/cmd/proxy/actions/home.go @@ -1,9 +1,137 @@ package actions import ( + "errors" + "html/template" "net/http" + "os" + "strings" + + "github.com/gomods/athens/pkg/config" + "github.com/gomods/athens/pkg/log" ) -func proxyHomeHandler(w http.ResponseWriter, r *http.Request) { - _, _ = w.Write([]byte(`"Welcome to The Athens Proxy"`)) +const homepage = ` + + + Athens + + + + +

Welcome to Athens

+ +

Configuring your client

+ 
GOPROXY={{ .Host }},direct
+ {{ if .NoSumPatterns }} +

Excluding checksum database

+

Use the following GONOSUM environment variable to exclude checksum database:

+ 
GONOSUM={{ .NoSumPatterns }}
+ {{ end }} + +

How to use the Athens API

+

Use the catalog endpoint to get a list of all modules in the proxy

+ +

List of versions

+

This endpoint returns a list of versions that Athens knows about for acidburn/htp:

+ 
GET {{ .Host }}/github.com/acidburn/htp/@v/list
+ +

Version info

+

This endpoint returns information about a specific version of a module:

+ 
GET {{ .Host }}/github.com/acidburn/htp/@v/v1.0.0.info
+

This returns JSON with information about v1.0.0. It looks like this: + 

{
+	"Name": "v1.0.0",
+	"Short": "v1.0.0",
+	"Version": "v1.0.0",
+	"Time": "1972-07-18T12:34:56Z"
+}
+ +

go.mod file

+

This endpoint returns the go.mod file for a specific version of a module:

+ 
GET {{ .Host }}/github.com/acidburn/htp/@v/v1.0.0.mod
+

This returns the go.mod file for version v1.0.0. If {{ .Host }}/github.com/acidburn/htp version v1.0.0 has no dependencies, the response body would look like this:

+ 
module github.com/acidburn/htp
+ +

Module sources

+ 
GET {{ .Host }}/github.com/acidburn/htp/@v/v1.0.0.zip
+

This is what it sounds like — it sends back a zip file with the source code for the module in version v1.0.0.

+ +

Latest

+ 
GET {{ .Host }}/github.com/acidburn/htp/@latest
+

This endpoint returns the latest version of the module. If the version does not exist it should retrieve the hash of latest commit.

+ + + +` + +func proxyHomeHandler(c *config.Config) http.HandlerFunc { + return func(w http.ResponseWriter, r *http.Request) { + lggr := log.EntryFromContext(r.Context()) + + templateData := make(map[string]string) + + templateContents := homepage + + // load the template from the file system if it exists, otherwise revert to default + rawTemplateFileContents, err := os.ReadFile(c.HomeTemplatePath) + if err != nil { + if !errors.Is(err, os.ErrNotExist) { + // this is some other error, log it and revert to default + lggr.SystemErr(err) + } + } else { + templateContents = string(rawTemplateFileContents) + } + + // This should be correct in most cases. If it is not, users can supply their own template + templateData["Host"] = r.Host + + // if the host does not have a scheme, add one based on the request + if !strings.HasPrefix(templateData["Host"], "http://") && !strings.HasPrefix(templateData["Host"], "https://") { + if r.TLS != nil { + templateData["Host"] = "https://" + templateData["Host"] + } else { + templateData["Host"] = "http://" + templateData["Host"] + } + } + + templateData["NoSumPatterns"] = strings.Join(c.NoSumPatterns, ",") + + tmp, err := template.New("home").Parse(templateContents) + if err != nil { + lggr.SystemErr(err) + w.WriteHeader(http.StatusInternalServerError) + } + + w.Header().Add("Content-Type", "text/html") + w.WriteHeader(http.StatusOK) + + err = tmp.ExecuteTemplate(w, "home", templateData) + if err != nil { + lggr.SystemErr(err) + w.WriteHeader(http.StatusInternalServerError) + } + } } diff --git a/config.dev.toml b/config.dev.toml index 16f11779c..d04df2fea 100755 --- a/config.dev.toml +++ b/config.dev.toml @@ -169,6 +169,10 @@ BasicAuthUser = "" # Env override: BASIC_AUTH_PASS BasicAuthPass = "" +# A path on disk to a Go HTML template to be used on the homepage +# Env override: ATHENS_HOME_TEMPLATE_PATH +HomeTemplatePath = "/var/lib/athens/home.html" + # Set to true to force an SSL redirect # Env override: PROXY_FORCE_SSL ForceSSL = false diff --git a/docs/content/configuration/home-template.md b/docs/content/configuration/home-template.md new file mode 100644 index 000000000..cbb55a2a8 --- /dev/null +++ b/docs/content/configuration/home-template.md @@ -0,0 +1,101 @@ +--- +title: Home template configuration +description: How to customize the home template +weight: 8 +--- + +As of v0.14.0 Athens ships with a default, minimal HTML home page that advises users on how to connect to the proxy. It factors in whether `GoNoSumPatterns` is configured, and attempts +to build configuration for `GO_PROXY`. It relies on the users request Host header (on HTTP 1.1) or the Authority header (on HTTP 2) as well as whether the request was over TLS to advise +on configuring `GO_PROXY`. Lastly, the homepage provides a quick guide on how users can leverage the Athens API. + +Of course, not all instructions will be this simple. Some installations may be reachable at different addresses in CI than for desktop users. In this case, and others where the default +home page does not make sense it is possible to override the template. + +Do so by configuring `HomeTemplatePath` via the config or `ATHENS_HOME_TEMPLATE_PATH` to a location on disk with a Go HTML template or placing a template file at `/var/lib/athens/home.html`. + +Athens automatically injects the following variables in templates: + +| Setting | Source | +| :------ | :----- | +| `Host` | Built from the request Host (HTTP1) or Authority (HTTP2) header and presence of TLS. Includes ports. | +| `NoSumPatterns` | Comes directly from the configuration. | + +Using these values is done by wrapping them in bracers with a dot prepended. Example: `{{ .Host }}` + +For more advanced formatting read more about [Go HTML templates](https://pkg.go.dev/html/template). + +```html + + + + Athens + + + + +

Welcome to Athens

+ +

Configuring your client

+ 
GOPROXY={{ .Host }},direct
+ {{ if .NoSumPatterns }} +

Excluding checksum database

+

Use the following GONOSUM environment variable to exclude checksum database:

+ 
GONOSUM={{ .NoSumPatterns }}
+ {{ end }} + +

How to use the Athens API

+

Use the catalog endpoint to get a list of all modules in the proxy

+ +

List of versions

+

This endpoint returns a list of versions that Athens knows about for acidburn/htp:

+ 
GET {{ .Host }}/github.com/acidburn/htp/@v/list
+ +

Version info

+

This endpoint returns information about a specific version of a module:

+ 
GET {{ .Host }}/github.com/acidburn/htp/@v/v1.0.0.info
+

This returns JSON with information about v1.0.0. It looks like this: + 

{
+	"Name": "v1.0.0",
+	"Short": "v1.0.0",
+	"Version": "v1.0.0",
+	"Time": "1972-07-18T12:34:56Z"
+}
+ +

go.mod file

+

This endpoint returns the go.mod file for a specific version of a module:

+ 
GET {{ .Host }}/github.com/acidburn/htp/@v/v1.0.0.mod
+

This returns the go.mod file for version v1.0.0. If {{ .Host }}/github.com/acidburn/htp version v1.0.0 has no dependencies, the response body would look like this:

+ 
module github.com/acidburn/htp
+ +

Module sources

+ 
GET {{ .Host }}/github.com/acidburn/htp/@v/v1.0.0.zip
+

This is what it sounds like — it sends back a zip file with the source code for the module in version v1.0.0.

+ +

Latest

+ 
GET {{ .Host }}/github.com/acidburn/htp/@latest
+

This endpoint returns the latest version of the module. If the version does not exist it should retrieve the hash of latest commit.

+ + + +``` \ No newline at end of file diff --git a/pkg/config/config.go b/pkg/config/config.go index 35aaccc1d..9f070e5b1 100644 --- a/pkg/config/config.go +++ b/pkg/config/config.go @@ -42,6 +42,7 @@ type Config struct { UnixSocket string `envconfig:"ATHENS_UNIX_SOCKET"` BasicAuthUser string `envconfig:"BASIC_AUTH_USER"` BasicAuthPass string `envconfig:"BASIC_AUTH_PASS"` + HomeTemplatePath string `envconfig:"ATHENS_HOME_TEMPLATE_PATH"` ForceSSL bool `envconfig:"PROXY_FORCE_SSL"` ValidatorHook string `envconfig:"ATHENS_PROXY_VALIDATOR"` PathPrefix string `envconfig:"ATHENS_PATH_PREFIX"` @@ -157,6 +158,7 @@ func defaultConfig() *Config { PprofPort: ":3001", StatsExporter: "prometheus", TimeoutConf: TimeoutConf{Timeout: 300}, + HomeTemplatePath: "/var/lib/athens/home.html", StorageType: "memory", Port: ":3000", SingleFlightType: "memory", diff --git a/pkg/config/config_test.go b/pkg/config/config_test.go index e10a2afbe..c2897b568 100644 --- a/pkg/config/config_test.go +++ b/pkg/config/config_test.go @@ -79,23 +79,24 @@ func TestEnvOverrides(t *testing.T) { TimeoutConf: TimeoutConf{ Timeout: 30, }, - StorageType: "minio", - GlobalEndpoint: "mytikas.gomods.io", - Port: ":7000", - EnablePprof: false, - PprofPort: ":3001", - BasicAuthUser: "testuser", - BasicAuthPass: "testpass", - ForceSSL: true, - ValidatorHook: "testhook.io", - PathPrefix: "prefix", - NETRCPath: "/test/path/.netrc", - HGRCPath: "/test/path/.hgrc", - Storage: &Storage{}, - GoBinaryEnvVars: []string{"GOPROXY=direct"}, - SingleFlight: &SingleFlight{}, - RobotsFile: "robots.txt", - Index: &Index{}, + StorageType: "minio", + GlobalEndpoint: "mytikas.gomods.io", + HomeTemplatePath: "/tmp/athens/home.html", + Port: ":7000", + EnablePprof: false, + PprofPort: ":3001", + BasicAuthUser: "testuser", + BasicAuthPass: "testpass", + ForceSSL: true, + ValidatorHook: "testhook.io", + PathPrefix: "prefix", + NETRCPath: "/test/path/.netrc", + HGRCPath: "/test/path/.hgrc", + Storage: &Storage{}, + GoBinaryEnvVars: []string{"GOPROXY=direct"}, + SingleFlight: &SingleFlight{}, + RobotsFile: "robots.txt", + Index: &Index{}, } envVars := getEnvMap(expConf) @@ -269,6 +270,7 @@ func TestParseExampleConfig(t *testing.T) { StorageType: "memory", NetworkMode: "strict", GlobalEndpoint: "http://localhost:3001", + HomeTemplatePath: "/var/lib/athens/home.html", Port: ":3000", EnablePprof: false, PprofPort: ":3001", @@ -322,6 +324,7 @@ func getEnvMap(config *Config) map[string]string { envVars["BASIC_AUTH_USER"] = config.BasicAuthUser envVars["BASIC_AUTH_PASS"] = config.BasicAuthPass envVars["PROXY_FORCE_SSL"] = strconv.FormatBool(config.ForceSSL) + envVars["ATHENS_HOME_TEMPLATE_PATH"] = config.HomeTemplatePath envVars["ATHENS_PROXY_VALIDATOR"] = config.ValidatorHook envVars["ATHENS_PATH_PREFIX"] = config.PathPrefix envVars["ATHENS_NETRC_PATH"] = config.NETRCPath