devcycle-ruby-server-sdk 1.2.0 → 2.0.1

data/lib/devcycle-ruby-server-sdk/localbucketing/event_types.rb

@@ -0,0 +1,8 @@
+module DevCycle
+  EventTypes = {
+    variable_evaluated: 'variableEvaluated',
+    agg_variable_evaluated: 'aggVariableEvaluated',
+    variable_defaulted: 'variableDefaulted',
+    agg_variable_defaulted: 'aggVariableDefaulted'
+  }.freeze
+end

data/lib/devcycle-ruby-server-sdk/localbucketing/events_payload.rb

@@ -0,0 +1,23 @@
+require 'sorbet-runtime'
+
+module DevCycle
+  class EventsPayload
+    attr_reader :records
+    attr_reader :payloadId
+    attr_reader :eventCount
+
+    def initialize(records, payloadId, eventCount)
+      @records = records
+      @payloadId = payloadId
+      @eventCount = eventCount
+    end
+  end
+
+  class EventsRecord
+    def initialize(user, events)
+      @user = user
+      @events = events
+    end
+
+  end
+end

data/lib/devcycle-ruby-server-sdk/localbucketing/local_bucketing.rb

@@ -0,0 +1,257 @@
+require 'wasmtime'
+require 'date'
+require 'bigdecimal'
+require 'sorbet-runtime'
+
+require_relative 'dvc_options'
+require_relative 'platform_data'
+require_relative 'events_payload'
+require_relative 'config_manager'
+
+module DevCycle
+  class LocalBucketing
+    extend T::Sig
+
+    attr_reader :options
+    attr_accessor :initialized
+
+    @@rand = Random.new(seed = Random.new_seed)
+    @@engine = Wasmtime::Engine.new
+
+    @@wasmmodule = Wasmtime::Module.from_file(@@engine, "#{__dir__}/bucketing-lib.release.wasm")
+    @@wasi_ctx = Wasmtime::WasiCtxBuilder.new
+                                         .inherit_stdout
+                                         .inherit_stderr
+                                         .set_argv(ARGV)
+                                         .set_env(ENV)
+    @@store = Wasmtime::Store.new(@@engine, wasi_ctx: @@wasi_ctx)
+    @@linker = Wasmtime::Linker.new(@@engine, wasi: true)
+
+    @@linker.func_new("env", "Date.now", [], [:f64]) do |_caller|
+      DateTime.now.strftime("%Q").to_i
+    end
+
+    inline_read_asc_string = lambda { |address|
+      raw_bytes = @@memory.read(address - 4, 4).bytes.reverse
+      message_len = 0
+      raw_bytes.each { |j|
+        message_len = (message_len << 8) + (j & 0xFF)
+      }
+      length = message_len
+      result = ""
+      i = 0
+      while i < length
+        result += @@memory.read(address + i, 1)
+        i += 2
+      end
+      result
+    }
+
+    @@stack_tracer = lambda {}
+
+    @@linker.func_new("env", "abort", [:i32, :i32, :i32, :i32], []) do |_caller, messagePtr, filenamePtr, lineNum, colNum|
+
+      exception_message = ""
+      exception_filename = ""
+
+      [messagePtr, filenamePtr].each { |m|
+        result = inline_read_asc_string.call(m)
+        if m == messagePtr
+          exception_message = result
+        else
+          if m == filenamePtr
+            exception_filename = result
+          end
+        end
+      }
+      @@stack_tracer.call("WASM Exception: #{exception_message} - #{exception_filename} #{lineNum}:#{colNum}")
+    end
+
+    @@linker.func_new("env", "console.log", [:i32], []) do |_caller, messagePtr|
+      @logger.info(inline_read_asc_string.call(messagePtr))
+    end
+
+    @@linker.func_new("env", "seed", [], [:f64]) do |_caller|
+      @@rand.rand(1.0) * DateTime.now.strftime("%Q").to_i
+
+    end
+
+    @@instance = @@linker.instantiate(@@store, @@wasmmodule)
+    @@memory = @@instance.export("memory").to_memory
+
+    sig { params(
+      sdkkey: String,
+      options: DVCOptions,
+      wait_for_init: T::Boolean
+    ).void }
+    def initialize(sdkkey, options, wait_for_init)
+      @initialized = false
+      @sdkkey = sdkkey
+      @options = options
+      @logger = options.logger
+
+      platform_data = PlatformData.new('server', VERSION, RUBY_VERSION, nil, 'Ruby', Socket.gethostname)
+      set_platform_data(platform_data)
+      @configmanager = ConfigManager.new(@sdkkey, self, wait_for_init)
+    end
+
+    def close
+      @configmanager.close
+      @configmanager = nil
+    end
+
+    sig { params(user: UserData).returns(BucketedUserConfig) }
+    def generate_bucketed_config(user)
+      sdkkey_addr = malloc_asc_string(@sdkkey)
+      user_addr = malloc_asc_string(user.to_json)
+      @@stack_tracer = lambda { |message| raise message }
+      config_addr = @@instance.invoke("generateBucketedConfigForUser", sdkkey_addr, user_addr)
+      bucketed_config_json = read_asc_string(config_addr)
+      bucketed_config_hash = Oj.load(bucketed_config_json)
+      BucketedUserConfig.new(bucketed_config_hash['project'],
+                             bucketed_config_hash['environment'],
+                             bucketed_config_hash['features'],
+                             bucketed_config_hash['featureVariationMap'],
+                             bucketed_config_hash['variableVariationMap'],
+                             bucketed_config_hash['variables'],
+                             bucketed_config_hash['knownVariableKeys'])
+    end
+
+    sig { returns(T::Array[EventsPayload]) }
+    def flush_event_queue
+      sdkkey_addr = malloc_asc_string(@sdkkey)
+      @@stack_tracer = lambda { |message| raise message }
+      payload_addr = @@instance.invoke("flushEventQueue", sdkkey_addr)
+      raw_json = read_asc_string(payload_addr)
+      raw_payloads = Oj.load(raw_json)
+
+      if raw_payloads == nil
+        return []
+      end
+      raw_payloads.map { |raw_payload| EventsPayload.new(raw_payload["records"], raw_payload["payloadId"], raw_payload["eventCount"]) }
+    end
+
+    sig { returns(Integer) }
+    def check_event_queue_size
+      sdkkey_addr = malloc_asc_string(@sdkkey)
+      @@stack_tracer = lambda { |message| raise message }
+      @@instance.invoke("eventQueueSize", sdkkey_addr)
+    end
+
+    sig { params(payload_id: String).returns(NilClass) }
+    def on_payload_success(payload_id)
+      sdkkey_addr = malloc_asc_string(@sdkkey)
+      payload_addr = malloc_asc_string(payload_id)
+      @@stack_tracer = lambda { |message| raise message }
+      @@instance.invoke("onPayloadSuccess", sdkkey_addr, payload_addr)
+    end
+
+    sig { params(user: UserData, event: Event).returns(NilClass) }
+    def queue_event(user, event)
+      sdkkey_addr = malloc_asc_string(@sdkkey)
+      user_addr = malloc_asc_string(Oj.dump(user))
+      event_addr = malloc_asc_string(Oj.dump(event))
+      @@stack_tracer = lambda { |message| raise message }
+      @@instance.invoke("queueEvent", sdkkey_addr, user_addr, event_addr)
+    end
+
+    sig { params(event: Event, bucketeduser: T.nilable(BucketedUserConfig)).returns(NilClass) }
+    def queue_aggregate_event(event, bucketeduser)
+      sdkkey_addr = malloc_asc_string(@sdkkey)
+      variable_variation_map =
+      if !bucketeduser.nil?
+        bucketeduser.variable_variation_map 
+      else
+        {}
+      end
+      varmap_addr = malloc_asc_string(Oj.dump(variable_variation_map))
+      event_addr = malloc_asc_string(Oj.dump(event))
+      @@stack_tracer = lambda { |message| raise message }
+      @@instance.invoke("queueAggregateEvent", sdkkey_addr, event_addr, varmap_addr)
+    end
+
+    sig { params(payload_id: String, retryable: Object).returns(NilClass) }
+    def on_payload_failure(payload_id, retryable)
+      sdkkey_addr = malloc_asc_string(@sdkkey)
+      payload_addr = malloc_asc_string(payload_id)
+      @@stack_tracer = lambda { |message| raise message }
+      @@instance.invoke("onPayloadFailure", sdkkey_addr, payload_addr, retryable ? 1 : 0)
+    end
+
+    sig { params(sdkkey: String, config: String).returns(NilClass) }
+    def store_config(sdkkey, config)
+      sdkkey_addr = malloc_asc_string(sdkkey)
+      config_addr = malloc_asc_string(config)
+      @@stack_tracer = lambda { |message| raise message }
+      @@instance.invoke("setConfigData", sdkkey_addr, config_addr)
+    end
+
+    sig { params(options: EventQueueOptions).returns(NilClass) }
+    def init_event_queue(options)
+      options_json = Oj.dump(options)
+      sdkkey_addr = malloc_asc_string(@sdkkey)
+      options_addr = malloc_asc_string(options_json)
+      @@stack_tracer = lambda { |message| raise message }
+      @@instance.invoke("initEventQueue", sdkkey_addr, options_addr)
+    end
+
+    sig { params(customdata: Hash).returns(NilClass) }
+    def set_client_custom_data(customdata)
+      customdata_json = Oj.dump(customdata)
+      customdata_addr = malloc_asc_string(customdata_json)
+      @@stack_tracer = lambda { |message| raise message }
+      @@instance.invoke("setClientCustomData", customdata_addr)
+    end
+
+    private
+
+    sig { params(platformdata: PlatformData).returns(NilClass) }
+    def set_platform_data(platformdata)
+      platformdata_json = Oj.dump(platformdata)
+      platformdata_addr = malloc_asc_string(platformdata_json)
+      @@stack_tracer = lambda { |message| raise message }
+      @@instance.invoke("setPlatformData", platformdata_addr)
+    end
+
+    # @param [String] string utf8 string to allocate
+    # @return [Integer] address to WASM String
+    sig { params(string: String).returns(Integer) }
+    def malloc_asc_string(string)
+      wasm_object_id = 1
+      @@stack_tracer = lambda { |message| raise message }
+      wasm_new = @@instance.export("__new").to_func
+      utf8_bytes = string.encode("iso-8859-1").force_encoding("utf-8").bytes
+      byte_len = utf8_bytes.length
+
+      start_addr = wasm_new.call(byte_len * 2, wasm_object_id)
+      i = 0
+      while i < byte_len
+        @@stack_tracer = lambda { |message| raise message }
+        @@memory.write(start_addr + (i * 2), [utf8_bytes[i]].pack('U'))
+        i += 1
+      end
+      start_addr
+    end
+
+    # @param [Integer] address start address of string.
+    # @return [String] resulting string
+    sig { params(address: Integer).returns(String) }
+    def read_asc_string(address)
+      @@stack_tracer = lambda { |message| raise message }
+      raw_bytes = @@memory.read(address - 4, 4).bytes.reverse
+      len = 0
+      raw_bytes.each { |j|
+        len = (len << 8) + (j & 0xFF)
+      }
+      result = ""
+      i = 0
+      while i < len
+        @@stack_tracer = lambda { |message| raise message }
+        result += @@memory.read(address + i, 1)
+        i += 2
+      end
+      result
+    end
+  end
+end
+

