test: ipns over pubsub #361

vasco-santos · 2018-08-31T15:59:47Z

PR implemented taking into consideration the most recent documentation of the go-ipfs API on:

http://ipfs.io/ipfs/QmPKzWaeHumLuiKLb2Ak67s5kxZ1p6YbnjVKYYfF9hTjzn

This tests aim to be integrated on s-ipfs-api#846 and in a future PR to js-ipfs containing the IPNS over Pubsub implementation.

daviddias · 2018-09-15T13:45:15Z

SPEC/NAME.md

@@ -76,6 +79,8 @@ This way, you can republish a new version of your website under the same address

 `callback` must follow `function (err, name) {}` signature, where `err` is an error if the operation was not successful. `name` is a string that contains the IPFS hash.

+`callback` must follow `function (err, result) {}` signature, where `err` is an error if the operation was not successful. `result` is an object that contains the resulting path, such as:


Why are there two callback definitions?

alanshaw · 2018-10-15T14:32:22Z

SPEC/NAME.md

+
+```JavaScript
+{
+  strings: ['/ipns/QmQrX8hka2BtNHa8N8arAq16TCVx5qHcb46c5yPewRycLm']


"strings"? Shall we just return an array here?

Yes! I got confused here. Both js-ipfs-api and js-ipfs should return only the array in the end!

SPEC/NAME.md

alanshaw · 2018-10-17T08:06:00Z

js/src/name-pubsub/cancel.js

+      ipfs.name.publish(value, { resolve: false }, (err, res) => {
+        expect(err).to.not.exist()
+
+        ipfs.name.resolve(nodeId, (err) => {


Just so I understand this correctly, when you resolve, you get automatically subscribed to updates? Is there a way to not subscribe?

When you try to resolve an ipns path and the experimental flag --enable-namesys-pubsub is being used, it will get automatically subscribed. This way, when an ipns record is updated, we will have the most recent version of it stored locally.

For now, there is no way to not subscribe it (if you use the experimental flag), but since it is experimental, we may consider adding a flag for it, in case we enable it by default in the future.

alanshaw · 2018-10-17T08:07:30Z

js/src/name-pubsub/cancel.js

+            expect(err).to.not.exist()
+            expect(res).to.exist()
+            expect(res).to.have.property('canceled')
+            expect(res.canceled).to.eql(true)


Should we also check this value is no longer in our subs list?

alanshaw · 2018-10-17T08:07:54Z

js/src/name-pubsub/cancel.js

+            expect(res.canceled).to.eql(true)
+
+            done()
+          })


Suggestion: async waterfall or something?

alanshaw · 2018-10-17T08:11:15Z

js/src/name-pubsub/cancel.js

+
+const fixture = Object.freeze({
+  data: loadFixture('js/test/fixtures/testfile.txt', 'interface-ipfs-core'),
+  cid: 'Qma4hjFTnCasJ8PVp3mZbZK5g2vGDT4LByLJ7m8ciyRFZP'


IMHO we should just use the CID in the result from add and not hard code it. We're not testing "add" functionality here and if the CID changes in the future (because of changes in default dag layout or cid version for instance) there's fewer things to update in the tests. If you do change this then please also change in the other test files :)

Will change in both

alanshaw · 2018-10-17T08:13:20Z

js/src/name-pubsub/subs.js

+        expect(err).to.not.exist()
+        expect(res).to.exist()
+        expect(res).to.have.property('strings')
+        expect(res.strings).to.eql(null)


It should always be an array.

alanshaw · 2018-10-17T08:14:12Z

js/src/name-pubsub/subs.js

+            expect(err).to.not.exist()
+            expect(res).to.exist()
+            expect(res).to.have.property('strings')
+            expect(res.strings).to.be.an('array').that.does.include(`/ipns/${nodeId}`)


Check that it was empty initially?

alanshaw · 2018-10-17T08:14:28Z

js/src/name-pubsub/subs.js

+            expect(res.strings).to.be.an('array').that.does.include(`/ipns/${nodeId}`)
+
+            done()
+          })


Suggestion: use async

alanshaw · 2018-10-17T08:59:57Z

SPEC/NAME.md

@@ -74,7 +77,7 @@ This way, you can republish a new version of your website under the same address
 }
 ```

-`callback` must follow `function (err, name) {}` signature, where `err` is an error if the operation was not successful. `name` is a string that contains the IPFS hash.
+`callback` must follow `function (err, result) {}` signature, where `err` is an error if the operation was not successful. `result` is an object that contains the resulting path.


I believe this was correct - both js-ipfs-api and js-ipfs return only the path.

vasco-santos requested review from alanshaw, victorb and daviddias August 31, 2018 15:59

vasco-santos requested a review from travisperson as a code owner August 31, 2018 15:59

ghost assigned vasco-santos Aug 31, 2018

ghost added the in progress label Aug 31, 2018

vasco-santos mentioned this pull request Aug 31, 2018

feat: ipns over pubsub ipfs-inactive/js-ipfs-http-client#846

Merged

3 tasks

alanshaw changed the title ~~Feat/ipns over pubsub~~ test: ipns over pubsub Sep 4, 2018

vasco-santos mentioned this pull request Sep 13, 2018

feat: ipns over pubsub ipfs/js-ipfs#1559

Merged

7 tasks

daviddias reviewed Sep 15, 2018

View reviewed changes

alanshaw suggested changes Oct 17, 2018

View reviewed changes

vasco-santos added 4 commits October 17, 2018 11:20

docs: ipns over pubsub

5f276b2

feat: ipns over pubsub

5b4645c

fix: typo

3962673

fix: code review

08a5b90

vasco-santos force-pushed the feat/ipns-over-pubsub branch from 1418857 to 08a5b90 Compare October 17, 2018 16:18

alanshaw approved these changes Oct 18, 2018

View reviewed changes

alanshaw merged commit 2d7071c into master Oct 18, 2018

ghost removed the in progress label Oct 18, 2018

alanshaw deleted the feat/ipns-over-pubsub branch October 18, 2018 09:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

test: ipns over pubsub #361

test: ipns over pubsub #361

vasco-santos commented Aug 31, 2018

daviddias Sep 15, 2018

alanshaw Oct 15, 2018

vasco-santos Oct 17, 2018 •

edited

Loading

alanshaw Oct 17, 2018

vasco-santos Oct 17, 2018

alanshaw Oct 17, 2018 •

edited

Loading

alanshaw Oct 17, 2018

alanshaw Oct 17, 2018

vasco-santos Oct 17, 2018

alanshaw Oct 17, 2018

alanshaw Oct 17, 2018

alanshaw Oct 17, 2018

alanshaw Oct 17, 2018

		@@ -76,6 +79,8 @@ This way, you can republish a new version of your website under the same address

		`callback` must follow `function (err, name) {}` signature, where `err` is an error if the operation was not successful. `name` is a string that contains the IPFS hash.

		`callback` must follow `function (err, result) {}` signature, where `err` is an error if the operation was not successful. `result` is an object that contains the resulting path, such as:

test: ipns over pubsub #361

test: ipns over pubsub #361

Conversation

vasco-santos commented Aug 31, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vasco-santos Oct 17, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alanshaw Oct 17, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vasco-santos Oct 17, 2018 •

edited

Loading

alanshaw Oct 17, 2018 •

edited

Loading