@hitchy/plugin-odem-rest 0.4.9 → 0.5.0

package/index.js

@@ -1,31 +1,3 @@
-/**
- * (c) 2018 cepharum GmbH, Berlin, http://cepharum.de
- *
- * The MIT License (MIT)
- *
- * Copyright (c) 2018 cepharum GmbH
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- *
- * @author: cepharum
- */
-
 "use strict";
 
 const { posix: { resolve } } = require( "path" );
@@ -34,6 +6,9 @@ module.exports = function() {
 	const api = this;
 	const { runtime: { services: Services, models: Models }, utility: { case: Case } } = api;
 
+	const logDebug = api.log( "hitchy:odem:rest:debug" );
+	const logError = api.log( "hitchy:odem:rest:error" );
+
 	return {
 		policies() {
 			const { config: { model: modelConfig = {} } } = api;
@@ -67,8 +42,8 @@ module.exports = function() {
 			/**
 			 * Responds on failure in case of not having handled request before.
 			 *
-			 * @param {HitchyIncomingMessage} req request descriptor
-			 * @param {HitchyServerResponse} res response manager
+			 * @param {Hitchy.Core.IncomingMessage} req request descriptor
+			 * @param {Hitchy.Core.ServerResponse} res response manager
 			 * @param {function(error:?Error):void} next callback to invoke when finished
 			 * @returns {void}
 			 */
@@ -122,8 +97,8 @@ module.exports = function() {
 		/**
 		 * Handles request for listing schemata of all available models.
 		 *
-		 * @param {HitchyIncomingMessage} req request descriptor
-		 * @param {HitchyServerResponse} res response manager
+		 * @param {Hitchy.Core.IncomingMessage} req request descriptor
+		 * @param {Hitchy.Core.ServerResponse} res response manager
 		 * @returns {void}
 		 */
 		function reqFetchSchemata( req, res ) {
@@ -201,8 +176,8 @@ module.exports = function() {
 		/**
 		 * Responds on success.
 		 *
-		 * @param {HitchyIncomingMessage} req request descriptor
-		 * @param {HitchyServerResponse} res response manager
+		 * @param {Hitchy.Core.IncomingMessage} req request descriptor
+		 * @param {Hitchy.Core.ServerResponse} res response manager
 		 * @returns {void}
 		 */
 		function reqSuccess( req, res ) {
@@ -229,12 +204,12 @@ module.exports = function() {
 		/**
 		 * Handles request for fetching schema of selected model.
 		 *
-		 * @param {HitchyIncomingMessage} req description of request
-		 * @param {HitchyServerResponse} res API for creating response
+		 * @param {Hitchy.Core.IncomingMessage} req description of request
+		 * @param {Hitchy.Core.ServerResponse} res API for creating response
 		 * @returns {void}
 		 */
 		function reqFetchSchema( req, res ) {
-			this.api.log( "hitchy:odem:rest" )( "got request fetching schema" );
+			logDebug( "got request fetching schema" );
 
 			if ( !Services.OdemRestSchema.mayBeExposed( req, Model ) ) {
 				res.status( 403 ).json( { error: "access forbidden by model" } );
@@ -248,12 +223,12 @@ module.exports = function() {
 		 * Handles request for checking whether some selected item of model exists
 		 * or not.
 		 *
-		 * @param {HitchyIncomingMessage} req description of request
-		 * @param {HitchyServerResponse} res API for creating response
+		 * @param {Hitchy.Core.IncomingMessage} req description of request
+		 * @param {Hitchy.Core.ServerResponse} res API for creating response
 		 * @returns {Promise|undefined} promises request processed successfully
 		 */
 		function reqCheckItem( req, res ) {
-			this.api.log( "hitchy:odem:rest" )( "got request checking if some item exists" );
+			logDebug( "got request checking if some item exists" );
 
 			if ( !Schema.mayBeExposed( req, Model ) ) {
 				res.status( 403 ).json( { error: "access forbidden by model" } );
@@ -273,7 +248,7 @@ module.exports = function() {
 					res.status( exists ? 200 : 404 ).send();
 				} )
 				.catch( error => {
-					this.api.log( "hitchy:odem:rest" )( "checking %s:", routeName, error );
+					logError( "checking %s:", routeName, error );
 					res.status( 500 ).json( { error: error.message } );
 				} );
 		}
@@ -281,12 +256,12 @@ module.exports = function() {
 		/**
 		 * Handles request for fetching data of selected item.
 		 *
-		 * @param {HitchyIncomingMessage} req description of request
-		 * @param {HitchyServerResponse} res API for creating response
+		 * @param {Hitchy.Core.IncomingMessage} req description of request
+		 * @param {Hitchy.Core.ServerResponse} res API for creating response
 		 * @returns {Promise} promises request processed successfully
 		 */
 		function reqFetchItem( req, res ) {
-			this.api.log( "hitchy:odem:rest" )( "got request fetching some item" );
+			logDebug( "got request fetching some item" );
 
 			if ( !Schema.mayBeExposed( req, Model ) ) {
 				res.status( 403 ).json( { error: "access forbidden by model" } );
@@ -302,9 +277,10 @@ module.exports = function() {
 			const item = new Model( uuid ); // eslint-disable-line new-cap
 
 			return item.load()
-				.then( loaded => res.json( loaded.toObject() ) )
+				.then( loaded => res.json( loaded.toObject( { serialized: true } ) ) )
 				.catch( error => {
-					this.api.log( "hitchy:odem:rest" )( "fetching %s:", routeName, error );
+					logError( "fetching %s:", routeName, error );
+
 					switch ( error.code ) {
 						case "ENOENT" : {
 							res.status( 404 ).json( { error: "selected item not found" } );
@@ -321,12 +297,12 @@ module.exports = function() {
 		 * Fetches items of a collection optionally required to match some provided
 		 * query.
 		 *
-		 * @param {HitchyIncomingMessage} req incoming request
-		 * @param {HitchyServerResponse} res response controller
+		 * @param {Hitchy.Core.IncomingMessage} req incoming request
+		 * @param {Hitchy.Core.ServerResponse} res response controller
 		 * @returns {Promise} promises response sent
 		 */
 		function reqFetchItems( req, res ) {
-			this.api.log( "hitchy:odem:rest" )( "got request fetching items" );
+			logDebug( "got request fetching items" );
 
 			if ( !Schema.mayBeExposed( req, Model ) ) {
 				res.status( 403 ).json( { error: "access forbidden by model" } );
@@ -376,12 +352,12 @@ module.exports = function() {
 		/**
 		 * Handles request for listing all items of model.
 		 *
-		 * @param {HitchyIncomingMessage} req description of request
-		 * @param {HitchyServerResponse} res API for creating response
+		 * @param {Hitchy.Core.IncomingMessage} req description of request
+		 * @param {Hitchy.Core.ServerResponse} res API for creating response
 		 * @returns {Promise|undefined} promises request processed successfully
 		 */
 		function reqListMatches( req, res ) {
-			this.api.log( "hitchy:odem:rest" )( "got request listing matching items" );
+			logDebug( "got request listing matching items" );
 
 			if ( !Schema.mayBeExposed( req, Model ) ) {
 				res.status( 403 ).json( { error: "access forbidden by model" } );
@@ -409,7 +385,7 @@ module.exports = function() {
 			} )
 				.then( matches => {
 					const result = {
-						items: matches.map( m => m.toObject() ),
+						items: matches.map( m => m.toObject( { serialized: true } ) ),
 					};
 
 					if ( meta ) {
@@ -420,7 +396,8 @@ module.exports = function() {
 					res.json( result );
 				} )
 				.catch( error => {
-					this.api.log( "hitchy:odem:rest" )( "querying %s:", routeName, error );
+					logError( "querying %s:", routeName, error );
+
 					res.status( 500 ).json( { error: error.message } );
 				} );
 		}
@@ -429,12 +406,12 @@ module.exports = function() {
 		 * Handles request for listing all items of model matching single given
 		 * condition.
 		 *
-		 * @param {HitchyIncomingMessage} req description of request
-		 * @param {HitchyServerResponse} res API for creating response
+		 * @param {Hitchy.Core.IncomingMessage} req description of request
+		 * @param {Hitchy.Core.ServerResponse} res API for creating response
 		 * @returns {Promise|undefined} promises request processed successfully
 		 */
 		function reqListAll( req, res ) {
-			this.api.log( "hitchy:odem:rest" )( "got request listing all items" );
+			logDebug( "got request listing all items" );
 
 			if ( !Schema.mayBeExposed( req, Model ) ) {
 				res.status( 403 ).json( { error: "access forbidden by model" } );
@@ -451,7 +428,7 @@ module.exports = function() {
 			}, { loadRecords, metaCollector: meta } )
 				.then( matches => {
 					const result = {
-						items: matches.map( m => m.toObject() ),
+						items: matches.map( m => m.toObject( { serialized: true } ) ),
 					};
 
 					if ( meta ) {
@@ -462,7 +439,8 @@ module.exports = function() {
 					res.json( result );
 				} )
 				.catch( error => {
-					this.api.log( "hitchy:odem:rest" )( "listing %s:", routeName, error );
+					logError( "listing %s:", routeName, error );
+
 					res.status( 500 ).json( { error: error.message } );
 				} );
 		}
@@ -470,12 +448,12 @@ module.exports = function() {
 		/**
 		 * Handles request for adding new item.
 		 *
-		 * @param {HitchyIncomingMessage} req description of request
-		 * @param {HitchyServerResponse} res API for creating response
+		 * @param {Hitchy.Core.IncomingMessage} req description of request
+		 * @param {Hitchy.Core.ServerResponse} res API for creating response
 		 * @returns {Promise|undefined} promises request processed successfully
 		 */
 		function reqCreateItem( req, res ) {
-			this.api.log( "hitchy:odem:rest" )( "got request creating item" );
+			logDebug( "got request creating item" );
 
 			if ( !Schema.mayBeExposed( req, Model ) ) {
 				res.status( 403 ).json( { error: "access forbidden by model" } );
@@ -487,7 +465,7 @@ module.exports = function() {
 			return ( req.method === "GET" ? Promise.resolve( req.query ) : req.fetchBody() )
 				.then( record => {
 					if ( record.uuid ) {
-						this.api.log( "hitchy:odem:rest" )( "creating %s:", routeName, "new entry can not be created with uuid" );
+						logDebug( "creating %s:", routeName, "new entry can not be created with uuid" );
 						res.status( 400 ).json( { error: "new entry can not be created with uuid" } );
 						return undefined;
 					}
@@ -511,12 +489,12 @@ module.exports = function() {
 					}
 
 					return item.save().then( saved => {
-						this.api.log( "hitchy:odem:rest" )( "created %s with %s", routeName, saved.uuid );
+						logDebug( "created %s with %s", routeName, saved.uuid );
 						res.status( 201 ).json( { uuid: saved.uuid } );
 					} );
 				} )
 				.catch( error => {
-					this.api.log( "hitchy:odem:rest" )( "creating %s:", routeName, error );
+					logError( "creating %s:", routeName, error );
 					res.status( 500 ).json( { error: error.message } );
 				} );
 		}
@@ -524,12 +502,12 @@ module.exports = function() {
 		/**
 		 * Handles request for updating properties of a selected item.
 		 *
-		 * @param {HitchyIncomingMessage} req description of request
-		 * @param {HitchyServerResponse} res API for creating response
+		 * @param {Hitchy.Core.IncomingMessage} req description of request
+		 * @param {Hitchy.Core.ServerResponse} res API for creating response
 		 * @returns {Promise|undefined} promises request processed successfully
 		 */
 		function reqModifyItem( req, res ) {
-			this.api.log( "hitchy:odem:rest" )( "got request to modify some item" );
+			logDebug( "got request to modify some item" );
 
 			if ( !Schema.mayBeExposed( req, Model ) ) {
 				res.status( 403 ).json( { error: "access forbidden by model" } );
@@ -557,6 +535,7 @@ module.exports = function() {
 					] )
 						.then( ( [ loaded, record ] ) => {
 							if ( record ) {
+								// FIXME consider using Odem's Model.fromObject() method here
 								const names = Object.keys( record );
 								const numNames = names.length;
 
@@ -567,21 +546,21 @@ module.exports = function() {
 									const name = names[i];
 
 									if ( definedProps[name] ) {
-										loaded.$properties[name] = record[name];
+										loaded.$properties[name] = record[name]; // eslint-disable-line no-param-reassign
 									} else if ( definedComputed[name] ) {
-										loaded[name] = record[name];
+										loaded[name] = record[name]; // eslint-disable-line no-param-reassign
 									}
 								}
 							}
 
 							return loaded.save()
 								.then( saved => {
-									res.json( saved.toObject() );
+									res.json( saved.toObject( { serialized: true } ) );
 								} );
 						} );
 				} )
 				.catch( error => {
-					this.api.log( "hitchy:odem:rest" )( "updating %s:", routeName, error );
+					logError( "updating %s:", routeName, error );
 					res.status( 500 ).json( { error: error.message } );
 				} );
 		}
@@ -590,12 +569,12 @@ module.exports = function() {
 		/**
 		 * Handles request for updating properties of a selected item.
 		 *
-		 * @param {HitchyIncomingMessage} req description of request
-		 * @param {HitchyServerResponse} res API for creating response
+		 * @param {Hitchy.Core.IncomingMessage} req description of request
+		 * @param {Hitchy.Core.ServerResponse} res API for creating response
 		 * @returns {Promise|undefined} promises request processed successfully
 		 */
 		function reqReplaceItem( req, res ) {
-			this.api.log( "hitchy:odem:rest" )( "got request replacing some item" );
+			logDebug( "got request replacing some item" );
 
 			if ( !Schema.mayBeExposed( req, Model ) ) {
 				res.status( 403 ).json( { error: "access forbidden by model" } );
@@ -651,7 +630,7 @@ module.exports = function() {
 					res.json( { uuid: saved.uuid } );
 				} )
 				.catch( error => {
-					this.api.log( "hitchy:odem:rest" )( "updating %s:", routeName, error );
+					logError( "updating %s:", routeName, error );
 					res.status( 500 ).json( { error: error.message } );
 				} );
 		}
@@ -659,12 +638,12 @@ module.exports = function() {
 		/**
 		 * Handles request for removing selected item.
 		 *
-		 * @param {HitchyIncomingMessage} req description of request
-		 * @param {HitchyServerResponse} res API for creating response
+		 * @param {Hitchy.Core.IncomingMessage} req description of request
+		 * @param {Hitchy.Core.ServerResponse} res API for creating response
 		 * @returns {Promise|undefined} promises request processed successfully
 		 */
 		function reqRemoveItem( req, res ) {
-			this.api.log( "hitchy:odem:rest" )( "got request removing some item" );
+			logDebug( "got request removing some item" );
 
 			if ( !Schema.mayBeExposed( req, Model ) ) {
 				res.status( 403 ).json( { error: "access forbidden by model" } );
@@ -689,12 +668,12 @@ module.exports = function() {
 								action: "remove"
 							} ) )
 							.catch( error => {
-								this.api.log( "hitchy:odem:rest" )( "removing %s:", routeName, error );
+								logError( "removing %s:", routeName, error );
 								res.status( 500 ).json( { error: error.message } );
 							} );
 					}
 
-					this.api.log( "hitchy:odem:rest" )( "request for removing missing %s ignored", routeName );
+					logError( "request for removing missing %s ignored", routeName );
 					res.status( 404 ).json( { error: "no such entry" } );
 
 					return undefined;

package/package.json

@@ -1,11 +1,12 @@
 {
 	"name": "@hitchy/plugin-odem-rest",
-	"version": "0.4.9",
+	"version": "0.5.0",
 	"description": "HTTP REST API for Hitchy's ODM",
 	"main": "index.js",
 	"scripts": {
 		"lint": "eslint .",
-		"test": "hitchy-pm odem --exec mocha --ui=tdd test/**/*.js"
+		"test": "hitchy-pm odem --exec mocha --ui=tdd 'test/scripts/**/*.js'",
+		"coverage": "hitchy-pm odem --exec c8 mocha --ui=tdd 'test/scripts/**/*.js'"
 	},
 	"repository": "https://gitlab.com/hitchy/plugin-odem-rest.git",
 	"keywords": [
@@ -17,15 +18,16 @@
 	"bugs": "https://gitlab.com/hitchy/plugin-odem-rest/-/issues",
 	"homepage": "https://gitlab.com/hitchy/plugin-odem-rest#plugin-odem-rest",
 	"peerDependencies": {
-		"@hitchy/core": "^0.6.4",
-		"@hitchy/plugin-odem": "^0.5.7"
+		"@hitchy/core": "^0.6.18",
+		"@hitchy/plugin-odem": "^0.7.0"
 	},
 	"devDependencies": {
-		"eslint": "^7.0.0",
-		"eslint-config-cepharum": "^1.0.11",
-		"eslint-plugin-promise": "^4.2.1",
-		"@hitchy/server-dev-tools": "^0.2.7",
-		"mocha": "^7.1.2",
+		"@hitchy/server-dev-tools": "^0.4.2",
+		"c8": "^7.11.0",
+		"eslint": "^8.13.0",
+		"eslint-config-cepharum": "^1.0.12",
+		"eslint-plugin-promise": "^6.0.0",
+		"mocha": "^9.2.2",
 		"should": "^13.2.3",
 		"should-http": "^0.1.1"
 	}