forest_liana 9.22.3 → 9.22.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 277b2499887f0ff82ea53ca55fc79843541cef4709f064c70f5efa55a4735d53
-  data.tar.gz: f0fbeb9771dae6c1db93581279e433815f47eca0e257543f24bf012057da51d3
+  metadata.gz: 6ca262c2db5e774393d0dd9b9266bbd360cea72c8caeea733c7df95a32bd6f3c
+  data.tar.gz: 5917abff7f56a4df5bf38c885ab375dc7240f666826c46a5ddb92a4709110d8e
 SHA512:
-  metadata.gz: 8e02b44b8348a306b0e7e60b44da087c0effb4ba538947e9165e6db2e156698b4a276a0288335ea8b7768454e0d4309ef4232e37c994abd2adffc04763f66f2b
-  data.tar.gz: 2be7bc1df7f51619407f1fe8f2b49a8e7b5629ada6151677e6f1f9a57a5548ffbeec5cfdb33f31cb8ca015a26937fb73e96f7decb9b63e959903e69497791f1b
+  metadata.gz: c60d6abc5f591ac151cf592e56f7790fc24db53984f4a646da46bf61ca1030b77d21713a4ee7d63a334ad9a70c5b934c982ce1fd76669e485be2c58e634fddcf
+  data.tar.gz: 55b8f9f4a71a17dcb8cb3c55b0a240e0576697ae5ca42116f266aa9b429d15aea49193222ea0f599a6feb892405f3fdfb565e1d1a033e4595c22f351e277e112

data/app/services/forest_liana/apimap_sorter.rb

@@ -110,15 +110,16 @@ module ForestLiana
     private
 
     def sort_array_of_objects(array)
-      array.sort! do |element1, element2|
-        [element1['type'], element1['id']] <=>  [element2['type'], element2['id']]
-      end
+      array.sort_by! { |element| [element['type'].to_s, element['id'].to_s] }
     end
 
+    # NOTICE: A field 'type' is a String ('String'), an Array (['String'] for an array column)
+    # or a Hash (a nested type), and those are not comparable with one another:
+    # `['String'] <=> 'String'` returns nil, which makes `sort` raise an ArgumentError as soon
+    # as two fields share a name. Only the tie-breaker ever needs to be total, so JSON-ifying
+    # that one alone keeps the primary key byte-for-byte identical and the apimap churn-free.
     def sort_array_of_fields(array)
-      array.sort do |field1, field2|
-        [field1['field'], field1['type']] <=>  [field2['field'], field2['type']]
-      end
+      array.sort_by { |field| [field['field'].to_s, field['type'].to_json] }
     end
 
     def reorder_keys_basic(object)

data/app/services/forest_liana/base_getter.rb

@@ -544,8 +544,13 @@ module ForestLiana
           # Skip ActiveStorage associations - already processed above
           next if is_active_storage_association?(association)
 
+          # NOTICE: A preloaded :through only reads keys off the rows this query builds: the root
+          #         row, and the narrowed rows of a first hop it joins. Walking the whole chain would
+          #         name tables it never joins.
+          if through_chain.any? && !joined?(association, joined_relations)
+            select_preload_hop_keys(select, [association.name], joined_relations)
           # For :through associations, recursively add all intermediate foreign keys
-          if through_chain.any?
+          elsif through_chain.any?
             current_resource = projected_resource
             through_chain.reverse.each do |through_name|
               through_assoc = current_resource.reflect_on_association(through_name)
@@ -694,7 +699,11 @@ module ForestLiana
     # those rows are the narrowed ones built off the JOIN, so its key has to be named here too.
     # It was not, and the list answered 500 rather than the one field (PRD-1316).
     def select_dependency_preload_keys(select, relation_path, joined_relations)
-      chains = flatten_dependency_hops(relation_path.relations)
+      select_preload_hop_keys(select, relation_path.relations, joined_relations)
+    end
+
+    def select_preload_hop_keys(select, relations, joined_relations)
+      chains = flatten_dependency_hops(relations)
       return if chains.empty?
 
       narrowed_hops(chains, joined_relations).each do |owner, reflection|

data/lib/forest_liana/version.rb

@@ -1,3 +1,3 @@
 module ForestLiana
-  VERSION = "9.22.3"
+  VERSION = "9.22.5"
 end

data/spec/dummy/app/models/boat.rb

@@ -0,0 +1,8 @@
+class Boat < ActiveRecord::Base
+  belongs_to :harbor
+  belongs_to :captain
+
+  # Its second hop is keyed on captains.license_number, which the preloader reads off the captain
+  # rows: narrowed ones when Harbor's boats related list joins captain to sort on it.
+  has_one :captain_license, through: :captain, source: :license
+end

