Fix exception when using a resource with a composite primary/foreign key association

[filipegiusti]

Fixes #3334

Fix NoMethodError: undefined method 'to_sym' for an instance of Array raised by this line when an association uses a composite primary key/foreign key.

Checklist:

• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• I have added tests that prove my fix is effective or that my feature works

[codeclimate]

Code Climate has analyzed commit 0a745ed and detected 0 issues on this pull request.

View more on Code Climate.

[adrianthedev]

Thanks @filipegiusti!
Would you be able to add some tests for this as well?

The approach I would take is to create a new model & resource which uses composite foreign keys and test that.

Thank you for tackling this!

[filipegiusti]

The approach I would take is to create a new model & resource which uses composite foreign keys and test that.

I searched for a test file at spec/lib/avo/fields/belongs_to_field.rb or using the search term spec fields belongs_to but I couldn't find anything. I'm not sure where such test would be and how it would look like, I don't have much experience testing libraries.

PS: I also searched for some sort of coverage tool that would help pinpoint which tests cover that method and tried to get github copilot to find such tests, all without luck.

[adrianthedev]

Can you create a new spec next to this one and test only the composite behavior?

[Paul-Bob]

@filipegiusti I can take over and create the test. Could you share some details about your environment setup? We don’t have any tables with composite primary or foreign keys, so I’m unsure how to configure the environment to test this change.

[filipegiusti]

It all started when we added the primary_key and foreign_key. We have these models.

class Profile
  has_one :membership, primary_key: %i[organization_id id], foreign_key: %i[organization_id profile_id], dependent: :destroy, inverse_of: :profile
end

class Membership
  belongs_to :profile, primary_key: %i[organization_id id], foreign_key: %i[organization_id profile_id], inverse_of: :membership
end

Both models have a primary key of id and an unique index of [organization_id, id].

The edit page of Profile works, the exception is raised when Profile is attempted to be updated.

We also have:

class Resources::Profile < Avo::BaseResource
  def fields
    field :membership, as: :belongs_to, only_on: :show
  end
end

[filipegiusti]

I might be able to look at this next week.

[github-actions]

This PR has been marked as stale because there was no activity for the past 15 days.

[Paul-Bob]

I might be able to look at this next week.

That would be great,

Thank you!

[github-actions]

This PR has been marked as stale because there was no activity for the past 15 days.

[github-actions]

Closing this because there was no activity for the past 15 days. Feel free to reopen if new information pops up ✌️

[filipegiusti]

Hello! This was prioritized and I'll try to make this work in Avo.

I see there are test models for Location and TeamMembership, could I modify and add a relationship between these? It would be something like:

# in a migration

add_column :team_memberships, :location_id, :bigint
add_foreign_key :team_memberships, :locations, primary_key: %i[team_id id], column: %i[team_id location_id] # introduced on https://github.com/rails/rails/pull/47637

# in models

class Location
  has_many :team_memberships, primary_key: %i[team_id id], foreign_key: %i[team_id location_id], inverse_of: :location
end

class TeamMembership
  belongs_to :location, primary_key: %i[team_id id], foreign_key: %i[team_id location_id], inverse_of: :team_memberships
end

This enforces a TeamMembership to only be linked to Location that shares the same Team.

With that I should be able to create a test case that fails with the current code.

[Paul-Bob]

could I modify and add a relationship between these?

If it doesn't affect the current tests, you can. However, I believe there are some tests related to those models and associations. The safest approach would be to establish a new association between existing models or create new ones specifically for this use case.

[filipegiusti]

I had a hard time creating the tests so I solved the problem in another way. We don't have a need to support composite foreign keys in associations anymore.

[Paul-Bob]

Thanks for letting us know @filipegiusti

I'm closing this PR to keep the queue clean, we might get back to it and reopen if necessary.