data/lib/devcycle-ruby-server-sdk/localbucketing/platform_data.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'socket'
+require 'json'
+
+module DevCycle
+  class PlatformData
+    attr_accessor :deviceModel, :platformVersion, :sdkVersion, :sdkType, :platform, :hostname
+
+    def initialize(sdk_type = nil, sdk_version = nil, platform_version = nil, device_model = nil, platform = nil, hostname = nil)
+      @sdkType = sdk_type
+      @sdkVersion = sdk_version
+      @platformVersion = platform_version
+      @deviceModel = device_model
+      @platform = platform
+      @hostname = hostname
+    end
+
+    def default
+      @sdkType = 'server'
+      @sdkVersion = VERSION
+      @platformVersion = RUBY_VERSION
+      @deviceModel = nil
+      @platform = 'Ruby'
+      @hostname = Socket.gethostname
+      self
+    end
+  end
+end

data/lib/devcycle-ruby-server-sdk/models/event.rb

@@ -28,7 +28,7 @@ module DevCycle
     attr_accessor :value
 
     # Extra JSON metadata for event. Contextual to event type
-    attr_accessor :meta_data
+    attr_accessor :metaData
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
@@ -37,7 +37,7 @@ module DevCycle
         :'target' => :'target',
         :'date' => :'date',
         :'value' => :'value',
