From b211106695bb82f6c32e53306081b5262c3d109d Mon Sep 17 00:00:00 2001
From: Chocobozzz <me@florianbigard.com>
Date: Thu, 24 Mar 2022 13:36:47 +0100
Subject: Support video views/viewers stats in server

 * Add "currentTime" and "event" body params to view endpoint
 * Merge watching and view endpoints
 * Introduce WatchAction AP activity
 * Add tables to store viewer information of local videos
 * Add endpoints to fetch video views/viewers stats of local videos
 * Refactor views/viewers handlers
 * Support "views" and "viewers" counters for both VOD and live videos
---
 shared/server-commands/videos/views-command.ts | 51 ++++++++++++++++++++++++++
 1 file changed, 51 insertions(+)
 create mode 100644 shared/server-commands/videos/views-command.ts

(limited to 'shared/server-commands/videos/views-command.ts')

diff --git a/shared/server-commands/videos/views-command.ts b/shared/server-commands/videos/views-command.ts
new file mode 100644
index 000000000..01113f798
--- /dev/null
+++ b/shared/server-commands/videos/views-command.ts
@@ -0,0 +1,51 @@
+/* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/no-floating-promises */
+import { HttpStatusCode, VideoViewEvent } from '@shared/models'
+import { AbstractCommand, OverrideCommandOptions } from '../shared'
+
+export class ViewsCommand extends AbstractCommand {
+
+  view (options: OverrideCommandOptions & {
+    id: number | string
+    currentTime?: number
+    viewEvent?: VideoViewEvent
+    xForwardedFor?: string
+  }) {
+    const { id, xForwardedFor, viewEvent, currentTime } = options
+    const path = '/api/v1/videos/' + id + '/views'
+
+    return this.postBodyRequest({
+      ...options,
+
+      path,
+      xForwardedFor,
+      fields: {
+        currentTime: currentTime ?? 1,
+        viewEvent
+      },
+      implicitToken: false,
+      defaultExpectedStatus: HttpStatusCode.NO_CONTENT_204
+    })
+  }
+
+  async simulateView (options: OverrideCommandOptions & {
+    id: number | string
+    xForwardedFor?: string
+  }) {
+    await this.view({ ...options, currentTime: 0 })
+    await this.view({ ...options, currentTime: 5 })
+  }
+
+  async simulateViewer (options: OverrideCommandOptions & {
+    id: number | string
+    currentTimes: number[]
+    xForwardedFor?: string
+  }) {
+    let viewEvent: VideoViewEvent = 'seek'
+
+    for (const currentTime of options.currentTimes) {
+      await this.view({ ...options, currentTime, viewEvent })
+
+      viewEvent = undefined
+    }
+  }
+}
-- 
cgit v1.2.3