[Tooling, Code Health] refactor: split Makefile into multiple files #816

bryanchriswhite · 2024-09-11T10:01:31Z

Summary

The Makefile has gotten quite large (1185 LoC). This PR splits the makefile into multiple files, focusing on large groups of targets and groups related to on-chain state or local/devnets:

warnings.mk
todos.mk
checks.mk
tests.mk
localnet.mk
testnet.mk
params.mk
applications.mk
suppliers.mk
gateways.mk
session.mk
claims.mk

Issue

Reaction to friction experienced while working on [Testing] E2E Test Refactoring #799

Type of change

Select one or more from the following:

New feature, functionality or library
Consensus breaking; add the consensus-breaking label if so. See [Infra] Automatically add the consensus-breaking label #791 for details
Bug fix
Code health or cleanup
Documentation
Other (specify)

Testing

Documentation: make docusaurus_start; only needed if you make doc changes
Unit Tests: make go_develop_and_test
LocalNet E2E Tests: make test_e2e
DevNet E2E Tests: Add the devnet-test-e2e label to the PR.

Sanity Checklist

I have tested my changes using the available tooling
I have commented my code
I have performed a self-review of my own code; both comments & source code
I create and reference any new tickets, if applicable
I have left TODOs throughout the codebase, if applicable

…pplier-stake_x_make-targets * issues/799/chore/make-targets: todo: discuss chore: add param query make targets chore: add tx query make targets fix: supplier unstake make targets

github-actions · 2024-09-11T10:02:17Z

The CI will now also run the e2e tests on devnet, which increases the time it takes to complete all CI checks.

You may need to run make trigger_ci to submit an empty commit that'll trigger the tests.

GCP workloads (requires changing the namespace to 816)
Grafana network dashboard for devnet-issue-816

makefiles/checks.mk

Olshansk

This is great, ty!

Olshansk · 2024-09-13T02:54:30Z

Makefile

@@ -132,167 +132,6 @@ list: ## List all make targets
 help: ## Prints all the targets in all the Makefiles


Did you confirm this still works?

Yessir! 🫡

makefiles/localnet.mk

Olshansk

This is great, ty!

Olshansk

This is great, ty!

This reverts commit e5672c1.

This reverts commit f2ec505.

This reverts commit 9706877.

This reverts commit 3a7315c.

