Deprecate commons-redis #662
Open
+31
−57
Conversation
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
mikegpl
reviewed
Jan 8, 2025
| @@ -33,7 +33,6 @@ | |||
| [`OptRef`](http://avsystem.github.io/scala-commons/api/com/avsystem/commons/misc/OptRef.html) (implemented as value | |||
| classes) | |||
| * [Components](docs/Components.md) and Dependency Injection library | |||
| * `commons-redis` - [Scala driver for Redis](docs/RedisDriver.md) | |||
There was a problem hiding this comment.
suggestion: If we're keeping the Redis docs (I noticed you added deprecation notice in RedisDriver.md) until we remove the driver code entirely, IMO we should keep the entrypoint to its docs too.
| @@ -45,6 +45,7 @@ import scala.concurrent.duration._ | |||
| * @param config client configuration - [[ClusterConfig]] | |||
| * @param clusterStateObserver optional observer for monitoring client's state and connections - [[ClusterStateObserver]] | |||
| */ | |||
| @deprecated("Redis driver is scheduled for removal. Use a different library, e.g. redisson.", "2.21.0") | |||
There was a problem hiding this comment.
suggestion: Extend this deprecation notice (and other ones as well) with info that this is no longer tested since 2.21.0. If, for some maintenance reasons, we release new version in the future and someone encounters unexpected behavior, it might be a good clue for searching for the root cause.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Most of our internal products migrated or are in the process of migrating to Redisson so I propose to release a deprecation.
This module is particularly flaky and maintenance intensive so I've also removed it from CI.