tailslide 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1a5e8473d47cabf7b875eed87f308f7ce87146c9f985be62f03c8de6122fa04
-  data.tar.gz: 7de6db758b0fc8fd7034212ace03061c53a7fc717ab3e68dc87bc46450f69098
+  metadata.gz: bd4e9eea51d59ec4a285b3531dd36e00bb2f437e1df5e50240014c59641c7499
+  data.tar.gz: feaae9d7f5af47900a5031426e9015290a552e0b0eb8060f80b16c2aa148df3d
 SHA512:
-  metadata.gz: 70b5ddcb2530404fefa63309de3ffbeab55b078cfbd7578890e92e40be4d035510a4c9c3c324a02465894fd8f8e1cab55423ad638acd3911ac73b08973daaaa8
-  data.tar.gz: 17cb8385bdb5c5f320dda627f33ff333ab6a34ae3853d66dfdc8b37bfaf64f124cf2cd2f8bd8572ab043c1fcd1c32dfc8c205e672553c1c69edeb4741bfbe68e
+  metadata.gz: 81e5ec75a95f6edce34ad2136376b222e02712bc30b49ed0c0f9423a0a9b9ad78d810269a0002f607d8d9d538779c5e0237e1a264e12dc98fcd59555eb35331b
+  data.tar.gz: c4d4c5276a112b56c2d36596e67a438a47f0f071de792cd46b04021d5e6cfb3fca8d5a712ff26c65eaca9f9565cea7913da8fba5c91db9311b34c6222900ce01

data/.vscode/launch.json

@@ -0,0 +1,14 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Debug Local File",
+      "type": "Ruby",
+      "request": "launch",
+      "program": "./test.rb"
+    }
+  ]
+}

data/.vscode/settings.json

@@ -0,0 +1,10 @@
+{
+  "workbench.colorCustomizations": {
+    "sash.hoverBorder": "#3b3b3b",
+    "titleBar.activeBackground": "#222222",
+    "titleBar.activeForeground": "#e7e7e7",
+    "titleBar.inactiveBackground": "#22222299",
+    "titleBar.inactiveForeground": "#e7e7e799"
+  },
+  "editor.acceptSuggestionOnEnter": "on"
+}

data/Gemfile

@@ -5,8 +5,13 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in tailslide.gemspec
 gemspec
 
+gem "async", "~> 2,0.3"
+gem "nats-pure", "~> 2,1.0"
+gem "redis", "~>4.7.1"
+gem "redistimeseries", "~>0.1.2"
 gem "rake", "~> 13.0"
 
 gem "minitest", "~> 5.0"
 
 gem "rubocop", "~> 1.21"
+

data/lib/tailslide/flag_manager.rb

@@ -0,0 +1,41 @@
+require_relative 'nats_client'
+require_relative 'redis_timeseries_client'
+require_relative 'toggler'
+
+class FlagManger
+  attr_reader :nats_client, :redis_ts_client, :user_context
+
+  def initialize(nats_server:'', stream:'', app_id:'', sdk_key:'', user_context:'', redis_host:'', redis_port:'')
+    @nats_client = NatsClient.new(server_url: nats_server, stream:stream, subject:app_id, callback:method(:set_flags), token:sdk_key)
+    @redis_ts_client = RedisTimeSeriesClient.new(redis_host, redis_port)
+    @user_context = user_context
+    @flags = []
+  end
+  
+  def initialize_flags
+    nats_client.initialize_flags
+    redis_ts_client.init
+  end
+  
+  def set_flags(flags)
+    @flags = flags
+  end
+  
+  def get_flags
+    return @flags
+  end
+  
+  def disconnect
+    nats_client.disconnect
+    redis_ts_client.disconnect
+  end
+  
+  def new_toggler(config)
+    p config
+
+    return Toggler.new(**config, get_flags:method(:get_flags), user_context:user_context,
+                       emit_redis_signal:redis_ts_client.method(:emit_signal)
+                      )
+  end
+  
+end

