import _ from "lodash" import async from "async" import * as utils from "./utils" import { processFind } from "./utils" import { compileSort } from "./selector" import { Doc, Item, MinimongoCollection, MinimongoCollectionFindOneOptions, MinimongoCollectionFindOptions, MinimongoDb, MinimongoLocalCollection } from "./types" export default class MemoryDb implements MinimongoDb { collections: { [collectionName: string]: Collection } options: { safety: "clone" | "freeze" } // Options are: // safety: How to protect the in-memory copies: "clone" (default) returns a fresh copy but is slow. "freeze" returns a frozen version constructor(options?: { safety?: "clone" | "freeze" }, success?: any) { this.collections = {} this.options = _.defaults(options, { safety: "clone" }) if (success) { success(this) } } addCollection(name: string, success?: () => void, error?: (err: any) => void) { const collection = new Collection(name, this.options) this[name] = collection this.collections[name] = collection if (success != null) { return success() } } removeCollection(name: any, success: any, error: any) { delete this[name] delete this.collections[name] if (success != null) { return success() } } getCollectionNames() { return _.keys(this.collections) } } // Stores data in memory class Collection implements MinimongoLocalCollection { name: string items: { [id: string]: T } upserts: { [id: string]: Item } removes: { [id: string]: T } options: { safety?: "clone" | "freeze" } constructor(name: any, options: { safety?: "clone" | "freeze" }) { this.name = name this.items = {} this.upserts = {} // Pending upserts by _id. Still in items this.removes = {} // Pending removes by _id. No longer in items this.options = options || {} } find(selector: any, options?: MinimongoCollectionFindOptions) { return { fetch: (success?: any, error?: any) => { return this._findFetch(selector, options, success, error) } } } findOne(selector: any, options?: MinimongoCollectionFindOneOptions): Promise findOne( selector: any, options: MinimongoCollectionFindOneOptions, success: (doc: T | null) => void, error: (err: any) => void ): void findOne(selector: any, success: (doc: T | null) => void, error: (err: any) => void): void findOne(selector: any, options?: any, success?: any, error?: any) { if (_.isFunction(options)) { ;[options, success, error] = [{}, options, success] } options = options || {} // If promise case if (success == null) { return new Promise((resolve, reject) => { this.findOne(selector, options, resolve, reject) }) } this.find(selector, options).fetch((results: any) => { if (success != null) { return success(this._applySafety(results.length > 0 ? results[0] : null)) } }, error) return } _findFetch(selector: any, options: any, success: any, error: any): any { // If promise case if (success == null) { return new Promise((resolve, reject) => { this._findFetch(selector, options, resolve, reject) }) } // Defer to allow other processes to run setTimeout(() => { // Shortcut if _id is specified let allItems if (selector && selector._id && _.isString(selector._id)) { allItems = _.compact([this.items[selector._id]]) } else { allItems = _.values(this.items) } const results = processFind(allItems, selector, options) if (success != null) { success(this._applySafety(results)) } }, 0) return } // Applies safety (either freezing or cloning to object or array) _applySafety = (items: any): any => { if (!items) { return items } if (_.isArray(items)) { return _.map(items, this._applySafety) } if (this.options.safety === "clone" || !this.options.safety) { return JSON.parse(JSON.stringify(items)) } if (this.options.safety === "freeze") { Object.freeze(items) return items } throw new Error(`Unsupported safety ${this.options.safety}`) } upsert(doc: T): Promise upsert(doc: T, base: T | null | undefined): Promise upsert(docs: T[]): Promise<(T | null)[]> upsert(docs: T[], bases: (T | null | undefined)[]): Promise<(T | null)[]> upsert(doc: T, success: (doc: T | null) => void, error: (err: any) => void): void upsert(doc: T, base: T | null | undefined, success: (doc: T | null) => void, error: (err: any) => void): void upsert(docs: T[], success: (docs: (T | null)[]) => void, error: (err: any) => void): void upsert( docs: T[], bases: (T | null | undefined)[], success: (item: (T | null)[]) => void, error: (err: any) => void ): void upsert(docs: any, bases?: any, success?: any, error?: any): any { // If promise case if (!success && !_.isFunction(bases)) { return new Promise((resolve, reject) => { this.upsert( docs, bases, resolve, reject ) }) } let items: { doc: T; base?: T }[] ;[items, success, error] = utils.regularizeUpsert(docs, bases, success, error) // Keep independent copies to prevent modification items = JSON.parse(JSON.stringify(items)) for (let item of items) { // Fill in base if undefined if (item.base === undefined) { // Use existing base if (this.upserts[item.doc._id!]) { item.base = this.upserts[item.doc._id!].base } else { item.base = this.items[item.doc._id!] || null } } // Replace/add this.items[item.doc._id!] = item.doc this.upserts[item.doc._id!] = item } if (_.isArray(docs)) { if (success) { return success(this._applySafety(_.map(items, "doc"))) } } else { if (success) { return success(this._applySafety(_.map(items, "doc")[0])) } } } remove(id: any): Promise remove(id: any, success: () => void, error: (err: any) => void): void remove(id: any, success?: () => void, error?: (err: any) => void): any { if (!success) { return new Promise((resolve, reject) => { this.remove(id, resolve, reject) }) } // Special case for filter-type remove if (_.isObject(id)) { this.find(id).fetch((rows: any) => { return async.each( rows, ((row: any, cb: any) => { return this.remove(row._id, () => cb(), cb) }) as any, () => success() ) }, error) return } if (_.has(this.items, id)) { this.removes[id] = this.items[id] delete this.items[id] delete this.upserts[id] } else { this.removes[id] = { _id: id } as T } if (success != null) { return success() } } // Options are find options with optional "exclude" which is list of _ids to exclude cache(docs: any, selector: any, options: any, success: any, error: any) { // Add all non-local that are not upserted or removed let sort: any for (let doc of docs) { // Exclude any excluded _ids from being cached/uncached if (options && options.exclude && options.exclude.includes(doc._id)) { continue } this.cacheOne( doc, () => {}, () => {} ) } const docsMap = _.fromPairs(_.zip(_.map(docs, "_id"), docs)) if (options.sort) { sort = compileSort(options.sort) } // Perform query, removing rows missing in docs from local db return this.find(selector, options).fetch((results: any) => { for (let result of results) { if (!docsMap[result._id] && !_.has(this.upserts, result._id)) { // If at limit if (options.limit && docs.length === options.limit) { // If past end on sorted limited, ignore if (options.sort && sort(result, _.last(docs)) >= 0) { continue } // If no sort, ignore if (!options.sort) { continue } } // Exclude any excluded _ids from being cached/uncached if (options && options.exclude && options.exclude.includes(result._id)) { continue } delete this.items[result._id] } } if (success != null) { return success() } }, error) } pendingUpserts(success: any) { return success(_.values(this.upserts)) } pendingRemoves(success: any) { return success(_.map(this.removes, "_id")) } resolveUpserts(upserts: any, success: any) { for (let upsert of upserts) { const id = upsert.doc._id if (this.upserts[id]) { // Only safely remove upsert if doc is unchanged if (JSON.stringify(upsert.doc) == JSON.stringify(this.upserts[id].doc)) { delete this.upserts[id] } else { // Just update base this.upserts[id].base = upsert.doc } } } if (success != null) { return success() } } resolveRemove(id: any, success: any) { delete this.removes[id] if (success != null) { return success() } } // Add but do not overwrite or record as upsert seed(docs: any, success: any) { if (!_.isArray(docs)) { docs = [docs] } for (let doc of docs) { if (!_.has(this.items, doc._id) && !_.has(this.removes, doc._id)) { this.items[doc._id] = doc } } if (success != null) { return success() } } // Add but do not overwrite upserts or removes cacheOne(doc: any, success: any, error: any) { return this.cacheList([doc], success, error) } // Add but do not overwrite upserts or removes cacheList(docs: any, success: any, error?: any) { for (let doc of docs) { if (!_.has(this.upserts, doc._id) && !_.has(this.removes, doc._id)) { const existing = this.items[doc._id] // If _rev present, make sure that not overwritten by lower or equal _rev if (!existing || !doc._rev || !existing._rev || doc._rev > existing._rev) { this.items[doc._id] = doc } } } if (success != null) { return success() } } uncache(selector: any, success: any, error: any) { const compiledSelector = utils.compileDocumentSelector(selector) const items = _.filter(_.values(this.items), (item: any) => { return this.upserts[item._id] != null || !compiledSelector(item) }) this.items = _.fromPairs(_.zip(_.map(items, "_id"), items)) if (success != null) { return success() } } uncacheList(ids: any, success: any, error: any) { const idIndex = _.keyBy(ids) const items = _.filter(_.values(this.items), (item: any) => { return this.upserts[item._id] != null || !idIndex[item._id] }) this.items = _.fromPairs(_.zip(_.map(items, "_id"), items)) if (success != null) { return success() } } }