SeanOMik
/
roulette
mirror of https://git.seedno.de/seednode/roulette.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Split /_/debug endpoint into /_/html and /_/json, formatted accordingly

This commit is contained in:
Seednode 2023-05-08 09:10:13 -05:00
parent 8dae3865c0
commit 5fdfaee80d
3 changed files with 46 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -83,9 +83,9 @@ If the `--stats` flag is passed, an additional endpoint, `/_/stats`, is register
When accessed, this endpoint returns a JSON document listing every file served, along with the number of times it has been served, its filesize, and timestamps of when it was served.
## Debug
If the `-d|--debug` flag is passed, an additional endpoint, `/_/debug`, is registered.
If the `-d|--debug` flag is passed, two additional endpoints—`/_/html` and `/_/json`—are registered.
When accessed, this endpoint returns a sorted JSON document listing every file currently in the index. This can prove useful when confirming whether the index is generated successfully, or whether a given file is in the index.
When accessed, these endpoints return the contents of the index, in HTML and JSON formats respectively. This can prove useful when confirming whether the index is generated successfully, or whether a given file is in the index.
## Usage output
```

2
cmd/version.go
View File

@ -10,7 +10,7 @@ import (
"github.com/spf13/cobra"
)
var Version = "0.42.0"
var Version = "0.43.0"
func init() {
rootCmd.AddCommand(versionCmd)

46
cmd/web.go
View File

@ -646,7 +646,46 @@ func serveStatsHandler(args []string, stats *ServeStats) http.HandlerFunc {
}
}
func serveDebugHandler(args []string, index *Index) http.HandlerFunc {
func serveHtmlDebugHandler(args []string, index *Index) http.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(http.StatusOK)
w.Header().Set("Content-Type", "text/html")
startTime := time.Now()
indexDump := index.Index()
sort.SliceStable(indexDump, func(p, q int) bool {
return indexDump[p] < indexDump[q]
})
var htmlBody strings.Builder
htmlBody.WriteString(`<!DOCTYPE html><html lang="en"><head>`)
htmlBody.WriteString(`<style>a{display:block;height:100%;width:100%;text-decoration:none;color:inherit;cursor:auto;}</style>`)
htmlBody.WriteString(`<title>Debug</title></head><body>`)
for _, v := range indexDump {
htmlBody.WriteString(fmt.Sprintf("<a href=%q>%s</a>\n", v, v))
}
htmlBody.WriteString(`</body></html>`)
b, err := io.WriteString(w, gohtml.Format(htmlBody.String()))
if err != nil {
return
}
if verbose {
fmt.Printf("%s | Served HTML debug page (%s) to %s in %s\n",
startTime.Format(LogDate),
humanReadableSize(b),
realIP(r),
time.Since(startTime).Round(time.Microsecond),
)
}
}
}
func serveJsonDebugHandler(args []string, index *Index) http.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(http.StatusOK)
w.Header().Set("Content-Type", "application/json")
@ -667,7 +706,7 @@ func serveDebugHandler(args []string, index *Index) http.HandlerFunc {
w.Write(response)
if verbose {
fmt.Printf("%s | Served debug page (%s) to %s in %s\n",
fmt.Printf("%s | Served JSON debug page (%s) to %s in %s\n",
startTime.Format(LogDate),
humanReadableSize(len(response)),
realIP(r),
@ -866,7 +905,8 @@ func ServePage(args []string) error {
}
if debug {
http.Handle("/_/debug", serveDebugHandler(args, index))
http.Handle("/_/html", serveHtmlDebugHandler(args, index))
http.Handle("/_/json", serveJsonDebugHandler(args, index))
}
err = http.ListenAndServe(":"+strconv.FormatInt(int64(port), 10), nil)