@iebh/tera-fy 2.0.14 → 2.0.16

package/lib/syncro/entities.js

@@ -1,7 +1,6 @@
 import Reflib from '@iebh/reflib';
 import {v4 as uuid4} from 'uuid';
 import {nanoid} from 'nanoid';
-import Syncro from './syncro.js';
 
 /**
 * Entities we support Syncro paths for, each should correspond directly with a Firebase/Firestore collection name
@@ -9,14 +8,14 @@ import Syncro from './syncro.js';
 * @type {Object} An object lookup of entities
 *
 * @property {String} singular The singular noun for the item
-* @property {Function} initState Function called to initialize state when Firestore has no existing document. Called as `({supabase:SupabaseClient, entity:String, id:String, relation?:string})` and expected to return the initial data object state
+* @property {Function} initState Function called to initialize state when Firestore has no existing document. Called as `({supabase:Supabasey, entity:String, id:String, relation?:string})` and expected to return the initial data object state
 * @property {Function} flushState Function called to flush state from Firebase to Supabase. Called the same as `initState` + `{state:Object}`
 */
 export default {
 	projects: { // {{{
 		singular: 'project',
 		async initState({supabase, id}) {
-			let data = await Syncro.wrapSupabase(supabase
+			let data = await supabase(s => s
 				.from('projects')
 				.select('data')
 				.maybeSingle()
@@ -43,7 +42,7 @@ export default {
 							console.log('[MIGRATION] Creating filename:', fileName);
 
 							return Promise.resolve()
-								.then(()=> Syncro.wrapSupabase(supabase.storage // Split data.temp[toolKey] -> file {{{
+								.then(()=> supabase(s => s // Split data.temp[toolKey] -> file {{{
 									.from('projects')
 									.upload(
 										`${id}/${fileName}`,
@@ -82,7 +81,7 @@ export default {
 			return data;
 		},
 		flushState({supabase, state, fsId}) {
-			return Syncro.wrapSupabase(supabase.rpc('syncro_merge_data', {
+			return supabase(s => s.rpc('syncro_merge_data', {
 				table_name: 'projects',
 				entity_id: fsId,
 				new_data: state,
@@ -97,13 +96,13 @@ export default {
 			let fileId = relation.replace(/_\*$/, '');
 
 			return Promise.resolve()
-				.then(()=> Syncro.wrapSupabase(supabase.storage
+				.then(()=> supabase(s => s.storage
 					.from('projects')
 					.list(id)
 				))
 				.then(files => files.find(f => f.id == fileId))
 				.then(file => file || Promise.reject(`Invalid file ID "${fileId}"`))
-				.then(file => Syncro.wrapSupabase(supabase.storage
+				.then(file => supabase(s => s.storage
 					.from('projects')
 					.download(`${id}/${file.name}`)
 				)
@@ -130,7 +129,8 @@ export default {
 		singular: 'project namespace',
 		initState({supabase, id, relation}) {
 			if (!relation) throw new Error('Project namespace relation missing, path should resemble "project_namespaces::${PROJECT}::${RELATION}"');
-			return Syncro.wrapSupabase(supabase.from('project_namespaces')
+			return supabase(s => s
+				.from('project_namespaces')
 				.select('data')
 				.limit(1)
 				.eq('project', id)
@@ -138,7 +138,8 @@ export default {
 			)
 				.then(rows => rows.length == 1
 					? rows[0]
-					: Syncro.wrapSupabase(supabase.from('project_namespaces') // Doesn't exist - create it
+					: supabase(s => s
+						.from('project_namespaces') // Doesn't exist - create it
 						.insert({
 							project: id,
 							name: relation,
@@ -150,7 +151,8 @@ export default {
 				.then(item => item.data);
 		},
 		flushState({supabase, state, id, relation}) {
-			return Syncro.wrapSupabase(supabase.from('project_namespaces')
+			return supabase(s => s
+				.from('project_namespaces')
 				.update({
 					edited_at: new Date(),
 					data: state,
@@ -163,7 +165,8 @@ export default {
 	test: { // {{{
 		singular: 'test',
 		initState({supabase, id}) {
-			return Syncro.wrapSupabase(supabase.from('test')
+			return supabase(s => s
+				.from('test')
 				.select('data')
 				.limit(1)
 				.eq('id', id)
@@ -172,7 +175,7 @@ export default {
 				.then(item => item.data);
 		},
 		flushState({supabase, state, fsId}) {
-			return Syncro.wrapSupabase(supabase.rpc('syncro_merge_data', {
+			return supabase(s => s.rpc('syncro_merge_data', {
 				table_name: 'test',
 				entity_id: fsId,
 				new_data: state,
@@ -182,7 +185,8 @@ export default {
 	users: { // {{{
 		singular: 'user',
 		initState({supabase, id}) {
-			return Syncro.wrapSupabase(supabase.from('users')
+			return supabase(s => s
+				.from('users')
 				.select('data')
 				.limit(1)
 				.maybeSingle()
@@ -192,7 +196,8 @@ export default {
 					if (user) return user.data; // User is valid and already exists
 
 					// User row doesn't already exist - need to create stub
-					return Syncro.wrapSupabase(supabase.from('users')
+					return supabase(s => s
+						.from('users')
 						.insert({
 							id,
 							data: {
@@ -209,7 +214,7 @@ export default {
 				})
 		},
 		flushState({supabase, state, fsId}) {
-			return Syncro.wrapSupabase(supabase.rpc('syncro_merge_data', {
+			return supabase(s => s.rpc('syncro_merge_data', {
 				table_name: 'users',
 				entity_id: fsId,
 				new_data: state,

package/lib/syncro/syncro.js

@@ -14,6 +14,7 @@ import {
 } from 'firebase/firestore';
 import marshal from '@momsfriendlydevco/marshal';
 import {nanoid} from 'nanoid';
+import PromiseRetry from 'p-retry';
 
 
 /**
@@ -135,6 +136,18 @@ export default class Syncro {
 	debug(...msg) {} // eslint-disable-line no-unused-vars
 
 
+	/**
+	* @interface
+	* Debugging printer specifically for error messages
+	* Defaults to using console.log()
+	*
+	* @param {*...} [msg] The message to output
+	*/
+	debugError(...msg) {
+		console.log(`[Syncro ${this.path}]`, ...msg);
+	}
+
+
 	/**
 	* Instance constructor
 	*
@@ -467,11 +480,14 @@ export default class Syncro {
 	*
 	* @param {Object} [options] Additional options to mutate behaviour
 	* @param {Object} [options.initalState] State to use if no state is already loaded, overrides the entities own `initState` function fetcher
+	* @param {Number} [options.retries=3] Number of times to retry if a mounted Syncro fails its sanity checks
 	* @returns {Promise<Syncro>} A promise which resolves as this syncro instance when completed
 	*/
 	mount(options) {
 		let settings = {
 			initialState: null,
+			retries: 5,
+			retryMinTime: 250,
 			...options,
 		};
 
@@ -479,54 +495,67 @@ export default class Syncro {
 		let reactive; // Eventual response from reactive() with the intitial value
 		let doc; // Eventual Firebase document
 
-		return Promise.resolve()
-			.then(()=> this.setHeartbeat(false)) // Disable any existing heartbeat - this only really applies if we're changing path for some reason
-			.then(async ()=> { // Set up binding and wait for it to come ready
-				this.docRef = FirestoreDocRef(Syncro.firestore, fsCollection, fsId);
-
-				// Initalize state
-				let initialState = await this.getFirestoreState();
-
-				// Construct a reactive component
-				reactive = this.getReactive(initialState);
-				if (!reactive.doc || !reactive.setState || !reactive.getState || !reactive.watch) throw new Error('Syncro.getReactive() requires a returned `doc`, `setState()`, `getState()` + `watch()`');
-				this.value = doc = reactive.doc;
-
-				this.debug('Initial state', {doc});
-
-				// Subscribe to remote updates
-				this._destroyActions.push( // Add the unsubscribe handle to the list of destroyAction promises we call on `destroy()`
-					FirestoreOnSnapshot(this.docRef, snapshot => {
-						let snapshotData = Syncro.fromFirestore(snapshot.data());
-						this.debug('Incoming snapshot', {snapshotData});
-						reactive.setState(snapshotData);
-					})
-				);
-			})
-			.then(()=> { // Optionally create the doc if it has no content
-				if (!isEmpty(doc)) { // Doc already has content - skip
-					return;
-				} else if (settings.initialState) { // Provided an intiailState - use that instead of the entities own method
-					this.debug('Populate initial Syncro state (from provided initialState)');
-					return this.setFirestoreState(settings.initialState, {method: 'set'});
-				} else {
-					this.debug(`Populate initial Syncro state (from "${entity}" Syncro worker)`);
-
-					return fetch(`${this.config.syncroRegistryUrl}/${this.path}`)
-						.then(response => response.ok || Promise.reject(`Failed to check Syncro "${fsCollection}::${fsId}" status - ${response.statusText}`))
-				}
-			})
-			.then(()=> { // Setup local state watcher
-				reactive.watch(throttle(newState => {
-					this.debug('Local change', {newState});
-					this.markDirty();
-					this.setFirestoreState(newState, {method: 'merge'});
-				}, this.throttle));
-			})
-			.then(()=> this.setHeartbeat(true, {
-				immediate: true,
-			}))
-			.then(()=> this)
+		return PromiseRetry(
+			()=> Promise.resolve()
+				.then(()=> this.setHeartbeat(false)) // Disable any existing heartbeat - this only really applies if we're changing path for some reason
+				.then(async ()=> { // Set up binding and wait for it to come ready
+					this.docRef = FirestoreDocRef(Syncro.firestore, fsCollection, fsId);
+
+					// Initalize state
+					let initialState = await this.getFirestoreState();
+
+					// Construct a reactive component
+					reactive = this.getReactive(initialState);
+					if (!reactive.doc || !reactive.setState || !reactive.getState || !reactive.watch) throw new Error('Syncro.getReactive() requires a returned `doc`, `setState()`, `getState()` + `watch()`');
+					this.value = doc = reactive.doc;
+
+					this.debug('Initial state', {doc});
+
+					// Subscribe to remote updates
+					this._destroyActions.push( // Add the unsubscribe handle to the list of destroyAction promises we call on `destroy()`
+						FirestoreOnSnapshot(this.docRef, snapshot => {
+							let snapshotData = Syncro.fromFirestore(snapshot.data());
+							this.debug('Incoming snapshot', {snapshotData});
+							reactive.setState(snapshotData);
+						})
+					);
+				})
+				.then(()=> { // Optionally create the doc if it has no content
+					if (!isEmpty(doc)) { // Doc already has content - skip
+						return;
+					} else if (settings.initialState) { // Provided an intiailState - use that instead of the entities own method
+						this.debug('Populate initial Syncro state (from provided initialState)');
+						return this.setFirestoreState(settings.initialState, {method: 'set'});
+					} else {
+						this.debug(`Populate initial Syncro state (from "${entity}" Syncro worker)`);
+
+						return fetch(`${this.config.syncroRegistryUrl}/${this.path}`)
+							.then(response => response.ok || Promise.reject(`Failed to check Syncro "${fsCollection}::${fsId}" status - ${response.statusText}`))
+					}
+				})
+				.then(()=> { // Setup local state watcher
+					reactive.watch(throttle(newState => {
+						this.debug('Local change', {newState});
+						this.markDirty();
+						this.setFirestoreState(newState, {method: 'merge'});
+					}, this.throttle));
+				})
+				.then(()=> this.setHeartbeat(true, {
+					immediate: true,
+				}))
+				.then(()=> this)
+				.catch(async (e) => {
+					await this.destroy();
+					throw e;
+				}),
+			{ // PromiseRetry / p-retry options
+				retries: settings.retries,
+				minTimeout: settings.retryMinTime,
+				randomize: true,
+				factor: 3,
+				onFailedAttempt: e => this.debugError(`[Attempt ${e.attemptNumber}/${e.attemptNumber + e.retriesLeft - 1}] to mount syncro`, e),
+			},
+		);
 	}
 
 

package/lib/terafy.server.js

@@ -1578,6 +1578,7 @@ export default class TeraFyServer {
 				close: false,
 				progress: 0,
 				progressMax: 0,
+				backdrop: true,
 				...options,
 			});
 		} else { // Merge options with existing uiProgress window
@@ -1595,7 +1596,7 @@ export default class TeraFyServer {
 			this._uiProgress.promise = this.requestFocus(()=>
 				app.service('$prompt').dialog({
 					title: this._uiProgress.options.title,
-					backdrop: this._uiProgress.options.backdrop, // pass backdrop to allow 'static' dialog
+					backdrop: this._uiProgress.options.backdrop ?? true, // pass backdrop to allow 'static' dialog
 					component: 'uiProgress',
 					componentProps: this._uiProgress.options,
 					closeable: false,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iebh/tera-fy",
-  "version": "2.0.14",
+  "version": "2.0.16",
   "description": "TERA website worker",
   "scripts": {
     "dev": "esbuild --platform=browser --format=esm --bundle lib/terafy.client.js --outfile=dist/terafy.js --minify --serve --servedir=.",
@@ -81,6 +81,7 @@
     "lodash-es": "^4.17.21",
     "mitt": "^3.0.1",
     "nanoid": "^5.1.2",
+    "p-retry": "^6.2.1",
     "release-it": "^18.1.2",
     "uuid": "^11.1.0"
   },