Skip to content

refact: Support b4a buffers #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

refact: Support b4a buffers #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9267975
refact: Support b4a buffers
lejeunerenard Sep 16, 2023
285f9c5
refact: Convert `.concat()` & `.from()` to `b4a` version
lejeunerenard Sep 16, 2023
783d055
refact: Upgrade `random-access-storage` to `^3.0.0` & convert to class
lejeunerenard Sep 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions example/hello.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,18 @@
var RAI = require('../')
var b4a = require('b4a')
const storage = RAI('dbname')
var cool = storage('cool.txt')

cool.write(100, Buffer.from('GREETINGS'), function (err) {
cool.write(100, b4a.from('GREETINGS'), function (err) {
if (err) return console.error(err)
cool.read(104, 3, function (err, buf) {
if (err) return console.error(err)
console.log(buf.toString()) // TIN
console.log(b4a.toString(buf)) // TIN
})

cool.read(100, 9, function (err, buf) {
if (err) return console.error(err)
console.log(buf.toString()) // GREETINGS
console.log(b4a.toString(buf)) // GREETINGS
})

})
228 changes: 115 additions & 113 deletions index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@ var inherits = require('inherits')
var nextTick = require('next-tick')
var once = require('once')
var blocks = require('./lib/blocks.js')
var bufferFrom = require('buffer-from')
var bufferAlloc = require('buffer-alloc')
var b4a = require('b4a')

var DELIM = '\0'

module.exports = function (dbname, xopts) {
if (!xopts) xopts = {}

var win = typeof window !== 'undefined' ? window
: (typeof self !== 'undefined' ? self : {})

Expand Down Expand Up @@ -51,131 +51,133 @@ module.exports = function (dbname, xopts) {
}
}

function Store (opts) {
if (!(this instanceof Store)) return new Store(opts)
RandomAccess.call(this)
if (!opts) opts = {}
if (typeof opts === 'string') opts = { name: opts }
this.size = opts.size || 4096
this.name = opts.name
this.length = opts.length || 0
this._getdb = opts.db
}
inherits(Store, RandomAccess)
class Store extends RandomAccess {
constructor (opts) {
super(opts)
if (!(this instanceof Store)) return new Store(opts)

Store.prototype._blocks = function (i, j) {
return blocks(this.size, i, j)
}
if (!opts) opts = {}
if (typeof opts === 'string') opts = { name: opts }
this.size = opts.size || 4096
this.name = opts.name
this.length = opts.length || 0
this._getdb = opts.db
}

Store.prototype._read = function (req) {
var self = this
var buffers = []
self._store('readonly', function (err, store) {
if ((self.length || 0) < req.offset + req.size) {
return req.callback(new Error('Could not satisfy length'), null)
}
if (err) return req.callback(err)
var offsets = self._blocks(req.offset, req.offset + req.size)
var pending = offsets.length + 1
var firstBlock = offsets.length > 0 ? offsets[0].block : 0
for (var i = 0; i < offsets.length; i++) (function (o) {
var key = self.name + DELIM + o.block
backify(store.get(key), function (err, ev) {
if (err) return req.callback(err)
buffers[o.block - firstBlock] = ev.target.result
? bufferFrom(ev.target.result.subarray(o.start, o.end))
: bufferAlloc(o.end - o.start)
if (--pending === 0) req.callback(null, Buffer.concat(buffers))
})
})(offsets[i])
if (--pending === 0) req.callback(null, Buffer.concat(buffers))
})
}
_blocks (i, j) {
return blocks(this.size, i, j)
}

Store.prototype._write = function (req) {
var self = this
self._store('readwrite', function (err, store) {
if (err) return req.callback(err)
var offsets = self._blocks(req.offset, req.offset + req.data.length)
var pending = 1
var buffers = {}
for (var i = 0; i < offsets.length; i++) (function (o, i) {
if (o.end - o.start === self.size) return
pending++
var key = self.name + DELIM + o.block
backify(store.get(key), function (err, ev) {
if (err) return req.callback(err)
buffers[i] = bufferFrom(ev.target.result || bufferAlloc(self.size))
if (--pending === 0) write(store, offsets, buffers)
})
})(offsets[i], i)
if (--pending === 0) write(store, offsets, buffers)
})

function write (store, offsets, buffers) {
var block
for (var i = 0, j = 0; i < offsets.length; i++) {
var o = offsets[i]
var len = o.end - o.start
if (len === self.size) {
block = bufferFrom(req.data.slice(j, j + len))
} else {
block = buffers[i]
req.data.copy(block, o.start, j, j + len)
_read (req) {
var self = this
var buffers = []
self._store('readonly', function (err, store) {
if ((self.length || 0) < req.offset + req.size) {
return req.callback(new Error('Could not satisfy length'), null)
}
store.put(block, self.name + DELIM + o.block)
j += len
}

var length = Math.max(self.length || 0, req.offset + req.data.length)
store.put(length, self.name + DELIM + 'length')
store.transaction.addEventListener('complete', function () {
self.length = length
req.callback(null)
if (err) return req.callback(err)
var offsets = self._blocks(req.offset, req.offset + req.size)
var pending = offsets.length + 1
var firstBlock = offsets.length > 0 ? offsets[0].block : 0
for (var i = 0; i < offsets.length; i++) (function (o) {
var key = self.name + DELIM + o.block
backify(store.get(key), function (err, ev) {
if (err) return req.callback(err)
buffers[o.block - firstBlock] = ev.target.result
? b4a.from(ev.target.result.subarray(o.start, o.end))
: bufferAlloc(o.end - o.start)
if (--pending === 0) req.callback(null, b4a.concat(buffers))
})
})(offsets[i])
if (--pending === 0) req.callback(null, b4a.concat(buffers))
})
store.transaction.addEventListener('error', function (err) {
req.callback(err)
}

_write (req) {
var self = this
self._store('readwrite', function (err, store) {
if (err) return req.callback(err)
var offsets = self._blocks(req.offset, req.offset + req.data.length)
var pending = 1
var buffers = {}
for (var i = 0; i < offsets.length; i++) (function (o, i) {
if (o.end - o.start === self.size) return
pending++
var key = self.name + DELIM + o.block
backify(store.get(key), function (err, ev) {
if (err) return req.callback(err)
buffers[i] = b4a.from(ev.target.result || bufferAlloc(self.size))
if (--pending === 0) write(store, offsets, buffers)
})
})(offsets[i], i)
if (--pending === 0) write(store, offsets, buffers)
})

function write (store, offsets, buffers) {
var block
for (var i = 0, j = 0; i < offsets.length; i++) {
var o = offsets[i]
var len = o.end - o.start
if (len === self.size) {
block = b4a.from(req.data.slice(j, j + len))
} else {
block = buffers[i]
b4a.copy(req.data, block, o.start, j, j + len)
}
store.put(block, self.name + DELIM + o.block)
j += len
}

var length = Math.max(self.length || 0, req.offset + req.data.length)
store.put(length, self.name + DELIM + 'length')
store.transaction.addEventListener('complete', function () {
self.length = length
req.callback(null)
})
store.transaction.addEventListener('error', function (err) {
req.callback(err)
})
}
}
}

Store.prototype._store = function (mode, cb) {
cb = once(cb)
var self = this
self._getdb(function (db) {
var tx = db.transaction(['data'], mode)
var store = tx.objectStore('data')
tx.addEventListener('error', cb)
cb(null, store)
})
}
_store (mode, cb) {
cb = once(cb)
var self = this
self._getdb(function (db) {
var tx = db.transaction(['data'], mode)
var store = tx.objectStore('data')
tx.addEventListener('error', cb)
cb(null, store)
})
}

Store.prototype._open = function (req) {
var self = this
this._getdb(function (db) {
self._store('readonly', function (err, store) {
if (err) return req.callback(err)
backify(store.get(self.name + DELIM + 'length'), function (err, ev) {
_open (req) {
var self = this
this._getdb(function (db) {
self._store('readonly', function (err, store) {
if (err) return req.callback(err)
self.length = ev.target.result || 0
req.callback(null)
backify(store.get(self.name + DELIM + 'length'), function (err, ev) {
if (err) return req.callback(err)
self.length = ev.target.result || 0
req.callback(null)
})
})
})
})
}
}

Store.prototype._close = function (req) {
this._getdb(function (db) {
//db.close() // TODO: reopen gracefully. Close breaks with corestore, as innercorestore closes the db
req.callback()
})
}
_close (req) {
this._getdb(function (db) {
//db.close() // TODO: reopen gracefully. Close breaks with corestore, as innercorestore closes the db
req.callback()
})
}

Store.prototype._stat = function (req) {
var self = this
nextTick(function () {
req.callback(null, { size: self.length })
})
_stat (req) {
var self = this
nextTick(function () {
req.callback(null, { size: self.length })
})
}
}

function backify (r, cb) {
Expand Down
8 changes: 4 additions & 4 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,18 @@
"version": "1.3.1",
"main": "index.js",
"dependencies": {
"random-access-storage": "^1.4.1",
"b4a": "^1.6.4",
"buffer-alloc": "^1.2.0",
"buffer-from": "^0.1.1",
"inherits": "^2.0.4",
"mutexify": "^1.3.1",
"next-tick": "^1.0.0",
"once": "^1.4.0"
"once": "^1.4.0",
"random-access-storage": "^3.0.0"
},
"devDependencies": {
"browser-run": "^8.0.0",
"browserify": "^16.5.2",
"random-access-memory": "^3.1.1",
"random-access-memory": "^6.2.0",
"randombytes": "^2.1.0",
"tape": "^5.0.1"
},
Expand Down
9 changes: 5 additions & 4 deletions test/big.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,21 @@
var test = require('tape')
var random = require('../')('testing-' + Math.random(), { size: 1024 })
var b4a = require('b4a')

test('big', function (t) {
t.plan(6)
var cool = random('cool.txt')
cool.write(32, Buffer.from('GREETINGS'), function (err) {
cool.write(32, b4a.from('GREETINGS'), function (err) {
t.ifError(err)
cool.write(32 + 3, Buffer.from('AT SCOTT'), function (err) {
cool.write(32 + 3, b4a.from('AT SCOTT'), function (err) {
t.ifError(err)
cool.read(32, 9, function (err, buf) {
t.ifError(err)
t.equal(buf.toString(), 'GREAT SCO')
t.equal(b4a.toString(buf), 'GREAT SCO')
})
cool.read(32 + 6, 5, function (err, buf) {
t.ifError(err)
t.equal(buf.toString(), 'SCOTT')
t.equal(b4a.toString(buf), 'SCOTT')
})
})
})
Expand Down
18 changes: 9 additions & 9 deletions test/multifile.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,35 +1,35 @@
var test = require('tape')
var random = require('../')('testing-' + Math.random(), { size: 5 })
var bfrom = require('buffer-from')
var b4a = require('b4a')

test('multiple files cool and good', function (t) {
t.plan(14)
var cool = random('cool.txt')
var and = random('and.txt')
var good = random('good.txt')
cool.write(100, bfrom('GREETINGS'), function (err) {
cool.write(100, b4a.from('GREETINGS'), function (err) {
t.ifError(err)
cool.read(100, 9, function (err, buf) {
t.ifError(err)
t.equal(buf.toString(), 'GREETINGS')
t.equal(b4a.toString(buf), 'GREETINGS')
})
cool.read(104, 3, function (err, buf) {
t.ifError(err)
t.equal(buf.toString(), 'TIN')
t.equal(b4a.toString(buf), 'TIN')
})
and.write(106, bfrom('ORANG'), function (err) {
and.write(106, b4a.from('ORANG'), function (err) {
t.ifError(err)
and.read(107, 3, function (err, buf) {
t.ifError(err)
t.equal(buf.toString(), 'RAN')
good.write(90, bfrom('DO YOU EVER JUST... TEAPOT'), function (err) {
t.equal(b4a.toString(buf), 'RAN')
good.write(90, b4a.from('DO YOU EVER JUST... TEAPOT'), function (err) {
t.ifError(err)
good.read(110, 6, function (err, buf) {
t.ifError(err)
t.equal(buf.toString(), 'TEAPOT')
t.equal(b4a.toString(buf), 'TEAPOT')
good.read(86, 10, function (err, buf) {
t.ifError(err)
t.equal(buf.toString(), '\0\0\0\0DO YOU')
t.equal(b4a.toString(buf), '\0\0\0\0DO YOU')
good.read(110, 10, function (err, buf) {
t.ok(err, 'should error when reading past end of file')
})
Expand Down
Loading