tenant_realm 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec5080c5a6b4e997fd094811df564e8cb6c7520030a1fb0617917a155dd05223
-  data.tar.gz: 159100e048f540997d9e9ffa33ba215c035357573bb297a65afa52bd6547d593
+  metadata.gz: cb38988c0c6f15c4ab3ad38292bf08b4f1f3f30579d4c50b6fe992748f9c4c53
+  data.tar.gz: '0740480bc624fbd480c00dee419d442b3358093b12b5a080787cba77898708b7'
 SHA512:
-  metadata.gz: 789611a5e9bc41b794a65e39d4d4cb48a69ad6d37a6d1bde72cb10e6f2bf499278f6715c5f50a7ba26023360408919bf921e33e72b9b994263747582eb0e8dc8
-  data.tar.gz: a7dc2cddb27f123a9772bd53d4e4b1f3d39f9f5cad245f83de9329aa9c3bd6acebde917cb42ce84927b12b896396f8837fe715f5f22ede2cbcec365cb2d72bfc
+  metadata.gz: 2babc4881ad94fbd81ae8356de99ea1ba9b3cd970ac78ef5a3ccbde642c5cedffa5560b36a0e27cb88eed3d3b30f4300d21811edce64cb4149abf7070cbf64ac
+  data.tar.gz: a0fd3f716507576ba08520997faeb93f6748c383c523e96266ec5fd7c9969e36e66e948cf39630d8caa09642ac36ccaf6e8fbab52b4bb5c474f012885925e75c

data/lib/tasks/migrate.rake

@@ -5,6 +5,16 @@ namespace :tenant_realm do
   task migrate: :environment do
     tenants = TenantRealm::Tenant.tenants
 
+    puts 'Migrating primary'
+    root_db_config = TenantRealm::DbContext.root_db_config
+    ActiveRecord::Tasks::DatabaseTasks.with_temporary_connection(root_db_config) do
+      ActiveRecord::Tasks::DatabaseTasks.migrate
+      TenantRealm::DbContext.dump_schema(
+        shard: :primary,
+        db_config: root_db_config
+      )
+    end
+
     tenants.each do |tenant|
       shard = TenantRealm::Utils.shard_name_from_tenant(tenant:)
 

data/lib/tasks/rollback.rake

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+namespace :tenant_realm do
+  desc 'Rollback db for all tenants'
+  task rollback: :environment do
+    tenants = TenantRealm::Tenant.tenants
+
+    puts 'Rollback primary'
+    Rake::Task['db:rollback:primary'].invoke
+    Rake::Task['db:rollback:primary'].reenable
+
+    tenants.each do |tenant|
+      shard = TenantRealm::Utils.shard_name_from_tenant(tenant:)
+
+      puts "Rollback #{shard}"
+
+      db_config = TenantRealm::Utils.dig_db_config(tenant:)
+
+      if db_config.blank?
+        puts "Skip Rollback #{shard}"
+
+        next
+      end
+
+      Rake::Task["db:rollback:#{shard}"].invoke
+      Rake::Task["db:rollback:#{shard}"].reenable
+    end
+  end
+end

data/lib/tenant_realm/cache/base_cache.rb

@@ -4,7 +4,7 @@ module TenantRealm
   module Cache
     class BaseCache
       class << self
-        def cache_tenants(_tenants)
+        def cache_tenants(tenants:)
           raise NotImplementedError
         end
 
@@ -12,11 +12,11 @@ module TenantRealm
           raise NotImplementedError
         end
 
-        def cache_tenant(_tenant)
+        def cache_tenant(tenant:)
           raise NotImplementedError
         end
 
-        def tenant(_identifier)
+        def tenant(identifier:)
           raise NotImplementedError
         end
 

data/lib/tenant_realm/cache/kredis_cache.rb

@@ -9,7 +9,7 @@ module TenantRealm
   module Cache
     class KredisCache < BaseCache
       class << self
-        def cache_tenants(tenants)
+        def cache_tenants(tenants:)
           return if tenants.blank?
 
           cached_tenants = tenants_kredis
@@ -22,7 +22,9 @@ module TenantRealm
           cached_tenants.value&.map(&:deep_symbolize_keys) || []
         end
 
-        def cache_tenant(tenant)
+        def cache_tenant(tenant:)
+          return tenant if tenant.blank?
+
           tenant_unique_keys(tenant).each do |key|
             cached_tenant = tenant_kredis(key)
             cached_tenant.value = tenant
@@ -31,7 +33,7 @@ module TenantRealm
           tenant
         end
 
-        def tenant(identifier)
+        def tenant(identifier:)
           cached_tenant = tenant_kredis(identifier)
           cached_tenant.value&.deep_symbolize_keys
         end

data/lib/tenant_realm/db_context.rb

@@ -55,10 +55,10 @@ module TenantRealm
           YAML.dump(config, f)
         end
 
