@hitchy/plugin-odem-socket.io 0.3.0 → 0.4.0

package/api/services/odem/websocket-provider.js

@@ -1,8 +1,7 @@
-"use strict";
+import { promisify } from "node:util";
 
-const { promisify } = require( "node:util" );
-
-module.exports = function() {
+/** */
+export default function() {
 	const api = this;
 
 	const logDebug = api.log( "hitchy:plugin:odem:socket.io:debug" );
@@ -88,7 +87,7 @@ module.exports = function() {
 							.then( item => this.namespaceEmit( namespace, Model, {
 								change: "created",
 								model: Model.name,
-								properties: item.toObject( { serialized: true } ),
+								properties: this.serializeItem( item, false ),
 							}, true ) )
 							.catch( cause => {
 								logError( "broadcasting notification on having created item %s of %s has failed:", uuid, Model.name, cause.stack );
@@ -99,7 +98,7 @@ module.exports = function() {
 							.then( item => this.namespaceEmit( namespace, Model, {
 								change: "updated",
 								model: Model.name,
-								properties: item.toObject( { serialized: true } ),
+								properties: this.serializeItem( item, false ),
 							}, true ) )
 							.catch( cause => {
 								logError( "broadcasting notification on having updated item %s of %s has failed:", uuid, Model.name, cause.stack );
@@ -109,7 +108,7 @@ module.exports = function() {
 						this.namespaceEmit( namespace, Model, {
 							change: "deleted",
 							model: Model.name,
-							properties: { uuid: Model.formatUUID( uuid ) },
+							properties: { uuid: String( uuid ) },
 						}, false )
 							.catch( cause => {
 								logError( "broadcasting notification on having removed item %s of %s has failed:", uuid, Model.name, cause.stack );
@@ -353,7 +352,7 @@ module.exports = function() {
 				let filter;
 
 				if ( loadRecords ) {
-					filter = item => api.service.OdemSchema.filterItem( item.toObject( { serialized: true } ), { user }, Model, "list" );
+					filter = item => api.service.OdemSchema.filterItem( this.serializeItem( item, false ), { user }, Model, "list" );
 				} else {
 					filter = item => ( { uuid: item.uuid } );
 				}
@@ -405,7 +404,7 @@ module.exports = function() {
 				let filter;
 
 				if ( loadRecords ) {
-					filter = item => api.service.OdemSchema.filterItem( item.toObject( { serialized: true } ), { user }, Model, "list" );
+					filter = item => api.service.OdemSchema.filterItem( this.serializeItem( item, false ), { user }, Model, "list" );
 				} else {
 					filter = item => ( { uuid: item.uuid } );
 				}
@@ -434,7 +433,7 @@ module.exports = function() {
 		 * @returns {Promise<void>} promise settled on request handled
 		 */
 		static async handleCreateRequest( socket, Model, properties, response ) {
-			logDebug( "request for creating %s instance with %j", Model.name, properties );
+			logDebug( "request for creating %s instance with %j", Model.name, reduce( properties ) );
 
 			const { Authorization, OdemSchema } = api.service;
 
@@ -453,9 +452,9 @@ module.exports = function() {
 				const filtered = OdemSchema.filterItem( properties, { user }, Model, "create" );
 				const instance = new Model();
 
-				for ( const [ propName, propValue ] of Object.entries( filtered ) ) {
+				for ( const propName of Object.keys( filtered ) ) {
 					if ( schema.props.hasOwnProperty( propName ) || schema.computed.hasOwnProperty( propName ) ) {
-						instance[propName] = propValue;
+						instance[propName] = filtered[propName];
 					}
 				}
 
@@ -463,7 +462,7 @@ module.exports = function() {
 
 				response( {
 					success: true,
-					properties: OdemSchema.filterItem( instance.toObject( { serialized: true } ), { user }, Model, "read" ),
+					properties: OdemSchema.filterItem( this.serializeItem( instance, false ), { user }, Model, "read" ),
 				} );
 			} catch ( error ) {
 				logError( "creating %s instance failed: %s", Model.name, error.stack );
@@ -504,7 +503,7 @@ module.exports = function() {
 
 				response( {
 					success: true,
-					properties: api.service.OdemSchema.filterItem( instance.toObject( { serialized: true } ), { user }, Model, "read" ),
+					properties: api.service.OdemSchema.filterItem( this.serializeItem( instance, true ), { user }, Model, "read" ),
 				} );
 			} catch ( error ) {
 				logError( "reading %s instance failed: %s", Model.name, error.stack );
@@ -526,7 +525,7 @@ module.exports = function() {
 		 * @returns {Promise<void>} promise settled on request handled
 		 */
 		static async handleUpdateRequest( socket, Model, uuid, properties, response ) {
-			logDebug( "request for updating %s instance %s with %j", Model.name, uuid, properties );
+			logDebug( "request for updating %s instance %s with %j", Model.name, uuid, reduce( properties ) );
 
 			try {
 				const user = await this.getUserForSocket( socket );
@@ -556,7 +555,7 @@ module.exports = function() {
 
 				response( {
 					success: true,
-					properties: api.service.OdemSchema.filterItem( instance.toObject( { serialized: true } ), { user }, Model, "read" ),
+					properties: api.service.OdemSchema.filterItem( this.serializeItem( instance, false ), { user }, Model, "read" ),
 				} );
 			} catch ( error ) {
 				logError( "updating %s instance failed: %s", Model.name, error.stack );
@@ -607,6 +606,47 @@ module.exports = function() {
 				} );
 			}
 		}
+
+		/**
+		 * Serializes provided instance of a model optionally including/excluding
+		 * properties marked as _lazy_.
+		 *
+		 * This method is used to provide reduced sets of properties per item
+		 * on listing/updating items while delivering all properties when
+		 * reading individual items.
+		 *
+		 * @param {Hitchy.Plugin.Odem.Model} item instance of model
+		 * @param {boolean} includeLazyProperties if true, properties marked as lazy in schema of model are included with resulting record
+		 * @returns {object} record of provided item's serialized properties
+		 */
+		static serializeItem( item, includeLazyProperties = false ) {
+			const record = item.toObject( { serialized: true } );
+
+			if ( includeLazyProperties ) {
+				return record;
+			}
+
+			const filtered = {};
+
+			for ( const name of Object.keys( record ) ) {
+				let definition = item.constructor.schema.props[name];
+
+				if ( definition == null ) {
+					definition = item.constructor.schema.computed[name];
+				}
+
+				const lazy = definition?.lazy;
+
+				if ( !lazy ||
+				     ( typeof lazy === "string" && lazy !== "ws" && lazy !== "socket" && lazy !== "websocket" ) ||
+				     ( typeof lazy === "object" && !lazy.ws && !lazy.socket && !lazy.websocket )
+				) {
+					filtered[name] = record[name];
+				}
+			}
+
+			return filtered;
+		}
 	}
 
 	return OdemWebsocketProvider;
@@ -615,7 +655,7 @@ module.exports = function() {
 /**
  * Commonly responds to action requests in case of having disabled them.
  *
- * @param {function(response: any):void} respondFn callback to be invoked for responding to a peer event
+ * @param {function(any):void} respondFn callback to be invoked for responding to a peer event
  * @returns {void}
  */
 function reject( respondFn ) {
@@ -623,3 +663,42 @@ function reject( respondFn ) {
 		error: "requested action is not available due to runtime configuration",
 	} );
 }
+
+/**
+ * Recursively trims values of provided data.
+ *
+ * @param {*} data data to be trimmed
+ * @param {number} limit number of characters to keep in strings when trimming
+ * @returns {*} provided data trimmed as necessary
+ */
+function reduce( data, limit = 200 ) {
+	if ( Array.isArray( data ) ) {
+		return data.map( item => reduce( item, Math.max( 10, limit / 5 ) ) );
+	}
+
+	if ( data && typeof data === "object" ) {
+		const copy = {};
+
+		for ( const name of Object.keys( data ) ) {
+			copy[name] = reduce( data[name], Math.max( 10, limit / 5 ) );
+		}
+
+		return copy;
+	}
+
+	switch ( typeof data ) {
+		case "function" :
+		case "string" : {
+			const s = String( data );
+
+			if ( s.length > limit ) {
+				return s.substring( 0, limit ) + "…+" + String( limit - s.length );
+			}
+
+			return s;
+		}
+
+		default :
+			return data;
+	}
+}

package/config/socket.js

@@ -1,6 +1,4 @@
-"use strict";
-
-module.exports = {
+export default {
 	socket: {
 		odem: {
 			/**

package/index.js

@@ -1,6 +1,5 @@
-"use strict";
-
-module.exports = function() {
+/** */
+export default function() {
 	const api = this;
 
 	return {

package/package.json

@@ -1,12 +1,13 @@
 {
 	"name": "@hitchy/plugin-odem-socket.io",
-	"version": "0.3.0",
+	"version": "0.4.0",
 	"description": "exposing Hitchy's document-oriented database via websocket",
 	"main": "index.js",
+	"type": "module",
 	"scripts": {
 		"lint": "eslint .",
-		"test": "hitchy-pm odem socket.io auth --exec mocha --ui=tdd 'test/**/*.spec.js'",
-		"coverage": "hitchy-pm odem socket.io auth --exec c8 mocha --ui=tdd 'test/**/*.spec.js'"
+		"test": "hitchy-pm odem socket.io auth --exec mocha --ui=tdd test/**/*.spec.js",
+		"coverage": "hitchy-pm odem socket.io auth --exec c8 mocha --ui=tdd test/**/*.spec.js"
 	},
 	"repository": {
 		"type": "git",
@@ -29,18 +30,18 @@
 		"index.js"
 	],
 	"peerDependencies": {
-		"@hitchy/core": ">=0.8.1",
-		"@hitchy/plugin-odem": ">=0.9.1",
-		"@hitchy/plugin-socket.io": ">=0.1.1"
+		"@hitchy/core": "1.x",
+		"@hitchy/plugin-odem": "0.13.x",
+		"@hitchy/plugin-socket.io": "0.1.x"
 	},
 	"devDependencies": {
-		"@hitchy/server-dev-tools": "^0.4.9",
-		"c8": "^10.1.2",
-		"eslint": "^8.57.0",
-		"eslint-config-cepharum": "^1.0.14",
-		"eslint-plugin-promise": "^7.1.0",
-		"mocha": "^10.7.3",
+		"@hitchy/server-dev-tools": "^0.8.6",
+		"c8": "^10.1.3",
+		"eslint": "^9.23.0",
+		"eslint-config-cepharum": "^2.0.2",
+		"eslint-plugin-promise": "^7.2.1",
+		"mocha": "^11.1.0",
 		"should": "^13.2.3",
-		"socket.io-client": "^4.7.5"
+		"socket.io-client": "^4.8.1"
 	}
 }

package/readme.md

@@ -59,7 +59,7 @@ socket.on( "connect", () => {
 } );
 ```
 
-> socket.io requires all arguments to be provided no matter what. Thus, you can't omit any of the arguments given in examples below but have to provide values assumed to be default, at least. 
+> socket.io requires all arguments to be provided no matter what. Thus, you can not omit any of the arguments given in examples below but have to provide values assumed to be default, at least. 
 
 The following code excerpts are focusing on the inner part of emitting an action event and processing the response.