-import { createClient } from 'redis'
+import { createClient, RedisClientOptions, RedisModules, RedisScripts } 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,
} from '../initializers/constants'
// Only used for typings
-const redisClientWrapperForType = () => createClient<{}>()
+// TODO: remove when https://github.com/microsoft/TypeScript/issues/37181 is fixed
+const redisClientWrapperForType = () => createClient<{}, RedisScripts>()
class Redis {
this.client = createClient(Redis.getRedisClientOptions())
+ logger.info('Connecting to redis...')
+
this.client.connect()
- .then(() => { this.connected = true })
- .catch(err => {
+ .then(() => {
+ logger.info('Connected to redis.')
+
+ this.connected = true
+ }).catch(err => {
logger.error('Cannot connect to redis', { err })
process.exit(-1)
})
- this.client.on('error', err => {
- logger.error('Error in Redis client.', { err })
- process.exit(-1)
- })
-
this.prefix = 'redis-' + WEBSERVER.HOST + '-'
}
static getRedisClientOptions () {
- return Object.assign({},
- CONFIG.REDIS.AUTH ? { 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<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
}
getClient () {
return this.setValue(this.generateIPViewKey(ip, videoUUID), '1', VIEW_LIFETIME.VIEW)
}
- setIPVideoViewer (ip: string, videoUUID: string) {
- return this.setValue(this.generateIPViewerKey(ip, videoUUID), '1', VIEW_LIFETIME.VIEWER)
- }
-
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))
- }
-
/* ************ Tracker IP block ************ */
setTrackerBlockIP (ip: string) {
])
}
+ /* ************ Video viewers stats ************ */
+
+ getLocalVideoViewer (options: {
+ key?: string
+ // Or
+ ip?: string
+ videoId?: number
+ }) {
+ if (options.key) return this.getObject(options.key)
+
+ const { viewerKey } = this.generateLocalVideoViewerKeys(options.ip, options.videoId)
+
+ return this.getObject(viewerKey)
+ }
+
+ setLocalVideoViewer (ip: string, videoId: number, object: any) {
+ const { setKey, viewerKey } = this.generateLocalVideoViewerKeys(ip, videoId)
+
+ return Promise.all([
+ this.addToSet(setKey, viewerKey),
+ this.setObject(viewerKey, object)
+ ])
+ }
+
+ listLocalVideoViewerKeys () {
+ const { setKey } = this.generateLocalVideoViewerKeys()
+
+ return this.getSet(setKey)
+ }
+
+ deleteLocalVideoViewersKeys (key: string) {
+ const { setKey } = this.generateLocalVideoViewerKeys()
+
+ return Promise.all([
+ this.deleteFromSet(setKey, key),
+ this.deleteKey(key)
+ ])
+ }
+
/* ************ Resumable uploads final responses ************ */
setUploadSession (uploadId: string, response?: { video: { id: number, shortUUID: string, uuid: string } }) {
return this.deleteKey('resumable-upload-' + uploadId)
}
+ /* ************ AP resource 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) {
+ private generateLocalVideoViewsKeys (videoId: number): { setKey: string, videoKey: string }
+ private generateLocalVideoViewsKeys (): { setKey: string }
+ private generateLocalVideoViewsKeys (videoId?: number) {
return { setKey: `local-video-views-buffer`, videoKey: `local-video-views-buffer-${videoId}` }
}
+ private generateLocalVideoViewerKeys (ip: string, videoId: number): { setKey: string, viewerKey: string }
+ private generateLocalVideoViewerKeys (): { setKey: string }
+ private generateLocalVideoViewerKeys (ip?: string, videoId?: number) {
+ return { setKey: `local-video-viewer-stats-keys`, viewerKey: `local-video-viewer-stats-${ip}-${videoId}` }
+ }
+
private generateVideoViewStatsKeys (options: { videoId?: number, hour?: number }) {
const hour = exists(options.hour)
? options.hour
return `views-${videoUUID}-${ip}`
}
- private generateIPViewerKey (ip: string, videoUUID: string) {
- return `viewer-${videoUUID}-${ip}`
- }
-
private generateTrackerBlockIPKey (ip: string) {
return `tracker-block-ip-${ip}`
}
return 'contact-form-' + ip
}
+ private generateAPUnavailabilityKey (url: string) {
+ return 'ap-unavailability-' + sha256(url)
+ }
+
/* ************ Redis helpers ************ */
private getValue (key: string) {
return this.client.del(this.prefix + key)
}
- private async setValue (key: string, value: string, expirationMilliseconds: number) {
- const result = await this.client.set(this.prefix + key, value, { PX: expirationMilliseconds })
+ private async getObject (key: string) {
+ const value = await this.getValue(key)
+ if (!value) return null
+
+ return JSON.parse(value)
+ }
+
+ private setObject (key: string, value: { [ id: string ]: number | string }) {
+ return this.setValue(key, JSON.stringify(value))
+ }
+
+ private async setValue (key: string, value: string, expirationMilliseconds?: number) {
+ const options = expirationMilliseconds
+ ? { PX: expirationMilliseconds }
+ : {}
+
+ const result = await this.client.set(this.prefix + key, value, options)
if (result !== 'OK') throw new Error('Redis set result is not OK.')
}
return this.client.del(this.prefix + key)
}
- private getObject (key: string) {
- return this.client.hGetAll(this.prefix + key)
- }
-
private increment (key: string) {
return this.client.incr(this.prefix + key)
}
- private exists (key: string) {
- return this.client.exists(this.prefix + key)
+ private async exists (key: string) {
+ const result = await this.client.exists(this.prefix + key)
+
+ return result !== 0
+ }
+
+ private setExpiration (key: string, ms: number) {
+ return this.client.expire(this.prefix + key, ms / 1000)
}
static get Instance () {
projects / github / Chocobozzz / PeerTube.git / blobdiff