summaryrefslogtreecommitdiff
path: root/src/util/time.ts
blob: 5c2f49d120261cd657008508a177ca47c1c764fa (plain)
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
import { Codec, renderContext, Context } from "./codec";

/*
 This file is part of GNU Taler
 (C) 2017-2019 Taler Systems S.A.

 GNU Taler is free software; you can redistribute it and/or modify it under the
 terms of the GNU General Public License as published by the Free Software
 Foundation; either version 3, or (at your option) any later version.

 GNU Taler is distributed in the hope that it will be useful, but WITHOUT ANY
 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 A PARTICULAR PURPOSE.  See the GNU General Public License for more details.

 You should have received a copy of the GNU General Public License along with
 GNU Taler; see the file COPYING.  If not, see <http://www.gnu.org/licenses/>
 */

/**
 * Helpers for relative and absolute time.
 */

export class Timestamp {
  /**
   * Timestamp in milliseconds.
   */
  readonly t_ms: number | "never";
}

export interface Duration {
  /**
   * Duration in milliseconds.
   */
  readonly d_ms: number | "forever";
}

let timeshift = 0;

export function setDangerousTimetravel(dt: number): void {
  timeshift = dt;
}

export function getTimestampNow(): Timestamp {
  return {
    t_ms: new Date().getTime() + timeshift,
  };
}

export function getDurationRemaining(
  deadline: Timestamp,
  now = getTimestampNow(),
): Duration {
  if (deadline.t_ms === "never") {
    return { d_ms: "forever" };
  }
  if (now.t_ms === "never") {
    throw Error("invalid argument for 'now'");
  }
  if (deadline.t_ms < now.t_ms) {
    return { d_ms: 0 };
  }
  return { d_ms: deadline.t_ms - now.t_ms };
}

export function timestampMin(t1: Timestamp, t2: Timestamp): Timestamp {
  if (t1.t_ms === "never") {
    return { t_ms: t2.t_ms };
  }
  if (t2.t_ms === "never") {
    return { t_ms: t2.t_ms };
  }
  return { t_ms: Math.min(t1.t_ms, t2.t_ms) };
}

/**
 * Truncate a timestamp so that that it represents a multiple
 * of seconds.  The timestamp is always rounded down.
 */
export function timestampTruncateToSecond(t1: Timestamp): Timestamp {
  if (t1.t_ms === "never") {
    return { t_ms: "never" };
  }
  return {
    t_ms: Math.floor(t1.t_ms / 1000) * 1000,
  };
}

export function durationMin(d1: Duration, d2: Duration): Duration {
  if (d1.d_ms === "forever") {
    return { d_ms: d2.d_ms };
  }
  if (d2.d_ms === "forever") {
    return { d_ms: d2.d_ms };
  }
  return { d_ms: Math.min(d1.d_ms, d2.d_ms) };
}

export function timestampCmp(t1: Timestamp, t2: Timestamp): number {
  if (t1.t_ms === "never") {
    if (t2.t_ms === "never") {
      return 0;
    }
    return 1;
  }
  if (t2.t_ms === "never") {
    return -1;
  }
  if (t1.t_ms == t2.t_ms) {
    return 0;
  }
  if (t1.t_ms > t2.t_ms) {
    return 1;
  }
  return -1;
}

export function timestampAddDuration(t1: Timestamp, d: Duration): Timestamp {
  if (t1.t_ms === "never" || d.d_ms === "forever") {
    return { t_ms: "never" };
  }
  return { t_ms: t1.t_ms + d.d_ms };
}

export function timestampSubtractDuraction(
  t1: Timestamp,
  d: Duration,
): Timestamp {
  if (t1.t_ms === "never") {
    return { t_ms: "never" };
  }
  if (d.d_ms === "forever") {
    return { t_ms: 0 };
  }
  return { t_ms: Math.max(0, t1.t_ms - d.d_ms) };
}

export function stringifyTimestamp(t: Timestamp): string {
  if (t.t_ms === "never") {
    return "never";
  }
  return new Date(t.t_ms).toISOString();
}

export function timestampDifference(t1: Timestamp, t2: Timestamp): Duration {
  if (t1.t_ms === "never") {
    return { d_ms: "forever" };
  }
  if (t2.t_ms === "never") {
    return { d_ms: "forever" };
  }
  return { d_ms: Math.abs(t1.t_ms - t2.t_ms) };
}

export function timestampIsBetween(
  t: Timestamp,
  start: Timestamp,
  end: Timestamp,
): boolean {
  if (timestampCmp(t, start) < 0) {
    return false;
  }
  if (timestampCmp(t, end) > 0) {
    return false;
  }
  return true;
}

export const codecForTimestamp: Codec<Timestamp> = {
  decode(x: any, c?: Context): Timestamp {
    const t_ms = x.t_ms;
    if (typeof t_ms === "string") {
      if (t_ms === "never") {
        return { t_ms: "never" };
      }
      throw Error(`expected timestamp at ${renderContext(c)}`);
    }
    if (typeof t_ms === "number") {
      return { t_ms };
    }
    throw Error(`expected timestamp at ${renderContext(c)}`);
  },
};

export const codecForDuration: Codec<Duration> = {
  decode(x: any, c?: Context): Duration {
    const d_ms = x.d_ms;
    if (typeof d_ms === "string") {
      if (d_ms === "forever") {
        return { d_ms: "forever" };
      }
      throw Error(`expected duration at ${renderContext(c)}`);
    }
    if (typeof d_ms === "number") {
      return { d_ms };
    }
    throw Error(`expected duration at ${renderContext(c)}`);
  },
};