X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Flib%2Fredis.ts;h=f544274ea0c80ff64256a441ea330d37bbc3cddc;hb=743dab5517d4501f6b35cfc795de6c8b6f41ebb3;hp=76b7868e850352b7647c6d0c91c4ac5a1c9c9b73;hpb=51353d9a035fb6b81f903a8b5f391292841649fd;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/lib/redis.ts b/server/lib/redis.ts index 76b7868e8..f544274ea 100644 --- a/server/lib/redis.ts +++ b/server/lib/redis.ts @@ -1,31 +1,30 @@ -import express from 'express' -import { createClient, RedisClient } from 'redis' +import { createClient, RedisClientOptions, RedisModules } from 'redis' +import { exists } from '@server/helpers/custom-validators/misc' +import { sha256 } from '@shared/extra-utils' import { logger } from '../helpers/logger' import { generateRandomString } from '../helpers/utils' +import { CONFIG } from '../initializers/config' import { + AP_CLEANER, CONTACT_FORM_LIFETIME, + RESUMABLE_UPLOAD_SESSION_LIFETIME, + TRACKER_RATE_LIMITS, USER_EMAIL_VERIFY_LIFETIME, - USER_PASSWORD_RESET_LIFETIME, USER_PASSWORD_CREATE_LIFETIME, + USER_PASSWORD_RESET_LIFETIME, VIEW_LIFETIME, - WEBSERVER, - TRACKER_RATE_LIMITS, - RESUMABLE_UPLOAD_SESSION_LIFETIME + WEBSERVER } from '../initializers/constants' -import { CONFIG } from '../initializers/config' -import { exists } from '@server/helpers/custom-validators/misc' -type CachedRoute = { - body: string - contentType?: string - statusCode?: string -} +// Only used for typings +const redisClientWrapperForType = () => createClient<{}>() class Redis { private static instance: Redis private initialized = false - private client: RedisClient + private connected = false + private client: ReturnType private prefix: string private constructor () { @@ -38,26 +37,43 @@ class Redis { this.client = createClient(Redis.getRedisClientOptions()) - this.client.on('error', err => { - logger.error('Error in Redis client.', { err }) - process.exit(-1) - }) + logger.info('Connecting to redis...') - if (CONFIG.REDIS.AUTH) { - this.client.auth(CONFIG.REDIS.AUTH) - } + this.client.connect() + .then(() => { + logger.info('Connected to redis.') + + this.connected = true + }).catch(err => { + logger.error('Cannot connect to redis', { err }) + process.exit(-1) + }) this.prefix = 'redis-' + WEBSERVER.HOST + '-' } static getRedisClientOptions () { - return Object.assign({}, - (CONFIG.REDIS.AUTH && CONFIG.REDIS.AUTH != null) ? { password: CONFIG.REDIS.AUTH } : {}, - (CONFIG.REDIS.DB) ? { db: CONFIG.REDIS.DB } : {}, - (CONFIG.REDIS.HOSTNAME && CONFIG.REDIS.PORT) - ? { host: CONFIG.REDIS.HOSTNAME, port: CONFIG.REDIS.PORT } - : { path: CONFIG.REDIS.SOCKET } - ) + let config: RedisClientOptions = { + socket: { + connectTimeout: 20000 // Could be slow since node use sync call to compile PeerTube + } + } + + if (CONFIG.REDIS.AUTH) { + config = { ...config, password: CONFIG.REDIS.AUTH } + } + + if (CONFIG.REDIS.DB) { + config = { ...config, database: CONFIG.REDIS.DB } + } + + if (CONFIG.REDIS.HOSTNAME && CONFIG.REDIS.PORT) { + config.socket = { ...config.socket, host: CONFIG.REDIS.HOSTNAME, port: CONFIG.REDIS.PORT } + } else { + config.socket = { ...config.socket, path: CONFIG.REDIS.SOCKET } + } + + return config } getClient () { @@ -68,6 +84,10 @@ class Redis { return this.prefix } + isConnected () { + return this.connected + } + /* ************ Forgot password ************ */ async setResetPasswordVerificationString (userId: number) { @@ -146,25 +166,6 @@ class Redis { return this.exists(this.generateTrackerBlockIPKey(ip)) } - /* ************ API cache ************ */ - - async getCachedRoute (req: express.Request) { - const cached = await this.getObject(this.generateCachedRouteKey(req)) - - return cached as CachedRoute - } - - setCachedRoute (req: express.Request, body: any, lifetime: number, contentType?: string, statusCode?: number) { - const cached: CachedRoute = Object.assign( - {}, - { body: body.toString() }, - (contentType) ? { contentType } : null, - (statusCode) ? { statusCode: statusCode.toString() } : null - ) - - return this.setObject(this.generateCachedRouteKey(req), cached, lifetime) - } - /* ************ Video views stats ************ */ addVideoViewStats (videoId: number) { @@ -271,12 +272,23 @@ class Redis { : '' } - /* ************ Keys generation ************ */ + deleteUploadSession (uploadId: string) { + return this.deleteKey('resumable-upload-' + uploadId) + } - generateCachedRouteKey (req: express.Request) { - return req.method + '-' + req.originalUrl + /* ************ AP ressource unavailability ************ */ + + async addAPUnavailability (url: string) { + const key = this.generateAPUnavailabilityKey(url) + + const value = await this.increment(key) + await this.setExpiration(key, AP_CLEANER.PERIOD * 2) + + return value } + /* ************ Keys generation ************ */ + private generateLocalVideoViewsKeys (videoId?: Number) { return { setKey: `local-video-views-buffer`, videoKey: `local-video-views-buffer-${videoId}` } } @@ -313,128 +325,54 @@ class Redis { return 'contact-form-' + ip } + private generateAPUnavailabilityKey (url: string) { + return 'ap-unavailability-' + sha256(url) + } + /* ************ Redis helpers ************ */ private getValue (key: string) { - return new Promise((res, rej) => { - this.client.get(this.prefix + key, (err, value) => { - if (err) return rej(err) - - return res(value) - }) - }) + return this.client.get(this.prefix + key) } private getSet (key: string) { - return new Promise((res, rej) => { - this.client.smembers(this.prefix + key, (err, value) => { - if (err) return rej(err) - - return res(value) - }) - }) + return this.client.sMembers(this.prefix + key) } private addToSet (key: string, value: string) { - return new Promise((res, rej) => { - this.client.sadd(this.prefix + key, value, err => err ? rej(err) : res()) - }) + return this.client.sAdd(this.prefix + key, value) } private deleteFromSet (key: string, value: string) { - return new Promise((res, rej) => { - this.client.srem(this.prefix + key, value, err => err ? rej(err) : res()) - }) + return this.client.sRem(this.prefix + key, value) } private deleteKey (key: string) { - return new Promise((res, rej) => { - this.client.del(this.prefix + key, err => err ? rej(err) : res()) - }) - } - - private deleteFieldInHash (key: string, field: string) { - return new Promise((res, rej) => { - this.client.hdel(this.prefix + key, field, err => err ? rej(err) : res()) - }) + return this.client.del(this.prefix + key) } - private setValue (key: string, value: string, expirationMilliseconds: number) { - return new Promise((res, rej) => { - this.client.set(this.prefix + key, value, 'PX', expirationMilliseconds, (err, ok) => { - if (err) return rej(err) - - if (ok !== 'OK') return rej(new Error('Redis set result is not OK.')) + private async setValue (key: string, value: string, expirationMilliseconds: number) { + const result = await this.client.set(this.prefix + key, value, { PX: expirationMilliseconds }) - return res() - }) - }) + if (result !== 'OK') throw new Error('Redis set result is not OK.') } private removeValue (key: string) { - return new Promise((res, rej) => { - this.client.del(this.prefix + key, err => { - if (err) return rej(err) - - return res() - }) - }) + return this.client.del(this.prefix + key) } - private setObject (key: string, obj: { [id: string]: string }, expirationMilliseconds: number) { - return new Promise((res, rej) => { - this.client.hmset(this.prefix + key, obj, (err, ok) => { - if (err) return rej(err) - if (!ok) return rej(new Error('Redis mset result is not OK.')) - - this.client.pexpire(this.prefix + key, expirationMilliseconds, (err, ok) => { - if (err) return rej(err) - if (!ok) return rej(new Error('Redis expiration result is not OK.')) - - return res() - }) - }) - }) - } - - private getObject (key: string) { - return new Promise<{ [id: string]: string }>((res, rej) => { - this.client.hgetall(this.prefix + key, (err, value) => { - if (err) return rej(err) - - return res(value) - }) - }) - } - - private setValueInHash (key: string, field: string, value: string) { - return new Promise((res, rej) => { - this.client.hset(this.prefix + key, field, value, (err) => { - if (err) return rej(err) - - return res() - }) - }) + private increment (key: string) { + return this.client.incr(this.prefix + key) } - private increment (key: string) { - return new Promise((res, rej) => { - this.client.incr(this.prefix + key, (err, value) => { - if (err) return rej(err) + private async exists (key: string) { + const result = await this.client.exists(this.prefix + key) - return res(value) - }) - }) + return result !== 0 } - private exists (key: string) { - return new Promise((res, rej) => { - this.client.exists(this.prefix + key, (err, existsNumber) => { - if (err) return rej(err) - - return res(existsNumber === 1) - }) - }) + private setExpiration (key: string, ms: number) { + return this.client.expire(this.prefix + key, ms / 1000) } static get Instance () {