-
Notifications
You must be signed in to change notification settings - Fork 0
/
controller.go
700 lines (600 loc) · 20.8 KB
/
controller.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
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
package resource
import (
"errors"
"fmt"
"log"
"github.com/omniviewdev/settings"
"github.com/omniviewdev/plugin-sdk/pkg/resource/services"
"github.com/omniviewdev/plugin-sdk/pkg/resource/types"
pkgtypes "github.com/omniviewdev/plugin-sdk/pkg/types"
)
// ResourceController is responsible for managing the execution of resource operations.
// The resource controller will take in requests from requesters, both inside the IDE
// and outside, and will execute the necessary operations on the resource manager.
//
// This controller is the primary entrypoint for executing operations on resources, and
// operates as the plugin host for the installed resource plugin.
func NewResourceController[ClientT, InformerT any](
resourcerManager services.ResourcerManager[ClientT],
connectionManager services.ConnectionManager[ClientT],
resourceTypeManager services.ResourceTypeManager,
layoutManager services.LayoutManager,
informerOpts *types.InformerOptions[ClientT, InformerT],
settingsProvider settings.Provider,
) types.ResourceProvider {
controller := &resourceController[ClientT, InformerT]{
stopChan: make(chan struct{}),
resourcerManager: resourcerManager,
connectionManager: connectionManager,
resourceTypeManager: resourceTypeManager,
layoutManager: layoutManager,
settingsProvider: settingsProvider,
}
if informerOpts != nil {
controller.withInformer = true
controller.addChan = make(chan types.InformerAddPayload)
controller.updateChan = make(chan types.InformerUpdatePayload)
controller.deleteChan = make(chan types.InformerDeletePayload)
controller.informerManager = services.NewInformerManager(
informerOpts,
controller.addChan,
controller.updateChan,
controller.deleteChan,
)
}
return controller
}
type resourceController[ClientT, InformerT any] struct {
resourcerManager services.ResourcerManager[ClientT]
connectionManager services.ConnectionManager[ClientT]
resourceTypeManager services.ResourceTypeManager
layoutManager services.LayoutManager
settingsProvider settings.Provider
stopChan chan struct{}
informerManager *services.InformerManager[ClientT, InformerT]
addChan chan types.InformerAddPayload
updateChan chan types.InformerUpdatePayload
deleteChan chan types.InformerDeletePayload
withInformer bool
}
func (c *resourceController[ClientT, InformerT]) retrieveDynamicClientResourcer(
ctx *pkgtypes.PluginContext,
resource string,
) (*ClientT, types.DynamicResourcer[ClientT], error) {
var nilResourcer types.DynamicResourcer[ClientT]
// set up the plugin context
if ctx.Connection == nil {
return nil, nilResourcer, errors.New("connection is nil")
}
ctx.SetSettingsProvider(c.settingsProvider)
resourcer, err := c.resourcerManager.GetDynamicResourcer(resource)
if err != nil {
return nil, nilResourcer, fmt.Errorf(
"resourcer not found for resource type %s: %w",
resource,
err,
)
}
// 2. Get the client for the given resource namespace, ensuring it is of the correct type
client, err := c.connectionManager.GetCurrentConnectionClient(ctx)
if err != nil {
return nil, nilResourcer, fmt.Errorf(
"client unable to be retrieved for auth context %s: %w",
ctx.Connection.ID,
err,
)
}
return client, resourcer, nil
}
// get our client and resourcer outside to slim down the methods.
func (c *resourceController[ClientT, InformerT]) retrieveClientResourcer(
ctx *pkgtypes.PluginContext,
resource string,
) (*ClientT, types.Resourcer[ClientT], error) {
var nilResourcer types.Resourcer[ClientT]
if ctx.Connection == nil {
return nil, nilResourcer, errors.New("connection is nil")
}
// make sure we attach the current settings provider before calling the resourcer
ctx.SetSettingsProvider(c.settingsProvider)
// get the resourcer for the given resource type, and check type
if ok := c.resourceTypeManager.HasResourceType(resource); !ok {
return nil, nilResourcer, fmt.Errorf(
"resource type %s not found in resource type manager",
resource,
)
}
resourcer, err := c.resourcerManager.GetResourcer(resource)
if err != nil {
return nil, nilResourcer, fmt.Errorf(
"resourcer not found for resource type %s: %w",
resource,
err,
)
}
// 2. Get the client for the given resource namespace, ensuring it is of the correct type
client, err := c.connectionManager.GetCurrentConnectionClient(ctx)
if err != nil {
return nil, nilResourcer, fmt.Errorf(
"client unable to be retrieved for connection %s: %w",
ctx.Connection.ID,
err,
)
}
return client, resourcer, nil
}
// ================================= Operation Methods ================================= //
// TODO - combine the common logic for the operations here, lots of repetativeness
// Get gets a resource within a resource namespace given an identifier and input options.
func (c *resourceController[ClientT, InformerT]) Get(
ctx *pkgtypes.PluginContext,
resource string,
input types.GetInput,
) (*types.GetResult, error) {
var (
useDynamic bool
client *ClientT
resourcer types.Resourcer[ClientT]
dynamicResourcer types.DynamicResourcer[ClientT]
result *types.GetResult
err error
)
hasDynamic := c.resourcerManager.HasDynamicResourcers()
client, resourcer, err = c.retrieveClientResourcer(ctx, resource)
if err != nil && !hasDynamic {
return nil, fmt.Errorf("unable to retrieve client and resourcer: %w", err)
}
// check for dynamic resourcer
if err != nil && hasDynamic {
client, dynamicResourcer, err = c.retrieveDynamicClientResourcer(ctx, resource)
if err != nil {
return nil, fmt.Errorf("unable to retrieve dynamic client and resourcer: %w", err)
}
useDynamic = true
}
// execute the resourcer
if useDynamic {
result, err = dynamicResourcer.Get(
ctx,
client,
types.ResourceMetaFromString(resource),
input,
)
} else {
result, err = resourcer.Get(ctx, client, input)
}
if err != nil {
return nil, err
}
return result, nil
}
// List lists resources within a resource namespace given an identifier and input options.
func (c *resourceController[ClientT, InformerT]) List(
ctx *pkgtypes.PluginContext,
resource string,
input types.ListInput,
) (*types.ListResult, error) {
var (
useDynamic bool
client *ClientT
resourcer types.Resourcer[ClientT]
dynamicResourcer types.DynamicResourcer[ClientT]
result *types.ListResult
err error
)
hasDynamic := c.resourcerManager.HasDynamicResourcers()
client, resourcer, err = c.retrieveClientResourcer(ctx, resource)
if err != nil && !hasDynamic {
return nil, fmt.Errorf("unable to retrieve client and resourcer: %w", err)
}
// check for dynamic resourcer
if err != nil && hasDynamic {
client, dynamicResourcer, err = c.retrieveDynamicClientResourcer(ctx, resource)
if err != nil {
return nil, fmt.Errorf("unable to retrieve dynamic client and resourcer: %w", err)
}
useDynamic = true
}
// execute the resourcer
if useDynamic {
result, err = dynamicResourcer.List(
ctx,
client,
types.ResourceMetaFromString(resource),
input,
)
} else {
result, err = resourcer.List(ctx, client, input)
}
if err != nil {
return nil, err
}
return result, nil
}
// Find finds resources within a resource namespace given an identifier and input options.
func (c *resourceController[ClientT, InformerT]) Find(
ctx *pkgtypes.PluginContext,
resource string,
input types.FindInput,
) (*types.FindResult, error) {
var (
useDynamic bool
client *ClientT
resourcer types.Resourcer[ClientT]
dynamicResourcer types.DynamicResourcer[ClientT]
result *types.FindResult
err error
)
hasDynamic := c.resourcerManager.HasDynamicResourcers()
client, resourcer, err = c.retrieveClientResourcer(ctx, resource)
if err != nil && !hasDynamic {
return nil, fmt.Errorf("unable to retrieve client and resourcer: %w", err)
}
// check for dynamic resourcer
if err != nil && hasDynamic {
client, dynamicResourcer, err = c.retrieveDynamicClientResourcer(ctx, resource)
if err != nil {
return nil, fmt.Errorf("unable to retrieve dynamic client and resourcer: %w", err)
}
useDynamic = true
}
// execute the resourcer
if useDynamic {
result, err = dynamicResourcer.Find(
ctx,
client,
types.ResourceMetaFromString(resource),
input,
)
} else {
result, err = resourcer.Find(ctx, client, input)
}
if err != nil {
return nil, err
}
return result, nil
}
// Create creates a resource within a resource namespace given an identifier and input options.
func (c *resourceController[ClientT, InformerT]) Create(
ctx *pkgtypes.PluginContext,
resource string,
input types.CreateInput,
) (*types.CreateResult, error) {
var (
useDynamic bool
client *ClientT
resourcer types.Resourcer[ClientT]
dynamicResourcer types.DynamicResourcer[ClientT]
result *types.CreateResult
err error
)
hasDynamic := c.resourcerManager.HasDynamicResourcers()
client, resourcer, err = c.retrieveClientResourcer(ctx, resource)
if err != nil && !hasDynamic {
return nil, fmt.Errorf("unable to retrieve client and resourcer: %w", err)
}
// check for dynamic resourcer
if err != nil && hasDynamic {
client, dynamicResourcer, err = c.retrieveDynamicClientResourcer(ctx, resource)
if err != nil {
return nil, fmt.Errorf("unable to retrieve dynamic client and resourcer: %w", err)
}
useDynamic = true
}
// execute the resourcer
if useDynamic {
result, err = dynamicResourcer.Create(
ctx,
client,
types.ResourceMetaFromString(resource),
input,
)
} else {
result, err = resourcer.Create(ctx, client, input)
}
if err != nil {
return nil, err
}
return result, nil
}
// Update updates a resource within a resource namespace given an identifier and input options.
func (c *resourceController[ClientT, InformerT]) Update(
ctx *pkgtypes.PluginContext,
resource string,
input types.UpdateInput,
) (*types.UpdateResult, error) {
var (
useDynamic bool
client *ClientT
resourcer types.Resourcer[ClientT]
dynamicResourcer types.DynamicResourcer[ClientT]
result *types.UpdateResult
err error
)
hasDynamic := c.resourcerManager.HasDynamicResourcers()
client, resourcer, err = c.retrieveClientResourcer(ctx, resource)
if err != nil && !hasDynamic {
return nil, fmt.Errorf("unable to retrieve client and resourcer: %w", err)
}
// check for dynamic resourcer
if err != nil && hasDynamic {
client, dynamicResourcer, err = c.retrieveDynamicClientResourcer(ctx, resource)
if err != nil {
return nil, fmt.Errorf("unable to retrieve dynamic client and resourcer: %w", err)
}
useDynamic = true
}
// execute the resourcer
if useDynamic {
result, err = dynamicResourcer.Update(
ctx,
client,
types.ResourceMetaFromString(resource),
input,
)
} else {
result, err = resourcer.Update(ctx, client, input)
}
if err != nil {
return nil, err
}
return result, nil
}
// Delete deletes a resource within a resource namespace given an identifier and input options.
func (c *resourceController[ClientT, InformerT]) Delete(
ctx *pkgtypes.PluginContext,
resource string,
input types.DeleteInput,
) (*types.DeleteResult, error) {
var (
useDynamic bool
client *ClientT
resourcer types.Resourcer[ClientT]
dynamicResourcer types.DynamicResourcer[ClientT]
result *types.DeleteResult
err error
)
hasDynamic := c.resourcerManager.HasDynamicResourcers()
client, resourcer, err = c.retrieveClientResourcer(ctx, resource)
if err != nil && !hasDynamic {
return nil, fmt.Errorf("unable to retrieve client and resourcer: %w", err)
}
// check for dynamic resourcer
if err != nil && hasDynamic {
client, dynamicResourcer, err = c.retrieveDynamicClientResourcer(ctx, resource)
if err != nil {
return nil, fmt.Errorf("unable to retrieve dynamic client and resourcer: %w", err)
}
useDynamic = true
}
// execute the resourcer
if useDynamic {
result, err = dynamicResourcer.Delete(
ctx,
client,
types.ResourceMetaFromString(resource),
input,
)
} else {
result, err = resourcer.Delete(ctx, client, input)
}
if err != nil {
return nil, err
}
return result, nil
}
// ================================= Informer Methods ================================= //
func (c *resourceController[ClientT, InformerT]) HasInformer(
ctx *pkgtypes.PluginContext,
connectionID string,
) bool {
return c.informerManager.HasInformer(ctx, connectionID)
}
// StartContextInformer signals to the listen runner to start the informer for the given context.
// If the informer is not enabled, this method will return a nil error.
//
// This typically should not be called by the client, but there may be situations where we need
// to start the informer manually. This gets handled on the StartConnection method.
func (c *resourceController[ClientT, InformerT]) StartConnectionInformer(
ctx *pkgtypes.PluginContext,
connectionID string,
) error {
if !c.withInformer {
// safety guard just in case
return nil
}
// setup plugin context
ctx.SetSettingsProvider(c.settingsProvider)
if err := c.connectionManager.InjectConnection(ctx, connectionID); err != nil {
return fmt.Errorf("unable to inject connection: %w", err)
}
client, err := c.connectionManager.GetConnectionClient(ctx, connectionID)
if err != nil {
return fmt.Errorf("unable to get connection client: %w", err)
}
// first create the connection informer
if err = c.informerManager.CreateConnectionInformer(ctx, ctx.Connection, client); err != nil {
return err
}
// get all the resource types
resourceTypes := c.GetResourceTypes(connectionID)
for _, resource := range resourceTypes {
if err = c.informerManager.RegisterResource(ctx, ctx.Connection, resource); err != nil {
return fmt.Errorf("unable to register resource: %w", err)
}
}
// finally, start it
return c.informerManager.StartConnection(ctx, connectionID)
}
// StopContextInformer signals to the listen runner to stop the informer for the given context.
func (c *resourceController[ClientT, InformerT]) StopConnectionInformer(
ctx *pkgtypes.PluginContext,
connectionID string,
) error {
if !c.withInformer {
// safety guard just in case
return nil
}
if err := c.connectionManager.InjectConnection(ctx, connectionID); err != nil {
return fmt.Errorf("unable to inject connection: %w", err)
}
ctx.SetSettingsProvider(c.settingsProvider)
if err := c.informerManager.StopConnection(ctx, connectionID); err != nil {
return fmt.Errorf("unable to stop connection: %w", err)
}
// remake the client
return c.connectionManager.RefreshConnectionClient(ctx, connectionID)
}
// ListenForEvents listens for events from the informer and sends them to the given event channels.
// This method will block until the context is cancelled, and given this will block, the parent
// gRPC plugin host will spin this up in a goroutine.
func (c *resourceController[ClientT, InformerT]) ListenForEvents(
ctx *pkgtypes.PluginContext,
addChan chan types.InformerAddPayload,
updateChan chan types.InformerUpdatePayload,
deleteChan chan types.InformerDeletePayload,
) error {
if !c.withInformer {
log.Println("informer not enabled")
return nil
}
ctx.SetSettingsProvider(c.settingsProvider)
if err := c.informerManager.Run(c.stopChan, addChan, updateChan, deleteChan); err != nil {
log.Println("error running informer manager:", err)
return fmt.Errorf("error running informer manager: %w", err)
}
return nil
}
// ================================= Connection Methods ================================= //
// StartConnection starts a connection, initializing any informers as necessary.
func (c *resourceController[ClientT, InformerT]) StartConnection(
ctx *pkgtypes.PluginContext,
connectionID string,
) (pkgtypes.ConnectionStatus, error) {
ctx.SetSettingsProvider(c.settingsProvider)
conn, err := c.connectionManager.StartConnection(ctx, connectionID)
if err != nil {
return conn, fmt.Errorf("unable to start connection: %w", err)
}
// don't start the informer if the connection is not connected and valid
if conn.Status != pkgtypes.ConnectionStatusConnected {
return conn, nil
}
// sync the resource types
if err := c.resourceTypeManager.SyncConnection(ctx, conn.Connection); err != nil {
conn.Status = pkgtypes.ConnectionStatusError
conn.Error = err.Error()
conn.Details = "Unable to sync connection"
return conn, nil
}
// check if has informer. if so, start it
return conn, c.StartConnectionInformer(ctx, connectionID)
}
// StopConnection stops a connection, stopping any informers as necessary.
func (c *resourceController[ClientT, InformerT]) StopConnection(
ctx *pkgtypes.PluginContext,
connectionID string,
) (pkgtypes.Connection, error) {
ctx.SetSettingsProvider(c.settingsProvider)
if err := c.StopConnectionInformer(ctx, connectionID); err != nil {
return pkgtypes.Connection{}, fmt.Errorf("unable to stop connection informer: %w", err)
}
return c.connectionManager.StopConnection(ctx, connectionID)
}
// LoadConnections calls the custom connection loader func to provide the the IDE the possible connections
// available.
func (c *resourceController[ClientT, InformerT]) LoadConnections(
ctx *pkgtypes.PluginContext,
) ([]pkgtypes.Connection, error) {
ctx.SetSettingsProvider(c.settingsProvider)
return c.connectionManager.LoadConnections(ctx)
}
// ListConnections calls the custom connection loader func to provide the the IDE the possible connections.
func (c *resourceController[ClientT, InformerT]) ListConnections(
ctx *pkgtypes.PluginContext,
) ([]pkgtypes.Connection, error) {
ctx.SetSettingsProvider(c.settingsProvider)
return c.connectionManager.ListConnections(ctx)
}
// GetConnection gets a connection by its ID.
func (c *resourceController[ClientT, InformerT]) GetConnection(
ctx *pkgtypes.PluginContext,
connectionID string,
) (pkgtypes.Connection, error) {
ctx.SetSettingsProvider(c.settingsProvider)
return c.connectionManager.GetConnection(ctx, connectionID)
}
// GetConnectionNamespaces get's the list of namespaces for the connection.
func (c *resourceController[ClientT, InformerT]) GetConnectionNamespaces(
ctx *pkgtypes.PluginContext,
connectionID string,
) ([]string, error) {
ctx.SetSettingsProvider(c.settingsProvider)
return c.connectionManager.GetConnectionNamespaces(ctx, connectionID)
}
// UpdateConnection updates a connection by its ID.
func (c *resourceController[ClientT, InformerT]) UpdateConnection(
ctx *pkgtypes.PluginContext,
connection pkgtypes.Connection,
) (pkgtypes.Connection, error) {
ctx.SetSettingsProvider(c.settingsProvider)
return c.connectionManager.UpdateConnection(ctx, connection)
}
// DeleteConnection deletes a connection by its ID.
func (c *resourceController[ClientT, InformerT]) DeleteConnection(
ctx *pkgtypes.PluginContext,
connectionID string,
) error {
ctx.SetSettingsProvider(c.settingsProvider)
return c.connectionManager.DeleteConnection(ctx, connectionID)
}
// ================================= Resource Type Methods ================================= //
// GetResourceGroups gets the resource groups available to the resource controller.
func (c *resourceController[ClientT, InformerT]) GetResourceGroups(
connID string,
) map[string]types.ResourceGroup {
return c.resourceTypeManager.GetGroups(connID)
}
// GetResourceGroup gets the resource group by its name.
func (c *resourceController[ClientT, InformerT]) GetResourceGroup(
name string,
) (types.ResourceGroup, error) {
return c.resourceTypeManager.GetGroup(name)
}
// GetResourceTypes gets the resource types available to the resource controller.
func (c *resourceController[ClientT, InformerT]) GetResourceTypes(
connID string,
) map[string]types.ResourceMeta {
return c.resourceTypeManager.GetResourceTypes(connID)
}
// GetResourceType gets the resource type information by its string representation.
func (c *resourceController[ClientT, InformerT]) GetResourceType(
resource string,
) (*types.ResourceMeta, error) {
return c.resourceTypeManager.GetResourceType(resource)
}
// HasResourceType checks to see if the resource type exists.
func (c *resourceController[ClientT, InformerT]) HasResourceType(resource string) bool {
return c.resourceTypeManager.HasResourceType(resource)
}
// GetResourceDefinition gets the resource definition for the resource type.
func (c *resourceController[ClientT, InformerT]) GetResourceDefinition(
resource string,
) (types.ResourceDefinition, error) {
return c.resourceTypeManager.GetResourceDefinition(resource)
}
// ================================= Resource Type Methods ================================= //
func (c *resourceController[ClientT, InformerT]) GetLayout(
layoutID string,
) ([]types.LayoutItem, error) {
return c.layoutManager.GetLayout(layoutID)
}
func (c *resourceController[ClientT, InformerT]) GetDefaultLayout() ([]types.LayoutItem, error) {
return c.layoutManager.GetDefaultLayout()
}
func (c *resourceController[ClientT, InformerT]) SetLayout(
id string,
layout []types.LayoutItem,
) error {
return c.layoutManager.SetLayout(id, layout)
}