@netless/slide 1.4.59-alpha.4 → 1.4.59

package/lib/SyncTaskManager.js

@@ -0,0 +1,206 @@
+function assertSyncEventQueuePolicy(policy) {
+    if (policy !== "fifo" && policy !== "latest-pending-render") {
+        throw new Error("Invalid sync event queue policy: " + policy);
+    }
+}
+export function resolveSyncEventQueuePolicy(mode, policy) {
+    if (policy === void 0) { policy = "fifo"; }
+    assertSyncEventQueuePolicy(policy);
+    return mode === "interactive" ? policy : "fifo";
+}
+function isPageScopedEvent(event) {
+    switch (event.type) {
+        case "renderSlide":
+        case "nextStep":
+        case "prevStep":
+        case "interactiveAnim":
+        case "mediaPlay":
+        case "mediaPause":
+        case "mediaSeek":
+        case "mediaFullscreen":
+            return true;
+        default:
+            return false;
+    }
+}
+var SyncTaskManager = /** @class */ (function () {
+    function SyncTaskManager(fn, options) {
+        var _this = this;
+        if (options === void 0) { options = {}; }
+        this.tasks = [];
+        this.isDestroy = false;
+        this.isScheduling = false;
+        this.isTaskRunning = false;
+        this.isCatchingUp = false;
+        this.compactedTasks = new WeakMap();
+        this.finishTask = function () {
+            _this.isTaskRunning = false;
+            _this.runningTask = undefined;
+            if (_this.isDestroy) {
+                _this.tasks.length = 0;
+                _this.isScheduling = false;
+            }
+            else if (_this.tasks.length > 0) {
+                window.requestAnimationFrame(_this.schedule);
+            }
+            else {
+                _this.isScheduling = false;
+                _this.setCatchUpState(false);
+            }
+        };
+        this.schedule = function () {
+            if (_this.isDestroy) {
+                _this.tasks.length = 0;
+                _this.isScheduling = false;
+                return;
+            }
+            _this.isScheduling = true;
+            var task = _this.tasks.shift();
+            if (!task) {
+                _this.isScheduling = false;
+                return;
+            }
+            _this.isTaskRunning = true;
+            _this.runningTask = task;
+            var compactInfo = _this.compactedTasks.get(task);
+            try {
+                _this.fn(task).then(function () {
+                    var _a;
+                    _this.compactedTasks.delete(task);
+                    if (compactInfo && !_this.isDestroy) {
+                        try {
+                            (_a = _this.onCompactedRenderComplete) === null || _a === void 0 ? void 0 : _a.call(_this, compactInfo, Date.now());
+                        }
+                        catch ( /* Observability must not interrupt synchronization. */_b) { /* Observability must not interrupt synchronization. */ }
+                    }
+                    _this.finishTask();
+                }, function () {
+                    _this.compactedTasks.delete(task);
+                    _this.finishTask();
+                });
+            }
+            catch (_a) {
+                _this.compactedTasks.delete(task);
+                _this.finishTask();
+            }
+        };
+        this.fn = fn;
+        this.policy = options.policy || "fifo";
+        this.onCompact = options.onCompact;
+        this.onCompactedRenderComplete = options.onCompactedRenderComplete;
+        this.onCatchUpStateChange = options.onCatchUpStateChange;
+        this.shouldTrackCatchUpEvent = options.shouldTrackCatchUpEvent;
+        assertSyncEventQueuePolicy(this.policy);
+    }
+    SyncTaskManager.prototype.destroy = function () {
+        this.isDestroy = true;
+        this.isCatchingUp = false;
+        this.runningTask = undefined;
+        this.tasks.length = 0;
+    };
+    SyncTaskManager.prototype.setPolicy = function (policy) {
+        assertSyncEventQueuePolicy(policy);
+        this.policy = policy;
+    };
+    SyncTaskManager.prototype.setCatchUpState = function (isCatchingUp) {
+        var _a;
+        if (this.isCatchingUp === isCatchingUp) {
+            return;
+        }
+        this.isCatchingUp = isCatchingUp;
+        try {
+            (_a = this.onCatchUpStateChange) === null || _a === void 0 ? void 0 : _a.call(this, isCatchingUp);
+        }
+        catch ( /* Observability must not interrupt synchronization. */_b) { /* Observability must not interrupt synchronization. */ }
+    };
+    SyncTaskManager.prototype.isCatchUpEvent = function (event) {
+        var _a, _b;
+        try {
+            return (_b = (_a = this.shouldTrackCatchUpEvent) === null || _a === void 0 ? void 0 : _a.call(this, event)) !== null && _b !== void 0 ? _b : true;
+        }
+        catch (_c) {
+            return true;
+        }
+    };
+    SyncTaskManager.prototype.compactForRender = function (event) {
+        var droppedEventTypes = {};
+        var droppedEventCount = 0;
+        var droppedRenderCount = 0;
+        var droppedStepCount = 0;
+        var droppedAnimationCount = 0;
+        var droppedMediaCount = 0;
+        while (this.tasks.length > 0) {
+            var pendingEvent = this.tasks[this.tasks.length - 1];
+            if (!isPageScopedEvent(pendingEvent)) {
+                break;
+            }
+            this.tasks.pop();
+            this.compactedTasks.delete(pendingEvent);
+            droppedEventCount += 1;
+            droppedEventTypes[pendingEvent.type] = (droppedEventTypes[pendingEvent.type] || 0) + 1;
+            if (pendingEvent.type === "renderSlide") {
+                droppedRenderCount += 1;
+            }
+            else if (pendingEvent.type === "nextStep" || pendingEvent.type === "prevStep") {
+                droppedStepCount += 1;
+            }
+            else if (pendingEvent.type === "interactiveAnim") {
+                droppedAnimationCount += 1;
+            }
+            else {
+                droppedMediaCount += 1;
+            }
+        }
+        if (droppedEventCount === 0) {
+            return undefined;
+        }
+        var boundaryEvent = this.tasks[this.tasks.length - 1];
+        return {
+            policy: "latest-pending-render",
+            droppedEventCount: droppedEventCount,
+            droppedRenderCount: droppedRenderCount,
+            droppedStepCount: droppedStepCount,
+            droppedAnimationCount: droppedAnimationCount,
+            droppedMediaCount: droppedMediaCount,
+            droppedOperationCount: droppedEventCount - droppedRenderCount,
+            droppedEventTypes: droppedEventTypes,
+            retainedSlideIndex: event.index,
+            retainedRenderReceivedAt: Date.now(),
+            hasRunningTask: this.isTaskRunning,
+            hardBoundaryType: boundaryEvent === null || boundaryEvent === void 0 ? void 0 : boundaryEvent.type,
+        };
+    };
+    SyncTaskManager.prototype.addTask = function (event) {
+        var _this = this;
+        var _a;
+        if (this.isDestroy) {
+            return undefined;
+        }
+        var hasPendingWork = this.isTaskRunning || this.tasks.length > 0;
+        var isIncomingCatchUpEvent = this.policy === "latest-pending-render" && this.isCatchUpEvent(event);
+        var hasCatchUpEvent = this.policy === "latest-pending-render" && (isIncomingCatchUpEvent ||
+            (!!this.runningTask && this.isCatchUpEvent(this.runningTask)) ||
+            this.tasks.some(function (pendingEvent) { return _this.isCatchUpEvent(pendingEvent); }));
+        var compactInfo = this.policy === "latest-pending-render" && event.type === "renderSlide" ?
+            this.compactForRender(event) :
+            undefined;
+        this.tasks.push(event);
+        var shouldStartCatchUp = hasCatchUpEvent && (hasPendingWork || (isIncomingCatchUpEvent && event.type === "renderSlide"));
+        if (shouldStartCatchUp) {
+            this.setCatchUpState(true);
+        }
+        if (compactInfo) {
+            this.compactedTasks.set(event, compactInfo);
+            try {
+                (_a = this.onCompact) === null || _a === void 0 ? void 0 : _a.call(this, compactInfo);
+            }
+            catch ( /* Observability must not interrupt synchronization. */_b) { /* Observability must not interrupt synchronization. */ }
+        }
+        if (!this.isScheduling) {
+            this.schedule();
+        }
+        return compactInfo;
+    };
+    return SyncTaskManager;
+}());
+export { SyncTaskManager };