…efiles * pokt/main: [Tooling] fix and add makefile targets (#814) [Docs] Add a debugging tip: using transaction hashes (#786)

bryanchriswhite · 2024-09-16T08:14:20Z

Merging despite CI failures.

CI passed as of 335e68b
Subsequent commits only "merge with main", reverting commits that were merged from another branch into this branches original base (the PR base has since been updated to main).
This branch only modifies the makefiles

…ke-transfer * pokt/main: [Tooling, Code Health] refactor: split Makefile into multiple files (#816) [Tooling] fix and add makefile targets (#814) [Docs] Add a debugging tip: using transaction hashes (#786) [Refactor] Replace embedded Service with ServiceId (#802) [Session,Service] Ensure SessionHeader and Service basic validation. (#782) [Tokenomics] Preparation for Global Mint Reimbursement Request (#755) [Quick PR][LocalNet] Turn off minimum-gas-prices (#805) [GATEWAY POC] A couple helpers to help deploy a PATH gateway (#801) [Documentation] Cosmovisor (#768) [CI] Add cosmovisor to container images (#796) Use a descriptive error if service ID is not found (#787) [SessionManager] Implement off-chain proof params usage (#765) [SDK] Update shannon sdk dependency (#800) [E2E Test] Remove redundant logging (#798)

…actor/transfer-msg_period-param * issues/657/feat/app-stake-transfer: [Tooling, Code Health] refactor: split Makefile into multiple files (#816) [Tooling] fix and add makefile targets (#814) [Docs] Add a debugging tip: using transaction hashes (#786) [Refactor] Replace embedded Service with ServiceId (#802) [Session,Service] Ensure SessionHeader and Service basic validation. (#782) [Tokenomics] Preparation for Global Mint Reimbursement Request (#755) [Quick PR][LocalNet] Turn off minimum-gas-prices (#805) [GATEWAY POC] A couple helpers to help deploy a PATH gateway (#801) [Documentation] Cosmovisor (#768) [CI] Add cosmovisor to container images (#796) Use a descriptive error if service ID is not found (#787) [SessionManager] Implement off-chain proof params usage (#765) [SDK] Update shannon sdk dependency (#800) [E2E Test] Remove redundant logging (#798)

…ues/657/chore/app-transfer-period * issues/657/refactor/transfer-msg_period-param: [Tooling, Code Health] refactor: split Makefile into multiple files (#816) [Tooling] fix and add makefile targets (#814) [Docs] Add a debugging tip: using transaction hashes (#786) [Refactor] Replace embedded Service with ServiceId (#802) [Session,Service] Ensure SessionHeader and Service basic validation. (#782) [Tokenomics] Preparation for Global Mint Reimbursement Request (#755) [Quick PR][LocalNet] Turn off minimum-gas-prices (#805) [GATEWAY POC] A couple helpers to help deploy a PATH gateway (#801) [Documentation] Cosmovisor (#768) [CI] Add cosmovisor to container images (#796) Use a descriptive error if service ID is not found (#787) [SessionManager] Implement off-chain proof params usage (#765) [SDK] Update shannon sdk dependency (#800) [E2E Test] Remove redundant logging (#798)

…99/e2e/param-helpers * issues/799/e2e/idempotent-stake-supplier: chore: add comment chore: sync shared module default params fix: failing E2E test [Supplier] Initial slashing implementation (#795) [Container image] Change base image for release (#829) [Proof] Prevent proof submission when not required (#822) chore: rename paramsAnyMap type to mitigate variable name shadowing [Tooling, Code Health] refactor: split Makefile into multiple files (#816) [Tooling] fix and add makefile targets (#814) [Docs] Add a debugging tip: using transaction hashes (#786)

…lier-stake-events * issues/799/e2e/param-helpers: chore: review feedback improvements chore: add comment chore: sync shared module default params fix: failing E2E test [Supplier] Initial slashing implementation (#795) [Container image] Change base image for release (#829) [Proof] Prevent proof submission when not required (#822) chore: rename paramsAnyMap type to mitigate variable name shadowing [Tooling, Code Health] refactor: split Makefile into multiple files (#816) [Tooling] fix and add makefile targets (#814) [Docs] Add a debugging tip: using transaction hashes (#786)

…tests/params * issues/799/feat/supplier-stake-events: chore: review feedback improvements chore: add comment chore: sync shared module default params fix: failing E2E test [Supplier] Initial slashing implementation (#795) [Container image] Change base image for release (#829) [Proof] Prevent proof submission when not required (#822) chore: rename paramsAnyMap type to mitigate variable name shadowing [Tooling, Code Health] refactor: split Makefile into multiple files (#816) [Tooling] fix and add makefile targets (#814) [Docs] Add a debugging tip: using transaction hashes (#786)

…816) ## Summary The Makefile has gotten quite large ([1185 LoC](https://github.com/pokt-network/poktroll/blob/main/Makefile#L1185)). This PR splits the makefile into multiple files, focusing on large groups of targets and groups related to on-chain state or local/devnets: - warnings.mk - todos.mk - checks.mk - tests.mk - localnet.mk - testnet.mk - params.mk - applications.mk - suppliers.mk - gateways.mk - session.mk - claims.mk ## Issue - Reaction to friction experienced while working on #799 ## Type of change Select one or more from the following: - [ ] New feature, functionality or library - [ ] Consensus breaking; add the `consensus-breaking` label if so. See #791 for details - [ ] Bug fix - [x] Code health or cleanup - [ ] Documentation - [ ] Other (specify) ## Testing - [ ] **Documentation**: `make docusaurus_start`; only needed if you make doc changes - [x] **Unit Tests**: `make go_develop_and_test` - [ ] **LocalNet E2E Tests**: `make test_e2e` - [ ] **DevNet E2E Tests**: Add the `devnet-test-e2e` label to the PR. ## Sanity Checklist - [x] I have tested my changes using the available tooling - [x] I have commented my code - [x] I have performed a self-review of my own code; both comments & source code - [ ] I create and reference any new tickets, if applicable - [ ] I have left TODOs throughout the codebase, if applicable

bryanchriswhite added 9 commits September 11, 2024 11:05

test: make stake_supplier.feature idempotent

3a7315c

test: speed up stake_supplier.feature

9706877

chore: simplification

f2ec505

chore: fix typos

e5672c1

fix: supplier unstake make targets

772239b

chore: add tx query make targets

2d4c5dd

chore: add param query make targets

a79806c

todo: discuss

e2d4750

Merge branch 'issues/799/chore/make-targets' into issues/799/merge/su…

8995151

…pplier-stake_x_make-targets * issues/799/chore/make-targets: todo: discuss chore: add param query make targets chore: add tx query make targets fix: supplier unstake make targets

bryanchriswhite added code health Cleans up some code tooling Tooling - CLI, scripts, helpers, off-chain, etc... labels Sep 11, 2024

bryanchriswhite added this to the Shannon Beta TestNet Launch milestone Sep 11, 2024

bryanchriswhite self-assigned this Sep 11, 2024

bryanchriswhite added the devnet-test-e2e label Sep 11, 2024

github-actions bot added devnet push-image CI related - pushes images to ghcr.io labels Sep 11, 2024

refactor: split makefile into multiple files

485156e

bryanchriswhite force-pushed the issues/799/refactor/makefiles branch from ee035ab to 485156e Compare September 11, 2024 10:03

bryanchriswhite commented Sep 11, 2024

View reviewed changes

makefiles/checks.mk Outdated Show resolved Hide resolved

chore: consolidate warnings

335e68b

bryanchriswhite marked this pull request as ready for review September 12, 2024 08:24

bryanchriswhite requested review from red-0ne, Olshansk and okdas September 12, 2024 08:25

Olshansk approved these changes Sep 13, 2024

View reviewed changes

bryanchriswhite linked an issue Sep 16, 2024 that may be closed by this pull request

[Testing] E2E Test Refactoring #799

Closed

6 tasks

bryanchriswhite changed the base branch from issues/799/merge/supplier-stake_x_make-targets to main September 16, 2024 08:02

bryanchriswhite added 7 commits September 16, 2024 10:04

Revert "chore: fix typos"

3b565ee

This reverts commit e5672c1.

Revert "chore: simplification"

0d4a64b

This reverts commit f2ec505.

Revert "test: speed up stake_supplier.feature"

b8dad5f

This reverts commit 9706877.

Revert "test: make stake_supplier.feature idempotent"

d782f7c

This reverts commit 3a7315c.

Merge remote-tracking branch 'pokt/main' into issues/799/refactor/mak…

5182b03

…efiles * pokt/main: [Tooling] fix and add makefile targets (#814) [Docs] Add a debugging tip: using transaction hashes (#786)

chore: review feedback improvements

5c46459

chore: cleanup

3869728

bryanchriswhite merged commit ac3b324 into main Sep 16, 2024
5 of 9 checks passed

bryanchriswhite deleted the issues/799/refactor/makefiles branch September 16, 2024 08:17

bryanchriswhite mentioned this pull request Oct 7, 2024

[RelayMiner]: add proxy.Ping(...) capability to test connectivity between relay servers and backend URLs #744

Closed

14 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Tooling, Code Health] refactor: split Makefile into multiple files #816

[Tooling, Code Health] refactor: split Makefile into multiple files #816

bryanchriswhite commented Sep 11, 2024 •

edited

Loading

github-actions bot commented Sep 11, 2024

Olshansk left a comment

Olshansk Sep 13, 2024

bryanchriswhite Sep 16, 2024

Olshansk left a comment

Olshansk left a comment

bryanchriswhite commented Sep 16, 2024

		@@ -132,167 +132,6 @@ list: ## List all make targets
		help: ## Prints all the targets in all the Makefiles

[Tooling, Code Health] refactor: split Makefile into multiple files #816

[Tooling, Code Health] refactor: split Makefile into multiple files #816

Conversation

bryanchriswhite commented Sep 11, 2024 • edited Loading

Summary

Issue

Type of change

Testing

Sanity Checklist

github-actions bot commented Sep 11, 2024

Olshansk left a comment

Choose a reason for hiding this comment

Olshansk Sep 13, 2024

Choose a reason for hiding this comment

bryanchriswhite Sep 16, 2024

Choose a reason for hiding this comment

Olshansk left a comment

Choose a reason for hiding this comment

Olshansk left a comment

Choose a reason for hiding this comment

bryanchriswhite commented Sep 16, 2024

bryanchriswhite commented Sep 11, 2024 •

edited

Loading