ru.Bee 1.8.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a7e2d8462e9cf796796f117503bbc4d51dfebaa8d9923d5e1e6905d522a5af7
-  data.tar.gz: d8eb71da20db0400dc96900f73f53481c835449d4b3f1ee20979dc95e7c083f4
+  metadata.gz: 95729d36d2f3e6f133212e3d2e4e94bbb741a60f1c68a85a2caf97d060dcf782
+  data.tar.gz: 261f8261a80d2b62a79fa92b87c86677f6d1e7dd9ab2689d3e325bb1160914e2
 SHA512:
-  metadata.gz: 041f294e20e60f29ab5c03833613815fe7c462b7cc248a79aad228fbfe680e5474f6c38695c884d060a9cebfa0c0f2e918a915c102e2476e98d45df39b7a77ab
-  data.tar.gz: b0f0acda20a4de0d3c8bfebc32b9229c9be04f1311d7f2bab5e3d6a5fa7819a7414f05d0902988801a7ed624b681dfbd14ca3e7682a85a5daf094014ee907a0c
+  metadata.gz: 95f59f4ee8cbce2e45ff8fa6563ed3c565a8a3fe5fe7954fae249aa75af3db98fb65ee0a801f55189ad80650b2dbabb86746c3100a9a53b05eae37c3d33a18b5
+  data.tar.gz: 27b6af04508c9438fb838946024ffef66f8b41808de3f503c7dc6e872a7642e3e749028b71eeb77cb97657e6988d0067a1622f1654a775c3007eb4c335aee7d4

data/lib/config/base_configuration.rb

@@ -10,6 +10,11 @@ Rubee::Configuration.setup(env = :development) do |config|
 
   ## configure logger
   # config.logger = { logger: MyLogger, env: }
+
+  ## configure db write retries
+  # config.db_max_retries = { env:, value: 3 }
+  # config.db_retry_delay = { env:, value: 0.1 }
+  # config.db_busy_timeout = { env:, value: 2000 }
 end
 
 Rubee::Configuration.setup(env = :test) do |config|
@@ -24,6 +29,11 @@ Rubee::Configuration.setup(env = :test) do |config|
 
   ## configure logger
   # config.logger = { logger: MyLogger, env: }
+
+  ## configure db write retries
+  # config.db_max_retries = { env:, value: 3 }
+  # config.db_retry_delay = { env:, value: 0.1 }
+  # config.db_busy_timeout = { env:, value: 2000 }
 end
 
 Rubee::Configuration.setup(env = :production) do |config|
@@ -38,4 +48,9 @@ Rubee::Configuration.setup(env = :production) do |config|
 
   ## configure logger
   # config.logger = { logger: MyLogger, env: }
+
+  ## configure db write retries
+  # config.db_max_retries = { env:, value: 3 }
+  # config.db_retry_delay = { env:, value: 0.1 }
+  # config.db_busy_timeout = { env:, value: 2000 }
 end

data/lib/rubee/autoload.rb

@@ -76,6 +76,10 @@ module Rubee
 
         require_relative File.join(root_directory,
                                    'rubee/models/sequel_object')
+        return if black_list.include?('db_tools.rb')
+
+        require_relative File.join(root_directory,
+                                   'rubee/models/db_tools')
 
         Dir[File.join(root_directory, 'rubee/cli/**', '*.rb')].each do |file|
           require_relative file

data/lib/rubee/configuration.rb

@@ -51,6 +51,21 @@ module Rubee
         @configuraiton[args[:app].to_sym][args[:env].to_sym][:fiber_pool_limit] = args[:value]
       end
 
+      def db_max_retries=(args)
+        args[:app] ||= :app
+        @configuraiton[args[:app].to_sym][args[:env].to_sym][:db_max_retries] = args[:value]
+      end
+
+      def db_retry_delay=(args)
+        args[:app] ||= :app
+        @configuraiton[args[:app].to_sym][args[:env].to_sym][:db_retry_delay] = args[:value]
+      end
+
+      def db_busy_timeout=(args)
+        args[:app] ||= :app
+        @configuraiton[args[:app].to_sym][args[:env].to_sym][:db_busy_timeout] = args[:value]
+      end
+
       def logger=(args)
         args[:app] ||= :app
         @configuraiton[args[:app].to_sym][args[:env].to_sym][:logger] = args[:logger]

data/lib/rubee/models/db_tools.rb

@@ -0,0 +1,36 @@
+module Rubee
+  module DBTools
+    MAX_RETRIES = Rubee::Configuration.get_db_max_retries || 3
+    DELAY = Rubee::Configuration.get_db_retry_delay || 0.1
+    BUSY_TIMEOUT = Rubee::Configuration.get_db_busy_timeout || 2000
+
+    class << self
+      def with_retry
+        retries = 0
+        begin
+          yield
+        rescue Sequel::DatabaseError => e
+          # Applicable for msqlite only, however it can be extended in the future
+          if Rubee::SequelObject::DB.adapter_scheme == :sqlite &&
+              e.cause.is_a?(SQLite3::BusyException) && retries < MAX_RETRIES
+            retries += 1
+            sleep(DELAY)
+            retry
+          else
+            raise e
+          end
+        end
+      end
+
+      def set_prerequisites!
+        # Necessary changes to make sqlite be none blocking
+        if Rubee::SequelObject::DB.adapter_scheme == :sqlite
+          # WAL mode allows concurrent reads and non-blocking writes.
+          Rubee::SequelObject::DB.execute("PRAGMA journal_mode = WAL")
+          # Wait 2000ms for a write lock.
+          Rubee::SequelObject::DB.execute("PRAGMA busy_timeout = #{BUSY_TIMEOUT}")
+        end
+      end
+    end
+  end
+end