-        :'meta_data' => :'metaData'
+        :'metaData' => :'metaData'
       }
     end
 
@@ -53,7 +53,7 @@ module DevCycle
         :'target' => :'String',
         :'date' => :'Float',
         :'value' => :'Float',
-        :'meta_data' => :'Object'
+        :'metaData' => :'Object'
       }
     end
 
@@ -94,8 +94,8 @@ module DevCycle
         self.value = attributes[:'value']
       end
 
-      if attributes.key?(:'meta_data')
-        self.meta_data = attributes[:'meta_data']
+      if attributes.key?(:'metaData')
+        self.metaData = attributes[:'metaData']
       end
     end
 
@@ -138,7 +138,7 @@ module DevCycle
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [type, target, date, value, meta_data].hash
+      [type, target, date, value, metaData].hash
     end
 
     # Builds the object from hash

data/lib/devcycle-ruby-server-sdk/models/user_data.rb

@@ -12,9 +12,14 @@ OpenAPI Generator version: 5.3.0
 
 require 'date'
 require 'time'
+require 'oj'
 
 module DevCycle
   class UserData
+
+    def to_json
+      Oj.dump(self)
+    end
     # Unique id to identify the user
     attr_accessor :user_id
 
@@ -31,37 +36,39 @@ module DevCycle
     attr_accessor :country
 
     # App Version of the running application
