All files / src/store a.store.ts

92.7% Statements 89/96
91.17% Branches 31/34
83.33% Functions 25/30
92.13% Lines 82/89

Press n or j to go to the next uncovered block, b, p or k for the previous block.

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 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274    9x 9x 9x 9x       9x 9x   9x 9x 9x     9x   9x   9x 844x       27x           9x           102x                                   102x   102x 102x 102x 102x 102x 102x 102x 102x 102x   102x         102x       67x 67x       25x                           41x               90x   90x   90x 90x   90x 90x   90x   90x 2x 6x   88x         3x 3x 2x   1x 1x         65x 65x 65x       64x       24x 24x 24x                 3x   3x 3x   3x 3x   3x                 4x                     1x                     3x                                 4x       89x   88x   88x 50x 50x     88x   88x 88x       4x       1x       2x       89x   88x 88x       50x       35x 35x                                  
'use strict';
 
import sift from 'sift';
import {randomUUID} from 'node:crypto';
import * as jsondiffpatch from 'jsondiffpatch';
import {cloneDeep, each, get, includes, isArray, isEmpty, isNil, omit, omitBy, set, values} from 'lodash';
 
import {Model} from 'mongoose';
 
import {throttleTime} from 'rxjs/operators';
import {asyncScheduler, Subject, Subscription} from 'rxjs';
 
import EStoreType from '../enums/store.type.enum';
import observableModel from '../mongodb/functions/observable.model';
import getMillisecondsFrom from '../functions/performance/get.milliseconds.from';
import StoreSubscriptionConfigType from '../types/store.subscription.config.type';
 
import 'json-circular-stringify';
 
const DEFAULT_DELAY: number = 100;
 
const diffPatcher: jsondiffpatch.DiffPatcher = jsondiffpatch.create({
	propertyFilter: (name: string): boolean => name !== 'subscriptionId'
});
 
// tslint:disable-next-line:variable-name
const _baseMessage = (target: string, incremental = false): any => ({
	type: incremental ? 'increment' : 'update',
	target,
	payload: {}
});
 
export default abstract class AStore extends Subject<any> {
	protected _model: Model<any>;
	protected _target: string;
	protected _type: EStoreType;
 
	protected _config: StoreSubscriptionConfigType;
	protected _incremental: boolean = false;
 
	protected _subscriptionId: string;
 
	protected _query: any;
	protected _sort: any;
	protected _fields: any;
	protected _paging: any;
	protected _populates: any[];
	protected _virtuals: any[];
 
	protected _delay: number;
 
	protected _subscription: Subscription;
 
	protected _subscriptionDiffs: Map<string, boolean>;
 
	protected constructor(model: Model<any>, target: string) {
		super();
 
		this._model = model;
		this._target = target;
		this._query = {};
		this._sort = {};
		this._fields = {};
		this._paging = {};
		this._populates = [];
		this._virtuals = [];
		this._delay = DEFAULT_DELAY;
 
		this._config = {
			query: {___initial___: true},
			strict: false,
			incremental: false
		};
		this._subscriptionDiffs = new Map<string, boolean>();
	}
 
	public destroy(): void {
		this._subscription?.unsubscribe();
		delete this._subscription;
	}
 
	public restartSubscription(): void {
		this.subscription = observableModel(this.model) //
			.pipe(throttleTime(this._delay, asyncScheduler, {leading: true, trailing: true}))
			.subscribe({
				next: (change: any): void => {
					this.load(change) //
						.then((): null => null)
						.catch((e: any): void => this.error(e));
				},
				error: (e: any): void => this.error(e),
				complete: (): void => this.complete()
			});
	}
 
	protected isInitialSubscription(change: any): boolean {
		return isEmpty(change);
	}
 
	protected abstract shouldReload(change: any): boolean;
 
	protected abstract load(change: any): Promise<void>;
 
	protected extractFromConfig(): void {
		const {subscriptionId = randomUUID(), query = {}, sort = {}, fields = {}, populates = [], virtuals = [], delay = DEFAULT_DELAY} = this._config;
 
		this._subscriptionId = subscriptionId;
 
		this._query = query;
		this._sort = sort;
 
		this._populates = populates;
		this._virtuals = virtuals;
 
		this._delay = delay;
 
		if (isArray(fields)) {
			this._fields = {};
			each(fields, (field: string) => set(this._fields, field, 1));
		} else {
			this._fields = fields;
		}
	}
 
