@akemona-org/strapi-hook-redis 3.7.0

package/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015-present Strapi Solutions SAS
+
+Portions of the Strapi software are licensed as follows:
+
+* All software that resides under an "ee/" directory (the “EE Software”), if that directory exists, is licensed under the license defined in "ee/LICENSE".
+
+* All software outside of the above-mentioned directories or restrictions above is available under the "MIT Expat" license as set forth below.
+
+MIT Expat License
+
+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.

package/README.md

@@ -0,0 +1,39 @@
+# strapi-redis
+
+[![npm version](https://img.shields.io/npm/v/strapi-redis.svg)](https://www.npmjs.org/package/strapi-redis)
+[![npm downloads](https://img.shields.io/npm/dm/strapi-redis.svg)](https://www.npmjs.org/package/strapi-redis)
+[![npm dependencies](https://david-dm.org/strapi/strapi-redis.svg)](https://david-dm.org/strapi/strapi-redis)
+[![Build status](https://travis-ci.org/strapi/strapi-redis.svg?branch=master)](https://travis-ci.org/strapi/strapi-redis)
+[![Slack status](https://slack.strapi.io/badge.svg)](https://slack.strapi.io)
+
+This built-in hook allows you to use [Redis](https://redis.io/) as a databases connection. Redis is an open source (BSD licensed), in-memory data structure store, used as a database, cache and message broker.
+
+---
+
+## Deprecation Warning :warning:
+
+Hello, we've some news to share!
+
+We released Strapi V4 in Q4 2021 and Strapi V3 will reach end-of-support around the end of Q3 2022.
+
+Since this package won't be ported in V4, we took the decision to deprecate it.
+
+If you’ve contributed to the development of this package, thank you again for that! We hope to see you on the V4 soon.
+
+The Akemona team
+
+---
+
+## Motivation
+
+We developed this hook to use Redis as cache database for our Strapi apps.
+
+## Resources
+
+- [License](LICENSE)
+
+## Links
+
+- [Strapi website](https://strapi.akemona.com/)
+- [Strapi community on Slack](https://slack.strapi.io)
+- [Strapi news on Twitter](https://twitter.com/strapijs)

package/lib/index.js

@@ -0,0 +1,165 @@
+'use strict';
+
+/**
+ * Module dependencies
+ */
+
+// Core
+const util = require('util');
+/* eslint-disable prefer-template */
+
+// Public node modules.
+const _ = require('lodash');
+const Redis = require('ioredis');
+const stackTrace = require('stack-trace');
+/**
+ * Redis hook
+ */
+
+module.exports = function(strapi) {
+  const hook = {
+    /**
+     * Default options
+     */
+
+    defaults: {
+      port: 6379,
+      host: 'localhost',
+      options: {
+        db: 0,
+      },
+      showFriendlyErrorStack: process.env.NODE_ENV !== 'production',
+    },
+
+    /**
+     * Initialize the hook
+     */
+
+    initialize: () => {
+      if (
+        _.isEmpty(strapi.models) ||
+        !_.pickBy(strapi.config.connections, {
+          connector: 'strapi-hook-redis',
+        })
+      ) {
+        return;
+      }
+
+      const connections = _.pickBy(strapi.config.connections, {
+        connector: 'strapi-hook-redis',
+      });
+
+      if (_.size(connections) === 0) {
+        return;
+      }
+
+      const done = _.after(_.size(connections), () => {
+        return;
+      });
+
+      // For each connection in the config register a new Knex connection.
+      _.forEach(connections, (connection, name) => {
+        // Apply defaults
+        _.defaults(connection.settings, strapi.config.hook.settings.redis);
+
+        const redis = new Redis(
+          _.defaultsDeep(
+            {
+              port: _.get(connection.settings, 'port'),
+              host: _.get(connection.settings, 'host'),
+              options: {
+                db: _.get(connection.options, 'database') || 0,
+              },
+            },
+            strapi.config.hook.settings.redis
+          )
+        );
+
+        redis.on('error', err => {
+          strapi.log.error(err);
+          process.exit(0);
+        });
+
+        // Utils function.
+        // Behavior: Try to retrieve data from Redis, if null
+        // execute callback and set the value in Redis for this serial key.
+        redis.cache = async ({ expired = 60 * 60, serial }, cb, type) => {
+          if (_.isEmpty(serial)) {
+            strapi.log.warn(
+              `Be careful, you're using cache() function of strapi-redis without serial`
+            );
+
+            const traces = stackTrace.get();
+
+            strapi.log.warn(
+              `> [${traces[1].getLineNumber()}] ${traces[1]
+                .getFileName()
+                .replace(strapi.config.appPath, '')}`
+            );
+
+            return await cb();
+          }
+
+          let cache = await redis.get(serial);
+
+          if (!cache) {
+            cache = await cb();
+
+            if (cache && _.get(connection, 'options.disabledCaching') !== true) {
+              switch (type) {
+                case 'json':
+                  redis.set(serial, JSON.stringify(cache), 'ex', expired);
+                  break;
+                case 'int':
+                default:
+                  redis.set(serial, cache, 'ex', expired);
+                  break;
+              }
+            }
+          }
+
+          switch (type) {
+            case 'int':
+              return parseInt(cache);
+            case 'float':
+              return _.toNumber(cache);
+            case 'json':
+              try {
+                return _.isObject(cache) ? cache : JSON.parse(cache);
+              } catch (e) {
+                return cache;
+              }
+            default:
+              return cache;
+          }
+        };
+
+        // Define as new connection.
+        strapi.connections[name] = redis;
+
+        // Expose global
+        if (_.get(connection, 'options.global') !== false) {
+          global[_.get(connection, 'options.globalName') || 'redis'] = redis;
+        }
+
+        if (_.get(connection, 'options.debug') === true) {
+          redis.monitor((err, monitor) => {
+            if (err) {
+              console.error(err);
+            }
+            // Entering monitoring mode.
+            monitor.on('monitor', (time, args) => {
+              console.log(time + ': ' + util.inspect(args));
+            });
+          });
+        }
+
+        redis.on('ready', () => {
+          done();
+        });
+      });
+    },
+  };
+
+  return hook;
+};

package/lib/utils/connectivity.js

@@ -0,0 +1,37 @@
+'use strict';
+
+// Public node modules
+const rimraf = require('rimraf');
+
+// Logger.
+const logger = require('@akemona-org/strapi-utils').logger;
+
+module.exports = (scope, success, error) => {
+  const Redis = require(`ioredis`);
+  const redis = new Redis({
+    port: scope.database.settings.port,
+    host: scope.database.settings.host,
+    password: scope.database.settings.password,
+    db: scope.database.settings.database,
+  });
+
+  redis.connect((err) => {
+    redis.disconnect();
+
+    if (err) {
+      logger.warn('Database connection has failed! Make sure your database is running.');
+      return error();
+    }
+
+    logger.info('The app has been connected to the database successfully!');
+
+    rimraf(scope.tmpPath, (err) => {
+      if (err) {
+        console.log(`Error removing connection test folder: ${scope.tmpPath}`);
+      }
+      logger.info('Copying the dashboard...');
+
+      success();
+    });
+  });
+};

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@akemona-org/strapi-hook-redis",
+  "publishConfig": {
+    "access": "public"
+  },
+  "version": "3.7.0",
+  "description": "Redis hook for the Strapi framework",
+  "homepage": "https://strapi.akemona.com",
+  "keywords": [
+    "redis",
+    "hook",
+    "memory",
+    "cache",
+    "strapi"
+  ],
+  "directories": {
+    "lib": "./lib"
+  },
+  "main": "./lib",
+  "dependencies": {
+    "@akemona-org/strapi-utils": "3.7.0",
+    "ioredis": "^4.27.1",
+    "lodash": "4.17.21",
+    "rimraf": "3.0.2",
+    "stack-trace": "0.0.10"
+  },
+  "author": {
+    "email": "strapi@akemona.com",
+    "name": "Akemona team",
+    "url": "https://strapi.akemona.com"
+  },
+  "maintainers": [
+    {
+      "name": "Akemona team",
+      "email": "strapi@akemona.com",
+      "url": "https://strapi.akemona.com"
+    }
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/akemona/strapi.git"
+  },
+  "bugs": {
+    "url": "https://github.com/akemona/strapi/issues"
+  },
+  "engines": {
+    "node": ">=10.16.0 <=14.x.x",
+    "npm": ">=6.0.0"
+  },
+  "license": "SEE LICENSE IN LICENSE",
+  "scripts": {
+    "test": "echo \"no tests yet\""
+  },
+  "gitHead": "129a8d6191b55810fd66448dcc47fee829df986c"
+}