-    attr_accessor :app_version
+    attr_accessor :appVersion
 
     # App Build number of the running application
-    attr_accessor :app_build
+    attr_accessor :appBuild
 
     # User's custom data to target the user with, data will be logged to DevCycle for use in dashboard.
-    attr_accessor :custom_data
+    attr_accessor :customData
 
     # User's custom data to target the user with, data will not be logged to DevCycle only used for feature bucketing.
-    attr_accessor :private_custom_data
+    attr_accessor :privateCustomData
+
+    # User's device model
+    attr_accessor :deviceModel
+
+    # read-only instance variables
 
     # Date the user was created, Unix epoch timestamp format
-    attr_accessor :created_date
+    attr_reader :createdDate
 
     # Date the user was created, Unix epoch timestamp format
-    attr_accessor :last_seen_date
+    attr_reader :lastSeenDate
 
     # Platform the Client SDK is running on
-    attr_accessor :platform
+    attr_reader :platform
 
     # Version of the platform the Client SDK is running on
-    attr_accessor :platform_version
-
-    # User's device model
-    attr_accessor :device_model
+    attr_reader :platformVersion
 
     # DevCycle SDK type
-    attr_accessor :sdk_type
+    attr_reader :sdkType
 
     # DevCycle SDK Version
-    attr_accessor :sdk_version
+    attr_reader :sdkVersion
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -93,17 +100,17 @@ module DevCycle
         :'name' => :'name',
         :'language' => :'language',
         :'country' => :'country',
-        :'app_version' => :'appVersion',
-        :'app_build' => :'appBuild',
-        :'custom_data' => :'customData',
-        :'private_custom_data' => :'privateCustomData',
-        :'created_date' => :'createdDate',
-        :'last_seen_date' => :'lastSeenDate',
+        :'appVersion' => :'appVersion',
+        :'appBuild' => :'appBuild',
+        :'customData' => :'customData',
+        :'privateCustomData' => :'privateCustomData',
+        :'createdDate' => :'createdDate',
+        :'lastSeenDate' => :'lastSeenDate',
         :'platform' => :'platform',
-        :'platform_version' => :'platformVersion',
-        :'device_model' => :'deviceModel',
-        :'sdk_type' => :'sdkType',
-        :'sdk_version' => :'sdkVersion'
+        :'platformVersion' => :'platformVersion',
+        :'deviceModel' => :'deviceModel',
+        :'sdkType' => :'sdkType',
+        :'sdkVersion' => :'sdkVersion'
       }
     end
 
@@ -120,24 +127,23 @@ module DevCycle
         :'name' => :'String',
         :'language' => :'String',
         :'country' => :'String',
-        :'app_version' => :'String',
-        :'app_build' => :'String',
-        :'custom_data' => :'Object',
-        :'private_custom_data' => :'Object',
-        :'created_date' => :'Float',
-        :'last_seen_date' => :'Float',
+        :'appVersion' => :'String',
+        :'appBuild' => :'String',
+        :'customData' => :'Object',
+        :'privateCustomData' => :'Object',
+        :'createdDate' => :'Float',
+        :'lastSeenDate' => :'Float',
         :'platform' => :'String',
-        :'platform_version' => :'String',
-        :'device_model' => :'String',
-        :'sdk_type' => :'String',
-        :'sdk_version' => :'String'
+        :'platformVersion' => :'String',
+        :'deviceModel' => :'String',
+        :'sdkType' => :'String',
+        :'sdkVersion' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
-      Set.new([
-      ])
+      Set.new([])
     end
 
     # Initializes the object
@@ -155,8 +161,6 @@ module DevCycle
         h[k.to_sym] = v
       }
 
-      self.set_default_platform_info()
-
       if attributes.key?(:'user_id')
         self.user_id = attributes[:'user_id']
       end
@@ -177,56 +181,34 @@ module DevCycle
         self.country = attributes[:'country']
       end
 
