From 3475ad4674e9d92e8d8ed416047213c4a8495ded Mon Sep 17 00:00:00 2001
From: paweldomas <pawel.domas@jitsi.org>
Date: Wed, 30 Nov 2016 07:34:38 -0600
Subject: [PATCH] ref(LogCollector): adapts to caching in LogCollector

---
 app.js                              | 33 ++++++++++++++++++++---------
 modules/util/JitsiMeetLogStorage.js | 21 ++++++++++++------
 2 files changed, 37 insertions(+), 17 deletions(-)

diff --git a/app.js b/app.js
index 4b8da6c68..ced7a2ce6 100644
--- a/app.js
+++ b/app.js
@@ -162,7 +162,10 @@ const APP = {
     initLogging () {
         // Adjust logging level
         configureLoggingLevels();
-        // Start the LogCollector and register it as the global log transport
+        // Create the LogCollector and register it as the global log transport.
+        // It is done early to capture as much logs as possible. Captured logs
+        // will be cached, before the JitsiMeetLogStorage gets ready (statistics
+        // module is initialized).
         if (!this.logCollector && !loggingConfig.disableLogCollector) {
             this.logCollector = new LogCollector(new JitsiMeetLogStorage());
             Logger.addGlobalTransport(this.logCollector);
@@ -189,19 +192,29 @@ function init() {
     APP.ConferenceUrl = new ConferenceUrl(window.location);
     // Clean up the URL displayed by the browser
     replaceHistoryState(APP.ConferenceUrl.getInviteUrl());
-    var isUIReady = APP.UI.start();
+    const isUIReady = APP.UI.start();
     if (isUIReady) {
-        // Start the LogCollector's periodic "store logs" task only if we're in
-        // the conference and not on the welcome page.
-        if (APP.logCollector) {
-            APP.logCollector.start();
-            APP.logCollectorStarted = true;
-        }
-
         APP.conference.init({roomName: buildRoomName()}).then(function () {
 
-            // Will flush the logs, before the stats are disposed
             if (APP.logCollector) {
+                // Start the LogCollector's periodic "store logs" task only if
+                // we're in the conference and not on the welcome page. This is
+                // determined by the value of "isUIReady" const above.
+                APP.logCollector.start();
+                APP.logCollectorStarted = true;
+                // Make an attempt to flush in case a lot of logs have been
+                // cached, before the collector was started.
+                APP.logCollector.flush();
+
+                // This event listener will flush the logs, before
+                // the statistics module (CallStats) is stopped.
+                //
+                // NOTE The LogCollector is not stopped, because this event can
+                // be triggered multiple times during single conference
+                // (whenever statistics module is stopped). That includes
+                // the case when Jicofo terminates the single person left in the
+                // room. It will then restart the media session when someone
+                // eventually join the room which will start the stats again.
                 APP.conference.addConferenceListener(
                     ConferenceEvents.BEFORE_STATISTICS_DISPOSED,
                     () => {
diff --git a/modules/util/JitsiMeetLogStorage.js b/modules/util/JitsiMeetLogStorage.js
index 1dfa9f9e4..7d130191b 100644
--- a/modules/util/JitsiMeetLogStorage.js
+++ b/modules/util/JitsiMeetLogStorage.js
@@ -16,6 +16,14 @@ export default class JitsiMeetLogStorage {
         this.counter = 1;
     }
 
+    /**
+     * @return {boolean} <tt>true</tt> when this storage is ready or
+     * <tt>false</tt> otherwise.
+     */
+    isReady() {
+        return APP.logCollectorStarted && APP.conference;
+    }
+
     /**
      * Called by the <tt>LogCollector</tt> to store a series of log lines into
      * batch.
@@ -24,6 +32,11 @@ export default class JitsiMeetLogStorage {
      */
     storeLogs(logEntries) {
 
+        if (!APP.conference.isCallstatsEnabled()) {
+            // Discard the logs if CallStats is not enabled.
+            return;
+        }
+
         let logJSON = '{"log' + this.counter + '":"\n';
         for (let i = 0, len = logEntries.length; i < len; i++) {
             let logEntry = logEntries[i];
@@ -43,13 +56,7 @@ export default class JitsiMeetLogStorage {
         // on the way that could be uninitialized if the storeLogs
         // attempt would be made very early (which is unlikely)
         try {
-            // Currently it makes sense to store the log only
-            // if CallStats is enabled
-            if (APP.logCollectorStarted
-                    && APP.conference
-                    && APP.conference.isCallstatsEnabled()) {
-                APP.conference.logJSON(logJSON);
-            }
+            APP.conference.logJSON(logJSON);
         } catch (error) {
             // NOTE console is intentional here
             console.error(