artin/sourcegraph
1
0
Fork 0
mirror of https://github.com/sourcegraph/sourcegraph.git synced 2026-02-06 12:51:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

src-expose: index page listing instructions and urls (#8327)

Browse Source 
Some users (including myself) visit src-expose and get a 404. This commit
includes a useful page instead.
This commit is contained in:
Keegan Carruthers-Smith 2020-02-07 20:27:27 +00:00 committed by GitHub
parent d0626a0c2b
commit 2a2a0fc6d2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 51 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
dev/src-expose/main.go
View File

@ -27,20 +27,13 @@ func (e *usageError) Error() string {
return e.Msg
}
func explain(s *Snapshotter, addr string) string {
var dirs []string
for _, d := range s.Dirs {
dirs = append(dirs, "- "+d.Dir)
}
func explainAddr(addr string) string {
_, port, err := net.SplitHostPort(addr)
if err != nil {
port = "3434"
}
return fmt.Sprintf(`Periodically syncing directories as git repositories to %s.
%s
Serving the repositories at http://%s.
return fmt.Sprintf(`Serving the repositories at http://%s.
FIRST RUN NOTE: If src-expose has not yet been setup on Sourcegraph, then you
need to configure Sourcegraph to sync with src-expose. Paste the following
@ -53,7 +46,16 @@ configuration as an Other External Service in Sourcegraph:
"url": "http://host.docker.internal:%s",
"repos": ["src-expose"] // This may change in versions later than 3.9
}
`, s.Destination, strings.Join(dirs, "\n"), addr, addr, port, port)
`, addr, addr, port, port)
}
func explainSnapshotter(s *Snapshotter) string {
var dirs []string
for _, d := range s.Dirs {
dirs = append(dirs, "- "+d.Dir)
}
return fmt.Sprintf("Periodically syncing directories as git repositories to %s.\n%s\n", s.Destination, strings.Join(dirs, "\n"))
}
func usageErrorOutput(cmd *ffcli.Command, cmdPath string, err error) string {
@ -226,7 +228,8 @@ See https://github.com/sourcegraph/sourcegraph/tree/master/dev/src-expose/exampl
}
if !*globalQuiet {
fmt.Println(explain(s, *globalAddr))
fmt.Println(explainSnapshotter(s))
fmt.Println(explainAddr(*globalAddr))
}
go func() {

12
dev/src-expose/main_test.go
View File

@ -7,10 +7,11 @@ import (
)
func TestExplain(t *testing.T) {
want := `Periodically syncing directories as git repositories to bam.
wantSnapshotter := `Periodically syncing directories as git repositories to bam.
- foo/bar
- baz
Serving the repositories at http://[::]:10810.
`
wantAddr := `Serving the repositories at http://[::]:10810.
FIRST RUN NOTE: If src-expose has not yet been setup on Sourcegraph, then you
need to configure Sourcegraph to sync with src-expose. Paste the following
@ -29,9 +30,12 @@ configuration as an Other External Service in Sourcegraph:
Destination: "bam",
Dirs: []*SyncDir{{Dir: "foo/bar"}, {Dir: "baz"}},
}
addr := "[::]:10810"
if got, want := explainSnapshotter(s), wantSnapshotter; got != want {
t.Errorf("mismatch (-want +got):\n%s", cmp.Diff(want, got))
}
if got := explain(s, addr); got != want {
addr := "[::]:10810"
if got, want := explainAddr(addr), wantAddr; got != want {
t.Errorf("mismatch (-want +got):\n%s", cmp.Diff(want, got))
}
}

29
dev/src-expose/serve.go
View File

@ -2,6 +2,7 @@ package main
import (
"encoding/json"
"html/template"
"log"
"net"
"net/http"
@ -30,12 +31,40 @@ func serveRepos(logger *log.Logger, addr, repoDir string) error {
return nil
}
var indexHTML = template.Must(template.New("").Parse(`<html>
<head><title>src-expose</title></head>
<body>
<h2>src-expose</h2>
<pre>
{{.Explain}}
<ul>{{range .Links}}
<li><a href="{{.}}">{{.}}</a></li>
{{- end}}
</ul>
</pre>
</body>
</html>`))
func serve(logger *log.Logger, ln net.Listener, reposRoot string) (*http.Server, error) {
configureRepos(logger, reposRoot)
// Start the HTTP server.
mux := &http.ServeMux{}
mux.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Content-Type", "text/html; charset=utf-8")
err := indexHTML.Execute(w, map[string]interface{}{
"Explain": explainAddr(ln.Addr().String()),
"Links": []string{
"/v1/list-repos",
"/repos/",
},
})
if err != nil {
log.Println(err)
}
})
mux.HandleFunc("/v1/list-repos", func(w http.ResponseWriter, r *http.Request) {
type Repo struct {
Name string