data/spec/dummy/app/models/captain.rb

@@ -0,0 +1,3 @@
+class Captain < ActiveRecord::Base
+  has_one :license, primary_key: :license_number, foreign_key: :number
+end

data/spec/dummy/app/models/harbor.rb

@@ -0,0 +1,3 @@
+class Harbor < ActiveRecord::Base
+  has_many :boats
+end

data/spec/dummy/app/models/license.rb

@@ -0,0 +1,2 @@
+class License < ActiveRecord::Base
+end

data/spec/dummy/app/models/membership.rb

@@ -1,4 +1,9 @@
 class Membership < ActiveRecord::Base
   belongs_to :island
   belongs_to :user
+
+  # A :through of a :through: displayed on Island's memberships related list, the hop past the
+  # first reads `locations`, a table that list preloads rather than joins (issue #818).
+  has_one :location, through: :island
+  has_one :location_island, through: :location, source: :island
 end

data/spec/dummy/db/migrate/20261001120000_create_harbors_boats_captains_licenses.rb

@@ -0,0 +1,23 @@
+class CreateHarborsBoatsCaptainsLicenses < ActiveRecord::Migration[6.0]
+  def change
+    create_table :harbors do |t|
+      t.string :name
+    end
+
+    create_table :captains do |t|
+      t.string :name
+      t.string :license_number
+    end
+
+    create_table :licenses do |t|
+      t.string :number
+      t.date :expires_on
+    end
+
+    create_table :boats do |t|
+      t.string :name
+      t.references :harbor
+      t.references :captain
+    end
+  end
+end

data/spec/dummy/db/schema.rb

@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 2026_09_24_120000) do
+ActiveRecord::Schema.define(version: 2026_10_01_120000) do
 
   create_table "addresses", force: :cascade do |t|
     t.string "line1"
@@ -29,6 +29,19 @@ ActiveRecord::Schema.define(version: 2026_09_24_120000) do
     t.datetime "updated_at", precision: 6, null: false
   end
 
+  create_table "boats", force: :cascade do |t|
+    t.string "name"
+    t.integer "harbor_id"
+    t.integer "captain_id"
+    t.index ["captain_id"], name: "index_boats_on_captain_id"
+    t.index ["harbor_id"], name: "index_boats_on_harbor_id"
+  end
+
+  create_table "captains", force: :cascade do |t|
+    t.string "name"
+    t.string "license_number"
+  end
+
   create_table "flags", force: :cascade do |t|
     t.integer "island_id"
     t.string "color"
@@ -37,6 +50,10 @@ ActiveRecord::Schema.define(version: 2026_09_24_120000) do
     t.index ["island_id"], name: "index_flags_on_island_id"
   end
 
+  create_table "harbors", force: :cascade do |t|
+    t.string "name"
+  end
+
   create_table "isle", force: :cascade do |t|
     t.string "name"
     t.binary "map"
@@ -44,6 +61,11 @@ ActiveRecord::Schema.define(version: 2026_09_24_120000) do
     t.datetime "updated_at"
   end
 
+  create_table "licenses", force: :cascade do |t|
+    t.string "number"
+    t.date "expires_on"
+  end
+
   create_table "locations", force: :cascade do |t|
     t.string "coordinates"
     t.integer "island_id"

data/spec/lib/forest_liana/bootstrapper_spec.rb

