communicate

package
v0.0.72 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 27, 2023 License: MIT Imports: 6 Imported by: 4

README

How does communication between the CLI and the Agent work?

Disclaimer: Looked briefly at bidirectional communication with Hashicorp plugin model but tabled that for now https://github.com/hashicorp/go-plugin/tree/main/examples/bidirectional

Goal here is to make the API somewhat clean to that we can move to this model later if needed.

Terminology

Since the CLI is the one that initiates the communication, we will call it the client and the agent the server.

Flows
  • Client asks server if communication is required for a given channel
  • If no, client proceeds with the command
  • If yes, client start a communication session with the server until the server is satisfied
Communication session
  • Client sends an initial Information request to the server
  • Server sends back an InformationRequest
  • Client processes the InformationRequest with a handler (CLI prompt) and returns an Answer
  • The Answer is sent back to the server
  • If satisfied, the server communicates back that it is done
  • Otherwise, we repeat the process until the server is satisfied

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Channel added in v0.0.51 

func Channel[T any]() *agentv1.Channel

func Display added in v0.0.51 

func Display(msg *agentv1.Message, data map[string]string) *agentv1.Question

func Do added in v0.0.51 

func Do[T any](ctx context.Context, agent Communicate, handler AnswerProvider) error

func NewChoice added in v0.0.51 

func NewChoice(msg *agentv1.Message, options ...*agentv1.Message) *agentv1.Question

func NewConfirm added in v0.0.51 

func NewConfirm(msg *agentv1.Message, defaultConfirm bool) *agentv1.Question

func NewSelection added in v0.0.51 

func NewSelection(msg *agentv1.Message, options ...*agentv1.Message) *agentv1.Question

func NewStringInput added in v0.0.51 

func NewStringInput(msg *agentv1.Message, defaultValue string) *agentv1.Question

func StateAsString 

func StateAsString(s *agentv1.Answer) string

Types

type AnswerProvider added in v0.0.51 

type AnswerProvider interface {
	Answer(ctx context.Context, question *agentv1.Question) (*agentv1.Answer, error)
}

type ClientSession added in v0.0.51 

type ClientSession struct {
	// contains filtered or unexported fields
}

func NewClientSession added in v0.0.51 

func NewClientSession(channel *agentv1.Channel, handler AnswerProvider) *ClientSession

func (*ClientSession) Engage added in v0.0.51 

func (s *ClientSession) Engage(ctx context.Context, req *agentv1.InformationRequest) (*agentv1.Engage, error)

type Communicate added in v0.0.51 

type Communicate interface {
	Communicate(ctx context.Context, req *agentv1.Engage) (*agentv1.InformationRequest, error)
}

type Generator added in v0.0.51 

type Generator struct {
	Kind              string
	QuestionGenerator QuestionGenerator
}

func New added in v0.0.51 

func New[T any](gen QuestionGenerator) *Generator

type QuestionGenerator added in v0.0.51 

type QuestionGenerator interface {
	Ready() bool
	Process(ctx context.Context, req *agentv1.Engage) (*agentv1.InformationRequest, error)
}

type Sequence 

type Sequence struct {
	// contains filtered or unexported fields
}

func NewSequence 

func NewSequence(qs ...*agentv1.Question) *Sequence

func (*Sequence) Process 

func (s *Sequence) Process(_ context.Context, _ *agentv1.Engage) (*agentv1.InformationRequest, error)

func (*Sequence) Ready 

func (s *Sequence) Ready() bool

type Server added in v0.0.51 

type Server struct {
	// contains filtered or unexported fields
}

Server is the Agent

func NewServer added in v0.0.51 

func NewServer(_ context.Context) *Server

func (*Server) Communicate added in v0.0.51 

func (m *Server) Communicate(ctx context.Context, req *agentv1.Engage) (*agentv1.InformationRequest, error)

Communicate from the generator and sends back information request required

func (*Server) Done added in v0.0.51 

func (m *Server) Done(ctx context.Context, channel *agentv1.Channel) (*ServerSession, error)

func (*Server) Ready added in v0.0.51 

func (m *Server) Ready(s string) bool

func (*Server) Register added in v0.0.51 

func (m *Server) Register(ctx context.Context, generator *Generator) error

func (*Server) RequiresCommunication added in v0.0.51 

func (m *Server) RequiresCommunication(channel *agentv1.Channel) (*ServerContext, bool)

type ServerContext 

type ServerContext struct {
	// contains filtered or unexported fields
}

func NewServerContext 

func NewServerContext(_ context.Context, gen QuestionGenerator) *ServerContext

func (*ServerContext) Communicate 

func (c *ServerContext) Communicate(ctx context.Context, req *agentv1.Engage) (*agentv1.InformationRequest, error)

func (*ServerContext) Done 

func (c *ServerContext) Done() bool

type ServerSession added in v0.0.51 

type ServerSession struct {
	// contains filtered or unexported fields
}

func NewServerSession added in v0.0.51 

func NewServerSession(generator QuestionGenerator) *ServerSession

func (*ServerSession) Confirm added in v0.0.51 

func (c *ServerSession) Confirm(stage string) (bool, error)

func (*ServerSession) GetInputString added in v0.0.51 

func (c *ServerSession) GetInputString(stage string) (string, error)

func (*ServerSession) Input added in v0.0.51 

func (c *ServerSession) Input(stage string) (*agentv1.InputAnswer, error)

func (*ServerSession) Process added in v0.0.51 

func (c *ServerSession) Process(ctx context.Context, eng *agentv1.Engage) (*agentv1.InformationRequest, error)

func (*ServerSession) Ready added in v0.0.51 

func (c *ServerSession) Ready() bool

func (*ServerSession) Selection added in v0.0.51 

func (c *ServerSession) Selection(stage string) (*agentv1.SelectionAnswer, error)

func (*ServerSession) String added in v0.0.51 

func (c *ServerSession) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.