package/lib/global.js

@@ -0,0 +1,118 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+/**
+ * 预加载静态资源, 调用后会一次性加载除媒体文件以外的远程资源,并生成必要的纹理缓存
+ * 创建 Slide 对象时需要设置 useLocalCache 参数 为 true
+ * @param taskId 任务 id
+ * @param prefix 任务进度 api 返回的资源前缀
+ * @param resourceOnly boolean 类型
+ * @param onProgress 加载进度回调函数
+ */
+import { Slide } from "./Slide";
+export function preloadResource(taskId, prefix, maxResolutionLevel, onProgress, pages) {
+    return __awaiter(this, void 0, void 0, function () {
+        var div, slide, slideCount, uniquePages, i, pageNumber, i, e_1;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    div = document.createElement("div");
+                    slide = new Slide({
+                        anchor: div,
+                        renderOptions: {
+                            minFPS: 1,
+                            maxFPS: 1,
+                            resolution: 1,
+                            maxResolutionLevel: maxResolutionLevel,
+                            forceCanvas: true,
+                        },
+                        mode: "local",
+                        interactive: false,
+                        useLocalCache: true,
+                    });
+                    slide.setResource(taskId, prefix);
+                    return [4 /*yield*/, slide.getSlideCountAsync()];
+                case 1:
+                    slideCount = _a.sent();
+                    _a.label = 2;
+                case 2:
+                    _a.trys.push([2, 12, 13, 14]);
+                    if (!(pages && pages.length > 0)) return [3 /*break*/, 7];
+                    uniquePages = pages.filter(function (item, index) { return pages.indexOf(item) === index; });
+                    i = 0;
+                    _a.label = 3;
+                case 3:
+                    if (!(i < uniquePages.length)) return [3 /*break*/, 6];
+                    pageNumber = uniquePages[i];
+                    if (!(pageNumber > 0 && pageNumber <= slideCount)) return [3 /*break*/, 5];
+                    // @ts-ignore
+                    return [4 /*yield*/, slide.player.stagePool.preload(pageNumber, true)];
+                case 4:
+                    // @ts-ignore
+                    _a.sent();
+                    onProgress(Math.round(((i + 1) / uniquePages.length) * 100) / 100);
+                    _a.label = 5;
+                case 5:
+                    i++;
+                    return [3 /*break*/, 3];
+                case 6: return [3 /*break*/, 11];
+                case 7:
+                    i = 1;
+                    _a.label = 8;
+                case 8:
+                    if (!(i <= slideCount)) return [3 /*break*/, 11];
+                    // @ts-ignore
+                    return [4 /*yield*/, slide.player.stagePool.preload(i, true)];
+                case 9:
+                    // @ts-ignore
+                    _a.sent();
+                    onProgress(Math.round((i / slideCount) * 100) / 100);
+                    _a.label = 10;
+                case 10:
+                    i++;
+                    return [3 /*break*/, 8];
+                case 11: return [3 /*break*/, 14];
+                case 12:
+                    e_1 = _a.sent();
+                    throw e_1;
+                case 13:
+                    slide.destroy();
+                    return [7 /*endfinally*/];
+                case 14: return [2 /*return*/];
+            }
+        });
+    });
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netless/slide",
-  "version": "1.4.59-alpha.4",
+  "version": "1.4.59",
   "description": "> TODO: description",
   "author": "huaguzheng <huaguzheng2007@126.com>",
   "homepage": "https://github.com/netless-io/netless-slide-demo",
@@ -17,7 +17,7 @@
   "scripts": {
     "dev": "tsc",
     "test": "yarn test:unit",
-    "test:unit": "node __tests__/SyncTaskManager.test.js && node __tests__/RenderSlideVisibility.test.js && node __tests__/GlobalPreload.test.js && node __tests__/RenderDestroySettlement.test.js && node __tests__/SlideMediaLifecycle.test.js",
+    "test:unit": "node __tests__/SyncTaskManager.test.js && node __tests__/RenderSlideVisibility.test.js && node __tests__/PlayerContextReleaseWait.test.js && node __tests__/GlobalPreload.test.js && node __tests__/RenderDestroySettlement.test.js && node __tests__/SlideMediaLifecycle.test.js",
     "test:package": "yarn build && node __tests__/PackageBundle.test.js",
     "build": "webpack --config webpack.config.js",
     "watch": "webpack --config webpack.config.js --watch"
@@ -38,5 +38,6 @@
   },
   "publishConfig": {
     "access": "public"
-  }
+  },
+  "gitHead": "01cfefb8e1190b9da3ddfb657ceb5ccc008d7a84"
 }