data/lib/rubee/models/sequel_object.rb

@@ -50,7 +50,7 @@ module Rubee
     def update(args = {})
       assign_attributes(args)
       found_hash = self.class.dataset.where(id:)
-      return self.class.find(id) if found_hash&.update(**args)
+      return self.class.find(id) if Rubee::DBTools.with_retry { found_hash&.update(**args) }
 
       false
     end
@@ -130,6 +130,10 @@ module Rubee
         return if defined?(DB) && !DB.nil?
 
         const_set(:DB, Sequel.connect(Rubee::Configuration.get_database_url))
+
+        Rubee::DBTools.set_prerequisites!
+
+        true
       end
 
       def dataset
@@ -169,7 +173,7 @@ module Rubee
       end
 
       def create(attrs)
-        out_id = dataset.insert(**attrs)
+        out_id = Rubee::DBTools.with_retry { dataset.insert(**attrs) }
         new(**attrs.merge(id: out_id))
       end
 

data/lib/rubee.rb

@@ -16,7 +16,7 @@ module Rubee
   JS_DIR = File.join(APP_ROOT, LIB, 'js') unless defined?(JS_DIR)
   CSS_DIR = File.join(APP_ROOT, LIB, 'css') unless defined?(CSS_DIR)
   ROOT_PATH = File.expand_path(File.join(__dir__, '..')) unless defined?(ROOT_PATH)
-  VERSION = '1.8.0'
+  VERSION = '1.9.0'
 
   require_relative 'rubee/router'
   require_relative 'rubee/logger'

data/lib/tests/models/user_model_test.rb

@@ -1,5 +1,4 @@
 require_relative '../test_helper'
-
 describe 'User model' do
   describe '.create' do
     after do
@@ -68,6 +67,32 @@ describe 'User model' do
         _(User.all.count).must_equal(initial_count)
       end
     end
+
+    describe 'locking model' do
+      before do
+        User.destroy_all(cascade: true)
+      end
+
+      it 'triggers save two times' do
+        t1 = Thread.new do
+          User::DB.transaction do
+            user2 = User.new(email: 'holding-lock2@example.com', password: '125')
+            sleep(0.5)
+            user2.save
+          end
+        end
+        sleep(0.1)
+        t2 = Thread.new do
+          user1 = User.new(email: 'holding-lock@example.com', password: '123')
+          user1.save
+        end
+
+        t1.join
+        t2.join
+
+        _(User.all.count).must_equal(2)
+      end
+    end
   end
 
   describe '.update' do

data/readme.md

@@ -100,6 +100,11 @@ bundle install
 4. Run ruBee server. Default port is 7000
 ```bash
 rubee start # or rubee start_dev for development
+
+# Sarting from veriosn 1.8.0, you can also start you rubee server with yjit compiler and enjoy speed boost.
+rubee start --yjit
+# Option is available for dev environment too
+rubee start_dev --yjit
 ```
 
 5. Open your browser and go to http://localhost:7000
@@ -334,6 +339,25 @@ So it may safe some resources.
 
 [Back to content](#content)
 
+## Mysqlite production ready
+Starting from verison 1.9.0 main issue for using sqlite - write db lock is resolved!
+If you feel comfortable you can play with retry configuration parameters:
+
+```ruby
+  ## configure db write retries
+  config.db_max_retries = { env:, value: 3 } # set it to 0 to disable or increase if needed
+  config.db_retry_delay = { env:, value: 0.1 }
+  config.db_busy_timeout = { env:, value: 1000 } # this is busy timeout in ms, before raising bussy error
+```
+
+For Rubee model class persist methods create and update retry will be added automatically. However, \
+if you want to do it with Sequel dataset you need to do it yourself:
+
+```ruby
+  Rubee::DBTools.with_retry { User.dataset.insert(email: "test@ok.com", password: "123") }
+```
+[Back to content](#content)
+
 ## Routing
 Rubee uses explicit routes. In the routes.rb yout can define routes for any of the main HTTP methods. \
 You can also add any matched parameter denoted by a pair of `{ }` in the path of the route. \
@@ -971,4 +995,4 @@ Have an idea or you wnat to discuss something?
 Please open a [discussion](https://github.com/nucleom42/rubee/discussions)
 
 ## License
-This project is released under the MIT License.
+This project is released under the [MIT License](https://github.com/nucleom42/rubee/blob/main/LICENSE).

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ru.Bee
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Oleg Saltykov
@@ -255,6 +255,7 @@ files:
 - lib/rubee/generator.rb
 - lib/rubee/logger.rb
 - lib/rubee/models/database_objectable.rb
+- lib/rubee/models/db_tools.rb
 - lib/rubee/models/sequel_object.rb
 - lib/rubee/router.rb
 - lib/tests/async/thread_async_test.rb