Gorynich

Gorynich - это гем для реализации мультитенантности (мультиарендности) в Ruby on Rails приложении. Позволяет обеспечить строгую изоляцию данных в нескольких СУБД, поддерживаемых в ActiveRecord.

Поскольку мультитенантное приложение тесно связано с разделением данных, которые в свою очередь могут находиться в разных источниках (СУБД, S3, Redis и пр.), а также с их обработкой в разных подсистемах (ActiveJob, ActionCable), мы выбрали название "Горыныч", чтобы подчеркнуть многоголовость многогранность интеграций.

---

Gorynich provides tools for creating Multitenancy Ruby on Rails application. If you need to have strong data segregation and isolated DBMS's with diffrent providers (supported by ActiveRecord) and credentials, Gorynich can help.

Since a multi-tenant application is closely related to the separation of data, which in turn can be located in different sources (DBMS, S3, Redis, etc.), as well as their processing in different subsystems (ActiveJob, ActionCable), we chose the name "Gorynych", which to emphasize the multiheadedness versatility of integrations.

Возможности / Features

• Прозрачное переключение БД/СУБД на основании данных запросов / Transparent request based DB/DBMS switching
• Интеграция с / Integrations:
  • ActiveRecord
  • ActionCable
  • ActiveJob
  • DelayedJob
• Получение параметров из Consul KV / Stoting configuration in Consul KV
• Получение параметров из файла / Storing configuration in file
• Разделение секретов / Secret storing and isolation
• Обновление конфигурации "на лету" / update configuration "on the fly"
• Статическая генерация database.yml / Static database.yml generation

Начало работы / Getting started

gem install gorynich

При установке Gorynich через bundler добавьте следующую строку в Gemfile:

---

If you'd rather install Gorynichr using bundler, add a line for it in your Gemfile:

gem 'gorynich'

Затем выполните / Then run:

bundle install # для установки гема / gem installation

rails generate gorynich:install # для добавления шаблонов конфигурации / install configuration templates

Что такое тенант? / What tenant is?

Тенант (в данном случае) - это активное подключение к СУБД, а также доступный в любом месте объект Gorynich::Current, в котором находятся параметры текущего тенанта. К нему можно обратиться в любом месте.

---

In this case tenant is an active connection to the DBMS, as well as a Gorynich::Current object available anywhere, which contains the parameters of the current tenant. You can refer to it anywhere, for example when sending emails:

Gorynich::Current.tap do |t|
  t.tenant   # tenant_name
  t.uri      # https://app.domain.org
  t.host     # app.domain.org
  t.secrets  # { key1 => value1, key2 => value2}
  t.database # { adapter => postgresql, host => localhost, port => 5432, username => xxx, password => xxx }
end

Как это работает / How it works

Перед обработкой запроса с помощью Gorynich::Rack::RackMiddleware соединение Active Record переключается на указанную БД, а с помощью ActiveSupport::CurrentAttributes в любом месте приложения становятся доступны дополнительные параметры через обращение к Gorynich::Current. ActionCable, ActiveJob и другие "головы" используют настройки из Gorynich::Current для сохранения контекста и дальнейшего исполнения.

Например, при отправке писем изнутри ActiveJob использование выглядит так:

---

Before request processing Gorynich::Rack::RackMiddleware ActiveRecord connection switching to apropriate database. Additional tenant properties available in any part of application through ActiveSupport::CurrentAttributes as Gorynich::Current instance. ActionCable, ActiveJob and other "heads" also uses Gorynich::Current to store context and evaluate it later.

For example, when sending emails from within ActiveJob, the usage looks like this:

#app/mailers/application_mailer.rb

class ApplicationMailer < ActionMailer::Base
  helper :application

  def self.email_settings
    (
      Gorynich::Current.secrets[:email_settings] || Rails.application.secrets.email_settings || {}
    ).with_indifferent_access
  end

  default from: email_settings[:from], content_type: 'text/plain'

  def mail(args)
    @host = Gorynich.instance.hosts(Gorynich::Current.tenant).first || Rails.application.secrets.domain

    @settings ||= smtp_settings.merge(application_host: @host)

    super(args).tap |m|
      m.from = @settings[:from]
      m.delivery_method.settings = @settings unless Rails.env.development?
    end
  end

