redis-memory-server 0.15.1 → 0.16.0

package/README.md

@@ -52,8 +52,6 @@ On install, this package auto-downloads and compiles version `stable` of the `re
 
 ### Requirements
 
-- NodeJS: 18+
-- Typescript: 3.8+ (if used)
 - `make`
 
 ### Windows
@@ -80,9 +78,9 @@ If this is a concern, either:
 1. specify a `version` other than `stable`
 2. forcibly update the `stable` binary on demand using a command like:
 ```bash
-REDISMS_IGNORE_DOWNLOAD_CACHE=1 yarn rebuild redis-memory-server
+REDISMS_IGNORE_DOWNLOAD_CACHE=true yarn rebuild redis-memory-server
 # OR
-REDISMS_IGNORE_DOWNLOAD_CACHE=1 npm rebuild redis-memory-server
+REDISMS_IGNORE_DOWNLOAD_CACHE=true npm rebuild redis-memory-server
 ```
 3. specify the `ignoreDownloadCache` option
    (NOTE: this will make installs/runs slower)
@@ -149,14 +147,16 @@ const redisServer = new RedisMemoryServer({
 ```sh
 REDISMS_DOWNLOAD_DIR=/path/to/redis/binaries # default target download directory
 REDISMS_VERSION=6.0.10 # default version to download
-REDISMS_IGNORE_DOWNLOAD_CACHE=1 # if you want to ignore already downloaded/installed binaries
-REDISMS_DEBUG=1 # debug mode, also available case-insensitive values: "on" "yes" "true"
+REDISMS_IGNORE_DOWNLOAD_CACHE=true
+REDISMS_DEBUG=true
 REDISMS_DOWNLOAD_MIRROR=host # your mirror host to download the redis binary
 REDISMS_DOWNLOAD_URL=url # full URL to download the redis binary
-REDISMS_DISABLE_POSTINSTALL=1 # if you want to skip download binaries on install
+REDISMS_DISABLE_POSTINSTALL=true
 REDISMS_SYSTEM_BINARY=/usr/local/bin/redis-server # if you want to use an existing binary already on your system.
 ```
 
+NOTE: Boolean-ish values can be any of these (case-insensitive): `true`, `on`, `yes`, `1`.
+
 ### Options which can be set via `package.json`
 
 You can also use `package.json` to configure the installation process.
@@ -168,15 +168,18 @@ Environment variables have higher priority than contents of `package.json` files
   "redisMemoryServer": {
     "downloadDir": "/path/to/redis/binaries",
     "version": "6.0.10",
-    "ignoreDownloadCache": "1",
-    "debug": "1",
+    "ignoreDownloadCache": true,
+    "debug": true,
     "downloadMirror": "url",
-    "disablePostinstall": "1",
-    "systemBinary": "/usr/local/bin/redis-server"
+    "disablePostinstall": true,
+    "systemBinary": "/usr/local/bin/redis-server",
+    "configProvider": "some-package/redisMemoryServerConfig.js"
   }
 }
 ```
 
+NOTE: Boolean-ish values can be any of these (case-insensitive): `true`, `"true"`, `"on"`, `"yes"`, `1`, `"1"`.
+
 By default, it starts looking for `package.json` files at `process.cwd()`.
 To change this:
 
@@ -186,6 +189,14 @@ import { findPackageJson } from 'redis-memory-server/lib/util/resolve-config';
 findPackageJson('/custom/path');
 ```
 
+The `configProvider` configuration can be used to dynamically load configurations from another package (e.g. `some-package/redisMemoryServerConfig.js`) or file (e.g. `./redisMemoryServerConfig.js`), where the target file looks like this:
+```js
+module.exports = {
+  version: '6.0.10',
+  // ...
+}
+```
+
 ### Simple test with `ioredis`
 
 Take a look at this [test file](https://github.com/mhassan1/redis-memory-server/blob/main/src/__tests__/singleDB-test.ts).
@@ -195,7 +206,7 @@ Take a look at this [test file](https://github.com/mhassan1/redis-memory-server/
 Debug mode can be enabled with an environment variable or in `package.json`:
 
 ```sh
