summaryrefslogtreecommitdiff
path: root/vrsite/static.go
blob: 7d31b1d46dbf547a54ada3973d4437dfba90273d (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
// static.go — the offline export: the same pages written out as files.
//
// Everything that needs a server (comments, live activity, jj queries) is
// omitted; the trace/notes toggle, the file finder and the note filters all
// keep working, since they run in the browser.
package main

import (
	"bytes"
	"fmt"
	"html/template"
	"os"
	"os/exec"
	"path/filepath"
	"runtime"
	"strings"
	"sync"
	"time"
)

func run(dir string, name string, args ...string) []byte {
	cmd := exec.Command(name, args...)
	cmd.Dir = dir
	out, err := cmd.Output()
	if err != nil {
		if ee, ok := err.(*exec.ExitError); ok {
			os.Stderr.Write(ee.Stderr)
		}
		fatal("%s %s: %v", name, strings.Join(args, " "), err)
	}
	return out
}

func buildSite(logPath, repoAbs, out, title string, theme, light *Theme) {
	start := time.Now()
	entries := readLog(logPath)
	ranked := buildModel(title, entries, "").Ranked
	if len(ranked) == 0 {
		fatal("log has no jj change ids")
	}
	// the most-logged change this repo actually has: a log can span repos, and
	// the busiest change in it may belong to another one
	var change string
	var list []byte
	for _, c := range ranked {
		out, err := jjRun(repoAbs, "file", "list", "-r", c)
		if err == nil {
			change, list = c, out
			break
		}
	}
	if change == "" {
		fatal("none of the log's %d changes are in %s — logs are per repository; point -repo at the one the trace was recorded in",
			len(ranked), repoAbs)
	}
	// an export is a picture of one change, so it holds only what was
	// recorded there; the notes page says how much of the log that leaves out
	site := buildModel(title, entries, change)
	site.Change = change
	site.Theme, site.Light, site.Repo = theme, light, repoAbs
	site.All = site.filesAt(strings.Split(strings.TrimRight(string(list), "\n"), "\n"), change)

	commit := strings.TrimSpace(string(mustJJ(repoAbs, "log", "-r", site.Change, "--no-graph", "-T", "commit_id")))
	tmp, err := os.MkdirTemp("", "vrsite-")
	if err != nil {
		fatal("%v", err)
	}
	defer os.RemoveAll(tmp)
	archive := exec.Command("git", "-C", repoAbs, "archive", commit)
	untar := exec.Command("tar", "-x", "-C", tmp)
	untar.Stdin, _ = archive.StdoutPipe()
	untar.Stderr = os.Stderr
	if err := untar.Start(); err != nil {
		fatal("tar: %v", err)
	}
	if err := archive.Run(); err != nil {
		fatal("git archive %s: %v", short(commit), err)
	}
	if err := untar.Wait(); err != nil {
		fatal("tar: %v", err)
	}

	writeSite(site, out, tmp)
	stubs := 0
	for _, f := range site.All {
		if f.Stub != "" {
			stubs++
		}
	}
	fmt.Printf("vrsite: %d files (%d traced, %d not rendered), %d notes, %d agents in %s -> %s\n",
		len(site.All), len(site.Order), stubs, len(site.Notes), len(site.Agents),
		time.Since(start).Round(time.Millisecond), out)
}

func writeSite(site *Site, out, srcDir string) {
	tpl := newTemplates()
	if err := os.MkdirAll(out, 0o755); err != nil {
		fatal("%v", err)
	}

	each := func(fn func(f *File)) {
		sem := make(chan struct{}, runtime.NumCPU())
		var wg sync.WaitGroup
		for _, f := range site.All {
			wg.Add(1)
			sem <- struct{}{}
			go func(f *File) {
				defer func() { <-sem; wg.Done() }()
				fn(f)
			}(f)
		}
		wg.Wait()
	}
	// phase A: content — coverage percentages must exist before any tree
	// or index below is written
	hl := newHighlighter(site.Theme, site.Light)
	each(func(f *File) {
		src, err := os.ReadFile(filepath.Join(srcDir, f.Path))
		switch {
		case err != nil:
			f.Stub = "not present in the archived commit"
		case bytes.IndexByte(src, 0) >= 0:
			f.Stub = "binary file — not rendered"
		case len(src) > 2<<20:
			f.Stub = fmt.Sprintf("file too large to render (%d KB)", len(src)/1024)
		default:
			f.render(src, hl)
		}
	})

	cf := mustCreate(filepath.Join(out, "style.css"))
	if err := renderCSS(cf, site); err != nil {
		fatal("css: %v", err)
	}
	cf.Close()
	for _, name := range []string{"app.js"} {
		b, err := tfs.ReadFile("assets/" + name)
		if err != nil {
			fatal("%v", err)
		}
		if err := os.WriteFile(filepath.Join(out, name), b, 0o644); err != nil {
			fatal("%v", err)
		}
	}

	// shared tree fragment: the only nav tree, fetched by every page; "@@" is
	// replaced with the page root by app.js, since the fragment is fetched
	// from any page depth
	treeFrag := renderTree(site.All, func(p string) string { return "@@code/" + p + ".html" })
	if err := os.WriteFile(filepath.Join(out, "tree.html"), []byte(treeFrag), 0o644); err != nil {
		fatal("%v", err)
	}

	facets := site.Facets()
	var info *Row
	if rows, err := LogRows(site.Repo, site.Change, "", 1); err == nil {
		for _, row := range rows {
			if !row.Blank() {
				r := row
				info = &r
				break
			}
		}
	}
	render := func(path string, p *page) {
		p.Site, p.Facets = site, facets
		p.ChangeID, p.Default, p.ChangeInfo = site.Change, site.Change, info
		p.Scope, p.Here = "change", site.NotesAt[site.Change]
		p.Elsewhere = site.NotesTotal - p.Here
		p.Files = site.All
		f := mustCreate(path)
		if err := tpl.Execute(f, p); err != nil {
			fatal("render %s: %v", path, err)
		}
		f.Close()
	}

	latest := site.FilterNotes(NoteFilter{})
	if len(latest) > 24 {
		latest = latest[:24]
	}
	render(filepath.Join(out, "index.html"), &page{Kind: "index", Title: site.Title, Notes: latest})

	fullTree := renderTree(site.All, func(p string) string { return "code/" + p + ".html" })
	render(filepath.Join(out, "files.html"), &page{Kind: "files", Title: "files — " + site.Title,
		Tree: template.HTML(fullTree)})

	render(filepath.Join(out, "notes.html"), &page{Kind: "notes", Title: "notes — " + site.Title,
		Notes: site.FilterNotes(NoteFilter{})})

	// phase B: every file page, in parallel
	each(func(f *File) {
		dst := filepath.Join(out, "code", f.Path+".html")
		os.MkdirAll(filepath.Dir(dst), 0o755)
		depth := strings.Count(f.Path, "/") + 1
		render(dst, &page{Kind: "file", Title: f.Path + " — " + site.Title,
			Root: strings.Repeat("../", depth), Current: f.Path, File: f})
	})
}

func mustCreate(path string) *os.File {
	f, err := os.Create(path)
	if err != nil {
		fatal("%v", err)
	}
	return f
}