Skip to content
This repository has been archived by the owner on Feb 12, 2024. It is now read-only.

chore: update libp2p to 0.30 #3427

Merged
merged 14 commits into from
Jan 15, 2021
Merged

chore: update libp2p to 0.30 #3427

merged 14 commits into from
Jan 15, 2021

Conversation

vasco-santos
Copy link
Member

@vasco-santos vasco-santos commented Nov 27, 2020

@@ -70,6 +70,8 @@ class IPFS {
})
const dns = createDNSAPI()
const isOnline = createIsOnlineAPI({ network })
// @ts-ignore This type check fails as options.
// libp2p can be a function, while IPNS router config expects libp2p config
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not an easy fix. I recommend we do it individually

const exportKey = (name, password, options) =>
keychain.exportKey(name, password, options)
const exportKey = (name, password) =>
keychain.exportKey(name, password)
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We do not support Aborts/options in keychain.

@@ -41,6 +41,7 @@ module.exports = ({ network, config }) => {
*/
async function subscribe (topic, handler, options) {
const { libp2p } = await network.use(options)
// @ts-ignore Libp2p Pubsub is deprecating the handler, using the EventEmitter
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At some point we might get https://github.com/libp2p/js-libp2p/blob/0.30.x/src/pubsub-adapter.js this out. I can add in a follow up PR the handlers behaviour for IPFS

@@ -111,7 +113,7 @@ module.exports = ({ network, config }) => {
*/
async function ls (options) {
const { libp2p } = await network.use(options)
return libp2p.pubsub.getTopics(options)
return libp2p.pubsub.getTopics()
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pubsub has no options for getTopics + getSubscribers

@@ -43,6 +43,8 @@ class Storage {

const { peerId, keychain, isNew } = await loadRepo(repo, options)

// TODO: throw error?
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Keychain is not available in init IIRC. That is why it might exist or not

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So there was / is this code:

const libp2p = createLibP2P({
options: undefined,
multiaddrs: undefined,
peerId,
repo,
config,
keychainConfig: {
pass: options.pass
}
})
if (libp2p.keychain && libp2p.keychain.opts) {
await libp2p.loadKeychain()
await repo.config.set('Keychain', {
dek: libp2p.keychain.opts.dek
})
}
return { peerId, keychain: libp2p.keychain }

And this code path

const libp2p = createLibP2P({
options: undefined,
multiaddrs: undefined,
peerId,
repo,
config: changed,
keychainConfig: {
pass,
...changed.Keychain
}
})
if (libp2p.keychain) {
await libp2p.loadKeychain()
}
return { peerId, keychain: libp2p.keychain }

And I'm still not sure why libp2p is created in two different ways to be honest. It would be good to get these cleaned up (in some followup). I'd also happily pair on this as lack of uncertainty here really bothered me.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with you on this, it also confused me. We should improve this on a followup

packages/ipfs-core/package.json Outdated Show resolved Hide resolved
packages/ipfs-core/src/components/storage.js Outdated Show resolved Hide resolved
packages/ipfs-core/src/components/storage.js Outdated Show resolved Hide resolved
packages/ipfs-core/src/components/storage.js Outdated Show resolved Hide resolved
@vasco-santos vasco-santos force-pushed the chore/update-libp2p-to-0.30 branch 14 times, most recently from 40a6ac5 to 95499e7 Compare December 16, 2020 12:03
@vasco-santos vasco-santos force-pushed the chore/update-libp2p-to-0.30 branch 2 times, most recently from 2fc5b0c to c487184 Compare December 19, 2020 18:42
@vasco-santos vasco-santos marked this pull request as ready for review December 19, 2020 18:52
@vasco-santos vasco-santos requested review from hugomrdias and achingbrain and removed request for achingbrain December 19, 2020 19:46
Copy link
Contributor

@Gozala Gozala left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the pull @vasco-santos, looks good to me.

@@ -43,6 +43,8 @@ class Storage {

const { peerId, keychain, isNew } = await loadRepo(repo, options)

// TODO: throw error?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So there was / is this code:

const libp2p = createLibP2P({
options: undefined,
multiaddrs: undefined,
peerId,
repo,
config,
keychainConfig: {
pass: options.pass
}
})
if (libp2p.keychain && libp2p.keychain.opts) {
await libp2p.loadKeychain()
await repo.config.set('Keychain', {
dek: libp2p.keychain.opts.dek
})
}
return { peerId, keychain: libp2p.keychain }

And this code path

const libp2p = createLibP2P({
options: undefined,
multiaddrs: undefined,
peerId,
repo,
config: changed,
keychainConfig: {
pass,
...changed.Keychain
}
})
if (libp2p.keychain) {
await libp2p.loadKeychain()
}
return { peerId, keychain: libp2p.keychain }

And I'm still not sure why libp2p is created in two different ways to be honest. It would be good to get these cleaned up (in some followup). I'd also happily pair on this as lack of uncertainty here really bothered me.

@@ -43,6 +43,8 @@ class Storage {

const { peerId, keychain, isNew } = await loadRepo(repo, options)

// TODO: throw error?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like throw is not a great option here, if we keychain does not exists we should probably create it ? Otherwise I don't see how user is supposed to use this without getting an error.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As far as I understand, Keychain will always exist at this point as this is only used after start. The problem is that the types are not sure about it.

@@ -16,7 +16,7 @@ module.exports = ({ network }) => {
*/
async function disconnect (addr, options) {
const { libp2p } = await network.use(options)
return libp2p.hangUp(addr, options)
return libp2p.hangUp(addr)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just to do the same thing you did with dial

Suggested change
return libp2p.hangUp(addr)
await libp2p.hangUp(addr)

const filters = require('libp2p-websockets/src/filters')
const transportKey = WS.prototype[Symbol.toStringTag]

module.exports = () => ({
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this could be just an object since it doesn't take any input, it would reduce LoC in the others files

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The main reason I created a function here is to enable the options to be customized from the caller without modifying the actual content thanks to the new reference. We had issues in the past in libp2p tests, where its base configuration used in tests was modified in some tests, which caused other tests to have different configurations than expected required.
We currently only use it directly and I can turn that into an object. What do you think?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sounds good maybe freeze it to be safe if it makes sense.

@achingbrain achingbrain merged commit a39e6fb into master Jan 15, 2021
@achingbrain achingbrain deleted the chore/update-libp2p-to-0.30 branch January 15, 2021 08:42
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants