From ac5ef7291979b772da4e70dac7f91d8fbdc56c9c Mon Sep 17 00:00:00 2001
From: achingbrain <alex@achingbrain.net>
Date: Tue, 24 Sep 2019 22:11:40 +0100
Subject: [PATCH] fix: topicToKey should return a buffer not a string

Also, `Buffer.toString()` can result in unprintable characters being
part of the string which can result in false positives when comparing
stringified buffers.

Also, also, stop putting stringified buffers into the logs because
it can corrupt your console output.
---
 src/index.js       |  4 ++--
 src/utils.js       |  2 +-
 test/index.spec.js | 14 +++++++-------
 3 files changed, 10 insertions(+), 10 deletions(-)

diff --git a/src/index.js b/src/index.js
index 258313d..cd88b4e 100644
--- a/src/index.js
+++ b/src/index.js
@@ -166,7 +166,7 @@ class DatastorePubsub {
       return
     }
 
-    log(`message received for ${key} topic`)
+    log(`message received for topic ${topicIDs[0]}`)
 
     // Stop if the message is from the peer (it already stored it while publishing to pubsub)
     if (from === this._peerId.toB58String()) {
@@ -269,7 +269,7 @@ class DatastorePubsub {
     const routingKey = new Key('/' + encodeBase32(key), false)
 
     await this._datastore.put(routingKey, data)
-    log(`record for ${key.toString()} was stored in the datastore`)
+    log(`record for ${keyToTopic(key)} was stored in the datastore`)
   }
 
   open () {
diff --git a/src/utils.js b/src/utils.js
index 4e7ea76..66b6727 100644
--- a/src/utils.js
+++ b/src/utils.js
@@ -27,5 +27,5 @@ module.exports.topicToKey = (topic) => {
 
   const key = `${base64urlCode}${topic.substring(namespace.length)}`
 
-  return multibase.decode(key).toString()
+  return multibase.decode(key)
 }
diff --git a/test/index.spec.js b/test/index.spec.js
index 53ecd24..4e5c2ff 100644
--- a/test/index.spec.js
+++ b/test/index.spec.js
@@ -13,7 +13,7 @@ const { Key } = require('interface-datastore')
 const { Record } = require('libp2p-record')
 
 const DatastorePubsub = require('../src')
-const { keyToTopic } = require('../src/utils')
+const { keyToTopic, topicToKey } = require('../src/utils')
 const { connect, waitFor, waitForPeerToSubscribe, spawnDaemon, stopDaemon } = require('./utils')
 const promisify = require('promisify-es6')
 
@@ -426,8 +426,8 @@ describe('datastore-pubsub', function () {
   })
 
   it('should subscribe the topic and after a message being received, discard it using the subscriptionKeyFn', async () => {
-    const subscriptionKeyFn = (topic) => {
-      expect(topic).to.equal(`/${keyRef}`)
+    const subscriptionKeyFn = (key) => {
+      expect(key.toString()).to.equal(`/${keyRef}`)
       throw new Error('DISCARD MESSAGE')
     }
     const dsPubsubA = new DatastorePubsub(pubsubA, datastoreA, peerIdA, smoothValidator)
@@ -469,14 +469,14 @@ describe('datastore-pubsub', function () {
   })
 
   it('should subscribe the topic and after a message being received, change its key using subscriptionKeyFn', async () => {
-    const subscriptionKeyFn = (topic) => {
-      expect(topic).to.equal(key.toString())
-      return `${topic}new`
+    const subscriptionKeyFn = (key) => {
+      expect(key.toString()).to.equal(`/${keyRef}`)
+      return topicToKey(`${keyToTopic(key)}new`)
     }
     const dsPubsubA = new DatastorePubsub(pubsubA, datastoreA, peerIdA, smoothValidator)
     const dsPubsubB = new DatastorePubsub(pubsubB, datastoreB, peerIdB, smoothValidator, subscriptionKeyFn)
     const subsTopic = keyToTopic(`/${keyRef}`)
-    const keyNew = Buffer.from(`${key.toString()}new`)
+    const keyNew = topicToKey(`${keyToTopic(key)}new`)
     let receivedMessage = false
 
     function messageHandler () {