refactor: change plugin system to use gRPC

.github/workflows/proto-checker.yml

@@ -0,0 +1,31 @@
+name: Protobuf Files
+
+on:
+  pull_request:
+    paths:
+      - "proto/**"
+
+permissions:
+  contents: read
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v3
+      - uses: bufbuild/[email protected]
+      - uses: bufbuild/buf-lint-action@v1
+        with:
+          input: "proto"
+
+  # TODO: Uncomment after PR#3529 is merged
+  # break-check:
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - uses: actions/checkout@v3
+  #     - uses: bufbuild/[email protected]
+  #     - uses: bufbuild/buf-breaking-action@v1
+  #       with:
+  #         input: "proto"
+  #         against: "https://github.com/${{ github.repository }}.git#branch=${{ github.event.pull_request.base.ref }},ref=HEAD~1,subdir=proto"

.gitignore

@@ -2,7 +2,6 @@ scripts/**/nodetime-*
 dist/
 node_modules
 .DS_Store
-apps/
 .idea
 .vscode
 docs/.vuepress/dist

Makefile

@@ -59,6 +59,26 @@ lint:
 
 .PHONY: govet format lint
 
+## proto-all: Format, lint and generate code from proto files using buf.
+proto-all: proto-format proto-lint proto-gen
+
+## proto-gen: Run buf generate.
+proto-gen:
+	@echo Generating code from proto...
+	@buf generate --template ./proto/buf.gen.yaml --output ./
+
+## proto-format: Run buf format and update files with invalid proto format>
+proto-format:
+	@echo Formatting proto files...
+	@buf format --write
+
+## proto-lint: Run buf lint.
+proto-lint:
+	@echo Linting proto files...
+	@buf lint
+
+.PHONY: proto-all proto-gen proto-format proto-lint
+
 ## test-unit: Run the unit tests.
 test-unit:
 	@echo Running unit tests...

buf.work.yaml

@@ -0,0 +1,3 @@
+version: v1
+directories:
+  - proto

changelog.md

@@ -4,6 +4,17 @@
 
 ### Features
 
