From f473f6c4aa204483f05435cf06c6917cf8b1a295 Mon Sep 17 00:00:00 2001 From: Patricio Mac Adden Date: Wed, 10 May 2023 23:49:19 -0300 Subject: [PATCH 1/5] Cleanup and more --- .gitignore | 8 ++ .standard.yml | 3 + Gemfile | 10 ++ Rakefile | 6 + .../models/landlord_record.rb | 10 +- app/models/tenant.rb | 25 +++++ .../models}/tenant_connection.rb | 6 +- bin/console | 15 +++ bin/setup | 8 ++ landlord.gemspec | 49 +++++--- lib/generators/landlord/install_generator.rb | 18 +-- ...ection.rb => create_tenant_connections.rb} | 6 +- .../landlord/templates/create_tenants.rb | 11 +- lib/generators/landlord/templates/tenant.rb | 28 ----- lib/landlord.rb | 5 +- lib/landlord/engine.rb | 7 ++ lib/landlord/schema_name_generator.rb | 25 +++++ lib/landlord/tasks/landlord.rake | 105 ++++++++++++++++++ lib/landlord/version.rb | 3 + lib/schema_name_generator.rb | 23 ---- 20 files changed, 283 insertions(+), 88 deletions(-) create mode 100644 .gitignore create mode 100644 .standard.yml create mode 100644 Gemfile create mode 100644 Rakefile rename lib/db_connections_fetcher.rb => app/models/landlord_record.rb (78%) create mode 100644 app/models/tenant.rb rename {lib/generators/landlord/templates => app/models}/tenant_connection.rb (93%) create mode 100755 bin/console create mode 100755 bin/setup rename lib/generators/landlord/templates/{create_tenant_connection.rb => create_tenant_connections.rb} (70%) delete mode 100644 lib/generators/landlord/templates/tenant.rb create mode 100644 lib/landlord/engine.rb create mode 100644 lib/landlord/schema_name_generator.rb create mode 100644 lib/landlord/tasks/landlord.rake create mode 100644 lib/landlord/version.rb delete mode 100644 lib/schema_name_generator.rb diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9106b2a --- /dev/null +++ b/.gitignore @@ -0,0 +1,8 @@ +/.bundle/ +/.yardoc +/_yardoc/ +/coverage/ +/doc/ +/pkg/ +/spec/reports/ +/tmp/ diff --git a/.standard.yml b/.standard.yml new file mode 100644 index 0000000..3a0787a --- /dev/null +++ b/.standard.yml @@ -0,0 +1,3 @@ +# For available configuration options, see: +# https://github.com/testdouble/standard +ruby_version: 2.6 diff --git a/Gemfile b/Gemfile new file mode 100644 index 0000000..df6ce4d --- /dev/null +++ b/Gemfile @@ -0,0 +1,10 @@ +# frozen_string_literal: true + +source "https://rubygems.org" + +# Specify your gem's dependencies in landlord.gemspec +gemspec + +gem "rake", "~> 13.0" + +gem "standard", "~> 1.3" diff --git a/Rakefile b/Rakefile new file mode 100644 index 0000000..12e5882 --- /dev/null +++ b/Rakefile @@ -0,0 +1,6 @@ +# frozen_string_literal: true + +require "bundler/gem_tasks" +require "standard/rake" + +task default: :standard diff --git a/lib/db_connections_fetcher.rb b/app/models/landlord_record.rb similarity index 78% rename from lib/db_connections_fetcher.rb rename to app/models/landlord_record.rb index 3c2d441..bd96ddf 100644 --- a/lib/db_connections_fetcher.rb +++ b/app/models/landlord_record.rb @@ -1,5 +1,7 @@ -module DbConnectionsFetcher - def fetch_db_connections +class LandlordRecord < ActiveRecord::Base + self.abstract_class = true + + def self.fetch_db_connections connections = [] role = :writing @@ -26,4 +28,8 @@ def fetch_db_connections connections end + + # TODO: originally this should go in ApplicationRecord. By extracting this functionality (see tenant.rb:19) into this class to share across models of this gem, this doesn't work. + # why we need it? + # fetch_db_connections end diff --git a/app/models/tenant.rb b/app/models/tenant.rb new file mode 100644 index 0000000..9b52d69 --- /dev/null +++ b/app/models/tenant.rb @@ -0,0 +1,25 @@ +class Tenant < LandlordRecord + has_one :tenant_connection, dependent: :destroy + + after_create_commit :create_tenant_connection + + def self.current + current_tenant_connection = TenantConnection.current + + Landlord.switch_to_main do + tenant.find_by(tenancy_connection: current_tenant_connection) + end + end + + def create_tenant_connection + @tenancy_connection = TenantConnection.create_from!(from_env_name: Rails.env, from_db_name: "primary", schema_search_path: Landlord::SchemaNameGenerator.generate(name), tenant: self) + Landlord.create_tenant(@tenancy_connection.config) + self.class.fetch_db_connections + + ## Hot restart puma + unless Rails.env.test? + pid = File.read(".pumactl_pid").to_i + Process.kill("SIGUSR2", pid) + end + end +end diff --git a/lib/generators/landlord/templates/tenant_connection.rb b/app/models/tenant_connection.rb similarity index 93% rename from lib/generators/landlord/templates/tenant_connection.rb rename to app/models/tenant_connection.rb index 0bb5402..0ca0205 100644 --- a/lib/generators/landlord/templates/tenant_connection.rb +++ b/app/models/tenant_connection.rb @@ -1,5 +1,5 @@ -class TenantConnection < ApplicationRecord - belongs_to :customer +class TenantConnection < LandlordRecord + belongs_to :tenant def shard_name Landlord.shard_name(config) @@ -20,6 +20,8 @@ def self.create_from!(from_env_name:, from_db_name:, **new_attributes) # public is not a valid schema name raise if tenant_options[:schema_search_path] == "public" + pp defaults.merge(tenant_options) + create!(**defaults.merge(tenant_options)) end diff --git a/bin/console b/bin/console new file mode 100755 index 0000000..0e80597 --- /dev/null +++ b/bin/console @@ -0,0 +1,15 @@ +#!/usr/bin/env ruby +# frozen_string_literal: true + +require "bundler/setup" +require "landlord" + +# You can add fixtures and/or initialization code here to make experimenting +# with your gem easier. You can also use a different console, if you like. + +# (If you use this, don't forget to add pry to your Gemfile!) +# require "pry" +# Pry.start + +require "irb" +IRB.start(__FILE__) diff --git a/bin/setup b/bin/setup new file mode 100755 index 0000000..dce67d8 --- /dev/null +++ b/bin/setup @@ -0,0 +1,8 @@ +#!/usr/bin/env bash +set -euo pipefail +IFS=$'\n\t' +set -vx + +bundle install + +# Do any other automated setup that you need to do here diff --git a/landlord.gemspec b/landlord.gemspec index f26e312..06c8156 100644 --- a/landlord.gemspec +++ b/landlord.gemspec @@ -1,16 +1,37 @@ -Gem::Specification.new do |s| - s.name = "landlord" - s.version = "0.1.0" - s.summary = "A dynamic and hybrid multitenancy solution for Rails > 6.0 & PostgresSQL" - s.description = "A dynamic and hybrid multitenancy solution for Rails > 6.0 & PostgresSQL" - s.authors = ["Nazareno Moresco"] - s.email = "nazareno.moresco@sinaptia.dev" - s.files = Dir["lib/**/*"] - s.homepage = - "https://rubygems.org/gems/landlord" - s.license = "MIT" +require_relative "lib/landlord/version" - s.add_dependency 'rails', '~> 6.1' -end +Gem::Specification.new do |spec| + spec.name = "landlord" + spec.version = Landlord::VERSION + spec.authors = ["Nazareno Moresco"] + spec.email = "nazareno.moresco@sinaptia.dev" + spec.summary = "A dynamic and hybrid multitenancy solution for Rails > 6.0 & PostgresSQL" + spec.description = "A dynamic and hybrid multitenancy solution for Rails > 6.0 & PostgresSQL" + spec.homepage = "https://rubygems.org/gems/landlord" + spec.required_ruby_version = ">= 2.6.0" + + spec.license = "MIT" + + spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'" + + spec.metadata["homepage_uri"] = spec.homepage + spec.metadata["source_code_uri"] = "https://github.com/sinaptia/landlord" - \ No newline at end of file + # Specify which files should be added to the gem when it is released. + # The `git ls-files -z` loads the files in the RubyGem that have been added into git. + spec.files = Dir.chdir(__dir__) do + `git ls-files -z`.split("\x0").reject do |f| + (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor]) + end + end + spec.bindir = "exe" + spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) } + spec.require_paths = ["lib"] + + # Uncomment to register a new dependency of your gem + # spec.add_dependency "example-gem", "~> 1.0" + spec.add_dependency 'rails', '>= 6.0' + + # For more information and examples about making a new gem, check out our + # guide at: https://bundler.io/guides/creating_gem.html +end diff --git a/lib/generators/landlord/install_generator.rb b/lib/generators/landlord/install_generator.rb index 6b4e497..de3f8b7 100644 --- a/lib/generators/landlord/install_generator.rb +++ b/lib/generators/landlord/install_generator.rb @@ -1,18 +1,20 @@ -require 'rails/generators/active_record' +require "rails/generators" +require "rails/generators/active_record" module Landlord module Generators - class InstallGenerator < ActiveRecord::Generators::Base - source_root File.expand_path('templates', __dir__) + class InstallGenerator < Rails::Generators::Base + include ActiveRecord::Generators::Migration + + source_root File.expand_path("templates", __dir__) def copy_migration_files - migration_template 'create_tenants.rb', 'db/migrate/create_tenants.rb' - migration_template 'create_tenant_connection.rb', 'db/migrate/create_tenant_connection.rb' + migration_template "create_tenants.rb", "db/migrate/create_tenants.rb" + migration_template "create_tenant_connections.rb", "db/migrate/create_tenant_connections.rb" end - def generate_models - copy_file 'tenant.rb', 'app/models/tenant.rb' - copy_file 'tenant_connection.rb', 'app/models/tenant_connection.rb' + def create_migrate_tenants_dir + create_file "db/migrate_tenants/.keep" end end end diff --git a/lib/generators/landlord/templates/create_tenant_connection.rb b/lib/generators/landlord/templates/create_tenant_connections.rb similarity index 70% rename from lib/generators/landlord/templates/create_tenant_connection.rb rename to lib/generators/landlord/templates/create_tenant_connections.rb index 22660c0..3d5fecb 100644 --- a/lib/generators/landlord/templates/create_tenant_connection.rb +++ b/lib/generators/landlord/templates/create_tenant_connections.rb @@ -1,6 +1,6 @@ -class CreateTenantConnection < ActiveRecord::Migration[6.0] +class CreateTenantConnections < ActiveRecord::Migration[6.0] def change - create_table :tenant_connection, force: :cascade do |t| + create_table :tenant_connections, force: :cascade do |t| t.string :database t.integer :timeout t.string :adapter @@ -9,7 +9,7 @@ def change t.string :password t.string :host t.string :port - t.string :migrations_paths, default: 'db/tenant_migrate' + t.string :migrations_paths, default: "db/migrate_tentants" t.boolean :database_owner, default: false t.references :tenant, foreign_key: true t.datetime :created_at, precision: 6, null: false diff --git a/lib/generators/landlord/templates/create_tenants.rb b/lib/generators/landlord/templates/create_tenants.rb index 41ab5cd..07b1896 100644 --- a/lib/generators/landlord/templates/create_tenants.rb +++ b/lib/generators/landlord/templates/create_tenants.rb @@ -1,10 +1,9 @@ class CreateTenants < ActiveRecord::Migration[6.0] - def change - create_table :tenants, force: :cascade do |t| - t.string :name + def change + create_table :tenants, force: :cascade do |t| + t.string :name - t.timestamps - end + t.timestamps end end - \ No newline at end of file +end diff --git a/lib/generators/landlord/templates/tenant.rb b/lib/generators/landlord/templates/tenant.rb deleted file mode 100644 index ae13eab..0000000 --- a/lib/generators/landlord/templates/tenant.rb +++ /dev/null @@ -1,28 +0,0 @@ -class Tenant < ApplicationRecord - has_one :tenant_connection, dependent: :destroy - - include SchemaNameGenerator - - after_create_commit :create_tenant_connection - - def self.current - current_tenant_connection = TenantConnection.current - - TenancyManager.switch_to_main do - tenant.find_by(tenancy_connection: current_tenant_connection) - end - end - - def create_tenant_connection - @tenancy_connection = TenantConnection.create_from!(from_env_name: Rails.env, from_db_name: "primary", schema_search_path: schema_name_override || SchemaNameGenerator.generate(name), tenant: self) - TenancyManager.create_tenant(@tenancy_connection.config) - ApplicationRecord.fetch_db_connections - - ## Hot restart puma - unless Rails.env.test? - pid = File.read(".pumactl_pid").to_i - Process.kill("SIGUSR2", pid) - end - end -end - \ No newline at end of file diff --git a/lib/landlord.rb b/lib/landlord.rb index 307df68..44a9c12 100644 --- a/lib/landlord.rb +++ b/lib/landlord.rb @@ -1,5 +1,7 @@ +require "landlord/engine" +require "landlord/schema_name_generator" + module Landlord - class Landlord # Returns the connection configuration of the main connection def self.main_connection ActiveRecord::Base.configurations.configs_for(env_name: Rails.env, name: "primary").configuration_hash.symbolize_keys.compact_blank @@ -148,5 +150,4 @@ def self.drop_schema(schema_name) def self.schema_exists?(name) ActiveRecord::Base.connection.schema_exists? name end - end end diff --git a/lib/landlord/engine.rb b/lib/landlord/engine.rb new file mode 100644 index 0000000..4f62971 --- /dev/null +++ b/lib/landlord/engine.rb @@ -0,0 +1,7 @@ +module Landlord + class Engine < Rails::Engine + rake_tasks do + load File.join(__dir__, "tasks/landlord.rake") + end + end +end diff --git a/lib/landlord/schema_name_generator.rb b/lib/landlord/schema_name_generator.rb new file mode 100644 index 0000000..d03d1a6 --- /dev/null +++ b/lib/landlord/schema_name_generator.rb @@ -0,0 +1,25 @@ +module Landlord + module SchemaNameGenerator + # The schema name has some restrictions - cant start with number, pg, etc + # See: https://dba.stackexchange.com/questions/45589/what-are-the-valid-formats-of-a-postgresql-schema-name + # Prefix with tenant_ resolves all these issues + def self.generate(name) + create_uniq_name("tenant_#{name.parameterize.underscore}") + end + + private_class_method + + def self.create_uniq_name(name) + similar_schemas_names = get_all_with_same_name name + if similar_schemas_names.size > 0 + next_num = similar_schemas_names.max_by { |name| name.scan(/\d+/) }.scan(/\d+/).first.nil? ? 1 : similar_schemas_names.max_by { |name| name.scan(/\d+/) }.scan(/\d+/).first.to_i + 1 + return "#{name}_#{next_num}" + end + name + end + + def self.get_all_with_same_name(name) + TenantConnection.where("schema_search_path LIKE ?", "#{name}%").pluck(:schema_search_path) + end + end +end diff --git a/lib/landlord/tasks/landlord.rake b/lib/landlord/tasks/landlord.rake new file mode 100644 index 0000000..9b77019 --- /dev/null +++ b/lib/landlord/tasks/landlord.rake @@ -0,0 +1,105 @@ +require "active_record" + +namespace :db do + # Dumps the public schema in the ruby format as reference + task ruby_public_dump: :load_config do + db_config = ActiveRecord::Base.connection_db_config + ActiveRecord::Tasks::DatabaseTasks.dump_schema(db_config, :ruby) + end + + task tenant_migrate: :load_config do + original_db_config = ActiveRecord::Base.connection_db_config + ask_again = true + TenantConnection.order(:id).all.map(&:config).each_with_index do |db_config, index| + puts "Migrating #{db_config[:schema_search_path]}... " + + # Check in the case tenancy_connection were not localized + ask_again = check_env_matching_db_configuration!(original_db_config, db_config) if ask_again + + # Migrate + ActiveRecord::Base.establish_connection(db_config) + ActiveRecord::Tasks::DatabaseTasks.migrate + + # Use first tenancy_connection for the schema dump + next unless index.zero? + db_config[:name] = "tenants" + ActiveRecord::Tasks::DatabaseTasks.dump_schema(ActiveRecord::DatabaseConfigurations::HashConfig.new(Rails.env, "primary", db_config), :ruby) + end + ensure + ActiveRecord::Base.establish_connection(original_db_config) + end + + task tenant_rollback: :load_config do + original_db_config = ActiveRecord::Base.connection_db_config + ask_again = true + TenantConnection.all.map(&:config).each_with_index do |db_config, index| + puts "Rollbacking #{db_config[:schema_search_path]}... " + + # Check in the case tenancy_connection were not localized + ask_again = check_env_matching_db_configuration!(original_db_config, db_config) if ask_again + + # Migrate + ActiveRecord::Base.establish_connection(db_config) + ActiveRecord::Base.connection.migration_context.rollback(1) + + # Use first tenancy_connection for the schema dump + next unless index.zero? + db_config[:name] = "tenants" + ActiveRecord::Tasks::DatabaseTasks.dump_schema(OpenStruct.new(db_config), :ruby) + end + ensure + ActiveRecord::Base.establish_connection(original_db_config) + end +end + +# Invoke these tasks after the migration +Rake::Task["db:migrate"].enhance do + Rake::Task["db:tenant_migrate"].invoke + Rake::Task["db:ruby_public_dump"].invoke +end + +# Handles mismatches between env db and tenant db and returns if this should be run again +def check_env_matching_db_configuration!(env_config, tenancy_config) + return false if ENV["AWS_ENV_NAME"] == "production" + + env_db_host = env_config.configuration_hash[:host] + tenant_db_host = tenancy_config[:host] + return true if env_db_host == tenant_db_host + + extra_databases_in_staging_and_qa_hosts = [] + if (ENV["AWS_ENV_NAME"] == "staging" || ENV["AWS_ENV_NAME"] == "qa") && !extra_databases_in_staging_and_qa_hosts.include?(tenant_db_host) + abort "Remember to run bundle exec rake tenants:localize_connections or add #{tenant_db_host} to 'extra_databases_in_staging_and_qa_hosts'" + end + + final_decision = false + until final_decision + puts + puts "This connection doesn't match this env main DB." + puts "Maybe this is a db-level tenant or maybe you forgot to run tenants:localize_connections" + puts "Do you want to abort?" + puts " * Y: abort, mb :$" + puts " * N: continue" + puts " * T: Show me the tenant connection db config" + puts " * M: Show me the main connection db config from this env" + puts " * D: continue and don't ask again" + option = gets.chomp + exit if option == "Y" + ask_again = option != "D" + + if option == "Y" || option == "N" || option == "D" + final_decision = true + elsif option == "T" + puts "Printing tenancy_connection db config..." + puts tenancy_config + sleep(1) + elsif option == "M" + puts "Printing env main connection db config..." + puts env_config.configuration_hash + sleep(1) + else + puts "That's not a valid option, try again." + end + end + + ask_again +end diff --git a/lib/landlord/version.rb b/lib/landlord/version.rb new file mode 100644 index 0000000..e3249d5 --- /dev/null +++ b/lib/landlord/version.rb @@ -0,0 +1,3 @@ +module Landlord + VERSION = "0.1.0" +end diff --git a/lib/schema_name_generator.rb b/lib/schema_name_generator.rb deleted file mode 100644 index 5bc4e4a..0000000 --- a/lib/schema_name_generator.rb +++ /dev/null @@ -1,23 +0,0 @@ -module SchemaNameGenerator - # The schema name has some restrictions - cant start with number, pg, etc - # See: https://dba.stackexchange.com/questions/45589/what-are-the-valid-formats-of-a-postgresql-schema-name - # Prefix with tenant_ resolves all these issues - def self.generate(name) - create_uniq_name("tenant_#{name.parameterize.underscore}") - end - - private_class_method - - def self.create_uniq_name(name) - similar_schemas_names = get_all_with_same_name name - if similar_schemas_names.size > 0 - next_num = similar_schemas_names.max_by { |name| name.scan(/\d+/) }.scan(/\d+/).first.nil? ? 1 : similar_schemas_names.max_by { |name| name.scan(/\d+/) }.scan(/\d+/).first.to_i + 1 - return "#{name}_#{next_num}" - end - name - end - - def self.get_all_with_same_name(name) - TenancyConnection.all.where("schema_search_path LIKE ?", "#{name}%").pluck(:schema_search_path) - end -end From d822ee5f40b54d31eb58c159847f1b095c485a30 Mon Sep 17 00:00:00 2001 From: Patricio Mac Adden Date: Wed, 10 May 2023 23:53:10 -0300 Subject: [PATCH 2/5] oops --- app/models/tenant_connection.rb | 2 -- 1 file changed, 2 deletions(-) diff --git a/app/models/tenant_connection.rb b/app/models/tenant_connection.rb index 0ca0205..74b1106 100644 --- a/app/models/tenant_connection.rb +++ b/app/models/tenant_connection.rb @@ -20,8 +20,6 @@ def self.create_from!(from_env_name:, from_db_name:, **new_attributes) # public is not a valid schema name raise if tenant_options[:schema_search_path] == "public" - pp defaults.merge(tenant_options) - create!(**defaults.merge(tenant_options)) end From 5adc31c37292f6b5c5f05de4dc04e4ab79a62cf1 Mon Sep 17 00:00:00 2001 From: Patricio Mac Adden Date: Thu, 11 May 2023 19:11:44 -0300 Subject: [PATCH 3/5] some fixes --- app/models/landlord_record.rb | 35 ------------------- app/models/tenant.rb | 4 ++- app/models/tenant_connection.rb | 2 +- lib/generators/landlord/install_generator.rb | 10 ++++++ .../templates/create_tenant_connections.rb | 2 +- lib/landlord.rb | 3 +- lib/landlord/concern.rb | 35 +++++++++++++++++++ 7 files changed, 52 insertions(+), 39 deletions(-) delete mode 100644 app/models/landlord_record.rb create mode 100644 lib/landlord/concern.rb diff --git a/app/models/landlord_record.rb b/app/models/landlord_record.rb deleted file mode 100644 index bd96ddf..0000000 --- a/app/models/landlord_record.rb +++ /dev/null @@ -1,35 +0,0 @@ -class LandlordRecord < ActiveRecord::Base - self.abstract_class = true - - def self.fetch_db_connections - connections = [] - - role = :writing - default_shard = :primary - - handler = lookup_connection_handler(role.to_sym) - self.connection_class = true - - # Default connection - db_config, owner_name = resolve_config_for_connection(default_shard) - connections << handler.establish_connection(db_config, owner_name: owner_name, role: role, shard: default_shard) - - # Stored in the db connections - begin - db_stored_connections_configurations = ActiveRecord::Base.connection.execute("SELECT database, timeout, adapter, schema_search_path, username, password, host, port, migrations_paths FROM tenants_connection").to_a - db_stored_connections_configurations.each { |config| config["pool"] = ENV.fetch("RAILS_MAX_THREADS", 5) } - db_stored_connections_configurations.each do |connection_configuration| - connection_configuration = connection_configuration.symbolize_keys - connections << handler.establish_connection(connection_configuration, owner_name: owner_name, role: role, shard: TenancyManager.shard_name(connection_configuration)) - end - rescue - # In migrations, we might not have tenants_connection, it is not neccessary to load them anyways - end - - connections - end - - # TODO: originally this should go in ApplicationRecord. By extracting this functionality (see tenant.rb:19) into this class to share across models of this gem, this doesn't work. - # why we need it? - # fetch_db_connections -end diff --git a/app/models/tenant.rb b/app/models/tenant.rb index 9b52d69..6033738 100644 --- a/app/models/tenant.rb +++ b/app/models/tenant.rb @@ -1,4 +1,6 @@ -class Tenant < LandlordRecord +class Tenant < ActiveRecord::Base + include Landlord::Concern + has_one :tenant_connection, dependent: :destroy after_create_commit :create_tenant_connection diff --git a/app/models/tenant_connection.rb b/app/models/tenant_connection.rb index 74b1106..f9456cf 100644 --- a/app/models/tenant_connection.rb +++ b/app/models/tenant_connection.rb @@ -1,4 +1,4 @@ -class TenantConnection < LandlordRecord +class TenantConnection < ActiveRecord::Base belongs_to :tenant def shard_name diff --git a/lib/generators/landlord/install_generator.rb b/lib/generators/landlord/install_generator.rb index de3f8b7..6f9b390 100644 --- a/lib/generators/landlord/install_generator.rb +++ b/lib/generators/landlord/install_generator.rb @@ -16,6 +16,16 @@ def copy_migration_files def create_migrate_tenants_dir create_file "db/migrate_tenants/.keep" end + + def update_application_record + inject_into_class "app/models/application_record.rb", "ApplicationRecord" do + <<-STR + include Landlord::Concern + + fetch_db_connections + STR + end + end end end end diff --git a/lib/generators/landlord/templates/create_tenant_connections.rb b/lib/generators/landlord/templates/create_tenant_connections.rb index 3d5fecb..0eb3a43 100644 --- a/lib/generators/landlord/templates/create_tenant_connections.rb +++ b/lib/generators/landlord/templates/create_tenant_connections.rb @@ -9,7 +9,7 @@ def change t.string :password t.string :host t.string :port - t.string :migrations_paths, default: "db/migrate_tentants" + t.string :migrations_paths, default: "db/migrate_tenants" t.boolean :database_owner, default: false t.references :tenant, foreign_key: true t.datetime :created_at, precision: 6, null: false diff --git a/lib/landlord.rb b/lib/landlord.rb index 44a9c12..86fd9f6 100644 --- a/lib/landlord.rb +++ b/lib/landlord.rb @@ -1,3 +1,4 @@ +require "landlord/concern" require "landlord/engine" require "landlord/schema_name_generator" @@ -48,7 +49,7 @@ def self.switch_to(tenant, &blk) end end - # Switchs to the given connection configuration for the given block + # Switches to the given connection configuration for the given block # More native option for switching tenants def self.switch(connection_configuration, &blk) ActiveRecord::Base.connected_to(role: :writing, shard: shard_name(connection_configuration)) do diff --git a/lib/landlord/concern.rb b/lib/landlord/concern.rb new file mode 100644 index 0000000..b5edd4c --- /dev/null +++ b/lib/landlord/concern.rb @@ -0,0 +1,35 @@ +module Landlord + module Concern + extend ActiveSupport::Concern + + class_methods do + def fetch_db_connections + connections = [] + + role = :writing + default_shard = :primary + + handler = lookup_connection_handler(role.to_sym) + self.connection_class = true + + # Default connection + db_config, owner_name = resolve_config_for_connection(default_shard) + connections << handler.establish_connection(db_config, owner_name: owner_name, role: role, shard: default_shard) + + # Stored in the db connections + begin + db_stored_connections_configurations = ActiveRecord::Base.connection.execute("SELECT database, timeout, adapter, schema_search_path, username, password, host, port, migrations_paths FROM tenants_connection").to_a + db_stored_connections_configurations.each { |config| config["pool"] = ENV.fetch("RAILS_MAX_THREADS", 5) } + db_stored_connections_configurations.each do |connection_configuration| + connection_configuration = connection_configuration.symbolize_keys + connections << handler.establish_connection(connection_configuration, owner_name: owner_name, role: role, shard: TenancyManager.shard_name(connection_configuration)) + end + rescue + # In migrations, we might not have tenants_connection, it is not neccessary to load them anyways + end + + connections + end + end + end +end From f9a03cac388720cfda6597c0bb4a51a9c43b2d9b Mon Sep 17 00:00:00 2001 From: Patricio Mac Adden Date: Mon, 4 Sep 2023 21:55:09 -0300 Subject: [PATCH 4/5] more changeS --- .gitignore | 11 +- .standard.yml | 3 - Dockerfile | 17 ++ Gemfile | 15 +- Gemfile.lock | 234 ++++++++++++++++++ MIT-LICENSE | 20 ++ README.md | 44 ++-- Rakefile | 10 +- bin/console | 15 -- bin/entrypoint.sh | 7 + bin/rails | 14 ++ bin/setup | 8 - docker-compose.yml | 38 +++ landlord.gemspec | 37 +-- lib/landlord.rb | 3 +- lib/landlord/engine.rb | 4 +- .../landlord_tasks.rake} | 82 +++--- test/dummy/.env.sample | 1 + test/dummy/Rakefile | 6 + test/dummy/app/assets/config/manifest.js | 2 + test/dummy/app/assets/images/.keep | 0 .../app/assets/stylesheets/application.css | 15 ++ .../app/channels/application_cable/channel.rb | 4 + .../channels/application_cable/connection.rb | 4 + .../app/controllers/application_controller.rb | 2 + test/dummy/app/controllers/concerns/.keep | 0 test/dummy/app/helpers/application_helper.rb | 2 + test/dummy/app/jobs/application_job.rb | 7 + test/dummy/app/mailers/application_mailer.rb | 4 + test/dummy/app/models/application_record.rb | 3 + test/dummy/app/models/concerns/.keep | 0 .../app/views/layouts/application.html.erb | 15 ++ test/dummy/app/views/layouts/mailer.html.erb | 13 + test/dummy/app/views/layouts/mailer.text.erb | 1 + test/dummy/bin/rails | 4 + test/dummy/bin/rake | 4 + test/dummy/bin/setup | 33 +++ test/dummy/config.ru | 6 + test/dummy/config/application.rb | 25 ++ test/dummy/config/boot.rb | 5 + test/dummy/config/cable.yml | 10 + test/dummy/config/database.yml | 25 ++ test/dummy/config/environment.rb | 5 + test/dummy/config/environments/development.rb | 70 ++++++ test/dummy/config/environments/production.rb | 93 +++++++ test/dummy/config/environments/test.rb | 60 +++++ test/dummy/config/initializers/assets.rb | 12 + .../initializers/content_security_policy.rb | 25 ++ .../initializers/filter_parameter_logging.rb | 8 + test/dummy/config/initializers/inflections.rb | 16 ++ .../config/initializers/permissions_policy.rb | 11 + test/dummy/config/locales/en.yml | 33 +++ test/dummy/config/puma.rb | 43 ++++ test/dummy/config/routes.rb | 6 + test/dummy/config/storage.yml | 34 +++ test/dummy/lib/assets/.keep | 0 test/dummy/log/.keep | 0 test/dummy/public/404.html | 67 +++++ test/dummy/public/422.html | 67 +++++ test/dummy/public/500.html | 66 +++++ .../public/apple-touch-icon-precomposed.png | 0 test/dummy/public/apple-touch-icon.png | 0 test/dummy/public/favicon.ico | 0 test/landlord_test.rb | 7 + test/models/.keep | 0 test/test_helper.rb | 14 ++ 66 files changed, 1258 insertions(+), 132 deletions(-) delete mode 100644 .standard.yml create mode 100644 Dockerfile create mode 100644 Gemfile.lock create mode 100644 MIT-LICENSE delete mode 100755 bin/console create mode 100644 bin/entrypoint.sh create mode 100755 bin/rails delete mode 100755 bin/setup create mode 100644 docker-compose.yml rename lib/{landlord/tasks/landlord.rake => tasks/landlord_tasks.rake} (52%) create mode 100644 test/dummy/.env.sample create mode 100644 test/dummy/Rakefile create mode 100644 test/dummy/app/assets/config/manifest.js create mode 100644 test/dummy/app/assets/images/.keep create mode 100644 test/dummy/app/assets/stylesheets/application.css create mode 100644 test/dummy/app/channels/application_cable/channel.rb create mode 100644 test/dummy/app/channels/application_cable/connection.rb create mode 100644 test/dummy/app/controllers/application_controller.rb create mode 100644 test/dummy/app/controllers/concerns/.keep create mode 100644 test/dummy/app/helpers/application_helper.rb create mode 100644 test/dummy/app/jobs/application_job.rb create mode 100644 test/dummy/app/mailers/application_mailer.rb create mode 100644 test/dummy/app/models/application_record.rb create mode 100644 test/dummy/app/models/concerns/.keep create mode 100644 test/dummy/app/views/layouts/application.html.erb create mode 100644 test/dummy/app/views/layouts/mailer.html.erb create mode 100644 test/dummy/app/views/layouts/mailer.text.erb create mode 100755 test/dummy/bin/rails create mode 100755 test/dummy/bin/rake create mode 100755 test/dummy/bin/setup create mode 100644 test/dummy/config.ru create mode 100644 test/dummy/config/application.rb create mode 100644 test/dummy/config/boot.rb create mode 100644 test/dummy/config/cable.yml create mode 100644 test/dummy/config/database.yml create mode 100644 test/dummy/config/environment.rb create mode 100644 test/dummy/config/environments/development.rb create mode 100644 test/dummy/config/environments/production.rb create mode 100644 test/dummy/config/environments/test.rb create mode 100644 test/dummy/config/initializers/assets.rb create mode 100644 test/dummy/config/initializers/content_security_policy.rb create mode 100644 test/dummy/config/initializers/filter_parameter_logging.rb create mode 100644 test/dummy/config/initializers/inflections.rb create mode 100644 test/dummy/config/initializers/permissions_policy.rb create mode 100644 test/dummy/config/locales/en.yml create mode 100644 test/dummy/config/puma.rb create mode 100644 test/dummy/config/routes.rb create mode 100644 test/dummy/config/storage.yml create mode 100644 test/dummy/lib/assets/.keep create mode 100644 test/dummy/log/.keep create mode 100644 test/dummy/public/404.html create mode 100644 test/dummy/public/422.html create mode 100644 test/dummy/public/500.html create mode 100644 test/dummy/public/apple-touch-icon-precomposed.png create mode 100644 test/dummy/public/apple-touch-icon.png create mode 100644 test/dummy/public/favicon.ico create mode 100644 test/landlord_test.rb create mode 100644 test/models/.keep create mode 100644 test/test_helper.rb diff --git a/.gitignore b/.gitignore index 9106b2a..5ec479f 100644 --- a/.gitignore +++ b/.gitignore @@ -1,8 +1,11 @@ /.bundle/ -/.yardoc -/_yardoc/ -/coverage/ /doc/ +/log/*.log /pkg/ -/spec/reports/ /tmp/ +/test/dummy/db/*.sqlite3 +/test/dummy/db/*.sqlite3-* +/test/dummy/log/*.log +/test/dummy/storage/ +/test/dummy/tmp/ +/test/dummy/.env diff --git a/.standard.yml b/.standard.yml deleted file mode 100644 index 3a0787a..0000000 --- a/.standard.yml +++ /dev/null @@ -1,3 +0,0 @@ -# For available configuration options, see: -# https://github.com/testdouble/standard -ruby_version: 2.6 diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..eb9e76c --- /dev/null +++ b/Dockerfile @@ -0,0 +1,17 @@ +FROM ruby:3.2-alpine + +RUN apk add --no-cache --update build-base git imagemagick linux-headers nodejs postgresql-dev tzdata yarn + +WORKDIR /app + +COPY . . +COPY bin/entrypoint.sh /usr/bin/ + +RUN chmod +x /usr/bin/entrypoint.sh + +RUN bundle install + +ENTRYPOINT ["entrypoint.sh"] +EXPOSE 3000 + +CMD ["rails", "server", "-b", "0.0.0.0"] diff --git a/Gemfile b/Gemfile index df6ce4d..1c3d412 100644 --- a/Gemfile +++ b/Gemfile @@ -1,10 +1,15 @@ -# frozen_string_literal: true - source "https://rubygems.org" +git_source(:github) { |repo| "https://github.com/#{repo}.git" } -# Specify your gem's dependencies in landlord.gemspec gemspec -gem "rake", "~> 13.0" +gem "pg" +gem "puma" +gem "sprockets-rails" -gem "standard", "~> 1.3" +group :development, :test do + # Start debugger with binding.b [https://github.com/ruby/debug] + gem "debug" + gem "dotenv-rails" + gem "standard" +end diff --git a/Gemfile.lock b/Gemfile.lock new file mode 100644 index 0000000..3b019d6 --- /dev/null +++ b/Gemfile.lock @@ -0,0 +1,234 @@ +PATH + remote: . + specs: + landlord (0.1.0) + rails (>= 6.0) + +GEM + remote: https://rubygems.org/ + specs: + actioncable (7.0.7.2) + actionpack (= 7.0.7.2) + activesupport (= 7.0.7.2) + nio4r (~> 2.0) + websocket-driver (>= 0.6.1) + actionmailbox (7.0.7.2) + actionpack (= 7.0.7.2) + activejob (= 7.0.7.2) + activerecord (= 7.0.7.2) + activestorage (= 7.0.7.2) + activesupport (= 7.0.7.2) + mail (>= 2.7.1) + net-imap + net-pop + net-smtp + actionmailer (7.0.7.2) + actionpack (= 7.0.7.2) + actionview (= 7.0.7.2) + activejob (= 7.0.7.2) + activesupport (= 7.0.7.2) + mail (~> 2.5, >= 2.5.4) + net-imap + net-pop + net-smtp + rails-dom-testing (~> 2.0) + actionpack (7.0.7.2) + actionview (= 7.0.7.2) + activesupport (= 7.0.7.2) + rack (~> 2.0, >= 2.2.4) + rack-test (>= 0.6.3) + rails-dom-testing (~> 2.0) + rails-html-sanitizer (~> 1.0, >= 1.2.0) + actiontext (7.0.7.2) + actionpack (= 7.0.7.2) + activerecord (= 7.0.7.2) + activestorage (= 7.0.7.2) + activesupport (= 7.0.7.2) + globalid (>= 0.6.0) + nokogiri (>= 1.8.5) + actionview (7.0.7.2) + activesupport (= 7.0.7.2) + builder (~> 3.1) + erubi (~> 1.4) + rails-dom-testing (~> 2.0) + rails-html-sanitizer (~> 1.1, >= 1.2.0) + activejob (7.0.7.2) + activesupport (= 7.0.7.2) + globalid (>= 0.3.6) + activemodel (7.0.7.2) + activesupport (= 7.0.7.2) + activerecord (7.0.7.2) + activemodel (= 7.0.7.2) + activesupport (= 7.0.7.2) + activestorage (7.0.7.2) + actionpack (= 7.0.7.2) + activejob (= 7.0.7.2) + activerecord (= 7.0.7.2) + activesupport (= 7.0.7.2) + marcel (~> 1.0) + mini_mime (>= 1.1.0) + activesupport (7.0.7.2) + concurrent-ruby (~> 1.0, >= 1.0.2) + i18n (>= 1.6, < 2) + minitest (>= 5.1) + tzinfo (~> 2.0) + ast (2.4.2) + base64 (0.1.1) + builder (3.2.4) + concurrent-ruby (1.2.2) + crass (1.0.6) + date (3.3.3) + debug (1.8.0) + irb (>= 1.5.0) + reline (>= 0.3.1) + dotenv (2.8.1) + dotenv-rails (2.8.1) + dotenv (= 2.8.1) + railties (>= 3.2) + erubi (1.12.0) + globalid (1.2.0) + activesupport (>= 6.1) + i18n (1.14.1) + concurrent-ruby (~> 1.0) + io-console (0.6.0) + irb (1.8.0) + rdoc (~> 6.5) + reline (>= 0.3.6) + json (2.6.3) + language_server-protocol (3.17.0.3) + lint_roller (1.1.0) + loofah (2.21.3) + crass (~> 1.0.2) + nokogiri (>= 1.12.0) + mail (2.8.1) + mini_mime (>= 0.1.1) + net-imap + net-pop + net-smtp + marcel (1.0.2) + method_source (1.0.0) + mini_mime (1.1.5) + minitest (5.19.0) + net-imap (0.3.7) + date + net-protocol + net-pop (0.1.2) + net-protocol + net-protocol (0.2.1) + timeout + net-smtp (0.3.3) + net-protocol + nio4r (2.5.9) + nokogiri (1.15.4-x86_64-linux) + racc (~> 1.4) + parallel (1.23.0) + parser (3.2.2.3) + ast (~> 2.4.1) + racc + pg (1.5.4) + psych (5.1.0) + stringio + puma (6.3.1) + nio4r (~> 2.0) + racc (1.7.1) + rack (2.2.8) + rack-test (2.1.0) + rack (>= 1.3) + rails (7.0.7.2) + actioncable (= 7.0.7.2) + actionmailbox (= 7.0.7.2) + actionmailer (= 7.0.7.2) + actionpack (= 7.0.7.2) + actiontext (= 7.0.7.2) + actionview (= 7.0.7.2) + activejob (= 7.0.7.2) + activemodel (= 7.0.7.2) + activerecord (= 7.0.7.2) + activestorage (= 7.0.7.2) + activesupport (= 7.0.7.2) + bundler (>= 1.15.0) + railties (= 7.0.7.2) + rails-dom-testing (2.2.0) + activesupport (>= 5.0.0) + minitest + nokogiri (>= 1.6) + rails-html-sanitizer (1.6.0) + loofah (~> 2.21) + nokogiri (~> 1.14) + railties (7.0.7.2) + actionpack (= 7.0.7.2) + activesupport (= 7.0.7.2) + method_source + rake (>= 12.2) + thor (~> 1.0) + zeitwerk (~> 2.5) + rainbow (3.1.1) + rake (13.0.6) + rdoc (6.5.0) + psych (>= 4.0.0) + regexp_parser (2.8.1) + reline (0.3.8) + io-console (~> 0.5) + rexml (3.2.6) + rubocop (1.56.2) + base64 (~> 0.1.1) + json (~> 2.3) + language_server-protocol (>= 3.17.0) + parallel (~> 1.10) + parser (>= 3.2.2.3) + rainbow (>= 2.2.2, < 4.0) + regexp_parser (>= 1.8, < 3.0) + rexml (>= 3.2.5, < 4.0) + rubocop-ast (>= 1.28.1, < 2.0) + ruby-progressbar (~> 1.7) + unicode-display_width (>= 2.4.0, < 3.0) + rubocop-ast (1.29.0) + parser (>= 3.2.1.0) + rubocop-performance (1.19.0) + rubocop (>= 1.7.0, < 2.0) + rubocop-ast (>= 0.4.0) + ruby-progressbar (1.13.0) + sprockets (4.2.0) + concurrent-ruby (~> 1.0) + rack (>= 2.2.4, < 4) + sprockets-rails (3.4.2) + actionpack (>= 5.2) + activesupport (>= 5.2) + sprockets (>= 3.0.0) + standard (1.31.0) + language_server-protocol (~> 3.17.0.2) + lint_roller (~> 1.0) + rubocop (~> 1.56.0) + standard-custom (~> 1.0.0) + standard-performance (~> 1.2) + standard-custom (1.0.2) + lint_roller (~> 1.0) + rubocop (~> 1.50) + standard-performance (1.2.0) + lint_roller (~> 1.1) + rubocop-performance (~> 1.19.0) + stringio (3.0.8) + thor (1.2.2) + timeout (0.4.0) + tzinfo (2.0.6) + concurrent-ruby (~> 1.0) + unicode-display_width (2.4.2) + websocket-driver (0.7.6) + websocket-extensions (>= 0.1.0) + websocket-extensions (0.1.5) + zeitwerk (2.6.11) + +PLATFORMS + x86_64-linux-musl + +DEPENDENCIES + debug + dotenv-rails + landlord! + pg + puma + sprockets-rails + standard + +BUNDLED WITH + 2.4.10 diff --git a/MIT-LICENSE b/MIT-LICENSE new file mode 100644 index 0000000..d810828 --- /dev/null +++ b/MIT-LICENSE @@ -0,0 +1,20 @@ +Copyright 2023 + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md index 528bc33..02e1393 100644 --- a/README.md +++ b/README.md @@ -1,47 +1,41 @@ -# Landlord Gem +# Landlord Landlord is a dynamic and hybrid multitenancy solution for Rails 6.0 and PostgreSQL. It allows you to manage multiple tenants within a single Rails application, simplifying the process of developing and maintaining applications with complex multitenant requirements. ## Installation -Add this line to your application's Gemfile: +Add this line to your application's `Gemfile`: ```ruby -gem 'landlord', '~> 0.1.0' +gem "landlord" ``` And then execute: ```bash -bundle install +$ bundle +``` + +Or install it yourself as: + +```bash +$ gem install landlord ``` After that, run the generator to create the necessary migrations and models: ```bash -rails generate landlord:install +$ rails generate landlord:install ``` Finally, run the migrations: ```bash -rails db:migrate +$ rails db:migrate ``` ## Usage -### Configuration -Firstly, in your ApplicationRecord model add the fetch_db_connections method call, and extend DbConnectionsFetcher: - -```ruby -class ApplicationRecord < ActiveRecord::Base - self.abstract_class = true - extend DbConnectionsFetcher - - fetch_db_connections -end -``` - ### Database Configuration Enable sharding. @@ -57,7 +51,7 @@ TODO: Add migrations of tenants ### Switching Tenants -The Landlord gem provides you with easy methods to switch tenants in your application. The Landlord module contains methods like switch_to_main and switch_to that take a block of code to execute in the context of a specific tenant: +Landlord provides you with easy methods to switch tenants in your application. The Landlord module contains methods like `switch_to_main` and `switch_to` that take a block of code to execute in the context of a specific tenant: ```ruby Landlord.switch_to(tenant) do @@ -65,12 +59,10 @@ Landlord.switch_to(tenant) do end ``` -## Development +## Contributing -During development, if you need to switch tenants permanently for easier debugging in the terminal, use the switch! methods. These are only available in development or test environments: +Contribution directions go here. -```ruby -Landlord.switch!(connection_configuration) -Landlord.switch_to_main! -Landlord.switch_to!(tenant) -``` \ No newline at end of file +## License + +The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). diff --git a/Rakefile b/Rakefile index 12e5882..e7793b5 100644 --- a/Rakefile +++ b/Rakefile @@ -1,6 +1,8 @@ -# frozen_string_literal: true +require "bundler/setup" -require "bundler/gem_tasks" -require "standard/rake" +APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__) +load "rails/tasks/engine.rake" + +load "rails/tasks/statistics.rake" -task default: :standard +require "bundler/gem_tasks" diff --git a/bin/console b/bin/console deleted file mode 100755 index 0e80597..0000000 --- a/bin/console +++ /dev/null @@ -1,15 +0,0 @@ -#!/usr/bin/env ruby -# frozen_string_literal: true - -require "bundler/setup" -require "landlord" - -# You can add fixtures and/or initialization code here to make experimenting -# with your gem easier. You can also use a different console, if you like. - -# (If you use this, don't forget to add pry to your Gemfile!) -# require "pry" -# Pry.start - -require "irb" -IRB.start(__FILE__) diff --git a/bin/entrypoint.sh b/bin/entrypoint.sh new file mode 100644 index 0000000..0a70d86 --- /dev/null +++ b/bin/entrypoint.sh @@ -0,0 +1,7 @@ +#!/bin/sh + +set -e + +rm -f /app/tmp/pids/server.pid + +exec "$@" diff --git a/bin/rails b/bin/rails new file mode 100755 index 0000000..37fcf43 --- /dev/null +++ b/bin/rails @@ -0,0 +1,14 @@ +#!/usr/bin/env ruby +# This command will automatically be run when you run "rails" with Rails gems +# installed from the root of your application. + +ENGINE_ROOT = File.expand_path("..", __dir__) +ENGINE_PATH = File.expand_path("../lib/landlord/engine", __dir__) +APP_PATH = File.expand_path("../test/dummy/config/application", __dir__) + +# Set up gems listed in the Gemfile. +ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__) +require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"]) + +require "rails/all" +require "rails/engine/commands" diff --git a/bin/setup b/bin/setup deleted file mode 100755 index dce67d8..0000000 --- a/bin/setup +++ /dev/null @@ -1,8 +0,0 @@ -#!/usr/bin/env bash -set -euo pipefail -IFS=$'\n\t' -set -vx - -bundle install - -# Do any other automated setup that you need to do here diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..e434444 --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,38 @@ +version: "3" + +services: + # css: + # command: yarn build:css --watch + # image: devstuff_web + # tty: true + # volumes: + # - .:/app + db: + environment: + - POSTGRES_PASSWORD=password + image: postgres:13 + volumes: + - postgresql-data:/var/lib/postgresql/data + # js: + # command: yarn build --watch + # image: devstuff_web + # tty: true + # volumes: + # - .:/app + web: + build: . + depends_on: + - db + environment: + - BUNDLE_PATH=/bundle/vendor + ports: + - 3000:3000 + volumes: + - bundler-data:/bundle + - .:/app + stdin_open: true + tty: true + +volumes: + bundler-data: + postgresql-data: diff --git a/landlord.gemspec b/landlord.gemspec index 06c8156..4d8d811 100644 --- a/landlord.gemspec +++ b/landlord.gemspec @@ -1,37 +1,26 @@ require_relative "lib/landlord/version" Gem::Specification.new do |spec| - spec.name = "landlord" - spec.version = Landlord::VERSION + spec.name = "landlord" + spec.version = Landlord::VERSION spec.authors = ["Nazareno Moresco"] - spec.email = "nazareno.moresco@sinaptia.dev" + spec.email = ["nazareno.moresco@sinaptia.dev"] + spec.homepage = "https://github.com/sinaptia/landlord" spec.summary = "A dynamic and hybrid multitenancy solution for Rails > 6.0 & PostgresSQL" spec.description = "A dynamic and hybrid multitenancy solution for Rails > 6.0 & PostgresSQL" - spec.homepage = "https://rubygems.org/gems/landlord" - spec.required_ruby_version = ">= 2.6.0" + spec.license = "MIT" - spec.license = "MIT" - - spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'" + # Prevent pushing this gem to RubyGems.org. To allow pushes either set the "allowed_push_host" + # to allow pushing to a single host or delete this section to allow pushing to any host. + # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'" spec.metadata["homepage_uri"] = spec.homepage - spec.metadata["source_code_uri"] = "https://github.com/sinaptia/landlord" + spec.metadata["source_code_uri"] = spec.homepage + # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here." - # Specify which files should be added to the gem when it is released. - # The `git ls-files -z` loads the files in the RubyGem that have been added into git. - spec.files = Dir.chdir(__dir__) do - `git ls-files -z`.split("\x0").reject do |f| - (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor]) - end + spec.files = Dir.chdir(File.expand_path(__dir__)) do + Dir["{app,config,db,lib}/**/*", "MIT-LICENSE", "Rakefile", "README.md"] end - spec.bindir = "exe" - spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) } - spec.require_paths = ["lib"] - - # Uncomment to register a new dependency of your gem - # spec.add_dependency "example-gem", "~> 1.0" - spec.add_dependency 'rails', '>= 6.0' - # For more information and examples about making a new gem, check out our - # guide at: https://bundler.io/guides/creating_gem.html + spec.add_dependency "rails", ">= 6.0" end diff --git a/lib/landlord.rb b/lib/landlord.rb index 86fd9f6..464c26c 100644 --- a/lib/landlord.rb +++ b/lib/landlord.rb @@ -1,6 +1,7 @@ require "landlord/concern" require "landlord/engine" require "landlord/schema_name_generator" +require "landlord/version" module Landlord # Returns the connection configuration of the main connection @@ -36,7 +37,7 @@ def self.switch_to_main(&blk) end end - # Switchs to the tenant tenant connection + # Switches to the tenant tenant connection # More user friendly option for switching tenants # It will only establish a new connection if the given connection is not the current connection def self.switch_to(tenant, &blk) diff --git a/lib/landlord/engine.rb b/lib/landlord/engine.rb index 4f62971..4f1ba57 100644 --- a/lib/landlord/engine.rb +++ b/lib/landlord/engine.rb @@ -1,7 +1,7 @@ module Landlord - class Engine < Rails::Engine + class Engine < ::Rails::Engine rake_tasks do - load File.join(__dir__, "tasks/landlord.rake") + load File.join(__dir__, "../tasks/landlord_tasks.rake") end end end diff --git a/lib/landlord/tasks/landlord.rake b/lib/tasks/landlord_tasks.rake similarity index 52% rename from lib/landlord/tasks/landlord.rake rename to lib/tasks/landlord_tasks.rake index 9b77019..0fa497e 100644 --- a/lib/landlord/tasks/landlord.rake +++ b/lib/tasks/landlord_tasks.rake @@ -7,54 +7,56 @@ namespace :db do ActiveRecord::Tasks::DatabaseTasks.dump_schema(db_config, :ruby) end - task tenant_migrate: :load_config do - original_db_config = ActiveRecord::Base.connection_db_config - ask_again = true - TenantConnection.order(:id).all.map(&:config).each_with_index do |db_config, index| - puts "Migrating #{db_config[:schema_search_path]}... " - - # Check in the case tenancy_connection were not localized - ask_again = check_env_matching_db_configuration!(original_db_config, db_config) if ask_again - - # Migrate - ActiveRecord::Base.establish_connection(db_config) - ActiveRecord::Tasks::DatabaseTasks.migrate - - # Use first tenancy_connection for the schema dump - next unless index.zero? - db_config[:name] = "tenants" - ActiveRecord::Tasks::DatabaseTasks.dump_schema(ActiveRecord::DatabaseConfigurations::HashConfig.new(Rails.env, "primary", db_config), :ruby) + namespace :tenants do + task migrate: :load_config do + original_db_config = ActiveRecord::Base.connection_db_config + ask_again = true + TenantConnection.order(:id).all.map(&:config).each_with_index do |db_config, index| + puts "Migrating #{db_config[:schema_search_path]}... " + + # Check in the case tenancy_connection were not localized + ask_again = check_env_matching_db_configuration!(original_db_config, db_config) if ask_again + + # Migrate + ActiveRecord::Base.establish_connection(db_config) + ActiveRecord::Tasks::DatabaseTasks.migrate + + # Use first tenancy_connection for the schema dump + next unless index.zero? + db_config[:name] = "tenants" + ActiveRecord::Tasks::DatabaseTasks.dump_schema(ActiveRecord::DatabaseConfigurations::HashConfig.new(Rails.env, "primary", db_config), :ruby) + end + ensure + ActiveRecord::Base.establish_connection(original_db_config) end - ensure - ActiveRecord::Base.establish_connection(original_db_config) - end - - task tenant_rollback: :load_config do - original_db_config = ActiveRecord::Base.connection_db_config - ask_again = true - TenantConnection.all.map(&:config).each_with_index do |db_config, index| - puts "Rollbacking #{db_config[:schema_search_path]}... " - - # Check in the case tenancy_connection were not localized - ask_again = check_env_matching_db_configuration!(original_db_config, db_config) if ask_again - - # Migrate - ActiveRecord::Base.establish_connection(db_config) - ActiveRecord::Base.connection.migration_context.rollback(1) - # Use first tenancy_connection for the schema dump - next unless index.zero? - db_config[:name] = "tenants" - ActiveRecord::Tasks::DatabaseTasks.dump_schema(OpenStruct.new(db_config), :ruby) + task rollback: :load_config do + original_db_config = ActiveRecord::Base.connection_db_config + ask_again = true + TenantConnection.all.map(&:config).each_with_index do |db_config, index| + puts "Rollbacking #{db_config[:schema_search_path]}... " + + # Check in the case tenancy_connection were not localized + ask_again = check_env_matching_db_configuration!(original_db_config, db_config) if ask_again + + # Migrate + ActiveRecord::Base.establish_connection(db_config) + ActiveRecord::Base.connection.migration_context.rollback(1) + + # Use first tenancy_connection for the schema dump + next unless index.zero? + db_config[:name] = "tenants" + ActiveRecord::Tasks::DatabaseTasks.dump_schema(OpenStruct.new(db_config), :ruby) + end + ensure + ActiveRecord::Base.establish_connection(original_db_config) end - ensure - ActiveRecord::Base.establish_connection(original_db_config) end end # Invoke these tasks after the migration Rake::Task["db:migrate"].enhance do - Rake::Task["db:tenant_migrate"].invoke + Rake::Task["db:tenants:migrate"].invoke Rake::Task["db:ruby_public_dump"].invoke end diff --git a/test/dummy/.env.sample b/test/dummy/.env.sample new file mode 100644 index 0000000..03cf39b --- /dev/null +++ b/test/dummy/.env.sample @@ -0,0 +1 @@ +DATABASE_URL=postgresql://postgres:password@db/app_development diff --git a/test/dummy/Rakefile b/test/dummy/Rakefile new file mode 100644 index 0000000..9a5ea73 --- /dev/null +++ b/test/dummy/Rakefile @@ -0,0 +1,6 @@ +# Add your own tasks in files placed in lib/tasks ending in .rake, +# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake. + +require_relative "config/application" + +Rails.application.load_tasks diff --git a/test/dummy/app/assets/config/manifest.js b/test/dummy/app/assets/config/manifest.js new file mode 100644 index 0000000..5918193 --- /dev/null +++ b/test/dummy/app/assets/config/manifest.js @@ -0,0 +1,2 @@ +//= link_tree ../images +//= link_directory ../stylesheets .css diff --git a/test/dummy/app/assets/images/.keep b/test/dummy/app/assets/images/.keep new file mode 100644 index 0000000..e69de29 diff --git a/test/dummy/app/assets/stylesheets/application.css b/test/dummy/app/assets/stylesheets/application.css new file mode 100644 index 0000000..0ebd7fe --- /dev/null +++ b/test/dummy/app/assets/stylesheets/application.css @@ -0,0 +1,15 @@ +/* + * This is a manifest file that'll be compiled into application.css, which will include all the files + * listed below. + * + * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets, + * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path. + * + * You're free to add application-wide styles to this file and they'll appear at the bottom of the + * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS + * files in this directory. Styles in this file should be added after the last require_* statement. + * It is generally better to create a new file per style scope. + * + *= require_tree . + *= require_self + */ diff --git a/test/dummy/app/channels/application_cable/channel.rb b/test/dummy/app/channels/application_cable/channel.rb new file mode 100644 index 0000000..d672697 --- /dev/null +++ b/test/dummy/app/channels/application_cable/channel.rb @@ -0,0 +1,4 @@ +module ApplicationCable + class Channel < ActionCable::Channel::Base + end +end diff --git a/test/dummy/app/channels/application_cable/connection.rb b/test/dummy/app/channels/application_cable/connection.rb new file mode 100644 index 0000000..0ff5442 --- /dev/null +++ b/test/dummy/app/channels/application_cable/connection.rb @@ -0,0 +1,4 @@ +module ApplicationCable + class Connection < ActionCable::Connection::Base + end +end diff --git a/test/dummy/app/controllers/application_controller.rb b/test/dummy/app/controllers/application_controller.rb new file mode 100644 index 0000000..09705d1 --- /dev/null +++ b/test/dummy/app/controllers/application_controller.rb @@ -0,0 +1,2 @@ +class ApplicationController < ActionController::Base +end diff --git a/test/dummy/app/controllers/concerns/.keep b/test/dummy/app/controllers/concerns/.keep new file mode 100644 index 0000000..e69de29 diff --git a/test/dummy/app/helpers/application_helper.rb b/test/dummy/app/helpers/application_helper.rb new file mode 100644 index 0000000..de6be79 --- /dev/null +++ b/test/dummy/app/helpers/application_helper.rb @@ -0,0 +1,2 @@ +module ApplicationHelper +end diff --git a/test/dummy/app/jobs/application_job.rb b/test/dummy/app/jobs/application_job.rb new file mode 100644 index 0000000..d394c3d --- /dev/null +++ b/test/dummy/app/jobs/application_job.rb @@ -0,0 +1,7 @@ +class ApplicationJob < ActiveJob::Base + # Automatically retry jobs that encountered a deadlock + # retry_on ActiveRecord::Deadlocked + + # Most jobs are safe to ignore if the underlying records are no longer available + # discard_on ActiveJob::DeserializationError +end diff --git a/test/dummy/app/mailers/application_mailer.rb b/test/dummy/app/mailers/application_mailer.rb new file mode 100644 index 0000000..3c34c81 --- /dev/null +++ b/test/dummy/app/mailers/application_mailer.rb @@ -0,0 +1,4 @@ +class ApplicationMailer < ActionMailer::Base + default from: "from@example.com" + layout "mailer" +end diff --git a/test/dummy/app/models/application_record.rb b/test/dummy/app/models/application_record.rb new file mode 100644 index 0000000..b63caeb --- /dev/null +++ b/test/dummy/app/models/application_record.rb @@ -0,0 +1,3 @@ +class ApplicationRecord < ActiveRecord::Base + primary_abstract_class +end diff --git a/test/dummy/app/models/concerns/.keep b/test/dummy/app/models/concerns/.keep new file mode 100644 index 0000000..e69de29 diff --git a/test/dummy/app/views/layouts/application.html.erb b/test/dummy/app/views/layouts/application.html.erb new file mode 100644 index 0000000..f72b4ef --- /dev/null +++ b/test/dummy/app/views/layouts/application.html.erb @@ -0,0 +1,15 @@ + + + + Dummy + + <%= csrf_meta_tags %> + <%= csp_meta_tag %> + + <%= stylesheet_link_tag "application" %> + + + + <%= yield %> + + diff --git a/test/dummy/app/views/layouts/mailer.html.erb b/test/dummy/app/views/layouts/mailer.html.erb new file mode 100644 index 0000000..cbd34d2 --- /dev/null +++ b/test/dummy/app/views/layouts/mailer.html.erb @@ -0,0 +1,13 @@ + + + + + + + + + <%= yield %> + + diff --git a/test/dummy/app/views/layouts/mailer.text.erb b/test/dummy/app/views/layouts/mailer.text.erb new file mode 100644 index 0000000..37f0bdd --- /dev/null +++ b/test/dummy/app/views/layouts/mailer.text.erb @@ -0,0 +1 @@ +<%= yield %> diff --git a/test/dummy/bin/rails b/test/dummy/bin/rails new file mode 100755 index 0000000..efc0377 --- /dev/null +++ b/test/dummy/bin/rails @@ -0,0 +1,4 @@ +#!/usr/bin/env ruby +APP_PATH = File.expand_path("../config/application", __dir__) +require_relative "../config/boot" +require "rails/commands" diff --git a/test/dummy/bin/rake b/test/dummy/bin/rake new file mode 100755 index 0000000..4fbf10b --- /dev/null +++ b/test/dummy/bin/rake @@ -0,0 +1,4 @@ +#!/usr/bin/env ruby +require_relative "../config/boot" +require "rake" +Rake.application.run diff --git a/test/dummy/bin/setup b/test/dummy/bin/setup new file mode 100755 index 0000000..ec47b79 --- /dev/null +++ b/test/dummy/bin/setup @@ -0,0 +1,33 @@ +#!/usr/bin/env ruby +require "fileutils" + +# path to your application root. +APP_ROOT = File.expand_path("..", __dir__) + +def system!(*args) + system(*args) || abort("\n== Command #{args} failed ==") +end + +FileUtils.chdir APP_ROOT do + # This script is a way to set up or update your development environment automatically. + # This script is idempotent, so that you can run it at any time and get an expectable outcome. + # Add necessary setup steps to this file. + + puts "== Installing dependencies ==" + system! "gem install bundler --conservative" + system("bundle check") || system!("bundle install") + + # puts "\n== Copying sample files ==" + # unless File.exist?("config/database.yml") + # FileUtils.cp "config/database.yml.sample", "config/database.yml" + # end + + puts "\n== Preparing database ==" + system! "bin/rails db:prepare" + + puts "\n== Removing old logs and tempfiles ==" + system! "bin/rails log:clear tmp:clear" + + puts "\n== Restarting application server ==" + system! "bin/rails restart" +end diff --git a/test/dummy/config.ru b/test/dummy/config.ru new file mode 100644 index 0000000..4a3c09a --- /dev/null +++ b/test/dummy/config.ru @@ -0,0 +1,6 @@ +# This file is used by Rack-based servers to start the application. + +require_relative "config/environment" + +run Rails.application +Rails.application.load_server diff --git a/test/dummy/config/application.rb b/test/dummy/config/application.rb new file mode 100644 index 0000000..892aac0 --- /dev/null +++ b/test/dummy/config/application.rb @@ -0,0 +1,25 @@ +require_relative "boot" + +require "rails/all" + +# Require the gems listed in Gemfile, including any gems +# you've limited to :test, :development, or :production. +Bundler.require(*Rails.groups) +require "landlord" + +module Dummy + class Application < Rails::Application + config.load_defaults Rails::VERSION::STRING.to_f + + # For compatibility with applications that use this config + config.action_controller.include_all_helpers = false + + # Configuration for the application, engines, and railties goes here. + # + # These settings can be overridden in specific environments using the files + # in config/environments, which are processed later. + # + # config.time_zone = "Central Time (US & Canada)" + # config.eager_load_paths << Rails.root.join("extras") + end +end diff --git a/test/dummy/config/boot.rb b/test/dummy/config/boot.rb new file mode 100644 index 0000000..116591a --- /dev/null +++ b/test/dummy/config/boot.rb @@ -0,0 +1,5 @@ +# Set up gems listed in the Gemfile. +ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../../Gemfile", __dir__) + +require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"]) +$LOAD_PATH.unshift File.expand_path("../../../lib", __dir__) diff --git a/test/dummy/config/cable.yml b/test/dummy/config/cable.yml new file mode 100644 index 0000000..98367f8 --- /dev/null +++ b/test/dummy/config/cable.yml @@ -0,0 +1,10 @@ +development: + adapter: async + +test: + adapter: test + +production: + adapter: redis + url: <%= ENV.fetch("REDIS_URL") { "redis://localhost:6379/1" } %> + channel_prefix: dummy_production diff --git a/test/dummy/config/database.yml b/test/dummy/config/database.yml new file mode 100644 index 0000000..fcba57f --- /dev/null +++ b/test/dummy/config/database.yml @@ -0,0 +1,25 @@ +# SQLite. Versions 3.8.0 and up are supported. +# gem install sqlite3 +# +# Ensure the SQLite 3 gem is defined in your Gemfile +# gem "sqlite3" +# +default: &default + adapter: sqlite3 + pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %> + timeout: 5000 + +development: + <<: *default + database: db/development.sqlite3 + +# Warning: The database defined as "test" will be erased and +# re-generated from your development database when you run "rake". +# Do not set this db to the same as development or production. +test: + <<: *default + database: db/test.sqlite3 + +production: + <<: *default + database: db/production.sqlite3 diff --git a/test/dummy/config/environment.rb b/test/dummy/config/environment.rb new file mode 100644 index 0000000..cac5315 --- /dev/null +++ b/test/dummy/config/environment.rb @@ -0,0 +1,5 @@ +# Load the Rails application. +require_relative "application" + +# Initialize the Rails application. +Rails.application.initialize! diff --git a/test/dummy/config/environments/development.rb b/test/dummy/config/environments/development.rb new file mode 100644 index 0000000..8500f45 --- /dev/null +++ b/test/dummy/config/environments/development.rb @@ -0,0 +1,70 @@ +require "active_support/core_ext/integer/time" + +Rails.application.configure do + # Settings specified here will take precedence over those in config/application.rb. + + # In the development environment your application's code is reloaded any time + # it changes. This slows down response time but is perfect for development + # since you don't have to restart the web server when you make code changes. + config.cache_classes = false + + # Do not eager load code on boot. + config.eager_load = false + + # Show full error reports. + config.consider_all_requests_local = true + + # Enable server timing + config.server_timing = true + + # Enable/disable caching. By default caching is disabled. + # Run rails dev:cache to toggle caching. + if Rails.root.join("tmp/caching-dev.txt").exist? + config.action_controller.perform_caching = true + config.action_controller.enable_fragment_cache_logging = true + + config.cache_store = :memory_store + config.public_file_server.headers = { + "Cache-Control" => "public, max-age=#{2.days.to_i}" + } + else + config.action_controller.perform_caching = false + + config.cache_store = :null_store + end + + # Store uploaded files on the local file system (see config/storage.yml for options). + config.active_storage.service = :local + + # Don't care if the mailer can't send. + config.action_mailer.raise_delivery_errors = false + + config.action_mailer.perform_caching = false + + # Print deprecation notices to the Rails logger. + config.active_support.deprecation = :log + + # Raise exceptions for disallowed deprecations. + config.active_support.disallowed_deprecation = :raise + + # Tell Active Support which deprecation messages to disallow. + config.active_support.disallowed_deprecation_warnings = [] + + # Raise an error on page load if there are pending migrations. + config.active_record.migration_error = :page_load + + # Highlight code that triggered database queries in logs. + config.active_record.verbose_query_logs = true + + # Suppress logger output for asset requests. + config.assets.quiet = true + + # Raises error for missing translations. + # config.i18n.raise_on_missing_translations = true + + # Annotate rendered view with file names. + # config.action_view.annotate_rendered_view_with_filenames = true + + # Uncomment if you wish to allow Action Cable access from any origin. + # config.action_cable.disable_request_forgery_protection = true +end diff --git a/test/dummy/config/environments/production.rb b/test/dummy/config/environments/production.rb new file mode 100644 index 0000000..8e989b5 --- /dev/null +++ b/test/dummy/config/environments/production.rb @@ -0,0 +1,93 @@ +require "active_support/core_ext/integer/time" + +Rails.application.configure do + # Settings specified here will take precedence over those in config/application.rb. + + # Code is not reloaded between requests. + config.cache_classes = true + + # Eager load code on boot. This eager loads most of Rails and + # your application in memory, allowing both threaded web servers + # and those relying on copy on write to perform better. + # Rake tasks automatically ignore this option for performance. + config.eager_load = true + + # Full error reports are disabled and caching is turned on. + config.consider_all_requests_local = false + config.action_controller.perform_caching = true + + # Ensures that a master key has been made available in either ENV["RAILS_MASTER_KEY"] + # or in config/master.key. This key is used to decrypt credentials (and other encrypted files). + # config.require_master_key = true + + # Disable serving static files from the `/public` folder by default since + # Apache or NGINX already handles this. + config.public_file_server.enabled = ENV["RAILS_SERVE_STATIC_FILES"].present? + + # Compress CSS using a preprocessor. + # config.assets.css_compressor = :sass + + # Do not fallback to assets pipeline if a precompiled asset is missed. + config.assets.compile = false + + # Enable serving of images, stylesheets, and JavaScripts from an asset server. + # config.asset_host = "http://assets.example.com" + + # Specifies the header that your server uses for sending files. + # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for Apache + # config.action_dispatch.x_sendfile_header = "X-Accel-Redirect" # for NGINX + + # Store uploaded files on the local file system (see config/storage.yml for options). + config.active_storage.service = :local + + # Mount Action Cable outside main process or domain. + # config.action_cable.mount_path = nil + # config.action_cable.url = "wss://example.com/cable" + # config.action_cable.allowed_request_origins = [ "http://example.com", /http:\/\/example.*/ ] + + # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies. + # config.force_ssl = true + + # Include generic and useful information about system operation, but avoid logging too much + # information to avoid inadvertent exposure of personally identifiable information (PII). + config.log_level = :info + + # Prepend all log lines with the following tags. + config.log_tags = [ :request_id ] + + # Use a different cache store in production. + # config.cache_store = :mem_cache_store + + # Use a real queuing backend for Active Job (and separate queues per environment). + # config.active_job.queue_adapter = :resque + # config.active_job.queue_name_prefix = "dummy_production" + + config.action_mailer.perform_caching = false + + # Ignore bad email addresses and do not raise email delivery errors. + # Set this to true and configure the email server for immediate delivery to raise delivery errors. + # config.action_mailer.raise_delivery_errors = false + + # Enable locale fallbacks for I18n (makes lookups for any locale fall back to + # the I18n.default_locale when a translation cannot be found). + config.i18n.fallbacks = true + + # Don't log any deprecations. + config.active_support.report_deprecations = false + + # Use default logging formatter so that PID and timestamp are not suppressed. + config.log_formatter = ::Logger::Formatter.new + + # Use a different logger for distributed setups. + # require "syslog/logger" + # config.logger = ActiveSupport::TaggedLogging.new(Syslog::Logger.new "app-name") + + if ENV["RAILS_LOG_TO_STDOUT"].present? + logger = ActiveSupport::Logger.new(STDOUT) + logger.formatter = config.log_formatter + config.logger = ActiveSupport::TaggedLogging.new(logger) + end + + # Do not dump schema after migrations. + config.active_record.dump_schema_after_migration = false +end diff --git a/test/dummy/config/environments/test.rb b/test/dummy/config/environments/test.rb new file mode 100644 index 0000000..6ea4d1e --- /dev/null +++ b/test/dummy/config/environments/test.rb @@ -0,0 +1,60 @@ +require "active_support/core_ext/integer/time" + +# The test environment is used exclusively to run your application's +# test suite. You never need to work with it otherwise. Remember that +# your test database is "scratch space" for the test suite and is wiped +# and recreated between test runs. Don't rely on the data there! + +Rails.application.configure do + # Settings specified here will take precedence over those in config/application.rb. + + # Turn false under Spring and add config.action_view.cache_template_loading = true. + config.cache_classes = true + + # Eager loading loads your whole application. When running a single test locally, + # this probably isn't necessary. It's a good idea to do in a continuous integration + # system, or in some way before deploying your code. + config.eager_load = ENV["CI"].present? + + # Configure public file server for tests with Cache-Control for performance. + config.public_file_server.enabled = true + config.public_file_server.headers = { + "Cache-Control" => "public, max-age=#{1.hour.to_i}" + } + + # Show full error reports and disable caching. + config.consider_all_requests_local = true + config.action_controller.perform_caching = false + config.cache_store = :null_store + + # Raise exceptions instead of rendering exception templates. + config.action_dispatch.show_exceptions = false + + # Disable request forgery protection in test environment. + config.action_controller.allow_forgery_protection = false + + # Store uploaded files on the local file system in a temporary directory. + config.active_storage.service = :test + + config.action_mailer.perform_caching = false + + # Tell Action Mailer not to deliver emails to the real world. + # The :test delivery method accumulates sent emails in the + # ActionMailer::Base.deliveries array. + config.action_mailer.delivery_method = :test + + # Print deprecation notices to the stderr. + config.active_support.deprecation = :stderr + + # Raise exceptions for disallowed deprecations. + config.active_support.disallowed_deprecation = :raise + + # Tell Active Support which deprecation messages to disallow. + config.active_support.disallowed_deprecation_warnings = [] + + # Raises error for missing translations. + # config.i18n.raise_on_missing_translations = true + + # Annotate rendered view with file names. + # config.action_view.annotate_rendered_view_with_filenames = true +end diff --git a/test/dummy/config/initializers/assets.rb b/test/dummy/config/initializers/assets.rb new file mode 100644 index 0000000..2eeef96 --- /dev/null +++ b/test/dummy/config/initializers/assets.rb @@ -0,0 +1,12 @@ +# Be sure to restart your server when you modify this file. + +# Version of your assets, change this if you want to expire all your assets. +Rails.application.config.assets.version = "1.0" + +# Add additional assets to the asset load path. +# Rails.application.config.assets.paths << Emoji.images_path + +# Precompile additional assets. +# application.js, application.css, and all non-JS/CSS in the app/assets +# folder are already added. +# Rails.application.config.assets.precompile += %w( admin.js admin.css ) diff --git a/test/dummy/config/initializers/content_security_policy.rb b/test/dummy/config/initializers/content_security_policy.rb new file mode 100644 index 0000000..54f47cf --- /dev/null +++ b/test/dummy/config/initializers/content_security_policy.rb @@ -0,0 +1,25 @@ +# Be sure to restart your server when you modify this file. + +# Define an application-wide content security policy. +# See the Securing Rails Applications Guide for more information: +# https://guides.rubyonrails.org/security.html#content-security-policy-header + +# Rails.application.configure do +# config.content_security_policy do |policy| +# policy.default_src :self, :https +# policy.font_src :self, :https, :data +# policy.img_src :self, :https, :data +# policy.object_src :none +# policy.script_src :self, :https +# policy.style_src :self, :https +# # Specify URI for violation reports +# # policy.report_uri "/csp-violation-report-endpoint" +# end +# +# # Generate session nonces for permitted importmap and inline scripts +# config.content_security_policy_nonce_generator = ->(request) { request.session.id.to_s } +# config.content_security_policy_nonce_directives = %w(script-src) +# +# # Report violations without enforcing the policy. +# # config.content_security_policy_report_only = true +# end diff --git a/test/dummy/config/initializers/filter_parameter_logging.rb b/test/dummy/config/initializers/filter_parameter_logging.rb new file mode 100644 index 0000000..adc6568 --- /dev/null +++ b/test/dummy/config/initializers/filter_parameter_logging.rb @@ -0,0 +1,8 @@ +# Be sure to restart your server when you modify this file. + +# Configure parameters to be filtered from the log file. Use this to limit dissemination of +# sensitive information. See the ActiveSupport::ParameterFilter documentation for supported +# notations and behaviors. +Rails.application.config.filter_parameters += [ + :passw, :secret, :token, :_key, :crypt, :salt, :certificate, :otp, :ssn +] diff --git a/test/dummy/config/initializers/inflections.rb b/test/dummy/config/initializers/inflections.rb new file mode 100644 index 0000000..3860f65 --- /dev/null +++ b/test/dummy/config/initializers/inflections.rb @@ -0,0 +1,16 @@ +# Be sure to restart your server when you modify this file. + +# Add new inflection rules using the following format. Inflections +# are locale specific, and you may define rules for as many different +# locales as you wish. All of these examples are active by default: +# ActiveSupport::Inflector.inflections(:en) do |inflect| +# inflect.plural /^(ox)$/i, "\\1en" +# inflect.singular /^(ox)en/i, "\\1" +# inflect.irregular "person", "people" +# inflect.uncountable %w( fish sheep ) +# end + +# These inflection rules are supported but not enabled by default: +# ActiveSupport::Inflector.inflections(:en) do |inflect| +# inflect.acronym "RESTful" +# end diff --git a/test/dummy/config/initializers/permissions_policy.rb b/test/dummy/config/initializers/permissions_policy.rb new file mode 100644 index 0000000..00f64d7 --- /dev/null +++ b/test/dummy/config/initializers/permissions_policy.rb @@ -0,0 +1,11 @@ +# Define an application-wide HTTP permissions policy. For further +# information see https://developers.google.com/web/updates/2018/06/feature-policy +# +# Rails.application.config.permissions_policy do |f| +# f.camera :none +# f.gyroscope :none +# f.microphone :none +# f.usb :none +# f.fullscreen :self +# f.payment :self, "https://secure.example.com" +# end diff --git a/test/dummy/config/locales/en.yml b/test/dummy/config/locales/en.yml new file mode 100644 index 0000000..8ca56fc --- /dev/null +++ b/test/dummy/config/locales/en.yml @@ -0,0 +1,33 @@ +# Files in the config/locales directory are used for internationalization +# and are automatically loaded by Rails. If you want to use locales other +# than English, add the necessary files in this directory. +# +# To use the locales, use `I18n.t`: +# +# I18n.t "hello" +# +# In views, this is aliased to just `t`: +# +# <%= t("hello") %> +# +# To use a different locale, set it with `I18n.locale`: +# +# I18n.locale = :es +# +# This would use the information in config/locales/es.yml. +# +# The following keys must be escaped otherwise they will not be retrieved by +# the default I18n backend: +# +# true, false, on, off, yes, no +# +# Instead, surround them with single quotes. +# +# en: +# "true": "foo" +# +# To learn more, please read the Rails Internationalization guide +# available at https://guides.rubyonrails.org/i18n.html. + +en: + hello: "Hello world" diff --git a/test/dummy/config/puma.rb b/test/dummy/config/puma.rb new file mode 100644 index 0000000..daaf036 --- /dev/null +++ b/test/dummy/config/puma.rb @@ -0,0 +1,43 @@ +# Puma can serve each request in a thread from an internal thread pool. +# The `threads` method setting takes two numbers: a minimum and maximum. +# Any libraries that use thread pools should be configured to match +# the maximum value specified for Puma. Default is set to 5 threads for minimum +# and maximum; this matches the default thread size of Active Record. +# +max_threads_count = ENV.fetch("RAILS_MAX_THREADS") { 5 } +min_threads_count = ENV.fetch("RAILS_MIN_THREADS") { max_threads_count } +threads min_threads_count, max_threads_count + +# Specifies the `worker_timeout` threshold that Puma will use to wait before +# terminating a worker in development environments. +# +worker_timeout 3600 if ENV.fetch("RAILS_ENV", "development") == "development" + +# Specifies the `port` that Puma will listen on to receive requests; default is 3000. +# +port ENV.fetch("PORT") { 3000 } + +# Specifies the `environment` that Puma will run in. +# +environment ENV.fetch("RAILS_ENV") { "development" } + +# Specifies the `pidfile` that Puma will use. +pidfile ENV.fetch("PIDFILE") { "tmp/pids/server.pid" } + +# Specifies the number of `workers` to boot in clustered mode. +# Workers are forked web server processes. If using threads and workers together +# the concurrency of the application would be max `threads` * `workers`. +# Workers do not work on JRuby or Windows (both of which do not support +# processes). +# +# workers ENV.fetch("WEB_CONCURRENCY") { 2 } + +# Use the `preload_app!` method when specifying a `workers` number. +# This directive tells Puma to first boot the application and load code +# before forking the application. This takes advantage of Copy On Write +# process behavior so workers use less memory. +# +# preload_app! + +# Allow puma to be restarted by `bin/rails restart` command. +plugin :tmp_restart diff --git a/test/dummy/config/routes.rb b/test/dummy/config/routes.rb new file mode 100644 index 0000000..262ffd5 --- /dev/null +++ b/test/dummy/config/routes.rb @@ -0,0 +1,6 @@ +Rails.application.routes.draw do + # Define your application routes per the DSL in https://guides.rubyonrails.org/routing.html + + # Defines the root path route ("/") + # root "articles#index" +end diff --git a/test/dummy/config/storage.yml b/test/dummy/config/storage.yml new file mode 100644 index 0000000..4942ab6 --- /dev/null +++ b/test/dummy/config/storage.yml @@ -0,0 +1,34 @@ +test: + service: Disk + root: <%= Rails.root.join("tmp/storage") %> + +local: + service: Disk + root: <%= Rails.root.join("storage") %> + +# Use bin/rails credentials:edit to set the AWS secrets (as aws:access_key_id|secret_access_key) +# amazon: +# service: S3 +# access_key_id: <%= Rails.application.credentials.dig(:aws, :access_key_id) %> +# secret_access_key: <%= Rails.application.credentials.dig(:aws, :secret_access_key) %> +# region: us-east-1 +# bucket: your_own_bucket-<%= Rails.env %> + +# Remember not to checkin your GCS keyfile to a repository +# google: +# service: GCS +# project: your_project +# credentials: <%= Rails.root.join("path/to/gcs.keyfile") %> +# bucket: your_own_bucket-<%= Rails.env %> + +# Use bin/rails credentials:edit to set the Azure Storage secret (as azure_storage:storage_access_key) +# microsoft: +# service: AzureStorage +# storage_account_name: your_account_name +# storage_access_key: <%= Rails.application.credentials.dig(:azure_storage, :storage_access_key) %> +# container: your_container_name-<%= Rails.env %> + +# mirror: +# service: Mirror +# primary: local +# mirrors: [ amazon, google, microsoft ] diff --git a/test/dummy/lib/assets/.keep b/test/dummy/lib/assets/.keep new file mode 100644 index 0000000..e69de29 diff --git a/test/dummy/log/.keep b/test/dummy/log/.keep new file mode 100644 index 0000000..e69de29 diff --git a/test/dummy/public/404.html b/test/dummy/public/404.html new file mode 100644 index 0000000..2be3af2 --- /dev/null +++ b/test/dummy/public/404.html @@ -0,0 +1,67 @@ + + + + The page you were looking for doesn't exist (404) + + + + + + +
+
+

