-
Notifications
You must be signed in to change notification settings - Fork 19
/
grpc.go
358 lines (316 loc) · 11.1 KB
/
grpc.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
/*
* Copyright 2022 Aspect Build Systems, 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.
*/
// grpc.go hides all the complexity of doing the gRPC calls between the aspect
// Core and a Plugin implementation by providing simple abstractions from the
// point of view of Plugin maintainers.
package plugin
import (
"context"
"fmt"
goplugin "github.com/hashicorp/go-plugin"
"github.com/manifoldco/promptui"
"google.golang.org/grpc"
buildeventstream "aspect.build/cli/bazel/buildeventstream"
"aspect.build/cli/pkg/ioutils"
"aspect.build/cli/pkg/plugin/sdk/v1alpha2/proto"
)
// GRPCPlugin represents a Plugin that communicates over gRPC.
type GRPCPlugin struct {
goplugin.Plugin
Impl Plugin
}
// GRPCServer registers an instance of the GRPCServer in the Plugin binary.
func (p *GRPCPlugin) GRPCServer(broker *goplugin.GRPCBroker, s *grpc.Server) error {
proto.RegisterPluginServer(s, &GRPCServer{
Impl: p.Impl,
broker: broker,
commandManager: &PluginCommandManager{
commands: make(map[string]CustomCommandFn),
},
})
return nil
}
// GRPCClient returns a client to perform the RPC calls to the Plugin
// instance from the Core.
func (p *GRPCPlugin) GRPCClient(ctx context.Context, broker *goplugin.GRPCBroker, c *grpc.ClientConn) (interface{}, error) {
return &GRPCClient{client: proto.NewPluginClient(c), broker: broker}, nil
}
// GRPCServer implements the gRPC server that runs on the Plugin instances.
type GRPCServer struct {
Impl Plugin
broker *goplugin.GRPCBroker
commandManager CommandManager
}
// BEPEventCallback translates the gRPC call to the Plugin BEPEventCallback
// implementation.
func (m *GRPCServer) BEPEventCallback(
ctx context.Context,
req *proto.BEPEventCallbackReq,
) (*proto.BEPEventCallbackRes, error) {
return &proto.BEPEventCallbackRes{}, m.Impl.BEPEventCallback(req.Event)
}
// Setup translates the gRPC call to the Plugin Setup implementation.
func (m *GRPCServer) Setup(
ctx context.Context,
req *proto.SetupReq,
) (*proto.SetupRes, error) {
return &proto.SetupRes{}, m.Impl.Setup(req.Properties)
}
// PostBuildHook translates the gRPC call to the Plugin PostBuildHook
// implementation. It starts a prompt runner that is passed to the Plugin
// instance to be able to perform prompt actions to the CLI user.
func (m *GRPCServer) PostBuildHook(
ctx context.Context,
req *proto.PostBuildHookReq,
) (*proto.PostBuildHookRes, error) {
conn, err := m.broker.Dial(req.BrokerId)
if err != nil {
return nil, err
}
defer conn.Close()
client := proto.NewPrompterClient(conn)
prompter := &PrompterGRPCClient{client: client}
return &proto.PostBuildHookRes{},
m.Impl.PostBuildHook(req.IsInteractiveMode, prompter)
}
// CustomCommands translates the gRPC call to the Plugin CustomCommands
// implementation. It returns a list of commands that the plugin implements.
func (m *GRPCServer) CustomCommands(
ctx context.Context,
req *proto.CustomCommandsReq,
) (*proto.CustomCommandsRes, error) {
customCommands, err := m.Impl.CustomCommands()
if err != nil {
return nil, err
}
m.commandManager.Save(customCommands)
pbCommands := make([]*proto.Command, 0, len(customCommands))
for _, command := range customCommands {
pbCommands = append(pbCommands, command.Command)
}
pb := &proto.CustomCommandsRes{
Commands: pbCommands,
}
return pb, nil
}
// ExecuteCustomCommand translates the gRPC call to the sdk ExecuteCustomCommand
// implementation.
func (m *GRPCServer) ExecuteCustomCommand(
_ context.Context,
req *proto.ExecuteCustomCommandReq,
) (*proto.ExecuteCustomCommandRes, error) {
ctx := context.Background()
return &proto.ExecuteCustomCommandRes{},
m.commandManager.Execute(req.CustomCommand, ctx, req.Args)
}
// PostTestHook translates the gRPC call to the Plugin PostTestHook
// implementation. It starts a prompt runner that is passed to the Plugin
// instance to be able to perform prompt actions to the CLI user.
func (m *GRPCServer) PostTestHook(
ctx context.Context,
req *proto.PostTestHookReq,
) (*proto.PostTestHookRes, error) {
conn, err := m.broker.Dial(req.BrokerId)
if err != nil {
return nil, err
}
defer conn.Close()
client := proto.NewPrompterClient(conn)
prompter := &PrompterGRPCClient{client: client}
return &proto.PostTestHookRes{},
m.Impl.PostTestHook(req.IsInteractiveMode, prompter)
}
// PostRunHook translates the gRPC call to the Plugin PostRunHook
// implementation. It starts a prompt runner that is passed to the Plugin
// instance to be able to perform prompt actions to the CLI user.
func (m *GRPCServer) PostRunHook(
ctx context.Context,
req *proto.PostRunHookReq,
) (*proto.PostRunHookRes, error) {
conn, err := m.broker.Dial(req.BrokerId)
if err != nil {
return nil, err
}
defer conn.Close()
client := proto.NewPrompterClient(conn)
prompter := &PrompterGRPCClient{client: client}
return &proto.PostRunHookRes{},
m.Impl.PostRunHook(req.IsInteractiveMode, prompter)
}
// GRPCClient implements the gRPC client that is used by the Core to communicate
// with the Plugin instances.
type GRPCClient struct {
client proto.PluginClient
broker *goplugin.GRPCBroker
}
// BEPEventCallback is called from the Core to execute the Plugin
// BEPEventCallback.
func (m *GRPCClient) BEPEventCallback(event *buildeventstream.BuildEvent) error {
_, err := m.client.BEPEventCallback(context.Background(), &proto.BEPEventCallbackReq{Event: event})
return err
}
// Setup is called from the Core to execute the Plugin Setup.
func (m *GRPCClient) Setup(
properties []byte,
) error {
req := &proto.SetupReq{
Properties: properties,
}
_, err := m.client.Setup(context.Background(), req)
return err
}
// PostBuildHook is called from the Core to execute the Plugin PostBuildHook. It
// starts the prompt runner server with the provided PromptRunner.
func (m *GRPCClient) PostBuildHook(isInteractiveMode bool, promptRunner ioutils.PromptRunner) error {
prompterServer := &PrompterGRPCServer{promptRunner: promptRunner}
var s *grpc.Server
serverFunc := func(opts []grpc.ServerOption) *grpc.Server {
s = grpc.NewServer(opts...)
proto.RegisterPrompterServer(s, prompterServer)
return s
}
brokerID := m.broker.NextId()
go m.broker.AcceptAndServe(brokerID, serverFunc)
req := &proto.PostBuildHookReq{
BrokerId: brokerID,
IsInteractiveMode: isInteractiveMode,
}
_, err := m.client.PostBuildHook(context.Background(), req)
s.Stop()
return err
}
// CustomCommands is called from the Core to execute the Plugin CustomCommands.
// It returns a list of commands that the plugin implements.
func (m *GRPCClient) CustomCommands() ([]*Command, error) {
req := &proto.CustomCommandsReq{}
customCommandsPB, err := m.client.CustomCommands(context.Background(), req)
customCommands := make([]*Command, 0, len(customCommandsPB.Commands))
for _, pbCommand := range customCommandsPB.Commands {
customCommands = append(customCommands, &Command{Command: pbCommand})
}
return customCommands, err
}
// ExecuteCustomCommand is called from the Core to execute the sdk ExecuteCustomCommand.
func (m *GRPCClient) ExecuteCustomCommand(customCommand string, ctx context.Context, args []string) error {
pbContext := &proto.Context{}
req := &proto.ExecuteCustomCommandReq{
CustomCommand: customCommand,
Ctx: pbContext,
Args: args,
}
_, err := m.client.ExecuteCustomCommand(context.Background(), req)
return err
}
// PostTestHook is called from the Core to execute the Plugin PostTestHook. It
// starts the prompt runner server with the provided PromptRunner.
func (m *GRPCClient) PostTestHook(isInteractiveMode bool, promptRunner ioutils.PromptRunner) error {
prompterServer := &PrompterGRPCServer{promptRunner: promptRunner}
var s *grpc.Server
serverFunc := func(opts []grpc.ServerOption) *grpc.Server {
s = grpc.NewServer(opts...)
proto.RegisterPrompterServer(s, prompterServer)
return s
}
brokerID := m.broker.NextId()
go m.broker.AcceptAndServe(brokerID, serverFunc)
req := &proto.PostTestHookReq{
BrokerId: brokerID,
IsInteractiveMode: isInteractiveMode,
}
_, err := m.client.PostTestHook(context.Background(), req)
s.Stop()
return err
}
// PostRunHook is called from the Core to execute the Plugin PostRunHook. It
// starts the prompt runner server with the provided PromptRunner.
func (m *GRPCClient) PostRunHook(isInteractiveMode bool, promptRunner ioutils.PromptRunner) error {
prompterServer := &PrompterGRPCServer{promptRunner: promptRunner}
var s *grpc.Server
serverFunc := func(opts []grpc.ServerOption) *grpc.Server {
s = grpc.NewServer(opts...)
proto.RegisterPrompterServer(s, prompterServer)
return s
}
brokerID := m.broker.NextId()
go m.broker.AcceptAndServe(brokerID, serverFunc)
req := &proto.PostRunHookReq{
BrokerId: brokerID,
IsInteractiveMode: isInteractiveMode,
}
_, err := m.client.PostRunHook(context.Background(), req)
s.Stop()
return err
}
// PrompterGRPCServer implements the gRPC server that runs on the Core and is
// passed to the Plugin to allow prompt actions to the CLI user.
type PrompterGRPCServer struct {
promptRunner ioutils.PromptRunner
}
// Run translates the gRPC call to perform a prompt Run on the Core.
func (p *PrompterGRPCServer) Run(
ctx context.Context,
req *proto.PromptRunReq,
) (*proto.PromptRunRes, error) {
prompt := promptui.Prompt{
Label: req.GetLabel(),
Default: req.GetDefault(),
AllowEdit: req.GetAllowEdit(),
Mask: []rune(req.GetMask())[0],
HideEntered: req.GetHideEntered(),
IsConfirm: req.GetIsConfirm(),
IsVimMode: req.GetIsVimMode(),
}
result, err := p.promptRunner.Run(prompt)
res := &proto.PromptRunRes{Result: result}
if err != nil {
res.Error = &proto.PromptRunRes_Error{
Happened: true,
Message: err.Error(),
}
}
return res, nil
}
// PrompterGRPCClient implements the gRPC client that is used by the Plugin
// instance to communicate with the Core to request prompt actions from the
// user.
type PrompterGRPCClient struct {
client proto.PrompterClient
}
// Run is called from the Plugin to request the Core to run the given
// promptui.Prompt.
func (p *PrompterGRPCClient) Run(prompt promptui.Prompt) (string, error) {
label, isString := prompt.Label.(string)
if !isString {
return "", fmt.Errorf("label '%+v' must be a string", prompt.Label)
}
req := &proto.PromptRunReq{
Label: label,
Default: prompt.Default,
AllowEdit: prompt.AllowEdit,
Mask: string(prompt.Mask),
HideEntered: prompt.HideEntered,
IsConfirm: prompt.IsConfirm,
IsVimMode: prompt.IsVimMode,
}
res, err := p.client.Run(context.Background(), req)
if err != nil {
return "", err
}
if res.Error != nil && res.Error.Happened {
return "", fmt.Errorf(res.Error.Message)
}
return res.Result, nil
}