redcord 0.0.2.alpha → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 679b0154429c95be05676a47608f0778c3d34e714d60eb5ec065863691fa9461
-  data.tar.gz: 43847db0f9fd339c8a91db402b8b2da70ea4b3f874b6faf8a05d20f234cf0aea
+  metadata.gz: 7612a04876a98367ab0b8a6d94a0254d0d79aa564b3bd43e5119785f114d962c
+  data.tar.gz: 9b679659f7087bfd65d202a58be3f0836b1a7e8bc889f16d34e423340ce8c4ed
 SHA512:
-  metadata.gz: b01c381b8e3436aaf0f4d2ebc8604bfd582c64663601a17044b0a29ca45c46e4e8ced22969ed5c53123af65808e1c4749cf262bec17e26468c1624c0023d2b9d
-  data.tar.gz: cb4403b960c7f2e017143738edcbbfbe356e7e8c8e5b761d1f98482296541dcc2255b480d1285ce233d5add5c7e7e78fda29ab8f5fafd561f106a64e9e144460
+  metadata.gz: 44796213c268dfb63e59472c9b59470e3b01dd7a26b0acc63aa48e0f7ff537c25906957d3700b24639eb41d9526708898dc8ff82a4eeea193fc7ec1a3a5cfe43
+  data.tar.gz: d656f40756c62507113ac660429e9dc10751f40158c8768d47ccdb238ac2d392ccdfc055744ef68837608e7ed33f5673527178a9d0ef77a928d4cabd49da055f

data/lib/redcord.rb

@@ -1,9 +1,36 @@
+# frozen_string_literal: true
+
 # typed: strict
-module Redcord
-end
 
 require 'sorbet-runtime'
 
+module Redcord
+  extend T::Sig
+
+  @@configuration_blks = T.let(
+    [],
+    T::Array[T.proc.params(arg0: T.untyped).void],
+  )
+
+  sig {
+    params(
+      blk: T.proc.params(arg0: T.untyped).void,
+    ).void
+  }
+  def self.configure(&blk)
+    @@configuration_blks << blk
+  end
+
+  sig { void }
+  def self._after_initialize!
+    @@configuration_blks.each do |blk|
+      blk.call(Redcord::Base)
+    end
+
+    @@configuration_blks.clear
+  end
+end
+
 require 'redcord/base'
 require 'redcord/migration'
 require 'redcord/migration/migrator'

data/lib/redcord.rbi

@@ -45,22 +45,6 @@ module Redcord::TTL::ClassMethods
   include Redcord::Serializer::ClassMethods
 end
 
-module Redcord::ServerScripts
-  include Kernel
-
-  sig do
-    params(
-      sha: String,
-      keys: T::Array[T.untyped],
-      argv: T::Array[T.untyped],
-    ).returns(T.untyped)
-  end
-  def evalsha(sha, keys: [], argv:[]); end
-
-  sig { returns(T::Hash[Symbol, String]) }
-  def redcord_server_script_shas; end
-end
-
 module Redcord::Actions::ClassMethods
   include Kernel
   include Redcord::RedisConnection::ClassMethods

data/lib/redcord/actions.rb

@@ -26,27 +26,42 @@ module Redcord::Actions
 
     sig { params(args: T::Hash[Symbol, T.untyped]).returns(T.untyped) }
     def create!(args)
-      args[:created_at] = args[:updated_at] = Time.zone.now
-      instance = TypeCoerce[self].new.from(args)
-      id = redis.create_hash_returning_id(model_key, to_redis_hash(args))
-      instance.send(:id=, id)
-      instance
+      Redcord::Base.trace(
+       'redcord_actions_class_methods_create!',
+        model_name: name,
+      ) do
+        args[:created_at] = args[:updated_at] = Time.zone.now
+        instance = TypeCoerce[self].new.from(args)
+        id = redis.create_hash_returning_id(model_key, to_redis_hash(args))
+        instance.send(:id=, id)
+        instance
+      end
     end
 
     sig { params(id: T.untyped).returns(T.untyped) }
     def find(id)
-      instance_key = "#{model_key}:id:#{id}"
-      args = redis.hgetall(instance_key)
-      if args.empty?
-        raise Redcord::RecordNotFound, "Couldn't find #{name} with 'id'=#{id}"
+      Redcord::Base.trace(
+       'redcord_actions_class_methods_find',
+        model_name: name,
+      ) do
+        instance_key = "#{model_key}:id:#{id}"
+        args = redis.hgetall(instance_key)
+        if args.empty?
+          raise Redcord::RecordNotFound, "Couldn't find #{name} with 'id'=#{id}"
+        end
+
+        coerce_and_set_id(args, id)
       end