data/lib/tailslide/nats_client.rb

@@ -0,0 +1,58 @@
+require 'async'
+require "nats/client"
+TimeoutError = NATS::IO::Timeout
+require 'json'
+
+
+class NatsClient
+  attr_accessor :nats_connection, :jetstream, :subscribed_stream
+  attr_reader :connection_string, :stream, :subject, :callback
+  def initialize(server_url:'localhost:4222', stream:'', subject:'', callback:nil, token:'')
+    @stream = stream
+    @subject = subject
+    @connection_string = "nats://#{token}#{'@' if token}#{server_url}"
+    @callback = callback
+  end
+  
+  def initialize_flags
+    connect()
+    fetch_latest_message()
+    fetch_ongoing_event_messages()
+  end
+  
+  private
+  def connect
+    self.nats_connection = NATS.connect(connection_string)
+    self.jetstream = nats_connection.jetstream
+  end
+  
+  def fetch_latest_message
+    begin
+      latest_msg = jetstream.get_last_msg(stream, subject)
+      json_data = JSON.parse latest_msg.data
+      callback.call(json_data)
+    rescue NATS::Timeout => e
+    end
+  end
+  
+  def fetch_ongoing_event_messages
+    Async do |task|
+      self.subscribed_stream = jetstream.pull_subscribe(subject, 'me', config: { deliver_policy: 'new' })
+      begin
+        messages = subscribed_stream.fetch(1)
+        messages.each do |message|
+          message.ack
+          json_data = JSON.parse message.data
+          p json_data
+          callback.call(json_data)
+        end
+      rescue NATS::IO::Timeout => e
+        p e
+      end until nats_connection.closed?
+    end
+  end
+  
+  def disconnect
+    nats_connection.close
+  end
+end

data/lib/tailslide/redis_timeseries_client.rb

@@ -0,0 +1,21 @@
+
+require 'redistimeseries'
+using Redistimeseries::RedisRefinement
+
+class RedisTimeSeriesClient
+  attr_reader :host, :port
+  attr_accessor :redis_client
+  def initialize(host, port)
+    @host = host || 'localhost'
+    @port = port || 6379
+  end
+
+  def init
+    self.redis_client = Redis.new(host:host, port:port)
+  end
+  
+  def emit_signal(flag_id, app_id, status)
+    redis_client.ts_add(key: "#{flag_id}:#{status}", timestamp:"*", value:1, labels:["status", status, "appId", app_id, "flagId", flag_id])
+  end
+
+end

data/lib/tailslide/toggler.rb

