petty-cache 3.2.0 → 3.3.0

package/CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.3.0] - 2024-07-03
+### Changed
+- Added the ability for `pettyCache.fetch` to support async functions.
+
 ## [3.2.0] - 2021-04-05
 ### Changed
 - Upgraded `redis` version to `~3.1.0`.

package/README.md

@@ -1,7 +1,7 @@
 # petty-cache
 
-[![Build Status](https://github.com/mediocre/petty-cache/workflows/build/badge.svg)](https://github.com/mediocre/petty-cache/actions?query=workflow%3Abuild)
-[![Coverage Status](https://coveralls.io/repos/github/mediocre/petty-cache/badge.svg?branch=master)](https://coveralls.io/github/mediocre/petty-cache?branch=master)
+[![Build Status](https://github.com/mediocre/petty-cache/actions/workflows/continuousIntegration.yaml/badge.svg?branch=main)](https://github.com/mediocre/petty-cache/actions?query=workflow%3Abuild+branch%3Amain)
+[![Coverage Status](https://coveralls.io/repos/github/mediocre/petty-cache/badge.svg?branch=main)](https://coveralls.io/github/mediocre/petty-cache?branch=main)
 
 A cache module for Node.js that uses a two-level cache (in-memory cache for recently accessed data plus Redis for distributed caching) with automatic serialization plus some extra features to avoid cache stampedes and thundering herds.
 
@@ -75,7 +75,7 @@ pettyCache.bulkFetch(['a', 'b', 'c', 'd'], function(keys, callback) {
 
     keys.forEach(function(key) {
         results[key] = key.toUpperCase();
-    }
+    });
 
     callback(null, results);
 }, function(err, values) {
@@ -161,6 +161,16 @@ pettyCache.fetch('key', function(callback) {
 });
 ```
 
+```javascript
+pettyCache.fetch('key', async () => {
+    // This function is called on a cache miss
+    return await fs.readFile('file.txt');
+}, function(err, value) {
+    // This callback is called once petty-cache has loaded data from cache or executed the specified cache miss function
+    console.log(value);
+});
+```
+
 **Options**
 
 ```

package/index.js

@@ -1,3 +1,5 @@
+const util = require('util');
+
 const async = require('async');
 const lock = require('lock').Lock();
 const memoryCache = require('memory-cache');
@@ -322,7 +324,7 @@ function PettyCache() {
                             }
 
                             // Try to get value from Redis
-                            getFromRedis(key, function(err, result) {
+                            getFromRedis(key, async function(err, result) {
                                 if (err) {
                                     return callback(err);
                                 }
@@ -334,15 +336,27 @@ function PettyCache() {
                                 }
 
                                 // Execute the specified function and place the results in cache before returning the data
-                                func(function(err, data) {
-                                    if (err) {
-                                        return callback(err);
+                                if (util.types.isAsyncFunction(func)) {
+                                    try {
+                                        const data = await func();
+
+                                        _this.set(key, data, options, function(err) {
+                                            callback(err, data);
+                                        });
+                                    } catch(err) {
+                                        callback(err);
                                     }
-
-                                    _this.set(key, data, options, function(err) {
-                                        callback(err, data);
+                                } else {
+                                    func(function(err, data) {
+                                        if (err) {
+                                            return callback(err);
+                                        }
+
+                                        _this.set(key, data, options, function(err) {
+                                            callback(err, data);
+                                        });
                                     });
-                                });
+                                }
                             });
                         })(releaseRedisLock(function(err, result) {
                             if (result.error) {
@@ -406,7 +420,7 @@ function PettyCache() {
 
     this.get = function(key, callback) {
         // Try to get value from memory cache
-        var result = getFromMemoryCache(key);
+        let result = getFromMemoryCache(key);
 
         // Return value from memory cache if it exists
         if (result.exists) {

package/package.json

@@ -30,5 +30,5 @@
     "type": "git",
     "url": "https://github.com/mediocre/petty-cache.git"
   },
-  "version": "3.2.0"
+  "version": "3.3.0"
 }