Merge pull request #12 from orbitdb/fix/persistent-store

Fix/persistent store

.circleci/config.yml

@@ -0,0 +1,59 @@
+# Use the latest 2.1 version of CircleCI pipeline processing engine, see https://circleci.com/docs/2.0/configuration-reference/
+version: 2.1
+
+executors:
+  node10-browsers:
+    docker:
+      - image: circleci/node:10-browsers
+
+jobs:
+  setup:
+    executor: node10-browsers
+    steps:
+      - checkout
+      - run: mkdir -p /tmp/workspace
+      - run: make clean-dependencies
+      - run: make deps
+      - run: npm run lint
+      - run: cp -R conf src node_modules test package.json /tmp/workspace
+      - persist_to_workspace:
+          root: /tmp/workspace
+          paths:
+            - src
+            - node_modules
+            - test
+            - conf
+            - package.json
+  test-node:
+    executor: node10-browsers
+    steps:
+      - attach_workspace:
+          at: ./
+      - run: npm run test:node
+  test-browser:
+    executor: node10-browsers
+    steps:
+      - attach_workspace:
+          at: ./
+      - run: npm run test:browser
+  build:
+    executor: node10-browsers
+    steps:
+      - attach_workspace:
+          at: ./
+      - run: npm run build
+
+workflows:
+  version: 2
+  Implementations:
+    jobs:
+      - setup
+      - test-node:
+          requires:
+            - setup
+      - test-browser:
+          requires:
+            - setup
+      - build:
+          requires:
+            - setup

.gitignore

@@ -1 +1,4 @@
-node_modules/
+dump.rdb
+orbitdb.json
+node_modules
+redis-stable*

Makefile

@@ -0,0 +1,27 @@
+all: build
+
+deps:
+	npm install
+
+test: deps
+	npm run test
+	rm -f dump.rdb
+	rm -f orbitdb.json
+
+build: test
+	npm run build
+	@echo "Build success!"
+	@echo "Output: 'dist/'"
+
+clean:
+	rm -rf orbitdb/
+	rm -rf customDir/
+	rm -rf node_modules/
+	rm -rf redis-stable/
+
+clean-dependencies: clean
+	rm -f package-lock.json;
+
+rebuild: | clean-dependencies build
+
+.PHONY: test build

README.md

@@ -20,18 +20,6 @@ npm install --save orbit-db-cache
 
 #### Public methods
 
-##### `open`
-
-Open cache store and make it available to be used (indexedDB or leveldb)
-
-##### `close`
-
-Close cache store and the underlying indexedDB / leveldb instance
-
-##### `destroy`
-
-Completely remove an existing store and deletes the locally persisted cache
-
 ##### `get`
 
 Get an item from the cache store

conf/webpack.config.js

@@ -0,0 +1,47 @@
+'use strict'
+
+const path = require('path')
+const webpack = require('webpack')
+
+module.exports = {
+  entry: './src/Cache.js',
+  output: {
+    libraryTarget: 'var',
+    library: 'Cache',
+    filename: '../dist/orbit-db-cache.min.js'
+  },
+  target: 'web',
+  devtool: 'none',
+  externals: {
+    fs: '{}',
+    mkdirp: '{}'
+  },
+  node: {
+    console: false,
+    Buffer: true,
+    mkdirp: 'empty'
+  },
+  plugins: [
+    new webpack.DefinePlugin({
+      'process.env': {
+        'NODE_ENV': JSON.stringify(process.env.NODE_ENV)
+      }
+    })
+  ],
+  resolve: {
+    modules: [
+      'node_modules',
+      path.resolve(__dirname, '../node_modules')
+    ],
+    alias: {
+      leveldown: 'level-js'
+    }
+  },
+  resolveLoader: {
+    modules: [
+      'node_modules',
+      path.resolve(__dirname, '../node_modules')
+    ],
+    moduleExtensions: ['-loader']
+  }
+}

conf/webpack.tests.config.js

@@ -0,0 +1,65 @@
+'use strict'
+
+const glob = require('glob')
+const webpack = require('webpack')
+const path = require('path')
+
+module.exports = {
+  // TODO: put all tests in a .js file that webpack can use as entry point
+  entry: glob.sync('./test/*.spec.js'),
+  output: {
+    filename: '../test/browser/bundle.js'
+  },
+  target: 'web',
+  mode: 'production',
+  devtool: 'source-map',
+  plugins: [
+    new webpack.DefinePlugin({
+      'process.env': {
+        'NODE_ENV': JSON.stringify(process.env.NODE_ENV)
+      }
+    }),
+    new webpack.IgnorePlugin(/mongo|redis/)
+  ],
+  externals: {
+    fs: '{}',
+    fatfs: '{}',
+    runtimejs: '{}',
+    net: '{}',
+    tls: '{}',
+    'child_process': {},
+    dns: '{}'
+    // path: '{}',
+    // "node-gyp-build": '{}'
+  },
+  resolve: {
+    modules: [
+      'node_modules',
+      path.resolve(__dirname, '../node_modules')
+    ]
+  },
+  resolveLoader: {
+    modules: [
+      'node_modules',
+      path.resolve(__dirname, '../node_modules')
+    ],
+    moduleExtensions: ['-loader']
+  },
+  module: {
+    rules: [
+      {
+        test: /\.js$/,
+        exclude: /node_modules/,
+        use: {
+          loader: 'babel-loader',
+          options: {
+            presets: [
+              ['@babel/preset-env', { modules: false }]
+            ],
+            plugins: ['@babel/syntax-object-rest-spread', '@babel/transform-runtime', '@babel/plugin-transform-modules-commonjs']
+          }
+        }
+      }
+    ]
+  }
+}