The page you were looking for doesn't exist.

+

You may have mistyped the address or the page may have moved.

+
+

If you are the application owner check the logs for more information.

+
+ + diff --git a/test/dummy/public/422.html b/test/dummy/public/422.html new file mode 100644 index 0000000..c08eac0 --- /dev/null +++ b/test/dummy/public/422.html @@ -0,0 +1,67 @@ + + + + The change you wanted was rejected (422) + + + + + + +
+
+

The change you wanted was rejected.

+

Maybe you tried to change something you didn't have access to.

+
+

If you are the application owner check the logs for more information.

+
+ + diff --git a/test/dummy/public/500.html b/test/dummy/public/500.html new file mode 100644 index 0000000..78a030a --- /dev/null +++ b/test/dummy/public/500.html @@ -0,0 +1,66 @@ + + + + We're sorry, but something went wrong (500) + + + + + + +
+
+

We're sorry, but something went wrong.

+
+

If you are the application owner check the logs for more information.

+
+ + diff --git a/test/dummy/public/apple-touch-icon-precomposed.png b/test/dummy/public/apple-touch-icon-precomposed.png new file mode 100644 index 0000000..e69de29 diff --git a/test/dummy/public/apple-touch-icon.png b/test/dummy/public/apple-touch-icon.png new file mode 100644 index 0000000..e69de29 diff --git a/test/dummy/public/favicon.ico b/test/dummy/public/favicon.ico new file mode 100644 index 0000000..e69de29 diff --git a/test/landlord_test.rb b/test/landlord_test.rb new file mode 100644 index 0000000..fc4916f --- /dev/null +++ b/test/landlord_test.rb @@ -0,0 +1,7 @@ +require "test_helper" + +class LandlordTest < ActiveSupport::TestCase + test "it has a version number" do + assert Landlord::VERSION + end +end diff --git a/test/models/.keep b/test/models/.keep new file mode 100644 index 0000000..e69de29 diff --git a/test/test_helper.rb b/test/test_helper.rb new file mode 100644 index 0000000..44d56a0 --- /dev/null +++ b/test/test_helper.rb @@ -0,0 +1,14 @@ +# Configure Rails Environment +ENV["RAILS_ENV"] = "test" + +require_relative "../test/dummy/config/environment" +ActiveRecord::Migrator.migrations_paths = [File.expand_path("../test/dummy/db/migrate", __dir__)] +require "rails/test_help" + +# Load fixtures from the engine +if ActiveSupport::TestCase.respond_to?(:fixture_path=) + ActiveSupport::TestCase.fixture_path = File.expand_path("fixtures", __dir__) + ActionDispatch::IntegrationTest.fixture_path = ActiveSupport::TestCase.fixture_path + ActiveSupport::TestCase.file_fixture_path = ActiveSupport::TestCase.fixture_path + "/files" + ActiveSupport::TestCase.fixtures :all +end From 7b8a34efb78791c5df0c624cde1d63ea0376a7bc Mon Sep 17 00:00:00 2001 From: Patricio Mac Adden Date: Tue, 5 Sep 2023 00:02:12 -0300 Subject: [PATCH 5/5] test app --- Dockerfile | 2 +- app/models/tenant.rb | 8 ++- app/models/tenant_connection.rb | 2 +- .../templates/create_tenant_connections.rb | 1 + lib/landlord/concern.rb | 7 +- lib/tasks/landlord_tasks.rake | 2 + .../app/controllers/people_controller.rb | 69 +++++++++++++++++++ .../app/controllers/tenants_controller.rb | 58 ++++++++++++++++ test/dummy/app/helpers/people_helper.rb | 2 + test/dummy/app/helpers/tenants_helper.rb | 2 + test/dummy/app/models/application_record.rb | 3 + test/dummy/app/models/person.rb | 4 ++ test/dummy/app/views/people/_form.html.erb | 27 ++++++++ test/dummy/app/views/people/_person.html.erb | 12 ++++ test/dummy/app/views/people/edit.html.erb | 10 +++ test/dummy/app/views/people/index.html.erb | 14 ++++ test/dummy/app/views/people/new.html.erb | 9 +++ test/dummy/app/views/people/show.html.erb | 10 +++ test/dummy/app/views/tenants/_form.html.erb | 22 ++++++ test/dummy/app/views/tenants/_tenant.html.erb | 7 ++ test/dummy/app/views/tenants/edit.html.erb | 10 +++ test/dummy/app/views/tenants/index.html.erb | 14 ++++ test/dummy/app/views/tenants/new.html.erb | 9 +++ test/dummy/app/views/tenants/show.html.erb | 14 ++++ test/dummy/config/database.yml | 35 ++++------ test/dummy/config/routes.rb | 7 +- .../migrate/20230905010414_create_tenants.rb | 9 +++ ...0230905010415_create_tenant_connections.rb | 20 ++++++ test/dummy/db/migrate_tenants/.keep | 0 .../20230905014354_create_people.rb | 11 +++ test/dummy/db/schema.rb | 42 +++++++++++ .../controllers/people_controller_test.rb | 48 +++++++++++++ .../controllers/tenants_controller_test.rb | 48 +++++++++++++ test/dummy/test/fixtures/people.yml | 9 +++ test/dummy/test/models/person_test.rb | 7 ++ test/dummy/test/system/people_test.rb | 43 ++++++++++++ test/dummy/test/system/tenants_test.rb | 41 +++++++++++ 37 files changed, 605 insertions(+), 33 deletions(-) create mode 100644 test/dummy/app/controllers/people_controller.rb create mode 100644 test/dummy/app/controllers/tenants_controller.rb create mode 100644 test/dummy/app/helpers/people_helper.rb create mode 100644 test/dummy/app/helpers/tenants_helper.rb create mode 100644 test/dummy/app/models/person.rb create mode 100644 test/dummy/app/views/people/_form.html.erb create mode 100644 test/dummy/app/views/people/_person.html.erb create mode 100644 test/dummy/app/views/people/edit.html.erb create mode 100644 test/dummy/app/views/people/index.html.erb create mode 100644 test/dummy/app/views/people/new.html.erb create mode 100644 test/dummy/app/views/people/show.html.erb create mode 100644 test/dummy/app/views/tenants/_form.html.erb create mode 100644 test/dummy/app/views/tenants/_tenant.html.erb create mode 100644 test/dummy/app/views/tenants/edit.html.erb create mode 100644 test/dummy/app/views/tenants/index.html.erb create mode 100644 test/dummy/app/views/tenants/new.html.erb create mode 100644 test/dummy/app/views/tenants/show.html.erb create mode 100644 test/dummy/db/migrate/20230905010414_create_tenants.rb create mode 100644 test/dummy/db/migrate/20230905010415_create_tenant_connections.rb create mode 100644 test/dummy/db/migrate_tenants/.keep create mode 100644 test/dummy/db/migrate_tenants/20230905014354_create_people.rb create mode 100644 test/dummy/db/schema.rb create mode 100644 test/dummy/test/controllers/people_controller_test.rb create mode 100644 test/dummy/test/controllers/tenants_controller_test.rb create mode 100644 test/dummy/test/fixtures/people.yml create mode 100644 test/dummy/test/models/person_test.rb create mode 100644 test/dummy/test/system/people_test.rb create mode 100644 test/dummy/test/system/tenants_test.rb diff --git a/Dockerfile b/Dockerfile index eb9e76c..b38074c 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,6 +1,6 @@ FROM ruby:3.2-alpine -RUN apk add --no-cache --update build-base git imagemagick linux-headers nodejs postgresql-dev tzdata yarn +RUN apk add --no-cache --update build-base git imagemagick linux-headers nodejs postgresql tzdata yarn WORKDIR /app diff --git a/app/models/tenant.rb b/app/models/tenant.rb index 6033738..695f88b 100644 --- a/app/models/tenant.rb +++ b/app/models/tenant.rb @@ -3,6 +3,8 @@ class Tenant < ActiveRecord::Base has_one :tenant_connection, dependent: :destroy + validates :name, presence: true, uniqueness: true + after_create_commit :create_tenant_connection def self.current @@ -20,8 +22,10 @@ def create_tenant_connection ## Hot restart puma unless Rails.env.test? - pid = File.read(".pumactl_pid").to_i - Process.kill("SIGUSR2", pid) + # pid = File.read(".pumactl_pid").to_i + # Process.kill("SIGUSR2", pid) + puts Process.pid + Process.kill "SIGUSR2", Process.pid end end end diff --git a/app/models/tenant_connection.rb b/app/models/tenant_connection.rb index f9456cf..3d4f198 100644 --- a/app/models/tenant_connection.rb +++ b/app/models/tenant_connection.rb @@ -8,7 +8,7 @@ def shard_name def config hash = attributes.symbolize_keys.except(:id, :created_at, :updated_at, :database_owner, :default_db_name, :default_env_name, :customer_id).compact_blank - hash[:pool] = ENV.fetch("RAILS_MAX_THREADS", 5) + hash[:pool] ||= ENV.fetch("RAILS_MAX_THREADS", 5) hash[:port] = hash[:port].to_i if hash[:port] hash end diff --git a/lib/generators/landlord/templates/create_tenant_connections.rb b/lib/generators/landlord/templates/create_tenant_connections.rb index 0eb3a43..9d06ec9 100644 --- a/lib/generators/landlord/templates/create_tenant_connections.rb +++ b/lib/generators/landlord/templates/create_tenant_connections.rb @@ -2,6 +2,7 @@ class CreateTenantConnections < ActiveRecord::Migration[6.0] def change create_table :tenant_connections, force: :cascade do |t| t.string :database + t.integer :pool t.integer :timeout t.string :adapter t.string :schema_search_path diff --git a/lib/landlord/concern.rb b/lib/landlord/concern.rb index b5edd4c..7b1e306 100644 --- a/lib/landlord/concern.rb +++ b/lib/landlord/concern.rb @@ -18,11 +18,12 @@ def fetch_db_connections # Stored in the db connections begin - db_stored_connections_configurations = ActiveRecord::Base.connection.execute("SELECT database, timeout, adapter, schema_search_path, username, password, host, port, migrations_paths FROM tenants_connection").to_a - db_stored_connections_configurations.each { |config| config["pool"] = ENV.fetch("RAILS_MAX_THREADS", 5) } + db_stored_connections_configurations = ActiveRecord::Base.connection.execute("SELECT database, pool, timeout, adapter, schema_search_path, username, password, host, port, migrations_paths FROM tenant_connections").to_a + # db_stored_connections_configurations.each { |config| config["pool"] ||= ENV.fetch("RAILS_MAX_THREADS", 5) } db_stored_connections_configurations.each do |connection_configuration| connection_configuration = connection_configuration.symbolize_keys - connections << handler.establish_connection(connection_configuration, owner_name: owner_name, role: role, shard: TenancyManager.shard_name(connection_configuration)) + connection_configuration[:pool] ||= ENV.fetch("RAILS_MAX_THREADS", 5) + connections << handler.establish_connection(connection_configuration, owner_name: owner_name, role: role, shard: Landlord.shard_name(connection_configuration)) end rescue # In migrations, we might not have tenants_connection, it is not neccessary to load them anyways diff --git a/lib/tasks/landlord_tasks.rake b/lib/tasks/landlord_tasks.rake index 0fa497e..f81e5a1 100644 --- a/lib/tasks/landlord_tasks.rake +++ b/lib/tasks/landlord_tasks.rake @@ -8,6 +8,7 @@ namespace :db do end namespace :tenants do + desc "Migrate the tenants database (options: VERSION=x, VERBOSE=false, SCOPE=blog)" task migrate: :load_config do original_db_config = ActiveRecord::Base.connection_db_config ask_again = true @@ -30,6 +31,7 @@ namespace :db do ActiveRecord::Base.establish_connection(original_db_config) end + desc "Rolls the schema back to the previous version (specify steps w/ STEP=n)" task rollback: :load_config do original_db_config = ActiveRecord::Base.connection_db_config ask_again = true diff --git a/test/dummy/app/controllers/people_controller.rb b/test/dummy/app/controllers/people_controller.rb new file mode 100644 index 0000000..571b7d5 --- /dev/null +++ b/test/dummy/app/controllers/people_controller.rb @@ -0,0 +1,69 @@ +class PeopleController < ApplicationController + before_action :set_tenant + around_action :switch_to_tenant + before_action :set_person, only: %i[show edit update destroy] + + # GET /people + def index + @people = Person.all + end + + # GET /people/1 + def show + end + + # GET /people/new + def new + @person = Person.new + end + + # GET /people/1/edit + def edit + end + + # POST /people + def create + @person = Person.new(person_params) + + if @person.save + redirect_to [@tenant, @person], notice: "Person was successfully created." + else + render :new, status: :unprocessable_entity + end + end + + # PATCH/PUT /people/1 + def update + if @person.update(person_params) + redirect_to [@tenant, @person], notice: "Person was successfully updated.", status: :see_other + else + render :edit, status: :unprocessable_entity + end + end + + # DELETE /people/1 + def destroy + @person.destroy + redirect_to tenant_people_url(@tenant), notice: "Person was successfully destroyed.", status: :see_other + end + + private + + # Use callbacks to share common setup or constraints between actions. + def set_person + @person = Person.find params[:id] + end + + def set_tenant + @tenant = Tenant.find params[:tenant_id] + end + + def switch_to_tenant + Landlord.switch_to(@tenant) { yield } + end + + # Only allow a list of trusted parameters through. + def person_params + params.require(:person).permit(:name, :email) + end +end diff --git a/test/dummy/app/controllers/tenants_controller.rb b/test/dummy/app/controllers/tenants_controller.rb new file mode 100644 index 0000000..df4a4d1 --- /dev/null +++ b/test/dummy/app/controllers/tenants_controller.rb @@ -0,0 +1,58 @@ +class TenantsController < ApplicationController + before_action :set_tenant, only: %i[ show edit update destroy ] + + # GET /tenants + def index + @tenants = Tenant.all + end + + # GET /tenants/1 + def show + end + + # GET /tenants/new + def new + @tenant = Tenant.new + end + + # GET /tenants/1/edit + def edit + end + + # POST /tenants + def create + @tenant = Tenant.new(tenant_params) + + if @tenant.save + redirect_to @tenant, notice: "Tenant was successfully created." + else + render :new, status: :unprocessable_entity + end + end + + # PATCH/PUT /tenants/1 + def update + if @tenant.update(tenant_params) + redirect_to @tenant, notice: "Tenant was successfully updated.", status: :see_other + else + render :edit, status: :unprocessable_entity + end + end + + # DELETE /tenants/1 + def destroy + @tenant.destroy + redirect_to tenants_url, notice: "Tenant was successfully destroyed.", status: :see_other + end + + private + # Use callbacks to share common setup or constraints between actions. + def set_tenant + @tenant = Tenant.find(params[:id]) + end + + # Only allow a list of trusted parameters through. + def tenant_params + params.require(:tenant).permit(:name) + end +end diff --git a/test/dummy/app/helpers/people_helper.rb b/test/dummy/app/helpers/people_helper.rb new file mode 100644 index 0000000..b682fbf --- /dev/null +++ b/test/dummy/app/helpers/people_helper.rb @@ -0,0 +1,2 @@ +module PeopleHelper +end diff --git a/test/dummy/app/helpers/tenants_helper.rb b/test/dummy/app/helpers/tenants_helper.rb new file mode 100644 index 0000000..b7bb45d --- /dev/null +++ b/test/dummy/app/helpers/tenants_helper.rb @@ -0,0 +1,2 @@ +module TenantsHelper +end diff --git a/test/dummy/app/models/application_record.rb b/test/dummy/app/models/application_record.rb index b63caeb..e5a8b4e 100644 --- a/test/dummy/app/models/application_record.rb +++ b/test/dummy/app/models/application_record.rb @@ -1,3 +1,6 @@ class ApplicationRecord < ActiveRecord::Base + include Landlord::Concern + + fetch_db_connections primary_abstract_class end diff --git a/test/dummy/app/models/person.rb b/test/dummy/app/models/person.rb new file mode 100644 index 0000000..2b5fe03 --- /dev/null +++ b/test/dummy/app/models/person.rb @@ -0,0 +1,4 @@ +class Person < ApplicationRecord + validates :email, presence: true + validates :name, presence: true +end diff --git a/test/dummy/app/views/people/_form.html.erb b/test/dummy/app/views/people/_form.html.erb new file mode 100644 index 0000000..510523c --- /dev/null +++ b/test/dummy/app/views/people/_form.html.erb @@ -0,0 +1,27 @@ +<%= form_with(model: [@tenant, person]) do |form| %> + <% if person.errors.any? %> +
+

<%= pluralize(person.errors.count, "error") %> prohibited this person from being saved:

+ +
    + <% person.errors.each do |error| %> +
  • <%= error.full_message %>
    • + <% end %> +
+
+ <% end %> + +
+ <%= form.label :name, style: "display: block" %> + <%= form.text_field :name %> +
+ +
+ <%= form.label :email, style: "display: block" %> + <%= form.text_field :email %> +
+ +
+ <%= form.submit %> +
+<% end %> diff --git a/test/dummy/app/views/people/_person.html.erb b/test/dummy/app/views/people/_person.html.erb new file mode 100644 index 0000000..b53b060 --- /dev/null +++ b/test/dummy/app/views/people/_person.html.erb @@ -0,0 +1,12 @@ +
+

+ Name: + <%= person.name %> +

+ +

+ Email: + <%= person.email %> +

+ +
diff --git a/test/dummy/app/views/people/edit.html.erb b/test/dummy/app/views/people/edit.html.erb new file mode 100644 index 0000000..60b8b4d --- /dev/null +++ b/test/dummy/app/views/people/edit.html.erb @@ -0,0 +1,10 @@ +

Editing person

+ +<%= render "form", person: @person %> + +
+ +
+ <%= link_to "Show this person", [@tenant, @person] %> | + <%= link_to "Back to people", tenant_people_path(@tenant) %> +
diff --git a/test/dummy/app/views/people/index.html.erb b/test/dummy/app/views/people/index.html.erb new file mode 100644 index 0000000..3c49a03 --- /dev/null +++ b/test/dummy/app/views/people/index.html.erb @@ -0,0 +1,14 @@ +

