-
Notifications
You must be signed in to change notification settings - Fork 9
/
module.go
301 lines (254 loc) · 8.33 KB
/
module.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
// 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 (
"bytes"
"context"
"fmt"
"net/http"
"os"
"os/exec"
"path/filepath"
"strings"
"golang.org/x/exp/slices"
"golang.org/x/net/html"
"namespacelabs.dev/foundation/internal/artifacts/download"
"namespacelabs.dev/foundation/internal/compute"
"namespacelabs.dev/foundation/internal/console"
"namespacelabs.dev/foundation/internal/fnerrors"
"namespacelabs.dev/foundation/internal/fnfs"
"namespacelabs.dev/foundation/internal/fnfs/zipfs"
"namespacelabs.dev/foundation/internal/git"
"namespacelabs.dev/foundation/internal/localexec"
"namespacelabs.dev/foundation/internal/workspace/dirs"
"namespacelabs.dev/foundation/schema"
"namespacelabs.dev/foundation/std/cfg"
"namespacelabs.dev/foundation/std/tasks"
"namespacelabs.dev/go-ids"
)
var publicRepos = []string{
"https://github.com/namespacelabs/foundation",
}
// LocalModule represents a module that is present in the specified LocalPath.
type LocalModule struct {
ModuleName string
LocalPath string
Version string
}
type ResolvedPackage struct {
ModuleName string
Type string
Repository string
RelPath string
}
func ResolveModuleVersion(ctx context.Context, packageName string) (*schema.Workspace_Dependency, error) {
resolved, err := ResolveModule(ctx, packageName)
if err != nil {
return nil, err
}
return ModuleHead(ctx, resolved)
}
func ModuleHead(ctx context.Context, resolved *ResolvedPackage) (*schema.Workspace_Dependency, error) {
return tasks.Return(ctx, tasks.Action("module.resolve-head").Arg("name", resolved.ModuleName), func(ctx context.Context) (*schema.Workspace_Dependency, error) {
var out bytes.Buffer
cmd := exec.CommandContext(ctx, "git", "ls-remote", "-q", resolved.Repository, "HEAD")
cmd.Env = append(os.Environ(), git.NoPromptEnv().Serialize()...)
cmd.Stdout = &out
cmd.Stderr = console.Output(ctx, "git")
if err := cmd.Run(); err != nil {
return nil, fnerrors.InvocationError("git", "%s: failed to `git ls-remote`: %w", resolved.Repository, err)
}
gitout := strings.TrimSpace(out.String())
if p := strings.TrimSuffix(gitout, "\tHEAD"); p != gitout {
dep := &schema.Workspace_Dependency{}
dep.ModuleName = resolved.ModuleName
dep.Version = strings.TrimSpace(p)
return dep, nil
}
return nil, fnerrors.InvocationError("git", "%s: failed to resolve HEAD", resolved.Repository)
})
}
func ResolveModule(ctx context.Context, packageName string) (*ResolvedPackage, error) {
// Check if there's a foundation redirect.
var r ResolvedPackage
if err := resolvePackageTo(ctx, packageName, &r); err != nil {
return nil, err
}
if r.Type != "git" {
return nil, fnerrors.New("%s: %s: unsupported type", packageName, r.Type)
}
return &r, nil
}
func resolvePackageTo(ctx context.Context, packageName string, resolved *ResolvedPackage) error {
return tasks.Action("module.resolve").Arg("name", packageName).Run(ctx, func(ctx context.Context) error {
contents, err := http.Get(fmt.Sprintf("https://%s?foundation-get=1", packageName))
if err != nil {
return err
}
defer contents.Body.Close()
doc, err := html.Parse(contents.Body)
if err != nil {
return err
}
if v := recurse(doc); v != "" {
parts := strings.Split(v, " ")
switch len(parts) {
case 3:
moduleName := parts[0]
var rel string
if moduleName != packageName {
rel = strings.TrimPrefix(packageName, moduleName+"/")
if rel == packageName {
return fnerrors.BadInputError("%s: invalid format, resolved package claimed it was module %q", packageName, moduleName)
}
}
*resolved = ResolvedPackage{
ModuleName: moduleName,
Type: parts[1],
Repository: parts[2],
RelPath: rel,
}
return nil
case 4:
*resolved = ResolvedPackage{
ModuleName: parts[0],
Type: parts[1],
Repository: parts[2],
RelPath: parts[3],
}
return nil
default:
fmt.Fprintf(console.Warnings(ctx), "Ignored foundation-import definition, wrong number of parts: %d (got %q)\n", len(parts), v)
}
}
if strings.HasPrefix(packageName, "github.com/") {
r, err := parseGithubPackage(packageName)
if err != nil {
return err
}
*resolved = *r
return nil
}
return fnerrors.InternalError("%s: don't know how to handle package", packageName)
})
}
func parseGithubPackage(packageName string) (*ResolvedPackage, error) {
// github.com/org/repo/rel
parts := strings.SplitN(packageName, "/", 4)
if len(parts) < 3 {
return nil, fnerrors.New("%s: invalid github package name", packageName)
}
var rel string
if len(parts) > 3 {
rel = strings.Join(parts[3:], "/")
}
moduleName := fmt.Sprintf("github.com/%s/%s", parts[1], parts[2])
return &ResolvedPackage{
ModuleName: moduleName,
Type: "git",
Repository: fmt.Sprintf("https://%s", moduleName),
RelPath: rel,
}, nil
}
func recurse(n *html.Node) string {
if n.Type == html.ElementNode && n.Data == "meta" {
name := getAttr(n.Attr, "name")
if name != nil && name.Val == "foundation-import" {
content := getAttr(n.Attr, "content")
if content != nil {
return content.Val
}
}
}
for c := n.FirstChild; c != nil; c = c.NextSibling {
if x := recurse(c); x != "" {
return x
}
}
return ""
}
func getAttr(attrs []html.Attribute, key string) *html.Attribute {
for _, attr := range attrs {
if attr.Key == key {
return &attr
}
}
return nil
}
func DownloadModule(ctx context.Context, dep *schema.Workspace_Dependency, force bool) (*LocalModule, error) {
return tasks.Return(ctx, tasks.Action("module.download").Arg("name", dep.ModuleName).Arg("version", dep.Version), func(ctx context.Context) (*LocalModule, error) {
modDir, err := dirs.ModuleCache(dep.ModuleName, dep.Version)
if err != nil {
return nil, err
}
// XXX more thorough check of the contents?
if !force {
if _, err := os.Stat(modDir); err == nil {
// Already exists.
return &LocalModule{ModuleName: dep.ModuleName, LocalPath: modDir, Version: dep.Version}, nil
}
}
mod, err := ResolveModule(ctx, dep.ModuleName)
if err != nil {
return nil, err
}
tmpModDir, err := dirs.ModuleCache(dep.ModuleName, fmt.Sprintf("tmp-%s", ids.NewRandomBase32ID(8)))
if err != nil {
return nil, err
}
srcDir := tmpModDir
defer func() {
if tmpModDir != "" {
os.RemoveAll(tmpModDir)
}
}()
if slices.Contains(publicRepos, mod.Repository) {
contents, err := compute.GetValue(ctx, download.UnverifiedURL(fmt.Sprintf("%s/archive/%s.zip", mod.Repository, dep.Version)))
if err != nil {
return nil, err
}
if err := tasks.Action("module.extract").Arg("module", mod.Repository).Arg("version", dep.Version).
Run(ctx, func(ctx context.Context) error {
return zipfs.UnzipContents(ctx, fnfs.ReadWriteLocalFS(tmpModDir), contents)
}); err != nil {
return nil, err
}
srcDir = filepath.Join(tmpModDir, fmt.Sprintf("%s-%s", filepath.Base(mod.Repository), dep.Version))
} else {
var cmd localexec.Command
cmd.Command = "git"
cmd.Args = []string{"clone", "-q", mod.Repository, tmpModDir}
cmd.AdditionalEnv = git.NoPromptEnv().Serialize()
cmd.Label = "git clone"
if err := cmd.Run(ctx); err != nil {
return nil, err
}
cmd.Args = []string{"reset", "-q", "--hard", dep.Version}
cmd.Label = "git reset"
cmd.Dir = tmpModDir
if err := cmd.Run(ctx); err != nil {
return nil, err
}
tmpModDir = "" // Inhibit the os.RemoveAll() above.
}
if force {
// Errors are ignored as the module directory may not exist, and if it doesn't
// and this fails, then Rename below will fail.
_ = os.RemoveAll(modDir)
}
if err := os.Rename(srcDir, modDir); err != nil {
return nil, err
}
return &LocalModule{ModuleName: dep.ModuleName, LocalPath: modDir, Version: dep.Version}, nil
})
}
type MissingModuleResolver interface {
Resolve(context.Context, schema.PackageName) (*schema.Workspace_Dependency, error)
}
type defaultMissingModuleResolver struct {
workspace cfg.Workspace
}
func (r *defaultMissingModuleResolver) Resolve(ctx context.Context, pkg schema.PackageName) (*schema.Workspace_Dependency, error) {
return nil, fnerrors.UsageError("Run `ns tidy`.", "%s: missing entry in %s: run:\n ns tidy", pkg, r.workspace.LoadedFrom().DefinitionFile)
}