use random-access-file 3 (#118)

* use random-access-file 3

* force bump

* move ram to latest also

* fix typo

Author: mafintosh

index.js

@@ -1,5 +1,5 @@
 const { EventEmitter } = require('events')
-const raf = require('random-access-file')
+const RAF = require('random-access-file')
 const isOptions = require('is-options')
 const hypercoreCrypto = require('hypercore-crypto')
 const c = require('compact-encoding')
@@ -9,8 +9,6 @@ const NoiseSecretStream = require('@hyperswarm/secret-stream')
 const Protomux = require('protomux')
 const codecs = require('codecs')
 
-const fsctl = requireMaybe('fsctl') || { lock: noop, sparse: noop }
-
 const Replicator = require('./lib/replicator')
 const Core = require('./lib/core')
 const BlockEncryption = require('./lib/block-encryption')
@@ -162,14 +160,25 @@ module.exports = class Hypercore extends EventEmitter {
   }
 
   static defaultStorage (storage, opts = {}) {
-    if (typeof storage !== 'string') return storage
+    if (typeof storage !== 'string') {
+      if (!isRandomAccessClass(storage)) return storage
+      const Cls = storage // just to satisfy standard...
+      return name => new Cls(name)
+    }
+
     const directory = storage
     const toLock = opts.lock || 'oplog'
-    return function createFile (name) {
-      const locked = name === toLock || name.endsWith('/' + toLock)
-      const lock = locked ? fsctl.lock : null
-      const sparse = locked ? null : null // fsctl.sparse, disable sparse on windows - seems to fail for some people. TODO: investigate
-      return raf(name, { directory, lock, sparse })
+
+    return createFile
+
+    function createFile (name) {
+      const lock = isFile(name, toLock)
+      const sparse = isFile(name, 'data') || isFile(name, 'bitfield') || isFile(name, 'tree')
+      return new RAF(name, { directory, lock, sparse })
+    }
+
+    function isFile (name, n) {
+      return name === n || name.endsWith('/' + n)
     }
   }
 
@@ -852,12 +861,8 @@ function isStream (s) {
   return typeof s === 'object' && s && typeof s.pipe === 'function'
 }
 
-function requireMaybe (name) {
-  try {
-    return require(name)
-  } catch (_) {
-    return null
-  }
+function isRandomAccessClass (fn) {
+  return !!(typeof fn === 'function' && fn.prototype && typeof fn.prototype.open === 'function')
 }
 
 function toHex (buf) {

package.json

@@ -43,7 +43,7 @@
     "hypercore-crypto": "^3.2.1",
     "is-options": "^1.0.1",
     "protomux": "^3.2.0",
-    "random-access-file": "^2.1.4",
+    "random-access-file": "^3.0.1",
     "random-array-iterator": "^1.0.0",
     "safety-catch": "^1.0.1",
     "sodium-universal": "^3.0.4",
@@ -52,13 +52,10 @@
   },
   "devDependencies": {
     "brittle": "^2.0.0",
-    "hyperswarm": "next",
-    "random-access-memory": "^4.1.0",
-    "random-access-memory-overlay": "^1.0.0",
+    "hyperswarm": "^4.1.1",
+    "random-access-memory": "^5.0.0",
+    "random-access-memory-overlay": "^2.0.0",
     "standard": "^16.0.3",
     "tmp-promise": "^3.0.2"
-  },
-  "optionalDependencies": {
-    "fsctl": "^1.0.0"
   }
 }

test/auth.js

@@ -1,5 +1,5 @@
 const test = require('brittle')
-const ram = require('random-access-memory')
+const RAM = require('random-access-memory')
 const crypto = require('hypercore-crypto')
 const sodium = require('sodium-universal')
 const b4a = require('b4a')
@@ -29,14 +29,14 @@ test('multisig hypercore', async function (t) {
     }
   }
 
-  const a = new Hypercore(ram, null, {
+  const a = new Hypercore(RAM, null, {
     valueEncoding: 'utf-8',
     auth
   })
 
   await a.ready()
 
-  const b = new Hypercore(ram, a.key, {
+  const b = new Hypercore(RAM, a.key, {
     valueEncoding: 'utf-8',
     auth
   })
@@ -110,14 +110,14 @@ test('multisig hypercore with instance and extension', async function (t) {
   const aKey = crypto.keyPair()
   const bKey = crypto.keyPair()
 
-  const a = new Hypercore(ram, null, {
+  const a = new Hypercore(RAM, null, {
     valueEncoding: 'utf-8',
     auth: new MultiSigAuth(aKey.publicKey, bKey.publicKey, { keyPair: aKey })
   })
 
   await a.ready()
 
-  const b = new Hypercore(ram, a.key, {
+  const b = new Hypercore(RAM, a.key, {
     valueEncoding: 'utf-8',
     auth: new MultiSigAuth(bKey.publicKey, aKey.publicKey, { keyPair: bKey })
   })
@@ -193,14 +193,14 @@ test('proof-of-work hypercore', async function (t) {
     }
   }
 
-  const a = new Hypercore(ram, null, {
+  const a = new Hypercore(RAM, null, {
     valueEncoding: 'utf-8',
     auth
   })
 
   await a.ready()
 
-  const b = new Hypercore(ram, a.key, {
+  const b = new Hypercore(RAM, a.key, {
     valueEncoding: 'utf-8',
     auth
   })
@@ -224,7 +224,7 @@ test('core using custom sign fn', async function (t) {
 
   const keyPair = crypto.keyPair()
 
-  const a = new Hypercore(ram, null, {
+  const a = new Hypercore(RAM, null, {
     valueEncoding: 'utf-8',
     sign: (signable) => crypto.sign(signable, keyPair.secretKey),
     keyPair: {
@@ -234,7 +234,7 @@ test('core using custom sign fn', async function (t) {
 
   await a.ready()
 
-  const b = new Hypercore(ram, a.key, { valueEncoding: 'utf-8' })
+  const b = new Hypercore(RAM, a.key, { valueEncoding: 'utf-8' })
   await b.ready()
 
   await a.append(['a', 'b', 'c', 'd', 'e'])

test/basic.js

@@ -1,5 +1,5 @@
 const test = require('brittle')
-const ram = require('random-access-memory')
+const RAM = require('random-access-memory')
 
 const Hypercore = require('../')
 const { create, eventFlush } = require('./helpers')
@@ -71,7 +71,7 @@ test('close multiple', async function (t) {
 })
 
 test('storage options', async function (t) {
-  const core = new Hypercore({ storage: ram })
+  const core = new Hypercore({ storage: RAM })
   await core.append('hello')
   t.alike(await core.get(0), Buffer.from('hello'))
   t.end()
@@ -82,15 +82,15 @@ test(
   function (t) {
     const key = Buffer.alloc(33).fill('a')
 
-    const core = new Hypercore(ram, key, { crypto: {} })
+    const core = new Hypercore(RAM, key, { crypto: {} })
 
     t.is(core.key, key)
     t.pass('creating a core with more than 32 byteLength key did not throw')
   }
 )
 
 test('createIfMissing', async function (t) {
-  const core = new Hypercore(ram, { createIfMissing: false })
+  const core = new Hypercore(RAM, { createIfMissing: false })
 
   t.exception(core.ready())
 })
@@ -114,15 +114,15 @@ test('reopen and overwrite', async function (t) {
 
   function open (name) {
     if (st[name]) return st[name]
-    st[name] = ram()
+    st[name] = new RAM()
     return st[name]
   }
 })
 
 test('truncate event has truncated-length and fork', async function (t) {
   t.plan(2)
 
-  const core = new Hypercore(ram)
+  const core = new Hypercore(RAM)
 
   core.on('truncate', function (length, fork) {
     t.is(length, 2)
@@ -134,7 +134,7 @@ test('truncate event has truncated-length and fork', async function (t) {
 })
 
 test('treeHash gets the tree hash at a given core length', async function (t) {
-  const core = new Hypercore(ram)
+  const core = new Hypercore(RAM)
   await core.ready()
 
   const { core: { tree } } = core
@@ -152,7 +152,7 @@ test('treeHash gets the tree hash at a given core length', async function (t) {
 })
 
 test('snapshot locks the state', async function (t) {
-  const core = new Hypercore(ram)
+  const core = new Hypercore(RAM)
   await core.ready()
 
   const a = core.snapshot()
@@ -173,7 +173,7 @@ test('snapshot locks the state', async function (t) {
 test('downloading local range', async function (t) {
   t.plan(1)
 
-  const core = new Hypercore(ram)
+  const core = new Hypercore(RAM)
 
   await core.append('a')
 
@@ -189,7 +189,7 @@ test('downloading local range', async function (t) {
 test('read ahead', async function (t) {
   t.plan(1)
 
-  const core = new Hypercore(ram, { valueEncoding: 'utf-8' })
+  const core = new Hypercore(RAM, { valueEncoding: 'utf-8' })
 
   await core.append('a')
 

test/bitfield.js

@@ -1,9 +1,9 @@
 const test = require('brittle')
-const ram = require('random-access-memory')
+const RAM = require('random-access-memory')
 const Bitfield = require('../lib/bitfield')
 
 test('bitfield - set and get', async function (t) {
-  const b = await Bitfield.open(ram())
+  const b = await Bitfield.open(new RAM())
 
   t.absent(b.get(42))
   b.set(42, true)
@@ -21,7 +21,7 @@ test('bitfield - set and get', async function (t) {
 })
 
 test('bitfield - random set and gets', async function (t) {
-  const b = await Bitfield.open(ram())
+  const b = await Bitfield.open(new RAM())
   const set = new Set()
 
   for (let i = 0; i < 200; i++) {
@@ -52,7 +52,7 @@ test('bitfield - random set and gets', async function (t) {
 })
 
 test('bitfield - reload', async function (t) {
-  const s = ram()
+  const s = new RAM()
 
   {
     const b = await Bitfield.open(s)

test/helpers/index.js

@@ -1,8 +1,8 @@
 const Hypercore = require('../../')
-const ram = require('random-access-memory')
+const RAM = require('random-access-memory')
 
 exports.create = async function create (...args) {
-  const core = new Hypercore(ram, ...args)
+  const core = new Hypercore(RAM, ...args)
   await core.ready()
   return core
 }
@@ -16,7 +16,7 @@ exports.createStored = function createStored () {
 
   function storage (name) {
     if (files.has(name)) return files.get(name).clone()
-    const st = ram()
+    const st = new RAM()
     files.set(name, st)
     return st
   }

test/merkle-tree.js

@@ -1,6 +1,6 @@
 const test = require('brittle')
 const Tree = require('../lib/merkle-tree')
-const ram = require('random-access-memory')
+const RAM = require('random-access-memory')
 
 test('nodes', async function (t) {
   const tree = await create()
@@ -590,7 +590,7 @@ async function reorg (local, remote) {
 }
 
 async function create (length = 0) {
-  const tree = await Tree.open(ram())
+  const tree = await Tree.open(new RAM())
   const b = tree.batch()
   for (let i = 0; i < length; i++) {
     b.append(Buffer.from('#' + i))

test/oplog.js

@@ -1,8 +1,7 @@
 const p = require('path')
 const fs = require('fs')
 const test = require('brittle')
-const fsctl = require('fsctl')
-const raf = require('random-access-file')
+const RAF = require('random-access-file')
 const c = require('compact-encoding')
 
 const Oplog = require('../lib/oplog')
@@ -370,12 +369,12 @@ test('oplog - multi append is atomic', async function (t) {
 })
 
 function testStorage () {
-  return raf(STORAGE_FILE_NAME, { directory: __dirname, lock: fsctl.lock })
+  return new RAF(STORAGE_FILE_NAME, { directory: __dirname, lock: true })
 }
 
 function failingOffsetStorage (offset) {
   let shouldError = false
-  const storage = raf(STORAGE_FILE_NAME, { directory: __dirname, lock: fsctl.lock })
+  const storage = new RAF(STORAGE_FILE_NAME, { directory: __dirname, lock: true })
   const write = storage.write.bind(storage)
 
   storage.write = (off, data, cb) => {

test/preload.js

@@ -1,12 +1,12 @@
 const crypto = require('hypercore-crypto')
 const test = require('brittle')
-const ram = require('random-access-memory')
+const RAM = require('random-access-memory')
 const Hypercore = require('../')
 
 test('preload - storage', async function (t) {
   const core = new Hypercore(null, {
     preload: () => {
-      return { storage: ram }
+      return { storage: RAM }
     }
   })
   await core.ready()
@@ -21,7 +21,7 @@ test('preload - storage', async function (t) {
 test('preload - from another core', async function (t) {
   t.plan(2)
 
-  const first = new Hypercore(ram)
+  const first = new Hypercore(RAM)
   await first.ready()
 
   const second = new Hypercore(null, {
@@ -37,7 +37,7 @@ test('preload - from another core', async function (t) {
 
 test('preload - custom keypair', async function (t) {
   const keyPair = crypto.keyPair()
-  const core = new Hypercore(ram, keyPair.publicKey, {
+  const core = new Hypercore(RAM, keyPair.publicKey, {
     preload: () => {
       return { keyPair }
     }
@@ -56,7 +56,7 @@ test('preload - sign/storage', async function (t) {
     valueEncoding: 'utf-8',
     preload: () => {
       return {
-        storage: ram,
+        storage: RAM,
         auth: {
           sign: signable => crypto.sign(signable, keyPair.secretKey),
           verify: (signable, signature) => crypto.verify(signable, signature, keyPair.publicKey)