-
Notifications
You must be signed in to change notification settings - Fork 309
/
build.go
534 lines (456 loc) · 12.9 KB
/
build.go
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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
package compiler
import (
"bufio"
"bytes"
"encoding/json"
"errors"
"fmt"
"io/ioutil"
"math"
"os"
"os/exec"
"path/filepath"
"runtime"
"strconv"
"strings"
"time"
"github.com/rs/zerolog/log"
"golang.org/x/mod/modfile"
"golang.org/x/mod/semver"
"encr.dev/internal/optracker"
"encr.dev/parser"
"encr.dev/parser/est"
)
type Config struct {
// Revision specifies the app version to encode
// into the app metadata.
Revision string
// This boolean returns if there are uncommitted changes
UncommittedChanges bool
// WorkingDir is the path relative to the app root from which the user
// is running the build. It is used to resolve relative filenames.
// If empty it defaults to "." which resolves to the app root.
WorkingDir string
// GOOS sets the GOOS to build for, if nonempty.
GOOS string
// GOARCH sets the GOARCH to build for, if nonempty.
GOARCH string
// CgoEnabled decides whether to build with cgo enabled.
CgoEnabled bool
// Debug specifies whether to compile in debug mode.
Debug bool
// BuildTags are additional build tags to specify when building.
BuildTags []string
// StaticLink enables static linking of C libraries.
StaticLink bool
// EncoreCompilerVersion is the version of the compiler used to build the app
// it is used purely for information purposes within the healthz response.
EncoreCompilerVersion string
// EncoreRuntimePath if set, causes builds to introduce a temporary replace directive
// that replaces the module path to the "encore.dev" module.
// This lets us replace the implementation for building.
EncoreRuntimePath string
// EncoreGoRoot is the path to the Encore GOROOT.
EncoreGoRoot string
// Test is the specific settings for running tests.
Test *TestConfig
// If Parse is set, the build will skip parsing the app again
// and use the information provided.
Parse *parser.Result
// KeepOutput keeps the temporary build directory from being deleted in the case of failure.
KeepOutput bool
// OpTracker is an option tracker to output the progress to the UI
OpTracker *optracker.OpTracker
}
// Validate validates the config.
func (cfg *Config) Validate() error {
if cfg.EncoreRuntimePath == "" {
return errors.New("empty EncoreRuntimePath")
} else if cfg.EncoreGoRoot == "" {
return errors.New("empty EncoreGoRoot")
}
return nil
}
// Result is the combined results of a build.
type Result struct {
Dir string // absolute path to build temp dir
Exe string // absolute path to the build executable
Parse *parser.Result // set only if build succeeded
}
// Build builds the application.
//
// On success, it is the caller's responsibility to delete the temp dir
// returned in Result.Dir.
func Build(appRoot string, cfg *Config) (*Result, error) {
if err := cfg.Validate(); err != nil {
return nil, err
} else if appRoot, err = filepath.Abs(appRoot); err != nil {
return nil, err
}
b := &builder{
cfg: cfg,
appRoot: appRoot,
lastOpID: optracker.NoOperationID,
}
return b.Build()
}
type builder struct {
// inputs
cfg *Config
appRoot string
parseTests bool
workdir string
modfile *modfile.File
overlay map[string]string
res *parser.Result
lastOpID optracker.OperationID
}
func (b *builder) Build() (res *Result, err error) {
defer func() {
if e := recover(); e != nil {
b.cfg.OpTracker.Fail(b.lastOpID, err)
if b, ok := e.(bailout); ok {
err = b.err
} else {
panic(e)
}
}
}()
b.workdir, err = ioutil.TempDir("", "encore-build")
if err != nil {
return nil, err
}
res = &Result{
Dir: b.workdir,
Exe: filepath.Join(b.workdir, binaryName+b.exe()),
}
defer func() {
if err != nil && !b.cfg.KeepOutput {
os.RemoveAll(b.workdir)
}
}()
for _, fn := range []func() error{
b.parseApp,
b.checkApp,
b.startCodeGenTracker,
b.writeModFile,
b.writeSumFile,
b.writePackages,
b.writeMainPkg,
b.endCodeGenTracker,
b.buildMain,
} {
if err := fn(); err != nil {
b.cfg.OpTracker.Fail(b.lastOpID, err)
return res, err
}
}
res.Parse = b.res
return res, nil
}
func (b *builder) startCodeGenTracker() error {
b.lastOpID = b.cfg.OpTracker.Add("Generating boilerplate code", time.Now())
return nil
}
func (b *builder) endCodeGenTracker() error {
b.cfg.OpTracker.Done(b.lastOpID, 450*time.Millisecond)
return nil
}
// parseApp parses the app situated at appRoot.
func (b *builder) parseApp() error {
modPath := filepath.Join(b.appRoot, "go.mod")
modData, err := ioutil.ReadFile(modPath)
if err != nil {
return err
}
b.modfile, err = modfile.Parse(modPath, modData, nil)
if err != nil {
return err
}
if pc := b.cfg.Parse; pc != nil {
b.res = pc
return nil
}
cfg := &parser.Config{
AppRoot: b.appRoot,
AppRevision: b.cfg.Revision,
AppHasUncommittedChanges: b.cfg.UncommittedChanges,
ModulePath: b.modfile.Module.Mod.Path,
WorkingDir: b.cfg.WorkingDir,
ParseTests: b.parseTests,
}
b.res, err = parser.Parse(cfg)
return err
}
// checkApp checks the parsed app against the metadata.
func (b *builder) checkApp() error {
dbs := make(map[string]bool)
for _, svc := range b.res.Meta.Svcs {
if len(svc.Migrations) > 0 {
dbs[svc.Name] = true
}
}
for _, pkg := range b.res.App.Packages {
for _, res := range pkg.Resources {
switch res := res.(type) {
case *est.SQLDB:
if !dbs[res.DBName] {
pp := b.res.FileSet.Position(res.Ident().Pos())
b.errf("%s: database not found: %s", pp, res.DBName)
}
}
}
}
return nil
}
func (b *builder) writeModFile() error {
newPath := b.cfg.EncoreRuntimePath
oldPath := "encore.dev"
if err := b.modfile.AddRequire("encore.dev", "v0.0.0"); err != nil {
return fmt.Errorf("could not add require encore.dev path: %v", err)
}
if err := b.modfile.AddReplace(oldPath, "", newPath, ""); err != nil {
return fmt.Errorf("could not replace encore.dev path: %v", err)
}
b.modfile.Cleanup()
runtimeModData, err := os.ReadFile(filepath.Join(newPath, "go.mod"))
if err != nil {
return err
}
runtimeModfile, err := modfile.Parse("encore-runtime/go.mod", runtimeModData, nil)
if err != nil {
return err
}
mergeModfiles(b.modfile, runtimeModfile)
modBytes := modfile.Format(b.modfile.Syntax)
dstGomod := filepath.Join(b.workdir, "go.mod")
return ioutil.WriteFile(dstGomod, modBytes, 0644)
}
func (b *builder) writeSumFile() error {
appSum, err := ioutil.ReadFile(filepath.Join(b.appRoot, "go.sum"))
if err != nil && !os.IsNotExist(err) {
return err
}
runtimeSum, err := ioutil.ReadFile(filepath.Join(b.cfg.EncoreRuntimePath, "go.sum"))
if err != nil {
return err
}
if !bytes.HasSuffix(appSum, []byte{'\n'}) {
appSum = append(appSum, '\n')
}
data := append(appSum, runtimeSum...)
dstGosum := filepath.Join(b.workdir, "go.sum")
return ioutil.WriteFile(dstGosum, data, 0644)
}
func (b *builder) writePackages() error {
// Copy all the packages into the workdir
for _, pkg := range b.res.App.Packages {
targetDir := filepath.Join(b.workdir, filepath.FromSlash(pkg.RelPath))
if err := os.MkdirAll(targetDir, 0755); err != nil {
return err
} else if err := b.rewritePkg(pkg, targetDir); err != nil {
return err
}
}
return nil
}
func (b *builder) buildMain() error {
b.lastOpID = b.cfg.OpTracker.Add("Compiling application source code", time.Now())
overlayData, _ := json.Marshal(map[string]interface{}{"Replace": b.overlay})
overlayPath := filepath.Join(b.workdir, "overlay.json")
if err := ioutil.WriteFile(overlayPath, overlayData, 0644); err != nil {
return err
}
tags := append([]string{"encore", "encore_internal"}, b.cfg.BuildTags...)
args := []string{
"build",
"-tags=" + strings.Join(tags, ","),
"-overlay=" + overlayPath,
"-modfile=" + filepath.Join(b.workdir, "go.mod"),
"-mod=mod",
"-o=" + filepath.Join(b.workdir, "out"+b.exe()),
}
if b.cfg.StaticLink {
args = append(args, "-ldflags", `-extldflags "-static"`)
}
args = append(args, "./"+mainPkgName)
cmd := exec.Command(filepath.Join(b.cfg.EncoreGoRoot, "bin", "go"+b.exe()), args...)
env := []string{
"GO111MODULE=on",
"GOROOT=" + b.cfg.EncoreGoRoot,
}
if goos := b.cfg.GOOS; goos != "" {
env = append(env, "GOOS="+goos)
}
if goarch := b.cfg.GOARCH; goarch != "" {
env = append(env, "GOARCH="+goarch)
}
if !b.cfg.CgoEnabled {
env = append(env, "CGO_ENABLED=0")
}
cmd.Env = append(os.Environ(), env...)
cmd.Dir = b.appRoot
if out, err := cmd.CombinedOutput(); err != nil {
if len(out) == 0 {
out = []byte(err.Error())
}
out = makeErrsRelative(out, b.workdir, b.appRoot, b.cfg.WorkingDir)
return &Error{Output: out}
}
b.cfg.OpTracker.Done(b.lastOpID, 300*time.Millisecond)
return nil
}
func (b *builder) addOverlay(src, dst string) {
if b.overlay == nil {
b.overlay = make(map[string]string)
}
b.overlay[src] = dst
}
// mergeModFiles merges two modfiles, adding the require statements from the latter to the former.
// If both files have the same module requirement, it keeps the one with the greater semver version.
func mergeModfiles(src, add *modfile.File) {
reqs := src.Require
for _, a := range add.Require {
found := false
for _, r := range src.Require {
if r.Mod.Path == a.Mod.Path {
found = true
// Update the version if the one to add is greater.
if semver.Compare(a.Mod.Version, r.Mod.Version) > 0 {
r.Mod.Version = a.Mod.Version
}
}
}
if !found {
reqs = append(reqs, a)
}
}
src.SetRequire(reqs)
src.Cleanup()
}
type Error struct {
Output []byte
}
func (err *Error) Error() string {
return string(err.Output)
}
type bailout struct {
err error
}
func (b *builder) err(msg string) {
panic(bailout{errors.New(msg)})
}
func (b *builder) errf(format string, args ...interface{}) {
b.err(fmt.Sprintf(format, args...))
}
const binaryName = "out"
func (b *builder) exe() string {
goos := b.cfg.GOOS
if goos == "" {
goos = runtime.GOOS
}
if goos == "windows" {
return ".exe"
}
return ""
}
// makeErrsRelative goes through the errors and tweaks the filename to be relative
// to the relwd.
func makeErrsRelative(out []byte, workdir, appRoot, relwd string) []byte {
wdroot := filepath.Join(appRoot, relwd)
lines := bytes.Split(out, []byte{'\n'})
prefix := append([]byte(workdir), '/')
modified := false
for i, line := range lines {
if !bytes.HasPrefix(line, prefix) {
continue
}
idx := bytes.IndexByte(line, ':')
if idx == -1 || idx < len(prefix) {
continue
}
filename := line[:idx]
appPath := filepath.Join(appRoot, string(filename[len(prefix):]))
if rel, err := filepath.Rel(wdroot, appPath); err == nil {
lines[i] = append([]byte(rel), line[idx:]...)
// If this is an encore generated code file, let's grab the surrounding source code
if strings.Contains(rel, "__encore_") {
parts := strings.SplitN(string(line), ":", 4)
if len(parts) >= 3 {
sourceCode := readSourceOfError(parts[0], parts[1], parts[2])
if sourceCode != "" {
lines[i] = append(lines[i], []byte(sourceCode)...)
}
}
}
modified = true
}
}
if !modified {
return out
}
return bytes.Join(lines, []byte{'\n'})
}
// readSourceOfError returns the 15 lines of code surrounding the error with a pointer to the error on the error line
//
// This code outputs something line this;
//
// ```
// 9 | func myFunc() {
// 10 | x := 5
// 11 | y := "hello"
// 12 | z := x + y
// |~~~~~~~~~~^
// 13 | fmt.Println(z)
// 14 | }
// ```
func readSourceOfError(filename string, lineNumberStr string, columnNumberStr string) string {
const linesBeforeError = 10
const linesAfterError = 5
lineNumber, err := strconv.ParseInt(lineNumberStr, 10, 64)
if err != nil {
log.Error().AnErr("error", err).Msgf("Unable to parse line number: %s", lineNumberStr)
return ""
}
columnNumber, err := strconv.ParseInt(columnNumberStr, 10, 64)
if err != nil {
log.Error().AnErr("error", err).Msgf("Unable to parse column number: %s", columnNumberStr)
return ""
}
numDigitsInLineNumbers := int(math.Log10(float64(lineNumber+linesAfterError) + 1))
lineNumberFmt := fmt.Sprintf(" %%%dd | ", numDigitsInLineNumbers)
f, err := os.Open(filename)
if err != nil {
log.Error().AnErr("error", err).Str("filename", filename).Msg("Unable to open file")
return ""
}
defer func() { _ = f.Close() }()
var (
builder strings.Builder
currentLine int64
)
builder.WriteRune('\n')
sc := bufio.NewScanner(f)
for sc.Scan() {
currentLine++
if currentLine >= lineNumber-linesBeforeError {
// Write the line number
builder.WriteString(fmt.Sprintf(lineNumberFmt, currentLine))
// Then the line of code itself
builder.WriteString(sc.Text())
builder.WriteRune('\n')
}
if currentLine == lineNumber {
// Write empty line number column
builder.WriteString(strings.Repeat(" ", numDigitsInLineNumbers+2))
builder.WriteString(" |")
// Write a pointer to the error
builder.WriteString(strings.Repeat("~", int(columnNumber)+1))
builder.WriteString("^\n")
}
if currentLine > lineNumber+linesAfterError {
break
}
}
return builder.String()
}