Compare commits

...

75 Commits

Author SHA1 Message Date
0d1861a1f8 chore: release version v0.11.4 2018-02-07 05:58:11 +00:00
929408eb38 chore: update contributors 2018-02-07 05:58:11 +00:00
b94f9c5d51 test: refactor 2018-02-07 05:56:55 +00:00
4b0851b4a4 chore: release version v0.11.3 2018-02-07 05:45:42 +00:00
74771b9504 chore: update contributors 2018-02-07 05:45:42 +00:00
48eefa1b40 chore: update deps 2018-02-07 05:45:30 +00:00
f8f52665f7 fix: clearing timeout when closes (#87) 2018-02-07 05:43:15 +00:00
d804244239 chore: release version v0.11.2 2018-01-12 12:30:45 +00:00
31c720f285 chore: update contributors 2018-01-12 12:30:45 +00:00
c553e0448f chore: fix release script 2018-01-12 12:30:38 +00:00
533835d22f test: do not run IPv6 tests on CI (#86)
* test: do not run IPv6 tests on CI

* Updating CI files (#83)

This commit updates all CI scripts to the latest version

* chore: use env variable instead

* skip the other IPv6 tests
2018-01-12 12:27:39 +00:00
74a88f6868 fix: missing dependency debug, fixes #84 2018-01-12 12:01:54 +00:00
1de9f18894 chore: update gitignore 2017-10-13 17:17:54 +02:00
2673ae48b0 chore: release version v0.11.1 2017-10-13 17:17:16 +02:00
9a4425f5ba chore: update contributors 2017-10-13 17:17:16 +02:00
50d6a7b7cf chre: fix linting 2017-10-13 17:17:11 +02:00
0a515f8fda chore: update deps and CI config 2017-10-13 17:15:36 +02:00
11c4f451f4 feat: relay filtering
* feat: filter IPFS addrs correctly

* feat: mafmt addrs now support /ipfs no need for ad-hoc filtering

* feat: skip p2p-circuit addresses
2017-10-13 17:13:28 +02:00
7572279838 chore: release version v0.11.0 2017-09-03 10:02:33 +01:00
181ce4eef2 chore: update contributors 2017-09-03 10:02:33 +01:00
f8075be92a docs: update badge on readme 2017-09-03 10:02:10 +01:00
a54bb83657 feat: p2p addrs situation (#82)
* chore: update gitignore

* chore: update CI configs

* chore: update deps

* chore: small refactor
2017-09-03 10:01:16 +01:00
ef45cc9a34 chore: release version v0.10.2 2017-07-22 14:42:22 -07:00
ce5f023508 chore: update contributors 2017-07-22 14:42:21 -07:00
2f9b1fe7fe chore: update deps 2017-07-22 14:40:25 -07:00
46672b669f chore: release version v0.10.1 2017-04-13 15:10:07 +01:00
31f69ec3c2 chore: update contributors 2017-04-13 15:10:07 +01:00
afed19439a chore: update deps 2017-04-10 14:32:05 -04:00
4b78faae3f Merge pull request #79 from libp2p/fix/catch-socket-reset-errors
fix: catch errors on incomming sockets
2017-04-10 14:19:24 -04:00
e204517a51 fix: catch errors on incomming sockets 2017-04-07 11:51:56 -04:00
4694f9dd47 chore: release version v0.10.0 2017-03-27 16:21:35 +01:00
dd6e067125 chore: update contributors 2017-03-27 16:21:34 +01:00
fb382a3e2a codestyle: fix linting 2017-03-27 16:21:26 +01:00
fd741367a2 chore: update deps 2017-03-27 16:19:30 +01:00
4d4f295dd5 fix(dial): proper error handling on dial (#77) 2017-03-27 16:18:55 +01:00
0edc487b23 chore: release version v0.9.4 2017-03-21 14:27:22 +00:00
c3ad8ce47a chore: update contributors 2017-03-21 14:27:22 +00:00
665b755922 chore: update aegir 2017-03-21 14:27:16 +00:00
1a550bac26 chore: release version v0.9.3 2017-02-09 09:01:06 -08:00
51c5594d49 chore: update contributors 2017-02-09 09:01:05 -08:00
d5476caee1 missing dep 2017-02-09 09:00:58 -08:00
4b211f5cd6 chore: release version v0.9.2 2017-02-09 08:34:54 -08:00
433188f182 chore: update contributors 2017-02-09 08:34:54 -08:00
f3de45d198 chore: ^ to ~ 2017-02-09 08:33:48 -08:00
2afaed5f2a chore(package): update multiaddr to version 2.1.3 (#62)
https://greenkeeper.io/
2017-01-19 11:05:56 +01:00
308dead134 chore(package): update mafmt to version 2.1.4 (#63)
https://greenkeeper.io/
2017-01-16 17:05:57 +01:00
1c8603b721 chore(package): update mafmt to version 2.1.3 (#61)
https://greenkeeper.io/
2017-01-16 16:18:52 +01:00
c883475a4f chore(package): update aegir to version 9.3.0 (#57)
https://greenkeeper.io/
2016-12-18 11:44:36 +00:00
515c6a32ec chore(package): update ip-address to version 5.8.6 (#60)
https://greenkeeper.io/
2016-12-18 11:38:42 +00:00
a107e1da57 chore(package): update pre-commit to version 1.2.2 (#58)
https://greenkeeper.io/
2016-12-18 11:37:15 +00:00
2ec97b3c8c chore(package): update pre-commit to version 1.2.0 (#53)
https://greenkeeper.io/
2016-12-10 12:02:44 -08:00
cb449a6c5c chore(package): update aegir to version 9.2.1 (#54)
https://greenkeeper.io/
2016-12-10 12:01:37 -08:00
1773efecdf chore(package): update ip-address to version 5.8.4 (#52)
https://greenkeeper.io/
2016-12-08 19:19:52 -08:00
49e23f1961 refactor: use lodash.includes instead of lodash.contains
As `loadash.contains` is deprecated.
2016-12-04 13:28:18 +01:00
10b35b22f6 chore(package): update multiaddr to version 2.1.1 (#47)
https://greenkeeper.io/
2016-11-28 12:02:56 +00:00
5677e12592 Merge pull request #44 from libp2p/greenkeeper-aegir-9.1.1
aegir@9.1.1 breaks build ⚠️
2016-11-07 16:12:35 +01:00
9524e8670a chore(package): update aegir to version 9.1.1
https://greenkeeper.io/
2016-11-04 16:07:36 +01:00
32dc4fa5c6 chore: release version v0.9.1 2016-11-03 08:29:14 +00:00
9d697f66a4 chore: update contributors 2016-11-03 08:29:14 +00:00
fb6c61abe9 chore: update deps 2016-11-03 08:29:09 +00:00
114998db1c chore: release version v0.9.0 2016-11-03 08:23:38 +00:00
4a94e3ca01 chore: update contributors 2016-11-03 08:23:38 +00:00
e451201848 Async Crypto Endeavour (#40) 2016-11-03 08:22:32 +00:00
e7524e1747 docs(readme): fix coverage badge 2016-09-09 12:13:14 +02:00
06689e3ff0 fix(deps): remove unused pull dep 2016-09-09 11:49:11 +02:00
376f938cc0 Merge pull request #34 from libp2p/greenkeeper-aegir-8.0.1
aegir@8.0.1 breaks build ⚠️
2016-09-08 20:07:25 -04:00
a2958b9bca chore(package): update aegir to version 8.0.1
https://greenkeeper.io/
2016-09-09 01:34:28 +02:00
7b7e521e57 Merge pull request #33 from libp2p/greenkeeper-multiaddr-2.0.3
multiaddr@2.0.3 breaks build ⚠️
2016-09-07 20:21:13 -04:00
2330732ed5 chore(package): update multiaddr to version 2.0.3
https://greenkeeper.io/
2016-09-08 01:20:22 +02:00
7b7e7f6344 Merge pull request #31 from libp2p/greenkeeper-aegir-8.0.0
Update aegir to version 8.0.0 🚀
2016-09-07 14:13:02 -04:00
850a414e6f chore: release version v0.8.1 2016-09-06 09:31:40 -04:00
f6df6cfa40 chore: update contributors 2016-09-06 09:31:40 -04:00
c16376f567 Merge pull request #32 from libp2p/feature/standardize-readme
Standardize Readme
2016-09-06 09:24:19 -04:00
0025407a5b Standardize Readme
Also did some edits to the text here and there. Added a contribute section, too.
2016-09-06 09:16:32 -04:00
48708ac4d2 chore(package): update aegir to version 8.0.0
https://greenkeeper.io/
2016-09-06 15:11:49 +02:00
18 changed files with 768 additions and 368 deletions

19
.gitignore vendored
View File

@ -1,7 +1,15 @@
docs
**/node_modules/
**/*.log
test/repo-tests*
**/bundle.js
# Logs # Logs
logs logs
*.log *.log
coverage
# Runtime data # Runtime data
pids pids
*.pid *.pid
@ -19,12 +27,17 @@ coverage
# node-waf configuration # node-waf configuration
.lock-wscript .lock-wscript
# Compiled binary addons (http://nodejs.org/api/addons.html) build
build/Release
# Dependency directory # Dependency directory
# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git # https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
node_modules node_modules
lib lib
dist dist
test/test-data/go-ipfs-repo/LOCK
test/test-data/go-ipfs-repo/LOG
test/test-data/go-ipfs-repo/LOG.old
# while testing npm5
package-lock.json

View File

@ -1,25 +1,32 @@
# Warning: This file is automatically synced from https://github.com/ipfs/ci-sync so if you want to change it, please change it there and ask someone to sync all repositories.
sudo: false sudo: false
language: node_js language: node_js
node_js:
- 4
- 5
- stable
# Make sure we have new NPM. matrix:
before_install: include:
- npm install -g npm - node_js: 6
env: CXX=g++-4.8
- node_js: 8
env: CXX=g++-4.8
# - node_js: stable
# env: CXX=g++-4.8
script: script:
- npm run lint - npm run lint
- npm test - npm run test
- npm run coverage - npm run coverage
addons:
firefox: 'latest'
before_script: before_script:
- export DISPLAY=:99.0 - export DISPLAY=:99.0
- sh -e /etc/init.d/xvfb start - sh -e /etc/init.d/xvfb start
after_success: after_success:
- npm run coverage-publish - npm run coverage-publish
addons:
firefox: 'latest'
apt:
sources:
- ubuntu-toolchain-r-test
packages:
- g++-4.8

223
CHANGELOG.md Normal file
View File

@ -0,0 +1,223 @@
<a name="0.11.4"></a>
## [0.11.4](https://github.com/libp2p/js-libp2p-tcp/compare/v0.11.3...v0.11.4) (2018-02-07)
<a name="0.11.3"></a>
## [0.11.3](https://github.com/libp2p/js-libp2p-tcp/compare/v0.11.2...v0.11.3) (2018-02-07)
### Bug Fixes
* clearing timeout when closes ([#87](https://github.com/libp2p/js-libp2p-tcp/issues/87)) ([f8f5266](https://github.com/libp2p/js-libp2p-tcp/commit/f8f5266))
<a name="0.11.2"></a>
## [0.11.2](https://github.com/libp2p/js-libp2p-tcp/compare/v0.11.1...v0.11.2) (2018-01-12)
### Bug Fixes
* missing dependency debug, fixes [#84](https://github.com/libp2p/js-libp2p-tcp/issues/84) ([74a88f6](https://github.com/libp2p/js-libp2p-tcp/commit/74a88f6))
<a name="0.11.1"></a>
## [0.11.1](https://github.com/libp2p/js-libp2p-tcp/compare/v0.11.0...v0.11.1) (2017-10-13)
### Features
* relay filtering ([11c4f45](https://github.com/libp2p/js-libp2p-tcp/commit/11c4f45))
<a name="0.11.0"></a>
# [0.11.0](https://github.com/libp2p/js-libp2p-tcp/compare/v0.10.2...v0.11.0) (2017-09-03)
### Features
* p2p addrs situation ([#82](https://github.com/libp2p/js-libp2p-tcp/issues/82)) ([a54bb83](https://github.com/libp2p/js-libp2p-tcp/commit/a54bb83))
<a name="0.10.2"></a>
## [0.10.2](https://github.com/libp2p/js-libp2p-tcp/compare/v0.10.1...v0.10.2) (2017-07-22)
<a name="0.10.1"></a>
## [0.10.1](https://github.com/libp2p/js-libp2p-tcp/compare/v0.10.0...v0.10.1) (2017-04-13)
### Bug Fixes
* catch errors on incomming sockets ([e204517](https://github.com/libp2p/js-libp2p-tcp/commit/e204517))
<a name="0.10.0"></a>
# [0.10.0](https://github.com/libp2p/js-libp2p-tcp/compare/v0.9.4...v0.10.0) (2017-03-27)
### Bug Fixes
* **dial:** proper error handling on dial ([#77](https://github.com/libp2p/js-libp2p-tcp/issues/77)) ([4d4f295](https://github.com/libp2p/js-libp2p-tcp/commit/4d4f295))
<a name="0.9.4"></a>
## [0.9.4](https://github.com/libp2p/js-libp2p-tcp/compare/v0.9.3...v0.9.4) (2017-03-21)
<a name="0.9.3"></a>
## [0.9.3](https://github.com/libp2p/js-libp2p-tcp/compare/v0.9.2...v0.9.3) (2017-02-09)
<a name="0.9.2"></a>
## [0.9.2](https://github.com/libp2p/js-libp2p-tcp/compare/v0.9.1...v0.9.2) (2017-02-09)
<a name="0.9.1"></a>
## [0.9.1](https://github.com/libp2p/js-libp2p-tcp/compare/v0.9.0...v0.9.1) (2016-11-03)
<a name="0.9.0"></a>
# [0.9.0](https://github.com/libp2p/js-libp2p-tcp/compare/v0.8.1...v0.9.0) (2016-11-03)
### Bug Fixes
* **deps:** remove unused pull dep ([06689e3](https://github.com/libp2p/js-libp2p-tcp/commit/06689e3))
<a name="0.8.1"></a>
## [0.8.1](https://github.com/libp2p/js-libp2p-tcp/compare/v0.8.0...v0.8.1) (2016-09-06)
<a name="0.8.0"></a>
# [0.8.0](https://github.com/libp2p/js-libp2p-tcp/compare/v0.7.4...v0.8.0) (2016-09-06)
### Features
* **deps:** update to published deps ([da8ee21](https://github.com/libp2p/js-libp2p-tcp/commit/da8ee21))
* **pull:** migration to pull-streams ([5e89a26](https://github.com/libp2p/js-libp2p-tcp/commit/5e89a26))
* **readme:** add pull-streams documentation ([d9f65e0](https://github.com/libp2p/js-libp2p-tcp/commit/d9f65e0))
<a name="0.7.4"></a>
## [0.7.4](https://github.com/libp2p/js-libp2p-tcp/compare/v0.7.3...v0.7.4) (2016-08-03)
<a name="0.7.3"></a>
## [0.7.3](https://github.com/libp2p/js-libp2p-tcp/compare/v0.7.2...v0.7.3) (2016-06-26)
<a name="0.7.2"></a>
## [0.7.2](https://github.com/libp2p/js-libp2p-tcp/compare/v0.7.1...v0.7.2) (2016-06-23)
<a name="0.7.1"></a>
## [0.7.1](https://github.com/libp2p/js-libp2p-tcp/compare/v0.7.0...v0.7.1) (2016-06-23)
### Bug Fixes
* error was passed in duplicate ([9ac5cca](https://github.com/libp2p/js-libp2p-tcp/commit/9ac5cca))
<a name="0.7.0"></a>
# [0.7.0](https://github.com/libp2p/js-libp2p-tcp/compare/v0.6.2...v0.7.0) (2016-06-22)
<a name="0.6.2"></a>
## [0.6.2](https://github.com/libp2p/js-libp2p-tcp/compare/v0.6.1...v0.6.2) (2016-06-01)
### Bug Fixes
* address cr ([2ed01e8](https://github.com/libp2p/js-libp2p-tcp/commit/2ed01e8))
* destroy hanging connections after timeout ([4a12169](https://github.com/libp2p/js-libp2p-tcp/commit/4a12169))
<a name="0.6.1"></a>
## [0.6.1](https://github.com/libp2p/js-libp2p-tcp/compare/v0.6.0...v0.6.1) (2016-05-29)
<a name="0.6.0"></a>
# [0.6.0](https://github.com/libp2p/js-libp2p-tcp/compare/v0.5.3...v0.6.0) (2016-05-22)
<a name="0.5.3"></a>
## [0.5.3](https://github.com/libp2p/js-libp2p-tcp/compare/v0.5.2...v0.5.3) (2016-05-22)
<a name="0.5.2"></a>
## [0.5.2](https://github.com/libp2p/js-libp2p-tcp/compare/v0.5.1...v0.5.2) (2016-05-09)
<a name="0.5.1"></a>
## [0.5.1](https://github.com/libp2p/js-libp2p-tcp/compare/v0.5.0...v0.5.1) (2016-05-08)
<a name="0.5.0"></a>
# [0.5.0](https://github.com/libp2p/js-libp2p-tcp/compare/v0.4.0...v0.5.0) (2016-04-25)
<a name="0.4.0"></a>
# [0.4.0](https://github.com/libp2p/js-libp2p-tcp/compare/v0.3.0...v0.4.0) (2016-03-14)
<a name="0.3.0"></a>
# [0.3.0](https://github.com/libp2p/js-libp2p-tcp/compare/v0.2.1...v0.3.0) (2016-03-10)
<a name="0.2.1"></a>
## [0.2.1](https://github.com/libp2p/js-libp2p-tcp/compare/v0.2.0...v0.2.1) (2016-03-04)
<a name="0.2.0"></a>
# [0.2.0](https://github.com/libp2p/js-libp2p-tcp/compare/v0.1.2...v0.2.0) (2016-03-04)
<a name="0.1.2"></a>
## [0.1.2](https://github.com/libp2p/js-libp2p-tcp/compare/v0.1.1...v0.1.2) (2015-10-29)
<a name="0.1.1"></a>
## [0.1.1](https://github.com/libp2p/js-libp2p-tcp/compare/v0.1.0...v0.1.1) (2015-09-17)
<a name="0.1.0"></a>
# 0.1.0 (2015-09-16)

View File

@ -1,6 +1,6 @@
The MIT License (MIT) The MIT License (MIT)
Copyright (c) 2015 David Dias Copyright (c) 2015-2016 David Dias
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal of this software and associated documentation files (the "Software"), to deal

View File

@ -3,22 +3,44 @@
[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io) [![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)
[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs) [![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
[![Build Status](https://travis-ci.org/libp2p/js-libp2p-tcp.svg?style=flat-square)](https://travis-ci.org/libp2p/js-libp2p-tcp) [![Build Status](https://travis-ci.org/libp2p/js-libp2p-tcp.svg?style=flat-square)](https://travis-ci.org/libp2p/js-libp2p-tcp)
![](https://img.shields.io/badge/coverage-%3F-yellow.svg?style=flat-square) [![Coverage Status](https://coveralls.io/repos/github/libp2p/js-libp2p-tcp/badge.svg?branch=master)](https://coveralls.io/github/libp2p/js-libp2p-tcp?branch=master)
[![Dependency Status](https://david-dm.org/libp2p/js-libp2p-tcp.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-tcp) [![Dependency Status](https://david-dm.org/libp2p/js-libp2p-tcp.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-tcp)
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)
![](https://img.shields.io/badge/npm-%3E%3D3.0.0-orange.svg?style=flat-square)
![](https://img.shields.io/badge/Node.js-%3E%3D6.0.0-orange.svg?style=flat-square)
![](https://raw.githubusercontent.com/libp2p/interface-connection/master/img/badge.png) ![](https://raw.githubusercontent.com/libp2p/interface-connection/master/img/badge.png)
![](https://raw.githubusercontent.com/libp2p/interface-transport/master/img/badge.png) ![](https://raw.githubusercontent.com/libp2p/interface-transport/master/img/badge.png)
> Node.js implementation of the TCP module that libp2p uses, which implements the [interface-connection](https://github.com/libp2p/interface-connection) interface for dial/listen. > Node.js implementation of the TCP module that libp2p uses, which implements the [interface-connection](https://github.com/libp2p/interface-connection) interface for dial/listen.
## Description
`libp2p-tcp` in Node.js is a very thin shim that adds support for dialing to a `multiaddr`. This small shim will enable libp2p to use other different transports. `libp2p-tcp` in Node.js is a very thin shim that adds support for dialing to a `multiaddr`. This small shim will enable libp2p to use other different transports.
**Note:** This module uses [pull-streams](https://pull-stream.github.io) for all stream based interfaces. **Note:** This module uses [pull-streams](https://pull-stream.github.io) for all stream based interfaces.
## Example ## Table of Contents
- [Install](#install)
- [npm](#npm)
- [Usage](#usage)
- [Example](#example)
- [This module uses `pull-streams`](#this-module-uses-pull-streams)
- [Converting `pull-streams` to Node.js Streams](#converting-pull-streams-to-nodejs-streams)
- [API](#api)
- [Contribute](#contribute)
- [License](#license)
## Install
### npm
```sh
> npm i libp2p-tcp
```
## Usage
### Example
```js ```js
const TCP = require('libp2p-tcp') const TCP = require('libp2p-tcp')
@ -51,25 +73,17 @@ listener.listen(() => {
}) })
``` ```
outputs Outputs:
``` ```sh
listening listening
new connection opened new connection opened
hello hello
``` ```
## Installation ### This module uses `pull-streams`
### npm We expose a streaming interface based on `pull-streams`, rather then on the Node.js core streams implementation (aka Node.js streams). `pull-streams` offers us a better mechanism for error handling and flow control guarantees. If you would like to know more about why we did this, see the discussion at this [issue](https://github.com/ipfs/js-ipfs/issues/362).
```sh
> npm i libp2p-tcp
```
## This module uses `pull-streams`
We expose a streaming interface based on `pull-streams`, rather then on the Node.js core streams implementation (aka Node.js streams). `pull-streams` offers us a better mechanism for error handling and flow control guarantees. If you would like to know more about what took us to make this migration, see the discussion at this [issue](https://github.com/ipfs/js-ipfs/issues/362).
You can learn more about pull-streams at: You can learn more about pull-streams at:
@ -78,22 +92,22 @@ You can learn more about pull-streams at:
- [pull-streams, the simple streaming primitive](http://dominictarr.com/post/149248845122/pull-streams-pull-streams-are-a-very-simple) - [pull-streams, the simple streaming primitive](http://dominictarr.com/post/149248845122/pull-streams-pull-streams-are-a-very-simple)
- [pull-streams documentation](https://pull-stream.github.io/) - [pull-streams documentation](https://pull-stream.github.io/)
### Converting `pull-streams` to Node.js Streams #### Converting `pull-streams` to Node.js Streams
If you are a Node.js streams user, you can convert a pull-stream to Node.js Stream using the module `pull-stream-to-stream`, giving you an instance of a Node.js stream that is linked to the pull-stream. Example: If you are a Node.js streams user, you can convert a pull-stream to a Node.js stream using the module [`pull-stream-to-stream`](https://github.com/dominictarr/pull-stream-to-stream), giving you an instance of a Node.js stream that is linked to the pull-stream. For example:
``` ```js
const pullToStream = require('pull-stream-to-stream') const pullToStream = require('pull-stream-to-stream')
const nodeStreamInstance = pullToStream(pullStreamInstance) const nodeStreamInstance = pullToStream(pullStreamInstance)
// nodeStreamInstance is an instance of a Node.js Stream // nodeStreamInstance is an instance of a Node.js Stream
``` ```
To learn more about his utility, visit https://pull-stream.github.io/#pull-stream-to-stream To learn more about this utility, visit https://pull-stream.github.io/#pull-stream-to-stream.
## API ## API
[![](https://raw.githubusercontent.com/diasdavid/interface-transport/master/img/badge.png)](https://github.com/diasdavid/interface-transport) [![](https://raw.githubusercontent.com/libp2p/interface-transport/master/img/badge.png)](https://github.com/libp2p/interface-transport)
`libp2p-tcp` accepts TCP addresses both IPFS and non IPFS encapsulated addresses, i.e: `libp2p-tcp` accepts TCP addresses both IPFS and non IPFS encapsulated addresses, i.e:
@ -102,6 +116,18 @@ To learn more about his utility, visit https://pull-stream.github.io/#pull-strea
Both for dialing and listening. Both for dialing and listening.
## Contribute
Contributions are welcome! The libp2p implementation in JavaScript is a work in progress. As such, there's a few things you can do right now to help out:
- [Check out the existing issues](//github.com/libp2p/js-libp2p-tcp/issues).
- **Perform code reviews**.
- **Add tests**. There can never be enough tests.
Please be aware that all interactions related to libp2p are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
Small note: If editing the README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.
## License ## License
MIT [MIT](LICENSE) © 2015-2016 David Dias

29
appveyor.yml Normal file
View File

@ -0,0 +1,29 @@
# Warning: This file is automatically synced from https://github.com/ipfs/ci-sync so if you want to change it, please change it there and ask someone to sync all repositories.
version: "{build}"
environment:
matrix:
- nodejs_version: "6"
- nodejs_version: "8"
matrix:
fast_finish: true
install:
# Install Node.js
- ps: Install-Product node $env:nodejs_version
# Upgrade npm
- npm install -g npm
# Output our current versions for debugging
- node --version
- npm --version
# Install our package dependencies
- npm install
test_script:
- npm run test:node
build: off

2
ci/Jenkinsfile vendored Normal file
View File

@ -0,0 +1,2 @@
// Warning: This file is automatically synced from https://github.com/ipfs/ci-sync so if you want to change it, please change it there and ask someone to sync all repositories.
javascript()

View File

@ -1,3 +1,4 @@
# Warning: This file is automatically synced from https://github.com/ipfs/ci-sync so if you want to change it, please change it there and ask someone to sync all repositories.
machine: machine:
node: node:
version: stable version: stable
@ -5,8 +6,10 @@ machine:
dependencies: dependencies:
pre: pre:
- google-chrome --version - google-chrome --version
- wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | sudo apt-key add - - curl -L -o google-chrome.deb https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb
- sudo sh -c 'echo "deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list' - sudo dpkg -i google-chrome.deb || true
- sudo apt-get update - sudo apt-get update
- sudo apt-get --only-upgrade install google-chrome-stable - sudo apt-get install -f
- sudo apt-get install --only-upgrade lsb-base
- sudo dpkg -i google-chrome.deb
- google-chrome --version - google-chrome --version

View File

@ -1,26 +1,24 @@
{ {
"name": "libp2p-tcp", "name": "libp2p-tcp",
"version": "0.8.0", "version": "0.11.4",
"description": "Node.js implementation of the TCP module that libp2p uses, which implements the interface-connection and interface-transport interfaces", "description": "Node.js implementation of the TCP module that libp2p uses, which implements the interface-connection and interface-transport interfaces",
"main": "lib/index.js", "main": "src/index.js",
"jsnext:main": "src/index.js",
"scripts": { "scripts": {
"lint": "aegir-lint", "lint": "aegir lint",
"build": "aegir-build --env node", "test": "aegir test -t node",
"test": "aegir-test --env node", "release": "aegir release -t node --no-build",
"release": "aegir-release --env node", "release-minor": "aegir release -t node --type minor --no-build",
"release-minor": "aegir-release --type minor --env node", "release-major": "aegir-release -t node --type major --no-build",
"release-major": "aegir-release --type major --env node", "coverage": "aegir coverage",
"coverage": "aegir-coverage", "coverage-publish": "aegir coverage --provider coveralls"
"coverage-publish": "aegir-coverage publish"
}, },
"pre-commit": [ "pre-push": [
"lint", "lint",
"test" "test"
], ],
"repository": { "repository": {
"type": "git", "type": "git",
"url": "https://github.com/diasdavid/js-libp2p-tcp.git" "url": "https://github.com/libp2p/js-libp2p-tcp.git"
}, },
"keywords": [ "keywords": [
"IPFS" "IPFS"
@ -28,32 +26,44 @@
"author": "David Dias <daviddias@ipfs.io>", "author": "David Dias <daviddias@ipfs.io>",
"license": "MIT", "license": "MIT",
"bugs": { "bugs": {
"url": "https://github.com/diasdavid/js-libp2p-tcp/issues" "url": "https://github.com/libp2p/js-libp2p-tcp/issues"
},
"homepage": "https://github.com/libp2p/js-libp2p-tcp",
"engines": {
"node": ">=6.0.0",
"npm": ">=3.0.0"
}, },
"homepage": "https://github.com/diasdavid/js-libp2p-tcp",
"devDependencies": { "devDependencies": {
"aegir": "^6.0.1", "aegir": "^12.4.0",
"chai": "^3.5.0", "chai": "^4.1.2",
"interface-transport": "^0.3.3", "dirty-chai": "^2.0.1",
"lodash.isfunction": "^3.0.8", "interface-transport": "~0.3.5",
"pre-commit": "^1.1.2" "lodash.isfunction": "^3.0.9",
"pre-commit": "^1.2.2",
"pull-stream": "^3.6.1"
}, },
"dependencies": { "dependencies": {
"interface-connection": "0.2.1", "debug": "^3.1.0",
"ip-address": "^5.8.0", "interface-connection": "~0.3.2",
"lodash.contains": "^2.4.3", "ip-address": "^5.8.9",
"mafmt": "^2.1.2", "lodash.includes": "^4.3.0",
"multiaddr": "^2.0.2", "lodash.isfunction": "^3.0.9",
"pull": "^2.1.1", "mafmt": "^3.0.2",
"stream-to-pull-stream": "^1.7.0" "multiaddr": "^3.0.2",
"once": "^1.4.0",
"stream-to-pull-stream": "^1.7.2"
}, },
"contributors": [ "contributors": [
"Alan Shaw <alan@tableflip.io>",
"David Dias <daviddias.p@gmail.com>", "David Dias <daviddias.p@gmail.com>",
"Dmitriy Ryajov <dryajov@gmail.com>",
"Evan Schwartz <evan.mark.schwartz@gmail.com>", "Evan Schwartz <evan.mark.schwartz@gmail.com>",
"Friedel Ziegelmayer <dignifiedquire@gmail.com>",
"Greenkeeper <support@greenkeeper.io>",
"João Antunes <j.goncalo.antunes@gmail.com>", "João Antunes <j.goncalo.antunes@gmail.com>",
"Pedro Teixeira <i@pgte.me>",
"Prashanth Chandra <coolshanth94@gmail.com>",
"Richard Littauer <richard.littauer@gmail.com>", "Richard Littauer <richard.littauer@gmail.com>",
"Stephen Whitmore <stephen.whitmore@gmail.com>", "Stephen Whitmore <stephen.whitmore@gmail.com>"
"dignifiedquire <dignifiedquire@gmail.com>",
"greenkeeperio-bot <support@greenkeeper.io>"
] ]
} }

View File

@ -4,7 +4,7 @@ const multiaddr = require('multiaddr')
const Address6 = require('ip-address').Address6 const Address6 = require('ip-address').Address6
module.exports = (socket) => { module.exports = (socket) => {
var mh let mh
if (socket.remoteFamily === 'IPv6') { if (socket.remoteFamily === 'IPv6') {
var addr = new Address6(socket.remoteAddress) var addr = new Address6(socket.remoteAddress)

View File

@ -3,41 +3,50 @@
const net = require('net') const net = require('net')
const toPull = require('stream-to-pull-stream') const toPull = require('stream-to-pull-stream')
const mafmt = require('mafmt') const mafmt = require('mafmt')
const contains = require('lodash.contains') const includes = require('lodash.includes')
const isFunction = require('lodash.isfunction') const isFunction = require('lodash.isfunction')
const Connection = require('interface-connection').Connection const Connection = require('interface-connection').Connection
const once = require('once')
const debug = require('debug') const debug = require('debug')
const log = debug('libp2p:tcp:dial') const log = debug('libp2p:tcp:dial')
const createListener = require('./listener') const createListener = require('./listener')
module.exports = class TCP { function noop () {}
dial (ma, options, cb) {
class TCP {
dial (ma, options, callback) {
if (isFunction(options)) { if (isFunction(options)) {
cb = options callback = options
options = {} options = {}
} }
if (!cb) { callback = callback || noop
cb = () => {}
}
callback = once(callback)
const cOpts = ma.toOptions() const cOpts = ma.toOptions()
log('Connecting to %s %s', cOpts.port, cOpts.host) log('Connecting to %s %s', cOpts.port, cOpts.host)
const rawSocket = net.connect(cOpts, cb) const rawSocket = net.connect(cOpts)
rawSocket.once('timeout', () => { rawSocket.once('timeout', () => {
log('timeout') log('timeout')
rawSocket.emit('error', new Error('Timeout')) rawSocket.emit('error', new Error('Timeout'))
}) })
rawSocket.once('error', callback)
rawSocket.once('connect', () => {
rawSocket.removeListener('error', callback)
callback()
})
const socket = toPull.duplex(rawSocket) const socket = toPull.duplex(rawSocket)
const conn = new Connection(socket) const conn = new Connection(socket)
conn.getObservedAddrs = (cb) => { conn.getObservedAddrs = (callback) => {
return cb(null, [ma]) return callback(null, [ma])
} }
return conn return conn
@ -58,11 +67,19 @@ module.exports = class TCP {
if (!Array.isArray(multiaddrs)) { if (!Array.isArray(multiaddrs)) {
multiaddrs = [multiaddrs] multiaddrs = [multiaddrs]
} }
return multiaddrs.filter((ma) => { return multiaddrs.filter((ma) => {
if (contains(ma.protoNames(), 'ipfs')) { if (includes(ma.protoNames(), 'p2p-circuit')) {
return false
}
if (includes(ma.protoNames(), 'ipfs')) {
ma = ma.decapsulate('ipfs') ma = ma.decapsulate('ipfs')
} }
return mafmt.TCP.matches(ma) return mafmt.TCP.matches(ma)
}) })
} }
} }
module.exports = TCP

View File

@ -3,7 +3,7 @@
const multiaddr = require('multiaddr') const multiaddr = require('multiaddr')
const Connection = require('interface-connection').Connection const Connection = require('interface-connection').Connection
const os = require('os') const os = require('os')
const contains = require('lodash.contains') const includes = require('lodash.includes')
const net = require('net') const net = require('net')
const toPull = require('stream-to-pull-stream') const toPull = require('stream-to-pull-stream')
const EventEmitter = require('events').EventEmitter const EventEmitter = require('events').EventEmitter
@ -15,16 +15,22 @@ const getMultiaddr = require('./get-multiaddr')
const IPFS_CODE = 421 const IPFS_CODE = 421
const CLOSE_TIMEOUT = 2000 const CLOSE_TIMEOUT = 2000
function noop () {}
module.exports = (handler) => { module.exports = (handler) => {
const listener = new EventEmitter() const listener = new EventEmitter()
const server = net.createServer((socket) => { const server = net.createServer((socket) => {
// Avoid uncaught errors cause by unstable connections
socket.on('error', noop)
const addr = getMultiaddr(socket) const addr = getMultiaddr(socket)
log('new connection', addr.toString()) log('new connection', addr.toString())
const s = toPull.duplex(socket) const s = toPull.duplex(socket)
s.getObservedAddrs = (cb) => { s.getObservedAddrs = (cb) => {
return cb(null, [addr]) cb(null, [addr])
} }
trackSocket(server, socket) trackSocket(server, socket)
@ -34,66 +40,57 @@ module.exports = (handler) => {
listener.emit('connection', conn) listener.emit('connection', conn)
}) })
server.on('listening', () => { server.on('listening', () => listener.emit('listening'))
listener.emit('listening') server.on('error', (err) => listener.emit('error', err))
}) server.on('close', () => listener.emit('close'))
server.on('error', (err) => {
listener.emit('error', err)
})
server.on('close', () => {
listener.emit('close')
})
// Keep track of open connections to destroy in case of timeout // Keep track of open connections to destroy in case of timeout
server.__connections = {} server.__connections = {}
listener.close = (options, cb) => { listener.close = (options, callback) => {
if (typeof options === 'function') { if (typeof options === 'function') {
cb = options callback = options
options = {} options = {}
} }
cb = cb || (() => {}) callback = callback || noop
options = options || {} options = options || {}
let closed = false const timeout = setTimeout(() => {
server.close(cb)
server.once('close', () => {
closed = true
})
setTimeout(() => {
if (closed) return
log('unable to close graciously, destroying conns') log('unable to close graciously, destroying conns')
Object.keys(server.__connections).forEach((key) => { Object.keys(server.__connections).forEach((key) => {
log('destroying %s', key) log('destroying %s', key)
server.__connections[key].destroy() server.__connections[key].destroy()
}) })
}, options.timeout || CLOSE_TIMEOUT) }, options.timeout || CLOSE_TIMEOUT)
server.close(callback)
server.once('close', () => {
clearTimeout(timeout)
})
} }
let ipfsId let ipfsId
let listeningAddr let listeningAddr
listener.listen = (ma, cb) => { listener.listen = (ma, callback) => {
listeningAddr = ma listeningAddr = ma
if (contains(ma.protoNames(), 'ipfs')) { if (includes(ma.protoNames(), 'ipfs')) {
ipfsId = getIpfsId(ma) ipfsId = getIpfsId(ma)
listeningAddr = ma.decapsulate('ipfs') listeningAddr = ma.decapsulate('ipfs')
} }
const lOpts = listeningAddr.toOptions() const lOpts = listeningAddr.toOptions()
log('Listening on %s %s', lOpts.port, lOpts.host) log('Listening on %s %s', lOpts.port, lOpts.host)
return server.listen(lOpts.port, lOpts.host, cb) return server.listen(lOpts.port, lOpts.host, callback)
} }
listener.getAddrs = (cb) => { listener.getAddrs = (callback) => {
const multiaddrs = [] const multiaddrs = []
const address = server.address() const address = server.address()
if (!address) { if (!address) {
return cb(new Error('Listener is not ready yet')) return callback(new Error('Listener is not ready yet'))
} }
// Because TCP will only return the IPv6 version // Because TCP will only return the IPv6 version
@ -128,7 +125,7 @@ module.exports = (handler) => {
multiaddrs.push(ma) multiaddrs.push(ma)
} }
cb(null, multiaddrs) callback(null, multiaddrs)
} }
return listener return listener

View File

@ -0,0 +1,121 @@
/* eslint-env mocha */
'use strict'
const pull = require('pull-stream')
const chai = require('chai')
const dirtyChai = require('dirty-chai')
const expect = chai.expect
chai.use(dirtyChai)
const TCP = require('../src')
const multiaddr = require('multiaddr')
const Connection = require('interface-connection').Connection
describe('Connection Wrap', () => {
let tcp
let listener
const ma = multiaddr('/ip4/127.0.0.1/tcp/9090')
beforeEach((done) => {
tcp = new TCP()
listener = tcp.createListener((conn) => {
pull(conn, conn)
})
listener.on('listening', done)
listener.listen(ma)
})
afterEach((done) => {
listener.close(done)
})
it('simple wrap', (done) => {
const conn = tcp.dial(ma)
conn.setPeerInfo('peerInfo')
const connWrap = new Connection(conn)
pull(
pull.values(['hey']),
connWrap,
pull.collect((err, chunks) => {
expect(err).to.not.exist()
expect(chunks).to.be.eql([Buffer.from('hey')])
connWrap.getPeerInfo((err, peerInfo) => {
expect(err).to.not.exist()
expect(peerInfo).to.equal('peerInfo')
done()
})
})
)
})
it('buffer wrap', (done) => {
const conn = tcp.dial(ma)
const connWrap = new Connection()
pull(
pull.values(['hey']),
connWrap,
pull.collect((err, chunks) => {
expect(err).to.not.exist()
expect(chunks).to.be.eql([Buffer.from('hey')])
done()
})
)
connWrap.setInnerConn(conn)
})
it('overload wrap', (done) => {
const conn = tcp.dial(ma)
const connWrap = new Connection(conn)
connWrap.getPeerInfo = (callback) => {
callback(null, 'none')
}
conn.getPeerInfo((err, peerInfo) => {
expect(err).to.exist()
})
connWrap.getPeerInfo((err, peerInfo) => {
expect(err).to.not.exist()
expect(peerInfo).to.equal('none')
})
pull(
pull.values(['hey']),
connWrap,
pull.collect((err, chunks) => {
expect(err).to.not.exist()
expect(chunks).to.be.eql([Buffer.from('hey')])
done()
})
)
})
it('dial error', (done) => {
tcp.dial(multiaddr('/ip4/999.0.0.1/tcp/1234'), (err) => {
expect(err).to.exist()
done()
})
})
it('matryoshka wrap', (done) => {
const conn = tcp.dial(ma)
const connWrap1 = new Connection(conn)
const connWrap2 = new Connection(connWrap1)
const connWrap3 = new Connection(connWrap2)
conn.getPeerInfo = (callback) => {
callback(null, 'inner doll')
}
pull(
pull.values(['hey']),
connWrap3,
pull.collect((err, chunks) => {
expect(err).to.not.exist()
expect(chunks).to.eql([Buffer.from('hey')])
connWrap3.getPeerInfo((err, peerInfo) => {
expect(err).to.not.exist()
expect(peerInfo).to.equal('inner doll')
done()
})
})
)
})
})

111
test/connection.spec.js Normal file
View File

@ -0,0 +1,111 @@
/* eslint-env mocha */
'use strict'
const pull = require('pull-stream')
const chai = require('chai')
const dirtyChai = require('dirty-chai')
const expect = chai.expect
chai.use(dirtyChai)
const TCP = require('../src')
const multiaddr = require('multiaddr')
describe('valid Connection', () => {
let tcp
beforeEach(() => {
tcp = new TCP()
})
const ma = multiaddr('/ip4/127.0.0.1/tcp/9090')
it('get observed addrs', (done) => {
let dialerObsAddrs
const listener = tcp.createListener((conn) => {
expect(conn).to.exist()
conn.getObservedAddrs((err, addrs) => {
expect(err).to.not.exist()
dialerObsAddrs = addrs
pull(pull.empty(), conn)
})
})
listener.listen(ma, () => {
const conn = tcp.dial(ma)
pull(
conn,
pull.onEnd(endHandler)
)
function endHandler () {
conn.getObservedAddrs((err, addrs) => {
expect(err).to.not.exist()
pull(pull.empty(), conn)
closeAndAssert(listener, addrs)
})
}
function closeAndAssert (listener, addrs) {
listener.close(() => {
expect(addrs[0]).to.deep.equal(ma)
expect(dialerObsAddrs.length).to.equal(1)
done()
})
}
})
})
it('get Peer Info', (done) => {
const listener = tcp.createListener((conn) => {
expect(conn).to.exist()
conn.getPeerInfo((err, peerInfo) => {
expect(err).to.exist()
expect(peerInfo).to.not.exist()
pull(pull.empty(), conn)
})
})
listener.listen(ma, () => {
const conn = tcp.dial(ma)
pull(conn, pull.onEnd(endHandler))
function endHandler () {
conn.getPeerInfo((err, peerInfo) => {
expect(err).to.exist()
expect(peerInfo).to.not.exist()
listener.close(done)
})
}
})
})
it('set Peer Info', (done) => {
const listener = tcp.createListener((conn) => {
expect(conn).to.exist()
conn.setPeerInfo('batatas')
conn.getPeerInfo((err, peerInfo) => {
expect(err).to.not.exist()
expect(peerInfo).to.equal('batatas')
pull(pull.empty(), conn)
})
})
listener.listen(ma, () => {
const conn = tcp.dial(ma)
pull(conn, pull.onEnd(endHandler))
function endHandler () {
conn.setPeerInfo('arroz')
conn.getPeerInfo((err, peerInfo) => {
expect(err).to.not.exist()
expect(peerInfo).to.equal('arroz')
listener.close(done)
})
}
})
})
})

15
test/constructor.spec.js Normal file
View File

@ -0,0 +1,15 @@
/* eslint-env mocha */
'use strict'
const chai = require('chai')
const dirtyChai = require('dirty-chai')
const expect = chai.expect
chai.use(dirtyChai)
const TCP = require('../src')
describe('Constructor', () => {
it('create an instance', () => {
const tcp = new TCP()
expect(tcp).to.exist()
})
})

40
test/filter.spec.js Normal file
View File

@ -0,0 +1,40 @@
/* eslint-env mocha */
'use strict'
const chai = require('chai')
const dirtyChai = require('dirty-chai')
const expect = chai.expect
chai.use(dirtyChai)
const TCP = require('../src')
const multiaddr = require('multiaddr')
describe('filter addrs', () => {
let tcp
before(() => {
tcp = new TCP()
})
it('filter valid addrs for this transport', () => {
const mh1 = multiaddr('/ip4/127.0.0.1/tcp/9090')
const mh2 = multiaddr('/ip4/127.0.0.1/udp/9090')
const mh3 = multiaddr('/ip4/127.0.0.1/tcp/9090/http')
const mh4 = multiaddr('/ip4/127.0.0.1/tcp/9090/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const mh5 = multiaddr('/ip4/127.0.0.1/tcp/9090/http/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const mh6 = multiaddr('/ip4/127.0.0.1/tcp/9090/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw' +
'/p2p-circuit/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const valid = tcp.filter([mh1, mh2, mh3, mh4, mh5, mh6])
expect(valid.length).to.equal(2)
expect(valid[0]).to.deep.equal(mh1)
expect(valid[1]).to.deep.equal(mh4)
})
it('filter a single addr for this transport', () => {
const mh1 = multiaddr('/ip4/127.0.0.1/tcp/9090')
const valid = tcp.filter(mh1)
expect(valid.length).to.equal(1)
expect(valid[0]).to.deep.equal(mh1)
})
})

View File

@ -2,16 +2,19 @@
'use strict' 'use strict'
const pull = require('pull-stream') const pull = require('pull-stream')
const expect = require('chai').expect const chai = require('chai')
const dirtyChai = require('dirty-chai')
const expect = chai.expect
chai.use(dirtyChai)
const TCP = require('../src') const TCP = require('../src')
const net = require('net') const net = require('net')
const multiaddr = require('multiaddr') const multiaddr = require('multiaddr')
const Connection = require('interface-connection').Connection const isCI = process.env.CI
describe('instantiate the transport', () => { describe('instantiate the transport', () => {
it('create', () => { it('create', () => {
const tcp = new TCP() const tcp = new TCP()
expect(tcp).to.exist expect(tcp).to.exist()
}) })
}) })
@ -51,6 +54,7 @@ describe('listen', () => {
}) })
it('listen on IPv6 addr', (done) => { it('listen on IPv6 addr', (done) => {
if (isCI) { return done() }
const mh = multiaddr('/ip6/::/tcp/9090') const mh = multiaddr('/ip6/::/tcp/9090')
const listener = tcp.createListener((conn) => {}) const listener = tcp.createListener((conn) => {})
listener.listen(mh, () => { listener.listen(mh, () => {
@ -71,7 +75,7 @@ describe('listen', () => {
const listener = tcp.createListener((conn) => {}) const listener = tcp.createListener((conn) => {})
listener.listen(mh, () => { listener.listen(mh, () => {
listener.getAddrs((err, multiaddrs) => { listener.getAddrs((err, multiaddrs) => {
expect(err).to.not.exist expect(err).to.not.exist()
expect(multiaddrs.length).to.equal(1) expect(multiaddrs.length).to.equal(1)
expect(multiaddrs[0]).to.deep.equal(mh) expect(multiaddrs[0]).to.deep.equal(mh)
listener.close(done) listener.close(done)
@ -84,7 +88,7 @@ describe('listen', () => {
const listener = tcp.createListener((conn) => {}) const listener = tcp.createListener((conn) => {})
listener.listen(mh, () => { listener.listen(mh, () => {
listener.getAddrs((err, multiaddrs) => { listener.getAddrs((err, multiaddrs) => {
expect(err).to.not.exist expect(err).to.not.exist()
expect(multiaddrs.length).to.equal(1) expect(multiaddrs.length).to.equal(1)
listener.close(done) listener.close(done)
}) })
@ -96,7 +100,7 @@ describe('listen', () => {
const listener = tcp.createListener((conn) => {}) const listener = tcp.createListener((conn) => {})
listener.listen(mh, () => { listener.listen(mh, () => {
listener.getAddrs((err, multiaddrs) => { listener.getAddrs((err, multiaddrs) => {
expect(err).to.not.exist expect(err).to.not.exist()
expect(multiaddrs.length > 0).to.equal(true) expect(multiaddrs.length > 0).to.equal(true)
expect(multiaddrs[0].toString().indexOf('0.0.0.0')).to.equal(-1) expect(multiaddrs[0].toString().indexOf('0.0.0.0')).to.equal(-1)
listener.close(done) listener.close(done)
@ -109,7 +113,7 @@ describe('listen', () => {
const listener = tcp.createListener((conn) => {}) const listener = tcp.createListener((conn) => {})
listener.listen(mh, () => { listener.listen(mh, () => {
listener.getAddrs((err, multiaddrs) => { listener.getAddrs((err, multiaddrs) => {
expect(err).to.not.exist expect(err).to.not.exist()
expect(multiaddrs.length > 0).to.equal(true) expect(multiaddrs.length > 0).to.equal(true)
expect(multiaddrs[0].toString().indexOf('0.0.0.0')).to.equal(-1) expect(multiaddrs[0].toString().indexOf('0.0.0.0')).to.equal(-1)
listener.close(done) listener.close(done)
@ -122,7 +126,7 @@ describe('listen', () => {
const listener = tcp.createListener((conn) => {}) const listener = tcp.createListener((conn) => {})
listener.listen(mh, () => { listener.listen(mh, () => {
listener.getAddrs((err, multiaddrs) => { listener.getAddrs((err, multiaddrs) => {
expect(err).to.not.exist expect(err).to.not.exist()
expect(multiaddrs.length).to.equal(1) expect(multiaddrs.length).to.equal(1)
expect(multiaddrs[0]).to.deep.equal(mh) expect(multiaddrs[0]).to.deep.equal(mh)
listener.close(done) listener.close(done)
@ -141,7 +145,7 @@ describe('dial', () => {
listener = tcp.createListener((conn) => { listener = tcp.createListener((conn) => {
pull( pull(
conn, conn,
pull.map((x) => new Buffer(x.toString() + '!')), pull.map((x) => Buffer.from(x.toString() + '!')),
conn conn
) )
}) })
@ -157,12 +161,8 @@ describe('dial', () => {
pull.values(['hey']), pull.values(['hey']),
tcp.dial(ma), tcp.dial(ma),
pull.collect((err, values) => { pull.collect((err, values) => {
expect(err).to.not.exist expect(err).to.not.exist()
expect( expect(values).to.eql([Buffer.from('hey!')])
values
).to.be.eql(
[new Buffer('hey!')]
)
done() done()
}) })
) )
@ -173,13 +173,15 @@ describe('dial', () => {
pull( pull(
tcp.dial(ma), tcp.dial(ma),
pull.onEnd((err) => { pull.onEnd((err) => {
expect(err).to.exist expect(err).to.exist()
done() done()
}) })
) )
}) })
it('dial on IPv6', (done) => { it('dial on IPv6', (done) => {
if (isCI) { return done() }
const ma = multiaddr('/ip6/::/tcp/9066') const ma = multiaddr('/ip6/::/tcp/9066')
const listener = tcp.createListener((conn) => { const listener = tcp.createListener((conn) => {
pull(conn, conn) pull(conn, conn)
@ -189,13 +191,9 @@ describe('dial', () => {
pull.values(['hey']), pull.values(['hey']),
tcp.dial(ma), tcp.dial(ma),
pull.collect((err, values) => { pull.collect((err, values) => {
expect(err).to.not.exist expect(err).to.not.exist()
expect( expect(values).to.be.eql([Buffer.from('hey')])
values
).to.be.eql([
new Buffer('hey')
])
listener.close(done) listener.close(done)
}) })
@ -203,8 +201,8 @@ describe('dial', () => {
}) })
}) })
// TODO: figure out why is this failing
it.skip('dial and destroy on listener', (done) => { it.skip('dial and destroy on listener', (done) => {
// TODO: why is this failing
let count = 0 let count = 0
const closed = ++count === 2 ? finish() : null const closed = ++count === 2 ? finish() : null
@ -228,6 +226,8 @@ describe('dial', () => {
}) })
it('dial and destroy on dialer', (done) => { it('dial and destroy on dialer', (done) => {
if (isCI) { return done() }
let count = 0 let count = 0
const destroyed = () => ++count === 2 ? finish() : null const destroyed = () => ++count === 2 ? finish() : null
@ -258,245 +258,15 @@ describe('dial', () => {
pull.values(['hey']), pull.values(['hey']),
conn, conn,
pull.collect((err, res) => { pull.collect((err, res) => {
expect(err).to.not.exist expect(err).to.not.exist()
expect(res).to.be.eql([new Buffer('hey!')]) expect(res).to.be.eql([Buffer.from('hey!')])
done() done()
}) })
) )
}) })
}) })
describe('filter addrs', () => {
let tcp
before(() => {
tcp = new TCP()
})
it('filter valid addrs for this transport', () => {
const mh1 = multiaddr('/ip4/127.0.0.1/tcp/9090')
const mh2 = multiaddr('/ip4/127.0.0.1/udp/9090')
const mh3 = multiaddr('/ip4/127.0.0.1/tcp/9090/http')
const mh4 = multiaddr('/ip4/127.0.0.1/tcp/9090/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const valid = tcp.filter([mh1, mh2, mh3, mh4])
expect(valid.length).to.equal(2)
expect(valid[0]).to.deep.equal(mh1)
expect(valid[1]).to.deep.equal(mh4)
})
it('filter a single addr for this transport', () => {
const mh1 = multiaddr('/ip4/127.0.0.1/tcp/9090')
const valid = tcp.filter(mh1)
expect(valid.length).to.equal(1)
expect(valid[0]).to.deep.equal(mh1)
})
})
describe('valid Connection', () => {
let tcp
beforeEach(() => {
tcp = new TCP()
})
const ma = multiaddr('/ip4/127.0.0.1/tcp/9090')
it('get observed addrs', (done) => {
let dialerObsAddrs
const listener = tcp.createListener((conn) => {
expect(conn).to.exist
conn.getObservedAddrs((err, addrs) => {
expect(err).to.not.exist
dialerObsAddrs = addrs
pull(pull.empty(), conn)
})
})
listener.listen(ma, () => {
const conn = tcp.dial(ma)
pull(
conn,
pull.onEnd(endHandler)
)
function endHandler () {
conn.getObservedAddrs((err, addrs) => {
expect(err).to.not.exist
pull(pull.empty(), conn)
closeAndAssert(listener, addrs)
})
}
function closeAndAssert (listener, addrs) {
listener.close(() => {
expect(addrs[0]).to.deep.equal(ma)
expect(dialerObsAddrs.length).to.equal(1)
done()
})
}
})
})
it('get Peer Info', (done) => {
const listener = tcp.createListener((conn) => {
expect(conn).to.exist
conn.getPeerInfo((err, peerInfo) => {
expect(err).to.exist
expect(peerInfo).to.not.exist
pull(pull.empty(), conn)
})
})
listener.listen(ma, () => {
const conn = tcp.dial(ma)
pull(conn, pull.onEnd(endHandler))
function endHandler () {
conn.getPeerInfo((err, peerInfo) => {
expect(err).to.exist
expect(peerInfo).to.not.exist
listener.close(done)
})
}
})
})
it('set Peer Info', (done) => {
const listener = tcp.createListener((conn) => {
expect(conn).to.exist
conn.setPeerInfo('batatas')
conn.getPeerInfo((err, peerInfo) => {
expect(err).to.not.exist
expect(peerInfo).to.equal('batatas')
pull(pull.empty(), conn)
})
})
listener.listen(ma, () => {
const conn = tcp.dial(ma)
pull(conn, pull.onEnd(endHandler))
function endHandler () {
conn.setPeerInfo('arroz')
conn.getPeerInfo((err, peerInfo) => {
expect(err).to.not.exist
expect(peerInfo).to.equal('arroz')
listener.close(done)
})
}
})
})
})
describe.skip('turbolence', () => { describe.skip('turbolence', () => {
it('dialer - emits error on the other end is terminated abruptly', (done) => {}) it('dialer - emits error on the other end is terminated abruptly', (done) => {})
it('listener - emits error on the other end is terminated abruptly', (done) => {}) it('listener - emits error on the other end is terminated abruptly', (done) => {})
}) })
describe('Connection wrap', () => {
let tcp
let listener
const ma = multiaddr('/ip4/127.0.0.1/tcp/9090')
beforeEach((done) => {
tcp = new TCP()
listener = tcp.createListener((conn) => {
pull(conn, conn)
})
listener.on('listening', done)
listener.listen(ma)
})
afterEach((done) => {
listener.close(done)
})
it('simple wrap', (done) => {
const conn = tcp.dial(ma)
conn.setPeerInfo('peerInfo')
const connWrap = new Connection(conn)
pull(
pull.values(['hey']),
connWrap,
pull.collect((err, chunks) => {
expect(err).to.not.exist
expect(chunks).to.be.eql([new Buffer('hey')])
connWrap.getPeerInfo((err, peerInfo) => {
expect(err).to.not.exist
expect(peerInfo).to.equal('peerInfo')
done()
})
})
)
})
it('buffer wrap', (done) => {
const conn = tcp.dial(ma)
const connWrap = new Connection()
pull(
pull.values(['hey']),
connWrap,
pull.collect((err, chunks) => {
expect(err).to.not.exist
expect(chunks).to.be.eql([new Buffer('hey')])
done()
})
)
connWrap.setInnerConn(conn)
})
it('overload wrap', (done) => {
const conn = tcp.dial(ma)
const connWrap = new Connection(conn)
connWrap.getPeerInfo = (callback) => {
callback(null, 'none')
}
conn.getPeerInfo((err, peerInfo) => {
expect(err).to.exist
})
connWrap.getPeerInfo((err, peerInfo) => {
expect(err).to.not.exist
expect(peerInfo).to.equal('none')
})
pull(
pull.values(['hey']),
connWrap,
pull.collect((err, chunks) => {
expect(err).to.not.exist
expect(chunks).to.be.eql([new Buffer('hey')])
done()
})
)
})
it('matryoshka wrap', (done) => {
const conn = tcp.dial(ma)
const connWrap1 = new Connection(conn)
const connWrap2 = new Connection(connWrap1)
const connWrap3 = new Connection(connWrap2)
conn.getPeerInfo = (callback) => {
callback(null, 'inner doll')
}
pull(
pull.values(['hey']),
connWrap3,
pull.collect((err, chunks) => {
expect(err).to.not.exist
expect(chunks).to.be.eql([new Buffer('hey')])
connWrap3.getPeerInfo((err, peerInfo) => {
expect(err).to.not.exist
expect(peerInfo).to.equal('inner doll')
done()
})
})
)
})
})

16
test/turbolence.spec.js Normal file
View File

@ -0,0 +1,16 @@
/* eslint-env mocha */
'use strict'
const chai = require('chai')
const dirtyChai = require('dirty-chai')
const expect = chai.expect
chai.use(dirtyChai)
// const TCP = require('../src')
describe.skip('turbolence', () => {
it('dialer - emits error on the other end is terminated abruptly', (done) => {
expect('ok').to.equal('ok')
})
it('listener - emits error on the other end is terminated abruptly', (done) => {})
})