-REDISMS_DEBUG=1 # also available case-insensitive values: "on", "yes", "true"
+REDISMS_DEBUG=true
 ```
 
 or
@@ -203,7 +214,7 @@ or
 ```json
 {
   "redisMemoryServer": {
-    "debug": "1"
+    "debug": true
   }
 }
 ```

package/lib/util/resolve-config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"resolve-config.d.ts","sourceRoot":"","sources":["../../src/util/resolve-config.ts"],"names":[],"mappings":"AAWA;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAEhE;AAKD;;;GAGG;AACH,wBAAgB,eAAe,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAwBxD;AAGD;;;GAGG;AACH,MAAM,CAAC,OAAO,UAAU,aAAa,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAM9E;AAED;;;GAGG;AACH,wBAAgB,SAAS,CAAC,GAAG,GAAE,MAAW,GAAG,OAAO,CAEnD"}
+{"version":3,"file":"resolve-config.d.ts","sourceRoot":"","sources":["../../src/util/resolve-config.ts"],"names":[],"mappings":"AAUA;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAEhE;AAKD;;;GAGG;AACH,wBAAgB,eAAe,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAiCxD;AAGD;;;GAGG;AACH,MAAM,CAAC,OAAO,UAAU,aAAa,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAM9E;AAED;;;GAGG;AACH,wBAAgB,SAAS,CAAC,GAAG,GAAE,MAAW,GAAG,OAAO,CAEnD"}

package/lib/util/resolve-config.js

@@ -11,7 +11,6 @@ const camelcase_1 = __importDefault(require("camelcase"));
 const find_package_json_1 = __importDefault(require("find-package-json"));
 const debug_1 = __importDefault(require("debug"));
 const path_1 = require("path");
-const lodash_defaultsdeep_1 = __importDefault(require("lodash.defaultsdeep"));
 const log = (0, debug_1.default)('RedisMS:ResolveConfig');
 const ENV_CONFIG_PREFIX = 'REDISMS_';
 const defaultValues = new Map();
@@ -30,7 +29,7 @@ let packageJsonConfig = {};
  * @param directory Set an custom directory to search the config in (default: process.cwd())
  */
 function findPackageJson(directory) {
-    const _packageJsonConfig = {};
+    let _packageJsonConfig = {};
     const finderIterator = (0, find_package_json_1.default)(directory || process.cwd());
     let foundPackageJson;
     while ((foundPackageJson = finderIterator.next())) {
@@ -40,13 +39,21 @@ function findPackageJson(directory) {
         const { value, filename } = foundPackageJson;
         log(`Found package.json at "${filename}"`);
         const ourConfig = (value === null || value === void 0 ? void 0 : value.redisMemoryServer) || {};
+        // resolve dynamic config
+        if (ourConfig.configProvider) {
+            const configProviderPath = require.resolve(ourConfig.configProvider, {
+                paths: [(0, path_1.dirname)(filename)],
+            });
+            // eslint-disable-next-line @typescript-eslint/no-require-imports
+            Object.assign(ourConfig, require(configProviderPath));
+        }
         // resolve relative paths
         for (const relativePathProp of ['downloadDir', 'systemBinary']) {
             if (ourConfig[relativePathProp]) {
                 ourConfig[relativePathProp] = (0, path_1.resolve)((0, path_1.dirname)(filename), ourConfig[relativePathProp]);
             }
         }
-        (0, lodash_defaultsdeep_1.default)(_packageJsonConfig, ourConfig);
+        _packageJsonConfig = Object.assign({}, ourConfig, _packageJsonConfig);
     }
     packageJsonConfig = _packageJsonConfig;
 }
@@ -56,8 +63,8 @@ findPackageJson();
  * @param variableName The variable to use
  */
 function resolveConfig(variableName) {
-    var _a, _b;
-    return ((_b = (_a = process.env[`${ENV_CONFIG_PREFIX}${variableName}`]) !== null && _a !== void 0 ? _a : packageJsonConfig === null || packageJsonConfig === void 0 ? void 0 : packageJsonConfig[(0, camelcase_1.default)(variableName)]) !== null && _b !== void 0 ? _b : defaultValues.get(variableName));
+    var _a, _b, _c;
+    return (_c = ((_b = (_a = process.env[`${ENV_CONFIG_PREFIX}${variableName}`]) !== null && _a !== void 0 ? _a : packageJsonConfig === null || packageJsonConfig === void 0 ? void 0 : packageJsonConfig[(0, camelcase_1.default)(variableName)]) !== null && _b !== void 0 ? _b : defaultValues.get(variableName))) === null || _c === void 0 ? void 0 : _c.toString();
 }
 /**
  * Convert "1, on, yes, true" to true (otherwise false)

package/lib/util/resolve-config.js.map

@@ -1 +1 @@
-{"version":3,"file":"resolve-config.js","sourceRoot":"","sources":["../../src/util/resolve-config.ts"],"names":[],"mappings":";;;;;AAiBA,0CAEC;AASD,0CAwBC;AAOD,gCAMC;AAMD,8BAEC;AAzED,0DAAkC;AAClC,0EAAuC;AACvC,kDAA0B;AAC1B,+BAAwC;AACxC,8EAA+C;AAE/C,MAAM,GAAG,GAAG,IAAA,eAAK,EAAC,uBAAuB,CAAC,CAAC;AAE3C,MAAM,iBAAiB,GAAG,UAAU,CAAC;AACrC,MAAM,aAAa,GAAG,IAAI,GAAG,EAAkB,CAAC;AAEhD;;;;;GAKG;AACH,SAAgB,eAAe,CAAC,GAAW,EAAE,KAAa;IACxD,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;AAChC,CAAC;AAED,IAAI,iBAAiB,GAEjB,EAAE,CAAC;AACP;;;GAGG;AACH,SAAgB,eAAe,CAAC,SAAkB;IAChD,MAAM,kBAAkB,GAAG,EAAE,CAAC;IAC9B,MAAM,cAAc,GAAG,IAAA,2BAAM,EAAC,SAAS,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;IAC1D,IAAI,gBAAgB,CAAC;IACrB,OAAO,CAAC,gBAAgB,GAAG,cAAc,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC;QAClD,IAAI,gBAAgB,CAAC,IAAI,EAAE,CAAC;YAC1B,MAAM;QACR,CAAC;QAED,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,gBAAgB,CAAC;QAE7C,GAAG,CAAC,0BAA0B,QAAQ,GAAG,CAAC,CAAC;QAC3C,MAAM,SAAS,GAAG,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,iBAAiB,KAAI,EAAE,CAAC;QAEjD,yBAAyB;QACzB,KAAK,MAAM,gBAAgB,IAAI,CAAC,aAAa,EAAE,cAAc,CAAC,EAAE,CAAC;YAC/D,IAAI,SAAS,CAAC,gBAAgB,CAAC,EAAE,CAAC;gBAChC,SAAS,CAAC,gBAAgB,CAAC,GAAG,IAAA,cAAO,EAAC,IAAA,cAAO,EAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,gBAAgB,CAAC,CAAC,CAAC;YACxF,CAAC;QACH,CAAC;QAED,IAAA,6BAAY,EAAC,kBAAkB,EAAE,SAAS,CAAC,CAAC;IAC9C,CAAC;IACD,iBAAiB,GAAG,kBAAkB,CAAC;AACzC,CAAC;AACD,eAAe,EAAE,CAAC;AAElB;;;GAGG;AACH,SAAwB,aAAa,CAAC,YAAoB;;IACxD,OAAO,CACL,MAAA,MAAA,OAAO,CAAC,GAAG,CAAC,GAAG,iBAAiB,GAAG,YAAY,EAAE,CAAC,mCAClD,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,CAAG,IAAA,mBAAS,EAAC,YAAY,CAAC,CAAC,mCAC5C,aAAa,CAAC,GAAG,CAAC,YAAY,CAAC,CAChC,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,SAAgB,SAAS,CAAC,MAAc,EAAE;IACxC,OAAO,CAAC,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;AACtE,CAAC;AAED,0CAA0C;AAC1C,IAAI,SAAS,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;IACtC,eAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;AAC5B,CAAC"}
+{"version":3,"file":"resolve-config.js","sourceRoot":"","sources":["../../src/util/resolve-config.ts"],"names":[],"mappings":";;;;;AAgBA,0CAEC;AASD,0CAiCC;AAOD,gCAMC;AAMD,8BAEC;AAjFD,0DAAkC;AAClC,0EAAuC;AACvC,kDAA0B;AAC1B,+BAAwC;AAExC,MAAM,GAAG,GAAG,IAAA,eAAK,EAAC,uBAAuB,CAAC,CAAC;AAE3C,MAAM,iBAAiB,GAAG,UAAU,CAAC;AACrC,MAAM,aAAa,GAAG,IAAI,GAAG,EAAkB,CAAC;AAEhD;;;;;GAKG;AACH,SAAgB,eAAe,CAAC,GAAW,EAAE,KAAa;IACxD,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;AAChC,CAAC;AAED,IAAI,iBAAiB,GAEjB,EAAE,CAAC;AACP;;;GAGG;AACH,SAAgB,eAAe,CAAC,SAAkB;IAChD,IAAI,kBAAkB,GAAG,EAAE,CAAC;IAC5B,MAAM,cAAc,GAAG,IAAA,2BAAM,EAAC,SAAS,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;IAC1D,IAAI,gBAAgB,CAAC;IACrB,OAAO,CAAC,gBAAgB,GAAG,cAAc,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC;QAClD,IAAI,gBAAgB,CAAC,IAAI,EAAE,CAAC;YAC1B,MAAM;QACR,CAAC;QAED,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,gBAAgB,CAAC;QAE7C,GAAG,CAAC,0BAA0B,QAAQ,GAAG,CAAC,CAAC;QAC3C,MAAM,SAAS,GAAG,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,iBAAiB,KAAI,EAAE,CAAC;QAEjD,yBAAyB;QACzB,IAAI,SAAS,CAAC,cAAc,EAAE,CAAC;YAC7B,MAAM,kBAAkB,GAAG,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,cAAc,EAAE;gBACnE,KAAK,EAAE,CAAC,IAAA,cAAO,EAAC,QAAQ,CAAC,CAAC;aAC3B,CAAC,CAAC;YACH,iEAAiE;YACjE,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC;QACxD,CAAC;QAED,yBAAyB;QACzB,KAAK,MAAM,gBAAgB,IAAI,CAAC,aAAa,EAAE,cAAc,CAAC,EAAE,CAAC;YAC/D,IAAI,SAAS,CAAC,gBAAgB,CAAC,EAAE,CAAC;gBAChC,SAAS,CAAC,gBAAgB,CAAC,GAAG,IAAA,cAAO,EAAC,IAAA,cAAO,EAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,gBAAgB,CAAC,CAAC,CAAC;YACxF,CAAC;QACH,CAAC;QAED,kBAAkB,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,SAAS,EAAE,kBAAkB,CAAC,CAAC;IACxE,CAAC;IACD,iBAAiB,GAAG,kBAAkB,CAAC;AACzC,CAAC;AACD,eAAe,EAAE,CAAC;AAElB;;;GAGG;AACH,SAAwB,aAAa,CAAC,YAAoB;;IACxD,OAAO,MAAA,CACL,MAAA,MAAA,OAAO,CAAC,GAAG,CAAC,GAAG,iBAAiB,GAAG,YAAY,EAAE,CAAC,mCAClD,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,CAAG,IAAA,mBAAS,EAAC,YAAY,CAAC,CAAC,mCAC5C,aAAa,CAAC,GAAG,CAAC,YAAY,CAAC,CAChC,0CAAE,QAAQ,EAAE,CAAC;AAChB,CAAC;AAED;;;GAGG;AACH,SAAgB,SAAS,CAAC,MAAc,EAAE;IACxC,OAAO,CAAC,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;AACtE,CAAC;AAED,0CAA0C;AAC1C,IAAI,SAAS,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;IACtC,eAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;AAC5B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "redis-memory-server",
-  "version": "0.15.1",
+  "version": "0.16.0",
   "description": "Redis Server for testing. The server will allow you to connect your favorite client library to the Redis Server and run parallel integration tests isolated from each other.",
   "bin": "bin/index.js",
   "main": "lib/index.js",
@@ -39,7 +39,6 @@
     "@types/ioredis": "^5.0.0",
     "@types/jest": "^30.0.0",
     "@types/lockfile": "^1.0.2",
-    "@types/lodash.defaultsdeep": "^4.6.7",
     "@types/node": "^18.11.9",
     "@types/rimraf": "^4.0.5",
     "@types/semver": "^7.5.0",
@@ -77,7 +76,6 @@
     "get-port": "^5.1.1",
     "https-proxy-agent": "^7.0.0",
     "lockfile": "^1.0.4",
-    "lodash.defaultsdeep": "^4.6.1",
     "rimraf": "^5.0.1",
     "semver": "^7.5.3",
     "tar": "^7.5.4",

package/scripts/postinstall.js

@@ -29,7 +29,7 @@ rc.findPackageJson(process.env.INIT_CWD);
 
 const envDisablePostinstall = rc.default('DISABLE_POSTINSTALL');
 
-if (typeof envDisablePostinstall === 'string' && rc.envToBool(envDisablePostinstall)) {
+if (rc.envToBool(envDisablePostinstall)) {
   console.log('Download is skipped by REDISMS_DISABLE_POSTINSTALL variable');
   process.exit(0);
 }