turbo-replay 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d51efac005c1642592ebccb9753657e2be702141014bc0ebae2e7d4757aee362
+  data.tar.gz: ae00e5f49f8f106ef525e5efa7f3f6abe01b2676553b64f2c8bbfe9f943e23f1
+SHA512:
+  metadata.gz: 6ff54759f20fdd6cbb6c6a23f926297d9f12eb5d86ae96617b212a98eb0c53d421d2c676020cf89778ef56795ef7cc8a2a213f8f12b710e5d198948995508e8a
+  data.tar.gz: 1cd690000760467b1ded8d168d26621d69fd08c255ca1d688c5e83d43c8d0df12038cb0e41a94b4af45a47f84cd2663eced22f3edc1c6ca0129ba18c1e5a3343

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 Luiz Paulo
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# Turbo::Replay
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "turbo-replay"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install turbo-replay
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/setup"
+require "bundler/gem_tasks"
+require "standard/rake"

data/lib/tasks/turbo/replay_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :turbo_replay do
+#   # Task goes here
+# end

data/lib/turbo/replay/message.rb

@@ -0,0 +1,47 @@
+module Turbo::Replay
+  module Message
+    extend self
+
+    def get_current_sequence_number(broadcasting:)
+      Turbo::Replay.configuration.repo.get_current_sequence_number(broadcasting: broadcasting)
+    end
+
+    def get_after_sequence_number(broadcasting:, sequence_number:)
+      messages =
+        Turbo::Replay.configuration.repo
+          .get_all_messages(broadcasting: broadcasting)
+          .sort_by(&BySequenceNumber)
+
+      return :unrecoverable if IsUnrecoverable.call(sequence_number, messages)
+
+      messages.filter(&AfterSequenceNumber[sequence_number])
+    end
+
+    def insert(broadcasting:, content:)
+      Turbo::Replay.configuration.repo.insert_message(
+        broadcasting: broadcasting,
+        content: content,
+        retention: Turbo::Replay.configuration.retention
+      )
+    end
+
+    private
+
+    BySequenceNumber =
+      ->(content_with_sequence_number) {
+        content_with_sequence_number[:sequence_number]
+      }
+
+    IsUnrecoverable =
+      ->(sequence_number, messages) {
+        return false if messages.empty?
+
+        sequence_number < messages.first[:sequence_number] - 1
+      }
+
+    AfterSequenceNumber =
+      ->(sequence_number, content_with_sequence_number) {
+        content_with_sequence_number[:sequence_number] > sequence_number
+      }.curry
+  end
+end

data/lib/turbo/replay/railtie.rb

@@ -0,0 +1,7 @@
+# Is this needed?
+module Turbo
+  module Replay
+    class Railtie < ::Rails::Railtie
+    end
+  end
+end

data/lib/turbo/replay/repo/base.rb

@@ -0,0 +1,17 @@
+module Turbo::Replay
+  module Repo
+    class Base
+      def get_current_sequence_number(broadcasting:)
+        raise NotImplementedError
+      end
+
+      def get_all_messages(broadcasting:)
+        raise NotImplementedError
+      end
+
+      def insert_message(broadcasting:, content:, retention:)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/turbo/replay/repo/memory.rb

@@ -0,0 +1,62 @@
+module Turbo::Replay
+  module Repo
+    class Memory < Base
+      def initialize
+        @mutex = Mutex.new
+        @counters = {}
+        @messages = {}
+        @ttl = {}
+      end
+
+      def get_current_sequence_number(broadcasting:)
+        synchronize(broadcasting) do
+          @counters.fetch(broadcasting, 0)
+        end
+      end
+
+      def get_all_messages(broadcasting:)
+        synchronize(broadcasting) do
+          @messages.fetch(broadcasting, [])
+        end
+      end
+
+      def insert_message(broadcasting:, content:, retention:)
+        synchronize(broadcasting) do
+          @ttl[broadcasting] =
+            Time.current + retention.ttl
+
+          next_sequence_number =
+            (@counters[broadcasting] = @counters.fetch(broadcasting, 0) + 1)
+
+          content_with_sequence_number =
+            {sequence_number: next_sequence_number, content: content}
+
+          (@messages[broadcasting] ||= []).tap do |messages|
+            messages << content_with_sequence_number
+            messages.shift if messages.length > retention.size
+          end
+
+          content_with_sequence_number
+        end
+      end
+
+      private
+
+      def synchronize(broadcasting)
+        @mutex.synchronize do
+          delete_cached_data_if_expired(broadcasting)
+
+          yield
+        end
+      end
+
+      def delete_cached_data_if_expired(broadcasting)
+        return if @ttl[broadcasting].nil? || @ttl[broadcasting].after?(Time.current)
+
+        @ttl.delete(broadcasting)
+        @counters.delete(broadcasting)
+        @messages.delete(broadcasting)
+      end
+    end
+  end
+end

