Rename waitingData to buffering for clarity in player stats & refine pre-push hook to check error

.github/workflows/deploy-docs.yml

@@ -5,7 +5,6 @@ on:
     types: [completed]
     branches: [main]
   workflow_dispatch:
-    branches: [main]
 
 permissions:
   contents: read
@@ -14,7 +13,7 @@ jobs:
   build-and-deploy:
     name: build and deploy docs
     runs-on: ubuntu-latest
-    if: ${{ github.event.workflow_run.conclusion == 'success' || github.event_name == 'workflow_dispatch' }}
+    if: ${{ (github.event_name == 'workflow_run' && github.event.workflow_run.conclusion == 'success') || (github.event_name == 'workflow_dispatch' && github.ref == 'refs/heads/main') }}
     permissions:
       contents: write
     steps:
@@ -24,7 +23,6 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
         with:
-          cache: npm
           node-version: lts/*
 
       - name: Install dependencies

package.json

@@ -20,7 +20,7 @@
         "build": "rollup -c",
         "build:es5": "rollup -c --format umd",
         "build:docs": "typedoc index.ts",
-        "test": "vitest",
+        "test": "vitest --run",
         "test:coverage": "vitest --run --coverage",
         "lint": "eslint . && prettier --check .",
         "eslint": "eslint --fix .",
@@ -32,8 +32,8 @@
     },
     "simple-git-hooks": {
         "pre-commit": "npx lint-staged",
-        "pre-push": "npm run build",
-        "prepare-commit-msg": "npx --no -- commitlint --edit $1"
+        "pre-push": "npm run build && npm run test && npm run build:docs",
+        "commit-msg": "npx --no -- commitlint --edit $1"
     },
     "author": "Ceeblue B.V.",
     "license": "AGPL-3.0-or-later",

src/stats/PlayerStats.spec.ts

@@ -17,7 +17,7 @@ describe('PlayerStats', () => {
             stats.playbackRate = 1.5;
             stats.audioByteRate = 60;
             stats.videoByteRate = 1500;
-            stats.waitingData = true;
+            stats.buffering = true;
             stats.stallCount = 3;
             stats.videoTrackId = 1;
             stats.videoTrackBandwidth = 1500;

src/stats/PlayerStats.ts

@@ -16,7 +16,7 @@ import { Loggable } from '../Log';
 export class PlayerStats extends Loggable {
     protocol?: string; // protocol: HLS, DASH, WRTS, HESP, SMOOTH
     currentTime?: number; // current time in ms
-    waitingData?: boolean;
+    buffering?: boolean; // true on startup or when rebuffering after a stall
 
     bufferAmount?: number; // buffer amount in ms
     latency?: number; // latency in ms
@@ -104,8 +104,8 @@ export class PlayerStats extends Loggable {
         if (proto != null) {
             cmcd.sf = (sfByProtocol[proto as keyof typeof sfByProtocol] ?? 'o') as CML.CmcdStreamingFormat; // Streaming Format
         }
-        if (this.waitingData != null) {
-            cmcd.su = this.waitingData; // Startup
+        if (this.buffering != null) {
+            cmcd.su = this.buffering; // Startup
         }
         return cmcd;
     }