+- [#3544](https://github.com/ignite/cli/pull/3544) Add bidirectional communication to plugin system
+- [#3561](https://github.com/ignite/cli/pull/3561) Add GetChainInfo method to plugin system API
+
+### Changes
+
+- [#3529](https://github.com/ignite/cli/pull/3529) Refactor plugin system to use gRPC
+
+## [`v0.27.1`](https://github.com/ignite/cli/releases/tag/v0.27.1)
+
+### Features
+
 - [#3476](https://github.com/ignite/cli/pull/3476) Use `buf.build` binary to code generate from proto files
 - [#3614](https://github.com/ignite/cli/pull/3614) feat: use DefaultBaseappOptions for app.New method
 - [#3536](https://github.com/ignite/cli/pull/3536) Change app.go to v2 and add AppWiring feature

docs/docs/apps/02-developing-apps.md

@@ -43,31 +43,35 @@ All apps must implement a predefined interface:
 ```go title=ignite/services/plugin/interface.go
 type Interface interface {
 	// Manifest declares app's Command(s) and Hook(s).
-	Manifest() (Manifest, error)
+	Manifest(context.Context) (*Manifest, error)
 
 	// Execute will be invoked by ignite when an app Command is executed.
 	// It is global for all commands declared in Manifest, if you have declared
 	// multiple commands, use cmd.Path to distinguish them.
-	Execute(cmd ExecutedCommand) error
+	// The ClientAPI argument can be used by plugins to get chain app analysis info.
+	Execute(context.Context, *ExecutedCommand, ClientAPI) error
 
 	// ExecuteHookPre is invoked by ignite when a command specified by the Hook
 	// path is invoked.
 	// It is global for all hooks declared in Manifest, if you have declared
 	// multiple hooks, use hook.Name to distinguish them.
-	ExecuteHookPre(hook ExecutedHook) error
+	// The ClientAPI argument can be used by plugins to get chain app analysis info.
+	ExecuteHookPre(context.Context, *ExecutedHook, ClientAPI) error
 
 	// ExecuteHookPost is invoked by ignite when a command specified by the hook
 	// path is invoked.
 	// It is global for all hooks declared in Manifest, if you have declared
 	// multiple hooks, use hook.Name to distinguish them.
-	ExecuteHookPost(hook ExecutedHook) error
+	// The ClientAPI argument can be used by plugins to get chain app analysis info.
+	ExecuteHookPost(context.Context, *ExecutedHook, ClientAPI) error
 
 	// ExecuteHookCleanUp is invoked by ignite when a command specified by the
 	// hook path is invoked. Unlike ExecuteHookPost, it is invoked regardless of
 	// execution status of the command and hooks.
 	// It is global for all hooks declared in Manifest, if you have declared
 	// multiple hooks, use hook.Name to distinguish them.
-	ExecuteHookCleanUp(hook ExecutedHook) error
+	// The ClientAPI argument can be used by plugins to get chain app analysis info.
+	ExecuteHookCleanUp(context.Context, *ExecutedHook, ClientAPI) error
 }
 ```
 
@@ -76,35 +80,34 @@ the method's body.
 
 ## Defining app's manifest
 
-Here is the `Manifest` struct:
-
-```go title=ignite/services/plugin/interface.go
-type Manifest struct {
-	Name string
-
-	// Commands contains the commands that will be added to the list of ignite
-	// commands. Each commands are independent, for nested commands use the
-	// inner Commands field.
-	Commands []Command
-
-	// Hooks contains the hooks that will be attached to the existing ignite
-	// commands.
-	Hooks []Hook
-
-	// SharedHost enables sharing a single app server across all running instances
-	// of an app. Useful if an app adds or extends long running commands
-	//
-	// Example: if an app defines a hook on `ignite chain serve`, a server is instanciated
-	// when the command is run. Now if you want to interact with that instance from commands
-	// defined in that app, you need to enable `SharedHost`, or else the commands will just
-	// instantiate separate app servers.
-	//
-	// When enabled, all apps of the same `Path` loaded from the same configuration will
-	// attach it's gRPC client to a an existing gRPC server.
-	//
-	// If an app instance has no other running app servers, it will create one and it
-	// will be the host.
-	SharedHost bool `yaml:"shared_host"`
+Here is the `Manifest` proto message definition:
+
+```protobuf title=proto/ignite/services/plugin/grpc/v1/types.proto
+message Manifest {
+  // App name.
+  string name = 1;
+
+  // Commands contains the commands that will be added to the list of ignite commands.
+  // Each commands are independent, for nested commands use the inner Commands field.
+  bool shared_host = 2;
+
+  // Hooks contains the hooks that will be attached to the existing ignite commands.
+  repeated Command commands = 3;
+
+  // Enables sharing a single app server across all running instances of an Ignite App.
+  // Useful if an app adds or extends long running commands.
+  //
+  // Example: if an app defines a hook on `ignite chain serve`, a server is instanciated
+  // when the command is run. Now if you want to interact with that instance
+  // from commands defined in that app, you need to enable shared host, or else the
+  // commands will just instantiate separate app servers.
+  //
+  // When enabled, all apps of the same path loaded from the same configuration will
+  // attach it's RPC client to a an existing RPC server.
+  //
+  // If an app instance has no other running app servers, it will create one and it
+  // will be the host.
+  repeated Hook hooks = 4;
 }
 ```
 
@@ -132,16 +135,16 @@ For instance, let's say your app adds a new `oracle` command to `ignite
 scaffold`, then the `Manifest` method will look like :
 
 ```go
-func (app) Manifest() (plugin.Manifest, error) {
-	return plugin.Manifest{
+func (app) Manifest(context.Context) (*plugin.Manifest, error) {
+	return &plugin.Manifest{
 		Name: "oracle",
-		Commands: []plugin.Command{
+		Commands: []*plugin.Command{
 			{
 				Use:   "oracle [name]",
 				Short: "Scaffold an oracle module",
 				Long:  "Long description goes here...",
 				// Optionnal flags is required
-				Flags: []plugin.Flag{
+				Flags: []*plugin.Flag{
 					{Name: "source", Type: plugin.FlagTypeString, Usage: "the oracle source"},
 				},
 				// Attach the command to `scaffold`
@@ -156,14 +159,21 @@ To update the app execution, you have to change the `Execute` command. For
 example:
 
 ```go
-func (app) Execute(cmd plugin.ExecutedCommand) error {
+func (app) Execute(_ context.Context, cmd *plugin.ExecutedCommand, _ plugin.ClientAPI) error {
 	if len(cmd.Args) == 0 {
 		return fmt.Errorf("oracle name missing")
 	}
+
+	flags, err := cmd.NewFlags()
+	if err != nil {
+		return err
+	}
+
 	var (
 		name      = cmd.Args[0]
-		source, _ = cmd.Flags().GetString("source")
+		source, _ = flags.GetString("source")
 	)
+
 	// Read chain information
 	c, err := getChain(cmd)
 	if err != nil {
@@ -199,10 +209,10 @@ resulting in `post` and `clean up` not executing.
 The following is an example of a `hook` definition.
 
 ```go
-func (app) Manifest() (plugin.Manifest, error) {
-	return plugin.Manifest{
+func (app) Manifest(context.Context) (*plugin.Manifest, error) {
+	return &plugin.Manifest{
 		Name: "oracle",
-		Hooks: []plugin.Hook{
+		Hooks: []*plugin.Hook{
 			{
 				Name:        "my-hook",
 				PlaceHookOn: "ignite chain build",
@@ -211,8 +221,8 @@ func (app) Manifest() (plugin.Manifest, error) {
 	}, nil
 }
 
-func (app) ExecuteHookPre(hook plugin.ExecutedHook) error {
-	switch hook.Name {
+func (app) ExecuteHookPre(_ context.Context, h *plugin.ExecutedHook, _ plugin.ClientAPI) error {
+	switch h.Hook.GetName() {
 	case "my-hook":
 		fmt.Println("I'm executed before ignite chain build")
 	default:
@@ -221,8 +231,8 @@ func (app) ExecuteHookPre(hook plugin.ExecutedHook) error {
 	return nil
 }
 
-func (app) ExecuteHookPost(hook plugin.ExecutedHook) error {
-	switch hook.Name {
+func (app) ExecuteHookPost(_ context.Context, h *plugin.ExecutedHook, _ plugin.ClientAPI) error {
+	switch h.Hook.GetName() {
 	case "my-hook":
 		fmt.Println("I'm executed after ignite chain build (if no error)")
 	default:
@@ -231,8 +241,8 @@ func (app) ExecuteHookPost(hook plugin.ExecutedHook) error {
 	return nil
 }
 
-func (app) ExecuteHookCleanUp(hook plugin.ExecutedHook) error {
-	switch hook.Name {
+func (app) ExecuteHookCleanUp(_ context.Context, h *plugin.ExecutedHook, _ plugin.ClientAPI) error {
+	switch h.Hook.GetName() {
 	case "my-hook":
 		fmt.Println("I'm executed after ignite chain build (regardless errors)")
 	default: