;; This Source Code Form is subject to the terms of the Mozilla Public ;; License, v. 2.0. If a copy of the MPL was not distributed with this ;; file, You can obtain one at http://mozilla.org/MPL/2.0/. ;; ;; Copyright (c) KALEIDOS INC (ns app.util.time (:require [app.common.data.macros :as dm] [app.common.exceptions :as ex] [app.common.schema :as sm] [app.common.schema.openapi :as-alias oapi] [app.common.time :as common-time] [clojure.spec.alpha :as s] [clojure.test.check.generators :as tgen] [cuerdas.core :as str] [fipp.ednize :as fez]) (:import java.nio.file.attribute.FileTime java.time.Duration java.time.Instant java.time.OffsetDateTime java.time.ZoneId java.time.ZonedDateTime java.time.format.DateTimeFormatter java.time.temporal.ChronoUnit java.time.temporal.Temporal java.time.temporal.TemporalAmount java.time.temporal.TemporalUnit java.util.Date org.apache.logging.log4j.core.util.CronExpression)) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;; Instant & Duration ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; (defn temporal-unit [o] (if (instance? TemporalUnit o) o (case o :nanos ChronoUnit/NANOS :millis ChronoUnit/MILLIS :micros ChronoUnit/MICROS :seconds ChronoUnit/SECONDS :minutes ChronoUnit/MINUTES :hours ChronoUnit/HOURS :days ChronoUnit/DAYS))) ;; --- DURATION (defn- obj->duration [params] (reduce-kv (fn [o k v] (.plus ^Duration o ^long v ^TemporalUnit (temporal-unit k))) (Duration/ofMillis 0) params)) (defn duration? [v] (instance? Duration v)) (defn duration [ms-or-obj] (cond (string? ms-or-obj) (Duration/parse (str "PT" ms-or-obj)) (duration? ms-or-obj) ms-or-obj (integer? ms-or-obj) (Duration/ofMillis ms-or-obj) :else (obj->duration ms-or-obj))) (defn ->seconds [d] (-> d inst-ms (/ 1000) int)) (defn diff [t1 t2] (Duration/between t1 t2)) (defn truncate [o unit] (let [unit (temporal-unit unit)] (cond (instance? Instant o) (.truncatedTo ^Instant o ^TemporalUnit unit) (instance? Duration o) (.truncatedTo ^Duration o ^TemporalUnit unit) :else (throw (IllegalArgumentException. "only instant and duration allowed"))))) (s/def ::duration (s/conformer (fn [v] (cond (duration? v) v (string? v) (try (duration v) (catch java.time.format.DateTimeParseException _e ::s/invalid)) :else ::s/invalid)) (fn [v] (subs (str v) 2)))) (extend-protocol clojure.core/Inst java.time.Duration (inst-ms* [v] (.toMillis ^Duration v)) OffsetDateTime (inst-ms* [v] (.toEpochMilli (.toInstant ^OffsetDateTime v))) FileTime (inst-ms* [v] (.toMillis ^FileTime v))) (defmethod print-method Duration [mv ^java.io.Writer writer] (.write writer (str "#app/duration \"" (str/lower (subs (str mv) 2)) "\""))) (defmethod print-dup Duration [o w] (print-method o w)) (extend-protocol fez/IEdn Duration (-edn [o] (tagged-literal 'app/duration (str o)))) (defn format-duration [o] (str/lower (subs (str o) 2))) ;; --- INSTANT (defn instant ([s] (if (int? s) (Instant/ofEpochMilli s) (Instant/parse s))) ([s fmt] (case fmt :rfc1123 (Instant/from (.parse DateTimeFormatter/RFC_1123_DATE_TIME ^String s)) :iso (Instant/from (.parse DateTimeFormatter/ISO_INSTANT ^String s)) :iso8601 (Instant/from (.parse DateTimeFormatter/ISO_INSTANT ^String s))))) (defn instant? [v] (instance? Instant v)) (defn is-after? [da db] (.isAfter ^Instant da ^Instant db)) (defn is-before? [da db] (.isBefore ^Instant da ^Instant db)) (defn plus [d ta] (let [^TemporalAmount ta (duration ta)] (cond (instance? Duration d) (.plus ^Duration d ta) (instance? Temporal d) (.plus ^Temporal d ta) :else (throw (UnsupportedOperationException. "unsupported type"))))) (defn minus [d ta] (let [^TemporalAmount ta (duration ta)] (cond (instance? Duration d) (.minus ^Duration d ta) (instance? Temporal d) (.minus ^Temporal d ta) :else (throw (UnsupportedOperationException. "unsupported type"))))) (dm/export common-time/now) (defn in-future [v] (plus (now) v)) (defn in-past [v] (minus (now) v)) (defn instant->zoned-date-time [v] (ZonedDateTime/ofInstant v (ZoneId/of "UTC"))) (defn format-instant ([v] (.format DateTimeFormatter/ISO_INSTANT ^Instant v)) ([v fmt] (case fmt :iso (.format DateTimeFormatter/ISO_INSTANT ^Instant v) :rfc1123 (.format DateTimeFormatter/RFC_1123_DATE_TIME ^ZonedDateTime (instant->zoned-date-time v))))) (defmethod print-method Instant [mv ^java.io.Writer writer] (.write writer (str "#app/instant \"" (format-instant mv) "\""))) (defmethod print-dup Instant [o w] (print-method o w)) (extend-protocol fez/IEdn Instant (-edn [o] (tagged-literal 'app/instant (format-instant o)))) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;; Cron Expression ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;; Cron expressions are comprised of 6 required fields and one ;; optional field separated by white space. The fields respectively ;; are described as follows: ;; ;; Field Name Allowed Values Allowed Special Characters ;; Seconds 0-59 , - * / ;; Minutes 0-59 , - * / ;; Hours 0-23 , - * / ;; Day-of-month 1-31 , - * ? / L W ;; Month 0-11 or JAN-DEC , - * / ;; Day-of-Week 1-7 or SUN-SAT , - * ? / L # ;; Year (Optional) empty, 1970-2199 , - * / ;; ;; The '*' character is used to specify all values. For example, "*" ;; in the minute field means "every minute". ;; ;; The '?' character is allowed for the day-of-month and day-of-week ;; fields. It is used to specify 'no specific value'. This is useful ;; when you need to specify something in one of the two fields, but ;; not the other. ;; ;; The '-' character is used to specify ranges For example "10-12" in ;; the hour field means "the hours 10, 11 and 12". ;; ;; The ',' character is used to specify additional values. For ;; example "MON,WED,FRI" in the day-of-week field means "the days ;; Monday, Wednesday, and Friday". ;; ;; The '/' character is used to specify increments. For example "0/15" ;; in the seconds field means "the seconds 0, 15, 30, and ;; 45". And "5/15" in the seconds field means "the seconds 5, 20, 35, ;; and 50". Specifying '*' before the '/' is equivalent to specifying ;; 0 is the value to start with. Essentially, for each field in the ;; expression, there is a set of numbers that can be turned on or ;; off. For seconds and minutes, the numbers range from 0 to 59. For ;; hours 0 to 23, for days of the month 0 to 31, and for months 0 to ;; 11 (JAN to DEC). The "/" character simply helps you turn on ;; every "nth" value in the given set. Thus "7/6" in the month field ;; only turns on month "7", it does NOT mean every 6th month, please ;; note that subtlety. ;; ;; The 'L' character is allowed for the day-of-month and day-of-week ;; fields. This character is short-hand for "last", but it has ;; different meaning in each of the two fields. For example, the ;; value "L" in the day-of-month field means "the last day of the ;; month" - day 31 for January, day 28 for February on non-leap ;; years. If used in the day-of-week field by itself, it simply ;; means "7" or "SAT". But if used in the day-of-week field after ;; another value, it means "the last xxx day of the month" - for ;; example "6L" means "the last friday of the month". You can also ;; specify an offset from the last day of the month, such as "L-3" ;; which would mean the third-to-last day of the calendar month. When ;; using the 'L' option, it is important not to specify lists, or ;; ranges of values, as you'll get confusing/unexpected results. ;; ;; The 'W' character is allowed for the day-of-month field. This ;; character is used to specify the weekday (Monday-Friday) nearest ;; the given day. As an example, if you were to specify "15W" as the ;; value for the day-of-month field, the meaning is: "the nearest ;; weekday to the 15th of the month". So if the 15th is a Saturday, ;; the trigger will fire on Friday the 14th. If the 15th is a Sunday, ;; the trigger will fire on Monday the 16th. If the 15th is a Tuesday, ;; then it will fire on Tuesday the 15th. However if you specify "1W" ;; as the value for day-of-month, and the 1st is a Saturday, the ;; trigger will fire on Monday the 3rd, as it will not 'jump' over the ;; boundary of a month's days. The 'W' character can only be specified ;; when the day-of-month is a single day, not a range or list of days. ;; ;; The 'L' and 'W' characters can also be combined for the ;; day-of-month expression to yield 'LW', which translates to "last ;; weekday of the month". ;; ;; The '#' character is allowed for the day-of-week field. This ;; character is used to specify "the nth" XXX day of the month. For ;; example, the value of "6#3" in the day-of-week field means the ;; third Friday of the month (day 6 = Friday and "#3" = the 3rd one in ;; the month). Other examples: "2#1" = the first Monday of the month ;; and "4#5" = the fifth Wednesday of the month. Note that if you ;; specify "#5" and there is not 5 of the given day-of-week in the ;; month, then no firing will occur that month. If the '#' character ;; is used, there can only be one expression in the day-of-week ;; field ("3#1,6#3" is not valid, since there are two expressions). ;; ;; The legal characters and the names of months and days of the week ;; are not case sensitive. (defn cron "Creates an instance of CronExpression from string." [s] (try (CronExpression. s) (catch java.text.ParseException e (ex/raise :type :parse :code :invalid-cron-expression :cause e :context {:expr s})))) (defn cron? [v] (instance? CronExpression v)) (defn next-valid-instant-from [^CronExpression cron ^Instant now] (s/assert cron? cron) (.toInstant (.getNextValidTimeAfter cron (Date/from now)))) (defn get-next [cron tnow] (let [nt (next-valid-instant-from cron tnow)] (cons nt (lazy-seq (get-next cron nt))))) (defmethod print-method CronExpression [mv ^java.io.Writer writer] (.write writer (str "#app/cron \"" (.toString ^CronExpression mv) "\""))) (defmethod print-dup CronExpression [o w] (print-ctor o (fn [o w] (print-dup (.toString ^CronExpression o) w)) w)) (extend-protocol fez/IEdn CronExpression (-edn [o] (pr-str o))) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;; Measurement Helpers ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; (defn tpoint "Create a measurement checkpoint for time measurement of potentially asynchronous flow." [] (let [p1 (System/nanoTime)] #(duration {:nanos (- (System/nanoTime) p1)}))) (sm/def! ::instant {:type ::instant :pred instant? :type-properties {:error/message "should be an instant" :title "instant" ::sm/decode instant :gen/gen (tgen/fmap (fn [i] (in-past i)) tgen/pos-int) ::oapi/type "string" ::oapi/format "iso" }}) (sm/def! ::duration {:type :durations :pred duration? :type-properties {:error/message "should be a duration" :gen/gen (tgen/fmap duration tgen/pos-int) :title "duration" ::sm/decode duration ::oapi/type "string" ::oapi/format "duration" }})