diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index b412471..6c241b6 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -27,7 +27,7 @@ jobs: strategy: matrix: os: [windows-latest, ubuntu-latest, macos-latest] - node: [14, 15] + node: [14, 16] fail-fast: true steps: - uses: actions/checkout@v2 @@ -50,18 +50,20 @@ jobs: steps: - uses: actions/checkout@v2 - run: npm install - - run: npx aegir test -t browser -t webworker --bail -- --browser firefox + - run: npx aegir test -t browser -t webworker --bail -- --browsers FirefoxHeadless test-electron-main: needs: check runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - run: npm install - - run: npx xvfb-maybe aegir test -t electron-main --bail + - run: npm run pretest + - run: npx xvfb-maybe aegir test -t electron-main --bail -f dist/cjs/node-test/*js test-electron-renderer: needs: check runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - run: npm install - - run: npx xvfb-maybe aegir test -t electron-renderer --bail \ No newline at end of file + - run: npm run pretest + - run: npx xvfb-maybe aegir test -t electron-renderer --bail -f dist/cjs/browser-test/*js diff --git a/.gitignore b/.gitignore index f8ca32b..d1e881e 100644 --- a/.gitignore +++ b/.gitignore @@ -37,3 +37,4 @@ node_modules dist docs +types diff --git a/CHANGELOG.md b/CHANGELOG.md index 2b8f061..d65bb68 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,48 @@ +## [2.0.3](https://github.com/ipfs/js-blockstore-datastore-adapter/compare/v2.0.2...v2.0.3) (2021-09-29) + + +### Bug Fixes + +* access process from globalThis ([#14](https://github.com/ipfs/js-blockstore-datastore-adapter/issues/14)) ([7874fd7](https://github.com/ipfs/js-blockstore-datastore-adapter/commit/7874fd70540e1be985c4703ffbd635fe3764ba94)) + + + +## [2.0.2](https://github.com/ipfs/js-blockstore-datastore-adapter/compare/v2.0.1...v2.0.2) (2021-09-17) + + +### Bug Fixes + +* remove instanceof ([#11](https://github.com/ipfs/js-blockstore-datastore-adapter/issues/11)) ([6b816cc](https://github.com/ipfs/js-blockstore-datastore-adapter/commit/6b816cc1ec2963858bad524fb1df28c14e8bab76)) + + + +## [2.0.1](https://github.com/ipfs/js-blockstore-datastore-adapter/compare/v2.0.0...v2.0.1) (2021-09-09) + + + +# [2.0.0](https://github.com/ipfs/js-blockstore-datastore-adapter/compare/v1.0.1...v2.0.0) (2021-09-09) + + +### chore + +* switch to esm ([#10](https://github.com/ipfs/js-blockstore-datastore-adapter/issues/10)) ([e8a2521](https://github.com/ipfs/js-blockstore-datastore-adapter/commit/e8a2521c090790c6cd6877950a3d90c3a938d83d)) + + +### BREAKING CHANGES + +* deep imports/requires are no longer possible + + + +## [1.0.1](https://github.com/ipfs/js-blockstore-datastore-adapter/compare/v1.0.0...v1.0.1) (2021-09-02) + + +### Bug Fixes + +* convert cid before instanceof check ([#9](https://github.com/ipfs/js-blockstore-datastore-adapter/issues/9)) ([b442488](https://github.com/ipfs/js-blockstore-datastore-adapter/commit/b4424884e89dc30b27a8466ba6cefac5e0612daa)) + + + # [1.0.0](https://github.com/ipfs/js-blockstore-datastore-adapter/compare/v0.0.4...v1.0.0) (2021-07-06) diff --git a/README.md b/README.md index 9862d97..9209d8a 100644 --- a/README.md +++ b/README.md @@ -18,10 +18,10 @@ $ npm install blockstore-datastore-adapter ## Usage ```js -const { MemoryStore } = require('interface-datastore') -const BlockstoreDatastoreAdapter = require('blockstore-datastore-adapter') +import { MemoryDatastore } from 'datastore-core/memory' +import { BlockstoreDatastoreAdapter } from 'blockstore-datastore-adapter' -const store = new BlockstoreDatastoreAdapter(new MemoryStore()) +const store = new BlockstoreDatastoreAdapter(new MemoryDatastore()) ``` ## Contribute diff --git a/package.json b/package.json index 212013e..bcda270 100644 --- a/package.json +++ b/package.json @@ -1,22 +1,37 @@ { "name": "blockstore-datastore-adapter", - "version": "1.0.0", + "version": "2.0.3", "description": "datastore interface", "leadMaintainer": "Alex Potsides ", "main": "src/index.js", - "types": "dist/src/index.d.ts", + "type": "module", + "types": "types/src/index.d.ts", "files": [ - "src", - "dist" + "*", + "!**/*.tsbuildinfo" ], + "exports": { + ".": { + "import": "./src/index.js" + } + }, + "eslintConfig": { + "extends": "ipfs", + "parserOptions": { + "sourceType": "module" + } + }, "scripts": { - "prepare": "aegir build --no-bundle", + "clean": "rimraf dist types", + "prepare": "aegir build --no-bundle && cp -R types dist", "lint": "aegir ts -p check && aegir lint", + "build": "aegir build", + "release": "aegir release --target node", + "release-minor": "aegir release --type minor --target node", + "release-major": "aegir release --type major --target node", + "pretest": "aegir build --esm-tests", "test": "aegir test", - "release": "aegir release", - "release-minor": "aegir release --type minor", - "release-major": "aegir release --type major", - "coverage": "aegir test --cov" + "dep-check": "aegir dep-check -i rimraf" }, "repository": { "type": "git", @@ -34,20 +49,20 @@ }, "homepage": "https://github.com/ipfs/js-blockstore-datastore-adapter#readme", "devDependencies": { - "aegir": "^33.1.0", - "interface-blockstore-tests": "^1.0.0" + "aegir": "^35.0.2", + "datastore-core": "^6.0.6", + "interface-blockstore-tests": "^2.0.1", + "util": "^0.12.4" }, "dependencies": { + "blockstore-core": "^1.0.0", "err-code": "^3.0.1", - "interface-blockstore": "^1.0.0", - "interface-datastore": "^5.0.0", + "interface-blockstore": "^2.0.2", + "interface-datastore": "^6.0.2", "it-drain": "^1.0.1", "it-pushable": "^1.4.2", "multiformats": "^9.1.0" }, - "eslintConfig": { - "extends": "ipfs" - }, "contributors": [ "achingbrain " ] diff --git a/src/index.js b/src/index.js index 42aca31..1e01908 100644 --- a/src/index.js +++ b/src/index.js @@ -1,15 +1,13 @@ -'use strict' - -const drain = require('it-drain') -const pushable = require('it-pushable') -const { Key } = require('interface-datastore') -const { CID } = require('multiformats/cid') -const raw = require('multiformats/codecs/raw') -const Digest = require('multiformats/hashes/digest') -const { base32, base32pad } = require('multiformats/bases/base32') -const { base58btc } = require('multiformats/bases/base58') -const errcode = require('err-code') -const { BlockstoreAdapter } = require('interface-blockstore') +import drain from 'it-drain' +import pushable from 'it-pushable' +import { Key } from 'interface-datastore/key' +import { CID } from 'multiformats/cid' +import * as raw from 'multiformats/codecs/raw' +import * as Digest from 'multiformats/hashes/digest' +import { base32, base32pad } from 'multiformats/bases/base32' +import { base58btc } from 'multiformats/bases/base58' +import errcode from 'err-code' +import { BaseBlockstore } from 'blockstore-core/base' /** * Transform a cid to the appropriate datastore key. @@ -18,11 +16,13 @@ const { BlockstoreAdapter } = require('interface-blockstore') * @returns {Key} */ function cidToKey (cid) { - if (!(cid instanceof CID)) { + const c = CID.asCID(cid) + + if (!c) { throw errcode(new Error('Not a valid cid'), 'ERR_INVALID_CID') } - return new Key('/' + base32.encode(cid.multihash.bytes).slice(1).toUpperCase(), false) + return new Key('/' + base32.encode(c.multihash.bytes).slice(1).toUpperCase(), false) } /** @@ -50,32 +50,53 @@ function keyToCid (key) { * @returns {string} */ function convertPrefix (prefix) { - let bytes const firstChar = prefix.substring(0, 1) if (firstChar === '/') { return convertPrefix(prefix.substring(1)) } + /** @type {(input: string) => Uint8Array } */ + let decoder + if (firstChar.toLowerCase() === 'b') { // v1 cid prefix, remove version and codec bytes - bytes = base32.decode(prefix.toLowerCase()).subarray(2) + decoder = (input) => base32.decode(input.toLowerCase()).subarray(2) } else if (firstChar.toLowerCase() === 'c') { // v1 cid prefix, remove version and codec bytes - bytes = base32pad.decode(prefix.toLowerCase()).subarray(2) + decoder = (input) => base32pad.decode(input.toLowerCase()).subarray(2) } else if (firstChar === 'z') { // v1 cid - bytes = base58btc.decode(prefix).subarray(2) + decoder = (input) => base58btc.decode(input).subarray(2) } else if (firstChar === 'Q') { // v0 cid prefix - bytes = base58btc.decode('z' + prefix) + decoder = (input) => base58btc.decode('z' + input) } else { - bytes = base32.decode('b' + prefix.toLowerCase()).subarray(2) + decoder = (input) => base32.decode('b' + input.toLowerCase()).subarray(2) + } + + let bytes + + // find the longest prefix that we can safely decode + for (let i = 1; i < prefix.length; i++) { + try { + bytes = decoder(prefix.substring(0, i)) + } catch (/** @type {any} */ err) { + if (err.message !== 'Unexpected end of data') { + throw err + } + } } - const str = base32.encode(bytes).substring(1).toUpperCase() + let str = '/C' - return str || 'C' + if (bytes) { + // slice one character from the end of the string to ensure we don't end up + // with a padded value which could have a non-matching string at the end + str = `/${base32.encode(bytes).slice(1, -1).toUpperCase() || 'C'}` + } + + return str } /** @@ -85,7 +106,7 @@ function convertPrefix (prefix) { function convertQuery (query) { return { ...query, - prefix: query.prefix ? `/${convertPrefix(query.prefix)}` : undefined, + prefix: query.prefix ? convertPrefix(query.prefix) : undefined, filters: query.filters ? query.filters.map( filter => (pair) => { @@ -110,7 +131,7 @@ function convertQuery (query) { function convertKeyQuery (query) { return { ...query, - prefix: query.prefix ? `/${convertPrefix(query.prefix)}` : undefined, + prefix: query.prefix ? convertPrefix(query.prefix) : undefined, filters: query.filters ? query.filters.map( filter => (key) => { @@ -140,7 +161,7 @@ function convertKeyQuery (query) { /** * @implements {Blockstore} */ -class BlockstoreDatastoreAdapter extends BlockstoreAdapter { +export class BlockstoreDatastoreAdapter extends BaseBlockstore { /** * @param {Datastore} datastore */ @@ -223,7 +244,7 @@ class BlockstoreDatastoreAdapter extends BlockstoreAdapter { // process.nextTick runs on the microtask queue, setImmediate runs on the next // event loop iteration so is slower. Use process.nextTick if it is available. - const runner = process && process.nextTick ? process.nextTick : setImmediate + const runner = globalThis.process && globalThis.process.nextTick ? globalThis.process.nextTick : (globalThis.setImmediate || globalThis.setTimeout) runner(async () => { try { @@ -291,5 +312,3 @@ class BlockstoreDatastoreAdapter extends BlockstoreAdapter { return out } } - -module.exports = BlockstoreDatastoreAdapter diff --git a/test/index.spec.js b/test/index.spec.js index 557bb4d..4704365 100644 --- a/test/index.spec.js +++ b/test/index.spec.js @@ -1,12 +1,12 @@ /* eslint-env mocha */ -'use strict' -const { MemoryDatastore } = require('interface-datastore') -const BlockstoreDatastoreAdapter = require('../src') +import { MemoryDatastore } from 'datastore-core/memory' +import { BlockstoreDatastoreAdapter } from '../src/index.js' +import { interfaceBlockstoreTests } from 'interface-blockstore-tests' describe('Memory', () => { describe('interface-blockstore', () => { - require('interface-blockstore-tests')({ + interfaceBlockstoreTests({ setup () { return new BlockstoreDatastoreAdapter( new MemoryDatastore() diff --git a/tsconfig.json b/tsconfig.json index fe3cbd6..f6b712b 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -1,10 +1,10 @@ { - "extends": "aegir/src/config/tsconfig.aegir.json", - "compilerOptions": { - "outDir": "dist" - }, - "include": [ - "test", - "src" - ] + "extends": "aegir/src/config/tsconfig.aegir.json", + "compilerOptions": { + "outDir": "types" + }, + "include": [ + "test", + "src" + ] }