マルチテナント対応のGemに触れた話

published_at: 2023-01-07

概要

社内の新規アプリケーション開発時にマルチテナント対応をしたいという話になり、Railsでそれを実現するGemを選定して実装した際の振り返り

背景

PostgresqlのRLS(Row Level Security)も考慮してテナントごとのデータを安全に扱いたかったため、それを前提にGemを探した

RLSのGemは https://github.com/suus-io/rls_rails も候補としてあったが、DSLみが強くconfigが複雑になりそうだったので不採用。

色々探した結果、SmartHRさんがRLSのGemを公開したという記事を読んで、結果的にそのGem (https://github.com/kufu/activerecord-tenant-level-security) を採用。

採用したGemが https://github.com/citusdata/activerecord-multi-tenant でのマルチテナント実装を推奨していたため、それを元に進めた。

詳細

まずusageに書かれているようにconfigでテナント分離できる設定を追記。

1TenantLevelSecurity.current_tenant_id { MultiTenant.current_tenant_id }

その後下記手順で動作確認を行なった。

テスト用のテーブルをマイグレーション（tenant_idをカラムにもたせる）
テストレコードのINSERT
Postgresql側でテストテーブルに参照権限を持ったテストユーザーを作成
テストユーザーでのコネクション確立
テナント分離動作確認

手順1: テスト用のテーブルをマイグレーション

usageに従いpolicyをテーブルに付与（tenant_idのカラムも持たせる）してマイグレーション

1class CreateEmployee < ActiveRecord::Migration[6.0]
2  def change
3    create_table :employees do |t|
4      t.integer :tenant_id
5      t.string :name
6    end
7    create_policy :employees
8  end
9end

DB側でもpolicyが付与されていることを確認

1development=# d employees
2                  Table "public.employees"
3  Column   |         Type          | Collation | Nullable |               Default
4-----------+-------------------+-----------+----------+---------------------------------------
5  id       | bigint           |           | not null | nextval('employees_id_seq'::regclass)
6  tenant_id | integer         |           |          |
7  name      | character varying |           |          |
8Indexes:
9  "employees_pkey" PRIMARY KEY, btree (id)
10Policies (forced row security enabled):
11  POLICY "tenant_policy"
12    USING (((tenant_id)::text = current_setting('tenant_level_security.tenant_id'::text)))
13    WITH CHECK (((tenantid)::text = currentsetting('tenant_level_security.tenant_id'::text)))

手順2: テストレコードのINSERT

12.times do |i|
2  Employee.create(tenant_id: i+1, name: "e#{i+1}")
3end;nil

この段階ではテナント分離されておらず全レコード取得できる

1irb(main):003:0> Employee.all
2  (0.2ms) SET tenant_level_security.tenant_id TO DEFAULT
3  Employee Load (0.6ms)  SELECT "employees".* FROM "employees"
4=> [#<Employee:0x0000ffffb2ef9770 id: 1, tenant_id: 1, name: "e1">, #<Employee:0x0000ffffb2c8acf0 id: 2, tenant_id: 2, name: "e2">]

手順3: Postgresql側でテストテーブルに参照権限を持ったテストユーザーを作成

テストユーザーにはSELECTだけ付与

1$ CREATE USER user WITH PASSWORD 'password';
2$ c development;
3$ GRANT SELECT ON employees To user;

手順4: テストユーザーでのコネクション確立

ActiveRecordのestablish_connectionを利用してテストユーザーでコネクション確立

1irb(main):017:1* app_user_config = {
2irb(main):018:1*   adapter: "postgresql",
3irb(main):019:1*   encoding: "UTF8",
4irb(main):020:1*   database: "development",
5irb(main):021:1*   username: "user",
6irb(main):022:1*   password: "password",
7irb(main):023:1*   host: "db",
8irb(main):024:1*   port: 5432,
9irb(main):025:0> }
10=> {:adapter=>"postgresql", :encoding=>"UTF8", :database=>"development", :username=>"user", :password=>"password", :host=>"db", :port=>5432}
11irb(main):026:0> ActiveRecord::Base.establish_connection(app_user_config)

手順5: テナント分離動作確認

tenant_idが1のレコードのみ返却される

1irb(main):016:1* TenantLevelSecurity.with(1) do
2irb(main):017:1*   Employee.pluck(:name)
3irb(main):018:0> end
4  (0.9ms) SHOW tenant_level_security.tenant_id
5  (0.5ms) SET tenant_level_security.tenant_id TO DEFAULT
6=> ["e1"]

これだけではまだ使い物にならないので、実装時に裏側でコネクション確立するような実装や明示的にコネクション抜ける方法も考えないといけない。

まとめ

RLSという単語を初めて知ったので新しい知見を得られた。Gemの選定も運用を考えた現実的なラインで判断できたので良い経験になった。

Kdevlog