git ssb

1
'use strict'
2
var ip = require('ip')
3
var onWakeup = require('on-wakeup')
4
var onNetwork = require('on-change-network')
5
var hasNetwork = require('has-network')
6
7
var pull = require('pull-stream')
8
9
function not (fn) {
10
  return function (e) { return !fn(e) }
11
}
12
13
function and () {
14
  var args = [].slice.call(arguments)
15
  return function (value) {
16
    return args.every(function (fn) { return fn.call(null, value) })
17
  }
18
}
19
20
//min delay (delay since last disconnect of most recent peer in unconnected set)
21
//unconnected filter delay peer < min delay
22
function delay (failures, factor, max) {
23
  return Math.min(Math.pow(2, failures)*factor, max || Infinity)
24
}
25
26
function maxStateChange (M, e) {
27
  return Math.max(M, e.stateChange || 0)
28
}
29
30
function peerNext(peer, opts) {
31
  return (peer.stateChange|0) + delay(peer.failure|0, opts.factor, opts.max)
32
}
33
34
35
//detect if not connected to wifi or other network
36
//(i.e. if there is only localhost)
37
38
function isOffline (e) {
39
  if(ip.isLoopback(e.host) || e.host == 'localhost') return false
40
  return !hasNetwork()
41
}
42
43
var isOnline = not(isOffline)
44
45
function isLocal (e) {
46
  // don't rely on private ip address, because
47
  // cjdns creates fake private ip addresses.
48
  // ignore localhost addresses, because sometimes they get broadcast.
49
  return !ip.isLoopback(e.host) && ip.isPrivate(e.host) && e.source === 'local'
50
}
51
52
function isSeed (e) {
53
  return e.source === 'seed'
54
}
55
56
function isFriend (e) {
57
  return e.source === 'friends'
58
}
59
60
function isUnattempted (e) {
61
  return !e.stateChange
62
}
63
64
//select peers which have never been successfully connected to yet,
65
//but have been tried.
66
function isInactive (e) {
67
  return e.stateChange && (!e.duration || e.duration.mean == 0)
68
}
69
70
function isLongterm (e) {
71
  return e.ping && e.ping.rtt && e.ping.rtt.mean > 0
72
}
73
74
//peers which we can connect to, but are not upgraded.
75
//select peers which we can connect to, but are not upgraded to LT.
76
//assume any peer is legacy, until we know otherwise...
77
function isLegacy (peer) {
78
  return peer.duration && (peer.duration && peer.duration.mean > 0) && !exports.isLongterm(peer)
79
}
80
81
function isConnect (e) {
82
  return 'connected' === e.state || 'connecting' === e.state
83
}
84
85
//sort oldest to newest then take first n
86
function earliest(peers, n) {
87
  return peers.sort(function (a, b) {
88
    return a.stateChange - b.stateChange
89
  }).slice(0, Math.max(n, 0))
90
}
91
92
function select(peers, ts, filter, opts) {
93
  if(opts.disable) return []
94
  //opts: { quota, groupMin, min, factor, max }
95
  var type = peers.filter(filter)
96
  var unconnect = type.filter(not(isConnect))
97
  var count = Math.max(opts.quota - type.filter(isConnect).length, 0)
98
  var min = unconnect.reduce(maxStateChange, 0) + opts.groupMin
99
  if(ts < min) return []
100
101
  return earliest(unconnect.filter(function (peer) {
102
    return peerNext(peer, opts) < ts
103
  }), count)
104
}
105
106
var schedule = exports = module.exports =
107
function (gossip, config, server) {
108
  var min = 60e3, hour = 60*60e3, closed = false
109
110
  //trigger hard reconnect after suspend or local network changes
111
  onWakeup(gossip.reconnect)
112
  onNetwork(gossip.reconnect)
113
114
  function conf(name, def) {
115
    if(config.gossip == null) return def
116
    var value = config.gossip[name]
117
    return (value == null || value === '') ? def : value
118
  }
119
120
  function connect (peers, ts, name, filter, opts) {
121
    opts.group = name
122
    var connected = peers.filter(isConnect).filter(filter)
123
124
    //disconnect if over quota
125
    if(connected.length > opts.quota) {
126
      return earliest(connected, connected.length - opts.quota)
127
        .forEach(function (peer) {
128
          gossip.disconnect(peer)
129
        })
130
    }
131
132
    //will return [] if the quota is full
133
    var selected = select(peers, ts, and(filter, isOnline), opts)
134
    selected
135
      .forEach(function (peer) {
136
        gossip.connect(peer)
137
      })
138
  }
139
140
141
  var connecting = false
142
  function connections () {
143
    if(connecting || closed) return
144
    connecting = true
145
    var timer = setTimeout(function () {
146
      connecting = false
147
148
      // don't attempt to connect while migration is running
149
      if (!server.ready()) return
150
151
      var ts = Date.now()
152
      var peers = gossip.peers()
153
154
      var connected = peers.filter(and(isConnect, not(isLocal), not(isFriend))).length
155
156
      var connectedFriends = peers.filter(and(isConnect, isFriend)).length
157
158
      if(conf('seed', true))
159
        connect(peers, ts, 'seeds', isSeed, {
160
          quota: 3, factor: 2e3, max: 10*min, groupMin: 1e3,
161
        })
162
163
      if(conf('local', true))
164
        connect(peers, ts, 'local', isLocal, {
165
          quota: 3, factor: 2e3, max: 10*min, groupMin: 1e3,
166
        })
167
168
      if(conf('global', true)) {
169
        // prioritize friends
170
        connect(peers, ts, 'friends', and(exports.isFriend, exports.isLongterm), {
171
          quota: 2, factor: 10e3, max: 10*min, groupMin: 5e3,
172
        })
173
174
        if (connectedFriends < 2)
175
          connect(peers, ts, 'attemptFriend', and(exports.isFriend, exports.isUnattempted), {
176
            min: 0, quota: 1, factor: 0, max: 0, groupMin: 0,
177
          })
178
179
        connect(peers, ts, 'retryFriends', and(exports.isFriend, exports.isInactive), {
180
          min: 0,
181
          quota: 3, factor: 60e3, max: 3*60*60e3, groupMin: 5*60e3,
182
        })
183
184
        // standard longterm peers
185
        connect(peers, ts, 'longterm', and(
186
          exports.isLongterm,
187
          not(exports.isFriend),
188
          not(exports.isLocal)
189
        ), {
190
          quota: 2, factor: 10e3, max: 10*min, groupMin: 5e3,
191
        })
192
193
        if(!connected)
194
          connect(peers, ts, 'attempt', exports.isUnattempted, {
195
            min: 0, quota: 1, factor: 0, max: 0, groupMin: 0,
196
          })
197
198
        //quota, groupMin, min, factor, max
199
        connect(peers, ts, 'retry', exports.isInactive, {
200
          min: 0,
201
          quota: 3, factor: 5*60e3, max: 3*60*60e3, groupMin: 5*50e3,
202
        })
203
204
        var longterm = peers.filter(isConnect).filter(isLongterm).length
205
206
        connect(peers, ts, 'legacy', exports.isLegacy, {
207
          quota: 3 - longterm,
208
          factor: 5*min, max: 3*hour, groupMin: 5*min,
209
        })
210
      }
211
212
      peers.filter(isConnect).forEach(function (e) {
213
        var permanent = exports.isLongterm(e) || exports.isLocal(e)
214
        if((!permanent || e.state === 'connecting') && e.stateChange + 10e3 < ts) {
215
          gossip.disconnect(e)
216
        }
217
      })
218
219
    }, 100*Math.random())
220
    if(timer.unref) timer.unref()
221
  }
222
223
    pull(
224
      gossip.changes(),
225
      pull.drain(function (ev) {
226
        if(ev.type == 'disconnect')
227
          connections()
228
      })
229
    )
230
231
    var int = setInterval(connections, 2e3)
232
    if(int.unref) int.unref()
233
234
    connections()
235
236
  return function onClose () {
237
    closed = true
238
  }
239
240
}
241
242
exports.isUnattempted = isUnattempted
243
exports.isInactive = isInactive
244
exports.isLongterm = isLongterm
245
exports.isLegacy = isLegacy
246
exports.isLocal = isLocal
247
exports.isFriend = isFriend
248
exports.isConnectedOrConnecting = isConnect
249
exports.select = select
250
251
252
253
254