<%= notice %>

+ +

People

+ +
+ <% @people.each do |person| %> + <%= render person %> +

+ <%= link_to "Show this person", [@tenant, person] %> +

+ <% end %> +
+ +<%= link_to "New person", new_tenant_person_path %> diff --git a/test/dummy/app/views/people/new.html.erb b/test/dummy/app/views/people/new.html.erb new file mode 100644 index 0000000..5c4f359 --- /dev/null +++ b/test/dummy/app/views/people/new.html.erb @@ -0,0 +1,9 @@ +

New person

+ +<%= render "form", person: @person %> + +
+ +
+ <%= link_to "Back to people", tenant_people_path(@tenant) %> +
diff --git a/test/dummy/app/views/people/show.html.erb b/test/dummy/app/views/people/show.html.erb new file mode 100644 index 0000000..2a4cf25 --- /dev/null +++ b/test/dummy/app/views/people/show.html.erb @@ -0,0 +1,10 @@ +

<%= notice %>

+ +<%= render @person %> + +
+ <%= link_to "Edit this person", edit_tenant_person_path([@tenant, @person]) %> | + <%= link_to "Back to people", tenant_people_path(@tenant) %> + + <%= button_to "Destroy this person", [@tenant, @person], method: :delete %> +
diff --git a/test/dummy/app/views/tenants/_form.html.erb b/test/dummy/app/views/tenants/_form.html.erb new file mode 100644 index 0000000..220615e --- /dev/null +++ b/test/dummy/app/views/tenants/_form.html.erb @@ -0,0 +1,22 @@ +<%= form_with(model: tenant) do |form| %> + <% if tenant.errors.any? %> +
+

