Skip to content
This repository

test case to illustrate callbacks definitions and HABTM association are order dependent #8674

Closed
wants to merge 1 commit into from

5 participants

Yves Senn Jon Leighton Ezekiel Smithburg Jon Rowe Andrew White
Yves Senn
Collaborator

WIP

The source issue is: #8672

This PR is only a failing test case as I am not completely sure how to tackle the problem.

I investigated and can confirm that the order in which after_create and has_and_belongs_to_many associations are defined does impact the functionality.

If the callback is defined before the association every HABTM record created inside the callback will be inserted twice. The reason is AutosaveAssociation#save_collection_association. It will pick up the already created records and save them again. This happens because @new_record_before_save will be true and since it's an after_create callback, the associations are inserted directly with <<.

My test case results in the following failure:

  1) Failure:
test_after_create_before_habtm_definition(HasAndBelongsToManyAssociationsTest) [test/cases/associations/has_and_belongs_to_many_associations_test.rb:616]:
Expected: 1
  Actual: 2
Yves Senn
Collaborator

@jonleighton @rafaelfranca is it known and expected that HABTM associations and callbacks are order dependent? If this is the expected behavior, feel free to close. Otherwise we should look for a possible solution.

Jon Leighton
Owner

Definitely looks like unexpected behaviour to me.

Ezekiel Smithburg

No clue if I can squash this or not, but I'm starting to investigate. I'll update in here with whatever I find, at the least.

Jon Rowe

Was any progress made on this?

Ezekiel Smithburg

I'll try to spend a little more time on it tonight, but no promises if I'll get anywhere. I was just trying to figure it out when I had to give up on it last time.

Ezekiel Smithburg

Status update: spent hours learning all the surrounding code, figured out that @senny is right on the money. No idea for a fix yet, but I'll give that a stab tomorrow.

Yves Senn
Collaborator
senny commented

I was thinking about this issue lately and it could be a tricky one to solve. Let me know if you find an angle.

Andrew White
Owner

@senny the problem is that AutosaveAssociation is using the public callback API to implement its functionality which means that it's subject to the definition order. There used to be a lot of these problems but most of them went away when @jonleighton refactored the association code.

The belongs_to :foo, :touch => true code is also using the callbacks api so that may be definition order dependent as well.

Ezekiel Smithburg

I basically came to the same conclusion as @pixeltrix. I think the best solution is to have separate callback chains for these purposes. Here's why:

  1. If we try to make save_collection_association smart enough to handle this situation, it'll be really ugly. The hack is certainly possible, but it's inexcusably ugly.
  2. If we try to force the right ordering by some sort of special case, that doesn't help at all in solving other instances where there might be problems of this sort.

The downsides I can see:

  1. By default, all callback chains are publicly exposed. If people start using the callback chains we add in their code, these sorts of problems could happen again. Then it turns into a sort of arms race for which callback chain is REALLY first or last.
  2. Aside from the public use scenario, in general proliferation of callback chains inside the same callback management code seems inelegant to me.

One final alternative that presents itself to me is to have an entirely separate, not publicly exposed, set of callback chains. Of course, this could be enforced more by code (of course, anyone can actually access them if they really want) or more by convention (documented as "don't touch unless you really know what you're doing"). A "separate set" is flexible concept, of course, so it could mean separate objects managing it, or a conceptually distinct set, managed by the same code, but distinct by convention.

I'm working on the separate by convention approach right now to see how the code turns out. If everyone is radically opposed to that, I'll stop and move on to something else.

Yves Senn
Collaborator
senny commented

I'm closing this one as it is just a test-case without a fix. It will remain linked in the issue.

Yves Senn senny closed this
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Showing 1 unique commit by 1 author.

Jan 01, 2013
Yves Senn senny test case to illustrate order dependent callbacks 4e0c79e
This page is out of date. Refresh to see the latest.
24 activerecord/test/cases/associations/has_and_belongs_to_many_associations_test.rb
@@ -38,6 +38,23 @@ def add_david
38 38 end
39 39 end
40 40
  41 +class ProjectWithAfterCreateHookBeforeHABTM < ActiveRecord::Base
  42 + self.table_name = 'projects'
  43 +
  44 + after_create :add_david
  45 +
  46 + has_and_belongs_to_many :custom_developers,
  47 + :class_name => "DeveloperForProjectWithAfterCreateHook",
  48 + :join_table => "developers_projects",
  49 + :foreign_key => "project_id",
  50 + :association_foreign_key => "developer_id"
  51 +
  52 + def add_david
  53 + david = DeveloperForProjectWithAfterCreateHook.find_by_name('David')
  54 + custom_developers << david
  55 + end
  56 +end
  57 +
41 58 class DeveloperForProjectWithAfterCreateHook < ActiveRecord::Base
42 59 self.table_name = 'developers'
43 60 has_and_belongs_to_many :projects,
@@ -592,6 +609,13 @@ def test_new_with_values_in_collection
592 609 assert project.developers.include?(david)
593 610 end
594 611
  612 + def test_after_create_before_habtm_definition
  613 + project = ProjectWithAfterCreateHookBeforeHABTM.create! :name => 'Getting things done'
  614 + project.save!
  615 +
  616 + assert_equal 1, project.custom_developers.count
  617 + end
  618 +
595 619 def test_find_in_association_with_options
596 620 developers = projects(:active_record).developers.to_a
597 621 assert_equal 3, developers.size

Tip: You can add notes to lines in a file. Hover to the left of a line to make a note

Something went wrong with that request. Please try again.