Skip to content

Instantly share code, notes, and snippets.

@nz
Last active July 10, 2023 21:35
Show Gist options
  • Select an option

  • Save nz/1282013 to your computer and use it in GitHub Desktop.

Select an option

Save nz/1282013 to your computer and use it in GitHub Desktop.
Sunspot with Resque
# app/models/post.rb
class Post
searchable :auto_index => false, :auto_remove => false do
text :title
text :body
end
after_commit :resque_solr_update, :if => :persisted?
before_destroy :resque_solr_remove
protected
def resque_solr_update
Resque.enqueue(SolrUpdate, self.class.to_s, id)
end
def resque_solr_remove
Resque.enqueue(SolrRemove, self.class.to_s, id)
end
end
# lib/jobs/solr_update.rb
class SolrUpdate
@queue = :solr
def self.perform(classname, id)
classname.constantize.find(id).solr_index
end
end
# lib/jobs/solr_remove.rb
class SolrRemove
@queue = :solr
def self.perform(classname, id)
Sunspot.remove_by_id(classname, id)
end
end
@fred

fred commented Feb 20, 2012

Copy link
Copy Markdown

I did a minor change:

  protected
    def resque_solr_update
      Resque.enqueue(SolrUpdate, self, id)
    end
    def resque_solr_remove
      Resque.enqueue(SolrRemove, self, id)
    end

using the Model name cause stack level too deep, so I changed to self.

also, instead of putting the files in lib/jobs, I put in app/workers/
cheers.

@ilyakatz

Copy link
Copy Markdown

Nice snippet, I decided to use solr_index! this way it is easier to identify and rerun jobs from resque, perhaps with resque-web or anything else.

  def self.perform(klass, id)
    klass.find(id).solr_index!
  end

@nz

nz commented Mar 12, 2012

Copy link
Copy Markdown
Author

@ilyakatz: the solr_index! is just solr_index call plus a commit. I highly recommend not using this in production, as a big burst in commits could easily overwhelm your index and start throwing 503 errors. Better to omit commits entirely and use the autoCommit setting in your solrconfig.xml, especially since you're already accepting some index latency by queuing. Of course, imho, ymmv, etc :)

@ilyakatz

Copy link
Copy Markdown

@nz ah i see, ok, you convinced me :)

@ciaranlee

Copy link
Copy Markdown

We were also getting stack level too deep when we queued the job to resque, as it doesn't like serializing ActiveRecord classes. We now just use the string like so:

Resque.enqueue(SolrUpdate, self.class.to_s, id)

and then constantize it when we actually do the job like so:

class SolrUpdate
  @queue = :solr_update

  def self.perform(classname, id)
    classname.constantize.find(id).solr_index
  end

end

@nz

nz commented Apr 18, 2012

Copy link
Copy Markdown
Author

Sounds like I'll need to work on a more general solution of this. Thanks for sharing your version @ciaranlee that looks pretty good.

Would be happy to merge something like this into Sunspot proper. If any of you want to put that together, branch it off 1-3-stable and /cc me in the pull request.

@ciaranlee

Copy link
Copy Markdown

I'll try to do that over the next few days!

@gudleik

gudleik commented May 16, 2012

Copy link
Copy Markdown

When removing an index, the object might already be destroyed when the worker calls find.
You can use Sunspot.remove_by_id instead:

class SolrRemove
  @queue = :solr

  def self.perform(classname, id)
    Sunspot.remove_by_id classname, id
  end  

end

@nz

nz commented May 18, 2012

Copy link
Copy Markdown
Author

Good point, @gudleik, thanks! Updated.

@gaffneyc

Copy link
Copy Markdown

I just released a gem for doing just this called sunspot-queue (https://github.com/gaffneyc/sunspot-queue).

@semmin

semmin commented Sep 4, 2012

Copy link
Copy Markdown

Great snippet, just what I was looking for, thanks. However, Nick, when is the Sunspot.commit performed in this scenario?

@nz

nz commented Nov 7, 2012

Copy link
Copy Markdown
Author

@semmin, usually best to avoid issuing explicit commits and instead rely on your server's autoCommit setting in the solrconfig.xml.

@semmin

semmin commented Mar 31, 2013

Copy link
Copy Markdown

I had to modify line 10 as follows: after_commit :resque_solr_update, if: :persisted? since resque_solr_update was triggered on delete operations.

@nz

nz commented Apr 1, 2013

Copy link
Copy Markdown
Author

Thanks, @semmin!

@leoromanovsky

Copy link
Copy Markdown

What do you think of adding this at the end of the Resque jobs, for specs and local development to work somewhat serially?

unless Rails.env.production?
  Sunspot.commit
end

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