@iebh/tera-fy 2.0.7 → 2.0.9

package/lib/syncro/entities.js

@@ -1,5 +1,6 @@
 import Reflib from '@iebh/reflib';
 import {v4 as uuid4} from 'uuid';
+import Syncro from './syncro.js';
 
 /**
 * Entities we support Syncro paths for, each should correspond directly with a Firebase/Firestore collection name
@@ -10,13 +11,10 @@ import {v4 as uuid4} from 'uuid';
 * @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} flushState Function called to flush state from Firebase to Supabase. Called the same as `initState` + `{state:Object}`
 */
-export default syncEntities = {
+export default {
 	projects: { // {{{
 		singular: 'project',
-		async initState({supabase, id, tera}) {
-			debugger; // FIXME: Check that `tera` gets populated
-			if (!tera) throw new Error('initState() for projects requires `{tera:app.service("$tera")}`');
-
+		async initState({supabase, id}) {
 			const result = await Syncro.wrapSupabase(supabase.from('projects')
 				.select('data')
 				.limit(1)
@@ -31,36 +29,32 @@ export default syncEntities = {
 			console.log('[MIGRATION] State of temp at start:', data.temp);
 
 			// Check if temp variable exists
-			if (!data.temp) return data;
-
-			let shownAlert = false;
-			for (const toolKey in data.temp) {
-				// Check if temp has already been set to file path
-				if (typeof data.temp[toolKey] !== 'object') {
-					console.log(`[MIGRATION] Skipping conversion of ${toolKey}, not an object:`, data.temp[toolKey])
-					return;
-				}
+			if (
+				!data.temp // Project contains no temp subkey
+				|| Object.values(data.temp).every(t => typeof t != 'object') // None of the temp keys are objects
+			) return data;
 
-				if (!shownAlert) {
-					shownAlert = true;
-					console.log('[MIGRATION] showing alert');
-					alert('Data found that will be migrated to new TERA file storage system. This may take a few minutes, please do not close your browser or refresh.');
-				}
+			throw new Error('Project data version unsupported');
 
-				// Create filename based on existing key
-				const toolName = toolKey.split('-')[0];
-				const fileName = `data-${toolName}-${nanoid()}.json`;
-				console.log('[MIGRATION] Creating filename:', fileName);
+			// MIGRATION - Move data.temp{} into Supabase files + add pointer to filename
+			await Promise.all(
+				Object.entries(data.temp)
+					.filter(([toolKey, branch]) => typeof branch == 'object')
+					.map(([toolKey, branch]) => {
+						console.log(`[MIGRATION] Converting data.temp[${toolKey}]...`);
 
-				// Create file, set contents and overwrite key
-				const projectFile = await tera.createProjectFile(fileName);
-				console.log('[MIGRATION] Setting file contents:', projectFile, 'to:', data.temp[toolKey]);
-				await projectFile.setContents(data.temp[toolKey])
-				console.log('[MIGRATION] Overwriting temp key with filepath:', fileName);
-				data.temp[toolKey] = fileName;
-			}
+						const toolName = toolKey.split('-')[0];
+						const fileName = `data-${toolName}-${nanoid()}.json`;
+						console.log('[MIGRATION] Creating filename:', fileName);
 
-			console.log("[MIGRATION] State of temp at end:", data.temp)
+						// FIXME: All of this needs converting over to a Cloudflare Worker compatible environment
+						/* const projectFile = await tera.createProjectFile(fileName);
+						console.log('[MIGRATION] Setting file contents:', projectFile, 'to:', data.temp[toolKey]);
+						await projectFile.setContents(data.temp[toolKey])
+						console.log('[MIGRATION] Overwriting temp key with filepath:', fileName);
+						data.temp[toolKey] = fileName; */
+					})
+			);
 
 			return data;
 		},

package/lib/syncro/keyed.js

@@ -1,6 +1,7 @@
 import {chunk} from 'lodash-es';
 import {doc as FirestoreDocRef, getDoc as FirestoreGetDoc} from 'firebase/firestore';
-import Syncro, {syncEntities} from './syncro.js';
+import Syncro from './syncro.js';
+import SyncroEntities from './entities.js';
 
 /**
 * @class SyncroKeyed
@@ -115,10 +116,10 @@ export default class SyncroKeyed extends Syncro {
 				this.debug('Populate initial SyncroKeyed state');
 
 				// Extract base data + add document and return new hook
-				if (!syncEntities[entity]) throw new Error(`Unknown Sync entity "${entity}"`);
+				if (!SyncroEntities[entity]) throw new Error(`Unknown Sync entity "${entity}"`);
 
 				// Go fetch the initial state object
-				let state = await syncEntities[entity].initState({
+				let state = await SyncroEntities[entity].initState({
 					supabase: Syncro.supabase,
 					fsCollection, fsId,
 					entity, id, relation,

package/lib/syncro/syncro.js

@@ -57,6 +57,15 @@ export default class Syncro {
 	static session;
 
 
+	/**
+	* OPTIONAL SyncroEntiries from './entiries.js' if its required
+	* This only gets populated if `config.forceLocalInit` is truthy and we've mounted at least one Syncro
+	*
+	* @type {Object}
+	*/
+	static SyncroEntities;
+
+
 	/**
 	* This instances fully formed string path
 	*
@@ -95,12 +104,12 @@ export default class Syncro {
 	*
 	* @type {Object}
 	* @property {Number} heartbeatinterval Time in milliseconds between heartbeat beacons
-	* @property {String} syncWorkerUrl The prefix Sync worker URL
+	* @property {String} syncroRegistryUrl The prefix Sync worker URL, used to populate Syncros and determine their active status
 	* @property {Object} context Additional named parameters to pass to callbacks like initState
 	*/
 	config = {
 		heartbeatInterval: 50_000, //~= 50s
-		syncWorkerUrl: 'https://tera-tools.com/api/sync',
+		syncroRegistryUrl: 'https://tera-tools.com/api/sync',
 		context: {},
 	};
 
@@ -245,7 +254,7 @@ export default class Syncro {
 		let extracted = { ...pathMatcher.exec(path)?.groups };
 
 		if (!extracted) throw new Error(`Invalid session path syntax "${path}"`);
-		if (!(extracted.entity in syncEntities)) throw new Error(`Unsupported entity "${path}" -> Entity="${extracted.entity}"`);
+		if (Syncro.SyncroEntities && !(extracted.entity in SyncroEntities)) throw new Error(`Unsupported entity "${path}" -> Entity="${extracted.entity}"`);
 
 		return {
 			...extracted,
@@ -300,6 +309,40 @@ export default class Syncro {
 	}
 
 
+	/**
+	* Convert a raw POJO into Firestore field layout
+	* Field structures are usually consumed by the Firestore ReST API and need converting before being used
+	* NOTE: This does not serialize the incoming data so you likely want to use this as `toFirestoreFields(toFirestore(data))`
+	*
+	* @see https://stackoverflow.com/a/62304377
+	* @param {Object} data The raw value to convert
+	* @returns {Object} A Firestore compatible, typed data structure
+	*/
+	static toFirestoreFields(data) {
+		const result = {};
+
+		for (const [key, value] of Object.entries(data)) {
+			const type = typeof value;
+
+			if (type === 'string') { // eslint-disable-line unicorn/prefer-switch
+				result[key] = { stringValue: value };
+			} else if (type === 'number') {
+				result[key] = { doubleValue: value };
+			} else if (type === 'boolean') {
+				result[key] = { booleanValue: value };
+			} else if (value === null) {
+				result[key] = { nullValue: null };
+			} else if (Array.isArray(value)) {
+				result[key] = { arrayValue: { values: value.map(item => Syncro.toFirestoreFields({ item }).item) } };
+			} else if (type === 'object') {
+				result[key] = { mapValue: { fields: Syncro.toFirestoreFields(value) } };
+			}
+		}
+
+		return result;
+	}
+
+
 	/**
 	* Convert a Firestore field dump into a native POJO
 	* Field structures are usually provided by the Firestore ReST API and need de-typing back into a native document
@@ -467,18 +510,10 @@ export default class Syncro {
 					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}" entity)`);
-
-					// Extract base data + add document and return new hook
-					return Promise.resolve()
-						.then(()=> syncEntities[entity] || Promise.reject(`Unknown Sync entity "${entity}"`))
-						.then(()=> syncEntities[entity].initState({
-							supabase: Syncro.supabase,
-							fsCollection, fsId,
-							entity, id, relation,
-							...this.config.context,
-						}))
-						.then(state => this.setFirestoreState(state, {method: 'set'})) // Send new base state to Firestore
+					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 "${path}" status - ${response.statusText}`))
 				}
 			})
 			.then(()=> { // Setup local state watcher
@@ -536,7 +571,7 @@ export default class Syncro {
 	async heartbeat() {
 		this.debug('heartbeat!');
 
-		await fetch(`${this.config.syncWorkerUrl}/${this.path}/heartbeat`, {
+		await fetch(`${this.config.syncroRegistryUrl}/${this.path}/heartbeat`, {
 			method: 'post',
 			headers: {
 				'Content-Type': 'application/json'
@@ -618,7 +653,7 @@ export default class Syncro {
 			...options,
 		};
 
-		return fetch(`${this.config.syncWorkerUrl}/${this.path}/flush` + (settings.destroy ? '?destroy=1' : ''))
+		return fetch(`${this.config.syncroRegistryUrl}/${this.path}/flush` + (settings.destroy ? '?destroy=1' : ''))
 			.then(response => response.ok ? null : Promise.reject(response.statusText || 'An error occured'))
 	}
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iebh/tera-fy",
-  "version": "2.0.7",
+  "version": "2.0.9",
   "description": "TERA website worker",
   "scripts": {
     "dev": "esbuild --platform=browser --format=esm --bundle lib/terafy.client.js --outfile=dist/terafy.js --minify --serve --servedir=.",
@@ -33,7 +33,7 @@
     "./projectFile": "./lib/projectFile.js",
     "./proxy": "./lib/terafy.proxy.js",
     "./server": "./lib/terafy.server.js",
-    "./syncro": "./lib/syncro.js",
+    "./syncro": "./lib/syncro/syncro.js",
     "./syncro/*": "./lib/syncro/*.js",
     "./plugins/*": "./plugins/*.js",
     "./widgets/*": "./widgets/*"
@@ -74,7 +74,6 @@
     "node": ">=18"
   },
   "dependencies": {
-    "@iebh/reflib": "^2.5.4",
     "@momsfriendlydevco/marshal": "^2.1.4",
     "detect-port": "^2.1.0",
     "filesize": "^10.1.6",
@@ -95,6 +94,7 @@
     "nodemon": "^3.1.9"
   },
   "peerDependencies": {
+    "@iebh/reflib": "^2.5.4",
     "@supabase/supabase-js": "^2.48.1",
     "firebase": "^11.3.1",
     "vue": "^3.0.0"