Aakash BakhleandGitHub
568aae875b
# Pull Request Template ## Description - Wires up Controllers to auto-sync job - adds plan based sync schedule - a scheduler that runs every hour to check syncable documents - guards the whole feature behind feature flag by reclaiming `twilio_content_templates` - Adds a global and account level cap on how many documents to enqueue to prevent sudden burst at first run - some refactor to simplify code - specs Fixes # (issue) ## Type of change - [x] New feature (non-breaking change which adds functionality) ## How Has This Been Tested? Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration. specs and locally ## Checklist: - [x] My code follows the style guidelines of this project - [x] I have performed a self-review of my code - [x] I have commented on my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [x] I have added tests that prove my fix is effective or that my feature works - [x] New and existing unit tests pass locally with my changes - [x] Any dependent changes have been merged and published in downstream modules
84 lines
2.1 KiB
Ruby
84 lines
2.1 KiB
Ruby
class Captain::Documents::SyncService
|
|
class PermanentSyncError < StandardError
|
|
end
|
|
|
|
class TransientSyncError < StandardError
|
|
end
|
|
|
|
PERMANENT_ERROR_CODES = %w[not_found access_denied content_empty].freeze
|
|
|
|
def initialize(document)
|
|
@document = document
|
|
end
|
|
|
|
def perform
|
|
@document.update!(sync_step: 'fetching')
|
|
result = Captain::Documents::SinglePageFetcher.new(@document.external_link).fetch
|
|
|
|
unless result.success
|
|
mark_failed(result.error_code)
|
|
raise_for_error_code(result.error_code)
|
|
end
|
|
|
|
@document.update!(sync_step: 'comparing')
|
|
new_fingerprint = compute_fingerprint(result.content)
|
|
previous_fingerprint = @document.content_fingerprint
|
|
|
|
if new_fingerprint == previous_fingerprint
|
|
mark_synced
|
|
return :unchanged
|
|
end
|
|
|
|
@document.update!(sync_step: 'updating')
|
|
update_content(result, new_fingerprint)
|
|
|
|
# Without a prior fingerprint we cannot tell a first-ever sync apart from a real
|
|
# change, so treat it as unchanged to keep downstream signals quiet on baseline.
|
|
previous_fingerprint.present? ? :updated : :unchanged
|
|
end
|
|
|
|
private
|
|
|
|
def compute_fingerprint(content)
|
|
Digest::SHA256.hexdigest(content.gsub(/\s+/, ' ').strip)
|
|
end
|
|
|
|
def mark_failed(error_code)
|
|
@document.update!(
|
|
sync_status: :failed,
|
|
sync_step: nil,
|
|
last_sync_error_code: error_code,
|
|
last_sync_attempted_at: Time.current
|
|
)
|
|
end
|
|
|
|
def mark_synced
|
|
@document.update!(
|
|
sync_status: :synced,
|
|
sync_step: nil,
|
|
last_synced_at: Time.current,
|
|
last_sync_attempted_at: Time.current,
|
|
last_sync_error_code: nil
|
|
)
|
|
end
|
|
|
|
def update_content(result, fingerprint)
|
|
@document.update!(
|
|
content: result.content,
|
|
name: result.title.presence || @document.name,
|
|
content_fingerprint: fingerprint,
|
|
sync_status: :synced,
|
|
sync_step: nil,
|
|
last_synced_at: Time.current,
|
|
last_sync_attempted_at: Time.current,
|
|
last_sync_error_code: nil
|
|
)
|
|
end
|
|
|
|
def raise_for_error_code(error_code)
|
|
raise PermanentSyncError, error_code if PERMANENT_ERROR_CODES.include?(error_code)
|
|
|
|
raise TransientSyncError, error_code
|
|
end
|
|
end
|