end

Использование / Usage

Настройка источника данных / Configuration source

Для использования необходимо в файле config/application.rb добавить источник данных. Сейчас доступны 3 источника:

---

Now you need to select configuration source in config/application.rb. Yuo can choose from 3 source types now:

Gorynich::Fetchers::File.new(file_path: [FILE_PATH]) # из файла / from file

Gorynich::Fetchers::Consul.new(storage: [CONSUL_KEY], **options) # из консула / from consul (options - from Dimplomat gem https://github.com/WeAreFarmGeek/diplomat)

Gorynich::Fetchers::ConsulSecure.new(storage: [CONSUL_KEY], file_path: [FILE_PATH], **options) # из консула с сохранением в файл (при недоступности консула будет читать из файла) / from consul with saving to a file (if unavailable, consul will read from the file) (options - from Dimplomat gem https://github.com/WeAreFarmGeek/diplomat)

Пример / Example:

# из одного / from single source
Gorynich.configuration.fetcher = Gorynich::Fetchers::File.new(file_path: Rails.root.join('config', 'gorynich_config.yml'))

# из нескольких (данные берутся от первого успешного fetcher)
# from multiple sources - first succesful source is used
Gorynich.configuration.fetcher  = [
  Gorynich::Fetchers::Consul.new(storage: 'gorynich_project/config'),
  Gorynich::Fetchers::File.new(file_path: Rails.root.join('config', 'gorynich_config.yml'))
]

Настройка интеграций ("голов") / Integration "Heads"

Gorynich настраивается в обычных инициалайзерах / Gorynich configured in initializer:

# config/initializers/gorynich.rb

Gorynich.configure do |config|
  # config cache of gorynich
  config.cache = Rails.cache

  # config cache namespace
  config.namespace = ENV.fetch('YOUR_NAMESPACE_ENV', 'your_namespace')

  # config how long your source cache will be alive in seconds
  config.cache_expiration = 'your_value'

  # Custom handler for swithing tenants in gorynich rack middleware
  config.rack_env_handler =
    lambda do |env|
      host = env['SERVER_NAME']
      tenant = Gorynich.instance.tenant_by_host(host)
      uri = Gorynich.instance.uri_by_host(host, tenant)

      Sentry.set_tags(tenant: tenant) if Sentry.get_current_scope.present?

      [tenant, { host: host, uri: uri }]
    end
end

# Add cable head
ActiveSupport.on_load(:action_cable_connection) do
  include Gorynich::Head::ActionCable::Connection
end

ActiveSupport.on_load(:action_cable_channel) do
  prepend Gorynich::Head::ActionCable::Channel
end

# Add active job head
ActiveSupport.on_load(:active_job) do
  include Gorynich::Head::ActiveJob
end

Rake Tasks

Запуск Rails console внутри тенанта / Run rails console inside tenant:

TENANT=tenant rails gc # default tenant name id  'default'

Для создания статичного файла database.yml из источника данных (Fetcher) используйте:

---

For static database.yml generation from configured source (Fetcher) use:

rails gc:db:prepare

Настройка конфигурации БД / Database configuration

1. Статическая генерация / static generation

Первый, самый простой способ работы, подходящий для локальной разработки, это статическая генерация database.yml.

---

First and most simple using of Gorynich handy for local development is static database.yml generation.

запуск rake-задачи / runing rake task:

rails gc:db:prepare

2. Полуавтоматический режим / Semi-automated mode

Второй вариант - это создание конфигурации database.yml при старте Rails приложения - данные будут прочитаны из настроенного источника. В этом случае конфигурация СУБД может изменяться только при перезапуске приложения, но остальные настройки, такие как привязка тенантов к доменам и secrets, будут подхватываться "на лету" непосредственно во время работы приложения. Rake-задачи db:create, db:migrate работают для всех тенантов на момент запуска.

---

Second option is dynamic database.yml creation while starting Rails application. Configuration will be readed from selected source. In this case database configuration can change only when application restarts, but other configuration such a domain to tenant binding and application secrets wil be updated "on the fly" while application running. Rake tasks db:create and db:migrate works as expected for all tenant in order.

