[Rails] PostgreSQLアダプタにカスタム型登録用の公式APIを追加

背景と課題

PostgreSQLを使用するRailsアプリケーションでは、PostGISやVector検索といったPostgreSQL拡張機能を利用する際、カスタムSQL型を登録する必要があります。これまで、activerecord-postgisやneighborといったgemは、PostgreSQLAdapterの内部メソッドをmonkey patchすることで型を追加していました。

この方法には以下の問題がありました：

内部実装に依存するため、Railsのバージョンアップ時に破壊的変更が発生するリスクがある
複数のgemが同じメソッドをpatchする際に競合が起こりうる
コードの保守性と可読性が低下する

導入された変更

今回のPRでは、PostgreSQLAdapter.register_type_mappingという公式APIが追加されました。これにより、サードパーティgemが安全にカスタム型を登録できるようになります。

実装の詳細

新しいAPIは、型マップの初期化時に実行されるコールバックを登録する仕組みです。

主要な実装部分：

def register_type_mapping(&block)
  raise ArgumentError, "block required" unless block_given?
  @@type_mapping_callbacks ||= []
  @@type_mapping_callbacks << block
end

登録されたコールバックは、initialize_type_mapメソッド内で順番に実行されます：

def initialize_type_map(m = type_map)
  # ... 既存の型登録処理 ...

  load_additional_types

  @@type_mapping_callbacks&.each { |block| block.call(m) }
end

使用例

カスタム型の登録は、以下のように記述できます：

ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.register_type_mapping do |type_map|
  type_map.register_type("geometry") do |oid, fmod, sql_type|
    MyGeometryType.new(sql_type)
  end
end

この例では、PostGISのgeometry型に対応するカスタム型MyGeometryTypeを登録しています。ブロックには以下の引数が渡されます：

oid: PostgreSQLの型OID（Object Identifier）
fmod: 型修飾子（例：VARCHAR(255)の255）
sql_type: SQL型名の文字列

複数の型を登録する場合

ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.register_type_mapping do |type_map|
  type_map.register_type("geometry") { |oid, fmod, sql_type| GeometryType.new(sql_type) }
  type_map.register_type("geography") { |oid, fmod, sql_type| GeographyType.new(sql_type) }
  type_map.register_type("vector") { |oid, fmod, sql_type| VectorType.new(sql_type) }
end

技術的特徴

実行順序の保証

コールバックは登録順に実行されます。これにより、複数のgemが型を登録する際の動作が予測可能になります。

クラス変数による管理

型マッピングコールバックは@@type_mapping_callbacksというクラス変数で管理されます。これは、PostgreSQLAdapterのすべてのインスタンスで共有されるため、一度登録すれば全コネクションで有効になります。

テスト用のクリアメソッド

テスト環境での分離を実現するため、clear_type_mapping_callbacks!メソッドも提供されています：

def setup
  @adapter_class = ActiveRecord::ConnectionAdapters::PostgreSQLAdapter
  @adapter_class.clear_type_mapping_callbacks!
end

def teardown
  @adapter_class.clear_type_mapping_callbacks!
end

まとめ

この変更により、PostgreSQL拡張機能を扱うgemの開発者は：

monkey patchを使わずに型を登録できる
Railsの内部実装変更の影響を受けにくくなる
より保守性の高いコードを書ける

PostGISやVector検索など、PostgreSQLの高度な機能を活用するアプリケーション開発がより安全かつ容易になることが期待されます。