All files index.js

100% Statements 83/83
100% Branches 34/34
100% Functions 12/12
100% Lines 83/83
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 1861x 1x 1x     49x 49x   39x   10x       160x       1x 1x       1x         5x 5x       10x 10x 10x 10x 10x 10x 1x   10x                     4x     4x 4x         4x     4x 2x 2x 2x     4x 1x   4x 4x                   6x 6x 6x       10x 10x 10x 21x   21x 3x   18x   8x     18x 4x   14x 14x 14x 14x 8x   6x       10x                           99x 17x 17x 7x 7x   17x 16x 16x 16x 95x 95x   16x           43x 43x 26x 39x 39x     26x   26x 26x 11x 11x 11x 11x                         4x 1x 1x 1x   4x 4x      
const CID = require('cids')
const multihashes = require('multihashes')
const assert = require('assert')
 
function isValidCID (link) {
  try {
    CID.isCID(new CID(link))
  } catch (e) {
    return false
  }
  return true
}
 
function isObject (obj) {
  return typeof obj === 'object' && obj !== null
}
 
function clearObject (myObject) {
  for (var member in myObject) {
    delete myObject[member]
  }
}
 
module.exports = class Graph {
  /**
   * @param {Object} ipfsDag an instance of [ipfs.dag](https://github.com/ipfs/interface-ipfs-core/tree/master/API/dag#dag-api)
   */
  constructor (ipfsDag) {
    assert(ipfsDag, 'ipld-graph must have an instance of ipfs.dag')
    this._dag = ipfsDag
  }
 
  async _loadCID (node, link) {
    const cid = new CID(link)
    node.options = {}
    node.options.format = cid.codec
    node.options.hashAlg = multihashes.decode(cid.multihash).name
    let value = (await this._dag.get(cid)).value
    if (value && typeof value.toJSON === 'function') {
      value = value.toJSON()
    }
    node['/'] = value
  }
 
  /**
   * sets a value on a root object given its path
   * @param {Object} node
   * @param {String} path
   * @param {*} value
   * @return {Promise}
   */
  async set (node, path, value) {
    value = {
      '/': value
    }
    path = path.split('/')
    const last = path.pop()
    let {
      value: foundVal,
      remainderPath: remainder,
      parent
    } = await this._get(node, path)
 
    // if the found value is a litaral attach an object to the parent object
    if (!isObject(foundVal)) {
      const pos = path.length - remainder.length - 1
      const name = path.slice(pos, pos + 1)[0]
      foundVal = parent[name] = {}
    }
    // extend the path for the left over path names
    for (const name of remainder) {
      foundVal = foundVal[name] = {}
    }
    foundVal[last] = value
    return node
  }
 
  /**
   * traverses an object's path and returns the resulting value in a Promise
   * @param {Object} node
   * @param {String} path
   * @return {Promise}
   */
  async get (node, path) {
    path = path.split('/')
    const {value} = await this._get(node, path)
    return value
  }
 
  async _get (node, path) {
    let parent = node
    path = path.slice(0)
    while (1) {
      const link = node['/']
      // if there is a link, traverse throught it
      if (isValidCID(link)) {
        await this._loadCID(node, link)
      } else {
        if (link !== undefined) {
          // link is a POJO
          node = link
        }
        // traverse through POJOs
        if (!path.length) {
          break
        }
        const name = path.shift()
        const edge = node[name]
        node = edge
        if (isObject(edge)) {
          parent = node
        } else {
          break
        }
      }
    }
    return {
      value: node,
      remainderPath: path,
      parent: parent
    }
  }
 
  /**
   * Resolves all the links in an object and does so recusivly for N `level`
   * @param {Object} node
   * @param {Integer} levels
   * @return {Promise}
   */
  async tree (node, levels = 1) {
    if (isObject(node)) {
      const link = node['/']
      if (isValidCID(link)) {
        await this._loadCID(node, link)
        node = node['/']
      }
      if (levels) {
        levels--
        const promises = []
        for (const name in node) {
          const edge = node[name]
          promises.push(this.tree(edge, levels))
        }
        await Promise.all(promises)
      }
    }
  }
 
  async _flush (node, opts = {format: 'dag-cbor', hashAlg: 'sha2-256'}) {
    const awaiting = []
    if (isObject(node)) {
      for (const name in node) {
        const edge = node[name]
        awaiting.push(this._flush(edge))
      }
 
      await Promise.all(awaiting)
 
      const link = node['/']
      if (link !== undefined && !isValidCID(link)) {
        let options = node.options || opts
        delete node.options
        return this._dag.put(link, options).then(cid => {
          node['/'] = cid.toBaseEncodedString()
        })
      }
    }
  }
 
  /**
   * flush an object to ipfs returning the resulting CID in a promise
   * @param {Object} node
   * @param {Object} opts - encoding options for [`dag.put`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/dag#dagput)
   * @return {Promise}
   */
  async flush (node, opts) {
    if (!node['/']) {
      const oldRoot = Object.assign({}, node)
      clearObject(node)
      node['/'] = oldRoot
    }
    await this._flush(node, opts)
    return node
  }
}