data/lib/turbo/replay/repo/redis.rb

@@ -0,0 +1,69 @@
+module Turbo::Replay
+  module Repo
+    class Redis < Base
+      attr_reader :client
+
+      def initialize(client:)
+        @client = client
+      end
+
+      def get_current_sequence_number(broadcasting:)
+        counter_key =
+          FormatCounterKey.call(broadcasting)
+
+        @client.get(counter_key)&.to_i || 0
+      end
+
+      def get_all_messages(broadcasting:)
+        messages_key =
+          FormatMessagesKey.call(broadcasting)
+
+        @client.lrange(messages_key, 0, -1)
+          .map(&SafeParseJson)
+          .compact
+          .reverse
+      end
+
+      def insert_message(broadcasting:, content:, retention:)
+        counter_key =
+          FormatCounterKey.call(broadcasting)
+
+        messages_key =
+          FormatMessagesKey.call(broadcasting)
+
+        next_sequence_number =
+          @client.incr(counter_key)
+
+        content_with_sequence_number =
+          {sequence_number: next_sequence_number, content: content}
+
+        @client.lpush(messages_key, content_with_sequence_number.to_json)
+        @client.ltrim(messages_key, 0, retention.size - 1)
+
+        @client.expire(counter_key, retention.ttl)
+        @client.expire(messages_key, retention.ttl)
+
+        content_with_sequence_number
+      end
+
+      private
+
+      PREFIX = "replay"
+
+      FormatCounterKey =
+        ->(broadcasting) { "#{PREFIX}:#{broadcasting}:counter" }
+
+      FormatMessagesKey =
+        ->(broadcasting) { "#{PREFIX}:#{broadcasting}:messages" }
+
+      SafeParseJson =
+        ->(encoded) do
+          begin
+            JSON.parse(encoded).symbolize_keys
+          rescue
+            nil
+          end
+        end
+    end
+  end
+end

data/lib/turbo/replay/retention.rb

@@ -0,0 +1,3 @@
+module Turbo::Replay
+  Retention = Struct.new(:ttl, :size, keyword_init: true)
+end

data/lib/turbo/replay/version.rb

@@ -0,0 +1,5 @@
+module Turbo
+  module Replay
+    VERSION = "0.1.0"
+  end
+end

data/lib/turbo/replay.rb

@@ -0,0 +1,23 @@
+require "turbo/replay/version"
+require "turbo/replay/railtie"
+
+require_relative "./replay/retention"
+require_relative "./replay/message"
+require_relative "./replay/repo/base"
+require_relative "./replay/repo/memory"
+require_relative "./replay/repo/redis"
+
+module Turbo
+  module Replay
+    include ActiveSupport::Autoload
+
+    class Configuration
+      attr_accessor :repo, :retention
+    end
+
+    mattr_accessor :configuration
+    self.configuration = Configuration.new
+
+    def self.configure = yield(configuration)
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: turbo-replay
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Luiz Vasconcellos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Turbo-Replay caches events sent to channels and re-sends them in order
+  when clients have flaky network.
+email:
+- luizpvasc@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/tasks/turbo/replay_tasks.rake
+- lib/turbo/replay.rb
+- lib/turbo/replay/message.rb
+- lib/turbo/replay/railtie.rb
+- lib/turbo/replay/repo/base.rb
+- lib/turbo/replay/repo/memory.rb
+- lib/turbo/replay/repo/redis.rb
+- lib/turbo/replay/retention.rb
+- lib/turbo/replay/version.rb
+homepage: https://github.com/luizpvas/turbo-replay
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/luizpvas/turbo-replay
+  source_code_uri: https://github.com/luizpvas/turbo-replay
+  changelog_uri: https://github.com/luizpvas/turbo-replay
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: Never miss a single websocket event ever again.
+test_files: []