-
Notifications
You must be signed in to change notification settings - Fork 8
/
parse.go
242 lines (201 loc) · 6.3 KB
/
parse.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
// 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 protos
import (
"fmt"
"io"
"io/fs"
"os"
"path/filepath"
"sort"
"strings"
dpb "github.com/golang/protobuf/protoc-gen-go/descriptor"
"github.com/jhump/protoreflect/desc"
"github.com/jhump/protoreflect/desc/protoparse"
"google.golang.org/protobuf/types/descriptorpb"
"namespacelabs.dev/foundation/internal/fnerrors"
"namespacelabs.dev/foundation/internal/uniquestrings"
"namespacelabs.dev/foundation/internal/workspace/dirs"
"sigs.k8s.io/yaml"
// Include descriptors for generated googleapis.
_ "google.golang.org/genproto/googleapis/api/annotations"
_ "google.golang.org/genproto/googleapis/rpc/status"
)
type ParseOpts struct {
KnownModules []struct {
ModuleName string
FS fs.FS
}
}
type bufWork struct {
Directories []string `json:"directories"`
}
func (opts ParseOpts) Parse(fsys fs.FS, files []string) (*FileDescriptorSetAndDeps, error) {
importPaths := []string{"."}
bufWorkData, err := fs.ReadFile(fsys, "buf.work.yaml")
if err != nil {
if !os.IsNotExist(err) {
return nil, fnerrors.New("failed to load buf.work.yaml: %w", err)
}
} else {
var bw bufWork
if err := yaml.Unmarshal(bufWorkData, &bw); err != nil {
return nil, fnerrors.New("failed to parse buf.work.yaml: %w", err)
}
importPaths = append(importPaths, bw.Directories...)
}
p := protoparse.Parser{
ImportPaths: importPaths,
IncludeSourceCodeInfo: true,
Accessor: func(filename string) (io.ReadCloser, error) {
return fsys.Open(filename)
},
LookupImport: func(path string) (*desc.FileDescriptor, error) {
// We're explicit about what protos are exposed here, as not all
// proto tooling will handling this well.
if filepath.Dir(path) == "google/api" || filepath.Dir(path) == "google/rpc" {
return desc.LoadFileDescriptor(path)
}
for _, known := range opts.KnownModules {
if rel := strings.TrimPrefix(path, known.ModuleName+"/"); rel != path {
x, err := opts.Parse(known.FS, []string{rel})
if err != nil {
return nil, err
}
// We need to patch paths, so proto linking can succeed.
for _, file := range x.AsFileDescriptorSet().File {
// XXX this is a poor heuristic; likely too broad.
if strings.HasPrefix(file.GetName(), "google/") {
continue
}
patchedName := fmt.Sprintf("%s/%s", known.ModuleName, file.GetName())
file.Name = &patchedName
for k, dep := range file.Dependency {
// XXX see above.
if strings.HasPrefix(dep, "google/") {
continue
}
patchedName := fmt.Sprintf("%s/%s", known.ModuleName, dep)
file.Dependency[k] = patchedName
}
}
return toFileDescriptor(x.File[0], x.Dependency)
}
}
// It's important to return an error, so the nil value is not used.
return nil, fnerrors.New("no such file %s", path)
},
}
expandedFiles, err := expandProtoList(fsys, files)
if err != nil {
return nil, err
}
descs, err := p.ParseFiles(expandedFiles...)
if err != nil {
return nil, fnerrors.BadInputError("proto parse failed of %q: %w", expandedFiles, err)
}
protos := protoList{refs: map[string]*dpb.FileDescriptorProto{}}
protoDeps := protoList{refs: map[string]*dpb.FileDescriptorProto{}}
for _, desc := range descs {
protos.add(desc.AsFileDescriptorProto())
}
for _, desc := range descs {
protoDeps.addDeps(&protos, desc)
}
return &FileDescriptorSetAndDeps{File: protos.sorted(), Dependency: protoDeps.sorted()}, nil
}
// XXX this is O(n^2)
func toFileDescriptor(file *descriptorpb.FileDescriptorProto, deps []*descriptorpb.FileDescriptorProto) (*desc.FileDescriptor, error) {
var parsedDeps []*desc.FileDescriptor
for _, dep := range file.GetDependency() {
var found *descriptorpb.FileDescriptorProto
for _, d := range deps {
if d.GetName() == dep {
found = d
break
}
}
if found == nil {
return nil, fnerrors.New("%s: missing dependency %q", file.GetName(), dep)
}
parsed, err := toFileDescriptor(found, deps)
if err != nil {
return nil, err
}
parsedDeps = append(parsedDeps, parsed)
}
res, err := desc.CreateFileDescriptor(file, parsedDeps...)
if err != nil {
return nil, fnerrors.New("failed to parse descriptor: %w", err)
}
return res, nil
}
type Location interface {
Rel(...string) string
}
func (opts ParseOpts) ParseAtLocation(fsys fs.FS, loc Location, files []string) (*FileDescriptorSetAndDeps, error) {
var protosrcs uniquestrings.List
for _, srcfile := range files {
protosrcs.Add(loc.Rel(srcfile))
}
return opts.Parse(fsys, protosrcs.Strings())
}
type protoList struct {
protos []*dpb.FileDescriptorProto
refs map[string]*dpb.FileDescriptorProto // map filename -> FileDescriptorProto to keep track of dups
}
func (pl *protoList) add(fproto *dpb.FileDescriptorProto) {
if _, has := pl.refs[fproto.GetName()]; !has {
pl.refs[fproto.GetName()] = fproto
pl.protos = append(pl.protos, fproto)
}
}
func (pl *protoList) addDeps(check *protoList, desc *desc.FileDescriptor) {
for _, dep := range desc.GetDependencies() {
x := dep.AsFileDescriptorProto()
if !check.has(x) {
pl.add(dep.AsFileDescriptorProto())
}
pl.addDeps(check, dep)
}
}
func (pl *protoList) has(fproto *dpb.FileDescriptorProto) bool {
_, has := pl.refs[fproto.GetName()]
return has
}
func (pl *protoList) sorted() []*dpb.FileDescriptorProto {
sort.Slice(pl.protos, func(i, j int) bool {
return strings.Compare(pl.protos[i].GetName(), pl.protos[j].GetName()) < 0
})
return pl.protos
}
func expandProtoList(fsys fs.FS, paths []string) ([]string, error) {
var ret []string
for _, path := range paths {
st, err := fs.Stat(fsys, path)
if err != nil {
return nil, err
}
if st.IsDir() {
dirents, err := fs.ReadDir(fsys, path)
if err != nil {
return nil, err
}
var children []string
for _, dirent := range dirents {
if !dirs.IsExcludedAsSource(path) && (dirent.IsDir() || filepath.Ext(dirent.Name()) == ".proto") {
children = append(children, filepath.Join(path, dirent.Name()))
}
}
further, err := expandProtoList(fsys, children)
if err != nil {
return nil, err
}
ret = append(ret, further...)
} else {
ret = append(ret, path)
}
}
return ret, nil
}