All files / composer-runtime-pouchdb/lib pouchdbdatacollection.js

100% Statements 85/85
100% Branches 22/22
100% Functions 17/17
100% Lines 85/85
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218                                1x 1x 1x 1x   1x                                 36x 36x 36x 36x 36x 36x 36x                   2x 2x 2x 2x 1x     2x 2x 2x 2x 2x   2x 4x 4x 4x   2x 2x                       3x 3x 3x 3x 1x     3x 3x   3x 1x   2x 2x                       4x 4x 4x 4x 2x     4x 4x   4x 4x                           3x 3x 3x   3x 3x 2x 2x     3x 3x   3x 1x   2x 2x                           3x 3x 3x 3x 1x 1x     3x 3x   3x 1x   2x 2x                         3x 3x 3x 3x 1x     3x 3x   3x 1x   2x 2x             1x  
/*
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
'use strict';
 
const DataCollection = require('composer-runtime').DataCollection;
const Logger = require('composer-common').Logger;
const pouchCollate = require('pouchdb-collate');
const PouchDBUtils = require('./pouchdbutils');
 
const LOG = Logger.getLog('PouchDBDataCollection');
 
/**
 * Base class representing a data collection provided by a {@link DataService}.
 * @protected
 * @abstract
 */
class PouchDBDataCollection extends DataCollection {
 
    /**
     * Constructor.
     * @param {DataService} dataService The owning data service.
     * @param {Dexie} db The database to use.
     * @param {string} collectionId The collection ID to use.
     * @param {string} uuid The uuid to use
     */
    constructor(dataService, db, collectionId, uuid) {
        super(dataService);
        const method = 'constructor';
        LOG.entry(method, dataService, db, collectionId);
        this.db = db;
        this.uuid = uuid;
        this.collectionId = collectionId;
        LOG.exit(method);
    }
 
    /**
     * Get all of the objects in this collection.
     * @abstract
     * @return {Promise} A promise that will be resolved with an array of objects,
     * or rejected with an error.
     */
    getAll() {
        const method = 'getAll';
        LOG.entry(method);
        let compositeKey = [this.collectionId];
        if(this.uuid) {
            compositeKey.unshift(this.uuid);
        }
 
        const startKey = pouchCollate.toIndexableString(compositeKey);
        const endCompositeKey = compositeKey;
        endCompositeKey.push('\uffff');
        const endKey = pouchCollate.toIndexableString(endCompositeKey);
        return this.db.allDocs({ include_docs: true, startkey: startKey, endkey: endKey, inclusive_end: false })
            .then((response) => {
                const result = response.rows.map((row) => {
                    delete row.doc._id;
                    delete row.doc._rev;
                    return row.doc;
                });
                LOG.exit(result);
                return result;
            });
    }
 
    /**
     * Get the specified object in this collection.
     * @abstract
     * @param {string} id The ID of the object.
     * @return {Promise} A promise that will be resolved with an object, or rejected
     * with an error.
     */
    get(id) {
        const method = 'get';
        LOG.entry(method, id);
        let compositeKey = [this.collectionId, id];
        if(this.uuid) {
            compositeKey.unshift(this.uuid);
        }
 
        const key = pouchCollate.toIndexableString(compositeKey);
        return PouchDBUtils.getDocument(this.db, key)
            .then((doc) => {
                if (!doc) {
                    throw new Error(`Object with ID '${id}' in collection with ID '${this.collectionId}' does not exist`);
                }
                LOG.exit(method, doc);
                return doc;
            });
    }
 
    /**
     * Determine whether the specified object exists in this collection.
     * @abstract
     * @param {string} id The ID of the object.
     * @return {Promise} A promise that will be resolved with a boolean indicating
     * whether the object exists.
     */
    exists(id) {
        const method = 'exists';
        LOG.entry(method, id);
        let compositeKey = [this.collectionId, id];
        if(this.uuid) {
            compositeKey.unshift(this.uuid);
        }
 
        const key = pouchCollate.toIndexableString(compositeKey);
        return PouchDBUtils.getDocument(this.db, key)
            .then((doc) => {
                LOG.exit(method, !!doc);
                return !!doc;
            });
    }
 
    /**
     * Add an object to the collection.
     * @abstract
     * @param {string} id The ID of the object.
     * @param {Object} object The object.
     * @param {boolean} force Whether to force creation without checking it already exists.
     * @return {Promise} A promise that will be resolved when complete, or rejected
     * with an error.
     */
    add(id, object, force) {
        const method = 'add';
        LOG.entry(method, id, object, force);
        force = !!force;
 
        let compositeKey = [this.collectionId, id];
        if(this.uuid) {
            compositeKey.unshift(this.uuid);
            object.$networkId = this.uuid;
        }
 
        const key = pouchCollate.toIndexableString(compositeKey);
        return PouchDBUtils.getDocument(this.db, key)
            .then((doc) => {
                if (doc && !force) {
                    throw new Error(`Failed to add object with ID '${id}' as the object already exists`);
                }
                return this.dataService.handleAction(() => {
                    return PouchDBUtils.putDocument(this.db, key, object);
                });
            });
    }
 
    /**
     * Add an object to the collection.
     * @abstract
     * @param {string} id The ID of the object.
     * @param {Object} object The object.
     * @return {Promise} A promise that will be resolved when complete, or rejected
     * with an error.
     */
    update(id, object) {
        const method = 'update';
        LOG.entry(method, id, object);
        let compositeKey = [this.collectionId, id];
        if(this.uuid) {
            compositeKey.unshift(this.uuid);
            object.$networkId = this.uuid;
        }
 
        const key = pouchCollate.toIndexableString(compositeKey);
        return PouchDBUtils.getDocument(this.db, key)
            .then((doc) => {
                if (!doc) {
                    throw new Error(`Object with ID '${id}' in collection with ID '${this.collectionId}' does not exist`);
                }
                return this.dataService.handleAction(() => {
                    return PouchDBUtils.putDocument(this.db, key, object);
                });
            });
    }
 
    /**
     * Remove an object from the collection.
     * @abstract
     * @param {string} id The ID of the object.
     * @return {Promise} A promise that will be resolved when complete, or rejected
     * with an error.
     */
    remove(id) {
        const method = 'remove';
        LOG.entry(method, id);
        let compositeKey = [this.collectionId, id];
        if(this.uuid) {
            compositeKey.unshift(this.uuid);
        }
 
        const key = pouchCollate.toIndexableString(compositeKey);
        return PouchDBUtils.getDocument(this.db, key)
            .then((doc) => {
                if (!doc) {
                    throw new Error(`Object with ID '${id}' in collection with ID '${this.collectionId}' does not exist`);
                }
                return this.dataService.handleAction(() => {
                    return PouchDBUtils.removeDocument(this.db, key);
                });
            });
    }
 
}
 
module.exports = PouchDBDataCollection;