@spinajs/templates-puppeteer 2.0.481 → 2.0.482

package/lib/mjs/progress.js

@@ -0,0 +1,175 @@
+import { RenderPhase } from '@spinajs/templates';
+/** Minimum gap between resource-driven emissions (ms). */
+const THROTTLE_MS = 150;
+/** Re-emit interval during long phases so the bar moves even when nothing changes (ms). */
+const HEARTBEAT_MS = 750;
+/** Percent band [start, end] each phase occupies. */
+const PHASE_BANDS = {
+    [RenderPhase.Starting]: [0, 10],
+    [RenderPhase.Preparing]: [10, 15],
+    [RenderPhase.Loading]: [15, 80],
+    [RenderPhase.Rendering]: [80, 95],
+    [RenderPhase.Done]: [100, 100],
+    [RenderPhase.Failed]: [0, 0],
+};
+/**
+ * Tracks a single puppeteer render and delivers throttled {@link IRenderProgress}
+ * snapshots to a callback. Resource counts come from the page's request lifecycle
+ * events; the percentage is phase-weighted (see {@link PHASE_BANDS}), and a
+ * heartbeat keeps it ticking during the long Loading/Rendering phases.
+ *
+ * When constructed without a callback it is entirely inert - no listeners, no
+ * timers, no allocations on the hot path - so callers can always create one.
+ */
+export class RenderProgressReporter {
+    constructor(filePath, callback) {
+        this.filePath = filePath;
+        this.startedAt = Date.now();
+        this.phaseNow = RenderPhase.Starting;
+        this.loaded = 0;
+        this.pending = 0;
+        this.failed = 0;
+        this.lastEmitAt = 0;
+        this.lastPercent = 0;
+        this.heartbeat = null;
+        this.page = null;
+        // pre-bound so add/remove reference the same function identities
+        this.onRequest = () => {
+            this.pending++;
+        };
+        this.onRequestFinished = () => {
+            this.pending = Math.max(0, this.pending - 1);
+            this.loaded++;
+            this.emit();
+        };
+        this.onRequestFailed = () => {
+            this.pending = Math.max(0, this.pending - 1);
+            this.failed++;
+            this.emit();
+        };
+        this.enabled = !!callback;
+        this.callback = callback ?? (() => undefined);
+    }
+    /** Attach resource-lifecycle counters to the page. Call once, after newPage(). */
+    attach(page) {
+        if (!this.enabled) {
+            return;
+        }
+        this.page = page;
+        page.on('request', this.onRequest);
+        page.on('requestfinished', this.onRequestFinished);
+        page.on('requestfailed', this.onRequestFailed);
+    }
+    /** Transition to a new phase and emit immediately (bypassing the throttle). */
+    phase(phase, message) {
+        if (!this.enabled) {
+            return;
+        }
+        this.phaseNow = phase;
+        // Heartbeat only during the phases that can take a long time.
+        if (phase === RenderPhase.Loading || phase === RenderPhase.Rendering) {
+            this.startHeartbeat();
+        }
+        else {
+            this.stopHeartbeat();
+        }
+        this.emit(message, true);
+    }
+    /** Stop the heartbeat and detach page listeners. Safe to call multiple times. */
+    dispose() {
+        this.stopHeartbeat();
+        if (this.page) {
+            this.page.off('request', this.onRequest);
+            this.page.off('requestfinished', this.onRequestFinished);
+            this.page.off('requestfailed', this.onRequestFailed);
+            this.page = null;
+        }
+    }
+    startHeartbeat() {
+        if (this.heartbeat) {
+            return;
+        }
+        this.heartbeat = setInterval(() => this.emit(), HEARTBEAT_MS);
+        // never keep the process alive just to tick progress
+        this.heartbeat.unref?.();
+    }
+    stopHeartbeat() {
+        if (this.heartbeat) {
+            clearInterval(this.heartbeat);
+            this.heartbeat = null;
+        }
+    }
+    computePercent() {
+        if (this.phaseNow === RenderPhase.Failed) {
+            return this.lastPercent;
+        }
+        const [start, end] = PHASE_BANDS[this.phaseNow];
+        if (this.phaseNow === RenderPhase.Loading) {
+            // total is unknown up front; approximate with completed / seen-so-far
+            const seen = this.loaded + this.pending;
+            const ratio = seen > 0 ? this.loaded / seen : 0;
+            return Math.max(this.lastPercent, Math.min(end, Math.round(start + (end - start) * ratio)));
+        }
+        // milestone phases sit at their band start (Done -> 100); never regress
+        return Math.max(this.lastPercent, start);
+    }
+    emit(message, force = false) {
+        if (!this.enabled) {
+            return;
+        }
+        const now = Date.now();
+        if (!force && now - this.lastEmitAt < THROTTLE_MS) {
+            return;
+        }
+        this.lastEmitAt = now;
+        const percent = this.computePercent();
+        this.lastPercent = percent;
+        const progress = {
+            phase: this.phaseNow,
+            percent,
+            resourcesLoaded: this.loaded,
+            resourcesPending: this.pending,
+            resourcesFailed: this.failed,
+            elapsedMs: now - this.startedAt,
+            filePath: this.filePath,
+            message: message ?? this.defaultMessage(),
+        };
+        // progress must never stall or break a render: don't await, swallow errors
+        try {
+            const result = this.callback(progress);
+            if (result && typeof result.then === 'function') {
+                result.catch(() => {
+                    /* swallow async listener errors */
+                });
+            }
+        }
+        catch {
+            /* swallow sync listener errors */
+        }
+    }
+    defaultMessage() {
+        switch (this.phaseNow) {
+            case RenderPhase.Starting:
+                return 'Starting renderer';
+            case RenderPhase.Preparing:
+                return 'Preparing HTML';
+            case RenderPhase.Loading: {
+                const extra = [`${this.loaded} done`];
+                if (this.pending)
+                    extra.push(`${this.pending} pending`);
+                if (this.failed)
+                    extra.push(`${this.failed} failed`);
+                return `Loading resources (${extra.join(', ')})`;
+            }
+            case RenderPhase.Rendering:
+                return 'Generating output';
+            case RenderPhase.Done:
+                return 'Done';
+            case RenderPhase.Failed:
+                return 'Failed';
+            default:
+                return '';
+        }
+    }
+}
+//# sourceMappingURL=progress.js.map