-
-      coerce_and_set_id(args, id)
     end
 
     sig { params(args: T::Hash[Symbol, T.untyped]).returns(T.untyped) }
     def find_by(args)
-      where(args).to_a.first
+      Redcord::Base.trace(
+       'redcord_actions_class_methods_find_by_args',
+        model_name: name,
+      ) do
+        where(args).to_a.first
+      end
     end
 
     sig { params(args: T::Hash[Symbol, T.untyped]).returns(Redcord::Relation) }
@@ -56,7 +71,12 @@ module Redcord::Actions
 
     sig { params(id: T.untyped).returns(T::Boolean) }
     def destroy(id)
-      redis.delete_hash(model_key, id) == 1
+      Redcord::Base.trace(
+       'redcord_actions_class_methods_destroy',
+        model_name: name,
+      ) do
+        redis.delete_hash(model_key, id) == 1
+      end
     end
   end
 
@@ -88,46 +108,61 @@ module Redcord::Actions
 
     sig { void }
     def save!
-      self.updated_at = Time.zone.now
-      _id = id
-      if _id.nil?
-        self.created_at = T.must(self.updated_at)
-        _id = redis.create_hash_returning_id(
-          self.class.model_key,
-          self.class.to_redis_hash(serialize),
-        )
-        send(:id=, _id)
-      else
-        redis.update_hash(
-          self.class.model_key,
-          _id,
-          self.class.to_redis_hash(serialize),
-        )
+      Redcord::Base.trace(
+       'redcord_actions_instance_methods_save!',
+        model_name: self.class.name,
+      ) do
+        self.updated_at = Time.zone.now
+        _id = id
+        if _id.nil?
+          self.created_at = T.must(self.updated_at)
+          _id = redis.create_hash_returning_id(
+            self.class.model_key,
+            self.class.to_redis_hash(serialize),
+          )
+          send(:id=, _id)
+        else
+          redis.update_hash(
+            self.class.model_key,
+            _id,
+            self.class.to_redis_hash(serialize),
+          )
+        end
       end
     end
 
     sig { params(args: T::Hash[Symbol, T.untyped]).void }
     def update!(args = {})
-      _id = id
-      if _id.nil?
-        _set_args!(args)
-        save!
-      else
-        args[:updated_at] = Time.zone.now
-        _set_args!(args)
-        redis.update_hash(
-          self.class.model_key,
-          _id,
-          self.class.to_redis_hash(args),
-        )
+      Redcord::Base.trace(
+       'redcord_actions_instance_methods_update!',
+        model_name: self.class.name,
+      ) do
+        _id = id
+        if _id.nil?
+          _set_args!(args)
+          save!
+        else
+          args[:updated_at] = Time.zone.now
+          _set_args!(args)
+          redis.update_hash(
+            self.class.model_key,
+            _id,
+            self.class.to_redis_hash(args),
+          )
+        end
       end
     end
 
     sig { returns(T::Boolean) }
     def destroy
-      return false if id.nil?
+      Redcord::Base.trace(
+       'redcord_actions_instance_methods_destroy',
+        model_name: self.class.name,
+      ) do
+        return false if id.nil?
 
-      self.class.destroy(T.must(id))
+        self.class.destroy(T.must(id))
+      end
     end
 
     sig { returns(String) }

data/lib/redcord/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+#
 # typed: strict
 #
 # A Redis ORM API inspired by ActiveRecord:
@@ -11,6 +13,7 @@ require 'redcord/configurations'
 require 'redcord/logger'
 require 'redcord/redis_connection'
 require 'redcord/serializer'
+require 'redcord/tracer'
 
 module Redcord::Base
   extend T::Sig
@@ -23,6 +26,7 @@ module Redcord::Base
   include Redcord::Configurations
   include Redcord::Logger
   include Redcord::RedisConnection
+  include Redcord::Tracer
 
   abstract!
 

data/lib/redcord/configurations.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+#
 # typed: strict
 #
 #  This allows us to configure Redis connections for Redcord. Redis
@@ -40,6 +42,8 @@
 #  ```
 #
 require 'redcord/redis_connection'
