Compare commits

..

No commits in common. "master" and "v0.13.5" have entirely different histories.

12 changed files with 164 additions and 459 deletions

View File

@ -10,21 +10,23 @@ const mockUpgrader = {
}
let listener
async function before () {
function boot (done) {
const ws = new WS({ upgrader: mockUpgrader })
const ma = new multiaddr.Multiaddr('/ip4/127.0.0.1/tcp/9095/ws')
const ma = multiaddr('/ip4/127.0.0.1/tcp/9095/ws')
listener = ws.createListener(conn => pipe(conn, conn))
await listener.listen(ma)
listener.listen(ma).then(() => done()).catch(done)
listener.on('error', console.error)
}
function after () {
return listener.close()
function shutdown (done) {
listener.close().then(done).catch(done)
}
module.exports = {
test: {
before,
after
hooks: {
browser: {
pre: boot,
post: shutdown
}
}
}

View File

@ -1,78 +1,3 @@
## [0.15.4](https://github.com/libp2p/js-libp2p-websockets/compare/v0.15.3...v0.15.4) (2021-03-31)
## [0.15.3](https://github.com/libp2p/js-libp2p-websockets/compare/v0.15.2...v0.15.3) (2021-02-22)
## [0.15.2](https://github.com/libp2p/js-libp2p-websockets/compare/v0.15.1...v0.15.2) (2021-02-09)
### Bug Fixes
* add error event handler ([#118](https://github.com/libp2p/js-libp2p-websockets/issues/118)) ([577d350](https://github.com/libp2p/js-libp2p-websockets/commit/577d3505f559b153ec9e0bbca7d31d2f164712bc))
## [0.15.1](https://github.com/libp2p/js-libp2p-websockets/compare/v0.15.0...v0.15.1) (2021-02-05)
### Bug Fixes
* incompatibility with @evanw/esbuild[#740](https://github.com/libp2p/js-libp2p-websockets/issues/740) ([#120](https://github.com/libp2p/js-libp2p-websockets/issues/120)) ([96244f0](https://github.com/libp2p/js-libp2p-websockets/commit/96244f048929c5225905327ae27a88961fe535f8))
# [0.15.0](https://github.com/libp2p/js-libp2p-websockets/compare/v0.13.1...v0.15.0) (2020-11-24)
### Bug Fixes
* add buffer ([#112](https://github.com/libp2p/js-libp2p-websockets/issues/112)) ([8065e07](https://github.com/libp2p/js-libp2p-websockets/commit/8065e07bad57b5732cdcec5ce3829ac2361604cf))
* catch thrown maConn errors in listener ([8bfb19a](https://github.com/libp2p/js-libp2p-websockets/commit/8bfb19a78f296c10d8e1a3c0ac608daa9ffcfefc))
* remove use of assert module ([#101](https://github.com/libp2p/js-libp2p-websockets/issues/101)) ([89d3723](https://github.com/libp2p/js-libp2p-websockets/commit/89d37232b8f603804b6ce5cd8230cc75d2dd8e28))
* replace node buffers with uint8arrays ([#115](https://github.com/libp2p/js-libp2p-websockets/issues/115)) ([a277bf6](https://github.com/libp2p/js-libp2p-websockets/commit/a277bf6bfbc7ad796e51f7646d7449c203384c06))
### Features
* custom address filter ([#116](https://github.com/libp2p/js-libp2p-websockets/issues/116)) ([711c721](https://github.com/libp2p/js-libp2p-websockets/commit/711c721b033d28b3c57c37bf9ca98d0f5d2a58b6))
### BREAKING CHANGES
* Only DNS+WSS addresses are now returned on filter by default in the browser. This can be overritten by the filter option and filters are provided in the module.
<a name="0.14.0"></a>
# [0.14.0](https://github.com/libp2p/js-libp2p-websockets/compare/v0.13.6...v0.14.0) (2020-08-11)
### Bug Fixes
* replace node buffers with uint8arrays ([#115](https://github.com/libp2p/js-libp2p-websockets/issues/115)) ([a277bf6](https://github.com/libp2p/js-libp2p-websockets/commit/a277bf6))
### BREAKING CHANGES
* - All deps used by this module now use Uint8Arrays in place of Buffers
* chore: remove gh dep
<a name="0.13.6"></a>
## [0.13.6](https://github.com/libp2p/js-libp2p-websockets/compare/v0.13.5...v0.13.6) (2020-03-23)
### Bug Fixes
* add buffer ([#112](https://github.com/libp2p/js-libp2p-websockets/issues/112)) ([8065e07](https://github.com/libp2p/js-libp2p-websockets/commit/8065e07))
<a name="0.13.5"></a>
## [0.13.5](https://github.com/libp2p/js-libp2p-websockets/compare/v0.13.4...v0.13.5) (2020-02-26)

View File

@ -35,62 +35,39 @@
> npm i libp2p-websockets
```
### Constructor properties
### Example
```js
const WS = require('libp2p-websockets')
const multiaddr = require('multiaddr')
const pipe = require('it-pipe')
const { collect } = require('streaming-iterables')
const properties = {
upgrader,
filter
}
const addr = multiaddr('/ip4/0.0.0.0/tcp/9090/ws')
const ws = new WS(properties)
```
const ws = new WS({ upgrader })
| Name | Type | Description | Default |
|------|------|-------------|---------|
| upgrader | [`Upgrader`](https://github.com/libp2p/interface-transport#upgrader) | connection upgrader object with `upgradeOutbound` and `upgradeInbound` | **REQUIRED** |
| filter | `(multiaddrs: Array<Multiaddr>) => Array<Multiaddr>` | override transport addresses filter | **Browser:** DNS+WSS multiaddrs / **Node.js:** DNS+{WS, WSS} multiaddrs |
You can create your own address filters for this transports, or rely in the filters [provided](./src/filters.js).
The available filters are:
- `filters.all`
- Returns all TCP and DNS based addresses, both with `ws` or `wss`.
- `filters.dnsWss`
- Returns all DNS based addresses with `wss`.
- `filters.dnsWsOrWss`
- Returns all DNS based addresses, both with `ws` or `wss`.
## Libp2p Usage Example
```js
const Libp2p = require('libp2p')
const Websockets = require('libp2p-websockets')
const filters = require('libp2p-websockets/src/filters')
const MPLEX = require('libp2p-mplex')
const { NOISE } = require('libp2p-noise')
const transportKey = Websockets.prototype[Symbol.toStringTag]
const node = await Libp2p.create({
modules: {
transport: [Websockets],
streamMuxer: [MPLEX],
connEncryption: [NOISE]
},
config: {
transport: {
[transportKey]: { // Transport properties -- Libp2p upgrader is automatically added
filter: filters.dnsWsOrWss
}
}
}
const listener = ws.createListener((socket) => {
console.log('new connection opened')
pipe(
['hello'],
socket
)
})
```
For more information see [libp2p/js-libp2p/doc/CONFIGURATION.md#customizing-transports](https://github.com/libp2p/js-libp2p/blob/master/doc/CONFIGURATION.md#customizing-transports).
await listener.listen(addr)
console.log('listening')
const socket = await ws.dial(addr)
const values = await pipe(
socket,
collect
)
console.log(`Value: ${values.toString()}`)
// Close connection after reading
await listener.close()
```
## API

View File

@ -1,6 +1,6 @@
{
"name": "libp2p-websockets",
"version": "0.15.4",
"version": "0.13.5",
"description": "JavaScript implementation of the WebSockets module that libp2p uses and that implements the interface-transport spec",
"leadMaintainer": "Jacob Heun <jacobheun@gmail.com>",
"main": "src/index.js",
@ -16,7 +16,7 @@
"coverage": "nyc --reporter=lcov --reporter=text npm run test:node"
},
"browser": {
"./src/listener.js": "./src/listener.browser.js"
"src/listener": "./src/listener.browser.js"
},
"files": [
"src",
@ -40,48 +40,48 @@
"dependencies": {
"abortable-iterator": "^3.0.0",
"class-is": "^1.1.0",
"debug": "^4.2.0",
"err-code": "^3.0.1",
"ipfs-utils": "^6.0.1",
"it-ws": "^4.0.0",
"libp2p-utils": "^0.2.1",
"mafmt": "^8.0.1",
"multiaddr": "^9.0.1",
"multiaddr-to-uri": "fluencelabs/js-multiaddr-to-uri",
"p-defer": "^3.0.0",
"p-timeout": "^4.1.0"
"debug": "^4.1.1",
"err-code": "^2.0.0",
"it-ws": "^3.0.0",
"libp2p-utils": "~0.1.0",
"mafmt": "^7.0.0",
"multiaddr": "^7.1.0",
"multiaddr-to-uri": "^5.0.0",
"p-timeout": "^3.2.0"
},
"devDependencies": {
"abort-controller": "^3.0.0",
"aegir": "^32.2.0",
"aegir": "^20.3.1",
"bl": "^4.0.0",
"is-loopback-addr": "^1.0.1",
"chai": "^4.2.0",
"dirty-chai": "^2.0.1",
"libp2p-interfaces": "^0.2.0",
"it-goodbye": "^2.0.1",
"it-pipe": "^1.0.1",
"libp2p-interfaces": "^0.8.3",
"streaming-iterables": "^5.0.2",
"uint8arrays": "^2.1.2",
"util": "^0.12.3"
"streaming-iterables": "^4.1.0"
},
"contributors": [
"David Dias <daviddias.p@gmail.com>",
"Jacob Heun <jacobheun@gmail.com>",
"Vasco Santos <vasco.santos@moxy.studio>",
"Friedel Ziegelmayer <dignifiedquire@gmail.com>",
"Francisco Baio Dias <xicombd@gmail.com>",
"Dmitriy Ryajov <dryajov@gmail.com>",
"Alan Shaw <alan.shaw@protocol.ai>",
"Alex Potsides <alex@achingbrain.net>",
"Hugo Dias <hugomrdias@gmail.com>",
"Maciej Krüger <mkg20001@gmail.com>",
"ᴠɪᴄᴛᴏʀ ʙᴊᴇʟᴋʜᴏʟᴍ <victorbjelkholm@gmail.com>",
"Chris Campbell <christopher.d.campbell@gmail.com>",
"David Dias <daviddias.p@gmail.com>",
"Diogo Silva <fsdiogo@gmail.com>",
"Irakli Gozalishvili <contact@gozala.io>",
"Dmitriy Ryajov <dryajov@gmail.com>",
"Francisco Baio Dias <xicombd@gmail.com>",
"Friedel Ziegelmayer <dignifiedquire@gmail.com>",
"Greenkeeper <support@greenkeeper.io>",
"Hugo Dias <hugomrdias@gmail.com>",
"Jack Kleeman <jackkleeman@gmail.com>",
"Jacob Heun <jacobheun@gmail.com>",
"Jacob Heun <jake@andyet.net>",
"Maciej Krüger <mkg20001@gmail.com>",
"Marcin Rataj <lidel@lidel.org>",
"Michael FIG <michael+github@fig.org>",
"Richard Littauer <richard.littauer@gmail.com>",
"nikor <nikorpoulsen@gmail.com>",
"Alan Shaw <alan.shaw@protocol.ai>"
"Vasco Santos <vasco.santos@moxy.studio>",
"Vasco Santos <vasco.santos@ua.pt>",
"Victor Bjelkholm <victorbjelkholm@gmail.com>",
"dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>",
"nikor <nikorpoulsen@gmail.com>"
]
}

View File

@ -4,9 +4,5 @@
exports.CODE_P2P = 421
exports.CODE_CIRCUIT = 290
exports.CODE_TCP = 6
exports.CODE_WS = 477
exports.CODE_WSS = 478
// Time to wait for a connection to close gracefully before destroying it manually
exports.CLOSE_TIMEOUT = 2000

View File

@ -1,49 +0,0 @@
'use strict'
const mafmt = require('mafmt')
const {
CODE_CIRCUIT,
CODE_P2P,
CODE_TCP,
CODE_WS,
CODE_WSS
} = require('./constants')
module.exports = {
all: (multiaddrs) => multiaddrs.filter((ma) => {
if (ma.protoCodes().includes(CODE_CIRCUIT)) {
return false
}
const testMa = ma.decapsulateCode(CODE_P2P)
return mafmt.WebSockets.matches(testMa) ||
mafmt.WebSocketsSecure.matches(testMa)
}),
dnsWss: (multiaddrs) => multiaddrs.filter((ma) => {
if (ma.protoCodes().includes(CODE_CIRCUIT)) {
return false
}
const testMa = ma.decapsulateCode(CODE_P2P)
return mafmt.WebSocketsSecure.matches(testMa) &&
mafmt.DNS.matches(testMa.decapsulateCode(CODE_TCP).decapsulateCode(CODE_WSS))
}),
dnsWsOrWss: (multiaddrs) => multiaddrs.filter((ma) => {
if (ma.protoCodes().includes(CODE_CIRCUIT)) {
return false
}
const testMa = ma.decapsulateCode(CODE_P2P)
// WS
if (mafmt.WebSockets.matches(testMa)) {
return mafmt.DNS.matches(testMa.decapsulateCode(CODE_TCP).decapsulateCode(CODE_WS))
}
// WSS
return mafmt.WebSocketsSecure.matches(testMa) &&
mafmt.DNS.matches(testMa.decapsulateCode(CODE_TCP).decapsulateCode(CODE_WSS))
})
}

View File

@ -1,43 +1,38 @@
'use strict'
const connect = require('it-ws/client')
const mafmt = require('mafmt')
const withIs = require('class-is')
const toUri = require('multiaddr-to-uri')
const { AbortError } = require('abortable-iterator')
const pDefer = require('p-defer')
const debug = require('debug')
const log = debug('libp2p:websockets')
log.error = debug('libp2p:websockets:error')
const env = require('ipfs-utils/src/env')
const log = require('debug')('libp2p:websockets')
const createListener = require('./listener')
const toConnection = require('./socket-to-conn')
const filters = require('./filters')
const { CODE_CIRCUIT, CODE_P2P } = require('./constants')
/**
* @class WebSockets
*/
class WebSockets {
/**
* @class
* @constructor
* @param {object} options
* @param {Upgrader} options.upgrader
* @param {(multiaddrs: Array<Multiaddr>) => Array<Multiaddr>} options.filter - override transport addresses filter
*/
constructor ({ upgrader, filter }) {
constructor ({ upgrader }) {
if (!upgrader) {
throw new Error('An upgrader must be provided. See https://github.com/libp2p/interface-transport#upgrader.')
}
this._upgrader = upgrader
this._filter = filter
}
/**
* @async
* @param {Multiaddr} ma
* @param {object} [options]
* @param {AbortSignal} [options.signal] - Used to abort dial requests
* @param {AbortSignal} [options.signal] Used to abort dial requests
* @returns {Connection} An upgraded Connection
*/
async dial (ma, options = {}) {
@ -56,7 +51,7 @@ class WebSockets {
* @private
* @param {Multiaddr} ma
* @param {object} [options]
* @param {AbortSignal} [options.signal] - Used to abort dial requests
* @param {AbortSignal} [options.signal] Used to abort dial requests
* @returns {Promise<WebSocket>} Resolves a extended duplex iterable on top of a WebSocket
*/
async _connect (ma, options = {}) {
@ -66,24 +61,10 @@ class WebSockets {
const cOpts = ma.toOptions()
log('dialing %s:%s', cOpts.host, cOpts.port)
const errorPromise = pDefer()
const errfn = (err) => {
const msg = `connection error: ${err.message}`
log.error(msg)
errorPromise.reject(err)
}
const rawSocket = connect(toUri(ma), Object.assign({ binary: true }, options))
if (rawSocket.socket.on) {
rawSocket.socket.on('error', errfn)
} else {
rawSocket.socket.onerror = errfn
}
if (!options.signal) {
await Promise.race([rawSocket.connected(), errorPromise.promise])
await rawSocket.connected()
log('connected %s', ma)
return rawSocket
@ -94,10 +75,7 @@ class WebSockets {
const abort = new Promise((resolve, reject) => {
onAbort = () => {
reject(new AbortError())
// FIXME: https://github.com/libp2p/js-libp2p-websockets/issues/121
setTimeout(() => {
rawSocket.close()
})
rawSocket.close()
}
// Already aborted?
@ -106,7 +84,7 @@ class WebSockets {
})
try {
await Promise.race([abort, errorPromise.promise, rawSocket.connected()])
await Promise.race([abort, rawSocket.connected()])
} finally {
options.signal.removeEventListener('abort', onAbort)
}
@ -119,9 +97,8 @@ class WebSockets {
* Creates a Websockets listener. The provided `handler` function will be called
* anytime a new incoming Connection has been successfully upgraded via
* `upgrader.upgradeInbound`.
*
* @param {object} [options]
* @param {http.Server} [options.server] - A pre-created Node.js HTTP/S server.
* @param {http.Server} [options.server] A pre-created Node.js HTTP/S server.
* @param {function (Connection)} handler
* @returns {Listener} A Websockets listener
*/
@ -135,26 +112,21 @@ class WebSockets {
}
/**
* Takes a list of `Multiaddr`s and returns only valid Websockets addresses.
* By default, in a browser environment only DNS+WSS multiaddr is accepted,
* while in a Node.js environment DNS+{WS, WSS} multiaddrs are accepted.
*
* Takes a list of `Multiaddr`s and returns only valid Websockets addresses
* @param {Multiaddr[]} multiaddrs
* @returns {Multiaddr[]} Valid Websockets multiaddrs
*/
filter (multiaddrs) {
multiaddrs = Array.isArray(multiaddrs) ? multiaddrs : [multiaddrs]
if (this._filter) {
return this._filter(multiaddrs)
}
return multiaddrs.filter((ma) => {
if (ma.protoCodes().includes(CODE_CIRCUIT)) {
return false
}
// Browser
if (env.isBrowser || env.isWebWorker) {
return filters.dnsWss(multiaddrs)
}
return filters.all(multiaddrs)
return mafmt.WebSockets.matches(ma.decapsulateCode(CODE_P2P)) ||
mafmt.WebSocketsSecure.matches(ma.decapsulateCode(CODE_P2P))
})
}
}

View File

@ -78,7 +78,7 @@ module.exports = ({ handler, upgrader }, options = {}) => {
Object.keys(netInterfaces).forEach((niKey) => {
netInterfaces[niKey].forEach((ni) => {
if (ni.family === 'IPv4') {
multiaddrs.push(new multiaddr.Multiaddr(m.toString().replace('0.0.0.0', ni.address)))
multiaddrs.push(multiaddr(m.toString().replace('0.0.0.0', ni.address)))
}
})
})

View File

@ -23,7 +23,7 @@ module.exports = (stream, options = {}) => {
await stream.sink((async function * () {
for await (const chunk of source) {
// Convert BufferList to Buffer
yield chunk instanceof Uint8Array ? chunk : chunk.slice()
yield Buffer.isBuffer(chunk) ? chunk : chunk.slice()
}
})())
} catch (err) {
@ -38,8 +38,7 @@ module.exports = (stream, options = {}) => {
conn: stream,
localAddr: options.localAddr || (stream.localAddress && stream.localPort
? toMultiaddr(stream.localAddress, stream.localPort)
: undefined),
? toMultiaddr(stream.localAddress, stream.localPort) : undefined),
// If the remote address was passed, use it - it may have the peer ID encapsulated
remoteAddr: options.remoteAddr || toMultiaddr(stream.remoteAddress, stream.remotePort),

View File

@ -1,13 +1,15 @@
/* eslint-env mocha */
'use strict'
const { expect } = require('aegir/utils/chai')
const chai = require('chai')
const dirtyChai = require('dirty-chai')
const expect = chai.expect
chai.use(dirtyChai)
const multiaddr = require('multiaddr')
const pipe = require('it-pipe')
const goodbye = require('it-goodbye')
const { collect, take } = require('streaming-iterables')
const uint8ArrayFromString = require('uint8arrays/from-string')
const WS = require('../src')
@ -17,7 +19,7 @@ const mockUpgrader = {
}
describe('libp2p-websockets', () => {
const ma = new multiaddr.Multiaddr('/ip4/127.0.0.1/tcp/9095/ws')
const ma = multiaddr('/ip4/127.0.0.1/tcp/9095/ws')
let ws
let conn
@ -27,26 +29,16 @@ describe('libp2p-websockets', () => {
})
it('echo', async () => {
const message = uint8ArrayFromString('Hello World!')
const message = Buffer.from('Hello World!')
const s = goodbye({ source: [message], sink: collect })
const results = await pipe(s, conn, s)
expect(results).to.eql([message])
})
it('should filter out no DNS websocket addresses', function () {
const ma1 = multiaddr('/ip4/127.0.0.1/tcp/80/ws')
const ma2 = multiaddr('/ip4/127.0.0.1/tcp/443/wss')
const ma3 = multiaddr('/ip6/::1/tcp/80/ws')
const ma4 = multiaddr('/ip6/::1/tcp/443/wss')
const valid = ws.filter([ma1, ma2, ma3, ma4])
expect(valid.length).to.equal(0)
})
describe('stress', () => {
it('one big write', async () => {
const rawMessage = new Uint8Array(1000000).fill('a')
const rawMessage = Buffer.allocUnsafe(1000000).fill('a')
const s = goodbye({ source: [rawMessage], sink: collect })
@ -60,7 +52,7 @@ describe('libp2p-websockets', () => {
source: pipe(
{
[Symbol.iterator] () { return this },
next: () => ({ done: false, value: uint8ArrayFromString(Math.random().toString()) })
next: () => ({ done: false, value: Buffer.from(Math.random().toString()) })
},
take(20000)
),

View File

@ -5,17 +5,16 @@ const tests = require('libp2p-interfaces/src/transport/tests')
const multiaddr = require('multiaddr')
const http = require('http')
const WS = require('../src')
const filters = require('../src/filters')
describe('interface-transport compliance', () => {
tests({
async setup ({ upgrader }) { // eslint-disable-line require-await
const ws = new WS({ upgrader, filter: filters.all })
const ws = new WS({ upgrader })
const addrs = [
new multiaddr.Multiaddr('/ip4/127.0.0.1/tcp/9091/ws'),
new multiaddr.Multiaddr('/ip4/127.0.0.1/tcp/9092/ws'),
new multiaddr.Multiaddr('/dns4/ipfs.io/tcp/9092/ws'),
new multiaddr.Multiaddr('/dns4/ipfs.io/tcp/9092/wss')
multiaddr('/ip4/127.0.0.1/tcp/9091/ws'),
multiaddr('/ip4/127.0.0.1/tcp/9092/ws'),
multiaddr('/dns4/ipfs.io/tcp/9092/ws'),
multiaddr('/dns4/ipfs.io/tcp/9092/wss')
]
let delayMs = 0

View File

@ -5,18 +5,17 @@
const https = require('https')
const fs = require('fs')
const AbortController = require('abort-controller').default
const { expect } = require('aegir/utils/chai')
const chai = require('chai')
const dirtyChai = require('dirty-chai')
const expect = chai.expect
chai.use(dirtyChai)
const multiaddr = require('multiaddr')
const goodbye = require('it-goodbye')
const isLoopbackAddr = require('is-loopback-addr')
const { collect } = require('streaming-iterables')
const pipe = require('it-pipe')
const BufferList = require('bl/BufferList')
const uint8ArrayFromString = require('uint8arrays/from-string')
const WS = require('../src')
const filters = require('../src/filters')
require('./compliance.node')
@ -35,7 +34,7 @@ describe('instantiate the transport', () => {
describe('listen', () => {
describe('ip4', () => {
let ws
const ma = new multiaddr.Multiaddr('/ip4/127.0.0.1/tcp/9090/ws')
const ma = multiaddr('/ip4/127.0.0.1/tcp/9090/ws')
beforeEach(() => {
ws = new WS({ upgrader: mockUpgrader })
@ -70,7 +69,7 @@ describe('listen', () => {
})
it('listen on addr with /ipfs/QmHASH', async () => {
const ma = new multiaddr.Multiaddr('/ip4/127.0.0.1/tcp/9090/ws/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const ma = multiaddr('/ip4/127.0.0.1/tcp/9090/ws/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const listener = ws.createListener((conn) => { })
await listener.listen(ma)
@ -78,7 +77,7 @@ describe('listen', () => {
})
it('listen on port 0', async () => {
const ma = new multiaddr.Multiaddr('/ip4/127.0.0.1/tcp/0/ws/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const ma = multiaddr('/ip4/127.0.0.1/tcp/0/ws/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const listener = ws.createListener((conn) => { })
await listener.listen(ma)
@ -88,7 +87,7 @@ describe('listen', () => {
})
it('listen on any Interface', async () => {
const ma = new multiaddr.Multiaddr('/ip4/0.0.0.0/tcp/0/ws/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const ma = multiaddr('/ip4/0.0.0.0/tcp/0/ws/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const listener = ws.createListener((conn) => { })
await listener.listen(ma)
@ -107,7 +106,7 @@ describe('listen', () => {
})
it('getAddrs on port 0 listen', async () => {
const addr = new multiaddr.Multiaddr('/ip4/127.0.0.1/tcp/0/ws')
const addr = multiaddr('/ip4/127.0.0.1/tcp/0/ws')
const listener = ws.createListener((conn) => { })
await listener.listen(addr)
const addrs = await listener.getAddrs()
@ -117,7 +116,7 @@ describe('listen', () => {
})
it('getAddrs from listening on 0.0.0.0', async () => {
const addr = new multiaddr.Multiaddr('/ip4/0.0.0.0/tcp/9003/ws')
const addr = multiaddr('/ip4/0.0.0.0/tcp/9003/ws')
const listener = ws.createListener((conn) => { })
await listener.listen(addr)
const addrs = await listener.getAddrs()
@ -126,7 +125,7 @@ describe('listen', () => {
})
it('getAddrs from listening on 0.0.0.0 and port 0', async () => {
const addr = new multiaddr.Multiaddr('/ip4/0.0.0.0/tcp/0/ws')
const addr = multiaddr('/ip4/0.0.0.0/tcp/0/ws')
const listener = ws.createListener((conn) => { })
await listener.listen(addr)
const addrs = await listener.getAddrs()
@ -136,7 +135,7 @@ describe('listen', () => {
})
it('getAddrs preserves p2p Id', async () => {
const ma = new multiaddr.Multiaddr('/ip4/127.0.0.1/tcp/9090/ws/p2p/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const ma = multiaddr('/ip4/127.0.0.1/tcp/9090/ws/p2p/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const listener = ws.createListener((conn) => { })
await listener.listen(ma)
@ -149,7 +148,7 @@ describe('listen', () => {
describe('ip6', () => {
let ws
const ma = new multiaddr.Multiaddr('/ip6/::1/tcp/9091/ws')
const ma = multiaddr('/ip6/::1/tcp/9091/ws')
beforeEach(() => {
ws = new WS({ upgrader: mockUpgrader })
@ -184,7 +183,7 @@ describe('listen', () => {
})
it('listen on addr with /ipfs/QmHASH', async () => {
const ma = new multiaddr.Multiaddr('/ip6/::1/tcp/9091/ws/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const ma = multiaddr('/ip6/::1/tcp/9091/ws/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const listener = ws.createListener((conn) => { })
await listener.listen(ma)
await listener.close()
@ -196,7 +195,7 @@ describe('dial', () => {
describe('ip4', () => {
let ws
let listener
const ma = new multiaddr.Multiaddr('/ip4/127.0.0.1/tcp/9091/ws')
const ma = multiaddr('/ip4/127.0.0.1/tcp/9091/ws')
beforeEach(() => {
ws = new WS({ upgrader: mockUpgrader })
@ -212,31 +211,21 @@ describe('dial', () => {
const result = await pipe(s, conn, s)
expect(result).to.be.eql([uint8ArrayFromString('hey')])
expect(result).to.be.eql([Buffer.from('hey')])
})
it('dial with p2p Id', async () => {
const ma = new multiaddr.Multiaddr('/ip4/127.0.0.1/tcp/9091/ws/p2p/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const ma = multiaddr('/ip4/127.0.0.1/tcp/9091/ws/p2p/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const conn = await ws.dial(ma)
const s = goodbye({ source: ['hey'], sink: collect })
const result = await pipe(s, conn, s)
expect(result).to.be.eql([uint8ArrayFromString('hey')])
})
it('dial should throw on immediate abort', async () => {
const ma = new multiaddr.Multiaddr('/ip4/127.0.0.1/tcp/0/ws')
const controller = new AbortController()
const conn = ws.dial(ma, { signal: controller.signal })
controller.abort()
await expect(conn).to.eventually.be.rejected()
expect(result).to.be.eql([Buffer.from('hey')])
})
it('should resolve port 0', async () => {
const ma = new multiaddr.Multiaddr('/ip4/127.0.0.1/tcp/0/ws')
const ma = multiaddr('/ip4/127.0.0.1/tcp/0/ws')
const ws = new WS({ upgrader: mockUpgrader })
// Create a Promise that resolves when a connection is handled
@ -263,40 +252,10 @@ describe('dial', () => {
})
})
describe('ip4 no loopback', () => {
let ws
let listener
const ma = new multiaddr.Multiaddr('/ip4/0.0.0.0/tcp/0/ws')
beforeEach(() => {
ws = new WS({ upgrader: mockUpgrader })
listener = ws.createListener(conn => pipe(conn, conn))
return listener.listen(ma)
})
afterEach(() => listener.close())
it('dial', async () => {
const addrs = listener.getAddrs().filter((ma) => {
const { address } = ma.nodeAddress()
return !isLoopbackAddr(address)
})
// Dial first no loopback address
const conn = await ws.dial(addrs[0])
const s = goodbye({ source: ['hey'], sink: collect })
const result = await pipe(s, conn, s)
expect(result).to.be.eql([uint8ArrayFromString('hey')])
})
})
describe('ip4 with wss', () => {
let ws
let listener
const ma = new multiaddr.Multiaddr('/ip4/127.0.0.1/tcp/9091/wss')
const ma = multiaddr('/ip4/127.0.0.1/tcp/9091/wss')
const server = https.createServer({
cert: fs.readFileSync('./test/fixtures/certificate.pem'),
@ -317,14 +276,14 @@ describe('dial', () => {
const result = await pipe(s, conn, s)
expect(result).to.be.eql([uint8ArrayFromString('hey')])
expect(result).to.be.eql([Buffer.from('hey')])
})
})
describe('ip6', () => {
let ws
let listener
const ma = new multiaddr.Multiaddr('/ip6/::1/tcp/9091')
const ma = multiaddr('/ip6/::1/tcp/9091')
beforeEach(() => {
ws = new WS({ upgrader: mockUpgrader })
@ -340,7 +299,7 @@ describe('dial', () => {
const result = await pipe(s, conn, s)
expect(result).to.be.eql([uint8ArrayFromString('hey')])
expect(result).to.be.eql([Buffer.from('hey')])
})
it('dial and use BufferList', async () => {
@ -349,11 +308,11 @@ describe('dial', () => {
const result = await pipe(s, conn, s)
expect(result).to.be.eql([uint8ArrayFromString('hey')])
expect(result).to.be.eql([Buffer.from('hey')])
})
it('dial with p2p Id', async () => {
const ma = new multiaddr.Multiaddr('/ip6/::1/tcp/9091/ws/p2p/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const ma = multiaddr('/ip6/::1/tcp/9091/ws/p2p/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const conn = await ws.dial(ma)
const s = goodbye({
@ -362,7 +321,7 @@ describe('dial', () => {
})
const result = await pipe(s, conn, s)
expect(result).to.be.eql([uint8ArrayFromString('hey')])
expect(result).to.be.eql([Buffer.from('hey')])
})
})
})
@ -370,92 +329,24 @@ describe('dial', () => {
describe('filter addrs', () => {
let ws
describe('default filter addrs with only dns', () => {
before(() => {
ws = new WS({ upgrader: mockUpgrader })
})
it('should filter out invalid WS addresses', function () {
const ma1 = new multiaddr.Multiaddr('/ip4/127.0.0.1/tcp/9090')
const ma2 = new multiaddr.Multiaddr('/ip4/127.0.0.1/udp/9090')
const ma3 = new multiaddr.Multiaddr('/ip6/::1/tcp/80')
const ma4 = new multiaddr.Multiaddr('/dnsaddr/ipfs.io/tcp/80')
const valid = ws.filter([ma1, ma2, ma3, ma4])
expect(valid.length).to.equal(0)
})
it('should filter correct dns address', function () {
const ma1 = new multiaddr.Multiaddr('/dnsaddr/ipfs.io/ws')
const ma2 = new multiaddr.Multiaddr('/dnsaddr/ipfs.io/tcp/80/ws')
const ma3 = new multiaddr.Multiaddr('/dnsaddr/ipfs.io/tcp/80/wss')
const valid = ws.filter([ma1, ma2, ma3])
expect(valid.length).to.equal(3)
expect(valid[0]).to.deep.equal(ma1)
expect(valid[1]).to.deep.equal(ma2)
expect(valid[2]).to.deep.equal(ma3)
})
it('should filter correct dns address with ipfs id', function () {
const ma1 = new multiaddr.Multiaddr('/dnsaddr/ipfs.io/tcp/80/ws/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const ma2 = new multiaddr.Multiaddr('/dnsaddr/ipfs.io/tcp/443/wss/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const valid = ws.filter([ma1, ma2])
expect(valid.length).to.equal(2)
expect(valid[0]).to.deep.equal(ma1)
expect(valid[1]).to.deep.equal(ma2)
})
it('should filter correct dns4 address', function () {
const ma1 = new multiaddr.Multiaddr('/dns4/ipfs.io/tcp/80/ws')
const ma2 = new multiaddr.Multiaddr('/dns4/ipfs.io/tcp/443/wss')
const valid = ws.filter([ma1, ma2])
expect(valid.length).to.equal(2)
expect(valid[0]).to.deep.equal(ma1)
expect(valid[1]).to.deep.equal(ma2)
})
it('should filter correct dns6 address', function () {
const ma1 = new multiaddr.Multiaddr('/dns6/ipfs.io/tcp/80/ws')
const ma2 = new multiaddr.Multiaddr('/dns6/ipfs.io/tcp/443/wss')
const valid = ws.filter([ma1, ma2])
expect(valid.length).to.equal(2)
expect(valid[0]).to.deep.equal(ma1)
expect(valid[1]).to.deep.equal(ma2)
})
it('should filter correct dns6 address with ipfs id', function () {
const ma1 = new multiaddr.Multiaddr('/dns6/ipfs.io/tcp/80/ws/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const ma2 = new multiaddr.Multiaddr('/dns6/ipfs.io/tcp/443/wss/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const valid = ws.filter([ma1, ma2])
expect(valid.length).to.equal(2)
expect(valid[0]).to.deep.equal(ma1)
expect(valid[1]).to.deep.equal(ma2)
})
before(() => {
ws = new WS({ upgrader: mockUpgrader })
})
describe('custom filter addrs', () => {
before(() => {
ws = new WS({ upgrader: mockUpgrader, filter: filters.all })
})
describe('filter valid addrs for this transport', function () {
it('should fail invalid WS addresses', function () {
const ma1 = new multiaddr.Multiaddr('/ip4/127.0.0.1/tcp/9090')
const ma2 = new multiaddr.Multiaddr('/ip4/127.0.0.1/udp/9090')
const ma3 = new multiaddr.Multiaddr('/ip6/::1/tcp/80')
const ma4 = new multiaddr.Multiaddr('/dnsaddr/ipfs.io/tcp/80')
const ma1 = multiaddr('/ip4/127.0.0.1/tcp/9090')
const ma2 = multiaddr('/ip4/127.0.0.1/udp/9090')
const ma3 = multiaddr('/ip6/::1/tcp/80')
const ma4 = multiaddr('/dnsaddr/ipfs.io/tcp/80')
const valid = ws.filter([ma1, ma2, ma3, ma4])
expect(valid.length).to.equal(0)
})
it('should filter correct ipv4 addresses', function () {
const ma1 = new multiaddr.Multiaddr('/ip4/127.0.0.1/tcp/80/ws')
const ma2 = new multiaddr.Multiaddr('/ip4/127.0.0.1/tcp/443/wss')
const ma1 = multiaddr('/ip4/127.0.0.1/tcp/80/ws')
const ma2 = multiaddr('/ip4/127.0.0.1/tcp/443/wss')
const valid = ws.filter([ma1, ma2])
expect(valid.length).to.equal(2)
@ -464,8 +355,8 @@ describe('filter addrs', () => {
})
it('should filter correct ipv4 addresses with ipfs id', function () {
const ma1 = new multiaddr.Multiaddr('/ip4/127.0.0.1/tcp/80/ws/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const ma2 = new multiaddr.Multiaddr('/ip4/127.0.0.1/tcp/80/wss/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const ma1 = multiaddr('/ip4/127.0.0.1/tcp/80/ws/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const ma2 = multiaddr('/ip4/127.0.0.1/tcp/80/wss/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const valid = ws.filter([ma1, ma2])
expect(valid.length).to.equal(2)
@ -474,8 +365,8 @@ describe('filter addrs', () => {
})
it('should filter correct ipv6 address', function () {
const ma1 = new multiaddr.Multiaddr('/ip6/::1/tcp/80/ws')
const ma2 = new multiaddr.Multiaddr('/ip6/::1/tcp/443/wss')
const ma1 = multiaddr('/ip6/::1/tcp/80/ws')
const ma2 = multiaddr('/ip6/::1/tcp/443/wss')
const valid = ws.filter([ma1, ma2])
expect(valid.length).to.equal(2)
@ -484,8 +375,8 @@ describe('filter addrs', () => {
})
it('should filter correct ipv6 addresses with ipfs id', function () {
const ma1 = new multiaddr.Multiaddr('/ip6/::1/tcp/80/ws/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const ma2 = new multiaddr.Multiaddr('/ip6/::1/tcp/443/wss/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const ma1 = multiaddr('/ip6/::1/tcp/80/ws/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const ma2 = multiaddr('/ip6/::1/tcp/443/wss/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const valid = ws.filter([ma1, ma2])
expect(valid.length).to.equal(2)
@ -494,9 +385,9 @@ describe('filter addrs', () => {
})
it('should filter correct dns address', function () {
const ma1 = new multiaddr.Multiaddr('/dnsaddr/ipfs.io/ws')
const ma2 = new multiaddr.Multiaddr('/dnsaddr/ipfs.io/tcp/80/ws')
const ma3 = new multiaddr.Multiaddr('/dnsaddr/ipfs.io/tcp/80/wss')
const ma1 = multiaddr('/dnsaddr/ipfs.io/ws')
const ma2 = multiaddr('/dnsaddr/ipfs.io/tcp/80/ws')
const ma3 = multiaddr('/dnsaddr/ipfs.io/tcp/80/wss')
const valid = ws.filter([ma1, ma2, ma3])
expect(valid.length).to.equal(3)
@ -506,8 +397,8 @@ describe('filter addrs', () => {
})
it('should filter correct dns address with ipfs id', function () {
const ma1 = new multiaddr.Multiaddr('/dnsaddr/ipfs.io/tcp/80/ws/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const ma2 = new multiaddr.Multiaddr('/dnsaddr/ipfs.io/tcp/443/wss/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const ma1 = multiaddr('/dnsaddr/ipfs.io/tcp/80/ws/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const ma2 = multiaddr('/dnsaddr/ipfs.io/tcp/443/wss/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const valid = ws.filter([ma1, ma2])
expect(valid.length).to.equal(2)
@ -516,8 +407,8 @@ describe('filter addrs', () => {
})
it('should filter correct dns4 address', function () {
const ma1 = new multiaddr.Multiaddr('/dns4/ipfs.io/tcp/80/ws')
const ma2 = new multiaddr.Multiaddr('/dns4/ipfs.io/tcp/443/wss')
const ma1 = multiaddr('/dns4/ipfs.io/tcp/80/ws')
const ma2 = multiaddr('/dns4/ipfs.io/tcp/443/wss')
const valid = ws.filter([ma1, ma2])
expect(valid.length).to.equal(2)
@ -526,8 +417,8 @@ describe('filter addrs', () => {
})
it('should filter correct dns6 address', function () {
const ma1 = new multiaddr.Multiaddr('/dns6/ipfs.io/tcp/80/ws')
const ma2 = new multiaddr.Multiaddr('/dns6/ipfs.io/tcp/443/wss')
const ma1 = multiaddr('/dns6/ipfs.io/tcp/80/ws')
const ma2 = multiaddr('/dns6/ipfs.io/tcp/443/wss')
const valid = ws.filter([ma1, ma2])
expect(valid.length).to.equal(2)
@ -536,8 +427,8 @@ describe('filter addrs', () => {
})
it('should filter correct dns6 address with ipfs id', function () {
const ma1 = new multiaddr.Multiaddr('/dns6/ipfs.io/tcp/80/ws/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const ma2 = new multiaddr.Multiaddr('/dns6/ipfs.io/tcp/443/wss/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const ma1 = multiaddr('/dns6/ipfs.io/tcp/80/ws/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const ma2 = multiaddr('/dns6/ipfs.io/tcp/443/wss/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const valid = ws.filter([ma1, ma2])
expect(valid.length).to.equal(2)
@ -546,11 +437,11 @@ describe('filter addrs', () => {
})
it('should filter mixed addresses', function () {
const ma1 = new multiaddr.Multiaddr('/dns6/ipfs.io/tcp/80/ws/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const ma2 = new multiaddr.Multiaddr('/ip4/127.0.0.1/tcp/9090')
const ma3 = new multiaddr.Multiaddr('/ip4/127.0.0.1/udp/9090')
const ma4 = new multiaddr.Multiaddr('/dns6/ipfs.io/ws')
const mh5 = new multiaddr.Multiaddr('/ip4/127.0.0.1/tcp/9090/ws/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw' +
const ma1 = multiaddr('/dns6/ipfs.io/tcp/80/ws/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const ma2 = multiaddr('/ip4/127.0.0.1/tcp/9090')
const ma3 = multiaddr('/ip4/127.0.0.1/udp/9090')
const ma4 = multiaddr('/dns6/ipfs.io/ws')
const mh5 = multiaddr('/ip4/127.0.0.1/tcp/9090/ws/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw' +
'/p2p-circuit/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const valid = ws.filter([ma1, ma2, ma3, ma4, mh5])
@ -558,13 +449,14 @@ describe('filter addrs', () => {
expect(valid[0]).to.deep.equal(ma1)
expect(valid[1]).to.deep.equal(ma4)
})
})
it('filter a single addr for this transport', () => {
const ma = new multiaddr.Multiaddr('/ip4/127.0.0.1/tcp/9090/ws/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
it('filter a single addr for this transport', (done) => {
const ma = multiaddr('/ip4/127.0.0.1/tcp/9090/ws/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const valid = ws.filter(ma)
expect(valid.length).to.equal(1)
expect(valid[0]).to.deep.equal(ma)
})
const valid = ws.filter(ma)
expect(valid.length).to.equal(1)
expect(valid[0]).to.deep.equal(ma)
done()
})
})