	protected testDocument(document: any): boolean {
		try {
			const test = sift(omit(this._query, ['createdAt', 'updatedAt']));
			return test(document);
		} catch (error) {
			console.error('[@owservable] -> AStore::testDocument Error:', {query: this._query, document, error});
			return true;
		}
	}
 
	protected set subscription(subscription: Subscription) {
		this.destroy();
		this._subscription = subscription;
		this.load({}).then((): null => null);
	}
 
	protected get model(): Model<any> {
		return this._model;
	}
 
	protected emitOne(startTime: number, subscriptionId: string, update: any = {}): void {
		const message = _baseMessage(this._target, this._incremental);
		set(message.payload, this._target, update);
		this.next({
			subscriptionId,
			...message,
			execution_time: getMillisecondsFrom(startTime).toFixed(2) + 'ms',
			...this._responseStatistics()
		});
	}
 
	protected emitMany(startTime: number, subscriptionId: string, update: any = {total: 0, data: [], recounting: false}): void {
		const {total, data, recounting} = update;
 
		const message = _baseMessage(this._target, this._incremental);
		set(message.payload, this._target, data);
 
		if (!this._incremental && total >= 0) set(message.payload, '_' + this._target + 'Count', total);
		if (recounting) set(message.payload, '_' + this._target + 'Recounting', true);
 
		this.next({
			subscriptionId,
			...message,
			execution_time: getMillisecondsFrom(startTime).toFixed(2) + 'ms',
			...this._responseStatistics()
		});
	}
 
	protected emitTotal(startTime: number, subscriptionId: string, total: any): void {
		this.next({
			subscriptionId,
			type: 'total',
			target: this._target,
			total,
			execution_time: getMillisecondsFrom(startTime).toFixed(2) + 'ms',
			...this._responseStatistics()
		});
	}
 
	protected emitDelete(startTime: number, subscriptionId: string, deleted: any): void {
		this.next({
			subscriptionId,
			type: 'delete',
			target: this._target,
			payload: deleted,
			execution_time: getMillisecondsFrom(startTime).toFixed(2) + 'ms',
			...this._responseStatistics()
		});
	}
 
	protected emitError(startTime: number, subscriptionId: string, error: any): void {
		this.next({
			subscriptionId,
			type: 'error',
			error,
			target: this._target,
			query: this._query,
			sort: this._sort,
			fields: this._fields,
			paging: this._paging,
			populates: this._populates,
			virtuals: this._virtuals,
			execution_time: getMillisecondsFrom(startTime).toFixed(2) + 'ms',
			...this._responseStatistics()
		});
	}
 
	protected shouldConsiderFields(): boolean {
		return !isEmpty(this._fields) && !includes(values(this._fields), 0);
	}
 
	public set config(config: StoreSubscriptionConfigType) {
		if (!this._isValidConfig(config)) return;
 
		config.subscriptionId = config.subscriptionId || randomUUID();
 
		if (this._type === EStoreType.COLLECTION) {
			const queryDiff = jsondiffpatch.diff(get(this._config, 'query', {}), get(config, 'query', {}));
			this._addSubscriptionDiff(config.subscriptionId, !isEmpty(queryDiff));
		}
 
		this._config = cloneDeep(config);
 
		this.extractFromConfig();
		this.restartSubscription();
	}
 
	public get target(): string {
		return this._target;
	}
 
	protected removeSubscriptionDiff(subId: string) {
		this._subscriptionDiffs.delete(subId);
	}
 
	protected isQueryChange(subId: string): boolean {
		return !!this._subscriptionDiffs.get(subId);
	}
 
	private _isValidConfig(config: StoreSubscriptionConfigType): boolean {
		if (!config) return false;
 
		const diff = diffPatcher.diff(this._config, config);
		return !isEmpty(diff);
	}
 
	private _addSubscriptionDiff(subId: string, diff: boolean) {
		this._subscriptionDiffs.set(subId, diff);
	}
 
	private _responseStatistics(): any {
		try {
			return omitBy(
				{
					query: JSON.stringify(this._query),
					sort: JSON.stringify(this._sort),
					fields: JSON.stringify(this._fields),
					paging: JSON.stringify(this._paging),
					populates: JSON.stringify(this._populates),
					virtuals: JSON.stringify(this._virtuals)
				},
				isNil
			);
		} catch (error) {
			console.error('[@owservable] -> AStore::responseStatistics Error:', {error});
			return {};
		}
	}
}