+require 'redcord/tracer'
+
 module Redcord::Configurations
   extend T::Sig
   extend T::Helpers

data/lib/redcord/logger.rb

@@ -12,7 +12,7 @@ module Redcord::Logger
   module ClassMethods
     extend T::Sig
 
-    @@logger = T.let(Rails.logger, T.untyped)
+    @@logger = T.let(nil, T.untyped)
 
     sig { returns(T.untyped) }
     def logger

data/lib/redcord/prepared_redis.rb

@@ -1,18 +1,147 @@
 # typed: strict
 require 'redis'
-require 'redcord/server_scripts'
 
+# TODO: Rename Redcord::PreparedRedis -> Redcord::Redis
 class Redcord::PreparedRedis < Redis
   extend T::Sig
-  include Redcord::ServerScripts
+
+  sig do
+    params(
+      key: T.any(String, Symbol),
+      args: T::Hash[T.untyped, T.untyped],
+    ).returns(Integer)
+  end
+  def create_hash_returning_id(key, args)
+    Redcord::Base.trace(
+      'redcord_redis_create_hash_returning_id',
+      model_name: key,
+    ) do
+      evalsha(
+        self.class.server_script_shas[:create_hash_returning_id],
+        keys: [key],
+        argv: args.to_a.flatten,
+      ).to_i
+    end
+  end
+
+  sig do
+    params(
+      model: String,
+      id: Integer,
+      args: T::Hash[T.untyped, T.untyped],
+    ).void
+  end
+  def update_hash(model, id, args)
+    Redcord::Base.trace(
+      'redcord_redis_update_hash',
+      model_name: model,
+    ) do
+      evalsha(
+        self.class.server_script_shas[:update_hash],
+        keys: [model, id],
+        argv: args.to_a.flatten,
+      )
+    end
+  end
+
+  sig do
+    params(
+      model: String,
+      id: Integer
+    ).returns(Integer)
+  end
+  def delete_hash(model, id)
+    Redcord::Base.trace(
+      'redcord_redis_delete_hash',
+      model_name: model,
+    ) do
+      evalsha(
+        self.class.server_script_shas[:delete_hash],
+        keys: [model, id]
+      )
+    end
+  end
+
+  sig do
+    params(
+      model: String,
+      query_conditions: T::Hash[T.untyped, T.untyped],
+      select_attrs: T::Set[Symbol]
+    ).returns(T::Hash[Integer, T::Hash[T.untyped, T.untyped]])
+  end
+  def find_by_attr(model, query_conditions, select_attrs=Set.new)
+    Redcord::Base.trace(
+      'redcord_redis_find_by_attr',
+      model_name: model,
+    ) do
+      res = evalsha(
+        self.class.server_script_shas[:find_by_attr],
+        keys: [model] + query_conditions.to_a.flatten,
+        argv: select_attrs.to_a.flatten
+      )
+      # The Lua script will return this as a flattened array.
+      # Convert the result into a hash of {id -> model hash}
+      res_hash = res.each_slice(2)
+      res_hash.map { |key, val| [key.to_i, val.each_slice(2).to_h] }.to_h
+    end
+  end
+
+  sig do
+    params(
+      model: String,
+      query_conditions: T::Hash[T.untyped, T.untyped]
+    ).returns(Integer)
+  end
+  def find_by_attr_count(model, query_conditions)
+    Redcord::Base.trace(
+      'redcord_redis_find_by_attr_count',
+      model_name: model,
+    ) do
+      evalsha(
+        self.class.server_script_shas[:find_by_attr_count],
+        keys: [model] + query_conditions.to_a.flatten,
+      )
+    end
+  end
+
+  sig { void }
+  def load_server_scripts!
+    script_names = Dir[File.join(
+      __dir__,
+      'server_scripts/*.lua',
+    )].map do |filename|
+      # lib/redcord/server_scripts/find_by_attr.erb.lua -> find_by_attr
+      T.must(filename.split('/').last).split('.').first&.to_sym
+    end
+
+    res = pipelined do
+      script_names.each do |script_name|
+        script(
+          :load,
+          Redcord::LuaScriptReader.read_lua_script(script_name.to_s),
+        )
+      end
+    end
+
+    if self.class.class_variable_get(:@@server_script_shas).nil?
+      self.class.class_variable_set(
+        :@@server_script_shas,
+        script_names.zip(res).to_h
+      )
+    end
+  end
+
+  @@server_script_shas = T.let(nil, T.nilable(T::Hash[Symbol, String]))
 
   sig { returns(T::Hash[Symbol, String]) }
