FilesExpand file tree

 master

/

timer.js

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

163 lines (147 loc) · 4.35 KB

 master

/

timer.js

Copy path

Top

File metadata and controls

• Code
• Blame

163 lines (147 loc) · 4.35 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

/**

* Copyright 2015 The AMP HTML Authors. All Rights Reserved.

*

* Licensed under the Apache License, Version 2.0 (the "License");

* you may not use this file except in compliance with the License.

* You may obtain a copy of the License at

*

* http://www.apache.org/licenses/LICENSE-2.0

*

* Unless required by applicable law or agreed to in writing, software

* distributed under the License is distributed on an "AS-IS" BASIS,

* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

* See the License for the specific language governing permissions and

* limitations under the License.

*/

// Requires polyfills in immediate side effect.

import './polyfills';

import {user} from './log';

/**

* Helper with all things Timer.

*/

export class Timer {

/**

* @param {!Window} win

*/

constructor(win) {

/** @const {!Window} */

this.win = win;

/** @private @const {!Promise} */

this.resolved_ = Promise.resolve();

this.taskCount_ = 0;

this.canceled_ = {};

/** @const {number} */

this.startTime_ = this.now();

}

/**

* Returns the current EPOC time in milliseconds.

* @return {number}

*/

now() {

return Date.now();

}

/**

* Returns time since start in milliseconds.

* @return {number}

*/

timeSinceStart() {

return this.now() - this.startTime_;

}

/**

* Runs the provided callback after the specified delay. This uses a micro

* task for 0 or no specified time. This means that the delay will actually

* be close to 0 and this will NOT yield to the event queue.

*

* Returns the timer ID that can be used to cancel the timer (cancel method).

* @param {!function()} callback

* @param {number=} opt_delay

* @return {number|string}

*/

delay(callback, opt_delay) {

if (!opt_delay) {

// For a delay of zero, schedule a promise based micro task since

// they are predictably fast.

const id = 'p' + this.taskCount_++;

this.resolved_.then(() => {

if (this.canceled_[id]) {

delete this.canceled_[id];

return;

}

callback();

});

return id;

}

return this.win.setTimeout(callback, opt_delay);

}

/**

* Cancels the previously scheduled callback.

* @param {number|string} timeoutId

*/

cancel(timeoutId) {

if (typeof timeoutId == 'string') {

this.canceled_[timeoutId] = true;

return;

}

this.win.clearTimeout(timeoutId);

}

/**

* Returns a promise that will resolve after the delay. Optionally, the

* resolved value can be provided as opt_result argument.

* @param {number=} opt_delay

* @param {RESULT=} opt_result

* @return {!Promise<RESULT>}

* @template RESULT

*/

promise(opt_delay, opt_result) {

let timerKey = null;

return new Promise((resolve, reject) => {

timerKey = this.delay(() => {

timerKey = -1;

resolve(opt_result);

}, opt_delay);

if (timerKey == -1) {

reject(new Error('Failed to schedule timer.'));

}

}).catch(error => {

// Clear the timer. The most likely reason is "cancel" signal.

if (timerKey != -1) {

this.cancel(timerKey);

}

throw error;

});

}

/**

* Returns a promise that will fail after the specified delay. Optionally,

* this method can take opt_racePromise parameter. In this case, the

* resulting promise will either fail when the specified delay expires or

* will resolve based on the opt_racePromise, whichever happens first.

* @param {number} delay

* @param {!Promise<RESULT>|undefined} opt_racePromise

* @param {string=} opt_message

* @return {!Promise<RESULT>}

* @template RESULT

*/

timeoutPromise(delay, opt_racePromise, opt_message) {

let timerKey = null;

const delayPromise = new Promise((_resolve, reject) => {

timerKey = this.delay(() => {

timerKey = -1;

reject(user.createError(opt_message || 'timeout'));

}, delay);

if (timerKey == -1) {

reject(new Error('Failed to schedule timer.'));

}

}).catch(error => {

// Clear the timer. The most likely reason is "cancel" signal.

if (timerKey != -1) {

this.cancel(timerKey);

}

throw error;

});

if (!opt_racePromise) {

return delayPromise;

}

return Promise.race([delayPromise, opt_racePromise]);

}

}

export const timer = new Timer(window);