-
Notifications
You must be signed in to change notification settings - Fork 265
/
module.go
200 lines (184 loc) · 5.28 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
// Copyright 2020-2021 Buf Technologies, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package bufmodule
import (
"context"
"fmt"
"io"
modulev1alpha1 "github.com/bufbuild/buf/private/gen/proto/go/buf/alpha/module/v1alpha1"
"github.com/bufbuild/buf/private/pkg/storage"
"github.com/bufbuild/buf/private/pkg/storage/storagemem"
"go.uber.org/multierr"
)
type module struct {
sourceReadBucket storage.ReadBucket
dependencyModulePins []ModulePin
moduleIdentity ModuleIdentity
commit string
documentation string
}
func newModuleForProto(
ctx context.Context,
protoModule *modulev1alpha1.Module,
options ...ModuleOption,
) (*module, error) {
if err := ValidateProtoModule(protoModule); err != nil {
return nil, err
}
readBucketBuilder := storagemem.NewReadBucketBuilder()
for _, moduleFile := range protoModule.Files {
// we already know that paths are unique from validation
if err := storage.PutPath(ctx, readBucketBuilder, moduleFile.Path, moduleFile.Content); err != nil {
return nil, err
}
}
if docs := protoModule.GetDocumentation(); docs != "" {
if err := storage.PutPath(ctx, readBucketBuilder, DocumentationFilePath, []byte(docs)); err != nil {
return nil, err
}
}
sourceReadBucket, err := readBucketBuilder.ToReadBucket()
if err != nil {
return nil, err
}
dependencyModulePins, err := NewModulePinsForProtos(protoModule.Dependencies...)
if err != nil {
return nil, err
}
return newModuleForBucketWithDependencyModulePins(
ctx,
sourceReadBucket,
dependencyModulePins,
options...,
)
}
func newModuleForBucket(
ctx context.Context,
sourceReadBucket storage.ReadBucket,
options ...ModuleOption,
) (*module, error) {
dependencyModulePins, err := getDependencyModulePinsForBucket(ctx, sourceReadBucket)
if err != nil {
return nil, err
}
return newModuleForBucketWithDependencyModulePins(
ctx,
sourceReadBucket,
dependencyModulePins,
options...,
)
}
func newModuleForBucketWithDependencyModulePins(
ctx context.Context,
sourceReadBucket storage.ReadBucket,
dependencyModulePins []ModulePin,
options ...ModuleOption,
) (_ *module, retErr error) {
if err := ValidateModulePinsUniqueByIdentity(dependencyModulePins); err != nil {
return nil, err
}
documentationReader, err := sourceReadBucket.Get(ctx, DocumentationFilePath)
// we allow the lack of documentation file
if err != nil && !storage.IsNotExist(err) {
return nil, err
}
documentationContents := ""
if documentationReader != nil {
defer func() {
retErr = multierr.Append(retErr, documentationReader.Close())
}()
documentationBytes, err := io.ReadAll(documentationReader)
if err != nil {
return nil, err
}
documentationContents = string(documentationBytes)
}
// we rely on this being sorted here
SortModulePins(dependencyModulePins)
module := &module{
sourceReadBucket: storage.MapReadBucket(sourceReadBucket, storage.MatchPathExt(".proto")),
dependencyModulePins: dependencyModulePins,
documentation: documentationContents,
}
for _, option := range options {
option(module)
}
return module, nil
}
func (m *module) TargetFileInfos(ctx context.Context) ([]FileInfo, error) {
return m.SourceFileInfos(ctx)
}
func (m *module) SourceFileInfos(ctx context.Context) ([]FileInfo, error) {
var fileInfos []FileInfo
if walkErr := m.sourceReadBucket.Walk(ctx, "", func(objectInfo storage.ObjectInfo) error {
// super overkill but ok
if err := ValidateModuleFilePath(objectInfo.Path()); err != nil {
return err
}
fileInfo, err := NewFileInfo(
objectInfo.Path(),
objectInfo.ExternalPath(),
false,
m.moduleIdentity,
m.commit,
)
if err != nil {
return err
}
fileInfos = append(fileInfos, fileInfo)
return nil
}); walkErr != nil {
return nil, fmt.Errorf("failed to enumerate module files: %w", walkErr)
}
sortFileInfos(fileInfos)
return fileInfos, nil
}
func (m *module) GetModuleFile(ctx context.Context, path string) (ModuleFile, error) {
// super overkill but ok
if err := ValidateModuleFilePath(path); err != nil {
return nil, err
}
readObjectCloser, err := m.sourceReadBucket.Get(ctx, path)
if err != nil {
return nil, err
}
fileInfo, err := NewFileInfo(
readObjectCloser.Path(),
readObjectCloser.ExternalPath(),
false,
m.moduleIdentity,
m.commit,
)
if err != nil {
return nil, err
}
return newModuleFile(fileInfo, readObjectCloser), nil
}
func (m *module) DependencyModulePins() []ModulePin {
// already sorted in constructor
return m.dependencyModulePins
}
func (m *module) Documentation() string {
return m.documentation
}
func (m *module) getSourceReadBucket() storage.ReadBucket {
return m.sourceReadBucket
}
func (m *module) getModuleIdentity() ModuleIdentity {
return m.moduleIdentity
}
func (m *module) getCommit() string {
return m.commit
}
func (m *module) isModule() {}