-
Notifications
You must be signed in to change notification settings - Fork 257
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add
message_type module and store msg types inside `message_t…
…ype` table (#702) Closes: #XXXX <!-- Add a description of the changes that this PR introduces and the files that are the most critical to review. --> Changes: - Added `message_type` module - Added msg handler to store message types inside `message_type` table - Added new `messages_by_type` function to allow to query messages by their types - Added `v5` migrator to parse all msg types already stored in db and save them inside `message_type` table --- *All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.* I have... - [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] added `!` to the type prefix if API or client breaking change - [x] targeted the correct branch - [x] provided a link to the relevant issue or specification - [x] added a changelog entry to `CHANGELOG.md` - [x] included comments for [documenting Go code](https://blog.golang.org/godoc) - [x] updated the relevant documentation or specification - [x] reviewed "Files changed" and left comments if necessary - [x] confirmed all CI checks have passed *All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.* I have... - [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] confirmed `!` in the type prefix if API or client breaking change - [ ] confirmed all author checklist items have been addressed - [ ] reviewed API design and naming - [ ] reviewed documentation is accurate - [ ] reviewed tests and test coverage - [ ] manually tested (if applicable)
- Loading branch information
Showing
21 changed files
with
329 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| package v5 | ||
|
|
||
| import ( | ||
| "fmt" | ||
|
|
||
| v5db "github.com/forbole/bdjuno/v4/database/migrate/v5" | ||
| parse "github.com/forbole/juno/v5/cmd/parse/types" | ||
| "github.com/forbole/juno/v5/database" | ||
| "github.com/forbole/juno/v5/database/postgresql" | ||
| "github.com/forbole/juno/v5/types/config" | ||
| ) | ||
|
|
||
| // RunMigration runs the migrations to v5 | ||
| func RunMigration(parseConfig *parse.Config) error { | ||
| cfg, err := GetConfig() | ||
| if err != nil { | ||
| return fmt.Errorf("error while reading config: %s", err) | ||
| } | ||
|
|
||
| // Migrate the database | ||
| err = migrateDb(cfg, parseConfig) | ||
| if err != nil { | ||
| return fmt.Errorf("error while migrating database: %s", err) | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func migrateDb(cfg config.Config, parseConfig *parse.Config) error { | ||
| // Build the codec | ||
| encodingConfig := parseConfig.GetEncodingConfigBuilder()() | ||
|
|
||
| // Get the db | ||
| databaseCtx := database.NewContext(cfg.Database, encodingConfig, parseConfig.GetLogger()) | ||
| db, err := postgresql.Builder(databaseCtx) | ||
| if err != nil { | ||
| return fmt.Errorf("error while building the db: %s", err) | ||
| } | ||
|
|
||
| // Build the migrator and perform the migrations | ||
| migrator := v5db.NewMigrator(db.(*postgresql.Database)) | ||
| return migrator.Migrate() | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| package v5 | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "os" | ||
| "path" | ||
|
|
||
| "github.com/forbole/juno/v5/types/config" | ||
| "gopkg.in/yaml.v3" | ||
| ) | ||
|
|
||
| // GetConfig returns the configuration reading it from the config.yaml file present inside the home directory | ||
| func GetConfig() (config.Config, error) { | ||
| file := path.Join(config.HomePath, "config.yaml") | ||
|
|
||
| // Make sure the path exists | ||
| if _, err := os.Stat(file); os.IsNotExist(err) { | ||
| return config.Config{}, fmt.Errorf("config file does not exist") | ||
| } | ||
|
|
||
| bz, err := os.ReadFile(file) | ||
| if err != nil { | ||
| return config.Config{}, fmt.Errorf("error while reading config file: %s", err) | ||
| } | ||
|
|
||
| var cfg config.Config | ||
| err = yaml.Unmarshal(bz, &cfg) | ||
| return cfg, err | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| package database | ||
|
|
||
| import ( | ||
| types "github.com/forbole/bdjuno/v4/types" | ||
| ) | ||
|
|
||
| // SaveMessageType stores the given message type inside the database | ||
| func (db *Db) SaveMessageType(msg *types.MessageType) error { | ||
| stmt := ` | ||
| INSERT INTO message_type(type, module, label, height) | ||
| VALUES ($1, $2, $3, $4) | ||
| ON CONFLICT (type) DO NOTHING` | ||
|
|
||
| _, err := db.SQL.Exec(stmt, msg.Type, msg.Module, msg.Label, msg.Height) | ||
| return err | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| package v5 | ||
|
|
||
| import ( | ||
| "fmt" | ||
|
|
||
| utils "github.com/forbole/bdjuno/v4/modules/utils" | ||
| "github.com/forbole/bdjuno/v4/types" | ||
| ) | ||
|
|
||
| // Migrate implements database.Migrator | ||
| func (db *Migrator) Migrate() error { | ||
| msgTypes, err := db.getMsgTypesFromMessageTable() | ||
| if err != nil { | ||
| return fmt.Errorf("error while getting message types rows: %s", err) | ||
| } | ||
|
|
||
| for _, msgType := range msgTypes { | ||
| // migrate message types | ||
| err = db.migrateMsgTypes(types.NewMessageType( | ||
| msgType.Type, | ||
| utils.GetModuleNameFromTypeURL(msgType.Type), | ||
| utils.GetMsgFromTypeURL(msgType.Type), | ||
| msgType.Height)) | ||
|
|
||
| if err != nil { | ||
| return err | ||
| } | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| // getMsgTypesFromMessageTable retrieves messages types stored in database inside message table | ||
| func (db *Migrator) getMsgTypesFromMessageTable() ([]MessageRow, error) { | ||
| smt := "SELECT DISTINCT ON (type) type, transaction_hash, height FROM message ORDER BY type DESC" | ||
| var rows []MessageRow | ||
| err := db.SQL.Select(&rows, smt) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| return rows, nil | ||
| } | ||
|
|
||
| // migrateMsgTypes stores the given message type inside the database | ||
| func (db *Migrator) migrateMsgTypes(msg *types.MessageType) error { | ||
| stmt := ` | ||
| INSERT INTO message_type(type, module, label, height) | ||
| VALUES ($1, $2, $3, $4) | ||
| ON CONFLICT (type) DO NOTHING` | ||
|
|
||
| _, err := db.SQL.Exec(stmt, msg.Type, msg.Module, msg.Label, msg.Height) | ||
| return err | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| package v5 | ||
|
|
||
| import ( | ||
| "github.com/jmoiron/sqlx" | ||
|
|
||
| "github.com/forbole/juno/v5/database" | ||
| "github.com/forbole/juno/v5/database/postgresql" | ||
| ) | ||
|
|
||
| var _ database.Migrator = &Migrator{} | ||
|
|
||
| // Migrator represents the database migrator that should be used to migrate from v4 of the database to v5 | ||
| type Migrator struct { | ||
| SQL *sqlx.DB | ||
| } | ||
|
|
||
| func NewMigrator(db *postgresql.Database) *Migrator { | ||
| return &Migrator{ | ||
| SQL: db.SQL, | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| package v5 | ||
|
|
||
| type MessageRow struct { | ||
| TransactionHash string `db:"transaction_hash"` | ||
| Index int64 `db:"index"` | ||
| Type string `db:"type"` | ||
| Value string `db:"value"` | ||
| InvolvedAccountsAddresses string `db:"involved_accounts_addresses"` | ||
| Height int64 `db:"height"` | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| package message_type | ||
|
|
||
| import ( | ||
| sdk "github.com/cosmos/cosmos-sdk/types" | ||
| "github.com/cosmos/gogoproto/proto" | ||
| utils "github.com/forbole/bdjuno/v4/modules/utils" | ||
| msgtypes "github.com/forbole/bdjuno/v4/types" | ||
|
|
||
| "github.com/forbole/juno/v5/types" | ||
| ) | ||
|
|
||
| // HandleMsg represents a message handler that stores the given message inside the proper database table | ||
| func (m *Module) HandleMsg( | ||
| index int, msg sdk.Msg, tx *types.Tx) error { | ||
| // Save message type | ||
| err := m.db.SaveMessageType(msgtypes.NewMessageType( | ||
| proto.MessageName(msg), | ||
| utils.GetModuleNameFromTypeURL(proto.MessageName(msg)), | ||
| utils.GetMsgFromTypeURL(proto.MessageName(msg)), | ||
| tx.Height)) | ||
|
|
||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| return nil | ||
| } |
Oops, something went wrong.