-
Notifications
You must be signed in to change notification settings - Fork 654
/
member.rb
496 lines (423 loc) · 16.8 KB
/
member.rb
1
2
3
4
5
6
7
8
9
10
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
49
50
51
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
83
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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
# encoding: utf-8
require 'virtus'
require_relative 'adapter'
require_relative '../../../services/importer/lib/importer'
require_relative '../visualization/collection'
require_relative '../../../services/importer/lib/importer/datasource_downloader'
require_relative '../../../services/datasources/lib/datasources'
require_relative '../log'
require_relative '../../../services/importer/lib/importer/unp'
require_relative '../../../services/importer/lib/importer/post_import_handler'
require_relative '../../../lib/cartodb/errors'
require_relative '../../../lib/cartodb/import_error_codes'
require_relative '../../../services/platform-limits/platform_limits'
include CartoDB::Datasources
module CartoDB
module Synchronization
class << self
attr_accessor :repository
end
class Member
include Virtus.model
MAX_RETRIES = 10
MIN_INTERVAL_SECONDS = 15 * 60
# Seconds required between manual sync now
SYNC_NOW_TIMESPAN = 900
STATE_CREATED = 'created'
# Already at resque, waiting for slot
STATE_QUEUED = 'queued'
# Actually syncing
STATE_SYNCING = 'syncing'
STATE_SUCCESS = 'success'
STATE_FAILURE = 'failure'
attribute :id, String
attribute :name, String
attribute :interval, Integer, default: 3600
attribute :url, String
attribute :state, String, default: STATE_CREATED
attribute :user_id, String
attribute :created_at, Time
attribute :updated_at, Time
attribute :run_at, Time
attribute :ran_at, Time
attribute :modified_at, Time
attribute :etag, String
attribute :checksum, String
attribute :log_id, String
attribute :error_code, Integer
attribute :error_message, String
attribute :retried_times, Integer, default: 0
attribute :service_name, String
attribute :service_item_id, String
attribute :type_guessing, Boolean, default: true
attribute :quoted_fields_guessing, Boolean, default: true
attribute :content_guessing, Boolean, default: false
def initialize(attributes={}, repository=Synchronization.repository)
super(attributes)
@log = nil
self.log_trace = nil
@repository = repository
self.id ||= @repository.next_id
self.state ||= STATE_CREATED
self.ran_at ||= Time.now
self.interval ||= 3600
self.run_at ||= Time.now + interval
self.retried_times ||= 0
self.log_id ||= log.id unless log.nil?
self.service_name ||= nil
self.service_item_id ||= nil
self.checksum ||= ''
raise InvalidInterval.new unless self.interval >= MIN_INTERVAL_SECONDS
end
def to_s
"<CartoDB::Synchronization::Member id:\"#{@id}\" name:\"#{@name}\" ran_at:\"#{@ran_at}\" run_at:\"#{@run_at}\" " \
"interval:\"#{@interval}\" state:\"#{@state}\" retried_times:\"#{@retried_times}\" log_id:\"#{log.id}\" " \
"service_name:\"#{@service_name}\" service_item_id:\"#{@service_item_id}\" checksum:\"#{@checksum}\" " \
"url:\"#{@url}\" error_code:\"#{@error_code}\" error_message:\"#{@error_message}\" modified_at:\"#{@modified_at}\" " \
" user_id:\"#{@user_id}\" type_guessing:\"#{@type_guessing}\" " \
"quoted_fields_guessing:\"#{@quoted_fields_guessing}\">"
end
def synchronizations_logger
@@synchronizations_logger ||= ::Logger.new("#{Rails.root}/log/synchronizations.log")
end
def interval=(seconds=3600)
super(seconds.to_i)
if seconds
self.run_at = Time.now + (seconds.to_i || 3600)
end
seconds
end
def store
raise CartoDB::InvalidMember unless self.valid?
set_timestamps
repository.store(id, attributes.to_hash)
self
end
def fetch
data = repository.fetch(id)
raise KeyError if data.nil?
self.attributes = data
self
end
def delete
repository.delete(id)
self.attributes.keys.each { |key| self.send("#{key}=", nil) }
self
end
def enqueue
Resque.enqueue(Resque::SynchronizationJobs, job_id: id)
self.state = CartoDB::Synchronization::Member::STATE_QUEUED
self.store
end
# @return bool
def can_manually_sync?
(self.state == STATE_SUCCESS || self.state == STATE_FAILURE) && (self.ran_at + SYNC_NOW_TIMESPAN < Time.now)
end
# @return bool
def should_auto_sync?
self.state == STATE_SUCCESS && (self.run_at < Time.now)
end
# This should be joined with data_import to stop the madness of duplicated code
def run
importer = nil
self.state = STATE_SYNCING
self.store
# First import is a "normal import" so still has no id, then run gets called and will get log first time
# but we need this to fix old logs
if log.nil?
@log = CartoDB::Log.new(type: CartoDB::Log::TYPE_SYNCHRONIZATION, user_id: user.id)
@log.save
self.log_id = @log.id
store
else
@log.clear
end
if user.nil?
raise "Couldn't instantiate synchronization user. Data: #{to_s}"
end
downloader = get_downloader
post_import_handler = CartoDB::Importer2::PostImportHandler.new
unless downloader.datasource.nil?
case downloader.datasource.class::DATASOURCE_NAME
when Url::ArcGIS::DATASOURCE_NAME
post_import_handler.add_fix_geometries_task
when Search::Twitter::DATASOURCE_NAME
post_import_handler.add_transform_geojson_geom_column
end
end
runner = CartoDB::Importer2::Runner.new({
pg: pg_options,
downloader: downloader,
log: log,
user: user,
unpacker: CartoDB::Importer2::Unp.new,
post_import_handler: post_import_handler
})
runner.loader_options = ogr2ogr_options.merge content_guessing_options
runner.include_additional_errors_mapping(
{
AuthError => 1011,
DataDownloadError => 1011,
TokenExpiredOrInvalidError => 1012,
DatasourceBaseError => 1012,
InvalidServiceError => 1012,
MissingConfigurationError => 1012,
UninitializedError => 1012
}
)
database = user.in_database
importer = CartoDB::Synchronization::Adapter.new(name, runner, database, user)
importer.run
self.ran_at = Time.now
self.run_at = Time.now + interval
if importer.success?
set_success_state_from(importer)
else
set_failure_state_from(importer)
end
store
notify
rescue => exception
Rollbar.report_exception(exception)
log.append exception.message
log.append exception.backtrace.join('\n')
if importer.nil?
if exception.kind_of?(NotFoundDownloadError)
set_general_failure_state_from(exception, 1017, 'File not found, you must import it again')
elsif exception.kind_of?(CartoDB::Importer2::FileTooBigError)
set_general_failure_state_from(exception, exception.error_code,
CartoDB::IMPORTER_ERROR_CODES[exception.error_code][:title])
else
set_general_failure_state_from(exception)
end
else
set_failure_state_from(importer)
end
store
if exception.kind_of?(TokenExpiredOrInvalidError)
begin
user.oauths.remove(exception.service_name)
rescue => ex
log.append "Exception removing OAuth: #{ex.message}"
log.append ex.backtrace
end
end
notify
self
end
def notify
sync_log = {
'name' => self.name,
'sync_time' => self.updated_at - self.created_at,
'sync_timestamp' => Time.now,
'user' => user.username,
'queue_server' => `hostname`.strip,
'resque_ppid' => Process.ppid,
'state' => self.state,
'user_timeout' => ::DataImport.http_timeout_for(user)
}
synchronizations_logger.info(sync_log.to_json)
end
def get_downloader
datasource_name = (service_name.nil? || service_name.size == 0) ? Url::PublicUrl::DATASOURCE_NAME : service_name
if service_item_id.nil? || service_item_id.size == 0
self.service_item_id = url
end
datasource_provider = get_datasource(datasource_name)
if datasource_provider.nil?
raise CartoDB::DataSourceError.new("Datasource #{datasource_name} could not be instantiated")
end
if service_item_id.nil?
raise CartoDB::DataSourceError.new("Datasource #{datasource_name} without item id")
end
log.append "Fetching datasource #{datasource_provider.to_s} metadata for item id #{service_item_id} from user #{user.id}"
metadata = datasource_provider.get_resource_metadata(service_item_id)
if hit_platform_limit?(datasource_provider, metadata, user)
raise CartoDB::Importer2::FileTooBigError.new(metadata.inspect)
end
if datasource_provider.providers_download_url?
resource_url = (metadata[:url].present? && datasource_provider.providers_download_url?) ? metadata[:url] : url
if resource_url.nil?
raise CartoDB::DataSourceError.new("Missing resource URL to download. Data:#{to_s}" )
end
downloader = CartoDB::Importer2::Downloader.new(
resource_url,
{
http_timeout: DataImport.http_timeout_for(user),
etag: etag,
last_modified: modified_at,
checksum: checksum,
verify_ssl_cert: false
}
)
log.append "File will be downloaded from #{downloader.url}"
else
log.append 'Downloading file data from datasource'
downloader = CartoDB::Importer2::DatasourceDownloader.new(
datasource_provider, metadata,
{
http_timeout: DataImport.http_timeout_for(user),
checksum: checksum
}, log
)
end
downloader
end
def hit_platform_limit?(datasource, metadata, user)
if datasource.has_resource_size?(metadata)
CartoDB::PlatformLimits::Importer::InputFileSize.new({ user: user })
.is_over_limit!(metadata[:size])
else
false
end
end
def set_success_state_from(importer)
log.append '******** synchronization succeeded ********'
self.log_trace = importer.runner_log_trace
self.state = STATE_SUCCESS
self.etag = importer.etag
self.checksum = importer.checksum
self.error_code = nil
self.error_message = nil
self.retried_times = 0
self.run_at = Time.now + interval
self.modified_at = importer.last_modified
geocode_table
rescue
self
end
def set_failure_state_from(importer)
log.append '******** synchronization failed ********'
self.log_trace = importer.runner_log_trace
log.append "*** Runner log: #{self.log_trace} \n***" unless self.log_trace.nil?
self.state = STATE_FAILURE
self.error_code = importer.error_code
self.error_message = importer.error_message
# Try to fill empty messages with the list
if self.error_message == '' && !self.error_code.nil?
default_message = CartoDB::IMPORTER_ERROR_CODES.fetch(self.error_code, {})
self.error_message = default_message.fetch(:title, '')
end
self.retried_times = self.retried_times + 1
if self.retried_times < MAX_RETRIES
self.run_at = Time.now + interval
end
end
def set_general_failure_state_from(exception, error_code = 99999, error_message = 'Unknown error, please try again')
log.append '******** synchronization raised exception ********'
self.log_trace = exception.message + ' ' + exception.backtrace.join("\n")
self.state = STATE_FAILURE
self.error_code = error_code
self.error_message = error_message
self.retried_times = self.retried_times + 1
if self.retried_times < MAX_RETRIES
self.run_at = Time.now + interval
end
rescue => e
Rollbar.report_exception(e)
end
# Tries to run automatic geocoding if present
def geocode_table
return unless table && table.automatic_geocoding
log.append 'Running automatic geocoding...'
table.automatic_geocoding.run
rescue => e
log.append "Error while running automatic geocoding: #{e.message}"
end # geocode_table
def to_hash
attributes.to_hash
end
def to_json(*args)
attributes.to_json(*args)
end
def valid?
true
end
def set_timestamps
self.created_at ||= Time.now
self.updated_at = Time.now
self
end
def user
@user ||= User.where(id: user_id).first
end
def table
return nil unless defined?(::Table)
if @table.nil?
@table = ::Table.get_by_id_or_name(name, user)
end
@table
end # table
def authorize?(user)
user.id == user_id && !!user.sync_tables_enabled
end
def pg_options
Rails.configuration.database_configuration[Rails.env].symbolize_keys
.merge(
user: user.database_username,
password: user.database_password,
database: user.database_name,
host: user.user_database_host
)
end
def ogr2ogr_options
options = Cartodb.config.fetch(:ogr2ogr, {})
if options['binary'].nil? || options['csv_guessing'].nil?
{}
else
{
ogr2ogr_binary: options['binary'],
ogr2ogr_csv_guessing: options['csv_guessing'] && @type_guessing,
quoted_fields_guessing: @quoted_fields_guessing
}
end
end
# TODO code duplicated from data_import.rb, refactor
def content_guessing_options
guessing_config = Cartodb.config.fetch(:importer, {}).deep_symbolize_keys.fetch(:content_guessing, {})
geocoder_config = Cartodb.config.fetch(:geocoder, {}).deep_symbolize_keys
if guessing_config[:enabled] and self.content_guessing and geocoder_config
{ guessing: guessing_config, geocoder: geocoder_config }
else
{ guessing: { enabled: false } }
end
end
def log
return @log unless @log.nil?
log_attributes = {
type: CartoDB::Log::TYPE_SYNCHRONIZATION,
id: self.log_id
}
log_attributes.merge(user_id: user.id) if user
@log = CartoDB::Log.where(log_attributes).first
end
def valid_uuid?(text)
!!UUIDTools::UUID.parse(text)
rescue TypeError
false
rescue ArgumentError
false
end
# @return mixed|nil
def get_datasource(datasource_name)
begin
datasource = DatasourcesFactory.get_datasource(datasource_name, user, {
http_timeout: ::DataImport.http_timeout_for(user)
})
datasource.report_component = Rollbar
if datasource.kind_of? BaseOAuth
oauth = user.oauths.select(datasource_name)
datasource.token = oauth.token unless oauth.nil?
end
rescue => ex
log.append "Exception: #{ex.message}"
log.append ex.backtrace
datasource = nil
end
datasource
end
attr_reader :repository
attr_accessor :log_trace, :service_name, :service_item_id
end
end
end