fix: allow mtime and mode to be optional

Uses protobuf messages to enable having mode and mtime as actually
optional values.

Author: achingbrain

src/index.js

@@ -32,14 +32,6 @@ function Data (type, data) {
   this.data = data
   this.blockSizes = []
 
-  if (this.type === 'file') {
-    this.mode = parseInt('0644', 8)
-  }
-
-  if (this.type === 'directory' || this.type === 'hamt-sharded-directory') {
-    this.mode = parseInt('0755', 8)
-  }
-
   this.addBlockSize = (size) => {
     this.blockSizes.push(size)
   }
@@ -92,12 +84,22 @@ function Data (type, data) {
       blockSizes = undefined
     }
 
-    if ((this.type === 'directory' || this.type === 'hamt-sharded-directory') && this.mode === parseInt('0755', 8)) {
-      delete this.mode
+    let mode
+
+    if (this.mode != null && this.mode >= 0) {
+      mode = {
+        value: this.mode
+      }
     }
 
-    if (this.type === 'file' && this.mode === parseInt('0644', 8)) {
-      delete this.mode
+    let mtime
+
+    if (this.mtime != null && this.mtime >= 0) {
+      mtime = {
+        value: [
+          this.mtime
+        ]
+      }
     }
 
     return unixfsData.encode({
@@ -107,27 +109,29 @@ function Data (type, data) {
       blocksizes: blockSizes,
       hashType: this.hashType,
       fanout: this.fanout,
-      mode: this.mode,
-      mtime: this.mtime
+      mode: mode,
+      mtime: mtime
     })
   }
 }
 
 // decode from protobuf https://github.com/ipfs/go-ipfs/blob/master/unixfs/format.go#L24
 Data.unmarshal = (marsheled) => {
   const decoded = unixfsData.decode(marsheled)
+
   if (!decoded.Data) {
     decoded.Data = undefined
   }
+
   const obj = new Data(types[decoded.Type], decoded.Data)
   obj.blockSizes = decoded.blocksizes
 
-  if (decoded.mode) {
-    obj.mode = decoded.mode
+  if (decoded.mode != null) {
+    obj.mode = decoded.mode.value
   }
 
-  if (decoded.mtime) {
-    obj.mtime = decoded.mtime
+  if (decoded.mtime != null) {
+    obj.mtime = decoded.mtime.value[0]
   }
 
   return obj

src/unixfs.proto.js

@@ -16,10 +16,18 @@ module.exports = `message Data {
   repeated uint64 blocksizes = 4;
   optional uint64 hashType = 5;
   optional uint64 fanout = 6;
-  optional uint32 mode = 7;
-  optional int64 mtime = 8;
+  optional Mode mode = 7;
+  optional Mtime mtime = 8;
 }
 
 message Metadata {
   optional string MimeType = 1;
+}
+
+message Mode {
+  optional uint32 value = 1;
+}
+
+message Mtime {
+  repeated int64 value = 1;
 }`

test/unixfs-format.spec.js

@@ -79,37 +79,33 @@ describe('unixfs-format', () => {
     expect(data.blockSizes).to.not.deep.equal(unmarshalled.blockSizes)
   })
 
-  it('default mode for files', () => {
+  it('mode', () => {
+    const mode = parseInt('0555', 8)
     const data = new UnixFS('file')
-    expect(data.mode).to.equal(parseInt('0644', 8))
-    const marshalled = data.marshal()
-    const unmarshalled = UnixFS.unmarshal(marshalled)
-    expect(unmarshalled.mode).to.equal(parseInt('0644', 8))
-  })
+    data.mode = mode
 
-  it('default mode for directories', () => {
-    const data = new UnixFS('directory')
-    expect(data.mode).to.equal(parseInt('0755', 8))
-    const marshalled = data.marshal()
-    const unmarshalled = UnixFS.unmarshal(marshalled)
-    expect(unmarshalled.mode).to.equal(parseInt('0755', 8))
+    expect(UnixFS.unmarshal(data.marshal())).to.have.property('mode', mode)
   })
 
-  it('default mode for hamt-sharded-directories', () => {
-    const data = new UnixFS('hamt-sharded-directory')
-    expect(data.mode).to.equal(parseInt('0755', 8))
-    const marshalled = data.marshal()
-    const unmarshalled = UnixFS.unmarshal(marshalled)
-    expect(unmarshalled.mode).to.equal(parseInt('0755', 8))
+  it('removes mode', () => {
+    const mode = parseInt('0555', 8)
+    const data = new UnixFS('file')
+    data.mode = mode
+
+    const unmarshalled = UnixFS.unmarshal(data.marshal())
+    expect(unmarshalled).to.have.property('mode', mode)
+
+    delete unmarshalled.mode
+
+    expect(UnixFS.unmarshal(unmarshalled.marshal())).to.not.have.property('mode')
   })
 
-  it('mode', () => {
-    const mode = parseInt('0555', 8)
+  it('sets mode to 0', () => {
+    const mode = 0
     const data = new UnixFS('file')
     data.mode = mode
-    const marshalled = data.marshal()
-    const unmarshalled = UnixFS.unmarshal(marshalled)
-    expect(unmarshalled.mode).to.equal(mode)
+
+    expect(UnixFS.unmarshal(data.marshal())).to.have.property('mode', mode)
   })
 
   it('mtime', () => {
@@ -121,6 +117,27 @@ describe('unixfs-format', () => {
     expect(unmarshalled.mtime).to.equal(mtime)
   })
 
+  it('removes mtime', () => {
+    const mtime = parseInt(Date.now() / 1000)
+    const data = new UnixFS('file')
+    data.mtime = mtime
+
+    const unmarshalled = UnixFS.unmarshal(data.marshal())
+    expect(unmarshalled).to.have.property('mtime', mtime)
+
+    delete unmarshalled.mtime
+
+    expect(UnixFS.unmarshal(unmarshalled.marshal())).to.not.have.property('mtime')
+  })
+
+  it('sets mtime to 0', () => {
+    const mtime = 0
+    const data = new UnixFS('file')
+    data.mtime = mtime
+
+    expect(UnixFS.unmarshal(data.marshal())).to.have.property('mtime', mtime)
+  })
+
   // figuring out what is this metadata for https://github.com/ipfs/js-ipfs-data-importing/issues/3#issuecomment-182336526
   it.skip('metadata', () => {})