chore: remove unused orm module #23633
Conversation
zrbecker
added
C:orm
backport/v0.50.x
📝 WalkthroughWalkthroughThis pull request removes a vast number of files and corresponding code segments related to the Cosmos SDK ORM module. Documentation, configuration files, code generation scripts, implementation files (including various codecs, key encoders, ORM backend and model logic), and nearly all tests have been deleted. No new functionality or modifications to exported public entities were introduced; rather, existing ORM-related implementations have been entirely removed. Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
|
Just a heads up there are teams using this, this is why we couldn't remove it. Doing a GitHub search will tell you which users to reach out to. Huge fan of the removal though |
I did a GitHub search and saw users were using v1.0.0-beta.3 released two years ago. I'm not planning on removing the tags that they are using, so removing it on SDK release branches will not break them. If active development needs to pick up for this module, I recommend forking it into a repo where development can continue. There does not seem a purpose to have an unmaintained module on the SDK release branches though. |
(cherry picked from commit d7f101e) # Conflicts: # x/params/proto/buf.gen.pulsar.yaml # x/params/sonar-project.properties
(cherry picked from commit d7f101e) # Conflicts: # orm/CHANGELOG.md # orm/README.md # orm/encoding/encodeutil/util.go # orm/encoding/ormfield/bool.go # orm/encoding/ormfield/codec_test.go # orm/encoding/ormfield/duration.go # orm/encoding/ormfield/duration_test.go # orm/encoding/ormfield/enum.go # orm/encoding/ormfield/int32.go # orm/encoding/ormfield/int64.go # orm/encoding/ormfield/string.go # orm/encoding/ormfield/timestamp.go # orm/encoding/ormfield/timestamp_test.go # orm/encoding/ormfield/uint32.go # orm/encoding/ormfield/uint64.go # orm/encoding/ormkv/index_key.go # orm/encoding/ormkv/key_codec.go # orm/encoding/ormkv/primary_key.go # orm/encoding/ormkv/unique_key.go # orm/encoding/ormkv/unique_key_test.go # orm/go.mod # orm/go.sum # orm/internal/codegen/file.go # orm/internal/codegen/index.go # orm/internal/codegen/query.go # orm/internal/listinternal/options.go # orm/internal/testkv/compare.go # orm/internal/testkv/debug.go # orm/internal/testkv/leveldb.go # orm/internal/testkv/mem.go # orm/model/ormdb/genesis.go # orm/model/ormdb/module.go # orm/model/ormdb/module_test.go # orm/model/ormtable/auto_increment_test.go # orm/model/ormtable/backend.go # orm/model/ormtable/batch.go # orm/model/ormtable/bench_test.go # orm/model/ormtable/hooks.go # orm/model/ormtable/iterator.go # orm/model/ormtable/table_test.go # orm/orm.go # orm/sonar-project.properties # orm/testing/ormmocks/hooks.go # orm/testing/ormmocks/match.go # orm/types/kv/store.go # orm/types/ormerrors/errors.go
|
As the original author of the orm, agree it should be moved to a standalone repo if someone wants to make updates and has the bandwidth for it. |
Description
Closes: #23635
On the
releases/v0.50.xbranch there is a failing test for the orm module. It looks like this module has not been in active development for some time, and is isolated into it's own module that was last released 2 years ago (https://github.com/cosmos/cosmos-sdk/tree/orm/v1.0.0-beta.3). The failing test was fixed on the main branch, but was not backported to thereleases/v0.50.x.Since the module is not in active development, and I am unaware of plans to continue development of the module, I recommend removing the module from the main branch, and backporting it to releases/v0.50.x.
Deleting orm from the Cosmos SDK repo is safe, even on the v0.50.x branch because it is isolated into it's own module, and the cosmos-sdk doesn't depend on it. So as far as cosmos-sdk releases are concerned the deletion of the module has no effect, and thus is non-breaking.
Author Checklist
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...
!in the type prefix if API or client breaking changeCHANGELOG.mdReviewers Checklist
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.
Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.
I have...