feat: support storing metadata in unixfs nodes

.travis.yml

@@ -6,7 +6,7 @@ stages:
   - cov
 
 node_js:
-  - '10'
+  - '12'
 
 os:
   - linux

README.md

@@ -1,4 +1,4 @@
-# ipfs-unixfs-importer
+# ipfs-unixfs-importer <!-- omit in toc -->
 
 [![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)
 [![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)
@@ -13,22 +13,19 @@
 
 > JavaScript implementation of the layout and chunking mechanisms used by IPFS to handle Files
 
-## Lead Maintainer
+## Lead Maintainer <!-- omit in toc -->
 
 [Alex Potsides](https://github.com/achingbrain)
 
-## Table of Contents
+## Table of Contents <!-- omit in toc -->
 
-- [ipfs-unixfs-importer](#ipfs-unixfs-importer)
-  - [Lead Maintainer](#lead-maintainer)
-  - [Table of Contents](#table-of-contents)
-  - [Install](#install)
-  - [Usage](#usage)
-    - [Example](#example)
-      - [API](#api)
-      - [const import = importer(source, ipld [, options])](#const-import--importersource-ipld--options)
-  - [Contribute](#contribute)
-  - [License](#license)
+- [Install](#install)
+- [Usage](#usage)
+  - [Example](#example)
+    - [API](#api)
+    - [const import = importer(source, ipld [, options])](#const-import--importersource-ipld--options)
+- [Contribute](#contribute)
+- [License](#license)
 
 ## Install
 
@@ -108,7 +105,9 @@ The `import` function returns an async iterator takes a source async iterator th
 ```js
 {
   path: 'a name',
-  content: (Buffer or iterator emitting Buffers)
+  content: (Buffer or iterator emitting Buffers),
+  mtime: (Number representing seconds since (positive) or before (negative) the Unix Epoch),
+  mode: (Number representing ugo-rwx, setuid, setguid and sticky bit)
 }
 ```
 

package.json

@@ -44,7 +44,7 @@
     "cids": "~0.7.1",
     "detect-node": "^2.0.4",
     "dirty-chai": "^2.0.1",
-    "ipfs-unixfs-exporter": "~0.37.0",
+    "ipfs-unixfs-exporter": "^0.39.0",
     "ipld": "^0.25.0",
     "ipld-in-memory": "^3.0.0",
     "multihashes": "~0.4.14",
@@ -55,16 +55,16 @@
     "async-iterator-all": "^1.0.0",
     "async-iterator-batch": "~0.0.1",
     "async-iterator-first": "^1.0.0",
-    "bl": "^3.0.0",
+    "bl": "^4.0.0",
     "deep-extend": "~0.6.0",
     "err-code": "^2.0.0",
     "hamt-sharding": "~0.0.2",
-    "ipfs-unixfs": "~0.1.16",
+    "ipfs-unixfs": "^0.2.0",
     "ipld-dag-pb": "^0.18.0",
     "multicodec": "~0.5.1",
-    "multihashing-async": "~0.7.0",
+    "multihashing-async": "^0.8.0",
     "rabin-wasm": "~0.0.8",
-    "superstruct": "~0.6.1"
+    "superstruct": "^0.8.2"
   },
   "contributors": [
     "Alan Shaw <alan.shaw@protocol.ai>",

src/dag-builder/file/index.js

@@ -81,6 +81,14 @@ const reduce = (file, ipld, options) => {
     // create a parent node and add all the leaves
     const f = new UnixFS('file')
 
+    if (options.mtime) {
+      f.mtime = options.mtime
+    }
+
+    if (options.mode) {
+      f.mode = options.mode
+    }
+
     const links = leaves
       .filter(leaf => {
         if (leaf.cid.codec === 'raw' && leaf.node.length) {

src/dag-builder/index.js

@@ -33,10 +33,18 @@ async function * dagBuilder (source, ipld, options) {
       const chunker = createChunker(options.chunker, validateChunks(source), options.chunkerOptions)
 
       // item is a file
-      yield fileBuilder(entry, chunker, ipld, options)
+      yield fileBuilder(entry, chunker, ipld, {
+        ...options,
+        mode: entry.mode,
+        mtime: entry.mtime
+      })
     } else {
       // item is a directory
-      yield dirBuilder(entry, ipld, options)
+      yield dirBuilder(entry, ipld, {
+        ...options,
+        mode: entry.mode,
+        mtime: entry.mtime
+      })
     }
   }
 }

test/benchmark.spec.js

@@ -24,7 +24,7 @@ describe.skip('benchmark', function () {
   const times = []
 
   after(() => {
-    console.info(`Percent\tms`) // eslint-disable-line no-console
+    console.info('Percent\tms') // eslint-disable-line no-console
     times.forEach((time, index) => {
       console.info(`${index}\t${parseInt(time / REPEATS)}`) // eslint-disable-line no-console
     })

test/importer.spec.js

@@ -676,5 +676,43 @@ strategies.forEach((strategy) => {
         }
       }
     })
+
+    it('supports passing mtime', async () => {
+      this.timeout(60 * 1000)
+
+      const options = {
+        rawLeaves: true
+      }
+      const now = parseInt(Date.now() / 1000)
+
+      for await (const file of importer([{
+        path: '1.2MiB.txt',
+        content: bigFile,
+        mtime: now
+      }], ipld, options)) {
+        const node = await exporter(file.cid, ipld)
+
+        expect(node.unixfs.mtime).to.equal(now)
+      }
+    })
+
+    it('supports passing mode', async () => {
+      this.timeout(60 * 1000)
+
+      const options = {
+        rawLeaves: true
+      }
+      const mode = parseInt('0111', 8)
+
+      for await (const file of importer([{
+        path: '1.2MiB.txt',
+        content: bigFile,
+        mode
+      }], ipld, options)) {
+        const node = await exporter(file.cid, ipld)
+
+        expect(node.unixfs.mode).to.equal(mode)
+      }
+    })
   })
 })