summary refs log tree commit diff
path: root/synapse/util/__init__.py
blob: 07ff25cef33c0f086c0ae4d38c71207a8522f193 (plain) (blame)
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
# -*- coding: utf-8 -*-
# Copyright 2014, 2015 OpenMarket Ltd
#
# 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.

from synapse.util.logcontext import LoggingContext, PreserveLoggingContext

from twisted.internet import defer, reactor, task

import time
import logging

logger = logging.getLogger(__name__)


def unwrapFirstError(failure):
    # defer.gatherResults and DeferredLists wrap failures.
    failure.trap(defer.FirstError)
    return failure.value.subFailure


def unwrap_deferred(d):
    """Given a deferred that we know has completed, return its value or raise
    the failure as an exception
    """
    if not d.called:
        raise RuntimeError("deferred has not finished")

    res = []

    def f(r):
        res.append(r)
        return r
    d.addCallback(f)

    if res:
        return res[0]

    def f(r):
        res.append(r)
        return r
    d.addErrback(f)

    if res:
        res[0].raiseException()
    else:
        raise RuntimeError("deferred did not call callbacks")


class Clock(object):
    """A small utility that obtains current time-of-day so that time may be
    mocked during unit-tests.

    TODO(paul): Also move the sleep() functionallity into it
    """

    def time(self):
        """Returns the current system time in seconds since epoch."""
        return time.time()

    def time_msec(self):
        """Returns the current system time in miliseconds since epoch."""
        return self.time() * 1000

    def looping_call(self, f, msec):
        l = task.LoopingCall(f)
        l.start(msec/1000.0, now=False)
        return l

    def stop_looping_call(self, loop):
        loop.stop()

    def call_later(self, delay, callback, *args, **kwargs):
        current_context = LoggingContext.current_context()

        def wrapped_callback(*args, **kwargs):
            with PreserveLoggingContext():
                LoggingContext.thread_local.current_context = current_context
                callback(*args, **kwargs)

        with PreserveLoggingContext():
            return reactor.callLater(delay, wrapped_callback, *args, **kwargs)

    def cancel_call_later(self, timer, ignore_errs=False):
        try:
            timer.cancel()
        except:
            if not ignore_errs:
                raise

    def time_bound_deferred(self, given_deferred, time_out):
        if given_deferred.called:
            return given_deferred

        ret_deferred = defer.Deferred()

        def timed_out_fn():
            try:
                ret_deferred.errback(RuntimeError("Timed out"))
            except:
                pass

            try:
                given_deferred.cancel()
            except:
                pass

        timer = None

        def cancel(res):
            try:
                self.cancel_call_later(timer)
            except:
                pass
            return res

        ret_deferred.addBoth(cancel)

        def sucess(res):
            try:
                ret_deferred.callback(res)
            except:
                pass

            return res

        def err(res):
            try:
                ret_deferred.errback(res)
            except:
                pass

        given_deferred.addCallbacks(callback=sucess, errback=err)

        timer = self.call_later(time_out, timed_out_fn)

        return ret_deferred