package/lib/mjs/progress.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"progress.js","sourceRoot":"","sources":["../../src/progress.ts"],"names":[],"mappings":"AACA,OAAO,EAAmB,WAAW,EAA0B,MAAM,oBAAoB,CAAC;AAE1F,0DAA0D;AAC1D,MAAM,WAAW,GAAG,GAAG,CAAC;AACxB,2FAA2F;AAC3F,MAAM,YAAY,GAAG,GAAG,CAAC;AAEzB,qDAAqD;AACrD,MAAM,WAAW,GAA0C;IACzD,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC;IAC/B,CAAC,WAAW,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC;IACjC,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC;IAC/B,CAAC,WAAW,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC;IACjC,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC;IAC9B,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;CAC7B,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,OAAO,sBAAsB;IA+BjC,YAA6B,QAAgB,EAAE,QAAiC;QAAnD,aAAQ,GAAR,QAAQ,CAAQ;QA5B5B,cAAS,GAAW,IAAI,CAAC,GAAG,EAAE,CAAC;QAExC,aAAQ,GAAgB,WAAW,CAAC,QAAQ,CAAC;QAC7C,WAAM,GAAG,CAAC,CAAC;QACX,YAAO,GAAG,CAAC,CAAC;QACZ,WAAM,GAAG,CAAC,CAAC;QAEX,eAAU,GAAG,CAAC,CAAC;QACf,gBAAW,GAAG,CAAC,CAAC;QAEhB,cAAS,GAA0B,IAAI,CAAC;QACxC,SAAI,GAAgB,IAAI,CAAC;QAEjC,iEAAiE;QAChD,cAAS,GAAG,GAAG,EAAE;YAChC,IAAI,CAAC,OAAO,EAAE,CAAC;QACjB,CAAC,CAAC;QACe,sBAAiB,GAAG,GAAG,EAAE;YACxC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC;YAC7C,IAAI,CAAC,MAAM,EAAE,CAAC;YACd,IAAI,CAAC,IAAI,EAAE,CAAC;QACd,CAAC,CAAC;QACe,oBAAe,GAAG,GAAG,EAAE;YACtC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC;YAC7C,IAAI,CAAC,MAAM,EAAE,CAAC;YACd,IAAI,CAAC,IAAI,EAAE,CAAC;QACd,CAAC,CAAC;QAGA,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC,QAAQ,CAAC;QAC1B,IAAI,CAAC,QAAQ,GAAG,QAAQ,IAAI,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IAChD,CAAC;IAED,kFAAkF;IAC3E,MAAM,CAAC,IAAU;QACtB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,OAAO;QACT,CAAC;QAED,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QACnC,IAAI,CAAC,EAAE,CAAC,iBAAiB,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC;QACnD,IAAI,CAAC,EAAE,CAAC,eAAe,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;IACjD,CAAC;IAED,+EAA+E;IACxE,KAAK,CAAC,KAAkB,EAAE,OAAgB;QAC/C,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,OAAO;QACT,CAAC;QAED,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;QAEtB,8DAA8D;QAC9D,IAAI,KAAK,KAAK,WAAW,CAAC,OAAO,IAAI,KAAK,KAAK,WAAW,CAAC,SAAS,EAAE,CAAC;YACrE,IAAI,CAAC,cAAc,EAAE,CAAC;QACxB,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,aAAa,EAAE,CAAC;QACvB,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAC3B,CAAC;IAED,iFAAiF;IAC1E,OAAO;QACZ,IAAI,CAAC,aAAa,EAAE,CAAC;QAErB,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACd,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;YACzC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,iBAAiB,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC;YACzD,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,eAAe,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;YACrD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACnB,CAAC;IACH,CAAC;IAEO,cAAc;QACpB,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,OAAO;QACT,CAAC;QAED,IAAI,CAAC,SAAS,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,YAAY,CAAC,CAAC;QAC9D,qDAAqD;QACrD,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,EAAE,CAAC;IAC3B,CAAC;IAEO,aAAa;QACnB,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC9B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACxB,CAAC;IACH,CAAC;IAEO,cAAc;QACpB,IAAI,IAAI,CAAC,QAAQ,KAAK,WAAW,CAAC,MAAM,EAAE,CAAC;YACzC,OAAO,IAAI,CAAC,WAAW,CAAC;QAC1B,CAAC;QAED,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,GAAG,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEhD,IAAI,IAAI,CAAC,QAAQ,KAAK,WAAW,CAAC,OAAO,EAAE,CAAC;YAC1C,sEAAsE;YACtE,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC;YACxC,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YAChD,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QAC9F,CAAC;QAED,wEAAwE;QACxE,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IAC3C,CAAC;IAEO,IAAI,CAAC,OAAgB,EAAE,KAAK,GAAG,KAAK;QAC1C,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,OAAO;QACT,CAAC;QAED,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,IAAI,CAAC,KAAK,IAAI,GAAG,GAAG,IAAI,CAAC,UAAU,GAAG,WAAW,EAAE,CAAC;YAClD,OAAO;QACT,CAAC;QACD,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC;QAEtB,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QACtC,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC;QAE3B,MAAM,QAAQ,GAAoB;YAChC,KAAK,EAAE,IAAI,CAAC,QAAQ;YACpB,OAAO;YACP,eAAe,EAAE,IAAI,CAAC,MAAM;YAC5B,gBAAgB,EAAE,IAAI,CAAC,OAAO;YAC9B,eAAe,EAAE,IAAI,CAAC,MAAM;YAC5B,SAAS,EAAE,GAAG,GAAG,IAAI,CAAC,SAAS;YAC/B,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,OAAO,EAAE,OAAO,IAAI,IAAI,CAAC,cAAc,EAAE;SAC1C,CAAC;QAEF,2EAA2E;QAC3E,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;YACvC,IAAI,MAAM,IAAI,OAAQ,MAAwB,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;gBAClE,MAAwB,CAAC,KAAK,CAAC,GAAG,EAAE;oBACnC,mCAAmC;gBACrC,CAAC,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAAC,MAAM,CAAC;YACP,kCAAkC;QACpC,CAAC;IACH,CAAC;IAEO,cAAc;QACpB,QAAQ,IAAI,CAAC,QAAQ,EAAE,CAAC;YACtB,KAAK,WAAW,CAAC,QAAQ;gBACvB,OAAO,mBAAmB,CAAC;YAC7B,KAAK,WAAW,CAAC,SAAS;gBACxB,OAAO,gBAAgB,CAAC;YAC1B,KAAK,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC;gBACzB,MAAM,KAAK,GAAG,CAAC,GAAG,IAAI,CAAC,MAAM,OAAO,CAAC,CAAC;gBACtC,IAAI,IAAI,CAAC,OAAO;oBAAE,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,OAAO,UAAU,CAAC,CAAC;gBACxD,IAAI,IAAI,CAAC,MAAM;oBAAE,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,MAAM,SAAS,CAAC,CAAC;gBACrD,OAAO,sBAAsB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;YACnD,CAAC;YACD,KAAK,WAAW,CAAC,SAAS;gBACxB,OAAO,mBAAmB,CAAC;YAC7B,KAAK,WAAW,CAAC,IAAI;gBACnB,OAAO,MAAM,CAAC;YAChB,KAAK,WAAW,CAAC,MAAM;gBACrB,OAAO,QAAQ,CAAC;YAClB;gBACE,OAAO,EAAE,CAAC;QACd,CAAC;IACH,CAAC;CACF"}