fix: block.put() options #793
Conversation
| hashAlg: opts.mhtype || 'sha2-256' | ||
| }) | ||
|
|
||
| if (cid && CID.isCID(cid)) { |
There was a problem hiding this comment.
At this point cid could be a string, buffer or CID instance (spec). isCID only checks if the parameter is a CID instance, so currently the passed cid will be ignored if it's not a CID instance!
|
|
||
| if (qs.format && qs.format.startsWith('dag-')) { | ||
| _send = SendOneFile(send, 'dag/put') | ||
| } |
There was a problem hiding this comment.
I'm mildly against adding this workaround here. I think it'll be unexpected for this method to call dag/put and without some comments or docs this behaviour will become confusing for contributors as well. It also sounds as though it's specific to go-ipfs and I'd rather not add implementation specific workarounds here in the API if we can avoid it. I'd like to know if js-ipfs has the same issue.
Is there an open issue in go-ipfs for this? It would be good to get this fixed there.
ghost
removed
the
So, this contains numerous fixes to block.put() some of which break the current tests because the tests are actually broken.
Prior to this patch, options passed in were simply ignored. The tests for those options showed false positives because the tests are passing in the default encoding values (dag-pb, sha2-256).
However, go-ipfs currently fails when trying to use
/block/putfor a dag node, you have to use/dag/putinstead. So, I modified ourblock.put()API to check the format and call the dag put API instead, this is actually a good thing since the JS API fordag.put()does encoding for you which means adding this support toblock.put()allows you to write already encoded dag nodes (which happens to be something I need anyway).And now 3 tests are failing because those tests don't actually write a valid
dag-pbnode, they're just random junk buffers, and/dag/putactually validates them :)I'll try to get around to fixing the tests and maybe writing a few extras as there's a few new features in here too (when you pass a Block instance it will use the attached cid, so you don't need to pass it in separately). But I won't get to that until next week and I wanted to get some eyeballs on this first.