PeerTube/server/lib/redis.ts

389 lines
10 KiB
TypeScript
Raw Normal View History

2022-03-21 14:20:47 +01:00
import { createClient, RedisClientOptions, RedisModules, RedisScripts } from 'redis'
2021-12-24 14:49:03 +01:00
import { exists } from '@server/helpers/custom-validators/misc'
2021-12-28 11:36:51 +01:00
import { sha256 } from '@shared/extra-utils'
2018-01-30 13:27:07 +01:00
import { logger } from '../helpers/logger'
import { generateRandomString } from '../helpers/utils'
2021-12-24 14:49:03 +01:00
import { CONFIG } from '../initializers/config'
2019-01-09 15:14:29 +01:00
import {
2021-12-28 11:36:51 +01:00
AP_CLEANER,
2019-01-09 15:14:29 +01:00
CONTACT_FORM_LIFETIME,
2021-12-24 14:49:03 +01:00
RESUMABLE_UPLOAD_SESSION_LIFETIME,
TRACKER_RATE_LIMITS,
2019-01-09 15:14:29 +01:00
USER_EMAIL_VERIFY_LIFETIME,
USER_PASSWORD_CREATE_LIFETIME,
2021-12-24 14:49:03 +01:00
USER_PASSWORD_RESET_LIFETIME,
2020-11-06 16:42:23 +01:00
VIEW_LIFETIME,
2021-12-24 14:49:03 +01:00
WEBSERVER
} from '../initializers/constants'
2018-04-17 14:01:06 +02:00
2021-12-24 14:49:03 +01:00
// Only used for typings
2022-02-01 16:38:07 +01:00
// TODO: remove when https://github.com/microsoft/TypeScript/issues/37181 is fixed
2022-03-21 14:20:47 +01:00
const redisClientWrapperForType = () => createClient<{}, RedisScripts>()
2018-01-30 13:27:07 +01:00
class Redis {
private static instance: Redis
private initialized = false
2021-12-24 14:49:03 +01:00
private connected = false
private client: ReturnType<typeof redisClientWrapperForType>
2018-01-30 13:27:07 +01:00
private prefix: string
2020-01-31 16:56:52 +01:00
private constructor () {
}
2018-01-30 13:27:07 +01:00
init () {
// Already initialized
if (this.initialized === true) return
this.initialized = true
this.client = createClient(Redis.getRedisClientOptions())
2018-01-30 13:27:07 +01:00
2022-01-04 09:16:43 +01:00
logger.info('Connecting to redis...')
2021-12-24 14:49:03 +01:00
this.client.connect()
2022-01-04 09:16:43 +01:00
.then(() => {
logger.info('Connected to redis.')
this.connected = true
}).catch(err => {
2021-12-24 14:49:03 +01:00
logger.error('Cannot connect to redis', { err })
process.exit(-1)
})
2019-04-11 11:33:44 +02:00
this.prefix = 'redis-' + WEBSERVER.HOST + '-'
2018-01-30 13:27:07 +01:00
}
static getRedisClientOptions () {
2022-01-04 09:16:43 +01:00
let config: RedisClientOptions<RedisModules, {}> = {
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
2018-05-14 17:51:15 +02:00
}
getClient () {
return this.client
}
getPrefix () {
return this.prefix
}
2021-12-24 14:49:03 +01:00
isConnected () {
return this.connected
}
2020-01-31 16:56:52 +01:00
/* ************ Forgot password ************ */
2018-10-05 11:15:06 +02:00
2018-01-30 13:27:07 +01:00
async setResetPasswordVerificationString (userId: number) {
const generatedString = await generateRandomString(32)
await this.setValue(this.generateResetPasswordKey(userId), generatedString, USER_PASSWORD_RESET_LIFETIME)
return generatedString
}
async setCreatePasswordVerificationString (userId: number) {
const generatedString = await generateRandomString(32)
await this.setValue(this.generateResetPasswordKey(userId), generatedString, USER_PASSWORD_CREATE_LIFETIME)
2018-01-30 13:27:07 +01:00
return generatedString
}
2020-08-12 09:15:31 +02:00
async removePasswordVerificationString (userId: number) {
return this.removeValue(this.generateResetPasswordKey(userId))
}
2018-01-30 13:27:07 +01:00
async getResetPasswordLink (userId: number) {
return this.getValue(this.generateResetPasswordKey(userId))
}
2020-01-31 16:56:52 +01:00
/* ************ Email verification ************ */
2018-10-05 11:15:06 +02:00
async setVerifyEmailVerificationString (userId: number) {
const generatedString = await generateRandomString(32)
await this.setValue(this.generateVerifyEmailKey(userId), generatedString, USER_EMAIL_VERIFY_LIFETIME)
return generatedString
}
async getVerifyEmailLink (userId: number) {
return this.getValue(this.generateVerifyEmailKey(userId))
}
2020-01-31 16:56:52 +01:00
/* ************ Contact form per IP ************ */
2019-01-09 15:14:29 +01:00
async setContactFormIp (ip: string) {
return this.setValue(this.generateContactFormKey(ip), '1', CONTACT_FORM_LIFETIME)
}
2019-03-19 09:26:50 +01:00
async doesContactFormIpExist (ip: string) {
2019-01-09 15:14:29 +01:00
return this.exists(this.generateContactFormKey(ip))
}
2020-01-31 16:56:52 +01:00
/* ************ Views per IP ************ */
2018-10-05 11:15:06 +02:00
setIPVideoView (ip: string, videoUUID: string) {
return this.setValue(this.generateIPViewKey(ip, videoUUID), '1', VIEW_LIFETIME.VIEW)
}
2020-11-06 16:42:23 +01:00
setIPVideoViewer (ip: string, videoUUID: string) {
return this.setValue(this.generateIPViewerKey(ip, videoUUID), '1', VIEW_LIFETIME.VIEWER)
2018-02-23 16:39:51 +01:00
}
2019-03-19 09:26:50 +01:00
async doesVideoIPViewExist (ip: string, videoUUID: string) {
return this.exists(this.generateIPViewKey(ip, videoUUID))
}
async doesVideoIPViewerExist (ip: string, videoUUID: string) {
return this.exists(this.generateIPViewerKey(ip, videoUUID))
2018-02-23 16:39:51 +01:00
}
2020-06-25 16:27:35 +02:00
/* ************ Tracker IP block ************ */
setTrackerBlockIP (ip: string) {
return this.setValue(this.generateTrackerBlockIPKey(ip), '1', TRACKER_RATE_LIMITS.BLOCK_IP_LIFETIME)
}
async doesTrackerBlockIPExist (ip: string) {
return this.exists(this.generateTrackerBlockIPKey(ip))
}
/* ************ Video views stats ************ */
2018-10-05 11:15:06 +02:00
addVideoViewStats (videoId: number) {
const { videoKey, setKey } = this.generateVideoViewStatsKeys({ videoId })
2018-08-29 16:26:25 +02:00
return Promise.all([
this.addToSet(setKey, videoId.toString()),
this.increment(videoKey)
2018-08-29 16:26:25 +02:00
])
}
async getVideoViewsStats (videoId: number, hour: number) {
const { videoKey } = this.generateVideoViewStatsKeys({ videoId, hour })
2018-08-29 16:26:25 +02:00
const valueString = await this.getValue(videoKey)
2018-12-04 16:02:49 +01:00
const valueInt = parseInt(valueString, 10)
if (isNaN(valueInt)) {
logger.error('Cannot get videos views stats of video %d in hour %d: views number is NaN (%s).', videoId, hour, valueString)
2018-12-04 16:02:49 +01:00
return undefined
}
return valueInt
2018-08-29 16:26:25 +02:00
}
async listVideosViewedForStats (hour: number) {
const { setKey } = this.generateVideoViewStatsKeys({ hour })
2018-08-29 16:26:25 +02:00
const stringIds = await this.getSet(setKey)
2018-08-29 16:26:25 +02:00
return stringIds.map(s => parseInt(s, 10))
}
deleteVideoViewsStats (videoId: number, hour: number) {
const { setKey, videoKey } = this.generateVideoViewStatsKeys({ videoId, hour })
return Promise.all([
this.deleteFromSet(setKey, videoId.toString()),
this.deleteKey(videoKey)
])
}
/* ************ Local video views buffer ************ */
addLocalVideoView (videoId: number) {
const { videoKey, setKey } = this.generateLocalVideoViewsKeys(videoId)
2018-08-29 16:26:25 +02:00
return Promise.all([
this.addToSet(setKey, videoId.toString()),
this.increment(videoKey)
])
}
async getLocalVideoViews (videoId: number) {
const { videoKey } = this.generateLocalVideoViewsKeys(videoId)
const valueString = await this.getValue(videoKey)
const valueInt = parseInt(valueString, 10)
if (isNaN(valueInt)) {
logger.error('Cannot get videos views of video %d: views number is NaN (%s).', videoId, valueString)
return undefined
}
return valueInt
}
async listLocalVideosViewed () {
const { setKey } = this.generateLocalVideoViewsKeys()
const stringIds = await this.getSet(setKey)
return stringIds.map(s => parseInt(s, 10))
}
deleteLocalVideoViews (videoId: number) {
const { setKey, videoKey } = this.generateLocalVideoViewsKeys(videoId)
return Promise.all([
this.deleteFromSet(setKey, videoId.toString()),
this.deleteKey(videoKey)
2018-08-29 16:26:25 +02:00
])
}
/* ************ Resumable uploads final responses ************ */
setUploadSession (uploadId: string, response?: { video: { id: number, shortUUID: string, uuid: string } }) {
return this.setValue(
'resumable-upload-' + uploadId,
response
? JSON.stringify(response)
: '',
RESUMABLE_UPLOAD_SESSION_LIFETIME
)
}
doesUploadSessionExist (uploadId: string) {
return this.exists('resumable-upload-' + uploadId)
}
async getUploadSession (uploadId: string) {
const value = await this.getValue('resumable-upload-' + uploadId)
return value
? JSON.parse(value)
: ''
}
deleteUploadSession (uploadId: string) {
return this.deleteKey('resumable-upload-' + uploadId)
}
2021-12-28 11:36:51 +01:00
/* ************ 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
}
2020-01-31 16:56:52 +01:00
/* ************ Keys generation ************ */
2018-10-05 11:15:06 +02:00
private generateLocalVideoViewsKeys (videoId?: Number) {
return { setKey: `local-video-views-buffer`, videoKey: `local-video-views-buffer-${videoId}` }
2018-08-29 16:26:25 +02:00
}
private generateVideoViewStatsKeys (options: { videoId?: number, hour?: number }) {
const hour = exists(options.hour)
? options.hour
: new Date().getHours()
2018-08-29 16:26:25 +02:00
return { setKey: `videos-view-h${hour}`, videoKey: `video-view-${options.videoId}-h${hour}` }
2018-08-29 16:26:25 +02:00
}
2018-10-05 11:15:06 +02:00
private generateResetPasswordKey (userId: number) {
return 'reset-password-' + userId
}
2018-10-05 11:15:06 +02:00
private generateVerifyEmailKey (userId: number) {
return 'verify-email-' + userId
}
private generateIPViewKey (ip: string, videoUUID: string) {
2019-01-09 15:14:29 +01:00
return `views-${videoUUID}-${ip}`
}
private generateIPViewerKey (ip: string, videoUUID: string) {
return `viewer-${videoUUID}-${ip}`
}
2020-06-25 16:27:35 +02:00
private generateTrackerBlockIPKey (ip: string) {
return `tracker-block-ip-${ip}`
}
2019-01-09 15:14:29 +01:00
private generateContactFormKey (ip: string) {
return 'contact-form-' + ip
}
2021-12-28 11:36:51 +01:00
private generateAPUnavailabilityKey (url: string) {
return 'ap-unavailability-' + sha256(url)
}
2020-01-31 16:56:52 +01:00
/* ************ Redis helpers ************ */
2018-01-30 13:27:07 +01:00
private getValue (key: string) {
2021-12-24 14:49:03 +01:00
return this.client.get(this.prefix + key)
2018-01-30 13:27:07 +01:00
}
2018-08-29 16:26:25 +02:00
private getSet (key: string) {
2021-12-24 14:49:03 +01:00
return this.client.sMembers(this.prefix + key)
2018-08-29 16:26:25 +02:00
}
private addToSet (key: string, value: string) {
2021-12-24 14:49:03 +01:00
return this.client.sAdd(this.prefix + key, value)
2018-08-29 16:26:25 +02:00
}
private deleteFromSet (key: string, value: string) {
2021-12-24 14:49:03 +01:00
return this.client.sRem(this.prefix + key, value)
2018-08-29 16:26:25 +02:00
}
private deleteKey (key: string) {
2021-12-24 14:49:03 +01:00
return this.client.del(this.prefix + key)
2018-10-05 11:15:06 +02:00
}
2021-12-24 14:49:03 +01:00
private async setValue (key: string, value: string, expirationMilliseconds: number) {
const result = await this.client.set(this.prefix + key, value, { PX: expirationMilliseconds })
2018-01-30 13:27:07 +01:00
2021-12-24 14:49:03 +01:00
if (result !== 'OK') throw new Error('Redis set result is not OK.')
2018-01-30 13:27:07 +01:00
}
2020-08-12 09:15:31 +02:00
private removeValue (key: string) {
2021-12-24 14:49:03 +01:00
return this.client.del(this.prefix + key)
2018-04-17 14:01:06 +02:00
}
2018-08-29 16:26:25 +02:00
private increment (key: string) {
2021-12-24 14:49:03 +01:00
return this.client.incr(this.prefix + key)
2018-08-29 16:26:25 +02:00
}
2022-01-14 14:15:23 +01:00
private async exists (key: string) {
const result = await this.client.exists(this.prefix + key)
return result !== 0
2018-02-23 16:39:51 +01:00
}
2021-12-28 11:36:51 +01:00
private setExpiration (key: string, ms: number) {
return this.client.expire(this.prefix + key, ms / 1000)
}
2018-01-30 13:27:07 +01:00
static get Instance () {
return this.instance || (this.instance = new this())
}
}
// ---------------------------------------------------------------------------
export {
Redis
}