Skip to content

fix: protect possible empty ipfsModule option #449

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.

Sign up for GitHub

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

Merged
hugomrdias merged 1 commit into from
Jan 29, 2020
Merged

fix: protect possible empty ipfsModule option #449

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 10 additions & 9 deletions src/factory.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ const defaults = {
path: require.resolve('ipfs-http-client'),
ref: require('ipfs-http-client')
},
ipfsModule: {},
ipfsOptions: {},
forceKill: true,
forceKillTimeout: 5000
Expand Down Expand Up @@ -104,19 +105,19 @@ class Factory {
* @returns {Promise<ControllerDaemon>}
*/
async spawn (options = { }) {
const type = options.type || this.opts.type
const opts = merge(
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') ? {

@achingbrain achingbrain Jan 29, 2020 •
edited
Loading

Copy link
Copy Markdown
Member

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

@hugomrdias hugomrdias Jan 29, 2020

Copy link
Copy Markdown
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

@achingbrain achingbrain Jan 29, 2020

Copy link
Copy Markdown
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 :)

@alanshaw alanshaw Jan 30, 2020 •
edited
Loading

Copy link
Copy Markdown
Member

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

@achingbrain achingbrain Jan 31, 2020

Copy link
Copy Markdown
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

ipfsModule: {
path: require.resolve('ipfs'),
ref: require('ipfs')
}
} : {},
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) {

@achingbrain achingbrain Jan 29, 2020 •
edited
Loading

Copy link
Copy Markdown
Member

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)
  }
}

@hugomrdias hugomrdias Jan 29, 2020

Copy link
Copy Markdown
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

opts.ipfsModule = {
path: require.resolve('ipfs'),
ref: require('ipfs')
}
}

// IPFS options defaults
const ipfsOptions = merge(
{
Expand Down