Module: NetSuiteRails::RecordSync::PollManager

Extended by:
PollManager
Included in:
PollManager
Defined in:
lib/netsuite_rails/record_sync/poll_manager.rb

Instance Method Summary collapse

Instance Method Details

#extract_advanced_search_criteria(criteria_option) ⇒ Object 



138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/netsuite_rails/record_sync/poll_manager.rb', line 138

def extract_advanced_search_criteria(criteria_option)
  if criteria_option.is_a?(Hash)
    criteria_option = criteria_option.dup
    criteria_option.delete(:basic)

    criteria_option
  elsif criteria_option.is_a?(Array) || criteria_option.nil?
    {}
  else
    # TODO unhandled criteria type
  end
end

#extract_basic_search_criteria(criteria_option) ⇒ Object 



151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/netsuite_rails/record_sync/poll_manager.rb', line 151

def extract_basic_search_criteria(criteria_option)
  # TODO use `kind_of?` instead?

  if criteria_option.is_a?(Hash)
    criteria_option[:basic] || []
  elsif criteria_option.is_a?(Array)
    criteria_option
  else
    # TODO unhandled criteria class
  end
end

#extract_custom_field_value(custom_field_value) ⇒ Object

TODO this should remain in the pull manager



232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/netsuite_rails/record_sync/poll_manager.rb', line 232

def extract_custom_field_value(custom_field_value)
  if custom_field_value.present? && custom_field_value.is_a?(Hash) && custom_field_value.has_key?(:name)
    custom_field_value = custom_field_value[:name]
  end

  if custom_field_value.present? && custom_field_value.is_a?(NetSuite::Records::CustomRecordRef)
    custom_field_value = custom_field_value.attributes[:name]
  end

  custom_field_value
end

#needs_get_list?(opts) ⇒ Boolean

Returns:

  • (Boolean) 


225
226
227
228
 
# File 'lib/netsuite_rails/record_sync/poll_manager.rb', line 225

def needs_get_list?(opts)
  (opts[:saved_search_id].present? && opts[:full_record_data] != false) ||
  opts[:full_record_data] == true
end

#poll(klass, opts = {}) ⇒ Object 



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/netsuite_rails/record_sync/poll_manager.rb', line 31

def poll(klass, opts = {})
  opts = {
    import_all: false,
  }.merge(opts)

  opts[:netsuite_record_class] ||= klass.netsuite_record_class
  opts[:netsuite_custom_record_type_id] ||= klass.netsuite_custom_record_type_id if opts[:netsuite_record_class] == NetSuite::Records::CustomRecord
  opts[:saved_search_id] ||= klass.netsuite_sync_options[:saved_search_id]

  search = opts[:netsuite_record_class].search(
    poll_criteria(klass, opts)
  )

  # TODO more robust error reporting
  unless search
    raise "NetSuite: #{klass}. Error running NS search. Most likely a search timeout."
  end

  process_search_results(klass, opts, search)
end

#poll_basic_criteria(klass, opts) ⇒ Object 



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/netsuite_rails/record_sync/poll_manager.rb', line 84

def poll_basic_criteria(klass, opts)
  opts = {
    criteria: [],
    # last_poll: DateTime
  }.merge(opts)

  # allow custom criteria to be passed directly to the sync call
  criteria = extract_basic_search_criteria(opts[:criteria])

  # allow custom criteria from the model level
  criteria += klass.netsuite_sync_options[:criteria] || []

  if opts[:netsuite_record_class] == NetSuite::Records::CustomRecord
    opts[:netsuite_custom_record_type_id] ||= klass.netsuite_custom_record_type_id

    criteria << {
      field: 'recType',
      operator: 'is',
      value: NetSuite::Records::CustomRecordRef.new(internal_id: opts[:netsuite_custom_record_type_id])
    }
  end

  # CustomRecordSearchBasic uses lastModified instead of the standard lastModifiedDate
  opts[:netsuite_poll_field] ||= (klass.netsuite_custom_record?) ? 'lastModified' : 'lastModifiedDate'

  # TODO investigate if defining a date range for `import_all` increases peformance

  unless opts[:import_all]
    if opts[:updated_before].present?
      criteria << {
        field: opts[:netsuite_poll_field],
        operator: 'within',
        type: 'SearchDateField',
        value: [
          opts[:last_poll],
          opts[:updated_before]
        ]
      }
    else
      criteria << {
        field: opts[:netsuite_poll_field],
        operator: 'after',
        value: opts[:last_poll]
      }
    end
  end

  criteria
end

#poll_criteria(klass, opts) ⇒ Object 



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/netsuite_rails/record_sync/poll_manager.rb', line 52

def poll_criteria(klass, opts)
  opts[:body_fields_only] ||= false
  opts[:page_size] ||= NetSuiteRails::Configuration.polling_page_size

  search_criteria = {
    criteria: {
      basic: poll_basic_criteria(klass, opts)
    }.merge(poll_join_criteria(klass, opts))
  }

  if opts[:saved_search_id]
    search_criteria[:criteria][:saved] = opts[:saved_search_id]
  end

  if needs_get_list?(opts)
    search_criteria[:columns] = {
      'listRel:basic' => [
        'platformCommon:internalId/' => {},
      ],
    }
  end

  search_criteria.merge!({
    preferences: {
      body_fields_only: opts[:body_fields_only],
      page_size: opts[:page_size]
    }
  })

  search_criteria
end

#poll_join_criteria(klass, opts) ⇒ Object 



134
135
136
 
# File 'lib/netsuite_rails/record_sync/poll_manager.rb', line 134

def poll_join_criteria(klass, opts)
  extract_advanced_search_criteria(opts[:criteria])
end

#process_search_result_item(klass, opts, netsuite_record) ⇒ Object 



210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/netsuite_rails/record_sync/poll_manager.rb', line 210

def process_search_result_item(klass, opts, netsuite_record)
  local_record = klass.where(netsuite_id: netsuite_record.internal_id).first_or_initialize

  # when importing lots of records during an import_all skipping imported records is important
  return if opts[:skip_existing] == true && !local_record.new_record?

  local_record.netsuite_extract_from_record(netsuite_record)

  # TODO optionally throw fatal errors; we want to skip fatal errors on intial import

  unless local_record.save
    Rails.logger.error "NetSuite: Error pulling record #{klass} NS ID #{netsuite_record.internal_id} #{local_record.errors.full_messages}"
  end
end

#process_search_results(klass, opts, search) ⇒ Object 



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/netsuite_rails/record_sync/poll_manager.rb', line 163

def process_search_results(klass, opts, search)
  opts = {
    skip_existing: false,
    full_record_data: -1,
  }.merge(opts)

  # TODO need to improve the conditional here to match the get_list call conditional belo
  if opts[:import_all] && opts[:skip_existing]
    synced_netsuite_list = klass.pluck(:netsuite_id)
  end

  search.results_in_batches do |batch|
    Rails.logger.info "NetSuite: Syncing #{klass}. Current Page: #{search.current_page}. Processing #{search.total_records} over #{search.total_pages} pages."

    # a saved search is processed as a advanced search; advanced search often does not allow you to retrieve
    # all of the fields (ex: addressbooklist on customer) that a normal search does
    # the only way to get those fields is to pull down the full record again using getAll

    if needs_get_list?(opts)
      filtered_netsuite_id_list = batch.map(&:internal_id).map(&:to_i)

      if opts[:skip_existing] == true
        filtered_netsuite_id_list.reject! { |netsuite_id| synced_netsuite_list.include?(netsuite_id) }
      end

      if filtered_netsuite_id_list.present?
        Rails.logger.info "NetSuite: Syncing #{klass}. Running get_list for #{filtered_netsuite_id_list.length} records"

        if opts[:netsuite_record_class] == NetSuite::Records::CustomRecord
          NetSuite::Records::CustomRecord.get_list(
            list: filtered_netsuite_id_list,
            type_id: opts[:netsuite_custom_record_type_id]
          )
        else
          opts[:netsuite_record_class].get_list(list: filtered_netsuite_id_list)
        end
      else
        []
      end
    else
      batch
    end.each do |netsuite_record|
      self.process_search_result_item(klass, opts, netsuite_record)
    end
  end
end

#update_local_records(klass, opts = {}) ⇒ Object 



6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/netsuite_rails/record_sync/poll_manager.rb', line 6

def update_local_records(klass, opts = {})
  klass.select([:netsuite_id, :id]).find_in_batches(batch_size: NetSuiteRails::Configuration.polling_page_size) do |local_batch|
    netsuite_batch = if klass.netsuite_custom_record?
      NetSuite::Records::CustomRecord.get_list(
        list: local_batch.map(&:netsuite_id),
        type_id: klass.netsuite_custom_record_type_id,
        allow_incomplete: true
      )
    else
      klass.netsuite_record_class.get_list(
        list: local_batch.map(&:netsuite_id),
        allow_incomplete: true
      )
    end

    unless netsuite_batch
      raise "NetSuite: #{klass}. Error running NS search. No Netsuite batch found. Most likely a search timeout."
    end

    netsuite_batch.each do |netsuite_record|
      self.process_search_result_item(klass, opts, netsuite_record)
    end
  end
end