Merge pull request #36 from ipfs/add-metadata

feat: adds metadata to unixfs

Author: achingbrain

package.json

@@ -8,7 +8,7 @@
     "fs": false
   },
   "scripts": {
-    "test": "aegir test -t node -t browser",
+    "test": "aegir test -t node -t browser -t webworker",
     "test:node": "aegir test -t node",
     "test:browser": "aegir test -t browser",
     "test:webworker": "aegir test -t webworker",
@@ -36,7 +36,7 @@
   },
   "homepage": "https://github.com/ipfs/js-ipfs-unixfs#readme",
   "devDependencies": {
-    "aegir": "^18.0.0",
+    "aegir": "^20.4.1",
     "chai": "^4.2.0",
     "dirty-chai": "^2.0.1",
     "safe-buffer": "^5.1.2"

src/index.js

@@ -32,6 +32,14 @@ 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)
   }
@@ -71,7 +79,6 @@ function Data (type, data) {
       default:
         throw new Error(`Unkown type: "${this.type}"`)
     }
-    let fileSize = this.fileSize()
 
     let data = this.data
 
@@ -85,13 +92,23 @@ function Data (type, data) {
       blockSizes = undefined
     }
 
+    if ((this.type === 'directory' || this.type === 'hamt-sharded-directory') && this.mode === parseInt('0755', 8)) {
+      delete this.mode
+    }
+
+    if (this.type === 'file' && this.mode === parseInt('0644', 8)) {
+      delete this.mode
+    }
+
     return unixfsData.encode({
       Type: type,
       Data: data,
-      filesize: fileSize,
+      filesize: this.fileSize(),
       blocksizes: blockSizes,
       hashType: this.hashType,
-      fanout: this.fanout
+      fanout: this.fanout,
+      mode: this.mode,
+      mtime: this.mtime
     })
   }
 }
@@ -104,6 +121,15 @@ Data.unmarshal = (marsheled) => {
   }
   const obj = new Data(types[decoded.Type], decoded.Data)
   obj.blockSizes = decoded.blocksizes
+
+  if (decoded.mode) {
+    obj.mode = decoded.mode
+  }
+
+  if (decoded.mtime) {
+    obj.mtime = decoded.mtime
+  }
+
   return obj
 }
 

src/unixfs.proto.js

@@ -14,9 +14,10 @@ module.exports = `message Data {
   optional bytes Data = 2;
   optional uint64 filesize = 3;
   repeated uint64 blocksizes = 4;
-
   optional uint64 hashType = 5;
   optional uint64 fanout = 6;
+  optional uint32 mode = 7;
+  optional int64 mtime = 8;
 }
 
 message Metadata {

test/unixfs-format.spec.js

@@ -79,6 +79,48 @@ describe('unixfs-format', () => {
     expect(data.blockSizes).to.not.deep.equal(unmarshalled.blockSizes)
   })
 
+  it('default mode for files', () => {
+    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))
+  })
+
+  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))
+  })
+
+  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('mode', () => {
+    const mode = parseInt('0555', 8)
+    const data = new UnixFS('file')
+    data.mode = mode
+    const marshalled = data.marshal()
+    const unmarshalled = UnixFS.unmarshal(marshalled)
+    expect(unmarshalled.mode).to.equal(mode)
+  })
+
+  it('mtime', () => {
+    const mtime = parseInt(Date.now() / 1000)
+    const data = new UnixFS('file')
+    data.mtime = mtime
+    const marshalled = data.marshal()
+    const unmarshalled = UnixFS.unmarshal(marshalled)
+    expect(unmarshalled.mtime).to.equal(mtime)
+  })
+
   // figuring out what is this metadata for https://github.com/ipfs/js-ipfs-data-importing/issues/3#issuecomment-182336526
   it.skip('metadata', () => {})