-        ActiveRecord::Base.configurations.configurations << ActiveRecord::DatabaseConfigurations::HashConfig.new(
-          Rails.env,
+        ActiveRecord::Base.configurations.configurations << build_db_hash_config(
           shard_name,
-          tenant_shard_config
+          tenant_shard_config,
+          Rails.env
         )
 
         sym_shard = shard_name.to_sym
@@ -110,8 +110,30 @@ module TenantRealm
         db_config
       end
 
+      def dump_schema(db_config:, shard:)
+        return unless ActiveRecord.dump_schema_after_migration
+
+        schema_format = ENV.fetch('SCHEMA_FORMAT', ActiveRecord.schema_format).to_sym
+        ActiveRecord::Tasks::DatabaseTasks.dump_schema(
+          build_db_hash_config(
+            shard.to_s,
+            db_config,
+            Rails.env
+          ),
+          schema_format
+        )
+      end
+
       private
 
+      def build_db_hash_config(shard, db_config, env_name = Rails.env)
+        ActiveRecord::DatabaseConfigurations::HashConfig.new(
+          env_name,
+          shard,
+          db_config
+        )
+      end
+
       def build_connected_shards
         @@shards.keys.each_with_object({}) do |shard, shards|
           sym_shard = shard.to_sym

data/lib/tenant_realm/helpers.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# internal usage
+# no need hash parameters
 module TenantRealm
   class Helpers
     class << self

data/lib/tenant_realm/tenant.rb

@@ -10,42 +10,46 @@ module TenantRealm
     }
 
     class << self
-      def tenants
+      def tenants(force_load: false)
         if cache.present?
-          tenants = cache.tenants
-          return tenants if tenants.present?
+          unless force_load
+            tenants = cache.tenants
+            return tenants if tenants.present?
+          end
 
           tenants = Utils.fetch_tenants
-          cache.cache_tenants(tenants)
+          cache.cache_tenants(tenants:)
           tenants
         else
           Utils.fetch_tenants
         end
       end
 
-      def tenant(identifier)
+      def tenant(identifier:, force_load: false)
         if cache.present?
-          tenant = cache.tenant(identifier)
-          return tenant if tenant.present?
+          unless force_load
+            tenant = cache.tenant(identifier:)
+            return tenant if tenant.present?
+          end
 
-          tenant = Utils.fetch_tenant(identifier)
-          cache.cache_tenant(tenant)
+          tenant = Utils.fetch_tenant(identifier:)
+          cache.cache_tenant(tenant:)
           tenant
         else
           Utils.fetch_tenant
         end
       end
 
-      def cache_tenants(tenants)
+      def cache_tenants(tenants:)
         return Helpers.dev_log('Tenant Realm: Skip cache tenants because cache not configured') if cache.blank?
 
-        cache.cache_tenants(tenants)
+        cache.cache_tenants(tenants:)
       end
 
-      def cache_tenant(tenant)
+      def cache_tenant(tenant:)
         return Helpers.dev_log('Tenant Realm: Skip cache tenant because cache not configured') if cache.blank?
 
-        cache.cache_tenant(tenant)
+        cache.cache_tenant(tenant:)
       end
 
       private

data/lib/tenant_realm/utils.rb

@@ -13,7 +13,7 @@ module TenantRealm
         (Config.fetch_tenants.call.presence || []).map(&:deep_symbolize_keys)
       end
 
-      def fetch_tenant(identifier)
+      def fetch_tenant(identifier:)
         Helpers.raise_if_not_proc(Config.fetch_tenant, 'config.fetch_tenant')
 
         Config.fetch_tenant.call(identifier)&.deep_symbolize_keys
@@ -41,7 +41,7 @@ module TenantRealm
         shard.underscore
       end
 
-      def identifier_resolver(request)
+      def identifier_resolver(request:)
         raise Error, 'config.identifier_resolver must be provided' if Config.identifier_resolver.blank?
 
         Helpers.raise_if_not_proc(Config.identifier_resolver, 'config.identifier_resolver')

data/lib/tenant_realm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TenantRealm
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/lib/tenant_realm.rb

@@ -30,13 +30,13 @@ module TenantRealm
 
         return :primary if skip_switch_db
 
-        identifier = Utils.identifier_resolver(request)
-        tenant = Tenant.tenant(identifier)
+        identifier = Utils.identifier_resolver(request:)
+        tenant = Tenant.tenant(identifier:)
         db_config = Utils.dig_db_config(tenant:)
-        shard = Utils.shard_name_from_tenant(tenant:)
 
         return :primary if db_config.blank?
 
+        shard = Utils.shard_name_from_tenant(tenant:)
         Config.current.tenant = tenant
         DbContext.add_shard(shard:, db_config:)
         ActiveRecord::Base.connects_to(shards: DbContext.connected_shards)

data/tenant_realm.gemspec

@@ -34,6 +34,10 @@ Gem::Specification.new do |spec|
             .vscode/settings.json
             LICENSE.txt
             lefthook.yml
+            docs/
+            biome.json
+            package.json
+            pnpm-lock.yaml
           ]
         )
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tenant_realm
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Alpha
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-27 00:00:00.000000000 Z
+date: 2024-01-30 00:00:00.000000000 Z
 dependencies: []
 description: Ruby on Rails gem to support multi-tenant
 email:
@@ -23,6 +23,7 @@ files:
 - lib/generators/templates/tenant_realm.tt
 - lib/generators/tenant_realm_generator.rb
 - lib/tasks/migrate.rake
+- lib/tasks/rollback.rake
 - lib/tenant_realm.rb
 - lib/tenant_realm/cache/base_cache.rb
 - lib/tenant_realm/cache/kredis_cache.rb