-  def redcord_server_script_shas
-    instance_variable_get(:@_redcord_server_script_shas)
+  def self.server_script_shas
+    T.must(@@server_script_shas)
   end
 
-  sig { params(shas: T::Hash[Symbol, String]).void }
-  def redcord_server_script_shas=(shas)
-    instance_variable_set(:@_redcord_server_script_shas, shas)
+  sig { void }
+  def self.load_server_scripts!
+    Redcord::Base.configurations[Rails.env].each do |_, config|
+      new(**(config.symbolize_keys)).load_server_scripts!
+    end
   end
 end

data/lib/redcord/railtie.rb

@@ -1,5 +1,9 @@
+# frozen_string_literal: true
+
 # typed: strict
+
 require 'rails'
+require 'yaml'
 
 class Redcord::Railtie < Rails::Railtie
   railtie_name 'redcord'
@@ -13,4 +17,19 @@ class Redcord::Railtie < Rails::Railtie
   config.before_configuration do
     require 'redcord/base'
   end
+
+  config.after_initialize do
+    Redcord::Base.logger = Rails.logger
+
+    config_file = 'config/redcord.yml'
+
+    if File.file?(config_file)
+      Redcord::Base.configurations = YAML.load(
+        ERB.new(File.read(config_file)).result
+      )
+    end
+
+    Redcord::PreparedRedis.load_server_scripts!
+    Redcord._after_initialize!
+  end
 end

data/lib/redcord/redis_connection.rb

@@ -71,17 +71,6 @@ module Redcord::RedisConnection
         end
       end
 
-      script_names = Redcord::ServerScripts.instance_methods
-      res = client.pipelined do
-        script_names.each do |script_name|
-          client.script(
-            :load,
-            Redcord::LuaScriptReader.read_lua_script(script_name.to_s),
-          )
-        end
-      end
-
-      client.redcord_server_script_shas = script_names.zip(res).to_h
       client
     end
   end

data/lib/redcord/relation.rb

@@ -51,14 +51,19 @@ class Redcord::Relation
   ).returns(T.any(Redcord::Relation, T::Array[T.untyped]))
   end
   def select(*args, &blk)
-    if block_given?
-      return execute_query.select do |*item|
-        blk.call(*item)
+    Redcord::Base.trace(
+     'redcord_relation_select',
+     model_name: model.name,
+    ) do
+      if block_given?
+        return execute_query.select do |*item|
+          blk.call(*item)
+        end
       end
-    end
 
-    select_attrs.merge(args)
-    self
+      select_attrs.merge(args)
+      self
+    end
   end
 
   sig { returns(Integer) }
@@ -134,25 +139,30 @@ class Redcord::Relation
 
   sig { returns(T::Array[T.untyped]) }
   def execute_query
-    if !select_attrs.empty?
-      res_hash = redis.find_by_attr(
-        model.model_key,
-        query_conditions,
-        select_attrs,
-      )
-
-      res_hash.map do |id, args|
-        model.from_redis_hash(args).map do |k, v|
-          [k.to_sym, TypeCoerce[model.get_attr_type(k.to_sym)].new.from(v)]
-        end.to_h.merge(id: id)
+    Redcord::Base.trace(
+     'redcord_relation_execute_query',
+     model_name: model.name,
+    ) do
+      if !select_attrs.empty?
+        res_hash = redis.find_by_attr(
+          model.model_key,
+          query_conditions,
+          select_attrs,
+        )
+
+        res_hash.map do |id, args|
+          model.from_redis_hash(args).map do |k, v|
+            [k.to_sym, TypeCoerce[model.get_attr_type(k.to_sym)].new.from(v)]
+          end.to_h.merge(id: id)
+        end
+      else
+        res_hash = redis.find_by_attr(
+          model.model_key,
+          query_conditions,
+        )
+
+        res_hash.map { |id, args| model.coerce_and_set_id(args, id) }
       end
-    else
-      res_hash = redis.find_by_attr(
-        model.model_key,
-        query_conditions,
-      )
-
-      res_hash.map { |id, args| model.coerce_and_set_id(args, id) }
     end
   end
 