<%= pluralize(tenant.errors.count, "error") %> prohibited this tenant from being saved:

+ +
    + <% tenant.errors.each do |error| %> +
  • <%= error.full_message %>
    • + <% end %> +
+
+ <% end %> + +
+ <%= form.label :name, style: "display: block" %> + <%= form.text_field :name %> +
+ +
+ <%= form.submit %> +
+<% end %> diff --git a/test/dummy/app/views/tenants/_tenant.html.erb b/test/dummy/app/views/tenants/_tenant.html.erb new file mode 100644 index 0000000..14fef42 --- /dev/null +++ b/test/dummy/app/views/tenants/_tenant.html.erb @@ -0,0 +1,7 @@ +
+

+ Name: + <%= tenant.name %> +

+ +
diff --git a/test/dummy/app/views/tenants/edit.html.erb b/test/dummy/app/views/tenants/edit.html.erb new file mode 100644 index 0000000..b32ddf0 --- /dev/null +++ b/test/dummy/app/views/tenants/edit.html.erb @@ -0,0 +1,10 @@ +

Editing tenant

+ +<%= render "form", tenant: @tenant %> + +
+ +
+ <%= link_to "Show this tenant", @tenant %> | + <%= link_to "Back to tenants", tenants_path %> +
diff --git a/test/dummy/app/views/tenants/index.html.erb b/test/dummy/app/views/tenants/index.html.erb new file mode 100644 index 0000000..8c4ade1 --- /dev/null +++ b/test/dummy/app/views/tenants/index.html.erb @@ -0,0 +1,14 @@ +

