This project is archived and is in readonly mode.

belongs_to with :primary_key does not work with find's :include

#3208

Since 2.3.3 Rails supports both :foreign_key and :primary_key for belongs_to association.
Using both (or only :primary_key) works great for simple instance.owner.
However, when using Owned.find(..., :include => [:owner]) the owner gets joined using it's ID (model's own primary key) column instead of the :primary_key defined within Owned's (which is the expected behaviour) belongs_to :owner association.

Thus
owned.owner yields different results based on whether owned was pulled using Owned.find(id, :include => [:owner]) or Owned.find(id) (and of course .owner gets pulled when owned.owner gets called in the view).

It was pretty hard to stumble upon this error, as one needs to have some overlapping values in both columns. In our case it was
regions table has column "zip" (5-digit numbers)
users table has column "postal_code", User belongs_to(:region, :foreign_key => :postal_code, :primary_key => :zip)
It turned out that when using @user=User.find(id, :include => [:region]) the region was joined using regions.id instead of regions.zip:

SELECT "users".* FROM "users" LEFT OUTER JOIN "regions" ON "regions".id = "users".postal_code WHERE ("users"."id" = 1))

Reported by Tomash · September 15th, 2009 @ 11:01 AM

Activity

CancelProfileIsBroken
- Tag changed from 2.3.3, :include, associations, belongs_to to 2.3.3, :include, associations, belongs_to, bugmash
September 25th, 2009 @ 12:09 PM
Matt Mitchell
I'm uploading a patch here. The JoinAssociation.associtation_join method now first checks for the reflection.options[:primary_key] and then defaults to reflection.klass.primary_key if the option is missing. This is my first patch so please let me know if this isn't the way to do it.
- belongs_to_primary_key_lazy_load.patch 1.19 KB
September 29th, 2009 @ 07:07 PM
Deleted User
- Tag changed from 2.3.3, :include, associations, belongs_to, bugmash to 2, :include, associations, belongs_to, bugmash
I'm using Rails 2.3.4, and I'm seeing this behaviour too.

December 15th, 2009 @ 08:24 AM
Yaroslav Markin
- Assigned user set to Frederick Cheung
Rails 2.3.5, before the patch I was having horrible problems with ThinkingSphinx indexing belongs_to association with :primary_key. Applied it, works just fine.

February 11th, 2010 @ 12:44 PM
Alexey Nayden
The bug confirmed at 2.3.5. However patch works fine.

February 11th, 2010 @ 12:47 PM
Rizwan Reza
- Tag changed from 2, :include, associations, belongs_to, bugmash to 2, :include, associations, belongs_to
[bulk edit]

February 12th, 2010 @ 12:46 PM
humanzz
I just stumbled upon this bug in Rails 2.3.5 too :(

April 12th, 2010 @ 04:17 PM
Yaroslav Markin
- Tag changed from 2, :include, associations, belongs_to to 2, :include, activerecord, associations, belongs_to, bug, patch
- Assigned user changed from Frederick Cheung to José Valim
Requesting committer attention :)

April 12th, 2010 @ 04:20 PM
Jeremy Kemper
- Milestone set to 2.3.6
- State changed from new to incomplete
Needs a test.

April 24th, 2010 @ 10:27 PM
José Valim
- Assigned user changed from José Valim to Jeremy Kemper
April 29th, 2010 @ 11:53 AM
Jeremy Kemper
Still pending tests.

April 29th, 2010 @ 04:56 PM
José Valim
- Tag changed from 2, :include, activerecord, associations, belongs_to, bug, patch to 2, :include, activerecord, associations, belongs_to, bug, bugmash, patch
April 30th, 2010 @ 03:17 PM
Łukasz Strzałkowski
Jeremy, isn't that fixed and tested with this commit?

http://github.com/rails/rails/commit/00b95eb265ff606ae0a7b650265aa3...

Personally I think the test is week.

May 5th, 2010 @ 07:38 PM
Jeremy Kemper
Definitely needs a better test.

May 5th, 2010 @ 08:08 PM
Ernie Miller
I'll cook something better up.

May 5th, 2010 @ 08:35 PM
Łukasz Strzałkowski
Quick one
- better_test.patch 1.16 KB
May 5th, 2010 @ 09:17 PM
Ernie Miller
Updated tests for 2-3-stable and master
- belongs_to_primary_key_test_master.diff 1.22 KB
- belongs_to_primary_key_test_2-3-stable.diff 1.21 KB
May 5th, 2010 @ 09:54 PM
Ernie Miller
- Tag changed from 2, :include, activerecord, associations, belongs_to, bug, bugmash, patch to 2, :include, activerecord, associations, belongs_to, bug, bugmash, patch, tests
May 5th, 2010 @ 11:35 PM
Rizwan Reza
[bulk edit]

May 16th, 2010 @ 02:41 AM
HBpencil
- Assigned user cleared.
try this

class Region
set_primary_key :zip end

May 16th, 2010 @ 07:12 AM

HBpencil

try this

class Region
  set_primary_key :zip 
end

May 16th, 2010 @ 07:13 AM

Anil Wadghule
+1

Verified both patches of tests on rails 3 master and 2-3 stable. HBpencil what are you trying to say? If possible more tests would be good.

May 16th, 2010 @ 12:24 PM
Rizwan Reza
- Tag changed from 2, :include, activerecord, associations, belongs_to, bug, bugmash, patch, tests to 2, :include, activerecord, associations, belongs_to, bug, bugmash-review, patch, tests
- State changed from incomplete to verified
May 16th, 2010 @ 04:59 PM
Jeremy Kemper
- Milestone changed from 2.3.6 to 2.3.7
[bulk edit]

May 23rd, 2010 @ 05:54 PM
Jeremy Kemper
- Milestone changed from 2.3.7 to 2.3.8
[bulk edit]

May 24th, 2010 @ 09:40 AM
Jeremy Kemper
- Milestone changed from 2.3.8 to 2.3.9
[bulk edit]

May 25th, 2010 @ 11:45 PM
Łukasz Strzałkowski
- Importance changed from to Medium
This ticket actually can be closed. It's duplicate of #765 PATCH: primary_key option for belongs_to

and this is solved by this commit: http://github.com/rails/rails/commit/63026541b209cc11ffd74cf3ca04b8...

June 28th, 2010 @ 06:58 PM
José Valim
- State changed from verified to duplicate
Awesome, thanks!

June 28th, 2010 @ 06:59 PM
Andrea Campi
- Tag changed from 2, :include, activerecord, associations, belongs_to, bug, bugmash-review, patch, tests to 2-3-stable, :include, activerecord, associations, belongs_to, bug, bugmash-review, patch, tests
October 16th, 2010 @ 11:40 PM