@@ -0,0 +1,73 @@
+require 'digest'
+
+class Toggler
+  attr_reader :flag_name, :get_flags, :feature_cb, :default_cb, :error_condition, :emit_redis_signal, :user_context
+  attr_accessor :app_id, :flag_id
+  def initialize(flag_name:'', feature_cb:nil, default_cb:nil, error_condition:nil, get_flags:nil, emit_redis_signal:nil, user_context:'')
+    @flag_name = flag_name
+    @feature_cb = feature_cb
+    @default_cb = default_cb
+    @error_condition = error_condition
+    @get_flags = get_flags
+    @flag_id = nil
+    @app_id = nil
+    set_flag_id_and_app_id(flag_name)
+    @emit_redis_signal = emit_redis_signal
+    @user_context = user_context
+  end
+  
+  def is_flag_active
+    flag = get_matching_flag
+    flag["is_active"] && (is_user_white_listed(flag) || validate_user_rollout(flag))
+  end
+  
+  def emit_success
+    return unless flag_id
+    p 'emiting success'
+    emit_redis_signal.call(flag_id, app_id, 'success')
+  end
+
+  def emit_failure
+    return unless flag_id
+    emit_redis_signal.call(flag_id, app_id, 'failure')
+  end
+  
+  private
+  def get_matching_flag
+    flag = get_flags.call.find { |flag| flag["title"] == flag_name}
+    raise Exception.new "Cannot find flag with flag name of: #{flag_name}" unless flag
+    flag
+  end
+  
+  def set_flag_id_and_app_id(flag_name)
+    matching_flag = get_matching_flag
+    self.flag_id = matching_flag["id"]
+    self.app_id = matching_flag["app_id"]
+  end
+  
+  def is_user_white_listed(flag)
+    flag["white_listed_users"].split(',').include?(user_context)
+  end
+  
+  def validate_user_rollout(flag)
+    rollout = flag["rollout_percentage"] / 100.0
+    if is_circuit_in_recovery(flag)
+      rollout = rollout * (flag["circuit_recovery_percentage"] / 100.0)
+    end
+    is_user_in_rollout(rollout)
+  end
+  
+  def is_circuit_in_recovery(flag)
+    flag["is_recoverable"] && flag["circuit_status"] == "recovery"
+  end
+  
+  def is_user_in_rollout(rollout)
+    puts "User context hash #{hash_user_context}"
+    puts "Rollout: #{rollout}"
+    hash_user_context <= rollout
+  end
+  
+  def hash_user_context
+    (Digest::MD5.hexdigest(user_context).to_i(base=16) % 100) / 100.0
+  end
+end

data/lib/tailslide/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Tailslide
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/lib/tailslide.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
 require_relative "tailslide/version"
+require_relative "tailslide/flag_manager"
 
 module Tailslide
-  class Error < StandardError; end
+  class FlagManger < FlagManger
+  end
   # Your code goes here...
 end

data/redis_test.rb

@@ -0,0 +1,8 @@
+require 'redistimeseries'
+using Redistimeseries::RedisRefinement
+
+app_id = 1
+flag_id = 1
+status = 'success'
+redis_client = Redis.new(host:'localhost', port: 6379)
+redis_client.ts_add(key: "#{flag_id}:#{status}", timestamp:"*", value:1, labels:["status", status, "appId", app_id, "flagId", flag_id])

data/test.rb

