Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: protect possible empty ipfsModule option #449

Merged
merged 1 commit into from
Jan 29, 2020
Merged

Conversation

hugomrdias
Copy link
Member

With this change only when type === go the option can be an empty object.

With this change only when `type === go` the option can be an empty object.
this.overrides[options.type || this.opts.type],
this.overrides[type],
// conditionally include ipfs based on which type of daemon we will spawn when none has been specifed
(type === 'js' || type === 'proc') ? {
Copy link
Member

@achingbrain achingbrain Jan 29, 2020

Choose a reason for hiding this comment

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

What about when the user does:

factory.spawn({
  type: 'js',
  ipfsModule: {
    path: require.resolve('some/other/path/to/ipfs'),
    ref: require('some/other/path/to/ipfs'),
  }
})

I think with this change the ipfsModule option the user passes in will get ignored

Copy link
Member Author

Choose a reason for hiding this comment

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

no, user options is the last arg and overrides everything above

Copy link
Member

Choose a reason for hiding this comment

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

Yeah, just thought of that :)

Copy link
Member

@alanshaw alanshaw Jan 30, 2020

Choose a reason for hiding this comment

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

It still evaluates require('ipfs') which does not work when used in js-ipfs.

Screenshot 2020-01-30 at 12 45 27

Copy link
Member

Choose a reason for hiding this comment

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

This is fixed in #450

options
)

// conditionally include ipfs based on which type of daemon we will spawn when none has been specifed
if ((opts.type === 'js' || opts.type === 'proc') && !opts.ipfsModule) {
Copy link
Member

@achingbrain achingbrain Jan 29, 2020

Choose a reason for hiding this comment

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

I was thinking this needed to be something more like:

if ((opts.type === 'js' || opts.type === 'proc') && !opts.ipfsModule) {	
  opts.ipfsModule = {}
}

if (opts.ipfsModule) {
  if (!opts.ipfsModule.path) {
    opts.ipfsModule.path = require.resolve('ipfs')
  }

  if (!opts.ipfsModule.ref) {
    opts.ipfsModule.ref = require(opts.ipfsModule.path)
  }
}

Copy link
Member Author

Choose a reason for hiding this comment

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

with the current changes we don't need to protect it like that, its already safe

https://codesandbox.io/s/clever-ride-kr3r1

@hugomrdias hugomrdias merged commit 09b1917 into master Jan 29, 2020
@hugomrdias hugomrdias deleted the fix/ipfs-module branch January 29, 2020 16:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants