Install extensions in a shared schema
This way all tenants will be able to access them instead of just the default one. The apartment gem recommends using a rake task instead of a migration, but that's a solution which is primarily meant for new installations. Migrations are easier to execute on existing installations. However, since this migration doesn't affect the `schema.rb` file, we still need to make sure the shared schema is created in tasks which do not execute migrations, like `db:schema:load` or `db:test:prepare`, just like the apartment gem recommends. That's why we're enhancing these tasks so they execute this migration. Note that there might be cases where the database user isn't a superuser (as it's usually the case on production environments), meaning commands to create, alter or drop extensions will fail. There's also the case where users don't have permissions to create schemas, which is needed in order to create the shared extensions schema and the schemas used by the tenants. For these reasons, we're minimizing the number of commands, and so we only alter or create extensions when it is really necessary. When users don't have permission, we aren't running the commands but showing a warning with the steps needed to run the migration manually. This is only necessary on installations which are going to use multitenancy; single-tenant applications upgrading don't need to run this migration, and that's why we aren't raising exceptions when we can't run it. For new installations, we'll change the CONSUL installer so extensions are automatically created in the shared schema. Also note the plpgsql extension is not handled here. This is a special extension which must be installed on the pg_catalog schema, which is always in the search path and so is shared by all tenants. Finally, we also need to change the `database.yml` file in order to search for shared extensions while running migrations or model tests, since none of our enabled extensions are executed during migrations; we're also adding a rake task for existing installations. Quoting the apartment documentation: > your database.yml file must mimic what you've set for your default and > persistent schemas in Apartment. When you run migrations with Rails, > it won't know about the extensions schema because Apartment isn't > injected into the default connection, it's done on a per-request > basis.
This commit is contained in:
137
db/migrate/20200602233844_create_shared_extensions_schema.rb
Normal file
137
db/migrate/20200602233844_create_shared_extensions_schema.rb
Normal file
@@ -0,0 +1,137 @@
|
||||
class CreateSharedExtensionsSchema < ActiveRecord::Migration[6.0]
|
||||
def up
|
||||
unless schema_exists?(extensions_schema)
|
||||
execute_or_log_create_schema_warning("CREATE SCHEMA #{extensions_schema}")
|
||||
end
|
||||
|
||||
%w[unaccent pg_trgm].each do |extension|
|
||||
if extension_enabled?(extension)
|
||||
unless extension_already_in_extensions_schema?(extension)
|
||||
execute_or_log_extension_warning("ALTER EXTENSION #{extension} SET SCHEMA #{extensions_schema}")
|
||||
end
|
||||
else
|
||||
execute_or_log_extension_warning("CREATE EXTENSION #{extension} SCHEMA #{extensions_schema}")
|
||||
end
|
||||
end
|
||||
|
||||
unless schema_exists?(extensions_schema) && public_has_usage_privilege_on_extensions_schema?
|
||||
execute_or_log_grant_usage_warning("GRANT usage ON SCHEMA #{extensions_schema} TO public")
|
||||
end
|
||||
|
||||
show_full_warning_message if warning_messages.any?
|
||||
end
|
||||
|
||||
def down
|
||||
%w[unaccent pg_trgm].each do |extension|
|
||||
unless extension_already_in_public_schema?(extension)
|
||||
execute "ALTER EXTENSION #{extension} SET SCHEMA public;"
|
||||
end
|
||||
end
|
||||
|
||||
execute "DROP SCHEMA #{extensions_schema};" if schema_exists?(extensions_schema)
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def extensions_schema
|
||||
"shared_extensions"
|
||||
end
|
||||
|
||||
def extension_already_in_extensions_schema?(extension)
|
||||
associated_schema_id_for(extension) == extensions_schema_id
|
||||
end
|
||||
|
||||
def extension_already_in_public_schema?(extension)
|
||||
associated_schema_id_for(extension) == public_schema_id
|
||||
end
|
||||
|
||||
def associated_schema_id_for(extension)
|
||||
query_value("SELECT extnamespace FROM pg_extension WHERE extname=#{quote(extension)}")
|
||||
end
|
||||
|
||||
def extensions_schema_id
|
||||
schema_id_for(extensions_schema)
|
||||
end
|
||||
|
||||
def public_schema_id
|
||||
schema_id_for("public")
|
||||
end
|
||||
|
||||
def schema_id_for(schema)
|
||||
query_value("SELECT oid FROM pg_namespace WHERE nspname=#{quote(schema)}")
|
||||
end
|
||||
|
||||
def execute_or_log_create_schema_warning(statement)
|
||||
if create_permission?
|
||||
execute statement
|
||||
else
|
||||
log_warning(
|
||||
"GRANT CREATE ON DATABASE #{query_value("SELECT CURRENT_DATABASE()")} "\
|
||||
"TO #{query_value("SELECT CURRENT_USER")}"
|
||||
)
|
||||
log_warning(statement)
|
||||
end
|
||||
end
|
||||
|
||||
def execute_or_log_extension_warning(statement)
|
||||
if superuser?
|
||||
execute statement
|
||||
else
|
||||
log_warning(statement)
|
||||
end
|
||||
end
|
||||
|
||||
def execute_or_log_grant_usage_warning(statement)
|
||||
if schema_exists?(extensions_schema) && grant_usage_permission?
|
||||
execute statement
|
||||
else
|
||||
log_warning(statement)
|
||||
end
|
||||
end
|
||||
|
||||
def create_permission?
|
||||
query_value("SELECT has_database_privilege(CURRENT_USER, CURRENT_DATABASE(), 'CREATE');")
|
||||
end
|
||||
|
||||
def superuser?
|
||||
query_value("SELECT usesuper FROM pg_user WHERE usename = CURRENT_USER")
|
||||
end
|
||||
|
||||
def grant_usage_permission?
|
||||
query_value("SELECT has_schema_privilege(CURRENT_USER, '#{extensions_schema}', 'CREATE');")
|
||||
end
|
||||
|
||||
def public_has_usage_privilege_on_extensions_schema?
|
||||
query_value("SELECT has_schema_privilege('public', '#{extensions_schema}', 'USAGE');")
|
||||
end
|
||||
|
||||
def log_warning(statement)
|
||||
warning_messages.push(statement)
|
||||
end
|
||||
|
||||
def warning_messages
|
||||
@warning_messages ||= []
|
||||
end
|
||||
|
||||
def show_full_warning_message
|
||||
message = <<~WARNING
|
||||
---------------------- Multitenancy Warning ----------------------
|
||||
Multitenancy is a feature that allows managing multiple
|
||||
institutions in a completely independent way using just one
|
||||
CONSUL installation.
|
||||
|
||||
NOTE: If you aren't going to use multitenancy, you can safely
|
||||
ignore this warning.
|
||||
|
||||
If you'd like to enable this feature, first run:
|
||||
#{warning_messages.join(";\n ")};
|
||||
using a user with enough database privileges.
|
||||
|
||||
Check the CONSUL release notes for more information.
|
||||
------------------------------------------------------------------
|
||||
WARNING
|
||||
|
||||
puts message
|
||||
Rails.logger.warn(message)
|
||||
end
|
||||
end
|
||||
Reference in New Issue
Block a user