Version 0.2.0

package.json

@@ -1,17 +1,17 @@
 {
   "name": "@ezerous/breeze",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "A reactive data-store for OrbitDB.",
   "license": "MIT",
   "author": "Ezerous <ezerous@gmail.com>",
   "main": "src/index.js",
   "repository": "github:Ezerous/breeze",
   "dependencies": {
-    "deepmerge": "4.2.2",
+    "deepmerge": "~4.2.2",
-    "ipfs": "0.50.1",
+    "ipfs": "~0.50.2",
-    "is-plain-object": "4.1.1",
+    "is-plain-object": "~5.0.0",
-    "orbit-db": "0.25.1",
+    "orbit-db": "~0.26.0",
-    "orbit-db-identity-provider": "0.3.1",
+    "orbit-db-identity-provider": "~0.3.1",
-    "redux-saga": "1.1.3"
+    "redux-saga": "~1.1.3"
   }
 }

src/Breeze.js

@@ -25,7 +25,6 @@ class Breeze {
         this.web3 = options.web3;
         this.ipfs = {}  // To be initialized in ipfsSaga
         this.orbit = {}  // To be initialized in orbitSaga
-        this.orbitDatabases = {};
         this.ipfsOptions = options.ipfs;
         this.orbitOptions = options.orbit;
 

src/breezeStatus/breezeStatusReducer.js

@@ -1,20 +1,33 @@
-import * as BreezeActions from './breezeActions'
+import { STATUS_INITIALIZING, STATUS_INITIALIZED, STATUS_FAILED } from "../constants";
+import { BREEZE_INITIALIZING,BREEZE_INITIALIZED,  BREEZE_FAILED } from "./breezeActions";
 
 const initialState = {
-    initialized: false
+    status: STATUS_INITIALIZING
 }
 
 const breezeStatusReducer = (state = initialState, action) => {
     /*
      * Breeze Status
      */
-    if (action.type === BreezeActions.BREEZE_INITIALIZED) {
+    switch (action.type) {
+        case BREEZE_INITIALIZING:
             return {
                 ...state,
-            initialized: true
+                status: STATUS_INITIALIZING
-        }
+            };
+        case BREEZE_INITIALIZED:
+            return {
+                ...state,
+                status: STATUS_INITIALIZED
+            };
+        case BREEZE_FAILED:
+            return {
+                ...state,
+                status: STATUS_FAILED
+            };
+        default:
+            return state;
     }
-    return state
 }
 
 export default breezeStatusReducer

src/breezeStatus/breezeStatusSaga.js

@@ -6,7 +6,7 @@ import { addOrbitIdentityProvider } from '../orbit/orbitSaga';
 
 const LOGGING_PREFIX = 'breezeStatusSaga: ';
 
-export function * initializeBreeze (action) {
+function * initializeBreeze (action) {
     try {
         const { breeze } = action;
 
@@ -31,7 +31,7 @@ export function * initializeBreeze (action) {
 }
 
 function * breezeStatusSaga () {
-    yield takeLatest(BreezeActions.BREEZE_INITIALIZING, initializeBreeze)
+    yield takeLatest(BreezeActions.BREEZE_INITIALIZING, initializeBreeze);
 }
 
 export default breezeStatusSaga

src/constants.js

@@ -0,0 +1,4 @@
+// Status
+export const STATUS_INITIALIZING = 'initializing';
+export const STATUS_INITIALIZED = 'initialized';
+export const STATUS_FAILED = 'failed';

src/index.js

@@ -1,7 +1,7 @@
 import Breeze from './Breeze.js'
 import breezeStatusReducer from './breezeStatus/breezeStatusReducer';
-import ipfsReducer from "./ipfs/ipfsReducer";
+import ipfsReducer from './ipfs/ipfsReducer';
-import orbitReducer from "./orbit/orbitReducer";
+import orbitReducer from './orbit/orbitReducer';
 
 import breezeStatusSaga from './breezeStatus/breezeStatusSaga';
 import orbitSaga from "./orbit/orbitSaga";
@@ -9,9 +9,8 @@ import orbitSaga from "./orbit/orbitSaga";
 import * as BreezeActions from './breezeStatus/breezeActions'
 import * as OrbitActions from './orbit/orbitActions'
 
-import * as orbitTypes from './orbit/constants'
+import * as breezeConstants from './constants'
-import orbitMiddleware from "./orbit/orbitMiddleware";
+import * as orbitConstants from './orbit/orbitConstants'
-import orbitStatusSaga from "./orbit/orbitStatusSaga";
 
 const breezeReducers = {
     breezeStatus: breezeStatusReducer,
@@ -19,14 +18,9 @@ const breezeReducers = {
     orbit: orbitReducer
 }
 
-const breezeMiddlewares = [
-    orbitMiddleware
-]
-
 const breezeSagas = [
     breezeStatusSaga,
-    orbitSaga,
+    orbitSaga
-    orbitStatusSaga
 ]
 
 const breezeActions = {
@@ -36,10 +30,10 @@ const breezeActions = {
 
 export {
     Breeze,
+    breezeConstants,
     breezeActions,
     breezeReducers,
-    breezeMiddlewares,
     breezeSagas,
-    orbitTypes
+    orbitConstants
 }
 

src/ipfs/ipfsReducer.js

@@ -1,15 +1,29 @@
-import { IPFS_INITIALIZED } from "./ipfsActions";
+import { IPFS_INITIALIZING , IPFS_INITIALIZED, IPFS_FAILED } from "./ipfsActions";
+import { STATUS_INITIALIZING, STATUS_INITIALIZED, STATUS_FAILED } from "../constants";
 
 const initialState = {
-    initialized: false,
+    status: STATUS_INITIALIZING
 };
 
 const ipfsReducer = (state = initialState, action) => {
+    /*
+     * IPFS Status
+     */
     switch (action.type) {
+        case IPFS_INITIALIZING:
+            return {
+                ...state,
+                status: STATUS_INITIALIZING
+            };
         case IPFS_INITIALIZED:
             return {
                 ...state,
-                initialized: true,
+                status: STATUS_INITIALIZED
+            };
+        case IPFS_FAILED:
+            return {
+                ...state,
+                status: STATUS_FAILED
             };
         default:
             return state;

src/misc/mergeUtils.js

@@ -1,5 +1,5 @@
 const merge = require('deepmerge');
-import isPlainObject from 'is-plain-object';
+import { isPlainObject } from 'is-plain-object';
 
 export default function (defaultOptions, customOptions) {
     return merge(defaultOptions, customOptions, {

src/orbit/orbitActions.js

@@ -1,9 +1,14 @@
+// OrbitDB Status
 export const ORBIT_INITIALIZING = 'ORBIT_INITIALIZING';
 export const ORBIT_INITIALIZED = 'ORBIT_INITIALIZED';
 export const ORBIT_INIT_FAILED = 'ORBIT_INIT_FAILED';
+
+// Identity Provider Status
 export const ORBIT_IDENTITY_PROVIDER_ADD = 'ORBIT_IDENTITY_PROVIDER_ADD';
 export const ORBIT_IDENTITY_PROVIDER_ADDED = 'ORBIT_IDENTITY_PROVIDER_ADDED';
 export const ORBIT_IDENTITY_PROVIDER_FAILED = 'ORBIT_IDENTITY_PROVIDER_FAILED';
+
+// Database Status
 export const ORBIT_DATABASE_CREATING = 'ORBIT_DATABASE_CREATING';
 export const ORBIT_DATABASE_CREATED = 'ORBIT_DATABASE_CREATED';
 export const ORBIT_DATABASE_FAILED = 'ORBIT_DATABASE_FAILED';

src/orbit/constants.js → src/orbit/orbitConstants.js

@@ -5,7 +5,7 @@ export const ORBIT_TYPE_KEYVALUE = 'keyvalue';
 export const ORBIT_TYPE_DOCS = 'docs';
 export const ORBIT_TYPE_COUNTER = 'counter';
 
-// OrbitDB statuses
+// OrbitDB Databases status
 export const DB_STATUS_INIT = 'init';
 export const DB_STATUS_READY = 'ready';
 export const DB_STATUS_REPLICATING = 'replicating';

src/orbit/orbitMiddleware.js

@@ -1,18 +0,0 @@
-import {ORBIT_DATABASE_CREATED} from "./orbitActions";
-import {BREEZE_INITIALIZED} from "../breezeStatus/breezeActions";
-
-export const orbitMiddleware = breezeInstance => () => next => action => {
-    const { type } = action
-
-    if (type === BREEZE_INITIALIZED)
-        breezeInstance = action.breeze
-
-    if (type === ORBIT_DATABASE_CREATED) {
-        const { database } = action;
-        breezeInstance.orbitDatabases[database.id] = database;
-    }
-    return next(action);
-}
-
-const initializedMiddleware = orbitMiddleware(undefined)
-export default initializedMiddleware

src/orbit/orbitReducer.js

@@ -3,26 +3,41 @@ import {
     ORBIT_DATABASE_READY,
     ORBIT_DATABASE_REPLICATED,
     ORBIT_DATABASE_REPLICATING,
-    ORBIT_INITIALIZED
+    ORBIT_INITIALIZING,
+    ORBIT_INITIALIZED,
+    ORBIT_INIT_FAILED
 } from "./orbitActions";
+
 import {
     DB_STATUS_INIT,
     DB_STATUS_READY,
     DB_STATUS_REPLICATED,
-    DB_STATUS_REPLICATING
+    DB_STATUS_REPLICATING,
-} from "./constants";
+} from "./orbitConstants";
+
+import {STATUS_INITIALIZING, STATUS_INITIALIZED, STATUS_FAILED } from "../constants";
 
 const initialState = {
-    initialized: false,
+    status: STATUS_INITIALIZING,
     databases: {}
 };
 
 const orbitReducer = (state = initialState, action) => {
     switch (action.type) {
+        case ORBIT_INITIALIZING:
+            return {
+                ...state,
+                status: STATUS_INITIALIZING
+            };
         case ORBIT_INITIALIZED:
             return {
                 ...state,
-                initialized: true,
+                status: STATUS_INITIALIZED
+            };
+        case ORBIT_INIT_FAILED:
+            return {
+                ...state,
+                status: STATUS_FAILED
             };
         case ORBIT_DATABASE_CREATED:
             return newDatabasesStatus(state, action, DB_STATUS_INIT);
@@ -44,7 +59,8 @@ function newDatabasesStatus (state, action, status) {
             ...state.databases,
             [action.database.id]: {
                 ...state[action.database.id],
-                status
+                status,
+                timestamp: action.timestamp
             }
         }
     }

src/orbit/orbitSaga.js

@@ -1,11 +1,16 @@
-import {all, call, put, take, takeLatest} from 'redux-saga/effects'
+import { all, call, put, spawn, take, takeEvery, takeLatest } from 'redux-saga/effects'
+import { eventChannel } from 'redux-saga';
 import OrbitDB from 'orbit-db';
 import Identities from 'orbit-db-identity-provider'
+
 import {
     ORBIT_DATABASE_CREATED,
     ORBIT_DATABASE_CREATING,
     ORBIT_DATABASE_FAILED,
     ORBIT_DATABASE_LISTEN,
+    ORBIT_DATABASE_READY,
+    ORBIT_DATABASE_REPLICATED,
+    ORBIT_DATABASE_REPLICATING,
     ORBIT_IDENTITY_PROVIDER_ADD,
     ORBIT_IDENTITY_PROVIDER_ADDED,
     ORBIT_IDENTITY_PROVIDER_FAILED,
@@ -14,10 +19,11 @@ import {
     ORBIT_INITIALIZING
 } from './orbitActions';
 
-import { resolveOrbitDBTypeFun} from "./orbitUtils";
+import { resolveOrbitDBTypeFun} from './orbitUtils';
 
 const LOGGING_PREFIX = 'orbitSaga: ';
 
+
 /*
  * Add Orbit Identity Provider
  */
@@ -31,12 +37,12 @@ export function * addOrbitIdentityProvider(identityProvider) {
         yield put({ type: ORBIT_IDENTITY_PROVIDER_ADDED });
     } catch (error) {
         yield put({ type: ORBIT_IDENTITY_PROVIDER_FAILED, error });
-        console.error(LOGGING_PREFIX + 'EthereumIdentityProvider adding error:');
+        console.error(LOGGING_PREFIX + 'IdentityProvider adding error:');
         console.error(error);
     }
 }
 
-export function * initOrbit(action) {
+function * initOrbit(action) {
     try {
         let { breeze, id } = action;
         const { ipfs } = breeze;
@@ -48,7 +54,7 @@ export function * initOrbit(action) {
 
         breeze.orbit = orbit;
 
-        // Create our own initial databases, as given in the options
+        // Create initial databases from options
         yield all(databases.map(db => {
             return call(createDatabase, { orbit, db });
         }));
@@ -66,13 +72,16 @@ export function * initOrbit(action) {
 /*
  * Creates an orbit database given a name and a type as its parameters
  */
-export function * createDatabase({orbit, db}) {
+function * createDatabase({ orbit, db }) {
     try {
         const dbTypeFun = resolveOrbitDBTypeFun(orbit, db.type);
 
         const createdDB = yield call([orbit, dbTypeFun], db.name);
 
-        yield put({ type: ORBIT_DATABASE_CREATED, database: createdDB });
+        yield put({ type: ORBIT_DATABASE_CREATED, database: createdDB, timestamp: +new Date });
+
+        // Event channel setup
+        yield spawn(callListenForOrbitDatabaseEvent, { database: createdDB });
 
         // Wait for event channel setup before loading
         yield take(action => action.type === ORBIT_DATABASE_LISTEN && action.id === createdDB.id);
@@ -82,14 +91,59 @@ export function * createDatabase({orbit, db}) {
         return createdDB;
     } catch (error) {
         yield put({ type: ORBIT_DATABASE_FAILED, error });
-        console.error(LOGGING_PREFIX + 'OrbitDB identity provider adding error:');
+        console.error(LOGGING_PREFIX + 'OrbitDB database creation error:');
         console.error(error);
     }
 }
 
+
+/*
+ * Database Events
+ * See also https://redux-saga.js.org/docs/advanced/Channels.html
+ */
+function createOrbitDatabaseChannel (database){
+    return eventChannel(emit => {
+        const onReady = () => {
+            emit({ type: ORBIT_DATABASE_READY, database, timestamp: +new Date });
+        };
+        const onReplicate = () => {
+            emit({ type: ORBIT_DATABASE_REPLICATING, database, timestamp: +new Date });
+        };
+        const onReplicated = () => {
+            emit({ type: ORBIT_DATABASE_REPLICATED, database, timestamp: +new Date });
+        };
+
+        const eventListener = database.events
+            .once('ready', onReady)
+            .on('replicate', onReplicate)
+            .on('replicated', onReplicated)
+
+        return () => {
+            eventListener.removeListener('ready',onReady)
+            eventListener.removeListener('replicate',onReplicate)
+            eventListener.removeListener('replicated',onReplicated)
+        };
+
+    })
+}
+
+function * callListenForOrbitDatabaseEvent ({ database }) {
+    const orbitDatabaseChannel = yield call(createOrbitDatabaseChannel, database);
+    yield put({type: ORBIT_DATABASE_LISTEN, id: database.id});
+
+    try {
+        while (true) {
+            let event = yield take(orbitDatabaseChannel);
+            yield put(event);
+        }
+    } finally {
+        orbitDatabaseChannel.close();
+    }
+}
+
 function * orbitSaga () {
     yield takeLatest(ORBIT_INITIALIZING, initOrbit);
-    yield takeLatest(ORBIT_DATABASE_CREATING, createDatabase);
+    yield takeEvery(ORBIT_DATABASE_CREATING, createDatabase);
 }
 
 export default orbitSaga

src/orbit/orbitStatusSaga.js

@@ -1,61 +0,0 @@
-import { call, put, take, takeEvery } from 'redux-saga/effects'
-import {eventChannel} from "@redux-saga/core";
-
-import {
-    ORBIT_DATABASE_CREATED,
-    ORBIT_DATABASE_LISTEN,
-    ORBIT_DATABASE_READY,
-    ORBIT_DATABASE_REPLICATED,
-    ORBIT_DATABASE_REPLICATING
-} from './orbitActions';
-
-/*
- * Database Events
- * See also https://redux-saga.js.org/docs/advanced/Channels.html
- */
-function createOrbitDatabaseChannel (database){
-    return eventChannel(emit => {
-        const onReady = () => {
-            emit({ type: ORBIT_DATABASE_READY, database });
-        };
-        const onReplicate = () => {
-            emit({ type: ORBIT_DATABASE_REPLICATING, database });
-        };
-        const onReplicated = () => {
-            emit({ type: ORBIT_DATABASE_REPLICATED, database });
-        };
-
-        const eventListener = database.events
-            .on('ready', onReady)
-            .on('replicate', onReplicate)
-            .on('replicated', onReplicated)
-
-        return () => {
-            eventListener.removeListener('ready',onReady)
-            eventListener.removeListener('replicate',onReplicate)
-            eventListener.removeListener('replicated',onReplicated)
-        };
-
-    })
-}
-
-export function * callListenForOrbitDatabaseEvent ({database}) {
-    const orbitDatabaseChannel = yield call(createOrbitDatabaseChannel, database)
-    yield put({type: ORBIT_DATABASE_LISTEN, id: database.id});
-
-    try {
-        while (true) {
-            let event = yield take(orbitDatabaseChannel);
-            yield put(event);
-        }
-    } finally {
-        orbitDatabaseChannel.close();
-    }
-}
-
-function * orbitStatusSaga () {
-   yield takeEvery(ORBIT_DATABASE_CREATED, callListenForOrbitDatabaseEvent);
-}
-
-export default orbitStatusSaga
-

src/orbit/orbitUtils.js

@@ -1,4 +1,4 @@
-import * as orbitTypes from "./constants";
+import * as orbitTypes from "./orbitConstants";
 
 export function resolveOrbitDBTypeFun(orbitdb, type){
     let dbTypeFun;