fix: use go-ipfs.version from parent package.json (#34)

* fix: use go-ipfs.version from parent package.json

fixes #33

* chore: add pkg-conf dep

* fix: use version from fixture and other stories

- fix all the things @alanshaw spotted

License: MIT
Signed-off-by: Oli Evans <[email protected]>

Author: olizilla

README.md

@@ -1,14 +1,13 @@
-Install go-ipfs from npm as a dependency of your project
-========================================================
+# go-ipfs-dep
 
+> Download [go-ipfs](https://github.com/ipfs/go-ipfs/) to your node_modules.
 
 [![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)
 [![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)
 [![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
 [![Travis CI](https://flat.badgen.net/travis/ipfs/npm-go-ipfs-dep)](https://travis-ci.com/ipfs/npm-go-ipfs-dep)
 [![Dependency Status](https://david-dm.org/ipfs/npm-go-ipfs.svg?style=flat-square)](https://david-dm.org/ipfs/npm-go-ipfs)
 
-> Install the latest [go-ipfs](https://github.com/ipfs/go-ipfs/) binary from [http://dist.ipfs.io](http://dist.ipfs.io)
 
 # Installation
 
@@ -18,13 +17,15 @@ npm install go-ipfs-dep --save
 
 See [IPFS getting-started](http://ipfs.io/docs/getting-started). If anything goes wrong, try using: [http://ipfs.io/docs/install](http://ipfs.io/docs/install).
 
-## Development
+## Usage
+
+This module downloads `go-ipfs` binaries from https://dist.ipfs.io into your project.
 
-**Warning**: The binary gets put in the `go-ipfs` folder inside the module folder.
+By default it will download the go-ipfs version that matches the npm version of this module. So depending on `go-ipfs[email protected]` will install `go-ipfs v0.4.19` for your current system architecture, in to your project at `node_modules/go-ipfs-dep/go-ipfs/ipfs`.
 
-### Which go-ipfs version this package downloads?
+### Overriding the go-ipfs version
 
-Can be specified in `package.json` with a field `go-ipfs.version`, eg:
+You can override the version of go-ipfs that gets downloaded by adding by adding a `go-ipfs.version` field to your `package.json`
 
 ```json
 "go-ipfs": {
@@ -33,7 +34,8 @@ Can be specified in `package.json` with a field `go-ipfs.version`, eg:
 ```
 
 ### Using local IPFS daemon as the package download url
-Can be specified in `package.json` with a field `go-ipfs.version`, eg:
+
+The url to download the binaries from can be specified by adding a field `go-ipfs.distUrl` field to your `package.json`, eg:
 
 ```json
 "go-ipfs": {
@@ -66,6 +68,10 @@ node src/bin.js <version> <platform> <architecture> <install directory>
 node src/bin.js v0.4.3 linux amd64 ./go-ipfs
 ```
 
+## Development
+
+**Note**: The binary gets put in the `go-ipfs` folder inside the module folder.
+
 ## Deployment
 
 ### Prerelease

package.json

@@ -20,6 +20,7 @@
     "go-platform": "^1.0.0",
     "gunzip-maybe": "^1.4.1",
     "node-fetch": "^2.3.0",
+    "pkg-conf": "^3.1.0",
     "tar-fs": "^2.0.0",
     "unzip-stream": "^0.3.0"
   },
@@ -35,7 +36,8 @@
   "homepage": "https://github.com/ipfs/npm-go-ipfs-dep",
   "devDependencies": {
     "aegir": "^18.2.0",
-    "rimraf": "^2.6.2",
+    "execa": "^1.0.0",
+    "rimraf": "^2.6.3",
     "standard": "^12.0.1",
     "tap-spec": "^5.0.0",
     "tape": "^4.9.1"
@@ -49,6 +51,7 @@
     "Haad <[email protected]>",
     "Harlan T Wood <[email protected]>",
     "Henrique Dias <[email protected]>",
+    "Oli Evans <[email protected]>",
     "Scott Hardy <[email protected]>",
     "Stephen Whitmore <[email protected]>",
     "haad <[email protected]>"

src/index.js

@@ -25,6 +25,7 @@ const path = require('path')
 const tarFS = require('tar-fs')
 const unzip = require('unzip-stream')
 const fetch = require('node-fetch')
+const pkgConf = require('pkg-conf')
 const pkg = require('./../package.json')
 
 function unpack ({ url, installPath, stream }) {
@@ -56,21 +57,18 @@ async function download ({ installPath, url }) {
 }
 
 function cleanArguments (version, platform, arch, installPath) {
-  const goIpfsInfo = pkg['go-ipfs']
-
-  const goIpfsVersion = (goIpfsInfo && goIpfsInfo.version)
-    ? pkg['go-ipfs'].version
-    : 'v' + pkg.version.replace(/-[0-9]+/, '')
-
-  const distUrl = (goIpfsInfo && goIpfsInfo.distUrl)
-    ? pkg['go-ipfs'].distUrl
-    : 'https://dist.ipfs.io'
-
+  const conf = pkgConf.sync('go-ipfs', {
+    cwd: path.join(process.cwd(), '..'),
+    defaults: {
+      version: 'v' + pkg.version.replace(/-[0-9]+/, ''),
+      distUrl: 'https://dist.ipfs.io'
+    }
+  })
   return {
-    version: process.env.TARGET_VERSION || version || goIpfsVersion,
+    version: process.env.TARGET_VERSION || version || conf.version,
     platform: process.env.TARGET_OS || platform || goenv.GOOS,
     arch: process.env.TARGET_ARCH || arch || goenv.GOARCH,
-    distUrl: process.env.GO_IPFS_DIST_URL || distUrl,
+    distUrl: process.env.GO_IPFS_DIST_URL || conf.distUrl,
     installPath: installPath ? path.resolve(installPath) : process.cwd()
   }
 }
@@ -105,7 +103,7 @@ async function getDownloadURL ({ version, platform, arch, distUrl }) {
 }
 
 module.exports = async function () {
-  const args = cleanArguments(...arguments)
+  const args = await cleanArguments(...arguments)
   const url = await getDownloadURL(args)
 
   process.stdout.write(`Downloading ${url}\n`)

test/fixture/example-project/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "example",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "author": "",
+  "license": "ISC",
+  "go-ipfs": {
+    "version": "v0.4.21-rc3"
+  }
+}

test/install.js

@@ -0,0 +1,40 @@
+const fs = require('fs')
+const path = require('path')
+const test = require('tape')
+const execa = require('execa')
+const rimraf = require('rimraf')
+
+/*
+  Test that go-ipfs is downloaded during npm install.
+  - package up the current source code with `npm pack`
+  - install the tarball into the example project
+  - ensure that the "go-ipfs.version" prop in the package.json is used
+*/
+
+const testVersion = require('./fixture/example-project/package.json')['go-ipfs'].version
+let tarballName = null
+
+function packTarball () {
+  const parentDir = path.join(__dirname, '..')
+  const res = execa.sync('npm', ['pack', parentDir], {
+    cwd: __dirname
+  })
+  tarballName = res.stdout
+  return tarballName
+}
+
+test.onFinish(() => {
+  fs.unlinkSync(path.join(__dirname, tarballName))
+  rimraf.sync(path.join('fixture', 'example-project', 'node_modules'))
+})
+
+test('Ensure go-ipfs.version defined in parent package.json is used', (t) => {
+  const tarballName = packTarball()
+  // from `example-project`, install the module
+  const res = execa.sync('npm', ['install', '--no-save', path.join('..', '..', tarballName)], {
+    cwd: path.join(__dirname, 'fixture', 'example-project')
+  })
+  const msg = `Downloading https://dist.ipfs.io/go-ipfs/${testVersion}`
+  t.ok(res.stdout.includes(msg), msg)
+  t.end()
+})