data/lib/redcord/tracer.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# typed: strict
+
+module Redcord::Tracer
+  extend T::Sig
+  extend T::Helpers
+
+  sig { params(klass: Module).void }
+  def self.included(klass)
+    klass.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    include Kernel
+
+    extend T::Sig
+
+    @@tracer = T.let(nil, T.untyped)
+
+    sig {
+      params(
+        span_name: String,
+        model_name: String,
+        tags: T::Array[String],
+        blk: T.proc.returns(T.untyped),
+      ).returns(T.untyped)
+    }
+    def trace(span_name, model_name:, tags: [], &blk)
+      return blk.call if @@tracer.nil?
+
+      @@tracer.call.trace(
+        span_name,
+        resource: model_name,
+        service: 'redcord',
+        tags: tags,
+        &blk
+      )
+    end
+
+    sig { params(blk: T.proc.returns(T.untyped)).void }
+    def tracer(&blk)
+      @@tracer = blk
+    end
+  end
+
+  mixes_in_class_methods(ClassMethods)
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redcord
 version: !ruby/object:Gem::Version
-  version: 0.0.2.alpha
+  version: 0.0.3
 platform: ruby
 authors:
 - Chan Zuckerberg Initiative
@@ -174,7 +174,6 @@ files:
 - lib/redcord/redis_connection.rb
 - lib/redcord/relation.rb
 - lib/redcord/serializer.rb
-- lib/redcord/server_scripts.rb
 - lib/redcord/server_scripts/create_hash_returning_id.erb.lua
 - lib/redcord/server_scripts/delete_hash.erb.lua
 - lib/redcord/server_scripts/find_by_attr.erb.lua
@@ -184,6 +183,7 @@ files:
 - lib/redcord/server_scripts/shared/query_helper_methods.erb.lua
 - lib/redcord/server_scripts/update_hash.erb.lua
 - lib/redcord/tasks/redis.rake
+- lib/redcord/tracer.rb
 homepage: https://github.com/chanzuckerberg/redis-record
 licenses:
 - MIT
@@ -199,9 +199,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.6.2

data/lib/redcord/server_scripts.rb

@@ -1,78 +0,0 @@
-# typed: strict
-module Redcord::ServerScripts
-  extend T::Sig
-
-  sig do
-    params(
-      key: T.any(String, Symbol),
-      args: T::Hash[T.untyped, T.untyped],
-    ).returns(Integer)
-  end
-  def create_hash_returning_id(key, args)
-    evalsha(
-      T.must(redcord_server_script_shas[:create_hash_returning_id]),
-      keys: [key],
-      argv: args.to_a.flatten,
-    ).to_i
-  end
-
-  sig do
-    params(
-      model: String,
-      id: Integer,
-      args: T::Hash[T.untyped, T.untyped],
-    ).void
-  end
-  def update_hash(model, id, args)
-    evalsha(
-      T.must(redcord_server_script_shas[:update_hash]),
-      keys: [model, id],
-      argv: args.to_a.flatten,
-    )
-  end
-
-  sig do
-    params(
-      model: String,
-      id: Integer
-    ).returns(Integer)
-  end
-  def delete_hash(model, id)
-    evalsha(
-      T.must(redcord_server_script_shas[:delete_hash]),
-      keys: [model, id]
-    )
-  end
-
-  sig do
-    params(
-      model: String,
-      query_conditions: T::Hash[T.untyped, T.untyped],
-      select_attrs: T::Set[Symbol]
-    ).returns(T::Hash[Integer, T::Hash[T.untyped, T.untyped]])
-  end
-  def find_by_attr(model, query_conditions, select_attrs=Set.new)
-    res = evalsha(
-      T.must(redcord_server_script_shas[:find_by_attr]),
-      keys: [model] + query_conditions.to_a.flatten,
-      argv: select_attrs.to_a.flatten
-    )
-    # The Lua script will return this as a flattened array.
-    # Convert the result into a hash of {id -> model hash}
-    res_hash = res.each_slice(2)
-    res_hash.map { |key, val| [key.to_i, val.each_slice(2).to_h] }.to_h
-  end
-
-  sig do
-    params(
-      model: String,
-      query_conditions: T::Hash[T.untyped, T.untyped]
-    ).returns(Integer)
-  end
-  def find_by_attr_count(model, query_conditions)
-    evalsha(
-      T.must(redcord_server_script_shas[:find_by_attr_count]),
-      keys: [model] + query_conditions.to_a.flatten,
-    )
-  end
-end