chore: refactor structure to make it more explicit what is which thin…

…g, reducing cognitive load

src/decision/engine.js → src/components/decision/engine.js

@@ -11,8 +11,8 @@ const debounce = require('lodash.debounce')
 const log = debug('bitswap:engine')
 log.error = debug('bitswap:engine:error')
 
-const Message = require('../message')
-const Wantlist = require('../wantlist')
+const Message = require('../../types/message')
+const Wantlist = require('../../types/wantlist')
 const PeerRequestQueue = require('./peer-request-queue')
 const Ledger = require('./ledger')
 

src/decision/ledger.js → src/components/decision/ledger.js

@@ -1,8 +1,8 @@
 'use strict'
 
-const Wantlist = require('../wantlist')
+const Wantlist = require('../../types/wantlist')
 
-module.exports = class Ledger {
+class Ledger {
   constructor (peerId) {
     this.partner = peerId
     this.wantlist = new Wantlist()
@@ -40,3 +40,5 @@ module.exports = class Ledger {
     return this.wantlist.contains(key)
   }
 }
+
+module.exports = Ledger

src/network/index.js → src/components/network/index.js

@@ -6,8 +6,8 @@ const pull = require('pull-stream')
 const pushable = require('pull-pushable')
 const setImmediate = require('async/setImmediate')
 
-const Message = require('../message')
-const cs = require('../constants')
+const Message = require('../../types/message')
+const CONSTANTS = require('../../constants')
 const log = debug('bitswap:network')
 log.error = debug('bitswap:network:error')
 
@@ -21,7 +21,7 @@ module.exports = class Network {
     this.conns = new Map()
 
     // increase event listener max
-    this.libp2p.swarm.setMaxListeners(cs.maxListeners)
+    this.libp2p.swarm.setMaxListeners(CONSTANTS.maxListeners)
   }
 
   start () {

src/wantmanager/index.js → src/components/want-manager/index.js

@@ -3,9 +3,9 @@
 const debug = require('debug')
 const pull = require('pull-stream')
 
-const Message = require('../message')
-const Wantlist = require('../wantlist')
-const cs = require('../constants')
+const Message = require('../../types/message')
+const Wantlist = require('../../types/wantlist')
+const CONSTANTS = require('../../constants')
 const MsgQueue = require('./msg-queue')
 
 const log = debug('bitswap:wantmanager')
@@ -29,7 +29,7 @@ module.exports = class WantManager {
       pull.values(cids),
       pull.map((cid) => {
         i++
-        return new Message.Entry(cid, cs.kMaxPriority - i, cancel)
+        return new Message.Entry(cid, CONSTANTS.kMaxPriority - i, cancel)
       }),
       pull.through((entry) => {
         // add changes to our wantlist

src/wantmanager/msg-queue.js → src/components/want-manager/msg-queue.js

@@ -3,12 +3,12 @@
 const queue = require('async/queue')
 const debug = require('debug')
 
-const Message = require('../message')
+const Message = require('../../types/message')
 
 const log = debug('bitswap:wantmanager:queue')
 log.error = debug('bitswap:wantmanager:queue:error')
 
-module.exports = class MsgQueue {
+class MessageQueue {
   constructor (peerId, network) {
     this.peerId = peerId
     this.peerIdStr = peerId.toB58String()
@@ -76,3 +76,5 @@ module.exports = class MsgQueue {
     this.queue.kill()
   }
 }
+
+module.exports = MessageQueue

src/constants.js

@@ -1,13 +1,13 @@
 'use strict'
 
-const second = 1000
+const SECOND = 1000
 
 module.exports = {
   maxProvidersPerRequest: 3,
-  providerRequestTimeout: 10 * second,
-  hasBlockTimeout: 15 * second,
-  provideTimeout: 15 * second,
+  providerRequestTimeout: 10 * SECOND,
+  hasBlockTimeout: 15 * SECOND,
+  provideTimeout: 15 * SECOND,
   kMaxPriority: Math.pow(2, 31) - 1,
-  rebroadcastDelay: 10 * second,
+  rebroadcastDelay: 10 * SECOND,
   maxListeners: 1000
 }

src/index.js

@@ -3,6 +3,7 @@
 const series = require('async/series')
 const retry = require('async/retry')
 const debug = require('debug')
+
 const log = debug('bitswap')
 log.error = debug('bitswap:error')
 const EventEmitter = require('events').EventEmitter
@@ -12,12 +13,12 @@ const paramap = require('pull-paramap')
 const defer = require('pull-defer/source')
 const Block = require('ipfs-block')
 
-const cs = require('./constants')
-const WantManager = require('./wantmanager')
-const Network = require('./network')
-const decision = require('./decision')
+const CONSTANTS = require('./constants')
+const WantManager = require('./components/want-manager')
+const Network = require('./components/network')
+const decision = require('./components/decision')
 
-module.exports = class Bitwap {
+class Bitswap {
   constructor (id, libp2p, blockstore, peerBook) {
     // the ID of the peer to act on behalf of
     this.self = id
@@ -38,7 +39,7 @@ module.exports = class Bitwap {
     this.dupDataRecvd = 0
 
     this.notifications = new EventEmitter()
-    this.notifications.setMaxListeners(cs.maxListeners)
+    this.notifications.setMaxListeners(CONSTANTS.maxListeners)
   }
 
   // handle messages received through the network
@@ -326,14 +327,16 @@ module.exports = class Bitwap {
 }
 
 // Helper method, to add a cid to a block before storing it in the ipfs-repo/blockstore
-function blockToStore (b, cb) {
+function blockToStore (b, callback) {
   b.key((err, key) => {
     if (err) {
-      return cb(err)
+      return callback(err)
     }
-    cb(null, {
+    callback(null, {
       data: b.data,
       key: key
     })
   })
 }
+
+module.exports = Bitswap

test/decision/engine-test.js

@@ -13,8 +13,8 @@ const eachSeries = require('async/eachSeries')
 const pull = require('pull-stream')
 const paramap = require('pull-paramap')
 
-const Message = require('../../src/message')
-const Engine = require('../../src/decision/engine')
+const Message = require('../../src/types/message')
+const Engine = require('../../src/components/decision/engine')
 
 const mockNetwork = require('../utils').mockNetwork
 

test/decision/ledger.spec.js

@@ -4,7 +4,7 @@
 const expect = require('chai').expect
 const PeerId = require('peer-id')
 
-const Ledger = require('../../src/decision/ledger')
+const Ledger = require('../../src/components/decision/ledger')
 
 describe('Ledger', () => {
   let p

test/decision/peer-request-queue.spec.js

@@ -11,20 +11,20 @@ const each = require('async/each')
 const waterfall = require('async/waterfall')
 const parallel = require('async/parallel')
 
-const hash = (data, cb) => {
+const WantlistEntry = require('../../src/types/wantlist').Entry
+const PeerRequestQueue = require('../../src/components/decision/peer-request-queue')
+
+const hash = (data, callback) => {
   const block = new Block(data)
   block.key((err, key) => {
     if (err) {
-      return cb(err)
+      return callback(err)
     }
 
-    cb(null, key)
+    callback(null, key)
   })
 }
 
-const WantlistEntry = require('../../src/wantlist').Entry
-const PeerRequestQueue = require('../../src/decision/peer-request-queue')
-
 describe('PeerRequestQueue', () => {
   it('push and pop', (done) => {
     const prq = new PeerRequestQueue()

test/decision/pq.spec.js

@@ -3,7 +3,7 @@
 
 const expect = require('chai').expect
 
-const PriorityQueue = require('../../src/decision/pq')
+const PriorityQueue = require('../../src/components/decision/pq')
 
 describe('PriorityQueue', () => {
   it('sorts with a less operator', () => {

test/index-test.js

@@ -16,7 +16,7 @@ const mh = require('multihashes')
 const PeerBook = require('peer-book')
 const pull = require('pull-stream')
 
-const Message = require('../src/message')
+const Message = require('../src/types/message')
 const Bitswap = require('../src')
 
 const utils = require('./utils')

test/message.spec.js

@@ -4,12 +4,11 @@
 const expect = require('chai').expect
 const Block = require('ipfs-block')
 const protobuf = require('protocol-buffers')
-// const series = require('async/series')
 const map = require('async/map')
-const pbm = protobuf(require('../src/message/message.proto'))
+const pbm = protobuf(require('../src/types/message/message.proto'))
 const CID = require('cids')
 
-const BitswapMessage = require('../src/message')
+const BitswapMessage = require('../src/types/message')
 
 describe.only('BitswapMessage', () => {
   let blocks

test/network/network.node.js

@@ -12,8 +12,8 @@ const pull = require('pull-stream')
 const parallel = require('async/parallel')
 const series = require('async/series')
 
-const Network = require('../../src/network')
-const Message = require('../../src/message')
+const Network = require('../../src/components/network')
+const Message = require('../../src/types/message')
 
 describe('network', () => {
   let libp2pNodeA

test/wantlist.spec.js

@@ -6,7 +6,7 @@ const Block = require('ipfs-block')
 const map = require('async/map')
 const CID = require('cids')
 
-const Wantlist = require('../src/wantlist')
+const Wantlist = require('../src/types/wantlist')
 
 describe.only('Wantlist', () => {
   let wm

test/wantmanager/index.spec.js

@@ -10,8 +10,8 @@ const Block = require('ipfs-block')
 const CID = require('cids')
 
 const cs = require('../../src/constants')
-const Message = require('../../src/message')
-const WantManager = require('../../src/wantmanager')
+const Message = require('../../src/types/message')
+const WantManager = require('../../src/components/want-manager')
 
 const mockNetwork = require('../utils').mockNetwork
 

test/wantmanager/msg-queue.spec.js

@@ -8,8 +8,8 @@ const parallel = require('async/parallel')
 const Block = require('ipfs-block')
 const CID = require('cids')
 
-const Message = require('../../src/message')
-const MsgQueue = require('../../src/wantmanager/msg-queue')
+const Message = require('../../src/types/message')
+const MsgQueue = require('../../src/components/want-manager/msg-queue')
 
 describe.only('MsgQueue', () => {
   let peerId