Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
{
"name": "@athenna/cache",
"version": "5.10.0",
"version": "5.11.0",
"description": "The cache handler for Athenna Framework.",
"license": "MIT",
"author": "João Lenon <lenon@athenna.io>",
Expand Down
82 changes: 75 additions & 7 deletions src/cache/drivers/RedisDriver.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -56,6 +56,26 @@ export class RedisDriver extends Driver<RedisClientType> {
*/
public database: number

/**
* In-flight resurrection attempt, shared so concurrent commands
* don't race multiple connect() calls against a closed client.
*/
private reconnectPromise: Promise<void> = null

/**
* Log without ever throwing: driver logs fire from node-redis event
* listeners and reconnect callbacks, where an exception (e.g. Logger
* service not bound in the container) would crash the process over a
* cache connection blip.
*/
private log(level: 'success' | 'warn' | 'error', message: string) {
try {
Log.channelOrVanilla('application')[level](message)
} catch {
/* logging must never take the process down */
}
}

public constructor(
store: string,
client: any = null,
Expand DownExpand Up@@ -109,13 +129,21 @@ export class RedisDriver extends Driver<RedisClientType> {
const config = Config.get(`cache.stores.${this.store}`)
const { createClient } = this.getRedis()

/**
* Never stop retrying: returning an Error here makes node-redis close
* the client permanently, so a Redis restart longer than the retry
* window would leave every future command throwing "The client is
* closed" until the process restarts.
*/
const defaultReconnectStrategy = (retries: number) => {
if (retries >= 5) {
return new Error(
`Cache store "${this.store}": max reconnect retries reached`
if (retries > 0 && retries % 10 === 0) {
this.log(
'warn',
`Cache store ({yellow} ${this.store}) still reconnecting after ${retries} retries`
)
}
return Math.min(retries * 200, 2000)

return Math.min(retries * 200, 5000)
}

this.client = createClient({
Expand All@@ -129,7 +157,8 @@ export class RedisDriver extends Driver<RedisClientType> {
// Required: without this listener node-redis emits 'error' events as
// unhandled rejections whenever the connection drops after initial connect.
this.client.on('error', err => {
Log.channelOrVanilla('application').error(
this.log(
'error',
`({red} Error) on ({yellow} ${this.store}) cache store: ${err.message}`
)
})
Expand All@@ -138,13 +167,15 @@ export class RedisDriver extends Driver<RedisClientType> {
.connect()
.then(() => {
if (Config.is('rc.bootLogs', true)) {
Log.channelOrVanilla('application').success(
this.log(
'success',
`Successfully connected to ({yellow} ${this.store}) cache store`
)
}
})
.catch(err => {
Log.channelOrVanilla('application').error(
this.log(
'error',
`Failed to connect to ({yellow} ${this.store}) cache store: ${err.message}`
)
})
Expand All@@ -157,6 +188,35 @@ export class RedisDriver extends Driver<RedisClientType> {
}
}

/**
* Reconnect a client that node-redis has permanently closed — a custom
* reconnect strategy that gave up, or a connection that never came up at
* boot. Without this, every command on that client throws "The client is
* closed" until the process restarts; with it, the next command heals the
* connection instead.
*/
private async ensureConnection() {
if (!this.client || this.client.isOpen) {
return
}

if (!this.reconnectPromise) {
this.reconnectPromise = this.client
.connect()
.then(() => {
if (Config.is('rc.bootLogs', true)) {
this.log(
'success',
`Reconnected to ({yellow} ${this.store}) cache store`
)
}
})
.finally(() => (this.reconnectPromise = null))
}

await this.reconnectPromise
}

/**
* Close the connection with the client in this instance.
*/
Expand All@@ -183,6 +243,8 @@ export class RedisDriver extends Driver<RedisClientType> {
return
}

await this.ensureConnection()

let cursor = '0'

do {
Expand All@@ -207,6 +269,8 @@ export class RedisDriver extends Driver<RedisClientType> {
return
}

await this.ensureConnection()

const value = await this.client.get(this.getCacheKey(key))

if (Is.Null(value) || Is.Undefined(value)) {
Expand DownExpand Up@@ -237,6 +301,8 @@ export class RedisDriver extends Driver<RedisClientType> {
return
}

await this.ensureConnection()

const driverOptions: any = {}

options = Options.create(options, {
Expand DownExpand Up@@ -277,6 +343,8 @@ export class RedisDriver extends Driver<RedisClientType> {
return
}

await this.ensureConnection()

await this.client.del(this.getCacheKey(key))
}
}
8 changes: 5 additions & 3 deletions src/types/StoreOptions.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -87,10 +87,12 @@ export type StoreOptions = {
* Define a custom reconnect strategy for the Redis connection.
* Receives the number of retries so far. Return a number (ms delay
* before next retry) or an Error to stop retrying and reject all
* pending commands. Defaults to exponential backoff that gives up
* after 5 retries.
* pending commands. By default the driver retries forever with a
* capped backoff (retries * 200ms, max 5s), since giving up leaves
* the client permanently closed. Even if a custom strategy gives up,
* the next command issued through the driver reconnects the client.
*
* @default built-in exponential backoff, max 5 retries
* @default built-in capped backoff (retries * 200ms, max 5s), never gives up
*/
reconnectStrategy?: (retries: number) => number | Error
}
Expand Down
34 changes: 34 additions & 0 deletions tests/unit/cache/drivers/RedisDriverTest.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,40 @@ export class RedisDriverTest {
assert.deepEqual(driver.client, { hello: 'world' })
}

@Test()
public async shouldResurrectAClosedClientOnTheNextCommand({ assert }: Context) {
const cache = Cache.store('redis')

await Sleep.for(100).milliseconds().wait()

await cache.set('resurrect', 'alive')

cache.driver.client.destroy()

assert.isFalse(cache.driver.client.isOpen)

const value = await cache.get('resurrect')

assert.equal(value, 'alive')
assert.isTrue(cache.driver.client.isOpen)
}

@Test()
public async shouldShareASingleReconnectAttemptBetweenConcurrentCommands({ assert }: Context) {
const cache = Cache.store('redis')

await Sleep.for(100).milliseconds().wait()

await cache.set('concurrent', 'ok')

cache.driver.client.destroy()

const values = await Promise.all([cache.get('concurrent'), cache.get('concurrent'), cache.get('concurrent')])

assert.deepEqual(values, ['ok', 'ok', 'ok'])
assert.isTrue(cache.driver.client.isOpen)
}

@Test()
public async shouldBeAbleToSetValueToTheCache({ assert }: Context) {
const cache = Cache.store('redis')
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
{
"name": "@athenna/cache",
"version": "5.10.0",
"version": "5.11.0",
"description": "The cache handler for Athenna Framework.",
"license": "MIT",
"author": "João Lenon <lenon@athenna.io>",
Expand Down
82 changes: 75 additions & 7 deletions src/cache/drivers/RedisDriver.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -56,6 +56,26 @@ export class RedisDriver extends Driver<RedisClientType> {
*/
public database: number

/**
* In-flight resurrection attempt, shared so concurrent commands
* don't race multiple connect() calls against a closed client.
*/
private reconnectPromise: Promise<void> = null

/**
* Log without ever throwing: driver logs fire from node-redis event
* listeners and reconnect callbacks, where an exception (e.g. Logger
* service not bound in the container) would crash the process over a
* cache connection blip.
*/
private log(level: 'success' | 'warn' | 'error', message: string) {
try {
Log.channelOrVanilla('application')[level](message)
} catch {
/* logging must never take the process down */
}
}

public constructor(
store: string,
client: any = null,
Expand DownExpand Up@@ -109,13 +129,21 @@ export class RedisDriver extends Driver<RedisClientType> {
const config = Config.get(`cache.stores.${this.store}`)
const { createClient } = this.getRedis()

/**
* Never stop retrying: returning an Error here makes node-redis close
* the client permanently, so a Redis restart longer than the retry
* window would leave every future command throwing "The client is
* closed" until the process restarts.
*/
const defaultReconnectStrategy = (retries: number) => {
if (retries >= 5) {
return new Error(
`Cache store "${this.store}": max reconnect retries reached`
if (retries > 0 && retries % 10 === 0) {
this.log(
'warn',
`Cache store ({yellow} ${this.store}) still reconnecting after ${retries} retries`
)
}
return Math.min(retries * 200, 2000)

return Math.min(retries * 200, 5000)
}

this.client = createClient({
Expand All@@ -129,7 +157,8 @@ export class RedisDriver extends Driver<RedisClientType> {
// Required: without this listener node-redis emits 'error' events as
// unhandled rejections whenever the connection drops after initial connect.
this.client.on('error', err => {
Log.channelOrVanilla('application').error(
this.log(
'error',
`({red} Error) on ({yellow} ${this.store}) cache store: ${err.message}`
)
})
Expand All@@ -138,13 +167,15 @@ export class RedisDriver extends Driver<RedisClientType> {
.connect()
.then(() => {
if (Config.is('rc.bootLogs', true)) {
Log.channelOrVanilla('application').success(
this.log(
'success',
`Successfully connected to ({yellow} ${this.store}) cache store`
)
}
})
.catch(err => {
Log.channelOrVanilla('application').error(
this.log(
'error',
`Failed to connect to ({yellow} ${this.store}) cache store: ${err.message}`
)
})
Expand All@@ -157,6 +188,35 @@ export class RedisDriver extends Driver<RedisClientType> {
}
}

/**
* Reconnect a client that node-redis has permanently closed — a custom
* reconnect strategy that gave up, or a connection that never came up at
* boot. Without this, every command on that client throws "The client is
* closed" until the process restarts; with it, the next command heals the
* connection instead.
*/
private async ensureConnection() {
if (!this.client || this.client.isOpen) {
return
}

if (!this.reconnectPromise) {
this.reconnectPromise = this.client
.connect()
.then(() => {
if (Config.is('rc.bootLogs', true)) {
this.log(
'success',
`Reconnected to ({yellow} ${this.store}) cache store`
)
}
})
.finally(() => (this.reconnectPromise = null))
}

await this.reconnectPromise
}

/**
* Close the connection with the client in this instance.
*/
Expand All@@ -183,6 +243,8 @@ export class RedisDriver extends Driver<RedisClientType> {
return
}

await this.ensureConnection()

let cursor = '0'

do {
Expand All@@ -207,6 +269,8 @@ export class RedisDriver extends Driver<RedisClientType> {
return
}

await this.ensureConnection()

const value = await this.client.get(this.getCacheKey(key))

if (Is.Null(value) || Is.Undefined(value)) {
Expand DownExpand Up@@ -237,6 +301,8 @@ export class RedisDriver extends Driver<RedisClientType> {
return
}

await this.ensureConnection()

const driverOptions: any = {}

options = Options.create(options, {
Expand DownExpand Up@@ -277,6 +343,8 @@ export class RedisDriver extends Driver<RedisClientType> {
return
}

await this.ensureConnection()

await this.client.del(this.getCacheKey(key))
}
}
8 changes: 5 additions & 3 deletions src/types/StoreOptions.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -87,10 +87,12 @@ export type StoreOptions = {
* Define a custom reconnect strategy for the Redis connection.
* Receives the number of retries so far. Return a number (ms delay
* before next retry) or an Error to stop retrying and reject all
* pending commands. Defaults to exponential backoff that gives up
* after 5 retries.
* pending commands. By default the driver retries forever with a
* capped backoff (retries * 200ms, max 5s), since giving up leaves
* the client permanently closed. Even if a custom strategy gives up,
* the next command issued through the driver reconnects the client.
*
* @default built-in exponential backoff, max 5 retries
* @default built-in capped backoff (retries * 200ms, max 5s), never gives up
*/
reconnectStrategy?: (retries: number) => number | Error
}
Expand Down
34 changes: 34 additions & 0 deletions tests/unit/cache/drivers/RedisDriverTest.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,40 @@ export class RedisDriverTest {
assert.deepEqual(driver.client, { hello: 'world' })
}

@Test()
public async shouldResurrectAClosedClientOnTheNextCommand({ assert }: Context) {
const cache = Cache.store('redis')

await Sleep.for(100).milliseconds().wait()

await cache.set('resurrect', 'alive')

cache.driver.client.destroy()

assert.isFalse(cache.driver.client.isOpen)

const value = await cache.get('resurrect')

assert.equal(value, 'alive')
assert.isTrue(cache.driver.client.isOpen)
}

@Test()
public async shouldShareASingleReconnectAttemptBetweenConcurrentCommands({ assert }: Context) {
const cache = Cache.store('redis')

await Sleep.for(100).milliseconds().wait()

await cache.set('concurrent', 'ok')

cache.driver.client.destroy()

const values = await Promise.all([cache.get('concurrent'), cache.get('concurrent'), cache.get('concurrent')])

assert.deepEqual(values, ['ok', 'ok', 'ok'])
assert.isTrue(cache.driver.client.isOpen)
}

@Test()
public async shouldBeAbleToSetValueToTheCache({ assert }: Context) {
const cache = Cache.store('redis')
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
{
"name": "@athenna/cache",
"version": "5.10.0",
"version": "5.11.0",
"description": "The cache handler for Athenna Framework.",
"license": "MIT",
"author": "João Lenon <lenon@athenna.io>",
Expand Down
82 changes: 75 additions & 7 deletions src/cache/drivers/RedisDriver.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -56,6 +56,26 @@ export class RedisDriver extends Driver<RedisClientType> {
*/
public database: number

/**
* In-flight resurrection attempt, shared so concurrent commands
* don't race multiple connect() calls against a closed client.
*/
private reconnectPromise: Promise<void> = null

/**
* Log without ever throwing: driver logs fire from node-redis event
* listeners and reconnect callbacks, where an exception (e.g. Logger
* service not bound in the container) would crash the process over a
* cache connection blip.
*/
private log(level: 'success' | 'warn' | 'error', message: string) {
try {
Log.channelOrVanilla('application')[level](message)
} catch {
/* logging must never take the process down */
}
}

public constructor(
store: string,
client: any = null,
Expand DownExpand Up@@ -109,13 +129,21 @@ export class RedisDriver extends Driver<RedisClientType> {
const config = Config.get(`cache.stores.${this.store}`)
const { createClient } = this.getRedis()

/**
* Never stop retrying: returning an Error here makes node-redis close
* the client permanently, so a Redis restart longer than the retry
* window would leave every future command throwing "The client is
* closed" until the process restarts.
*/
const defaultReconnectStrategy = (retries: number) => {
if (retries >= 5) {
return new Error(
`Cache store "${this.store}": max reconnect retries reached`
if (retries > 0 && retries % 10 === 0) {
this.log(
'warn',
`Cache store ({yellow} ${this.store}) still reconnecting after ${retries} retries`
)
}
return Math.min(retries * 200, 2000)

return Math.min(retries * 200, 5000)
}

this.client = createClient({
Expand All@@ -129,7 +157,8 @@ export class RedisDriver extends Driver<RedisClientType> {
// Required: without this listener node-redis emits 'error' events as
// unhandled rejections whenever the connection drops after initial connect.
this.client.on('error', err => {
Log.channelOrVanilla('application').error(
this.log(
'error',
`({red} Error) on ({yellow} ${this.store}) cache store: ${err.message}`
)
})
Expand All@@ -138,13 +167,15 @@ export class RedisDriver extends Driver<RedisClientType> {
.connect()
.then(() => {
if (Config.is('rc.bootLogs', true)) {
Log.channelOrVanilla('application').success(
this.log(
'success',
`Successfully connected to ({yellow} ${this.store}) cache store`
)
}
})
.catch(err => {
Log.channelOrVanilla('application').error(
this.log(
'error',
`Failed to connect to ({yellow} ${this.store}) cache store: ${err.message}`
)
})
Expand All@@ -157,6 +188,35 @@ export class RedisDriver extends Driver<RedisClientType> {
}
}

/**
* Reconnect a client that node-redis has permanently closed — a custom
* reconnect strategy that gave up, or a connection that never came up at
* boot. Without this, every command on that client throws "The client is
* closed" until the process restarts; with it, the next command heals the
* connection instead.
*/
private async ensureConnection() {
if (!this.client || this.client.isOpen) {
return
}

if (!this.reconnectPromise) {
this.reconnectPromise = this.client
.connect()
.then(() => {
if (Config.is('rc.bootLogs', true)) {
this.log(
'success',
`Reconnected to ({yellow} ${this.store}) cache store`
)
}
})
.finally(() => (this.reconnectPromise = null))
}

await this.reconnectPromise
}

/**
* Close the connection with the client in this instance.
*/
Expand All@@ -183,6 +243,8 @@ export class RedisDriver extends Driver<RedisClientType> {
return
}

await this.ensureConnection()

let cursor = '0'

do {
Expand All@@ -207,6 +269,8 @@ export class RedisDriver extends Driver<RedisClientType> {
return
}

await this.ensureConnection()

const value = await this.client.get(this.getCacheKey(key))

if (Is.Null(value) || Is.Undefined(value)) {
Expand DownExpand Up@@ -237,6 +301,8 @@ export class RedisDriver extends Driver<RedisClientType> {
return
}

await this.ensureConnection()

const driverOptions: any = {}

options = Options.create(options, {
Expand DownExpand Up@@ -277,6 +343,8 @@ export class RedisDriver extends Driver<RedisClientType> {
return
}

await this.ensureConnection()

await this.client.del(this.getCacheKey(key))
}
}
8 changes: 5 additions & 3 deletions src/types/StoreOptions.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -87,10 +87,12 @@ export type StoreOptions = {
* Define a custom reconnect strategy for the Redis connection.
* Receives the number of retries so far. Return a number (ms delay
* before next retry) or an Error to stop retrying and reject all
* pending commands. Defaults to exponential backoff that gives up
* after 5 retries.
* pending commands. By default the driver retries forever with a
* capped backoff (retries * 200ms, max 5s), since giving up leaves
* the client permanently closed. Even if a custom strategy gives up,
* the next command issued through the driver reconnects the client.
*
* @default built-in exponential backoff, max 5 retries
* @default built-in capped backoff (retries * 200ms, max 5s), never gives up
*/
reconnectStrategy?: (retries: number) => number | Error
}
Expand Down
34 changes: 34 additions & 0 deletions tests/unit/cache/drivers/RedisDriverTest.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,40 @@ export class RedisDriverTest {
assert.deepEqual(driver.client, { hello: 'world' })
}

@Test()
public async shouldResurrectAClosedClientOnTheNextCommand({ assert }: Context) {
const cache = Cache.store('redis')

await Sleep.for(100).milliseconds().wait()

await cache.set('resurrect', 'alive')

cache.driver.client.destroy()

assert.isFalse(cache.driver.client.isOpen)

const value = await cache.get('resurrect')

assert.equal(value, 'alive')
assert.isTrue(cache.driver.client.isOpen)
}

@Test()
public async shouldShareASingleReconnectAttemptBetweenConcurrentCommands({ assert }: Context) {
const cache = Cache.store('redis')

await Sleep.for(100).milliseconds().wait()

await cache.set('concurrent', 'ok')

cache.driver.client.destroy()

const values = await Promise.all([cache.get('concurrent'), cache.get('concurrent'), cache.get('concurrent')])

assert.deepEqual(values, ['ok', 'ok', 'ok'])
assert.isTrue(cache.driver.client.isOpen)
}

@Test()
public async shouldBeAbleToSetValueToTheCache({ assert }: Context) {
const cache = Cache.store('redis')
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
{
"name": "@athenna/cache",
"version": "5.10.0",
"version": "5.11.0",
"description": "The cache handler for Athenna Framework.",
"license": "MIT",
"author": "João Lenon <lenon@athenna.io>",
Expand Down
82 changes: 75 additions & 7 deletions src/cache/drivers/RedisDriver.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -56,6 +56,26 @@ export class RedisDriver extends Driver<RedisClientType> {
*/
public database: number

/**
* In-flight resurrection attempt, shared so concurrent commands
* don't race multiple connect() calls against a closed client.
*/
private reconnectPromise: Promise<void> = null

/**
* Log without ever throwing: driver logs fire from node-redis event
* listeners and reconnect callbacks, where an exception (e.g. Logger
* service not bound in the container) would crash the process over a
* cache connection blip.
*/
private log(level: 'success' | 'warn' | 'error', message: string) {
try {
Log.channelOrVanilla('application')[level](message)
} catch {
/* logging must never take the process down */
}
}

public constructor(
store: string,
client: any = null,
Expand DownExpand Up@@ -109,13 +129,21 @@ export class RedisDriver extends Driver<RedisClientType> {
const config = Config.get(`cache.stores.${this.store}`)
const { createClient } = this.getRedis()

/**
* Never stop retrying: returning an Error here makes node-redis close
* the client permanently, so a Redis restart longer than the retry
* window would leave every future command throwing "The client is
* closed" until the process restarts.
*/
const defaultReconnectStrategy = (retries: number) => {
if (retries >= 5) {
return new Error(
`Cache store "${this.store}": max reconnect retries reached`
if (retries > 0 && retries % 10 === 0) {
this.log(
'warn',
`Cache store ({yellow} ${this.store}) still reconnecting after ${retries} retries`
)
}
return Math.min(retries * 200, 2000)

return Math.min(retries * 200, 5000)
}

this.client = createClient({
Expand All@@ -129,7 +157,8 @@ export class RedisDriver extends Driver<RedisClientType> {
// Required: without this listener node-redis emits 'error' events as
// unhandled rejections whenever the connection drops after initial connect.
this.client.on('error', err => {
Log.channelOrVanilla('application').error(
this.log(
'error',
`({red} Error) on ({yellow} ${this.store}) cache store: ${err.message}`
)
})
Expand All@@ -138,13 +167,15 @@ export class RedisDriver extends Driver<RedisClientType> {
.connect()
.then(() => {
if (Config.is('rc.bootLogs', true)) {
Log.channelOrVanilla('application').success(
this.log(
'success',
`Successfully connected to ({yellow} ${this.store}) cache store`
)
}
})
.catch(err => {
Log.channelOrVanilla('application').error(
this.log(
'error',
`Failed to connect to ({yellow} ${this.store}) cache store: ${err.message}`
)
})
Expand All@@ -157,6 +188,35 @@ export class RedisDriver extends Driver<RedisClientType> {
}
}

/**
* Reconnect a client that node-redis has permanently closed — a custom
* reconnect strategy that gave up, or a connection that never came up at
* boot. Without this, every command on that client throws "The client is
* closed" until the process restarts; with it, the next command heals the
* connection instead.
*/
private async ensureConnection() {
if (!this.client || this.client.isOpen) {
return
}

if (!this.reconnectPromise) {
this.reconnectPromise = this.client
.connect()
.then(() => {
if (Config.is('rc.bootLogs', true)) {
this.log(
'success',
`Reconnected to ({yellow} ${this.store}) cache store`
)
}
})
.finally(() => (this.reconnectPromise = null))
}

await this.reconnectPromise
}

/**
* Close the connection with the client in this instance.
*/
Expand All@@ -183,6 +243,8 @@ export class RedisDriver extends Driver<RedisClientType> {
return
}

await this.ensureConnection()

let cursor = '0'

do {
Expand All@@ -207,6 +269,8 @@ export class RedisDriver extends Driver<RedisClientType> {
return
}

await this.ensureConnection()

const value = await this.client.get(this.getCacheKey(key))

if (Is.Null(value) || Is.Undefined(value)) {
Expand DownExpand Up@@ -237,6 +301,8 @@ export class RedisDriver extends Driver<RedisClientType> {
return
}

await this.ensureConnection()

const driverOptions: any = {}

options = Options.create(options, {
Expand DownExpand Up@@ -277,6 +343,8 @@ export class RedisDriver extends Driver<RedisClientType> {
return
}

await this.ensureConnection()

await this.client.del(this.getCacheKey(key))
}
}
8 changes: 5 additions & 3 deletions src/types/StoreOptions.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -87,10 +87,12 @@ export type StoreOptions = {
* Define a custom reconnect strategy for the Redis connection.
* Receives the number of retries so far. Return a number (ms delay
* before next retry) or an Error to stop retrying and reject all
* pending commands. Defaults to exponential backoff that gives up
* after 5 retries.
* pending commands. By default the driver retries forever with a
* capped backoff (retries * 200ms, max 5s), since giving up leaves
* the client permanently closed. Even if a custom strategy gives up,
* the next command issued through the driver reconnects the client.
*
* @default built-in exponential backoff, max 5 retries
* @default built-in capped backoff (retries * 200ms, max 5s), never gives up
*/
reconnectStrategy?: (retries: number) => number | Error
}
Expand Down
34 changes: 34 additions & 0 deletions tests/unit/cache/drivers/RedisDriverTest.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,40 @@ export class RedisDriverTest {
assert.deepEqual(driver.client, { hello: 'world' })
}

@Test()
public async shouldResurrectAClosedClientOnTheNextCommand({ assert }: Context) {
const cache = Cache.store('redis')

await Sleep.for(100).milliseconds().wait()

await cache.set('resurrect', 'alive')

cache.driver.client.destroy()

assert.isFalse(cache.driver.client.isOpen)

const value = await cache.get('resurrect')

assert.equal(value, 'alive')
assert.isTrue(cache.driver.client.isOpen)
}

@Test()
public async shouldShareASingleReconnectAttemptBetweenConcurrentCommands({ assert }: Context) {
const cache = Cache.store('redis')

await Sleep.for(100).milliseconds().wait()

await cache.set('concurrent', 'ok')

cache.driver.client.destroy()

const values = await Promise.all([cache.get('concurrent'), cache.get('concurrent'), cache.get('concurrent')])

assert.deepEqual(values, ['ok', 'ok', 'ok'])
assert.isTrue(cache.driver.client.isOpen)
}

@Test()
public async shouldBeAbleToSetValueToTheCache({ assert }: Context) {
const cache = Cache.store('redis')
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
{
"name": "@athenna/cache",
"version": "5.10.0",
"version": "5.11.0",
"description": "The cache handler for Athenna Framework.",
"license": "MIT",
"author": "João Lenon <lenon@athenna.io>",
Expand Down
82 changes: 75 additions & 7 deletions src/cache/drivers/RedisDriver.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -56,6 +56,26 @@ export class RedisDriver extends Driver<RedisClientType> {
*/
public database: number

/**
* In-flight resurrection attempt, shared so concurrent commands
* don't race multiple connect() calls against a closed client.
*/
private reconnectPromise: Promise<void> = null

/**
* Log without ever throwing: driver logs fire from node-redis event
* listeners and reconnect callbacks, where an exception (e.g. Logger
* service not bound in the container) would crash the process over a
* cache connection blip.
*/
private log(level: 'success' | 'warn' | 'error', message: string) {
try {
Log.channelOrVanilla('application')[level](message)
} catch {
/* logging must never take the process down */
}
}

public constructor(
store: string,
client: any = null,
Expand DownExpand Up@@ -109,13 +129,21 @@ export class RedisDriver extends Driver<RedisClientType> {
const config = Config.get(`cache.stores.${this.store}`)
const { createClient } = this.getRedis()

/**
* Never stop retrying: returning an Error here makes node-redis close
* the client permanently, so a Redis restart longer than the retry
* window would leave every future command throwing "The client is
* closed" until the process restarts.
*/
const defaultReconnectStrategy = (retries: number) => {
if (retries >= 5) {
return new Error(
`Cache store "${this.store}": max reconnect retries reached`
if (retries > 0 && retries % 10 === 0) {
this.log(
'warn',
`Cache store ({yellow} ${this.store}) still reconnecting after ${retries} retries`
)
}
return Math.min(retries * 200, 2000)

return Math.min(retries * 200, 5000)
}

this.client = createClient({
Expand All@@ -129,7 +157,8 @@ export class RedisDriver extends Driver<RedisClientType> {
// Required: without this listener node-redis emits 'error' events as
// unhandled rejections whenever the connection drops after initial connect.
this.client.on('error', err => {
Log.channelOrVanilla('application').error(
this.log(
'error',
`({red} Error) on ({yellow} ${this.store}) cache store: ${err.message}`
)
})
Expand All@@ -138,13 +167,15 @@ export class RedisDriver extends Driver<RedisClientType> {
.connect()
.then(() => {
if (Config.is('rc.bootLogs', true)) {
Log.channelOrVanilla('application').success(
this.log(
'success',
`Successfully connected to ({yellow} ${this.store}) cache store`
)
}
})
.catch(err => {
Log.channelOrVanilla('application').error(
this.log(
'error',
`Failed to connect to ({yellow} ${this.store}) cache store: ${err.message}`
)
})
Expand All@@ -157,6 +188,35 @@ export class RedisDriver extends Driver<RedisClientType> {
}
}

/**
* Reconnect a client that node-redis has permanently closed — a custom
* reconnect strategy that gave up, or a connection that never came up at
* boot. Without this, every command on that client throws "The client is
* closed" until the process restarts; with it, the next command heals the
* connection instead.
*/
private async ensureConnection() {
if (!this.client || this.client.isOpen) {
return
}

if (!this.reconnectPromise) {
this.reconnectPromise = this.client
.connect()
.then(() => {
if (Config.is('rc.bootLogs', true)) {
this.log(
'success',
`Reconnected to ({yellow} ${this.store}) cache store`
)
}
})
.finally(() => (this.reconnectPromise = null))
}

await this.reconnectPromise
}

/**
* Close the connection with the client in this instance.
*/
Expand All@@ -183,6 +243,8 @@ export class RedisDriver extends Driver<RedisClientType> {
return
}

await this.ensureConnection()

let cursor = '0'

do {
Expand All@@ -207,6 +269,8 @@ export class RedisDriver extends Driver<RedisClientType> {
return
}

await this.ensureConnection()

const value = await this.client.get(this.getCacheKey(key))

if (Is.Null(value) || Is.Undefined(value)) {
Expand DownExpand Up@@ -237,6 +301,8 @@ export class RedisDriver extends Driver<RedisClientType> {
return
}

await this.ensureConnection()

const driverOptions: any = {}

options = Options.create(options, {
Expand DownExpand Up@@ -277,6 +343,8 @@ export class RedisDriver extends Driver<RedisClientType> {
return
}

await this.ensureConnection()

await this.client.del(this.getCacheKey(key))
}
}
8 changes: 5 additions & 3 deletions src/types/StoreOptions.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -87,10 +87,12 @@ export type StoreOptions = {
* Define a custom reconnect strategy for the Redis connection.
* Receives the number of retries so far. Return a number (ms delay
* before next retry) or an Error to stop retrying and reject all
* pending commands. Defaults to exponential backoff that gives up
* after 5 retries.
* pending commands. By default the driver retries forever with a
* capped backoff (retries * 200ms, max 5s), since giving up leaves
* the client permanently closed. Even if a custom strategy gives up,
* the next command issued through the driver reconnects the client.
*
* @default built-in exponential backoff, max 5 retries
* @default built-in capped backoff (retries * 200ms, max 5s), never gives up
*/
reconnectStrategy?: (retries: number) => number | Error
}
Expand Down
34 changes: 34 additions & 0 deletions tests/unit/cache/drivers/RedisDriverTest.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,40 @@ export class RedisDriverTest {
assert.deepEqual(driver.client, { hello: 'world' })
}

@Test()
public async shouldResurrectAClosedClientOnTheNextCommand({ assert }: Context) {
const cache = Cache.store('redis')

await Sleep.for(100).milliseconds().wait()

await cache.set('resurrect', 'alive')

cache.driver.client.destroy()

assert.isFalse(cache.driver.client.isOpen)

const value = await cache.get('resurrect')

assert.equal(value, 'alive')
assert.isTrue(cache.driver.client.isOpen)
}

@Test()
public async shouldShareASingleReconnectAttemptBetweenConcurrentCommands({ assert }: Context) {
const cache = Cache.store('redis')

await Sleep.for(100).milliseconds().wait()

await cache.set('concurrent', 'ok')

cache.driver.client.destroy()

const values = await Promise.all([cache.get('concurrent'), cache.get('concurrent'), cache.get('concurrent')])

assert.deepEqual(values, ['ok', 'ok', 'ok'])
assert.isTrue(cache.driver.client.isOpen)
}

@Test()
public async shouldBeAbleToSetValueToTheCache({ assert }: Context) {
const cache = Cache.store('redis')
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
{
"name": "@athenna/cache",
"version": "5.10.0",
"version": "5.11.0",
"description": "The cache handler for Athenna Framework.",
"license": "MIT",
"author": "João Lenon <lenon@athenna.io>",
Expand Down
82 changes: 75 additions & 7 deletions src/cache/drivers/RedisDriver.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -56,6 +56,26 @@ export class RedisDriver extends Driver<RedisClientType> {
*/
public database: number

/**
* In-flight resurrection attempt, shared so concurrent commands
* don't race multiple connect() calls against a closed client.
*/
private reconnectPromise: Promise<void> = null

/**
* Log without ever throwing: driver logs fire from node-redis event
* listeners and reconnect callbacks, where an exception (e.g. Logger
* service not bound in the container) would crash the process over a
* cache connection blip.
*/
private log(level: 'success' | 'warn' | 'error', message: string) {
try {
Log.channelOrVanilla('application')[level](message)
} catch {
/* logging must never take the process down */
}
}

public constructor(
store: string,
client: any = null,
Expand DownExpand Up@@ -109,13 +129,21 @@ export class RedisDriver extends Driver<RedisClientType> {
const config = Config.get(`cache.stores.${this.store}`)
const { createClient } = this.getRedis()

/**
* Never stop retrying: returning an Error here makes node-redis close
* the client permanently, so a Redis restart longer than the retry
* window would leave every future command throwing "The client is
* closed" until the process restarts.
*/
const defaultReconnectStrategy = (retries: number) => {
if (retries >= 5) {
return new Error(
`Cache store "${this.store}": max reconnect retries reached`
if (retries > 0 && retries % 10 === 0) {
this.log(
'warn',
`Cache store ({yellow} ${this.store}) still reconnecting after ${retries} retries`
)
}
return Math.min(retries * 200, 2000)

return Math.min(retries * 200, 5000)
}

this.client = createClient({
Expand All@@ -129,7 +157,8 @@ export class RedisDriver extends Driver<RedisClientType> {
// Required: without this listener node-redis emits 'error' events as
// unhandled rejections whenever the connection drops after initial connect.
this.client.on('error', err => {
Log.channelOrVanilla('application').error(
this.log(
'error',
`({red} Error) on ({yellow} ${this.store}) cache store: ${err.message}`
)
})
Expand All@@ -138,13 +167,15 @@ export class RedisDriver extends Driver<RedisClientType> {
.connect()
.then(() => {
if (Config.is('rc.bootLogs', true)) {
Log.channelOrVanilla('application').success(
this.log(
'success',
`Successfully connected to ({yellow} ${this.store}) cache store`
)
}
})
.catch(err => {
Log.channelOrVanilla('application').error(
this.log(
'error',
`Failed to connect to ({yellow} ${this.store}) cache store: ${err.message}`
)
})
Expand All@@ -157,6 +188,35 @@ export class RedisDriver extends Driver<RedisClientType> {
}
}

/**
* Reconnect a client that node-redis has permanently closed — a custom
* reconnect strategy that gave up, or a connection that never came up at
* boot. Without this, every command on that client throws "The client is
* closed" until the process restarts; with it, the next command heals the
* connection instead.
*/
private async ensureConnection() {
if (!this.client || this.client.isOpen) {
return
}

if (!this.reconnectPromise) {
this.reconnectPromise = this.client
.connect()
.then(() => {
if (Config.is('rc.bootLogs', true)) {
this.log(
'success',
`Reconnected to ({yellow} ${this.store}) cache store`
)
}
})
.finally(() => (this.reconnectPromise = null))
}

await this.reconnectPromise
}

/**
* Close the connection with the client in this instance.
*/
Expand All@@ -183,6 +243,8 @@ export class RedisDriver extends Driver<RedisClientType> {
return
}

await this.ensureConnection()

let cursor = '0'

do {
Expand All@@ -207,6 +269,8 @@ export class RedisDriver extends Driver<RedisClientType> {
return
}

await this.ensureConnection()

const value = await this.client.get(this.getCacheKey(key))

if (Is.Null(value) || Is.Undefined(value)) {
Expand DownExpand Up@@ -237,6 +301,8 @@ export class RedisDriver extends Driver<RedisClientType> {
return
}

await this.ensureConnection()

const driverOptions: any = {}

options = Options.create(options, {
Expand DownExpand Up@@ -277,6 +343,8 @@ export class RedisDriver extends Driver<RedisClientType> {
return
}

await this.ensureConnection()

await this.client.del(this.getCacheKey(key))
}
}
8 changes: 5 additions & 3 deletions src/types/StoreOptions.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -87,10 +87,12 @@ export type StoreOptions = {
* Define a custom reconnect strategy for the Redis connection.
* Receives the number of retries so far. Return a number (ms delay
* before next retry) or an Error to stop retrying and reject all
* pending commands. Defaults to exponential backoff that gives up
* after 5 retries.
* pending commands. By default the driver retries forever with a
* capped backoff (retries * 200ms, max 5s), since giving up leaves
* the client permanently closed. Even if a custom strategy gives up,
* the next command issued through the driver reconnects the client.
*
* @default built-in exponential backoff, max 5 retries
* @default built-in capped backoff (retries * 200ms, max 5s), never gives up
*/
reconnectStrategy?: (retries: number) => number | Error
}
Expand Down
34 changes: 34 additions & 0 deletions tests/unit/cache/drivers/RedisDriverTest.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,40 @@ export class RedisDriverTest {
assert.deepEqual(driver.client, { hello: 'world' })
}

@Test()
public async shouldResurrectAClosedClientOnTheNextCommand({ assert }: Context) {
const cache = Cache.store('redis')

await Sleep.for(100).milliseconds().wait()

await cache.set('resurrect', 'alive')

cache.driver.client.destroy()

assert.isFalse(cache.driver.client.isOpen)

const value = await cache.get('resurrect')

assert.equal(value, 'alive')
assert.isTrue(cache.driver.client.isOpen)
}

@Test()
public async shouldShareASingleReconnectAttemptBetweenConcurrentCommands({ assert }: Context) {
const cache = Cache.store('redis')

await Sleep.for(100).milliseconds().wait()

await cache.set('concurrent', 'ok')

cache.driver.client.destroy()

const values = await Promise.all([cache.get('concurrent'), cache.get('concurrent'), cache.get('concurrent')])

assert.deepEqual(values, ['ok', 'ok', 'ok'])
assert.isTrue(cache.driver.client.isOpen)
}

@Test()
public async shouldBeAbleToSetValueToTheCache({ assert }: Context) {
const cache = Cache.store('redis')
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
{
"name": "@athenna/cache",
"version": "5.10.0",
"version": "5.11.0",
"description": "The cache handler for Athenna Framework.",
"license": "MIT",
"author": "João Lenon <lenon@athenna.io>",
Expand Down
82 changes: 75 additions & 7 deletions src/cache/drivers/RedisDriver.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -56,6 +56,26 @@ export class RedisDriver extends Driver<RedisClientType> {
*/
public database: number

/**
* In-flight resurrection attempt, shared so concurrent commands
* don't race multiple connect() calls against a closed client.
*/
private reconnectPromise: Promise<void> = null

/**
* Log without ever throwing: driver logs fire from node-redis event
* listeners and reconnect callbacks, where an exception (e.g. Logger
* service not bound in the container) would crash the process over a
* cache connection blip.
*/
private log(level: 'success' | 'warn' | 'error', message: string) {
try {
Log.channelOrVanilla('application')[level](message)
} catch {
/* logging must never take the process down */
}
}

public constructor(
store: string,
client: any = null,
Expand DownExpand Up@@ -109,13 +129,21 @@ export class RedisDriver extends Driver<RedisClientType> {
const config = Config.get(`cache.stores.${this.store}`)
const { createClient } = this.getRedis()

/**
* Never stop retrying: returning an Error here makes node-redis close
* the client permanently, so a Redis restart longer than the retry
* window would leave every future command throwing "The client is
* closed" until the process restarts.
*/
const defaultReconnectStrategy = (retries: number) => {
if (retries >= 5) {
return new Error(
`Cache store "${this.store}": max reconnect retries reached`
if (retries > 0 && retries % 10 === 0) {
this.log(
'warn',
`Cache store ({yellow} ${this.store}) still reconnecting after ${retries} retries`
)
}
return Math.min(retries * 200, 2000)

return Math.min(retries * 200, 5000)
}

this.client = createClient({
Expand All@@ -129,7 +157,8 @@ export class RedisDriver extends Driver<RedisClientType> {
// Required: without this listener node-redis emits 'error' events as
// unhandled rejections whenever the connection drops after initial connect.
this.client.on('error', err => {
Log.channelOrVanilla('application').error(
this.log(
'error',
`({red} Error) on ({yellow} ${this.store}) cache store: ${err.message}`
)
})
Expand All@@ -138,13 +167,15 @@ export class RedisDriver extends Driver<RedisClientType> {
.connect()
.then(() => {
if (Config.is('rc.bootLogs', true)) {
Log.channelOrVanilla('application').success(
this.log(
'success',
`Successfully connected to ({yellow} ${this.store}) cache store`
)
}
})
.catch(err => {
Log.channelOrVanilla('application').error(
this.log(
'error',
`Failed to connect to ({yellow} ${this.store}) cache store: ${err.message}`
)
})
Expand All@@ -157,6 +188,35 @@ export class RedisDriver extends Driver<RedisClientType> {
}
}

/**
* Reconnect a client that node-redis has permanently closed — a custom
* reconnect strategy that gave up, or a connection that never came up at
* boot. Without this, every command on that client throws "The client is
* closed" until the process restarts; with it, the next command heals the
* connection instead.
*/
private async ensureConnection() {
if (!this.client || this.client.isOpen) {
return
}

if (!this.reconnectPromise) {
this.reconnectPromise = this.client
.connect()
.then(() => {
if (Config.is('rc.bootLogs', true)) {
this.log(
'success',
`Reconnected to ({yellow} ${this.store}) cache store`
)
}
})
.finally(() => (this.reconnectPromise = null))
}

await this.reconnectPromise
}

/**
* Close the connection with the client in this instance.
*/
Expand All@@ -183,6 +243,8 @@ export class RedisDriver extends Driver<RedisClientType> {
return
}

await this.ensureConnection()

let cursor = '0'

do {
Expand All@@ -207,6 +269,8 @@ export class RedisDriver extends Driver<RedisClientType> {
return
}

await this.ensureConnection()

const value = await this.client.get(this.getCacheKey(key))

if (Is.Null(value) || Is.Undefined(value)) {
Expand DownExpand Up@@ -237,6 +301,8 @@ export class RedisDriver extends Driver<RedisClientType> {
return
}

await this.ensureConnection()

const driverOptions: any = {}

options = Options.create(options, {
Expand DownExpand Up@@ -277,6 +343,8 @@ export class RedisDriver extends Driver<RedisClientType> {
return
}

await this.ensureConnection()

await this.client.del(this.getCacheKey(key))
}
}
8 changes: 5 additions & 3 deletions src/types/StoreOptions.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -87,10 +87,12 @@ export type StoreOptions = {
* Define a custom reconnect strategy for the Redis connection.
* Receives the number of retries so far. Return a number (ms delay
* before next retry) or an Error to stop retrying and reject all
* pending commands. Defaults to exponential backoff that gives up
* after 5 retries.
* pending commands. By default the driver retries forever with a
* capped backoff (retries * 200ms, max 5s), since giving up leaves
* the client permanently closed. Even if a custom strategy gives up,
* the next command issued through the driver reconnects the client.
*
* @default built-in exponential backoff, max 5 retries
* @default built-in capped backoff (retries * 200ms, max 5s), never gives up
*/
reconnectStrategy?: (retries: number) => number | Error
}
Expand Down
34 changes: 34 additions & 0 deletions tests/unit/cache/drivers/RedisDriverTest.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,40 @@ export class RedisDriverTest {
assert.deepEqual(driver.client, { hello: 'world' })
}

@Test()
public async shouldResurrectAClosedClientOnTheNextCommand({ assert }: Context) {
const cache = Cache.store('redis')

await Sleep.for(100).milliseconds().wait()

await cache.set('resurrect', 'alive')

cache.driver.client.destroy()

assert.isFalse(cache.driver.client.isOpen)

const value = await cache.get('resurrect')

assert.equal(value, 'alive')
assert.isTrue(cache.driver.client.isOpen)
}

@Test()
public async shouldShareASingleReconnectAttemptBetweenConcurrentCommands({ assert }: Context) {
const cache = Cache.store('redis')

await Sleep.for(100).milliseconds().wait()

await cache.set('concurrent', 'ok')

cache.driver.client.destroy()

const values = await Promise.all([cache.get('concurrent'), cache.get('concurrent'), cache.get('concurrent')])

assert.deepEqual(values, ['ok', 'ok', 'ok'])
assert.isTrue(cache.driver.client.isOpen)
}

@Test()
public async shouldBeAbleToSetValueToTheCache({ assert }: Context) {
const cache = Cache.store('redis')
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
{
"name": "@athenna/cache",
"version": "5.10.0",
"version": "5.11.0",
"description": "The cache handler for Athenna Framework.",
"license": "MIT",
"author": "João Lenon <lenon@athenna.io>",
Expand Down
82 changes: 75 additions & 7 deletions src/cache/drivers/RedisDriver.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -56,6 +56,26 @@ export class RedisDriver extends Driver<RedisClientType> {
*/
public database: number

/**
* In-flight resurrection attempt, shared so concurrent commands
* don't race multiple connect() calls against a closed client.
*/
private reconnectPromise: Promise<void> = null

/**
* Log without ever throwing: driver logs fire from node-redis event
* listeners and reconnect callbacks, where an exception (e.g. Logger
* service not bound in the container) would crash the process over a
* cache connection blip.
*/
private log(level: 'success' | 'warn' | 'error', message: string) {
try {
Log.channelOrVanilla('application')[level](message)
} catch {
/* logging must never take the process down */
}
}

public constructor(
store: string,
client: any = null,
Expand DownExpand Up@@ -109,13 +129,21 @@ export class RedisDriver extends Driver<RedisClientType> {
const config = Config.get(`cache.stores.${this.store}`)
const { createClient } = this.getRedis()

/**
* Never stop retrying: returning an Error here makes node-redis close
* the client permanently, so a Redis restart longer than the retry
* window would leave every future command throwing "The client is
* closed" until the process restarts.
*/
const defaultReconnectStrategy = (retries: number) => {
if (retries >= 5) {
return new Error(
`Cache store "${this.store}": max reconnect retries reached`
if (retries > 0 && retries % 10 === 0) {
this.log(
'warn',
`Cache store ({yellow} ${this.store}) still reconnecting after ${retries} retries`
)
}
return Math.min(retries * 200, 2000)

return Math.min(retries * 200, 5000)
}

this.client = createClient({
Expand All@@ -129,7 +157,8 @@ export class RedisDriver extends Driver<RedisClientType> {
// Required: without this listener node-redis emits 'error' events as
// unhandled rejections whenever the connection drops after initial connect.
this.client.on('error', err => {
Log.channelOrVanilla('application').error(
this.log(
'error',
`({red} Error) on ({yellow} ${this.store}) cache store: ${err.message}`
)
})
Expand All@@ -138,13 +167,15 @@ export class RedisDriver extends Driver<RedisClientType> {
.connect()
.then(() => {
if (Config.is('rc.bootLogs', true)) {
Log.channelOrVanilla('application').success(
this.log(
'success',
`Successfully connected to ({yellow} ${this.store}) cache store`
)
}
})
.catch(err => {
Log.channelOrVanilla('application').error(
this.log(
'error',
`Failed to connect to ({yellow} ${this.store}) cache store: ${err.message}`
)
})
Expand All@@ -157,6 +188,35 @@ export class RedisDriver extends Driver<RedisClientType> {
}
}

/**
* Reconnect a client that node-redis has permanently closed — a custom
* reconnect strategy that gave up, or a connection that never came up at
* boot. Without this, every command on that client throws "The client is
* closed" until the process restarts; with it, the next command heals the
* connection instead.
*/
private async ensureConnection() {
if (!this.client || this.client.isOpen) {
return
}

if (!this.reconnectPromise) {
this.reconnectPromise = this.client
.connect()
.then(() => {
if (Config.is('rc.bootLogs', true)) {
this.log(
'success',
`Reconnected to ({yellow} ${this.store}) cache store`
)
}
})
.finally(() => (this.reconnectPromise = null))
}

await this.reconnectPromise
}

/**
* Close the connection with the client in this instance.
*/
Expand All@@ -183,6 +243,8 @@ export class RedisDriver extends Driver<RedisClientType> {
return
}

await this.ensureConnection()

let cursor = '0'

do {
Expand All@@ -207,6 +269,8 @@ export class RedisDriver extends Driver<RedisClientType> {
return
}

await this.ensureConnection()

const value = await this.client.get(this.getCacheKey(key))

if (Is.Null(value) || Is.Undefined(value)) {
Expand DownExpand Up@@ -237,6 +301,8 @@ export class RedisDriver extends Driver<RedisClientType> {
return
}

await this.ensureConnection()

const driverOptions: any = {}

options = Options.create(options, {
Expand DownExpand Up@@ -277,6 +343,8 @@ export class RedisDriver extends Driver<RedisClientType> {
return
}

await this.ensureConnection()

await this.client.del(this.getCacheKey(key))
}
}
8 changes: 5 additions & 3 deletions src/types/StoreOptions.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -87,10 +87,12 @@ export type StoreOptions = {
* Define a custom reconnect strategy for the Redis connection.
* Receives the number of retries so far. Return a number (ms delay
* before next retry) or an Error to stop retrying and reject all
* pending commands. Defaults to exponential backoff that gives up
* after 5 retries.
* pending commands. By default the driver retries forever with a
* capped backoff (retries * 200ms, max 5s), since giving up leaves
* the client permanently closed. Even if a custom strategy gives up,
* the next command issued through the driver reconnects the client.
*
* @default built-in exponential backoff, max 5 retries
* @default built-in capped backoff (retries * 200ms, max 5s), never gives up
*/
reconnectStrategy?: (retries: number) => number | Error
}
Expand Down
34 changes: 34 additions & 0 deletions tests/unit/cache/drivers/RedisDriverTest.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,40 @@ export class RedisDriverTest {
assert.deepEqual(driver.client, { hello: 'world' })
}

@Test()
public async shouldResurrectAClosedClientOnTheNextCommand({ assert }: Context) {
const cache = Cache.store('redis')

await Sleep.for(100).milliseconds().wait()

await cache.set('resurrect', 'alive')

cache.driver.client.destroy()

assert.isFalse(cache.driver.client.isOpen)

const value = await cache.get('resurrect')

assert.equal(value, 'alive')
assert.isTrue(cache.driver.client.isOpen)
}

@Test()
public async shouldShareASingleReconnectAttemptBetweenConcurrentCommands({ assert }: Context) {
const cache = Cache.store('redis')

await Sleep.for(100).milliseconds().wait()

await cache.set('concurrent', 'ok')

cache.driver.client.destroy()

const values = await Promise.all([cache.get('concurrent'), cache.get('concurrent'), cache.get('concurrent')])

assert.deepEqual(values, ['ok', 'ok', 'ok'])
assert.isTrue(cache.driver.client.isOpen)
}

@Test()
public async shouldBeAbleToSetValueToTheCache({ assert }: Context) {
const cache = Cache.store('redis')
Expand Down
Loading