2018-10-26 04:12:43 +00:00
|
|
|
# frozen_string_literal: true
|
|
|
|
|
2017-04-04 09:44:25 +00:00
|
|
|
module Gitlab
|
|
|
|
module Ci
|
|
|
|
class CronParser
|
2019-08-31 19:25:25 +00:00
|
|
|
VALID_SYNTAX_SAMPLE_TIME_ZONE = 'UTC'
|
|
|
|
VALID_SYNTAX_SAMPLE_CRON = '* * * * *'
|
2017-04-04 09:44:25 +00:00
|
|
|
|
2017-04-04 16:54:45 +00:00
|
|
|
def initialize(cron, cron_timezone = 'UTC')
|
2017-04-04 09:44:25 +00:00
|
|
|
@cron = cron
|
2018-04-28 23:10:36 +00:00
|
|
|
@cron_timezone = timezone_name(cron_timezone)
|
2017-04-04 09:44:25 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
def next_time_from(time)
|
2017-04-05 07:47:20 +00:00
|
|
|
@cron_line ||= try_parse_cron(@cron, @cron_timezone)
|
2017-05-10 15:48:09 +00:00
|
|
|
@cron_line.next_time(time).utc.in_time_zone(Time.zone) if @cron_line.present?
|
2017-04-04 09:44:25 +00:00
|
|
|
end
|
|
|
|
|
2017-04-04 10:14:49 +00:00
|
|
|
def cron_valid?
|
|
|
|
try_parse_cron(@cron, VALID_SYNTAX_SAMPLE_TIME_ZONE).present?
|
|
|
|
end
|
|
|
|
|
2017-04-04 16:54:45 +00:00
|
|
|
def cron_timezone_valid?
|
|
|
|
try_parse_cron(VALID_SYNTAX_SAMPLE_CRON, @cron_timezone).present?
|
2017-04-04 09:44:25 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
private
|
|
|
|
|
2018-04-28 23:10:36 +00:00
|
|
|
def timezone_name(timezone)
|
|
|
|
ActiveSupport::TimeZone.find_tzinfo(timezone).name
|
|
|
|
rescue TZInfo::InvalidTimezoneIdentifier
|
|
|
|
timezone
|
|
|
|
end
|
|
|
|
|
2017-05-03 15:23:20 +00:00
|
|
|
# NOTE:
|
|
|
|
# cron_timezone can only accept timezones listed in TZInfo::Timezone.
|
|
|
|
# Aliases of Timezones from ActiveSupport::TimeZone are NOT accepted,
|
2019-01-08 15:36:38 +00:00
|
|
|
# because Fugit::Cron only supports TZInfo::Timezone.
|
2017-05-03 15:23:20 +00:00
|
|
|
#
|
|
|
|
# For example, those codes have the same effect.
|
|
|
|
# Time.zone = 'Pacific Time (US & Canada)' (ActiveSupport::TimeZone)
|
|
|
|
# Time.zone = 'America/Los_Angeles' (TZInfo::Timezone)
|
|
|
|
#
|
|
|
|
# However, try_parse_cron only accepts the latter format.
|
|
|
|
# try_parse_cron('* * * * *', 'Pacific Time (US & Canada)') -> Doesn't work
|
|
|
|
# try_parse_cron('* * * * *', 'America/Los_Angeles') -> Works
|
|
|
|
# If you want to know more, please take a look
|
|
|
|
# https://github.com/rails/rails/blob/master/activesupport/lib/active_support/values/time_zone.rb
|
2017-04-04 16:54:45 +00:00
|
|
|
def try_parse_cron(cron, cron_timezone)
|
2019-01-08 15:36:38 +00:00
|
|
|
Fugit::Cron.parse("#{cron} #{cron_timezone}")
|
2017-04-04 09:44:25 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
2017-04-04 16:59:24 +00:00
|
|
|
end
|