@@ -0,0 +1,129 @@
+require "async"
+# require "./lib/tailslide/nats_client.rb"
+require_relative "lib/tailslide/flag_manager.rb"
+require_relative 'lib/tailslide/toggler'
+
+# def logMessage(message)
+#   p message
+# end
+
+# config = {server_url: "localhost:4222", callback: :p, token: 'myToken', stream:"flags", subject:'1'}
+app_id = "1"
+flag_name = 'Flag in app 1 number 1'
+flag_config = {"flag_name": flag_name}
+
+config = {nats_server:'localhost:4222', stream:'flags', app_id:app_id, sdk_key:'myToken', user_context:'375d39e6-9c3f-4f58-80bd-e5960b710295',
+   redis_host:'localhost', redis_port:6379}
+
+
+Async do |task|
+  manager = FlagManger.new(**config) 
+  manager.initialize_flags
+  flag_toggler = manager.new_toggler(flag_config)
+  
+
+  if flag_toggler.is_flag_active
+    puts "Flag in #{app_id} with name \"#{flag_name}\" is active!"
+    flag_toggler.emit_success()
+  else
+    puts "Flag in #{app_id} with name \"#{flag_name}\" is not active!"
+    flag_toggler.emit_failure()
+  end
+  sleep 5
+
+  if flag_toggler.is_flag_active
+    puts "Flag in #{app_id} with name \"#{flag_name}\" is active!"
+    flag_toggler.emit_success()
+  else
+    puts "Flag in #{app_id} with name \"#{flag_name}\" is not active!"
+    flag_toggler.emit_failure()
+  end
+end
+
+
+# require "nats/client"
+# require "async"
+# TimeoutError = NATS::IO::Timeout
+# require 'json'
+
+# token = "myToken"
+
+# nats_client = NATS.connect("nats://#{token}@127.0.0.1:4222")
+# jet_stream = nats_client.jetstream
+
+# # get last message
+# latest_msg = jet_stream.get_last_msg("flags", "test")
+# json_data = JSON.parse latest_msg.data
+# p json_data
+
+
+# # pull subscribe for new onging messages (workaround until Nats.rb make new update)
+# subscribed_stream = jet_stream.pull_subscribe("test", 'mydurable', config: { deliver_policy: 'new' })
+# Async do |task|
+#   task.async do 
+#       begin
+#       messages = subscribed_stream.fetch(1)
+#       messages.each do |message|
+#         message.ack
+#         json_data = JSON.parse message.data
+#         p json_data
+#       end
+#     rescue NATS::Timeout => e
+#       p e
+#     end until nats_client.closed?
+#   end
+#   p "hello past async"
+# end
+
+
+
+# push subscribe for new ongoing messages
+# setting deliver_policy still results in delivering all messages in "test" subject
+# push_sub = jetStream.subscribe("test", {manual_ack: true, deliver_policy:"new"} ) do |msg|
+#   msg.ack
+#   puts msg.data
+# end
+
+# Get ongoing messages
+# Push subscribe
+# consumer_req = {
+#   stream_name: "test",
+#   config: {
+#     durable_name: "sample",
+#     deliver_policy: "new",
+#     ack_policy: "explicit",
+#     max_deliver: -1,
+#     replay_policy: "instant"
+#   }
+# }
+
+# config = NATS::JetStream::API::ConsumerConfig.new({ deliver_policy: "new" })
+  # Create inbox for push consumer.
+# deliver = natsClient.new_inbox
+# config.deliver_subject = deliver
+
+# push_sub = jetStream.subscribe("test", {manual_ack: true, deliver_policy:"new"} ) do |msg|
+#   puts msg.data
+# end
+
+# cinfo = push_sub.consumer_info["config"]
+# puts cinfo
+# msg = push_sub.next_msg(timeout: 10000000000)
+# msg.ack
+# puts msg.data
+# push_sub.consumer_info["config"]["deliver_policy"] = "new"
+# puts cinfo
+
+# loop do
+#   msgs = push_sub.next_msg()
+#   puts msgs.data
+# rescue TimeoutError => e
+#   puts e
+#   sleep 1
+# end
+
+# js.publish("9", "Hello JetStream! 1")
+# js.publish("9", "Hello JetStream! 2")
+# js.publish("9", "Hello JetStream! 3")
+# js.publish("9", "Hello JetStream! 4")
+# js.publish("9", "Hello JetStream! Latest")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tailslide
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Steven Liou
@@ -11,8 +11,22 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-13 00:00:00.000000000 Z
-dependencies: []
+date: 2022-07-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: "[]"
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: " Write a longer description or delete this line."
 email:
 - stevenliou@gmail.com
@@ -23,7 +37,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rubocop.yml"
+- ".vscode/launch.json"
+- ".vscode/settings.json"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -31,8 +46,15 @@ files:
 - README.md
 - Rakefile
 - lib/tailslide.rb
+- lib/tailslide/flag_manager.rb
+- lib/tailslide/nats_client.rb
+- lib/tailslide/redis_timeseries_client.rb
+- lib/tailslide/toggler.rb
 - lib/tailslide/version.rb
+- redis_test.rb
 - sig/tailslide.rbs
+- tailslide-0.1.0.gem
+- test.rb
 homepage: https://github.com/tailslide-io/tailslide.rb
 licenses:
 - MIT
@@ -58,5 +80,6 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: Write a short summary, because RubyGems requires one.
+summary: This is the Ruby SDK for Tailslide, which is a feature flag framework with
+  automatic fail safe and circuit recovery.
 test_files: []

data/.rubocop.yml

@@ -1,13 +0,0 @@
-AllCops:
-  TargetRubyVersion: 2.6
-
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Layout/LineLength:
-  Max: 120