Merge pull request #191 from bridie-hifi/2021-10-14-release

10/14 Weekly merge into release

package.json

@@ -1,6 +1,6 @@
 {
   "name": "hifi-spatial-audio",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "description": "The High Fidelity Audio Client Library allows developers to integrate High Fidelity's spatial audio technology into their projects.",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -57,6 +57,7 @@
   "dependencies": {
     "esm": "^3.2.25",
     "pako": "^2.0.3",
+    "uuid": "^8.3.2",
     "wrtc": "^0.4.7",
     "ws": "^7.4.2"
   },

src/classes/HiFiMixerSession.ts

@@ -1011,7 +1011,7 @@ export class HiFiMixerSession {
                 this._hifiDiagnostics.prime(this.mixerInfo.visit_id_hash);
                 this._copyAudioTracksFromRavi();
             } else {
-                this._hifiDiagnostics.fire();
+                this._hifiDiagnostics.fire(state.toString());
             }
         }
 
@@ -1070,7 +1070,7 @@ export class HiFiMixerSession {
     onRAVISessionStateChanged = (async function(event:any) : Promise<void> {
         HiFiLogger.log(`New RAVI session state: \`${event.state}\``);
         let message = undefined;
-        this._raviDiagnostics.fire();
+        this._raviDiagnostics.fire(event.state.toString());
         switch (event.state) {
             case RaviSessionStates.CONNECTED:
                 HiFiLogger.log(`RaviSession connected; waiting for results of audionet.init`);

src/diagnostics/diagnostics.ts

@@ -1,5 +1,7 @@
 import { HiFiMixerSession } from "../classes/HiFiMixerSession";
 import { RaviSession, STATS_WATCHER_FILTER } from "../libravi/RaviSession";
+import { apiVersion } from "../index";
+
 
 const isBrowser = typeof window !== 'undefined';
 const noop = (_:any):any => undefined;
@@ -17,6 +19,8 @@ if (!isBrowser) {
     }
 }
 
+const MAX_DIAGNOSTICS_STORAGE_LENGTH = 5000;
+
 const nonOperative = "non-operative";
 
 STATS_WATCHER_FILTER.set('remote-inbound-rtp',
@@ -72,7 +76,7 @@ export class Diagnostics {
         Object.assign(this, {url, label, session, ravi, fireOn});
         this.checkPersisted();
         this.reset();
-        this.fireListener = () => this.fire();
+        this.fireListener = (event:any) => this.fire(event.type);
         this.onlineListener = () => this.checkPersisted();
     }
     /** 
@@ -89,9 +93,9 @@ export class Diagnostics {
     /**
      * Call this when we get into a state that we want to know more about, e.g., when leaving the thing that caused us to prime().
      */
-    async fire() {
+    async fire(eventName:string) {
         if (!this.isPrimed()) return;
-        const reportString = this.toString();
+        const reportString = this.toString(eventName);
         this.reset();
         // When we fire on closing tab or browser, we sometimes don't have enough time to report, or
         // sometimes have enough time to report, but not enough to check the response.
@@ -137,7 +141,7 @@ export class Diagnostics {
     /**
      * Answer a single (long) log line to report.
      */
-    toString() {
+    toString(eventName:string) {
         return `${new Date().toISOString()} ${this.identifier} ` +
             this.s('logReason', 'sessionEND') +
             this.connectionStats('browserStats') +
@@ -152,6 +156,8 @@ export class Diagnostics {
             this.visibilityInfo() +
             this.connectionInfo() +
             this.s('PERSISTENCE', directSendLabel) +
+            this.s('VERSION', apiVersion) +
+            this.s('EVENT', eventName) +
             (useDebugPrefixes ? '\n' : '') +
             ` [${xNavigator.userAgent}]`;
     }
@@ -237,7 +243,8 @@ export class Diagnostics {
             method: 'POST',
             headers: { 'Content-Type': 'text/plain' },
             body: reportString
-        }).then((response:Response) => response.ok);
+        }).then((response:Response) => response.ok)
+          .catch((err) => { console.log(`Could not send diagnostics report for ${this.label} to ${this.url}: ${err}`); return false; });
     }
     /**
      * Add reportString to the set of data being saved for later reporting.
@@ -248,7 +255,14 @@ export class Diagnostics {
         // there is a bug, or if the application site limits the connect-src (or default-src)
         // in its Content-Security-Policy header without allowing this.url.
         // If it is more than a line, we are accumulating stuff and really ought to phone home through the mixer when connected.
-        if (existing) existing += "\n";
+        if (existing) {
+            if (existing.length > MAX_DIAGNOSTICS_STORAGE_LENGTH) {
+                // If it is many lines, we may be in a web context where we cannot send diagnostics lines, and are better off discarding them to conserve web storage
+                console.log(`Diagnostics for ${this.label} truncated`);
+                existing = "";
+            }
+            existing += "\n";
+        }
         // The reportString is generated as through it will be sent directly. Here we replace that label with a reason why we're persisting.
         reportString = reportString.replace(directSendLabel, reason);
         xStorage.setItem(this.label, existing + reportString);

tests/testUtilities/testUtils.ts

@@ -1,6 +1,7 @@
-const { default: SignedJWT } = require('jose/jwt/sign');
-const { default: UnsecuredJWT } = require('jose/jwt/unsecured');
-const crypto = require('crypto');
+const { default: SignedJWT } = require('jose/jwt/sign'),
+    { v4 } = require('uuid'),
+    { default: UnsecuredJWT } = require('jose/jwt/unsecured'),
+    crypto = require('crypto');
 
 export let tokenTypes: any = {};
 
@@ -111,16 +112,7 @@ export async function generateJWT(tokenType: { [property: string]: any }, spaceI
 }
 
 export function generateUUID() {
-    let i = 0;
-    let generatedUUID = "";
-    let baseString = 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx';
-
-    while (i++ < 38) {
-        let c = baseString[i - 1], r = Math.random() * 16 | 0, v = c == 'x' ? r : (r & 0x3 | 0x8);
-        generatedUUID += (c == '-' || c == '4') ? c : v.toString(16)
-    }
-
-    return generatedUUID;
+    return v4();
 }
 
 export function sleep(ms: number) {