From b4dabfeeb920c7f27e6529010eef6611f3461cfa Mon Sep 17 00:00:00 2001
From: John Livingston <git@john-livingston.fr>
Date: Thu, 13 Apr 2023 15:41:46 +0200
Subject: [PATCH] New debug mode:

Debug mode is no more triggered by the NODE_ENV value, but by testing
the existance of a file in the plugin data directory.
---
 CHANGELOG.md                                  |  1 +
 server/lib/debug.ts                           | 19 +++++++++++++++++++
 server/lib/diagnostic/backend.ts              |  2 +-
 server/lib/diagnostic/debug.ts                | 12 ++++++++++++
 server/lib/diagnostic/index.ts                |  3 +++
 server/lib/diagnostic/utils.ts                |  2 +-
 server/lib/prosody/ctl.ts                     |  2 +-
 server/lib/prosody/logrotate.ts               |  6 ++++--
 .../content/contributing/develop/_index.de.md | 13 +++++++++++++
 .../content/contributing/develop/_index.en.md | 13 +++++++++++++
 .../content/contributing/develop/_index.fr.md | 14 ++++++++++++++
 11 files changed, 82 insertions(+), 5 deletions(-)
 create mode 100644 server/lib/debug.ts
 create mode 100644 server/lib/diagnostic/debug.ts

diff --git a/CHANGELOG.md b/CHANGELOG.md
index e64cabe1..02c8a67f 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -9,6 +9,7 @@
 ### Minor changes and fixes
 
 * Diagnostic tool: add the result of `prosodyctl check` in the debug section.
+* New debug mode
 
 ## 6.2.3
 
diff --git a/server/lib/debug.ts b/server/lib/debug.ts
new file mode 100644
index 00000000..10408939
--- /dev/null
+++ b/server/lib/debug.ts
@@ -0,0 +1,19 @@
+import type { RegisterServerOptions } from '@peertube/peertube-types'
+import * as path from 'path'
+import * as fs from 'fs'
+
+export function isDebugMode (options: RegisterServerOptions): boolean {
+  const peertubeHelpers = options.peertubeHelpers
+  const logger = peertubeHelpers.logger
+
+  if (!peertubeHelpers.plugin) {
+    return false
+  }
+  const filepath = path.resolve(peertubeHelpers.plugin.getDataDirectoryPath(), 'debug_mode')
+  logger.debug('Testing debug mode by testing if file exists: ' + filepath)
+  if (fs.existsSync(filepath)) {
+    logger.info('Plugin livechat Debug mode is on.')
+    return true
+  }
+  return false
+}
diff --git a/server/lib/diagnostic/backend.ts b/server/lib/diagnostic/backend.ts
index d3500e88..19ec75d8 100644
--- a/server/lib/diagnostic/backend.ts
+++ b/server/lib/diagnostic/backend.ts
@@ -5,6 +5,6 @@ export async function diagBackend (test: string, _options: RegisterServerOptions
   const result = newResult(test)
   result.label = 'Backend connection'
   result.ok = true
-  result.next = 'webchat-video'
+  result.next = 'debug'
   return result
 }
diff --git a/server/lib/diagnostic/debug.ts b/server/lib/diagnostic/debug.ts
new file mode 100644
index 00000000..91bb16d8
--- /dev/null
+++ b/server/lib/diagnostic/debug.ts
@@ -0,0 +1,12 @@
+import type { RegisterServerOptions } from '@peertube/peertube-types'
+import { newResult, TestResult } from './utils'
+import { isDebugMode } from '../../lib/debug'
+
+export async function diagDebug (test: string, options: RegisterServerOptions): Promise<TestResult> {
+  const result = newResult(test)
+  result.label = 'Test debug mode'
+  result.ok = true
+  result.messages = [isDebugMode(options) ? 'Debug mode is ON' : 'Debug mode is OFF']
+  result.next = 'webchat-video'
+  return result
+}
diff --git a/server/lib/diagnostic/index.ts b/server/lib/diagnostic/index.ts
index 60fe3bf1..56a3ae06 100644
--- a/server/lib/diagnostic/index.ts
+++ b/server/lib/diagnostic/index.ts
@@ -1,6 +1,7 @@
 import type { RegisterServerOptions } from '@peertube/peertube-types'
 import { diagBackend } from './backend'
 import { TestResult, newResult } from './utils'
