X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Flib%2Fredis.ts;h=158f3c08090e7106c165847cdac9c49ae14e4cfb;hb=b89b0bfce9bb79d81f9761b07b04d0c4e5aa25c1;hp=46617b07e4ac6405978d9249b1c1f8681b30f9c7;hpb=276250f0a36e00373166d91d539e5220d6f158c7;p=github%2FChocobozzz%2FPeerTube.git

diff --git a/server/lib/redis.ts b/server/lib/redis.ts
index 46617b07e..158f3c080 100644
--- a/server/lib/redis.ts
+++ b/server/lib/redis.ts
@@ -1,30 +1,31 @@
-import express from 'express'
-import { createClient, RedisClient } 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,
   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'
 
-type CachedRoute = {
-  body: string
-  contentType?: string
-  statusCode?: string
-}
+// Only used for typings
+// TODO: remove when https://github.com/microsoft/TypeScript/issues/37181 is fixed
+const redisClientWrapperForType = () => createClient<{}, RedisScripts>()
 
 class Redis {
 
   private static instance: Redis
   private initialized = false
-  private client: RedisClient
+  private connected = false
+  private client: ReturnType<typeof redisClientWrapperForType>
   private prefix: string
 
   private constructor () {
@@ -37,26 +38,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<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 () {
@@ -67,6 +85,10 @@ class Redis {
     return this.prefix
   }
 
+  isConnected () {
+    return this.connected
+  }
+
   /* ************ Forgot password ************ */
 
   async setResetPasswordVerificationString (userId: number) {
@@ -119,16 +141,12 @@ class Redis {
 
   /* ************ Views per IP ************ */
 
-  setIPVideoView (ip: string, videoUUID: string, isLive: boolean) {
-    const lifetime = isLive
-      ? VIEW_LIFETIME.LIVE
-      : VIEW_LIFETIME.VIDEO
-
-    return this.setValue(this.generateViewKey(ip, videoUUID), '1', lifetime)
+  setIPVideoView (ip: string, videoUUID: string) {
+    return this.setValue(this.generateIPViewKey(ip, videoUUID), '1', VIEW_LIFETIME.VIEW)
   }
 
   async doesVideoIPViewExist (ip: string, videoUUID: string) {
-    return this.exists(this.generateViewKey(ip, videoUUID))
+    return this.exists(this.generateIPViewKey(ip, videoUUID))
   }
 
   /* ************ Tracker IP block ************ */
@@ -141,65 +159,124 @@ class Redis {
     return this.exists(this.generateTrackerBlockIPKey(ip))
   }
 
-  /* ************ API cache ************ */
+  /* ************ Video views stats ************ */
 
-  async getCachedRoute (req: express.Request) {
-    const cached = await this.getObject(this.generateCachedRouteKey(req))
+  addVideoViewStats (videoId: number) {
+    const { videoKey, setKey } = this.generateVideoViewStatsKeys({ videoId })
 
-    return cached as CachedRoute
+    return Promise.all([
+      this.addToSet(setKey, videoId.toString()),
+      this.increment(videoKey)
+    ])
   }
 
-  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
-    )
+  async getVideoViewsStats (videoId: number, hour: number) {
+    const { videoKey } = this.generateVideoViewStatsKeys({ videoId, hour })
+
+    const valueString = await this.getValue(videoKey)
+    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)
+      return undefined
+    }
 
-    return this.setObject(this.generateCachedRouteKey(req), cached, lifetime)
+    return valueInt
   }
 
-  /* ************ Video views ************ */
+  async listVideosViewedForStats (hour: number) {
+    const { setKey } = this.generateVideoViewStatsKeys({ hour })
 
-  addVideoView (videoId: number) {
-    const keyIncr = this.generateVideoViewKey(videoId)
-    const keySet = this.generateVideosViewKey()
+    const stringIds = await this.getSet(setKey)
+    return stringIds.map(s => parseInt(s, 10))
+  }
+
+  deleteVideoViewsStats (videoId: number, hour: number) {
+    const { setKey, videoKey } = this.generateVideoViewStatsKeys({ videoId, hour })
 
     return Promise.all([
-      this.addToSet(keySet, videoId.toString()),
-      this.increment(keyIncr)
+      this.deleteFromSet(setKey, videoId.toString()),
+      this.deleteKey(videoKey)
     ])
   }
 
-  async getVideoViews (videoId: number, hour: number) {
-    const key = this.generateVideoViewKey(videoId, hour)
+  /* ************ Local video views buffer ************ */
+
+  addLocalVideoView (videoId: number) {
+    const { videoKey, setKey } = this.generateLocalVideoViewsKeys(videoId)
+
+    return Promise.all([
+      this.addToSet(setKey, videoId.toString()),
+      this.increment(videoKey)
+    ])
+  }
 
-    const valueString = await this.getValue(key)
+  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 in hour %d: views number is NaN (%s).', videoId, hour, valueString)
+      logger.error('Cannot get videos views of video %d: views number is NaN (%s).', videoId, valueString)
       return undefined
     }
 
     return valueInt
   }
 
-  async getVideosIdViewed (hour: number) {
-    const key = this.generateVideosViewKey(hour)
+  async listLocalVideosViewed () {
+    const { setKey } = this.generateLocalVideoViewsKeys()
 
-    const stringIds = await this.getSet(key)
+    const stringIds = await this.getSet(setKey)
     return stringIds.map(s => parseInt(s, 10))
   }
 
-  deleteVideoViews (videoId: number, hour: number) {
-    const keySet = this.generateVideosViewKey(hour)
-    const keyIncr = this.generateVideoViewKey(videoId, hour)
+  deleteLocalVideoViews (videoId: number) {
+    const { setKey, videoKey } = this.generateLocalVideoViewsKeys(videoId)
+
+    return Promise.all([
+      this.deleteFromSet(setKey, videoId.toString()),
+      this.deleteKey(videoKey)
+    ])
+  }
+
+  /* ************ 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(keySet, videoId.toString()),
-      this.deleteKey(keyIncr)
+      this.deleteFromSet(setKey, key),
+      this.deleteKey(key)
     ])
   }
 
@@ -227,22 +304,41 @@ class Redis {
       : ''
   }
 
-  /* ************ Keys generation ************ */
+  deleteUploadSession (uploadId: string) {
+    return this.deleteKey('resumable-upload-' + uploadId)
+  }
+
+  /* ************ AP resource unavailability ************ */
+
+  async addAPUnavailability (url: string) {
+    const key = this.generateAPUnavailabilityKey(url)
 
-  generateCachedRouteKey (req: express.Request) {
-    return req.method + '-' + req.originalUrl
+    const value = await this.increment(key)
+    await this.setExpiration(key, AP_CLEANER.PERIOD * 2)
+
+    return value
   }
 
-  private generateVideosViewKey (hour?: number) {
-    if (!hour) hour = new Date().getHours()
+  /* ************ Keys generation ************ */
+
+  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}` }
+  }
 
-    return `videos-view-h${hour}`
+  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 generateVideoViewKey (videoId: number, hour?: number) {
-    if (hour === undefined || hour === null) hour = new Date().getHours()
+  private generateVideoViewStatsKeys (options: { videoId?: number, hour?: number }) {
+    const hour = exists(options.hour)
+      ? options.hour
+      : new Date().getHours()
 
-    return `video-view-${videoId}-h${hour}`
+    return { setKey: `videos-view-h${hour}`, videoKey: `video-view-${options.videoId}-h${hour}` }
   }
 
   private generateResetPasswordKey (userId: number) {
@@ -253,7 +349,7 @@ class Redis {
     return 'verify-email-' + userId
   }
 
-  private generateViewKey (ip: string, videoUUID: string) {
+  private generateIPViewKey (ip: string, videoUUID: string) {
     return `views-${videoUUID}-${ip}`
   }
 
@@ -265,128 +361,69 @@ class Redis {
     return 'contact-form-' + ip
   }
 
+  private generateAPUnavailabilityKey (url: string) {
+    return 'ap-unavailability-' + sha256(url)
+  }
+
   /* ************ Redis helpers ************ */
 
   private getValue (key: string) {
-    return new Promise<string>((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<string[]>((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<void>((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<void>((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<void>((res, rej) => {
-      this.client.del(this.prefix + key, err => err ? rej(err) : res())
-    })
-  }
-
-  private deleteFieldInHash (key: string, field: string) {
-    return new Promise<void>((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<void>((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 getObject (key: string) {
+    const value = await this.getValue(key)
+    if (!value) return null
 
-        return res()
-      })
-    })
+    return JSON.parse(value)
   }
 
-  private removeValue (key: string) {
-    return new Promise<void>((res, rej) => {
-      this.client.del(this.prefix + key, err => {
-        if (err) return rej(err)
-
-        return res()
-      })
-    })
+  private setObject (key: string, value: { [ id: string ]: number | string }) {
+    return this.setValue(key, JSON.stringify(value))
   }
 
-  private setObject (key: string, obj: { [id: string]: string }, expirationMilliseconds: number) {
-    return new Promise<void>((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.'))
+  private async setValue (key: string, value: string, expirationMilliseconds?: number) {
+    const options = expirationMilliseconds
+      ? { PX: expirationMilliseconds }
+      : {}
 
-        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.'))
+    const result = await this.client.set(this.prefix + key, value, options)
 
-          return res()
-        })
-      })
-    })
+    if (result !== 'OK') throw new Error('Redis set result is not OK.')
   }
 
-  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 removeValue (key: string) {
+    return this.client.del(this.prefix + key)
   }
 
-  private setValueInHash (key: string, field: string, value: string) {
-    return new Promise<void>((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<number>((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<boolean>((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 () {