rollout-redis-adapter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a9cc50e6246dc24c608dd1ed9574950ae757ac12a6338c42dec4a1bbd1b844fd
+  data.tar.gz: 43eb90671e27630916809f429f7f101ab56a75abbcb6c5e60974a8dc7eef5701
+SHA512:
+  metadata.gz: b93786646e9fcad1049aff85e8c0ebb40d15624ce836ef325ea75df8f88d0f496cb1b7d8d4e0ca35a75760e3f89be5065dc98f61c72a078b6b2c3eb1d2a54ca4
+  data.tar.gz: 9de7bddd73e7a9ee24d97e5ca34883b54b432fbb9310094ff4a4bb452b194a973420afd06eeeb04fe56d4dfb121a109c37d3ab72b7a9fb42d2659efb422d3a2d

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010-InfinityAndBeyond BitLove, Inc.
+
+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/lib/rollout/adapters/redis.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+require 'redis'
+require 'rollout'
+require 'rollout/logging'
+require 'rollout/redis/codec'
+
+class Rollout
+  module Adapters
+    class Redis
+      FEATURES_KEY = 'feature:__features__'
+
+      def initialize(client)
+        @client = client
+      end
+
+      def fetch_feature(name)
+        ::Rollout::Redis::Codec.decode(name, @client.get(key(name)))
+      end
+
+      def fetch_features(names)
+        return [] if names.empty?
+
+        payloads = @client.mget(*names.map { |name| key(name) })
+        names.zip(payloads).map { |name, payload| ::Rollout::Redis::Codec.decode(name, payload) }
+      end
+
+      def feature_names
+        (@client.get(FEATURES_KEY) || '').split(',')
+      end
+
+      def feature_exists?(name)
+        if @client.respond_to?(:exists?)
+          @client.exists?(key(name))
+        else
+          @client.exists(key(name))
+        end
+      end
+
+      def save_feature(state)
+        @client.set(key(state.name), ::Rollout::Redis::Codec.encode(state))
+        names = feature_names.map(&:to_s) | [state.name.to_s]
+        @client.set(FEATURES_KEY, names.join(','))
+      end
+
+      def delete_feature(name)
+        names = feature_names
+        names.delete(name.to_s)
+        @client.set(FEATURES_KEY, names.join(','))
+        @client.del(key(name))
+      end
+
+      def clear_features
+        @client.del(FEATURES_KEY)
+      end
+
+      def mutate_feature(name)
+        mutation = yield fetch_feature(name)
+        save_feature(mutation.fetch(:state))
+        event = mutation[:event]
+        if event
+          record_event(
+            event,
+            history_length: mutation.fetch(:history_length),
+            global: mutation[:global],
+          )
+        end
+        mutation
+      end
+
+      def record_event(event, history_length:, global: false)
+        storage_key = events_key(event.feature)
+        @client.zadd(storage_key, -event.timestamp, event.serialize)
+        @client.zremrangebyrank(storage_key, history_length, -1)
+
+        return unless global
+
+        @client.zadd(global_events_key, -event.timestamp, event.serialize)
+        @client.zremrangebyrank(global_events_key, history_length, -1)
+      end
+
+      def feature_events(name, limit: nil)
+        events_from(events_key(name), limit: limit)
+      end
+
+      def global_events(limit: nil)
+        events_from(global_events_key, limit: limit)
+      end
+
+      def feature_updated_at(name)
+        _, score = @client.zrange(events_key(name), 0, 0, with_scores: true).first
+        Time.at(-score.to_f / 1_000_000) if score
+      end
+
+      def delete_feature_events(name)
+        @client.del(events_key(name))
+      end
+
+      private
+
+      def key(name)
+        "feature:#{name}"
+      end
+
+      def events_key(name)
+        "feature:#{name}:logging:events"
+      end
+
+      def global_events_key
+        'feature:_global_:logging:events'
+      end
+
+      def events_from(storage_key, limit: nil)
+        stop = event_range_stop(limit)
+        return [] if stop == :empty
+
+        @client
+          .zrange(storage_key, 0, stop, with_scores: true)
+          .map { |value| ::Rollout::Redis::Codec.decode_event(*value) }
+          .reverse
+      end
+
+      def event_range_stop(limit)
+        return -1 if limit.nil?
+        raise ArgumentError, "limit must be an Integer" unless limit.is_a?(Integer)
+        raise ArgumentError, "limit must be >= 0" if limit < 0
+        return :empty if limit.zero?
+
+        limit - 1
+      end
+    end
+  end
+end

data/lib/rollout/redis/codec.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'rollout/feature_state'
+require 'rollout/logging'
+
+class Rollout
+  module Redis
+    class Codec
+      def self.decode(name, payload)
+        if payload.nil? || payload.empty?
+          return FeatureState.new(
+            name: name,
+            percentage: 0,
+            users: [],
+            groups: [],
+            data: {},
+          )
+        end
+
+        raw_percentage, raw_users, raw_groups, raw_data = payload.split('|', 4)
+        data = raw_data.nil? || raw_data.strip.empty? ? {} : JSON.parse(raw_data)
+
+        FeatureState.new(
+          name: name,
+          percentage: raw_percentage.to_f,
+          users: (raw_users || '').split(','),
+          groups: (raw_groups || '').split(','),
+          data: data,
+        )
+      end
+
+      def self.encode(feature_state)
+        "#{feature_state.percentage}|#{feature_state.users.join(',')}|#{feature_state.groups.join(',')}|#{feature_state.data.to_json}"
+      end
+
+      def self.decode_event(value, score)
+        hash = JSON.parse(value, symbolize_names: true)
+
+        Logging::Event.new(**hash.merge(created_at: Time.at(-score.to_f / 1_000_000)))
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: rollout-redis-adapter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- FetLife
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: rollout
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+description: Redis adapter for the rollout gem.
+email:
+- dev@fetlife.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- lib/rollout/adapters/redis.rb
+- lib/rollout/redis/codec.rb
+homepage: https://github.com/FetLife/rollout
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Redis adapter for the rollout gem.
+test_files: []