+import { diagDebug } from './debug'
 import { diagProsody } from './prosody'
 import { diagVideo } from './video'
 
@@ -9,6 +10,8 @@ export async function diag (test: string, options: RegisterServerOptions): Promi
 
   if (test === 'backend') {
     result = await diagBackend(test, options)
+  } else if (test === 'debug') {
+    result = await diagDebug(test, options)
   } else if (test === 'webchat-video') {
     result = await diagVideo(test, options)
   } else if (test === 'prosody') {
diff --git a/server/lib/diagnostic/utils.ts b/server/lib/diagnostic/utils.ts
index 105de414..a7ccbbaa 100644
--- a/server/lib/diagnostic/utils.ts
+++ b/server/lib/diagnostic/utils.ts
@@ -1,4 +1,4 @@
-type nextValue = 'backend' | 'webchat-video' | 'prosody'
+type nextValue = 'backend' | 'debug' | 'webchat-video' | 'prosody'
 
 interface MessageWithLevel {
   level: 'info' | 'warning' | 'error'
diff --git a/server/lib/prosody/ctl.ts b/server/lib/prosody/ctl.ts
index 10103543..9a1b36e5 100644
--- a/server/lib/prosody/ctl.ts
+++ b/server/lib/prosody/ctl.ts
@@ -347,7 +347,7 @@ async function ensureProsodyRunning (options: RegisterServerOptions): Promise<vo
     return
   }
   logger.info('Prosody is running')
-  startProsodyLogRotate(options, filePaths, reloadProsody)
+  await startProsodyLogRotate(options, filePaths, reloadProsody)
 }
 
 async function ensureProsodyNotRunning (options: RegisterServerOptions): Promise<void> {
diff --git a/server/lib/prosody/logrotate.ts b/server/lib/prosody/logrotate.ts
index 4eb3abf6..e5e6f464 100644
--- a/server/lib/prosody/logrotate.ts
+++ b/server/lib/prosody/logrotate.ts
@@ -1,5 +1,6 @@
 import type { RegisterServerOptions } from '@peertube/peertube-types'
 import type { ProsodyFilePaths } from './config/paths'
+import { isDebugMode } from '../debug'
 
 type Rotate = (file: string, options: {
   count?: number
@@ -32,8 +33,9 @@ async function _rotate (options: RegisterServerOptions, path: string): Promise<v
 
 function startProsodyLogRotate (options: RegisterServerOptions, paths: ProsodyFilePaths, reload: ReloadProsody): void {
   const logger = options.peertubeHelpers.logger
-  const checkInterval = process.env.NODE_ENV === 'test' ? 60 * 1000 : 60 * 60 * 1000 // check every hour
-  const rotateEvery = process.env.NODE_ENV === 'test' ? 2 * 60 * 1000 : 24 * 60 * 60 * 1000 // rotate every 24hour
+  const debugMode = isDebugMode(options)
+  const checkInterval = debugMode ? 60 * 1000 : 60 * 60 * 1000 // check every hour
+  const rotateEvery = debugMode ? 2 * 60 * 1000 : 24 * 60 * 60 * 1000 // rotate every 24hour
   // TODO: also rotate when file is too big
 
   if (logRotate) {
diff --git a/support/documentation/content/contributing/develop/_index.de.md b/support/documentation/content/contributing/develop/_index.de.md
index 4b234547..2e4bb501 100644
--- a/support/documentation/content/contributing/develop/_index.de.md
+++ b/support/documentation/content/contributing/develop/_index.de.md
@@ -64,3 +64,16 @@ ESBuild kann mit Typescript umgehen, prüft aber keine Typen
 (siehe [ESBuild-Dokumentation](https://esbuild.github.io/content-types/#typescript)).
 Deshalb kompilieren wir Typescript zuerst mit der Option `-noEmit`, nur um die Typen zu überprüfen (`check:client:ts` in der package.json Datei).
 Dann, wenn alles in Ordnung ist, führen wir ESBuild aus, um das kompilierte Javascript zu erzeugen.
+
+## Debug Mode
+
+There is a debug mode for this plugin, that shorten some delay.
+For example, some log files will rotate every two minutes, instead of once per day.
+This permit to test more easily certain actions, for which it could normally take hours or days to wait.
+
+To enable this mode, you juste have to create the
+`/var/www/peertube/storage/plugins/data/peertube-plugin-livechat/debug_mode` file
+(replacing `/var/www/peertube/storage/` by the correct path on your installation).
+
+The simple existence of this file is sufficient to trigger the debug mode.
+To make sure it's taken into account, you can restart your Peertube instance.
diff --git a/support/documentation/content/contributing/develop/_index.en.md b/support/documentation/content/contributing/develop/_index.en.md
index 2c2232fa..c2d3c788 100644
--- a/support/documentation/content/contributing/develop/_index.en.md
+++ b/support/documentation/content/contributing/develop/_index.en.md
@@ -66,3 +66,16 @@ ESBuild can handle Typescript, but does not check types
 (see [ESBuild documentation](https://esbuild.github.io/content-types/#typescript)).
 That's why we first compile Typescript with the `-noEmit` option, just to check types (`check:client:ts` in package.json file).
 Then, if everything is okay, we run ESBuild to generate the compiled javascript.
+
+## Debug Mode
+
+There is a debug mode for this plugin, that shorten some delay.
+For example, some log files will rotate every two minutes, instead of once per day.
+This permit to test more easily certain actions, for which it could normally take hours or days to wait.
+
+To enable this mode, you juste have to create the
+`/var/www/peertube/storage/plugins/data/peertube-plugin-livechat/debug_mode` file
+(replacing `/var/www/peertube/storage/` by the correct path on your installation).
+
+The simple existence of this file is sufficient to trigger the debug mode.
+To make sure it's taken into account, you can restart your Peertube instance.
diff --git a/support/documentation/content/contributing/develop/_index.fr.md b/support/documentation/content/contributing/develop/_index.fr.md
index a8a79448..b65f1be0 100644
--- a/support/documentation/content/contributing/develop/_index.fr.md
+++ b/support/documentation/content/contributing/develop/_index.fr.md
@@ -64,3 +64,17 @@ ESBuild peut gérer Typescript, mais ne vérifie pas les types
 (voir [la documentation ESBuild](https://esbuild.github.io/content-types/#typescript)).
 C'est pourquoi on compile d'abord Typescript avec l'option `-noEmit`, juste pour vérifier les types (`check:client:ts` dans le fichier package.json).
 Ensuite, si tout est ok, on lance ESBuild pour générer le javascript compilé.
+
+## Debug Mode
+
+Il existe un mode de debug pour le plugin, qui va raccourcir le délais de certaines actions.
+Par exemple, il va faire tourner les journaux toutes les deux minutes, au lieu de tous les jours.
+Cela permet de tester plus facilement certaines actions, pour lesquelles il faudrait normalement attendre
+des heures ou des jours.
+
+Pour activer ce mode, il suffit de créer un fichier
+`/var/www/peertube/storage/plugins/data/peertube-plugin-livechat/debug_mode`
+(en adaptant `/var/www/peertube/storage/` à votre installation le cas échéant).
+
+La simple existance de ce fichier suffit à déclencher le mode debug.
+Pour être sûr qu'il est pris en compte, vous pouvez redémarrer votre instance Peertube.