refactor: normalise debug logging prefix from jsipfs to just ipfs (#1911)

Alan Shaw · web-flow · commit d2726fbca9da · 2019-03-11T14:15:52.000Z
Shorter prefix ftw, MFS already uses "ipfs". Hooray \o/

License: MIT
Signed-off-by: Alan Shaw &lt;alan.shaw@protocol.ai&gt;
diff --git a/src/core/components/dht.js b/src/core/components/dht.js
@@ -11,8 +11,8 @@ const nextTick = require('async/nextTick')
 const errcode = require('err-code')
 
 const debug = require('debug')
-const log = debug('jsipfs:dht')
-log.error = debug('jsipfs:dht:error')
+const log = debug('ipfs:dht')
+log.error = debug('ipfs:dht:error')
 
 module.exports = (self) => {
   return {
diff --git a/src/core/components/name-pubsub.js b/src/core/components/name-pubsub.js
@@ -6,8 +6,8 @@ const promisify = require('promisify-es6')
 
 const IpnsPubsubDatastore = require('../ipns/routing/pubsub-datastore')
 
-const log = debug('jsipfs:name-pubsub')
-log.error = debug('jsipfs:name-pubsub:error')
+const log = debug('ipfs:name-pubsub')
+log.error = debug('ipfs:name-pubsub:error')
 
 // Is pubsub enabled
 const isNamePubsubEnabled = (node) => {
diff --git a/src/core/components/name.js b/src/core/components/name.js
@@ -8,8 +8,8 @@ const human = require('human-to-milliseconds')
 const crypto = require('libp2p-crypto')
 const errcode = require('err-code')
 
-const log = debug('jsipfs:name')
-log.error = debug('jsipfs:name:error')
+const log = debug('ipfs:name')
+log.error = debug('ipfs:name:error')
 
 const namePubsub = require('./name-pubsub')
 const utils = require('../utils')
diff --git a/src/core/components/ping-pull-stream.js b/src/core/components/ping-pull-stream.js
@@ -6,8 +6,8 @@ const PeerId = require('peer-id')
 const pull = require('pull-stream')
 const Pushable = require('pull-pushable')
 
-const log = debug('jsipfs:pingPullStream')
-log.error = debug('jsipfs:pingPullStream:error')
+const log = debug('ipfs:pingPullStream')
+log.error = debug('ipfs:pingPullStream:error')
 
 module.exports = function pingPullStream (self) {
   return (peerId, opts) => {
diff --git a/src/core/index.js b/src/core/index.js
@@ -95,8 +95,8 @@ class IPFS extends EventEmitter {
     }
 
     // IPFS utils
-    this.log = debug('jsipfs')
-    this.log.err = debug('jsipfs:err')
+    this.log = debug('ipfs')
+    this.log.err = debug('ipfs:err')
 
     // IPFS Core Internals
     // this._repo - assigned above
diff --git a/src/core/ipns/index.js b/src/core/ipns/index.js
@@ -6,8 +6,8 @@ const Receptacle = require('receptacle')
 
 const errcode = require('err-code')
 const debug = require('debug')
-const log = debug('jsipfs:ipns')
-log.error = debug('jsipfs:ipns:error')
+const log = debug('ipfs:ipns')
+log.error = debug('ipfs:ipns:error')
 
 const IpnsPublisher = require('./publisher')
 const IpnsRepublisher = require('./republisher')
diff --git a/src/core/ipns/path.js b/src/core/ipns/path.js
@@ -3,8 +3,8 @@
 const isIPFS = require('is-ipfs')
 
 const debug = require('debug')
-const log = debug('jsipfs:ipns:path')
-log.error = debug('jsipfs:ipns:path:error')
+const log = debug('ipfs:ipns:path')
+log.error = debug('ipfs:ipns:path:error')
 
 // resolves the given path by parsing out protocol-specific entries
 // (e.g. /ipns/<node-key>) and then going through the /ipfs/ entries and returning the final node
diff --git a/src/core/ipns/publisher.js b/src/core/ipns/publisher.js
@@ -6,8 +6,8 @@ const series = require('async/series')
 const errcode = require('err-code')
 
 const debug = require('debug')
-const log = debug('jsipfs:ipns:publisher')
-log.error = debug('jsipfs:ipns:publisher:error')
+const log = debug('ipfs:ipns:publisher')
+log.error = debug('ipfs:ipns:publisher:error')
 
 const ipns = require('ipns')
 
diff --git a/src/core/ipns/republisher.js b/src/core/ipns/republisher.js
@@ -8,8 +8,8 @@ const errcode = require('err-code')
 const debug = require('debug')
 const each = require('async/each')
 const waterfall = require('async/waterfall')
-const log = debug('jsipfs:ipns:republisher')
-log.error = debug('jsipfs:ipns:republisher:error')
+const log = debug('ipfs:ipns:republisher')
+log.error = debug('ipfs:ipns:republisher:error')
 
 const minute = 60 * 1000
 const hour = 60 * minute
diff --git a/src/core/ipns/resolver.js b/src/core/ipns/resolver.js
@@ -6,8 +6,8 @@ const PeerId = require('peer-id')
 const errcode = require('err-code')
 
 const debug = require('debug')
-const log = debug('jsipfs:ipns:resolver')
-log.error = debug('jsipfs:ipns:resolver:error')
+const log = debug('ipfs:ipns:resolver')
+log.error = debug('ipfs:ipns:resolver:error')
 
 const defaultMaximumRecursiveDepth = 32
 
diff --git a/src/core/ipns/routing/offline-datastore.js b/src/core/ipns/routing/offline-datastore.js
@@ -6,8 +6,8 @@ const { encodeBase32 } = require('./utils')
 
 const errcode = require('err-code')
 const debug = require('debug')
-const log = debug('jsipfs:ipns:offline-datastore')
-log.error = debug('jsipfs:ipns:offline-datastore:error')
+const log = debug('ipfs:ipns:offline-datastore')
+log.error = debug('ipfs:ipns:offline-datastore:error')
 
 // Offline datastore aims to mimic the same encoding as routing when storing records
 // to the local datastore
diff --git a/src/core/ipns/routing/pubsub-datastore.js b/src/core/ipns/routing/pubsub-datastore.js
@@ -8,8 +8,8 @@ const withIs = require('class-is')
 
 const errcode = require('err-code')
 const debug = require('debug')
-const log = debug('jsipfs:ipns:pubsub')
-log.error = debug('jsipfs:ipns:pubsub:error')
+const log = debug('ipfs:ipns:pubsub')
+log.error = debug('ipfs:ipns:pubsub:error')
 
 // Pubsub datastore aims to manage the pubsub subscriptions for IPNS
 class IpnsPubsubDatastore {
diff --git a/src/core/mfs-preload.js b/src/core/mfs-preload.js
@@ -2,8 +2,8 @@
 
 const debug = require('debug')
 
-const log = debug('jsipfs:mfs-preload')
-log.error = debug('jsipfs:mfs-preload:error')
+const log = debug('ipfs:mfs-preload')
+log.error = debug('ipfs:mfs-preload:error')
 
 module.exports = (self) => {
   const options = self._options.preload || {}
diff --git a/src/core/preload.js b/src/core/preload.js
@@ -7,8 +7,8 @@ const debug = require('debug')
 const CID = require('cids')
 const preload = require('./runtime/preload-nodejs')
 
-const log = debug('jsipfs:preload')
-log.error = debug('jsipfs:preload:error')
+const log = debug('ipfs:preload')
+log.error = debug('ipfs:preload:error')
 
 const noop = (err) => { if (err) log.error(err) }
 
diff --git a/src/core/runtime/preload-browser.js b/src/core/runtime/preload-browser.js
@@ -3,8 +3,8 @@
 
 const debug = require('debug')
 
-const log = debug('jsipfs:preload')
-log.error = debug('jsipfs:preload:error')
+const log = debug('ipfs:preload')
+log.error = debug('ipfs:preload:error')
 
 module.exports = function preload (url, callback) {
   log(url)
diff --git a/src/core/runtime/preload-nodejs.js b/src/core/runtime/preload-nodejs.js
@@ -6,8 +6,8 @@ const { URL } = require('url')
 const debug = require('debug')
 const setImmediate = require('async/setImmediate')
 
-const log = debug('jsipfs:preload')
-log.error = debug('jsipfs:preload:error')
+const log = debug('ipfs:preload')
+log.error = debug('ipfs:preload:error')
 
 module.exports = function preload (url, callback) {
   log(url)
diff --git a/src/core/state.js b/src/core/state.js
@@ -1,8 +1,8 @@
 'use strict'
 
 const debug = require('debug')
-const log = debug('jsipfs:state')
-log.error = debug('jsipfs:state:error')
+const log = debug('ipfs:state')
+log.error = debug('ipfs:state:error')
 
 const fsm = require('fsm-event')
 
diff --git a/src/http/api/resources/block.js b/src/http/api/resources/block.js
@@ -7,8 +7,8 @@ const multibase = require('multibase')
 const Boom = require('boom')
 const { cidToString } = require('../../../utils/cid')
 const debug = require('debug')
-const log = debug('jsipfs:http-api:block')
-log.error = debug('jsipfs:http-api:block:error')
+const log = debug('ipfs:http-api:block')
+log.error = debug('ipfs:http-api:block:error')
 
 // common pre request handler that parses the args and returns `key` which is assigned to `request.pre.args`
 exports.parseKey = (request, h) => {
diff --git a/src/http/api/resources/config.js b/src/http/api/resources/config.js
@@ -3,8 +3,8 @@
 const debug = require('debug')
 const get = require('lodash/get')
 const set = require('lodash/set')
-const log = debug('jsipfs:http-api:config')
-log.error = debug('jsipfs:http-api:config:error')
+const log = debug('ipfs:http-api:config')
+log.error = debug('ipfs:http-api:config:error')
 const multipart = require('ipfs-multipart')
 const Boom = require('boom')
 
diff --git a/src/http/api/resources/dht.js b/src/http/api/resources/dht.js
@@ -6,8 +6,8 @@ const Boom = require('boom')
 const CID = require('cids')
 
 const debug = require('debug')
-const log = debug('jsipfs:http-api:dht')
-log.error = debug('jsipfs:http-api:dht:error')
+const log = debug('ipfs:http-api:dht')
+log.error = debug('ipfs:http-api:dht:error')
 
 exports = module.exports
 
diff --git a/src/http/api/resources/files-regular.js b/src/http/api/resources/files-regular.js
@@ -3,8 +3,8 @@
 const multipart = require('ipfs-multipart')
 const debug = require('debug')
 const tar = require('tar-stream')
-const log = debug('jsipfs:http-api:files')
-log.error = debug('jsipfs:http-api:files:error')
+const log = debug('ipfs:http-api:files')
+log.error = debug('ipfs:http-api:files:error')
 const pull = require('pull-stream')
 const toPull = require('stream-to-pull-stream')
 const pushable = require('pull-pushable')
diff --git a/src/http/api/resources/object.js b/src/http/api/resources/object.js
@@ -13,8 +13,8 @@ const multibase = require('multibase')
 const Boom = require('boom')
 const { cidToString } = require('../../../utils/cid')
 const debug = require('debug')
-const log = debug('jsipfs:http-api:object')
-log.error = debug('jsipfs:http-api:object:error')
+const log = debug('ipfs:http-api:object')
+log.error = debug('ipfs:http-api:object:error')
 
 // common pre request handler that parses the args and returns `key` which is assigned to `request.pre.args`
 exports.parseKey = (request, h) => {
diff --git a/src/http/api/resources/resolve.js b/src/http/api/resources/resolve.js
@@ -4,8 +4,8 @@ const Joi = require('joi')
 const debug = require('debug')
 const multibase = require('multibase')
 
-const log = debug('jsipfs:http-api:resolve')
-log.error = debug('jsipfs:http-api:resolve:error')
+const log = debug('ipfs:http-api:resolve')
+log.error = debug('ipfs:http-api:resolve:error')
 
 module.exports = {
   validate: {
diff --git a/src/http/gateway/resources/gateway.js b/src/http/gateway/resources/gateway.js
@@ -1,8 +1,8 @@
 'use strict'
 
 const debug = require('debug')
-const log = debug('jsipfs:http-gateway')
-log.error = debug('jsipfs:http-gateway:error')
+const log = debug('ipfs:http-gateway')
+log.error = debug('ipfs:http-gateway:error')
 const pull = require('pull-stream')
 const pushable = require('pull-pushable')
 const toStream = require('pull-stream-to-stream')
diff --git a/src/http/index.js b/src/http/index.js
@@ -32,8 +32,8 @@ function hapiInfoToMultiaddr (info) {
 class HttpApi {
   constructor (options) {
     this._options = options || {}
-    this._log = debug('jsipfs:http-api')
-    this._log.error = debug('jsipfs:http-api:error')
+    this._log = debug('ipfs:http-api')
+    this._log.error = debug('ipfs:http-api:error')
 
     if (process.env.IPFS_MONITORING) {
       // Setup debug metrics collection

Original file line number	Diff line number	Diff line change
`@@ -95,8 +95,8 @@ class IPFS extends EventEmitter {`
`95`	`95`	`}`
`96`	`96`
`97`	`97`	`// IPFS utils`
`98`		`- this.log = debug('jsipfs')`
`99`		`- this.log.err = debug('jsipfs:err')`
	`98`	`+ this.log = debug('ipfs')`
	`99`	`+ this.log.err = debug('ipfs:err')`
`100`	`100`
`101`	`101`	`// IPFS Core Internals`
`102`	`102`	`// this._repo - assigned above`