fix: allow mtime and mode to be optional #38
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -17,121 +17,138 @@ const Buffer = require('safe-buffer').Buffer | |
| describe('unixfs-format', () => { | ||
| it('raw', () => { | ||
| const data = new UnixFS('raw', Buffer.from('bananas')) | ||
| const marshaled = data.marshal() | ||
| const unmarshaled = UnixFS.unmarshal(marshaled) | ||
| expect(data.type).to.equal(unmarshaled.type) | ||
| expect(data.data).to.deep.equal(unmarshaled.data) | ||
| expect(data.blockSizes).to.deep.equal(unmarshaled.blockSizes) | ||
| expect(data.fileSize()).to.deep.equal(unmarshaled.fileSize()) | ||
| }) | ||
|
|
||
| it('directory', () => { | ||
| const data = new UnixFS('directory') | ||
| const marshaled = data.marshal() | ||
| const unmarshaled = UnixFS.unmarshal(marshaled) | ||
| expect(data.type).to.equal(unmarshaled.type) | ||
| expect(data.data).to.deep.equal(unmarshaled.data) | ||
| expect(data.blockSizes).to.deep.equal(unmarshaled.blockSizes) | ||
| expect(data.fileSize()).to.deep.equal(unmarshaled.fileSize()) | ||
| }) | ||
|
|
||
| it('hamt-sharded-directory', () => { | ||
| const data = new UnixFS('hamt-sharded-directory') | ||
| const marshaled = data.marshal() | ||
| const unmarshaled = UnixFS.unmarshal(marshaled) | ||
| expect(data.type).to.equal(unmarshaled.type) | ||
| expect(data.data).to.deep.equal(unmarshaled.data) | ||
| expect(data.blockSizes).to.deep.equal(unmarshaled.blockSizes) | ||
| expect(data.fileSize()).to.deep.equal(unmarshaled.fileSize()) | ||
| }) | ||
|
|
||
| it('file', () => { | ||
| const data = new UnixFS('file', Buffer.from('batata')) | ||
| const marshaled = data.marshal() | ||
| const unmarshaled = UnixFS.unmarshal(marshaled) | ||
| expect(data.type).to.equal(unmarshaled.type) | ||
| expect(data.data).to.deep.equal(unmarshaled.data) | ||
| expect(data.blockSizes).to.deep.equal(unmarshaled.blockSizes) | ||
| expect(data.fileSize()).to.deep.equal(unmarshaled.fileSize()) | ||
| }) | ||
|
|
||
| it('file add blocksize', () => { | ||
| const data = new UnixFS('file') | ||
| data.addBlockSize(256) | ||
| const marshaled = data.marshal() | ||
| const unmarshaled = UnixFS.unmarshal(marshaled) | ||
| expect(data.type).to.equal(unmarshaled.type) | ||
| expect(data.data).to.deep.equal(unmarshaled.data) | ||
| expect(data.blockSizes).to.deep.equal(unmarshaled.blockSizes) | ||
| expect(data.fileSize()).to.deep.equal(unmarshaled.fileSize()) | ||
| }) | ||
|
|
||
| it('file add and remove blocksize', () => { | ||
| const data = new UnixFS('file') | ||
| data.addBlockSize(256) | ||
| const marshaled = data.marshal() | ||
| const unmarshaled = UnixFS.unmarshal(marshaled) | ||
| expect(data.type).to.equal(unmarshaled.type) | ||
| expect(data.data).to.deep.equal(unmarshaled.data) | ||
| expect(data.blockSizes).to.deep.equal(unmarshaled.blockSizes) | ||
| expect(data.fileSize()).to.deep.equal(unmarshaled.fileSize()) | ||
| unmarshaled.removeBlockSize(0) | ||
| expect(data.blockSizes).to.not.deep.equal(unmarshaled.blockSizes) | ||
| }) | ||
|
|
||
| it('mode', () => { | ||
|
There was a problem hiding this comment. Is there any way I can convince you to make the spec follow golang's Having already paid for transporting a 32bit value, it seems so odd to not populate the rest of the bits if we have them. In js-ipfs you can of course simply mask them off, the point is for the spec to allow it... There was a problem hiding this comment. Is there anything in the spec that prevents us filling the higher bits with subsequent PRs? From my understanding all we've done so far is specify the equivalent of the file mode component of There was a problem hiding this comment. @achingbrain yes you are correct. I crossed wires with not explicitly masking off future bits for when we do add them, I left a comment to the effect above |
||
| const mode = parseInt('0555', 8) | ||
| const data = new UnixFS('file') | ||
| data.mode = mode | ||
|
|
||
| expect(UnixFS.unmarshal(data.marshal())).to.have.property('mode', mode) | ||
| }) | ||
|
|
||
| it('removes mode', () => { | ||
| const mode = parseInt('0555', 8) | ||
| const data = new UnixFS('file') | ||
| data.mode = mode | ||
|
|
||
| const unmarshaled = UnixFS.unmarshal(data.marshal()) | ||
| expect(unmarshaled).to.have.property('mode', mode) | ||
|
|
||
| delete unmarshaled.mode | ||
|
|
||
| expect(UnixFS.unmarshal(unmarshaled.marshal())).to.not.have.property('mode') | ||
| }) | ||
|
|
||
| it('sets mode to 0', () => { | ||
| const mode = 0 | ||
| const data = new UnixFS('file') | ||
| data.mode = mode | ||
|
|
||
| expect(UnixFS.unmarshal(data.marshal())).to.have.property('mode', mode) | ||
| }) | ||
|
|
||
| it('mtime', () => { | ||
| const mtime = new Date() | ||
| const data = new UnixFS('file') | ||
| data.mtime = mtime | ||
| const marshaled = data.marshal() | ||
| const unmarshaled = UnixFS.unmarshal(marshaled) | ||
| expect(unmarshaled.mtime).to.deep.equal(new Date(Math.round(mtime.getTime() / 1000) * 1000)) | ||
| }) | ||
|
|
||
| it('removes mtime', () => { | ||
| const mtime = new Date() | ||
| const data = new UnixFS('file') | ||
| data.mtime = mtime | ||
|
|
||
| const unmarshaled = UnixFS.unmarshal(data.marshal()) | ||
| expect(unmarshaled).to.have.deep.property('mtime', new Date(Math.round(mtime.getTime() / 1000) * 1000)) | ||
|
|
||
| delete unmarshaled.mtime | ||
|
|
||
| expect(UnixFS.unmarshal(unmarshaled.marshal())).to.not.have.property('mtime') | ||
| }) | ||
|
|
||
| it('sets mtime to 0', () => { | ||
| const mtime = new Date(0) | ||
| const data = new UnixFS('file') | ||
| data.mtime = mtime | ||
|
|
||
| expect(UnixFS.unmarshal(data.marshal())).to.have.deep.property('mtime', new Date(Math.round(mtime.getTime() / 1000) * 1000)) | ||
| }) | ||
|
|
||
| // figuring out what is this metadata for https://github.com/ipfs/js-ipfs-data-importing/issues/3#issuecomment-182336526 | ||
| it.skip('metadata', () => {}) | ||
|
|
||
| it('symlink', () => { | ||
| const data = new UnixFS('symlink') | ||
| const marshaled = data.marshal() | ||
| const unmarshaled = UnixFS.unmarshal(marshaled) | ||
| expect(data.type).to.equal(unmarshaled.type) | ||
| expect(data.data).to.deep.equal(unmarshaled.data) | ||
| expect(data.blockSizes).to.deep.equal(unmarshaled.blockSizes) | ||
| expect(data.fileSize()).to.deep.equal(unmarshaled.fileSize()) | ||
| }) | ||
| it('wrong type', (done) => { | ||
| let data | ||
|
|
@@ -146,42 +163,42 @@ describe('unixfs-format', () => { | |
|
|
||
| describe('interop', () => { | ||
| it('raw', () => { | ||
| const unmarshaled = UnixFS.unmarshal(raw) | ||
| expect(unmarshaled.data).to.eql(Buffer.from('Hello UnixFS\n')) | ||
| expect(unmarshaled.type).to.equal('file') | ||
| expect(unmarshaled.marshal()).to.deep.equal(raw) | ||
| }) | ||
|
|
||
| it('directory', () => { | ||
| const unmarshaled = UnixFS.unmarshal(directory) | ||
| expect(unmarshaled.data).to.deep.equal(undefined) | ||
| expect(unmarshaled.type).to.equal('directory') | ||
| expect(unmarshaled.marshal()).to.deep.equal(directory) | ||
| }) | ||
|
|
||
| it('file', () => { | ||
| const unmarshaled = UnixFS.unmarshal(file) | ||
| expect(unmarshaled.data).to.deep.equal(Buffer.from('Hello UnixFS\n')) | ||
| expect(unmarshaled.type).to.equal('file') | ||
| expect(unmarshaled.marshal()).to.deep.equal(file) | ||
| }) | ||
|
|
||
| it.skip('metadata', () => { | ||
| }) | ||
|
|
||
| it('symlink', () => { | ||
| const unmarshaled = UnixFS.unmarshal(symlink) | ||
| expect(unmarshaled.data).to.deep.equal(Buffer.from('file.txt')) | ||
| expect(unmarshaled.type).to.equal('symlink') | ||
| // TODO: waiting on https://github.com/ipfs/js-ipfs-data-importing/issues/3#issuecomment-182440079 | ||
| // expect(unmarshaled.marshal()).to.deep.equal(symlink) | ||
| }) | ||
| }) | ||
|
|
||
| it('empty', () => { | ||
| const data = new UnixFS('file') | ||
| const marshaled = data.marshal() | ||
|
|
||
| expect(marshaled).to.deep.equal(Buffer.from([0x08, 0x02, 0x18, 0x00])) | ||
| }) | ||
| }) | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As per ipfs/specs#231, this needs to mask off with
07777There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's not in the spec yet, will do a further PR if it gets added.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
However, let's be careful. If we get a file that has extra bits, we should round-trip those bits. Otherwise, it's hard to add features later.