ВНИМАНИЕ! db:rollback не работает в мультитенантном режиме.

WARNING! db:rollback is not working in multitenancy mode.

В database.yml прописать следующее / In database.yml set:

# config/database.yml
<%= Gorynich.instance.database_config %>

3. Дополнительные БД / Additional databases

Если вам нужны дополнительные БД, не являющиеся тенантами, например общая БД, то в database.yml можно дописать всё необходимое, как в обычном Rails приложении:

---

If you need additional DB, not for tenants Ex. generic database you can configure it in database.yml like in regular Rails application:

# config/database.yml
<%= Gorynich.instance.database_config('development') %>

your_database:
  <<: *configs_for_your_database

<%= Gorynich.instance.database_config('test') %>
your_database:
  <<: *configs_for_your_database

<%= Gorynich.instance.database_config('production') %>
your_database:
  <<: *configs_for_your_database

В коде / Inside code

Проверить, в каком вы тенанте, можно с помощью / Check in which tenant you are:

Gorynich::Current.tenant

Переключение тенантов работает автоматически, и внутри Rails приложения не нужно предпринимать никаких дополнительных действий - вы всегда подключены к той базе данных, к которой привязан домен текущего запроса (или иной параметр). Но если необходимо явно выполнить действия в контексте конкретного тената, это можно сделать:

---

Switching tenants is automatic and no additional steps need to be taken inside a Rails application - you always connected to database associated with currently procesed request. But if you want take action inside specific tenant context you can use:

  # для выполнения в конкретном тенанте / run block inside specific tenant
  Gorynich.with('tenant_name') do
    # your code
  end

  # для выполнения в каждом тенанте / run block inside each tenant
  Gorynich.with_each_tenant do |tenant|
    # your code
  end

Примеры дополнительных интеграций и использований / Additional integration examples

Redis / Rails.cache

#config/environments/production.rb

config.cache_store = :redis_cache_store, {
  url:                ENV.fetch('REDIS_URL', nil),
  expires_in:         90.minutes,
  connect_timeout:    3,
  reconnect_attempts: 3,
  namespace:          -> { "#{Gorynich.configuration.namespace}#{Gorynich::Current.tenant}" }
}

Sentry

#config/initializers/gorynich.rb

Gorynich.configure do |config|
  config.rack_env_handler =
    lambda do |env|
      host = env['SERVER_NAME']
      tenant = Gorynich.instance.tenant_by_host(host)
      uri = Gorynich.instance.uri_by_host(host, tenant)

      Sentry.set_tags(tenant: tenant) if Sentry.get_current_scope.present?

      [tenant, { host: host, uri: uri }]
    end
end

Telegram

#config/environments/production.rb

config.telegram_updates_controller.session_store = :redis_cache_store, {
  url:        ENV.fetch('REDIS_URL', nil),
  expires_in: 90.minutes,
  namespace:  -> { "#{Gorynich.configuration.namespace}#{Gorynich::Current.tenant}" }
}

Shrine

#lib/shrine/plugins/tenant_location.rb

class Shrine
  module Plugins
    module TenantLocation
      module InstanceMethods
        def generate_location(io, **options)
          "#{Gorynich::Current.tenant}/#{super}"
        end
      end
    end

    register_plugin(:tenant_location, TenantLocation)
  end
end

#config/initializers/shrine.rb

Shrine.plugin :tenant_location

ApplicationController

class ApplicationController < ActionController::Base
  around_action :around_action_notification

  def around_action_notification(&block)
    ActiveSupport::Notifications.instrument(
      'around_action.action_controller',
      current_user: current_user,
      request:      request,
      tenant:       Gorynich::Current.tenant, &block
    )
  end
end

DelayedJob

#config/initializers/delayed_job.rb

require 'gorynich/head/delayed_job'

Delayed::Worker.plugins << Gorynich::Head::DelayedJob

Лицензия / License

Библиотека доступна с открытым исходным кодом в соответствии с условиями лицензии MIT.

---

The gem is available as open source under the terms of the MIT License.