fix: prevent error accessing foreign_collection on polymorphic relations (#211)

Author: matthv

packages/forest_admin_datasource_customizer/lib/forest_admin_datasource_customizer/decorators/relation/relation_collection_decorator.rb

@@ -240,6 +240,9 @@ def re_project_in_place(caller, records, projection)
 
         def re_project_relation_in_place(caller, records, name, projection)
           field_schema = schema[:fields][name]
+
+          return if field_schema.type == 'PolymorphicManyToOne'
+
           association = datasource.get_collection(field_schema.foreign_collection)
 
           if !@relations[name]

packages/forest_admin_datasource_customizer/spec/lib/forest_admin_datasource_customizer/decorators/relation/relation_collection_decorator_spec.rb

@@ -45,6 +45,40 @@ module Relation
             { 'id' => 203, 'other_id' => 203, 'name' => 'Joseph P. Rodriguez' }
           ]
         end
+        let(:comment_records) do
+          [
+            {
+              'id' => 301,
+              'text' => 'Great!',
+              'commentable_id' => 101,
+              'commentable_type' => 'passport',
+              'commentable' => { 'commentable_id' => 101, 'commentable_type' => 'passport' }
+            },
+            {
+              'id' => 302,
+              'text' => 'Nice',
+              'commentable_id' => 201,
+              'commentable_type' => 'person',
+              'commentable' => { 'commentable_id' => 201, 'commentable_type' => 'person' }
+            }
+          ]
+        end
+        let(:address_records) do
+          [
+            {
+              'id' => 401,
+              'street' => '123 Main St',
+              'addressable_id' => 201,
+              'addressable_type' => 'person'
+            },
+            {
+              'id' => 402,
+              'street' => '456 Oak Ave',
+              'addressable_id' => 202,
+              'addressable_type' => 'person'
+            }
+          ]
+        end
 
         before do
           datasource = Datasource.new
@@ -84,13 +118,40 @@ module Relation
             aggregation.apply(passport_records, caller.timezone, limit)
           end
 
+          collection_address = build_collection(
+            name: 'address',
+            schema: {
+              fields: {
+                'id' => ColumnSchema.new(column_type: PrimitiveType::NUMBER, is_primary_key: true, filter_operators: [Operators::EQUAL, Operators::IN]),
+                'street' => ColumnSchema.new(column_type: PrimitiveType::STRING),
+                'addressable_id' => ColumnSchema.new(column_type: PrimitiveType::NUMBER, filter_operators: [Operators::IN]),
+                'addressable_type' => ColumnSchema.new(column_type: PrimitiveType::STRING)
+              }
+            },
+            datasource: datasource
+          )
+
+          allow(collection_address).to receive(:list) do |_caller, filter, projection|
+            result = ForestAdminDatasourceToolkit::Utils::HashHelper.convert_keys(address_records, :to_s)
+            result = filter.condition_tree.apply(result, collection_address, 'Europe/Paris') if filter&.condition_tree
+
+            projection.apply(result)
+          end
+
           collection_person = build_collection(
             name: 'person',
             schema: {
               fields: {
                 'id' => ColumnSchema.new(column_type: PrimitiveType::NUMBER, is_primary_key: true, filter_operators: [Operators::EQUAL, Operators::IN]),
                 'other_id' => ColumnSchema.new(column_type: PrimitiveType::NUMBER, filter_operators: [Operators::IN]),
-                'name' => ColumnSchema.new(column_type: PrimitiveType::STRING, filter_operators: [Operators::IN])
+                'name' => ColumnSchema.new(column_type: PrimitiveType::STRING, filter_operators: [Operators::IN]),
+                'address' => Relations::PolymorphicOneToOneSchema.new(
+                  origin_key: 'addressable_id',
+                  origin_key_target: 'id',
+                  foreign_collection: 'address',
+                  origin_type_field: 'addressable_type',
+                  origin_type_value: 'person'
+                )
               }
             },
             datasource: datasource
@@ -107,9 +168,37 @@ module Relation
             aggregation.apply(person_records, caller.timezone, limit)
           end
 
+          collection_comment = build_collection(
+            name: 'comment',
+            schema: {
+              fields: {
+                'id' => ColumnSchema.new(column_type: PrimitiveType::NUMBER, is_primary_key: true, filter_operators: [Operators::EQUAL, Operators::IN]),
+                'text' => ColumnSchema.new(column_type: PrimitiveType::STRING),
+                'commentable_id' => ColumnSchema.new(column_type: PrimitiveType::NUMBER, filter_operators: [Operators::IN]),
+                'commentable_type' => ColumnSchema.new(column_type: PrimitiveType::STRING),
+                'commentable' => Relations::PolymorphicManyToOneSchema.new(
+                  foreign_key_type_field: 'commentable_type',
+                  foreign_key: 'commentable_id',
+                  foreign_key_targets: { 'passport' => 'id', 'person' => 'id' },
+                  foreign_collections: %w[passport person]
+                )
+              }
+            },
+            datasource: datasource
+          )
+
+          allow(collection_comment).to receive(:list) do |_caller, filter, projection|
+            result = ForestAdminDatasourceToolkit::Utils::HashHelper.convert_keys(comment_records, :to_s)
+            result = filter.condition_tree.apply(result, collection_comment, 'Europe/Paris') if filter&.condition_tree
+
+            projection.apply(result)
+          end
+
           datasource.add_collection(collection_picture)
           datasource.add_collection(collection_passport)
+          datasource.add_collection(collection_address)
           datasource.add_collection(collection_person)
+          datasource.add_collection(collection_comment)
 
           @datasource_decorator = DatasourceDecorator.new(datasource, relation_collection_decorator)
         end
@@ -606,6 +695,33 @@ module Relation
               end
             end
           end
+
+          context 'with polymorphic relations' do
+            it 'handles PolymorphicManyToOne without error' do
+              records = @datasource_decorator.get_collection('comment').list(
+                caller,
+                Filter.new,
+                Projection.new(%w[id text commentable:commentable_id])
+              )
+
+              expect(records).to eq([
+                                      { 'id' => 301, 'text' => 'Great!', 'commentable' => { 'commentable_id' => 101 } },
+                                      { 'id' => 302, 'text' => 'Nice', 'commentable' => { 'commentable_id' => 201 } }
+                                    ])
+            end
+
+            it 'handles PolymorphicOneToOne without error' do
+              records = @datasource_decorator.get_collection('person').list(
+                caller,
+                Filter.new,
+                Projection.new(%w[id name address:street])
+              )
+
+              expect(records.length).to eq(3)
+              expect(records.first).to have_key('id')
+              expect(records.first).to have_key('name')
+            end
+          end
         end
       end
     end