@ti-engine/core 1.2.3 → 1.2.4

package/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 This document will contain the list of changes made to the framework. The format is based on the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.
 
+## Version 1.2.4
+* feat(cache): expose the cache module as export in `package.json`
+* feat(cache): add method `hashDeleteField` to remove a hash-set field. This implements the `hdel` Redis command
+* fix(tools): optimize method `stringifyJSON` not to call unnecessary decycling of the value if it's not an object
+* fix(cache): replace `hmset` with `hset` Redis command in both methods that set hash-set values. Also remove unnecessary `_.isObjectLike` call in `hashSetFields` method
+
 ## Version 1.2.3
 * feat(start instance): add support for providing a custom path to the `.env` file to be used at service startup as process argument. Accepted arguments are `--env`, `--env-file`, `--dotenv`, `--dotenv-path`, and `-e`. The path itself should be relative to the working directory and should include the file name
 

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@ti-engine/core",
-  "version": "1.2.3",
+  "version": "1.2.4",
   "description": "The ti-engine is an open source, free to use—both for personal and commercial projects—framework for the creation of microservice-based solutions using node.js.",
   "author": "Boris Kostadinov <kostadinov.boris@gmail.com>",
   "license": "GPL-3.0-or-later",
   "exports": {
     ".": "./bin/start-instance.js",
+    "./cache": "./utils/cache.js",
     "./exceptions": "./utils/exceptions.js",
     "./localization": "./utils/localization.js",
     "./logger": "./utils/logger.js",

package/utils/cache.js

@@ -508,7 +508,7 @@ class CommonMemoryCache extends ConnectionObserver {
     hashSetField( key, name, value ) {
         return new Promise( ( resolve, reject ) => {
             if ( this.#isOperational === true ) {
-                let commandHashSetField = [ redis.cacheCommands.HASH_SET_MANY, key, name, tools.stringifyJSON( value ) ];
+                let commandHashSetField = [ redis.cacheCommands.HASH_SET, key, name, tools.stringifyJSON( value ) ];
                 this.#redisClient.executeCommands( [ commandHashSetField ] ).then( () => {
                     resolve();
                 } ).catch( ( error ) => {
@@ -535,10 +535,10 @@ class CommonMemoryCache extends ConnectionObserver {
     hashSetFields( key, fields ) {
         return new Promise( ( resolve, reject ) => {
             if ( this.#isOperational === true ) {
-                let commandHashSetFields = [ redis.cacheCommands.HASH_SET_MANY, key ];
+                let commandHashSetFields = [ redis.cacheCommands.HASH_SET, key ];
                 _.forEach( fields, ( field ) => {
                     commandHashSetFields.push( field.name );
-                    commandHashSetFields.push( _.isObjectLike( field.value ) ? tools.stringifyJSON( field.value ) : field.value );
+                    commandHashSetFields.push( tools.stringifyJSON( field.value ) );
                 } );
                 this.#redisClient.executeCommands( [ commandHashSetFields ] ).then( () => {
                     resolve();
@@ -576,6 +576,31 @@ class CommonMemoryCache extends ConnectionObserver {
         } );
     }
 
+    /**
+     * Used to remove a single field from a hash.
+     *
+     * @method
+     * @param {string} key
+     * @param {string} field
+     * @return {Promise<boolean>} Will return 'true' if the field was removed, 'false' otherwise.
+     * @public
+     */
+    hashDeleteField( key, field ) {
+        return new Promise( ( resolve, reject ) => {
+            if ( this.#isOperational === true ) {
+                let commandHashGetField = [ redis.cacheCommands.HASH_REMOVE, key, field ];
+                this.#redisClient.executeCommands( [ commandHashGetField ] ).then( ( results ) => {
+                    results = results[ 0 ];
+                    resolve( ( results && results.length > 1 ) ? tools.toBool( results[ 1 ] ) : false );
+                } ).catch( ( error ) => {
+                    reject( error );
+                } );
+            } else {
+                reject( exceptions.raise( exceptions.exceptionCode.E_GEN_SYSTEM_CACHE_UNAVAILABLE ) );
+            }
+        } );
+    }
+
     /**
      * Used to store a JSON variable.
      * <br/>

package/utils/exceptions.js

@@ -248,4 +248,4 @@ module.exports.raise = ( source, data, exceptionID ) => {
  */
 module.exports.isException = ( object ) => {
     return ( object instanceof Exception );
-};
+};

package/utils/tools.js

@@ -319,8 +319,7 @@ module.exports.retrocycle = ( $ ) => {
  * @public
  */
 module.exports.stringifyJSON = ( value ) => {
-    let transformed = module.exports.decycle( value );
-    return _.isObjectLike( transformed ) ? JSON.stringify( _.toPlainObject( transformed ) ) : value;
+    return _.isObjectLike( value ) ? JSON.stringify( _.toPlainObject( module.exports.decycle( value ) ) ) : value;
 };
 
 /**
@@ -537,4 +536,4 @@ class RetryPolicy {
 
 }
 
-module.exports.RetryPolicy = RetryPolicy;
+module.exports.RetryPolicy = RetryPolicy;