feat(plugin): execute from function

[tbruyelle]

This change introduces a plugin.Execute() function that can be used to run arbitrary code without affecting the Ignite CLI dependencies. The code lives in its own repo, like any other plugins. Arguments can be passed to update the behavior.

Originally, plugins were designed to add new commands to the CLI, but it seems that, with minimal changes, it can be used for other purposes, such as the one described above.

Once merged, this will be used to remove the interchain-security dependency from Ignite CLI which we currently have in #3660 (see discussions 0)

Because this will be used internally in Ignite CLI for specific cases, I don't feel that we need to document this feature in the official documentation.

[jeronimoalbi]

@tbruyelle I left a comment in the original discussion that could eventually solve the original issue.

The Execute function looks good and seems it could be useful but where would it be used right now?

[tbruyelle]

The Execute function looks good and seems it could be useful but where would it be used right now?

@jeronimoalbi There's currently two specific locations where the interchain-security package is imported:

• writeConsumerGenesis() function: executed during ignite s chain, to generate the consumer genesis module.
• IsInitialized() function which is invoked during ignite c serve, to tell if a consumer chain has already been initialized (the process differs than a normal chain).

To remove the interchain-security import, the idea is to move that code into a plugin repo, like https://github.com/tbruyelle/cli-plugin-consumer, and then replace the moved code by plugin.Execute. So for instance, for the writeConsumerGenesis, it would look like that :

    if cfg.IsConsumerChain() {
		// Consumer chain writes validators in the consumer module genesis
		err := plugin.Execute(ctx, "github.com/tbruyelle/cli-plugin-consumer", "writeGenesis")
		if err != nil {
			return fmt.Errorf("execute consumer plugin: %w", err)
		}
	} 

For the IsInitialized() func, it would look a bit different because this time we have a value to return (true or false), we can rely on the error to determine that:

   if cfg.IsConsumerChain() {
		// Consumer chain writes validators in the consumer module genesis
		// FIXME use constant for plugin path and args (or introduce new method in plugin/consumer.go)
		err := plugin.Execute(context.Background(), "/home/tom/src/ignite/cli-plugin-consumer", "isInitialized")
		if err != nil {
			// FIXME convert to rpc status.Error to get access to desc
			if errors.Cause(err).Error() == "not initialized" {
				return false, nil
			}
			return false, fmt.Errorf("execute consumer plugin %q %T: %w", err.Error(), err, err)
		}
	}

With these changes, the interchain-security is no longer present in the Ignite CLI go.mod.

[jeronimoalbi]

For the IsInitialized() func, it would look a bit different because this time we have a value to return (true or false), we can rely on the error to determine that

I wonder if adding Call to plugin.Interface would make sense for cases like this where we would expect to get a value back from an RPC call. In any case, is just a though which we could implement as an improvement if it makes sense.

[tbruyelle]

I wonder if adding Call to plugin.Interface would make sense for cases like this where we would expect to get a value back from an RPC call. In any case, is just a though which we could implement as an improvement if it makes sense.

That would be better yes, but I didn't want to change the plugin interface and break existing plugins. But maybe that doesn't really matter. The other point is there's already too many methods in the plugin interface, and adding a new one will increase again its complexity. Finally, since it's internal and not exposed to Ignite users, I think it's acceptable to use the Execute method.

[tbruyelle]

• writeConsumerGenesis() function: executed during ignite s chain, to generate the consumer genesis module.

Sorry this is wrong, writeConsumerGenesis is called during ignite c init (or ignite c serve). No genesis are written during the scaffold phase.