@v1nt1248/3nclient-lib 0.0.13 → 0.0.15

package/src/libs/sqlite-on-3nstorage/synced.ts

@@ -0,0 +1,194 @@
+/*
+ Copyright (C) 2015, 2017, 2019 - 2021 3NSoft Inc.
+ 
+ This program is free software: you can redistribute it and/or modify it under
+ the terms of the GNU General Public License as published by the Free Software
+ Foundation, either version 3 of the License, or (at your option) any later
+ version.
+ 
+ This program is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ See the GNU General Public License for more details.
+ 
+ You should have received a copy of the GNU General Public License along with
+ this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+
+import { defer, Deferred } from "./deferred.js";
+
+/**
+ * This represents a function that will create a promise, potentially starting
+ * some background process, only when it is called. Such wrap of code is needed
+ * for scheduling, as very often any start of an action must be postponed till
+ * later time. Scheduler needs a not-yet-started activity, as scheduler has
+ * control action's start.
+ */
+export type Action<T> = () => Promise<T>;
+
+/**
+ * This is a container of processes, labeled by some ids. It allows to track if
+ * there is a process already in progress with a given id. And, it allows to
+ * chain process, when needed.
+ * 
+ * Common use of such class is to reuse getting of some expensive resource(s).
+ */
+export class NamedProcs {
+	
+	private processes = new Map<string, SingleProc>();
+	
+	constructor() {
+		Object.freeze(this);
+	}
+	
+	/**
+	 * @param id is a string key of a process
+	 * @return a promise of a process' completion, or undefined, if process with
+	 * given id is unknown.
+	 */
+	latestTaskAtThisMoment<T>(id: string): Promise<T> | undefined {
+		const proc = this.processes.get(id);
+		return (proc ? proc.latestTaskAtThisMoment() : undefined);
+	}
+
+	isProcessing(id: string): boolean {
+		const proc = this.processes.get(id);
+		return (proc ? proc.isProcessing() : false);
+	}
+	
+	/**
+	 * This method will add a promise of an already started process.
+	 * @param id is a string key of a process
+	 * @param promise of an already started process
+	 * @return a promise of a process' completion.
+	 */
+	addStarted<T>(id: string, promise: Promise<T>): Promise<T> {
+		if (this.isProcessing(id)) { throw new Error(
+			'Process with id "'+id+'" is already in progress.'); }
+		return this.startOrChain(id, () => promise);
+	}
+	
+	/**
+	 * This method will start a given action only, if a process with a given id
+	 * is not running.
+	 * @param id is a string key of a process
+	 * @param action is a function that starts some process
+	 * @return a promise of a process' completion.
+	 */
+	start<T>(id: string, action: Action<T>): Promise<T> {
+		if (this.isProcessing(id)) { throw new Error(
+			'Process with id "'+id+'" is already in progress.'); }
+		return this.startOrChain(id, action);
+	}
+	
+	/**
+	 * This method will chain a given action to an already running process, or,
+	 * if identified process is not running, this will start given action under
+	 * a given id.
+	 * @param id is a string key of a process
+	 * @param action is a function that starts some process
+	 * @return a promise of a process' completion.
+	 */
+	startOrChain<T>(id: string, action: Action<T>): Promise<T> {
+		let proc = this.processes.get(id);
+		if (!proc) {
+			proc = new SingleProc(() => this.processes.delete(id));
+			this.processes.set(id, proc);
+		}
+		return proc.startOrChain(action);
+	}
+	
+}
+Object.freeze(NamedProcs.prototype);
+Object.freeze(NamedProcs);
+
+
+/**
+ * This is a container of process. It allows to track if a process is already
+ * in progress. It also allows to chain process, when needed.
+ * 
+ * Common use of such class is to reuse getting of some expensive resource, or
+ * do ning something as an exclusive process.
+ */
+export class SingleProc {
+
+	private actions: {
+		action: Action<any>;
+		deferred: Deferred<any>;
+	}[] = [];
+	private running = false;
+
+	constructor(
+		private onGoingIdle?: () => void
+	) {
+		Object.seal(this);
+	}
+
+	isProcessing(): boolean {
+		return (this.actions.length > 0);
+	}
+
+	latestTaskAtThisMoment<T>(): Promise<T>|undefined {
+		return ((this.actions.length === 0) ?
+			undefined :
+			this.actions[this.actions.length-1].deferred.promise);
+	}
+
+	addStarted<T>(promise: Promise<T>): Promise<T> {
+		if (this.isProcessing()) { throw new Error(
+			'Process is already in progress.'); }
+		return this.startOrChain(() => promise);
+	}
+
+	start<T>(action: Action<T>): Promise<T> {
+		if (this.isProcessing()) { throw new Error(
+			'Process is already in progress.'); }
+		return this.startOrChain(action);
+	}
+
+	private async runIfIdle(): Promise<void> {
+		if (this.running) { return; }
+		this.running = true;
+		while (this.actions.length > 0) {
+			const { action, deferred } = this.actions[0];
+			try {
+				const res = await action();
+				deferred.resolve(res);
+			} catch (err) {
+				deferred.reject(err);
+			}
+			this.actions.shift();
+		}
+		this.running = false;
+		// paranoid check after seeing LiquidCore 0.7.10 on iOS
+		if (this.actions.length > 0) {
+			return this.runIfIdle();
+		}
+		// when listener is used, like with NamedPcos
+		if (this.onGoingIdle) {
+			this.onGoingIdle();
+		}
+	}
+
+	startOrChain<T>(action: Action<T>): Promise<T> {
+		const deferred = defer<T>();
+		this.actions.push({ action, deferred });
+		this.runIfIdle();
+		return deferred.promise;
+	}
+
+}
+Object.freeze(SingleProc.prototype);
+Object.freeze(SingleProc);
+
+
+/**
+ * This wraps given function/method into syncing wrap.
+ */
+export function makeSyncedFunc<T extends Function>(
+	syncProc: SingleProc, thisArg: any, func: T
+): T {
+	return ((
+		...args: any[]
+	) => syncProc.startOrChain(() => func.apply(thisArg, args))) as any as T;
+}

package/dist/libs/index.js

@@ -1,4 +0,0 @@
-export * from './ipc-service'
-export * from './ipc-service-caller'
-export * from './serialization-for-ipc/json-n-binary'
-export * from './sqlite-on-3nstorage/index'