@@ -66,8 +66,12 @@ module ForestLiana
         [
           Address,
           Article,
+          Boat,
+          Captain,
           Flag,
+          Harbor,
           Island,
+          License,
           Location,
           Manufacturer,
           Membership,

data/spec/requests/related_list_nested_through_spec.rb

@@ -0,0 +1,55 @@
+require 'rails_helper'
+
+describe 'A related list displaying a has_one :through', type: :request do
+  before do
+    allow(ForestLiana::IpWhitelist).to receive(:retrieve) { true }
+    allow(ForestLiana::IpWhitelist).to receive(:is_ip_whitelist_retrieved) { true }
+    allow(ForestLiana::IpWhitelist).to receive(:is_ip_valid) { true }
+    allow_any_instance_of(ForestLiana::Ability).to receive(:forest_authorize!) { true }
+    Rails.cache.write('forest.has_permission', false)
+    allow(ForestLiana::ScopeManager).to receive(:fetch_scopes)
+      .and_return('scopes' => {}, 'team' => { 'id' => '1', 'name' => 'Operations' })
+  end
+
+  token = JWT.encode({ id: 38, email: 'michael.kelso@that70.show', first_name: 'Michael',
+                       last_name: 'Kelso', team: 'Operations', rendering_id: 16,
+                       exp: Time.now.to_i + 2.weeks.to_i, permission_level: 'admin' },
+                     ForestLiana.auth_secret, 'HS256')
+  headers = { 'Accept' => 'application/json', 'Content-Type' => 'application/json',
+              'Authorization' => "Bearer #{token}" }
+
+  let!(:user) { User.create!(name: 'Michel', title: :king) }
+  let!(:island) { Island.create!(name: 'Skull') }
+  let!(:location) { Location.create!(coordinates: '12345', island: island) }
+  let!(:membership) { Membership.create!(island: island, user: user) }
+
+  it 'serves a :through going through another :through' do
+    get "/forest/Island/#{island.id}/relationships/memberships",
+        params: { fields: { 'Membership' => 'id,location_island', 'location_island' => 'name' },
+                  page: { 'number' => '1', 'size' => '15' }, sort: '-id', timezone: 'Europe/Paris' },
+        headers: headers
+
+    expect(response.status).to eq(200)
+    body = JSON.parse(response.body)
+    expect(body['data'].map { |row| row.dig('relationships', 'location_island', 'data', 'id') }).to eq([island.id.to_s])
+    expect(body['included'].map { |record| record.dig('attributes', 'name') }).to eq(['Skull'])
+  end
+
+  # Sorting on captain joins it with only the columns the list shows, and the preloader reads the
+  # license's key, captains.license_number, off those narrowed rows.
+  it 'serves a :through whose first hop is joined and keys the next hop on a non-primary column' do
+    harbor = Harbor.create!(name: 'Saint-Malo')
+    captain = Captain.create!(name: 'Haddock', license_number: 'FR-4421')
+    license = License.create!(number: 'FR-4421', expires_on: Date.new(2030, 1, 1))
+    Boat.create!(name: 'Karaboudjan', harbor: harbor, captain: captain)
+
+    get "/forest/Harbor/#{harbor.id}/relationships/boats",
+        params: { fields: { 'Boat' => 'id,captain,captain_license', 'captain' => 'name', 'captain_license' => 'number' },
+                  page: { 'number' => '1', 'size' => '15' }, sort: 'captain.name', timezone: 'Europe/Paris' },
+        headers: headers
+
+    expect(response.status).to eq(200)
+    body = JSON.parse(response.body)
+    expect(body['data'].map { |row| row.dig('relationships', 'captain_license', 'data', 'id') }).to eq([license.id.to_s])
+  end
+end

data/spec/services/forest_liana/apimap_sorter_spec.rb

@@ -171,6 +171,80 @@ module ForestLiana
           expect(apimap_sorted['meta']['stack'].keys).to eq(['database_type', 'orm_version'])
         end
       end
+
+      context 'on an apimap with fields sharing a name but not a comparable type' do
+        # NOTICE: a field 'type' is a String ('String'), an Array (['String'] for an array
+        # column) or a Hash (a nested type). The sort used to compare those values
+        # directly, so `['String'] <=> 'String'` returned nil and `sort` raised
+        # `ArgumentError: comparison of Hash with Hash failed`. The rescue in `perform`
+        # swallowed it and returned a half-processed apimap: collections that were never
+        # reached kept attributes outside KEYS_COLLECTION (such as 'search_fields'), and
+        # the Forest API rejects those with `HTTP 400 ValidationFailedError`.
+        let(:apimap) do
+          ActiveSupport::JSON.decode(ActiveSupport::JSON.encode({
+            'meta': {
+              stack: {
+                'orm_version': '4.34.9',
+                'database_type': 'postgresql',
+              },
+              liana: 'forest-rails',
+              'liana_version': '1.5.24',
+            },
+            'data': [{
+              id: 'posts',
+              type: 'collections',
+              attributes: {
+                name: 'posts',
+                fields: [
+                  { field: 'tags', type: ['String'] },
+                  { field: 'tags', type: 'String' },
+                  { field: 'meta', type: { fields: [{ field: 'locale', type: 'String' }] } },
+                  { field: 'meta', type: 'String' },
+                  { field: 'id', type: 'Number' },
+                ],
+              }
+            }, {
+              id: 'zebras',
+              type: 'collections',
+              attributes: {
+                'search_fields': ['name'],
+                fields: [
+                  { field: 'id', type: 'Number' },
+                ],
+                name: 'zebras',
+              }
+            }]
+          }))
+        end
+
+        let(:apimap_sorted) { ApimapSorter.new(apimap).perform }
+
+        it 'should reorder the whole apimap without bailing out' do
+          expect(FOREST_LOGGER).not_to receive(:warn)
+
+          apimap_sorted
+        end
+
+        it 'should sort the fields of the offending collection' do
+          expect(apimap_sorted['data'][0]['attributes']['fields'].map { |field| field['field'] })
+            .to eq(['id', 'meta', 'meta', 'tags', 'tags'])
+        end
+
+        it 'should keep a deterministic order between the non-comparable types' do
+          tag_types = apimap_sorted['data'][0]['attributes']['fields']
+            .select { |field| field['field'] == 'tags' }
+            .map { |field| field['type'] }
+          expect(tag_types).to eq(['String', ['String']])
+        end
+
+        it 'should keep processing the collections after the offending one' do
+          expect(apimap_sorted['data'][1]['attributes'].keys).to eq(['name', 'fields'])
+        end
+
+        it 'should not leak collection attributes that are not part of the schema' do
+          expect(apimap_sorted['data'][1]['attributes']).not_to have_key('search_fields')
+        end
+      end
     end
 
     describe 'a smart field dependencies key' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: forest_liana
 version: !ruby/object:Gem::Version
-  version: 9.22.3
+  version: 9.22.5
 platform: ruby
 authors:
 - Sandro Munda
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-09-25 00:00:00.000000000 Z
+date: 2026-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -386,11 +386,15 @@ files:
 - spec/dummy/app/models/address.rb
 - spec/dummy/app/models/application_record.rb
 - spec/dummy/app/models/article.rb
+- spec/dummy/app/models/boat.rb
+- spec/dummy/app/models/captain.rb
 - spec/dummy/app/models/car.rb
 - spec/dummy/app/models/driver.rb
 - spec/dummy/app/models/flag.rb
 - spec/dummy/app/models/garage_record.rb
+- spec/dummy/app/models/harbor.rb
 - spec/dummy/app/models/island.rb
+- spec/dummy/app/models/license.rb
 - spec/dummy/app/models/location.rb
 - spec/dummy/app/models/manufacturer.rb
 - spec/dummy/app/models/membership.rb
@@ -446,6 +450,7 @@ files:
 - spec/dummy/db/migrate/20260914120000_create_articles_and_taggings.rb
 - spec/dummy/db/migrate/20260922120000_create_trees_users.rb
 - spec/dummy/db/migrate/20260924120000_add_maker_name_to_products.rb
+- spec/dummy/db/migrate/20261001120000_create_harbors_boats_captains_licenses.rb
 - spec/dummy/db/schema.rb
 - spec/dummy/db/user_schema.rb
 - spec/dummy/lib/forest_liana/collections/address.rb
@@ -477,6 +482,7 @@ files:
 - spec/requests/projection_header_spec.rb
 - spec/requests/projection_inherited_loads_spec.rb
 - spec/requests/query_footprint_spec.rb
+- spec/requests/related_list_nested_through_spec.rb
 - spec/requests/resources_spec.rb
 - spec/requests/stats_spec.rb
 - spec/requests/sti_record_conversion_spec.rb
@@ -734,11 +740,15 @@ test_files:
 - spec/dummy/app/models/address.rb
 - spec/dummy/app/models/application_record.rb
 - spec/dummy/app/models/article.rb
+- spec/dummy/app/models/boat.rb
+- spec/dummy/app/models/captain.rb
 - spec/dummy/app/models/car.rb
 - spec/dummy/app/models/driver.rb
 - spec/dummy/app/models/flag.rb
 - spec/dummy/app/models/garage_record.rb
+- spec/dummy/app/models/harbor.rb
 - spec/dummy/app/models/island.rb
+- spec/dummy/app/models/license.rb
 - spec/dummy/app/models/location.rb
 - spec/dummy/app/models/manufacturer.rb
 - spec/dummy/app/models/membership.rb
@@ -794,6 +804,7 @@ test_files:
 - spec/dummy/db/migrate/20260914120000_create_articles_and_taggings.rb
 - spec/dummy/db/migrate/20260922120000_create_trees_users.rb
 - spec/dummy/db/migrate/20260924120000_add_maker_name_to_products.rb
+- spec/dummy/db/migrate/20261001120000_create_harbors_boats_captains_licenses.rb
 - spec/dummy/db/schema.rb
 - spec/dummy/db/user_schema.rb
 - spec/dummy/lib/forest_liana/collections/address.rb
@@ -825,6 +836,7 @@ test_files:
 - spec/requests/projection_header_spec.rb
 - spec/requests/projection_inherited_loads_spec.rb
 - spec/requests/query_footprint_spec.rb
+- spec/requests/related_list_nested_through_spec.rb
 - spec/requests/resources_spec.rb
 - spec/requests/stats_spec.rb
 - spec/requests/sti_record_conversion_spec.rb