Adding a new DevBackend for testing. #63
Merged
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
…ses to avoid name collisions. Fixes #61
jwoertink
added
the
BREAKING CHANGE
jwoertink
commented
Apr 9, 2023
Comment on lines
+34
to
-45
| setting backend_class : Cable::BackendCore.class = Cable::RedisBackend, example: "Cable::RedisBackend" | ||
| setting redis_ping_interval : Time::Span = 15.seconds | ||
| setting restart_error_allowance : Int32 = 20 | ||
| setting on_error : Proc(Exception, String, Nil) = ->(exception : Exception, message : String) do | ||
| Cable::Logger.error(exception: exception) { message } | ||
| end | ||
|
|
||
| # DEPRECATED | ||
| # only use if you are using stefanwille/crystal-redis | ||
| # AND you want to use the connection pool | ||
| setting pool_redis_publish : Bool = false | ||
| setting redis_pool_size : Int32 = 5 | ||
| setting redis_pool_timeout : Float64 = 5.0 | ||
| setting redis_ping_interval : Time::Span = 15.seconds | ||
| setting restart_error_allowance : Int32 = 20 | ||
| setting on_error : Proc(Exception, String, Nil) = ->(exception : Exception, message : String) do | ||
| Cable::Logger.error(exception: exception) { message } | ||
| end |
There was a problem hiding this comment.
I just moved these up so we can group which settings are deprecated and which are still in use.
jwoertink
commented
Apr 9, 2023
fernandes
approved these changes
Apr 17, 2023
There was a problem hiding this comment.
this is pretty cool, I won't merge waiting for if @mjeffrey18 wants to add something once worked on this backend, but looks 💯
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.
Fixes #61
This PR adds in a new
Cable::DevBackendclass that can be used for testing to ensure that your channels are called when you expect.In order to do this, I had to rename the current Backend classes because they were both named
Cable::Backend, and that wouldn't let you figure out if you were using redis or just this in-memory dev backend. We will need the separate naming anyway in order to do #49 eventually.I ended up moving some code from the
connection_spec.crin to helpers because as I was writing my spec, I thought I needed them, but turns out I didn't. I figure they belong in the spec/support anyway.Lastly, in order to test, this requires setting the
@@serverin Cable to nil because we were callingCable.restartbefore every spec. When that's called,Cable.serveris defaulted to the Redis backend, and I need the DevBackend for my spec.This also means that potentially other devs will need to do the same... I'm not a huge fan of that, but I also don't know another way to handle that.
This is a small breaking change for those that are using the legacy redis backend. If you are, you'll have to set
settings.backend_class = Cable::RedisLegacyBackendin your Cable config for it to still work. This is officially deprecated now.