From b3252f956f3c24f99e2f17d1ebe81fc096ef21fc Mon Sep 17 00:00:00 2001 From: Naz Date: Mon, 13 Feb 2023 14:52:37 +0800 Subject: [PATCH] Added adapter-cache-redis package refs https://github.com/TryGhost/Toolbox/issues/515 - Redis-based caches can be used on hosted-environments to store information with high memory impact - when in-memory caches would be too impractical to use - This is a placeholder package for a cluster-aware Redis cache implementation compatible with Ghost's cache adapter interface (https://github.com/TryGhost/SDK/tree/a41d351f16cb2b934ce755f4464706c01d2078d8/packages/adapter-base-cache) --- ghost/adapter-cache-redis/.eslintrc.js | 6 +++++ ghost/adapter-cache-redis/README.md | 23 ++++++++++++++++ ghost/adapter-cache-redis/index.js | 1 + .../lib/adapter-cache-redis.js | 0 ghost/adapter-cache-redis/package.json | 26 +++++++++++++++++++ ghost/adapter-cache-redis/test/.eslintrc.js | 6 +++++ ghost/adapter-cache-redis/test/hello.test.js | 8 ++++++ 7 files changed, 70 insertions(+) create mode 100644 ghost/adapter-cache-redis/.eslintrc.js create mode 100644 ghost/adapter-cache-redis/README.md create mode 100644 ghost/adapter-cache-redis/index.js create mode 100644 ghost/adapter-cache-redis/lib/adapter-cache-redis.js create mode 100644 ghost/adapter-cache-redis/package.json create mode 100644 ghost/adapter-cache-redis/test/.eslintrc.js create mode 100644 ghost/adapter-cache-redis/test/hello.test.js diff --git a/ghost/adapter-cache-redis/.eslintrc.js b/ghost/adapter-cache-redis/.eslintrc.js new file mode 100644 index 0000000000..c9c1bcb522 --- /dev/null +++ b/ghost/adapter-cache-redis/.eslintrc.js @@ -0,0 +1,6 @@ +module.exports = { + plugins: ['ghost'], + extends: [ + 'plugin:ghost/node' + ] +}; diff --git a/ghost/adapter-cache-redis/README.md b/ghost/adapter-cache-redis/README.md new file mode 100644 index 0000000000..a400086088 --- /dev/null +++ b/ghost/adapter-cache-redis/README.md @@ -0,0 +1,23 @@ +# Adapter Cache Redis + +Redis based cache adapter with support of Redis cluster + + +## Usage + + +## Develop + +This is a monorepo package. + +Follow the instructions for the top-level repo. +1. `git clone` this repo & `cd` into it as usual +2. Run `yarn` to install top-level dependencies. + + + +## Test + +- `yarn lint` run just eslint +- `yarn test` run lint and tests + diff --git a/ghost/adapter-cache-redis/index.js b/ghost/adapter-cache-redis/index.js new file mode 100644 index 0000000000..d40bd74269 --- /dev/null +++ b/ghost/adapter-cache-redis/index.js @@ -0,0 +1 @@ +module.exports = require('./lib/adapter-cache-redis'); diff --git a/ghost/adapter-cache-redis/lib/adapter-cache-redis.js b/ghost/adapter-cache-redis/lib/adapter-cache-redis.js new file mode 100644 index 0000000000..e69de29bb2 diff --git a/ghost/adapter-cache-redis/package.json b/ghost/adapter-cache-redis/package.json new file mode 100644 index 0000000000..449e454c05 --- /dev/null +++ b/ghost/adapter-cache-redis/package.json @@ -0,0 +1,26 @@ +{ + "name": "@tryghost/adapter-cache-redis", + "version": "0.0.0", + "repository": "https://github.com/TryGhost/Ghost/tree/main/packages/adapter-cache-redis", + "author": "Ghost Foundation", + "private": true, + "main": "index.js", + "scripts": { + "dev": "echo \"Implement me!\"", + "test:unit": "NODE_ENV=testing c8 --all --check-coverage --100 --reporter text --reporter cobertura mocha './test/**/*.test.js'", + "test": "yarn test:unit", + "lint:code": "eslint *.js lib/ --ext .js --cache", + "lint": "yarn lint:code && yarn lint:test", + "lint:test": "eslint -c test/.eslintrc.js test/ --ext .js --cache" + }, + "files": [ + "index.js", + "lib" + ], + "devDependencies": { + "c8": "7.12.0", + "mocha": "10.2.0", + "sinon": "15.0.1" + }, + "dependencies": {} +} diff --git a/ghost/adapter-cache-redis/test/.eslintrc.js b/ghost/adapter-cache-redis/test/.eslintrc.js new file mode 100644 index 0000000000..829b601eb0 --- /dev/null +++ b/ghost/adapter-cache-redis/test/.eslintrc.js @@ -0,0 +1,6 @@ +module.exports = { + plugins: ['ghost'], + extends: [ + 'plugin:ghost/test' + ] +}; diff --git a/ghost/adapter-cache-redis/test/hello.test.js b/ghost/adapter-cache-redis/test/hello.test.js new file mode 100644 index 0000000000..3224ab57bf --- /dev/null +++ b/ghost/adapter-cache-redis/test/hello.test.js @@ -0,0 +1,8 @@ +const assert = require('assert'); + +describe('Hello world', function () { + it('Runs a test', function () { + // TODO: Write me! + assert.ok(require('../index')); + }); +});