Skip to content
This repository was archived by the owner on Mar 10, 2020. It is now read-only.

Commit 118456e

Browse files
hacdiasdaviddias
hacdias
authored and
daviddias
committed
feat: (breaking change) stats spec, spec repo, stream to value on files read (#679)
* tests: STAT spec * fix(breaking change): REPO spec * feat(breaking change): FILES spec: stream to value on files read * docs: improve readme
1 parent ec04f6e commit 118456e

File tree

11 files changed

+142
-113
lines changed

11 files changed

+142
-113
lines changed

‎README.md

+22-21
Original file line numberDiff line numberDiff line change
@@ -170,27 +170,23 @@ $ ipfs config --json API.HTTPHeaders.Access-Control-Allow-Methods "[\"PUT\", \"P
170170
- [`ipfs.files.get(ipfsPath, [options], [callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/FILES.md#get). Alias to `ipfs.get`.
171171
- [`ipfs.files.getReadableStream(ipfsPath, [options])`](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/FILES.md#getreadablestream)
172172
- [`ipfs.files.getPullStream(ipfsPath, [options])`](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/FILES.md#getpullstream)
173-
- `ipfs.ls`
174-
- MFS (mutable file system) specific:
175-
- `ipfs.files.cp`
176-
- `ipfs.files.ls`
177-
- `ipfs.files.mkdir`
178-
- `ipfs.files.stat`
179-
- `ipfs.files.rm`
180-
- `ipfs.files.read`
181-
- `ipfs.files.write`
182-
- `ipfs.files.mv`
183-
- `ipfs.files.flush(path, [callback])`
173+
- [`ipfs.ls(ipfsPath, [callback])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/FILES.md#ls)
174+
- [MFS (mutable file system) specific](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/FILES.md#mutable-file-system)
175+
- [`ipfs.files.cp([from, to], [callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/FILES.md#cp)
176+
- [`ipfs.files.mkdir(path, [options, callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/FILES.md#mkdir)
177+
- [`ipfs.files.stat(path, [options, callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/FILES.md#stat)
178+
- [`ipfs.files.rm(path, [options, callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/FILES.md#rm)
179+
- [`ipfs.files.read(path, [options, callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/FILES.md#read)
180+
- [`ipfs.files.write(path, content, [options, callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/FILES.md#write)
181+
- [`ipfs.files.mv([from, to], [callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/FILES.md#mv)
182+
- [`ipfs.files.ls([path, options, callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/FILES.md#ls-1)
183+
- [`ipfs.files.flush([path, callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/FILES.md#flush)
184184
185185
- [block](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/BLOCK.md)
186186
- [`ipfs.block.get(cid, [options, callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/BLOCK.md#get)
187187
- [`ipfs.block.put(block, cid, [callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/BLOCK.md#put)
188188
- [`ipfs.block.stat(cid, [callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/BLOCK.md#stat)
189189
190-
- repo
191-
- `ipfs.repo.stat()`
192-
- `ipfs.repo.gc()`
193-
194190
#### `Graph`
195191
196192
- [dag (not implemented, yet!)](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/DAG.md)
@@ -264,17 +260,22 @@ $ ipfs config --json API.HTTPHeaders.Access-Control-Allow-Methods "[\"PUT\", \"P
264260
- [`ipfs.config.set(key, value, [callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/CONFIG.md#configset)
265261
- [`ipfs.config.replace(config, [callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/CONFIG.md#configreplace)
266262
267-
- stats:
268-
- `ipfs.stats.bitswap([callback])`
269-
- `ipfs.stats.bw([options, callback])`
270-
- `ipfs.stats.repo([options, callback])`
263+
- [stats](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/STATS.md)
264+
- [`ipfs.stats.bitswap([callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/STATS.md#bitswap)
265+
- [`ipfs.stats.bw([options, callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/STATS.md#bw)
266+
- [`ipfs.stats.repo([options, callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/STATS.md#repo)
271267
272-
- log:
268+
- log
273269
- `ipfs.log.ls([callback])`
274270
- `ipfs.log.tail([callback])`
275271
- `ipfs.log.level(subsystem, level, [options, callback])`
272+
273+
- [repo](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/REPO.md)
274+
- [`ipfs.repo.gc([options, callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/REPO.md#gc)
275+
- [`ipfs.repo.stat([options, callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/REPO.md#stat)
276+
- [`ipfs.repo.version([callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/REPO.md#version)
276277
277-
- key:
278+
- [key](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/KEY.md)
278279
- [`ipfs.key.gen(name, [options, callback])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/KEY.md#javascript---ipfskeygenname-options-callback)
279280
- [`ipfs.key.list([options, callback])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/KEY.md#javascript---ipfskeylistcallback)
280281
- [`ipfs.key.rm(name, [callback])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/KEY.md#javascript---ipfskeyrmname-callback)

‎package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@
6868
"eslint-plugin-react": "^7.5.1",
6969
"go-ipfs-dep": "^0.4.13",
7070
"gulp": "^3.9.1",
71-
"interface-ipfs-core": "~0.41.0",
71+
"interface-ipfs-core": "~0.43.0",
7272
"hapi": "^16.6.2",
7373
"ipfsd-ctl": "~0.27.0",
7474
"pre-commit": "^1.2.2",

‎src/files/flush.js

+5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ const promisify = require('promisify-es6')
44

55
module.exports = (send) => {
66
return promisify((args, callback) => {
7+
if (typeof args === 'function') {
8+
callback = args
9+
args = '/'
10+
}
11+
712
return send({
813
path: 'files/flush',
914
args: args

‎src/files/read.js

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
11
'use strict'
22

33
const promisify = require('promisify-es6')
4+
const streamToValue = require('../utils/stream-to-value')
45

56
module.exports = (send) => {
67
return promisify((args, opts, callback) => {
78
if (typeof (opts) === 'function') {
89
callback = opts
910
opts = {}
1011
}
11-
send({
12+
13+
send.andTransform({
1214
path: 'files/read',
1315
args: args,
1416
qs: opts
15-
}, callback)
17+
}, streamToValue, callback)
1618
})
1719
}

‎src/repo/stat.js

+13-2
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,26 @@
22

33
const promisify = require('promisify-es6')
44

5+
const transform = function (res, callback) {
6+
callback(null, {
7+
numObjects: res.NumObjects,
8+
repoSize: res.RepoSize,
9+
repoPath: res.RepoPath,
10+
version: res.Version,
11+
storageMax: res.StorageMax
12+
})
13+
}
14+
515
module.exports = (send) => {
616
return promisify((opts, callback) => {
717
if (typeof (opts) === 'function') {
818
callback = opts
919
opts = {}
1020
}
11-
send({
21+
22+
send.andTransform({
1223
path: 'repo/stat',
1324
qs: opts
14-
}, callback)
25+
}, transform, callback)
1526
})
1627
}

‎src/repo/version.js

+7-2
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,20 @@
22

33
const promisify = require('promisify-es6')
44

5+
const transform = function (res, callback) {
6+
callback(null, res.Version)
7+
}
8+
59
module.exports = (send) => {
610
return promisify((opts, callback) => {
711
if (typeof (opts) === 'function') {
812
callback = opts
913
opts = {}
1014
}
11-
send({
15+
16+
send.andTransform({
1217
path: 'repo/version',
1318
qs: opts
14-
}, callback)
19+
}, transform, callback)
1520
})
1621
}

‎src/stats/repo.js

-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
'use strict'
32

43
const promisify = require('promisify-es6')

‎test/files.spec.js

+18-78
Original file line numberDiff line numberDiff line change
@@ -244,19 +244,10 @@ describe('.files (the MFS API part)', function () {
244244
.write('/test-folder/test-file-2.txt', Buffer.from('hello world'), {create: true}, (err) => {
245245
expect(err).to.not.exist()
246246

247-
ipfs.files.read('/test-folder/test-file-2.txt', (err, stream) => {
247+
ipfs.files.read('/test-folder/test-file-2.txt', (err, buf) => {
248248
expect(err).to.not.exist()
249-
250-
let buf = ''
251-
stream
252-
.on('error', (err) => expect(err).to.not.exist())
253-
.on('data', (data) => {
254-
buf += data
255-
})
256-
.on('end', () => {
257-
expect(buf).to.be.equal('hello world')
258-
done()
259-
})
249+
expect(buf.toString()).to.be.equal('hello world')
250+
done()
260251
})
261252
})
262253
})
@@ -266,21 +257,10 @@ describe('.files (the MFS API part)', function () {
266257
.write('/test-folder/test-file-2.txt', Buffer.from('hello world'), (err) => {
267258
expect(err).to.not.exist()
268259

269-
ipfs.files.read('/test-folder/test-file-2.txt', (err, stream) => {
260+
ipfs.files.read('/test-folder/test-file-2.txt', (err, buf) => {
270261
expect(err).to.not.exist()
271-
272-
let buf = ''
273-
stream
274-
.on('error', (err) => {
275-
expect(err).to.not.exist()
276-
})
277-
.on('data', (data) => {
278-
buf += data
279-
})
280-
.on('end', () => {
281-
expect(buf).to.be.equal('hello world')
282-
done()
283-
})
262+
expect(buf.toString()).to.be.equal('hello world')
263+
done()
284264
})
285265
})
286266
})
@@ -315,20 +295,10 @@ describe('.files (the MFS API part)', function () {
315295
return done()
316296
}
317297

318-
ipfs.files.read('/test-folder/test-file', (err, stream) => {
298+
ipfs.files.read('/test-folder/test-file', (err, buf) => {
319299
expect(err).to.not.exist()
320-
let buf = ''
321-
stream
322-
.on('error', (err) => {
323-
expect(err).to.not.exist()
324-
})
325-
.on('data', (data) => {
326-
buf += data
327-
})
328-
.on('end', () => {
329-
expect(Buffer.from(buf)).to.deep.equal(testfile)
330-
done()
331-
})
300+
expect(Buffer.from(buf)).to.deep.equal(testfile)
301+
done()
332302
})
333303
})
334304

@@ -417,19 +387,9 @@ describe('.files (the MFS API part)', function () {
417387
.then(() => {
418388
return ipfs.files.read('/test-folder/test-file-2.txt')
419389
})
420-
.then((stream) => {
421-
let buf = ''
422-
stream
423-
.on('error', (err) => {
424-
expect(err).to.not.exist()
425-
})
426-
.on('data', (data) => {
427-
buf += data
428-
})
429-
.on('end', () => {
430-
expect(buf).to.be.equal('hello world')
431-
done()
432-
})
390+
.then((buf) => {
391+
expect(buf.toString()).to.be.equal('hello world')
392+
done()
433393
})
434394
.catch(done)
435395
})
@@ -440,19 +400,9 @@ describe('.files (the MFS API part)', function () {
440400
.then(() => {
441401
return ipfs.files.read('/test-folder/test-file-2.txt')
442402
})
443-
.then((stream) => {
444-
let buf = ''
445-
stream
446-
.on('error', (err) => {
447-
expect(err).to.not.exist()
448-
})
449-
.on('data', (data) => {
450-
buf += data
451-
})
452-
.on('end', () => {
453-
expect(buf).to.be.equal('hello world')
454-
done()
455-
})
403+
.then((buf) => {
404+
expect(buf.toString()).to.be.equal('hello world')
405+
done()
456406
})
457407
.catch(done)
458408
})
@@ -482,19 +432,9 @@ describe('.files (the MFS API part)', function () {
482432
if (!isNode) { return done() }
483433

484434
ipfs.files.read('/test-folder/test-file')
485-
.then((stream) => {
486-
let buf = ''
487-
stream
488-
.on('error', (err) => {
489-
expect(err).to.not.exist()
490-
})
491-
.on('data', (data) => {
492-
buf += data
493-
})
494-
.on('end', () => {
495-
expect(Buffer.from(buf)).to.eql(testfile)
496-
done()
497-
})
435+
.then((buf) => {
436+
expect(Buffer.from(buf)).to.eql(testfile)
437+
done()
498438
})
499439
})
500440

‎test/interface/repo.spec.js

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
/* eslint-env mocha */
2+
/* eslint max-nested-callbacks: ["error", 8] */
3+
'use strict'
4+
5+
const test = require('interface-ipfs-core')
6+
const parallel = require('async/parallel')
7+
8+
const IPFSApi = require('../../src')
9+
10+
const DaemonFactory = require('ipfsd-ctl')
11+
const df = DaemonFactory.create()
12+
13+
const nodes = []
14+
const common = {
15+
setup: function (callback) {
16+
callback(null, {
17+
spawnNode: (cb) => {
18+
df.spawn((err, _ipfsd) => {
19+
if (err) {
20+
return cb(err)
21+
}
22+
23+
nodes.push(_ipfsd)
24+
cb(null, IPFSApi(_ipfsd.apiAddr))
25+
})
26+
}
27+
})
28+
},
29+
teardown: function (callback) {
30+
parallel(nodes.map((node) => (cb) => node.stop(cb)), callback)
31+
}
32+
}
33+
34+
test.repo(common)

‎test/interface/stats.spec.js

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
/* eslint-env mocha */
2+
3+
'use strict'
4+
5+
const test = require('interface-ipfs-core')
6+
const parallel = require('async/parallel')
7+
8+
const IPFSApi = require('../../src')
9+
10+
const DaemonFactory = require('ipfsd-ctl')
11+
const df = DaemonFactory.create()
12+
13+
const nodes = []
14+
const common = {
15+
setup: function (callback) {
16+
callback(null, {
17+
spawnNode: (cb) => {
18+
df.spawn((err, _ipfsd) => {
19+
if (err) {
20+
return cb(err)
21+
}
22+
23+
nodes.push(_ipfsd)
24+
cb(null, IPFSApi(_ipfsd.apiAddr))
25+
})
26+
}
27+
})
28+
},
29+
teardown: function (callback) {
30+
parallel(nodes.map((node) => (cb) => node.stop(cb)), callback)
31+
}
32+
}
33+
34+
test.stats(common)

0 commit comments

Comments
 (0)