Class: Triannon::SolrWriter

Inherits:
Object
  • Object
show all
Defined in:
app/services/triannon/solr_writer.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ SolrWriter

Returns a new instance of SolrWriter.



52
53
54
55
56
57
58
 
# File 'app/services/triannon/solr_writer.rb', line 52

def initialize
  @rsolr_client = RSolr.connect :url => Triannon.config[:solr_url]
  @logger = Rails.logger
  @max_retries = Triannon.config[:max_solr_retries] || 5
  @base_sleep_seconds = Triannon.config[:base_sleep_seconds] || 1
  @max_sleep_seconds = Triannon.config[:max_sleep_seconds] || 5
end

Instance Attribute Details

#rsolr_client ⇒ Object

Returns the value of attribute rsolr_client.



50
51
52
 
# File 'app/services/triannon/solr_writer.rb', line 50

def rsolr_client
  @rsolr_client
end

Class Method Details

.solr_hash(triannon_graph) ⇒ Hash

DO NOT CALL before anno is stored: the graph should have an assigned url for the

@id of the root;  it shouldn't be a blank node

Convert a OA::Graph object into a Hash suitable for writing to Solr.

Parameters:

  • triannon_graph (OA::Graph) —

    a populated OA::Graph object for a stored anno

Returns:

  • (Hash) —

    a hash to be written to Solr, populated appropriately



11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'app/services/triannon/solr_writer.rb', line 11

def self.solr_hash(triannon_graph)
  doc_hash = {}
  triannon_id = triannon_graph.id_as_url
  if triannon_id
    # chars in Solr/Lucene query syntax are a big pain in Solr id fields, so we only use
    # the uuid portion of the Triannon anno id, not the full url
    solr_id = triannon_id.sub(Triannon.config[:triannon_base_url], "")
    doc_hash[:id] = solr_id.sub(/^\/*/, "") # remove first char slash(es) if present

    # use short strings for motivation field
    doc_hash[:motivation] = triannon_graph.motivated_by.map { |m| m.sub(RDF::Vocab::OA.to_s, "") }

    # date field format: 1995-12-31T23:59:59Z; or w fractional seconds: 1995-12-31T23:59:59.999Z
    if triannon_graph.annotated_at
      begin
        dt = Time.parse(triannon_graph.annotated_at)
        doc_hash[:annotated_at] = dt.iso8601 if dt
      rescue ArgumentError
        # ignore invalid datestamps
      end
    end
    #doc_hash[:annotated_by_stem] # not yet implemented

    doc_hash[:target_url] = triannon_graph.predicate_urls RDF::Vocab::OA.hasTarget
    # TODO: recognize more target types
    doc_hash[:target_type] = ['external_URI'] if doc_hash[:target_url].size > 0

    doc_hash[:body_url] = triannon_graph.predicate_urls RDF::Vocab::OA.hasBody
    doc_hash[:body_type] = []
    doc_hash[:body_type] << 'external_URI' if doc_hash[:body_url].size > 0
    doc_hash[:body_chars_exact] = triannon_graph.body_chars.map {|bc| bc.strip}
    doc_hash[:body_type] << 'content_as_text' if doc_hash[:body_chars_exact].size > 0
    doc_hash[:body_type] << 'no_body' if doc_hash[:body_type].size == 0

    doc_hash[:anno_jsonld] = triannon_graph.jsonld_oa
  end
  doc_hash
end

Instance Method Details

#add(doc) ⇒ Object

Add the document to Solr, retrying if an error occurs. See github.com/ooyala/retries for info on with_retries.

Parameters:

  • doc (Hash) —

    a Hash representation of the Solr document to be added



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'app/services/triannon/solr_writer.rb', line 71

def add(doc)
  id = doc[:id]

  handler = Proc.new do |exception, attempt_cnt, total_delay|
    @logger.debug "#{exception.inspect} on Solr add attempt #{attempt_cnt} for #{id}"
    if exception.kind_of?(RSolr::Error::Http)
      # Note there are extra shenanigans b/c RSolr hijacks the Solr error to return RSolr Error
      fail Triannon::SearchError.new("error adding doc #{id} to Solr #{doc.inspect}; #{exception.message}", exception.response[:status], exception.response[:body])
    elsif exception.kind_of?(StandardError)
      fail Triannon::SearchError.new("error adding doc #{id} to Solr #{doc.inspect}; #{exception.message}")
    end
  end

  with_retries(:handler => handler,
                :max_tries => @max_retries,
                :base_sleep_seconds => @base_sleep_seconds,
                :max_sleep_seconds => @max_sleep_seconds) do |attempt|
    @logger.debug "Solr add attempt #{attempt} for #{id}"
    # add it and commit within 0.5 seconds
    @rsolr_client.add(doc, :add_attributes => {:commitWithin => 500})
    #  RSolr throws RSolr::Error::Http for any Solr response without status 200 or 302
    @logger.info "Successfully indexed #{id} to Solr on attempt #{attempt}"
  end
end

#delete(id) ⇒ Object

Delete the document from Solr, retrying if an error occurs. See github.com/ooyala/retries for info on with_retries.

Parameters:

  • id (String) —

    the id of the Solr document to be deleted



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'app/services/triannon/solr_writer.rb', line 99

def delete(id)
  handler = Proc.new do |exception, attempt_cnt, total_delay|
    @logger.debug "#{exception.inspect} on Solr delete attempt #{attempt_cnt} for #{id}"
    if exception.kind_of?(RSolr::Error::Http)
      # Note there are extra shenanigans b/c RSolr hijacks the Solr error to return RSolr Error
      fail Triannon::SearchError.new("error deleting doc #{id} from Solr: #{exception.message}", exception.response[:status], exception.response[:body])
    elsif exception.kind_of?(StandardError)
      fail Triannon::SearchError.new("error deleting doc #{id} from Solr: #{exception.message}")
    end
  end

  with_retries(:handler => handler,
                :max_tries => @max_retries,
                :base_sleep_seconds => @base_sleep_seconds,
                :max_sleep_seconds => @max_sleep_seconds) do |attempt|
    @logger.debug "Solr delete attempt #{attempt} for #{id}"
    #  RSolr throws RSolr::Error::Http for any Solr response without status 200 or 302
    @rsolr_client.delete_by_id(id)
    @rsolr_client.commit
    @logger.info "Successfully deleted #{id} from Solr"
  end
end

#write(tgraph) ⇒ Object

Convert the OA::Graph to a Solr document hash, then call RSolr.add

with the doc hash

Parameters:

  • tgraph (OA::Graph) —

    anno represented as a OA::Graph



63
64
65
66
 
# File 'app/services/triannon/solr_writer.rb', line 63

def write(tgraph)
  doc_hash = self.class.solr_hash(tgraph) if tgraph && !tgraph.id_as_url.empty?
  add(doc_hash) if doc_hash && !doc_hash.empty?
end