Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: swap go-ipfs-dep for go-ipfs #522

Merged
merged 1 commit into from
Jul 16, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .aegir.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
const getPort = require('aegir/utils/get-port')
const createServer = require('./src').createServer

const server = createServer(undefined,
const server = createServer(undefined,
{
ipfsModule: require('ipfs'),
ipfsHttpModule: require('ipfs-http-client')
},
},
{
go: {
ipfsBin: require('go-ipfs-dep').path()
ipfsBin: require('go-ipfs').path()
},
js: {
ipfsBin: require.resolve('ipfs/src/cli/bin.js')
Expand Down
18 changes: 9 additions & 9 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

### Features

* remove default key size and upgrade go-ipfs-dep ([#504](https://github.com/ipfs/js-ipfsd-ctl/issues/504)) ([ecbf4be](https://github.com/ipfs/js-ipfsd-ctl/commit/ecbf4be))
* remove default key size and upgrade go-ipfs ([#504](https://github.com/ipfs/js-ipfsd-ctl/issues/504)) ([ecbf4be](https://github.com/ipfs/js-ipfsd-ctl/commit/ecbf4be))



Expand Down Expand Up @@ -91,7 +91,7 @@

* chore: increase test timeouts

* fix: only get go-ipfs-dep path in node
* fix: only get go-ipfs path in node

* fix: linting

Expand Down Expand Up @@ -192,7 +192,7 @@ to use js-IPFS.

### BREAKING CHANGES

* Problems:
* Problems:
- Browsers tests skipped cause ctl didn't support proper connectivity to remote nodes
- We weren't able to tell ctl to use a specific commit of http-client, js-ipfs or cli
- Options/config between the 3 types of daemons weren't consistent
Expand All @@ -206,8 +206,8 @@ Related issues:
- https://github.com/ipfs/js-ipfsd-ctl/issues/315
- https://github.com/ipfs/js-ipfsd-ctl/issues/207
- https://github.com/ipfs/js-ipfsd-ctl/issues/217
- and more
- and more

Improvements:
- better errors
- DEBUG='ipfsd-ctl:*' everywhere
Expand All @@ -228,14 +228,14 @@ Improvements:
- support electron
- test in electron

New:
New:
- new method `createController` returns a spawned controller
- createFactory as a second parameter to override options per type


Changes:
Changes:
- `create` change to `createFactory`
- `createFactory` options changed
- `createFactory` options changed

Old
```md
Expand Down Expand Up @@ -272,7 +272,7 @@ Old
```

- Previous default ipfs config is only applied when `test` options equals `true`
- `defaultAddrs` option was removed
- `defaultAddrs` option was removed
- Spawn options are the same as `createFactory`

Old
Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,17 +32,17 @@ Version 1.0.0 changed a bit the api and the options methods take so please read
npm install --save ipfsd-ctl
```

Please ensure your project also has dependencies on `ipfs`, `ipfs-http-client` and `go-ipfs-dep`.
Please ensure your project also has dependencies on `ipfs`, `ipfs-http-client` and `go-ipfs`.

```sh
npm install --save ipfs
npm install --save ipfs-http-client
npm install --save go-ipfs-dep
npm install --save go-ipfs
```

If you are only going to use the `go` implementation of IPFS, you can skip installing the `js` implementation and vice versa, though both will require the `ipfs-http-client` module.

If you are only using the `proc` type in-process IPFS node, you can skip installing `go-ipfs-dep` and `ipfs-http-client`.
If you are only using the `proc` type in-process IPFS node, you can skip installing `go-ipfs` and `ipfs-http-client`.

> You also need to explicitly defined the options `ipfsBin`, `ipfsModule` and `ipfsHttpModule` according to your needs. Check [ControllerOptions](#controlleroptions) and [ControllerOptionsOverrides](#controlleroptionsoverrides) for more information.

Expand All @@ -58,7 +58,7 @@ This is a shorthand for simpler use cases where factory is not needed.
const Ctl = require('ipfsd-ctl')
const ipfsd = await Ctl.createController({
ipfsHttpModule: require('ipfs-http-client'),
ipfsBin: require('go-ipfs-dep').path()
ipfsBin: require('go-ipfs').path()
})
const id = await ipfsd.api.id()

Expand All @@ -79,9 +79,9 @@ Use a factory to spawn multiple controllers based on some common template.
const Ctl = require('ipfsd-ctl')

const factory = Ctl.createFactory(
{
type: 'js',
test: true,
{
type: 'js',
test: true,
disposable: true,
ipfsHttpModule: require('ipfs-http-client'),
ipfsModule: require('ipfs') // only if you gonna spawn 'proc' controllers
Expand Down Expand Up @@ -127,7 +127,7 @@ const server = Ctl.createServer(port, {
})
const factory = Ctl.createFactory({
ipfsHttpModule: require('ipfs-http-client'),
remote: true,
remote: true,
endpoint: `http://localhost:${port}` // or you can set process.env.IPFSD_CTL_SERVER to http://localhost:9090
})

Expand Down
2 changes: 1 addition & 1 deletion examples/electron-asar/app.js
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ ipcMain.on('start', async ({ sender }) => {
await s.start()
const node = await createController({
type: 'go',
ipfsBin: require('go-ipfs-dep').path()
ipfsBin: require('go-ipfs').path()
})
console.log('get id')
sender.send('message', 'get id')
Expand Down
2 changes: 1 addition & 1 deletion examples/electron-asar/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"private": true,
"main": "./app.js",
"dependencies": {
"go-ipfs-dep": "^0.5.0",
"go-ipfs": "^0.6.0",
"ipfs": "^0.43.0",
"ipfsd-ctl": "file:../.."
},
Expand Down
2 changes: 1 addition & 1 deletion examples/id/id.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ const { createController } = require('../../src')
async function run () {
const node = await createController({
type: 'go',
ipfsBin: require('go-ipfs-dep').path(),
ipfsBin: require('go-ipfs').path(),
ipfsHttpModule: require('ipfs-http-client')
})
console.log('alice')
Expand Down
2 changes: 1 addition & 1 deletion examples/remote-disposable/remote-disposable.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ async function run () {
const node = await createController({
remote: true,
type: 'go',
ipfsBin: require('go-ipfs-dep').path()
ipfsBin: require('go-ipfs').path()
})

console.log(await node.api.id())
Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
"./src/endpoint/server.js": "./src/endpoint/server.browser.js",
"./src/utils.js": "./src/utils.browser.js",
"./src/ipfsd-daemon.js": "./src/ipfsd-client.js",
"go-ipfs-dep": false
"go-ipfs": false
},
"husky": {
"hooks": {
Expand Down Expand Up @@ -65,14 +65,14 @@
"devDependencies": {
"aegir": "^23.0.0",
"benchmark": "^2.1.4",
"go-ipfs-dep": "^0.5.0",
"go-ipfs": "^0.6.0",
"husky": "^4.2.5",
"ipfs": "^0.43.0",
"ipfs-http-client": "^44.0.0",
"lint-staged": "^10.1.6"
},
"peerDependencies": {
"go-ipfs-dep": "*",
"go-ipfs": "*",
"ipfs": "*",
"ipfs-http-client": "*"
},
Expand Down
2 changes: 1 addition & 1 deletion test/controller.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ describe('Controller API', function () {
ipfsBin: pathJoin(__dirname, '../node_modules/ipfs/src/cli/bin.js')
},
go: {
ipfsBin: isNode ? require('go-ipfs-dep').path() : undefined
ipfsBin: isNode ? require('go-ipfs').path() : undefined
}
})

Expand Down
6 changes: 3 additions & 3 deletions test/create.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ describe('`createController` should return the correct class', () => {
type: 'go',
disposable: false,
ipfsHttpModule: require('ipfs-http-client'),
ipfsBin: isNode ? require('go-ipfs-dep').path() : undefined
ipfsBin: isNode ? require('go-ipfs').path() : undefined
})

if (!isNode) {
Expand Down Expand Up @@ -70,7 +70,7 @@ const types = [{
ipfsBin: pathJoin(__dirname, '../node_modules/ipfs/src/cli/bin.js')
}, {
...defaultOps,
ipfsBin: isNode ? require('go-ipfs-dep').path() : undefined,
ipfsBin: isNode ? require('go-ipfs').path() : undefined,
type: 'go',
test: true
}, {
Expand All @@ -87,7 +87,7 @@ const types = [{
ipfsBin: pathJoin(__dirname, '../node_modules/ipfs/src/cli/bin.js')
}, {
...defaultOps,
ipfsBin: isNode ? require('go-ipfs-dep').path() : undefined,
ipfsBin: isNode ? require('go-ipfs').path() : undefined,
type: 'go',
test: true,
remote: true
Expand Down
4 changes: 2 additions & 2 deletions test/factory.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ const types = [{
ipfsBin: pathJoin(__dirname, '../node_modules/ipfs/src/cli/bin.js')
}, {
...defaultOps,
ipfsBin: isNode ? require('go-ipfs-dep').path() : undefined,
ipfsBin: isNode ? require('go-ipfs').path() : undefined,
type: 'go',
test: true
}, {
Expand All @@ -35,7 +35,7 @@ const types = [{
ipfsBin: pathJoin(__dirname, '../node_modules/ipfs/src/cli/bin.js')
}, {
...defaultOps,
ipfsBin: isNode ? require('go-ipfs-dep').path() : undefined,
ipfsBin: isNode ? require('go-ipfs').path() : undefined,
type: 'go',
remote: true,
test: true
Expand Down
2 changes: 1 addition & 1 deletion test/node.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ describe('Node specific tests', function () {
test: true,
ipfsHttpModule: require('ipfs-http-client'),
ipfsModule: require('ipfs'),
ipfsBin: require('go-ipfs-dep').path()
ipfsBin: require('go-ipfs').path()
})

it('should use process.IPFS_PATH', async () => {
Expand Down