-
Notifications
You must be signed in to change notification settings - Fork 9
/
loader.go
458 lines (370 loc) · 12.2 KB
/
loader.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
// Copyright 2022 Namespace Labs Inc; All rights reserved.
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
package parsing
import (
"context"
"io/fs"
"os"
"path/filepath"
"strings"
"sync"
"golang.org/x/exp/maps"
"golang.org/x/exp/slices"
"namespacelabs.dev/foundation/internal/fnerrors"
"namespacelabs.dev/foundation/schema"
"namespacelabs.dev/foundation/std/cfg"
"namespacelabs.dev/foundation/std/pkggraph"
"namespacelabs.dev/foundation/std/tasks"
)
func LoadPackageByName(ctx context.Context, env cfg.Context, name schema.PackageName) (*pkggraph.Package, error) {
pl := NewPackageLoader(env)
parsed, err := pl.LoadByName(ctx, name)
if err != nil {
return nil, err
}
return parsed, nil
}
// EarlyPackageLoader is available during package graph construction, and has
// the ability to load workspace contents as well. All of the contents that are
// loaded through WorkspaceOf are retained, and stored as part of the config
// image, so that package loading is fully reproducible.
type EarlyPackageLoader interface {
pkggraph.PackageLoader
WorkspaceOf(context.Context, *pkggraph.Module) (fs.FS, error)
}
type PackageType int
const (
PackageType_None PackageType = iota
PackageType_Extension
PackageType_Service
PackageType_Server
PackageType_Binary
PackageType_Test
)
type Frontend interface {
ParsePackage(context.Context, pkggraph.Location) (*pkggraph.Package, error)
GuessPackageType(context.Context, schema.PackageName) (PackageType, error)
}
var MakeFrontend func(EarlyPackageLoader, *schema.Environment) Frontend
// Parsing packages often as an exponential factor because nodes tend to depend on
// complete whole sub-trees. During a single root load, we maintain a cache of
// already loaded packages to minimize this fan-out cost.
type PackageLoader struct {
absPath string
workspace cfg.Workspace
env *schema.Environment
frontend Frontend
rootmodule *pkggraph.Module
moduleResolver MissingModuleResolver
mu sync.RWMutex
loaded map[schema.PackageName]*pkggraph.Package // package name -> pkggraph.Package
loading map[schema.PackageName]*loadingPackage // pkggraph.Package name -> loadingPackage
loadedModules map[string]*pkggraph.Module // module name -> Module
}
type sealedPackages struct {
modules map[string]*pkggraph.Module // module name -> Module
packages map[schema.PackageName]*pkggraph.Package // package name -> pkggraph.Package
}
type resultPair struct {
value *pkggraph.Package
err error
}
type loadingPackage struct {
pl *PackageLoader
loc pkggraph.Location
mu sync.Mutex
waiters []chan resultPair
waiting int // The first waiter, will also get to the package load.
done bool
result resultPair
}
type packageLoaderOpt func(*PackageLoader)
var _ pkggraph.SealedPackageLoader = sealedPackages{}
func WithMissingModuleResolver(moduleResolver MissingModuleResolver) packageLoaderOpt {
return func(pl *PackageLoader) {
pl.moduleResolver = moduleResolver
}
}
func NewPackageLoader(env cfg.Context, opt ...packageLoaderOpt) *PackageLoader {
pl := &PackageLoader{}
pl.absPath = env.Workspace().LoadedFrom().AbsPath
pl.workspace = env.Workspace()
pl.env = env.Environment()
pl.loaded = map[schema.PackageName]*pkggraph.Package{}
pl.loading = map[schema.PackageName]*loadingPackage{}
pl.loadedModules = map[string]*pkggraph.Module{}
pl.frontend = MakeFrontend(pl, env.Environment())
pl.rootmodule = pl.inject(env.Workspace().LoadedFrom(), env.Workspace().Proto(), "" /* version */)
pl.moduleResolver = &defaultMissingModuleResolver{workspace: env.Workspace()}
for _, o := range opt {
o(pl)
}
return pl
}
func (pl *PackageLoader) Seal() pkggraph.SealedPackageLoader {
sealed := sealedPackages{
modules: map[string]*pkggraph.Module{},
packages: map[schema.PackageName]*pkggraph.Package{},
}
pl.mu.Lock()
for name, module := range pl.loadedModules {
sealed.modules[name] = module
}
for name, p := range pl.loaded {
sealed.packages[name] = p
}
pl.mu.Unlock()
return sealed
}
func (pl *PackageLoader) Resolve(ctx context.Context, original schema.PackageName) (pkggraph.Location, error) {
packageName := maybeRewritePackage(original)
pkg := string(packageName)
if pkg == "" || pkg == "." {
return pkggraph.Location{}, fnerrors.InternalError("bad package reference %q", pkg)
}
if packageName.Equals(pl.workspace.ModuleName()) {
return pl.rootmodule.MakeLocation("."), nil
} else if rel := strings.TrimPrefix(pkg, pl.workspace.ModuleName()+"/"); rel != pkg {
return pl.rootmodule.MakeLocation(rel), nil
}
replaced, err := pl.MatchModuleReplace(ctx, packageName)
if err != nil {
return pkggraph.Location{}, err
}
if replaced != nil {
return *replaced, nil
}
mods := pl.workspace.Proto().Dep
// XXX longest prefix match?
for _, mod := range mods {
if rel := strings.TrimPrefix(pkg, mod.ModuleName+"/"); rel != pkg || pkg == mod.ModuleName {
return pl.ExternalLocation(ctx, mod, packageName)
}
}
// Resolve missing workspace dependency.
mod, err := pl.moduleResolver.Resolve(ctx, packageName)
if err != nil {
return pkggraph.Location{}, err
}
return pl.ExternalLocation(ctx, mod, packageName)
}
func (pl *PackageLoader) MatchModuleReplace(ctx context.Context, packageName schema.PackageName) (*pkggraph.Location, error) {
for _, replace := range pl.workspace.Proto().Replace {
rel, ok := schema.IsParent(replace.ModuleName, packageName)
if ok {
module, err := pl.resolveExternal(ctx, replace.ModuleName, func() (*LocalModule, error) {
return &LocalModule{
ModuleName: replace.ModuleName,
LocalPath: filepath.Join(pl.absPath, replace.Path),
}, nil
})
if err != nil {
return nil, err
}
loc := module.MakeLocation(rel)
return &loc, nil
}
}
return nil, nil
}
func (pl *PackageLoader) WorkspaceOf(ctx context.Context, module *pkggraph.Module) (fs.FS, error) {
return module.ReadOnlyFS(), nil
}
func (pl *PackageLoader) LoadByName(ctx context.Context, packageName schema.PackageName) (*pkggraph.Package, error) {
loc, err := pl.Resolve(ctx, packageName)
if err != nil {
return nil, err
}
return pl.loadPackage(ctx, loc)
}
func (pl *PackageLoader) loadPackage(ctx context.Context, loc pkggraph.Location) (*pkggraph.Package, error) {
pkgName := loc.PackageName
// Fast path: was the package already loaded?
pl.mu.RLock()
loaded := pl.loaded[pkgName]
pl.mu.RUnlock()
if loaded != nil {
return loaded, nil
}
// Slow path: if not, concentrate all concurrent loads of the same package into a single loader.
pl.mu.Lock()
loading := pl.loading[pkgName]
if loading == nil {
loading = &loadingPackage{
pl: pl,
loc: loc,
}
pl.loading[pkgName] = loading
}
pl.mu.Unlock()
if err := loading.Ensure(ctx); err != nil {
return nil, err
}
return loading.Get(ctx)
}
func (pl *PackageLoader) ExternalLocation(ctx context.Context, mod *schema.Workspace_Dependency, packageName schema.PackageName) (pkggraph.Location, error) {
module, err := pl.resolveExternal(ctx, mod.ModuleName, func() (*LocalModule, error) {
return DownloadModule(ctx, mod, false)
})
if err != nil {
return pkggraph.Location{}, err
}
if string(packageName) == module.ModuleName() {
return module.MakeLocation("."), nil
}
rel := strings.TrimPrefix(string(packageName), module.ModuleName()+"/")
if packageName.Equals(rel) {
return pkggraph.Location{}, fnerrors.InternalError("%s: inconsistent module, got %q", packageName, module.ModuleName())
}
return module.MakeLocation(rel), nil
}
func (pl *PackageLoader) inject(lf *schema.Workspace_LoadedFrom, w *schema.Workspace, version string) *pkggraph.Module {
pl.mu.Lock()
defer pl.mu.Unlock()
m := pkggraph.NewModule(w, lf, version)
pl.loadedModules[m.ModuleName()] = m
return m
}
func (pl *PackageLoader) resolveExternal(ctx context.Context, moduleName string, download func() (*LocalModule, error)) (*pkggraph.Module, error) {
pl.mu.RLock()
m := pl.loadedModules[moduleName]
pl.mu.RUnlock()
if m != nil {
return m, nil
}
downloaded, err := download()
if err != nil {
return nil, err
}
data, err := ModuleAt(ctx, downloaded.LocalPath, ModuleAtArgs{})
if err != nil {
if os.IsNotExist(err) {
return nil, fnerrors.UserError(nil, "%s: is not a workspace, %q missing.", moduleName, data.DefinitionFile())
}
return nil, err
}
if data.ModuleName() != moduleName {
return nil, fnerrors.InternalError("%s: inconsistent definition, module specified %q", moduleName, data.ModuleName())
}
return pl.inject(data.LoadedFrom(), data.Proto(), downloaded.Version), nil
}
type PackageLoaderStats struct {
LoadedPackageCount int
LoadedModuleCount int
PerModule map[string][]string
}
func (pl *PackageLoader) Stats(ctx context.Context) PackageLoaderStats {
var stats PackageLoaderStats
pl.mu.Lock()
defer pl.mu.Unlock()
stats.LoadedPackageCount = len(pl.loaded)
stats.PerModule = map[string][]string{}
stats.LoadedModuleCount = len(pl.loadedModules)
return stats
}
func (pl *PackageLoader) complete(pkg *pkggraph.Package) {
pl.mu.Lock()
pl.loaded[pkg.PackageName()] = pkg
pl.mu.Unlock()
}
func (l *loadingPackage) Ensure(ctx context.Context) error {
l.mu.Lock()
rev := l.waiting
l.waiting++
if rev > 0 {
// Someone is already loading the package.
l.mu.Unlock()
return nil
}
l.mu.Unlock()
var res resultPair
res.value, res.err = tasks.Return(ctx, tasks.Action("package.load").Scope(l.loc.PackageName), func(ctx context.Context) (*pkggraph.Package, error) {
pp, err := l.pl.frontend.ParsePackage(ctx, l.loc)
if err != nil {
return nil, err
}
return FinalizePackage(ctx, l.pl.env, l.pl, pp)
})
l.mu.Lock()
l.done = true
l.result = res
if res.err == nil {
l.pl.complete(res.value)
}
waiters := l.waiters
l.waiters = nil
l.mu.Unlock()
for _, ch := range waiters {
ch <- res
close(ch)
}
return nil
}
func (l *loadingPackage) Get(ctx context.Context) (*pkggraph.Package, error) {
l.mu.Lock()
if l.done {
defer l.mu.Unlock()
return l.result.value, l.result.err
}
// Very important that this is a buffered channel, else the write above will
// block forever and deadlock package loading.
ch := make(chan resultPair, 1)
l.waiters = append(l.waiters, ch)
l.mu.Unlock()
select {
case v, ok := <-ch:
if !ok {
return nil, fnerrors.InternalError("unexpected eof")
}
return v.value, v.err
case <-ctx.Done():
return nil, ctx.Err()
}
}
func (sealed sealedPackages) Resolve(ctx context.Context, original schema.PackageName) (pkggraph.Location, error) {
packageName := maybeRewritePackage(original)
if pkg, ok := sealed.packages[packageName]; ok {
return pkg.Location, nil
}
if mod, ok := sealed.modules[packageName.String()]; ok {
return mod.MakeLocation("."), nil
}
return pkggraph.Location{}, fnerrors.InternalError("%s: package not loaded while resolving!", packageName)
}
func (sealed sealedPackages) LoadByName(ctx context.Context, original schema.PackageName) (*pkggraph.Package, error) {
packageName := maybeRewritePackage(original)
if pkg, ok := sealed.packages[packageName]; ok {
return pkg, nil
}
return nil, fnerrors.InternalError("%s: package not loaded!", packageName)
}
func (sealed sealedPackages) Modules() []*pkggraph.Module {
mods := maps.Values(sealed.modules)
slices.SortFunc(mods, func(a, b *pkggraph.Module) bool {
return strings.Compare(a.ModuleName(), b.ModuleName()) < 0
})
return mods
}
func (sealed sealedPackages) Packages() []*pkggraph.Package {
packages := maps.Values(sealed.packages)
slices.SortFunc(packages, func(a, b *pkggraph.Package) bool {
return strings.Compare(a.PackageName().String(), b.PackageName().String()) < 0
})
return packages
}
func Ensure(ctx context.Context, packages pkggraph.PackageLoader, packageName schema.PackageName) error {
_, err := packages.LoadByName(ctx, packageName)
return err
}
func maybeRewritePackage(pkg schema.PackageName) schema.PackageName {
for key, target := range schema.StaticModuleRewrites {
if string(pkg) == key {
return schema.PackageName(filepath.Join(target.ModuleName, target.RelPath))
} else if strings.HasPrefix(string(pkg), key+"/") {
rel := strings.TrimPrefix(string(pkg), key+"/")
return schema.PackageName(filepath.Join(target.ModuleName, target.RelPath, rel))
}
}
return pkg
}