<%= notice %>

+ +

Tenants

+ +
+ <% @tenants.each do |tenant| %> + <%= render tenant %> +

+ <%= link_to "Show this tenant", tenant %> +

+ <% end %> +
+ +<%= link_to "New tenant", new_tenant_path %> diff --git a/test/dummy/app/views/tenants/new.html.erb b/test/dummy/app/views/tenants/new.html.erb new file mode 100644 index 0000000..a231d44 --- /dev/null +++ b/test/dummy/app/views/tenants/new.html.erb @@ -0,0 +1,9 @@ +

New tenant

+ +<%= render "form", tenant: @tenant %> + +
+ +
+ <%= link_to "Back to tenants", tenants_path %> +
diff --git a/test/dummy/app/views/tenants/show.html.erb b/test/dummy/app/views/tenants/show.html.erb new file mode 100644 index 0000000..24e44bc --- /dev/null +++ b/test/dummy/app/views/tenants/show.html.erb @@ -0,0 +1,14 @@ +

<%= notice %>

+ +<%= render @tenant %> + +
+ <%= link_to "Edit this tenant", edit_tenant_path(@tenant) %> | + <%= link_to "Back to tenants", tenants_path %> + + <%= button_to "Destroy this tenant", @tenant, method: :delete %> +
+ +
+ <%= link_to "People", tenant_people_path(@tenant) %> +
diff --git a/test/dummy/config/database.yml b/test/dummy/config/database.yml index fcba57f..638cf74 100644 --- a/test/dummy/config/database.yml +++ b/test/dummy/config/database.yml @@ -1,25 +1,14 @@ -# SQLite. Versions 3.8.0 and up are supported. -# gem install sqlite3 -# -# Ensure the SQLite 3 gem is defined in your Gemfile -# gem "sqlite3" -# -default: &default - adapter: sqlite3 - pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %> - timeout: 5000 +# default: &default +# adapter: postgresql +# pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %> +# timeout: 5000 -development: - <<: *default - database: db/development.sqlite3 +# development: +# primary: +# <<: *default +# url: <%= ENV["DATABASE_URL"] %> -# Warning: The database defined as "test" will be erased and -# re-generated from your development database when you run "rake". -# Do not set this db to the same as development or production. -test: - <<: *default - database: db/test.sqlite3 - -production: - <<: *default - database: db/production.sqlite3 +# test: +# primary: +# <<: *default +# url: <%= ENV["DATABASE_URL"] %> diff --git a/test/dummy/config/routes.rb b/test/dummy/config/routes.rb index 262ffd5..3d2a14b 100644 --- a/test/dummy/config/routes.rb +++ b/test/dummy/config/routes.rb @@ -1,6 +1,7 @@ Rails.application.routes.draw do - # Define your application routes per the DSL in https://guides.rubyonrails.org/routing.html + resources :tenants do + resources :people + end - # Defines the root path route ("/") - # root "articles#index" + root to: "tenants#index" end diff --git a/test/dummy/db/migrate/20230905010414_create_tenants.rb b/test/dummy/db/migrate/20230905010414_create_tenants.rb new file mode 100644 index 0000000..07b1896 --- /dev/null +++ b/test/dummy/db/migrate/20230905010414_create_tenants.rb @@ -0,0 +1,9 @@ +class CreateTenants < ActiveRecord::Migration[6.0] + def change + create_table :tenants, force: :cascade do |t| + t.string :name + + t.timestamps + end + end +end diff --git a/test/dummy/db/migrate/20230905010415_create_tenant_connections.rb b/test/dummy/db/migrate/20230905010415_create_tenant_connections.rb new file mode 100644 index 0000000..9d06ec9 --- /dev/null +++ b/test/dummy/db/migrate/20230905010415_create_tenant_connections.rb @@ -0,0 +1,20 @@ +class CreateTenantConnections < ActiveRecord::Migration[6.0] + def change + create_table :tenant_connections, force: :cascade do |t| + t.string :database + t.integer :pool + t.integer :timeout + t.string :adapter + t.string :schema_search_path + t.string :username + t.string :password + t.string :host + t.string :port + t.string :migrations_paths, default: "db/migrate_tenants" + t.boolean :database_owner, default: false + t.references :tenant, foreign_key: true + t.datetime :created_at, precision: 6, null: false + t.datetime :updated_at, precision: 6, null: false + end + end +end diff --git a/test/dummy/db/migrate_tenants/.keep b/test/dummy/db/migrate_tenants/.keep new file mode 100644 index 0000000..e69de29 diff --git a/test/dummy/db/migrate_tenants/20230905014354_create_people.rb b/test/dummy/db/migrate_tenants/20230905014354_create_people.rb new file mode 100644 index 0000000..1bc24d9 --- /dev/null +++ b/test/dummy/db/migrate_tenants/20230905014354_create_people.rb @@ -0,0 +1,11 @@ +class CreatePeople < ActiveRecord::Migration[7.0] + def change + create_table :people do |t| + t.string :name + t.string :email + + t.timestamps + end + add_index :people, :email, unique: true + end +end diff --git a/test/dummy/db/schema.rb b/test/dummy/db/schema.rb new file mode 100644 index 0000000..40ff99b --- /dev/null +++ b/test/dummy/db/schema.rb @@ -0,0 +1,42 @@ +# This file is auto-generated from the current state of the database. Instead +# of editing this file, please use the migrations feature of Active Record to +# incrementally modify your database, and then regenerate this schema definition. +# +# This file is the source Rails uses to define your schema when running `bin/rails +# db:schema:load`. When creating a new database, `bin/rails db:schema:load` tends to +# be faster and is potentially less error prone than running all of your +# migrations from scratch. Old migrations may fail to apply correctly if those +# migrations use external dependencies or application code. +# +# It's strongly recommended that you check this file into your version control system. + +ActiveRecord::Schema[7.0].define(version: 2023_09_05_010415) do + # These are extensions that must be enabled in order to support this database + enable_extension "plpgsql" + + create_table "tenant_connections", force: :cascade do |t| + t.string "database" + t.integer "pool" + t.integer "timeout" + t.string "adapter" + t.string "schema_search_path" + t.string "username" + t.string "password" + t.string "host" + t.string "port" + t.string "migrations_paths", default: "db/migrate_tenants" + t.boolean "database_owner", default: false + t.bigint "tenant_id" + t.datetime "created_at", null: false + t.datetime "updated_at", null: false + t.index ["tenant_id"], name: "index_tenant_connections_on_tenant_id" + end + + create_table "tenants", force: :cascade do |t| + t.string "name" + t.datetime "created_at", null: false + t.datetime "updated_at", null: false + end + + add_foreign_key "tenant_connections", "tenants" +end diff --git a/test/dummy/test/controllers/people_controller_test.rb b/test/dummy/test/controllers/people_controller_test.rb new file mode 100644 index 0000000..436fc6a --- /dev/null +++ b/test/dummy/test/controllers/people_controller_test.rb @@ -0,0 +1,48 @@ +require "test_helper" + +class PeopleControllerTest < ActionDispatch::IntegrationTest + setup do + @person = people(:one) + end + + test "should get index" do + get people_url + assert_response :success + end + + test "should get new" do + get new_person_url + assert_response :success + end + + test "should create person" do + assert_difference("Person.count") do + post people_url, params: { person: { email: @person.email, name: @person.name } } + end + + assert_redirected_to person_url(Person.last) + end + + test "should show person" do + get person_url(@person) + assert_response :success + end + + test "should get edit" do + get edit_person_url(@person) + assert_response :success + end + + test "should update person" do + patch person_url(@person), params: { person: { email: @person.email, name: @person.name } } + assert_redirected_to person_url(@person) + end + + test "should destroy person" do + assert_difference("Person.count", -1) do + delete person_url(@person) + end + + assert_redirected_to people_url + end +end diff --git a/test/dummy/test/controllers/tenants_controller_test.rb b/test/dummy/test/controllers/tenants_controller_test.rb new file mode 100644 index 0000000..f15d306 --- /dev/null +++ b/test/dummy/test/controllers/tenants_controller_test.rb @@ -0,0 +1,48 @@ +require "test_helper" + +class TenantsControllerTest < ActionDispatch::IntegrationTest + setup do + @tenant = tenants(:one) + end + + test "should get index" do + get tenants_url + assert_response :success + end + + test "should get new" do + get new_tenant_url + assert_response :success + end + + test "should create tenant" do + assert_difference("Tenant.count") do + post tenants_url, params: { tenant: { name: @tenant.name } } + end + + assert_redirected_to tenant_url(Tenant.last) + end + + test "should show tenant" do + get tenant_url(@tenant) + assert_response :success + end + + test "should get edit" do + get edit_tenant_url(@tenant) + assert_response :success + end + + test "should update tenant" do + patch tenant_url(@tenant), params: { tenant: { name: @tenant.name } } + assert_redirected_to tenant_url(@tenant) + end + + test "should destroy tenant" do + assert_difference("Tenant.count", -1) do + delete tenant_url(@tenant) + end + + assert_redirected_to tenants_url + end +end diff --git a/test/dummy/test/fixtures/people.yml b/test/dummy/test/fixtures/people.yml new file mode 100644 index 0000000..11c0b4d --- /dev/null +++ b/test/dummy/test/fixtures/people.yml @@ -0,0 +1,9 @@ +# Read about fixtures at https://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html + +one: + name: MyString + email: MyString + +two: + name: MyString + email: MyString diff --git a/test/dummy/test/models/person_test.rb b/test/dummy/test/models/person_test.rb new file mode 100644 index 0000000..357c9af --- /dev/null +++ b/test/dummy/test/models/person_test.rb @@ -0,0 +1,7 @@ +require "test_helper" + +class PersonTest < ActiveSupport::TestCase + # test "the truth" do + # assert true + # end +end diff --git a/test/dummy/test/system/people_test.rb b/test/dummy/test/system/people_test.rb new file mode 100644 index 0000000..44a4dcc --- /dev/null +++ b/test/dummy/test/system/people_test.rb @@ -0,0 +1,43 @@ +require "application_system_test_case" + +class PeopleTest < ApplicationSystemTestCase + setup do + @person = people(:one) + end + + test "visiting the index" do + visit people_url + assert_selector "h1", text: "People" + end + + test "should create person" do + visit people_url + click_on "New person" + + fill_in "Email", with: @person.email + fill_in "Name", with: @person.name + click_on "Create Person" + + assert_text "Person was successfully created" + click_on "Back" + end + + test "should update Person" do + visit person_url(@person) + click_on "Edit this person", match: :first + + fill_in "Email", with: @person.email + fill_in "Name", with: @person.name + click_on "Update Person" + + assert_text "Person was successfully updated" + click_on "Back" + end + + test "should destroy Person" do + visit person_url(@person) + click_on "Destroy this person", match: :first + + assert_text "Person was successfully destroyed" + end +end diff --git a/test/dummy/test/system/tenants_test.rb b/test/dummy/test/system/tenants_test.rb new file mode 100644 index 0000000..f7f5b0c --- /dev/null +++ b/test/dummy/test/system/tenants_test.rb @@ -0,0 +1,41 @@ +require "application_system_test_case" + +class TenantsTest < ApplicationSystemTestCase + setup do + @tenant = tenants(:one) + end + + test "visiting the index" do + visit tenants_url + assert_selector "h1", text: "Tenants" + end + + test "should create tenant" do + visit tenants_url + click_on "New tenant" + + fill_in "Name", with: @tenant.name + click_on "Create Tenant" + + assert_text "Tenant was successfully created" + click_on "Back" + end + + test "should update Tenant" do + visit tenant_url(@tenant) + click_on "Edit this tenant", match: :first + + fill_in "Name", with: @tenant.name + click_on "Update Tenant" + + assert_text "Tenant was successfully updated" + click_on "Back" + end + + test "should destroy Tenant" do + visit tenant_url(@tenant) + click_on "Destroy this tenant", match: :first + + assert_text "Tenant was successfully destroyed" + end +end