-      if attributes.key?(:'app_version')
-        self.app_version = attributes[:'app_version']
-      end
-
-      if attributes.key?(:'app_build')
-        self.app_build = attributes[:'app_build']
-      end
-
-      if attributes.key?(:'custom_data')
-        self.custom_data = attributes[:'custom_data']
-      end
-
-      if attributes.key?(:'private_custom_data')
-        self.private_custom_data = attributes[:'private_custom_data']
+      if attributes.key?(:'appVersion')
+        self.appVersion = attributes[:'appVersion']
       end
 
-      if attributes.key?(:'created_date')
-        self.created_date = attributes[:'created_date']
+      if attributes.key?(:'appBuild')
+        self.appBuild = attributes[:'appBuild']
       end
 
-      if attributes.key?(:'last_seen_date')
-        self.last_seen_date = attributes[:'last_seen_date']
+      if attributes.key?(:'customData')
+        self.customData = attributes[:'customData']
       end
 
-      if attributes.key?(:'platform')
-        self.platform = attributes[:'platform']
+      if attributes.key?(:'privateCustomData')
+        self.privateCustomData = attributes[:'privateCustomData']
       end
 
-      if attributes.key?(:'platform_version')
-        self.platform_version = attributes[:'platform_version']
+      if attributes.key?(:'deviceModel')
+        self.deviceModel = attributes[:'deviceModel']
       end
 
-      if attributes.key?(:'device_model')
-        self.device_model = attributes[:'device_model']
-      end
-
-      if attributes.key?(:'sdk_type')
-        self.sdk_type = attributes[:'sdk_type']
-      end
-
-      if attributes.key?(:'sdk_version')
-        self.sdk_version = attributes[:'sdk_version']
-      end
-    end
-
-    def set_default_platform_info
-      self.sdk_type = 'server'
-      self.sdk_version = VERSION
-      self.platform = 'ruby'
-      self.platform_version = RUBY_VERSION
+      # set read-only instance variables
+      default_platform_data = PlatformData.new.default
+      @sdkType = default_platform_data.sdkType
+      @sdkVersion = default_platform_data.sdkVersion
+      @platform = default_platform_data.platform
+      @platformVersion = default_platform_data.platformVersion
+      @createdDate = Time.now.utc.iso8601
+      @lastSeenDate = Time.now.utc.iso8601
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -279,37 +261,27 @@ module DevCycle
       @country = country
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] sdk_type Object to be assigned
-    def sdk_type=(sdk_type)
-      validator = EnumAttributeValidator.new('String', ["api", "server"])
-      unless validator.valid?(sdk_type)
-        fail ArgumentError, "invalid value for \"sdk_type\", must be one of #{validator.allowable_values}."
-      end
-      @sdk_type = sdk_type
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          user_id == o.user_id &&
-          email == o.email &&
-          name == o.name &&
-          language == o.language &&
-          country == o.country &&
-          app_version == o.app_version &&
-          app_build == o.app_build &&
-          custom_data == o.custom_data &&
-          private_custom_data == o.private_custom_data &&
-          created_date == o.created_date &&
-          last_seen_date == o.last_seen_date &&
-          platform == o.platform &&
-          platform_version == o.platform_version &&
-          device_model == o.device_model &&
-          sdk_type == o.sdk_type &&
-          sdk_version == o.sdk_version
+        user_id == o.user_id &&
+        email == o.email &&
+        name == o.name &&
+        language == o.language &&
+        country == o.country &&
+        appVersion == o.appVersion &&
+        appBuild == o.appBuild &&
+        customData == o.customData &&
+        privateCustomData == o.privateCustomData &&
+        createdDate == o.createdDate &&
+        lastSeenDate == o.lastSeenDate &&
+        platform == o.platform &&
+        platformVersion == o.platformVersion &&
+        deviceModel == o.deviceModel &&
+        sdkType == o.sdkType &&
+        sdkVersion == o.sdkVersion
     end
 
     # @see the `==` method
@@ -321,7 +293,7 @@ module DevCycle
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [user_id, email, name, language, country, app_version, app_build, custom_data, private_custom_data, created_date, last_seen_date, platform, platform_version, device_model, sdk_type, sdk_version].hash
+      [user_id, email, name, language, country, appVersion, appBuild, customData, privateCustomData, createdDate, lastSeenDate, platform, platformVersion, deviceModel, sdkType, sdkVersion].hash
     end
 
     # Builds the object from hash
@@ -389,7 +361,8 @@ module DevCycle
             hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
           end
         end
-      else # model
+      else
+        # model
         # models (e.g. Pet) or oneOf
         klass = DevCycle.const_get(type)
         klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
@@ -441,7 +414,5 @@ module DevCycle
         value
       end
     end
-
   end
-
 end