[Code Health] Investigate a permanent solution to pulsar self-import issue

[bryanchriswhite]

Objective

Remove proto_fix_self_import make target workaround.

Origin Document

1. Post v0.50.x cosmos-sdk leverages the v2 go protobuf API, which necessitates tracking api/poktroll/**/*.go (generated) files in version control. Otherwise, the ignite CLI becomes unusable as it requries go mod tidy to succeed for all subcommands, which is not possible without these files as they are imported by each respective module's module.go and autocli.go files.
2. When .proto files import protobuf types from other .proto files, it seems that we MUST add a corresponding option in the plugins.opt field in buf.gen.pulsar.yaml to mitigate the following error during generation:
3. So long as we MUST do 2 (and we do not apply the workaround), a new self-import error arises in the corresponding generated *.pulsar.go code immediately after generation (i.e. try ignite generate proto-go && ignite chain build --skip-proto):

Goals

• [ ] Determine whether this phenomenon is a result of misconfiguration on our end or a bug in cosmos-proto's
  • Outcome:
• Either:
  • Open an issue in the cosmos-proto (or other appropriate) repo.
  • Correct the misconfiguration.

Deliverables

• ...

Non-goals / Non-deliverables

• ...

General deliverables

• [ ] Comments: Add/update TODOs and comments alongside the source code so it is easier to follow.
• [ ] Testing: Add new tests (unit and/or E2E) to the test suite.
• [ ] Makefile: Add new targets to the Makefile to make the new functionality easier to use.
• [ ] Documentation: Update architectural or development READMEs; use mermaid diagrams where appropriate.

---

Creator: @bryanchriswhite Co-Owners: @red-0ne

[bryanchriswhite]

Try renaming any .proto files which are currently named after their respective modules; e.g., proto/poktroll/session/session.proto, proto/poktroll/service/service.proto, etc.

See:

• https://discordapp.com/channels/824324475256438814/1138895490331705354/1275635151564439614
• https://github.com/pokt-network/poktroll/issues/663#issuecomment-2210697573

We can also probably remove these files from the [buf.gen.pulsar.yaml]() plugins.opt field:

plugins:
  - name: go-pulsar
    out: ./api
-    opt: paths=source_relative,Mpoktroll/shared/service.proto=github.com/pokt-network/poktroll/api/poktroll/shared,Mpoktroll/shared/supplier.proto=github.com/pokt-network/poktroll/api/poktroll/shared,Mpoktroll/supplier/supplier.proto=github.com/pokt-network/poktroll/api/poktroll/supplier,Mpoktroll/session/session.proto=github.com/pokt-network/poktroll/api/poktroll/session
+    opt: paths=source_relative

[bryanchriswhite]

Try renaming any .proto files which are currently named after their respective modules; e.g., proto/poktroll/session/session.proto, proto/poktroll/service/service.proto, etc.

We can also probably remove these files from the buf.gen.pulsar.yaml plugins.opt field:

No dice. :game_die: The proto_fix_self_import target seems to still be necessary despite these changes (see: #749). :disappointed:

[Olshansk]

@bryanchriswhite Is this still an open issue? Please close out if not.

[Olshansk]

@bryanchriswhite Is this still an open issue? Please close out if not.

[bryanchriswhite]

This is still an issue that we're applying a workaround for.

[Olshansk]

@bryanchriswhite Did you ever open an issue in https://github.com/cosmos/cosmos-proto?

Seemed to be one of the notes in the original description.

[bryanchriswhite]

I did not. I wanted to ensure that it wasn't our fault first. My plan was to scaffold a new chain and try to reproduce the issue there. I think this exercise will also improve the quality of any issue that we do open.