Skip to content

A fast 2D and 3D game engine — TypeScript SDK, C++/WebAssembly core, visual editor. Ship one project to web, desktop, WeChat MiniGames, playable ads, and native Android / iOS.

fix(video): WeChat getFrameData() null crashes VideoUpdateSystem

yhh8459d843ae83
diff --git a/sdk/src/video/WeChatVideoBackend.ts b/sdk/src/video/WeChatVideoBackend.ts
index 3ed3755c8..fa8624fd1 100644
--- a/sdk/src/video/WeChatVideoBackend.ts
+++ b/sdk/src/video/WeChatVideoBackend.ts
@@ -67,8 +67,10 @@ class WeChatVideoStreamHandle implements VideoStreamHandle {
pump(module: ESEngineModule): void {
if (this.disposed_ || !this.playing_) return;
- const frame = this.decoder_.getFrameData();
- if (!frame.data || frame.data.byteLength === 0 || frame.width <= 0) return; // not decoded yet
+ // getFrameData is typed non-null but returns null on-device until a frame
+ // has decoded — guard for it rather than trusting the vendor type.
+ const frame: WechatMinigame.FrameDataOptions | null = this.decoder_.getFrameData();
+ if (!frame || !frame.data || frame.data.byteLength === 0 || frame.width <= 0) return;
if (frame.pkPts === this.lastPts_) return; // no new frame
this.lastPts_ = frame.pkPts;
diff --git a/sdk/tests/wechat-video-backend.test.ts b/sdk/tests/wechat-video-backend.test.ts
new file mode 100644
index 000000000..4b1e6e9e6
--- /dev/null
+++ b/sdk/tests/wechat-video-backend.test.ts
@@ -0,0 +1,53 @@
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: Copyright (c) 2024-present ESEngine Team
+import { describe, it, expect, beforeEach, afterEach, vi } from 'vitest';
+import { WeChatVideoBackend } from '../src/video/WeChatVideoBackend';
+
+function createMockDecoder(getFrameData: () => unknown) {
+ return {
+ start: vi.fn().mockResolvedValue(undefined),
+ getFrameData: vi.fn().mockImplementation(getFrameData),
+ seek: vi.fn().mockResolvedValue(undefined),
+ stop: vi.fn().mockResolvedValue(undefined),
+ remove: vi.fn().mockResolvedValue(undefined),
+ on: vi.fn(),
+ };
+}
+
+describe('WeChatVideoBackend', () => {
+ let backend: WeChatVideoBackend;
+ let decoder: ReturnType<typeof createMockDecoder>;
+
+ beforeEach(() => {
+ decoder = createMockDecoder(() => null);
+ (globalThis as any).wx = { createVideoDecoder: vi.fn(() => decoder) };
+ backend = new WeChatVideoBackend();
+ });
+
+ afterEach(() => {
+ delete (globalThis as any).wx;
+ });
+
+ it('is named WeChat and starts the decoder in PTS mode', () => {
+ backend.createStream('clip.mp4', { autoplay: true, muted: true });
+ expect(backend.name).toBe('WeChat');
+ expect((globalThis as any).wx.createVideoDecoder).toHaveBeenCalled();
+ expect(decoder.start).toHaveBeenCalledWith({ source: 'clip.mp4', mode: 0 });
+ });
+
+ // Regression: getFrameData is typed non-null but returns null on-device until
+ // a frame decodes — pump must not crash the whole VideoUpdateSystem.
+ it('pump tolerates getFrameData() returning null', () => {
+ const handle = backend.createStream('clip.mp4', { autoplay: true, muted: true });
+ expect(() => handle.pump({} as never)).not.toThrow();
+ expect(handle.textureHandle).toBe(0);
+ expect(handle.isReady).toBe(false);
+ });
+
+ it('pump tolerates an empty (not-yet-decoded) frame', () => {
+ decoder.getFrameData.mockReturnValue({ data: new ArrayBuffer(0), width: 0, height: 0, pkPts: 0, pkDts: 0 });
+ const handle = backend.createStream('clip.mp4', { autoplay: true, muted: true });
+ expect(() => handle.pump({} as never)).not.toThrow();
+ expect(handle.textureHandle).toBe(0);
+ });
+});