Files
cocos4/pal/wasm/wasm-minigame.ts
T
2026-04-28 23:12:10 +08:00

130 lines
5.1 KiB
TypeScript

/*
Copyright (c) 2023 Xiamen Yaji Software Co., Ltd.
https://www.cocos.com/
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/
import { HUAWEI, TAOBAO_MINIGAME, WASM_SUBPACKAGE, XIAOMI } from 'internal:constants';
import { minigame } from 'pal/minigame';
import { basename } from '../../cocos/core/utils/path';
import { checkPalIntegrity, withImpl } from '../integrity-check';
import { log } from '../../cocos/core/platform/debug';
// NOTE: The global variable `CCWebAssembly` is assigned in platforms/(bytedance|wechat)/wrapper/builtin/index.js
declare namespace CCWebAssembly {
// The first argument of `instantiate` function in mini-game platforms is always a wasm url.
function instantiate(url: string, importObject?: WebAssembly.Imports): Promise<WebAssembly.WebAssemblyInstantiatedSource>;
}
export function instantiateWasm (wasmUrl: string, importObject: WebAssembly.Imports): Promise<any> {
return getPlatformBinaryUrl(wasmUrl).then((url: string) => CCWebAssembly.instantiate(url, importObject));
}
export function fetchBuffer (binaryUrl: string): Promise<ArrayBuffer> {
return new Promise<ArrayBuffer>((resolve, reject) => {
getPlatformBinaryUrl(binaryUrl).then((url) => {
// NOTE: fsUtils is defined in engine-adapter, we need to access globalThis explicitly for Taobao platform
globalThis.fsUtils.readArrayBuffer(url, (err, arrayBuffer: ArrayBuffer) => {
if (err) {
reject(err);
return;
}
resolve(arrayBuffer);
});
// eslint-disable-next-line @typescript-eslint/no-empty-function
}).catch((e) => {});
});
}
export function fetchUrl (binaryUrl: string): Promise<string> {
return new Promise<string>((resolve, reject) => {
getPlatformBinaryUrl(binaryUrl).then((url) => {
resolve(url);
// eslint-disable-next-line @typescript-eslint/no-empty-function
}).catch((e) => {
reject(e);
});
});
}
function loadSubpackage (name: string): Promise<void> {
return new Promise((resolve, reject) => {
if (minigame.loadSubpackage) {
minigame.loadSubpackage({
name,
success () {
resolve();
},
fail (err) {
log(`Load subpacakge '${name}' failed, maybe we don't need this subpacakge or it's an engine build issue, for detailed: `, err);
resolve();
},
});
} else {
reject(new Error(`Subpackage is not supported on this platform`));
}
});
}
let promiseToLoadWasmModule: Promise<void> | undefined;
export function ensureWasmModuleReady (): Promise<void> {
if (promiseToLoadWasmModule) {
return promiseToLoadWasmModule;
}
return promiseToLoadWasmModule = new Promise<void>((resolve, reject) => {
if (WASM_SUBPACKAGE) {
if (HUAWEI) {
// NOTE: huawei quick game doesn't support concurrent loading subpackage.
loadSubpackage('__ccWasmAssetSubpkg__').then(() => loadSubpackage('__ccWasmChunkSubpkg__')).then(() => {
resolve();
}).catch(reject);
} else {
Promise.all(['__ccWasmAssetSubpkg__', '__ccWasmChunkSubpkg__'].map((pkgName) => loadSubpackage(pkgName)))
.then(() => {
resolve();
}).catch(reject);
}
} else {
resolve();
}
});
}
/**
* The binary url can be different on different platforms.
* @param binaryUrl the basic build output binary url
* @returns the real binary url on the exact platform
*/
function getPlatformBinaryUrl (binaryUrl: string): Promise<string> {
return new Promise((resolve) => {
if (XIAOMI) {
resolve(`src/cocos-js/${binaryUrl}`);
} if (TAOBAO_MINIGAME && WASM_SUBPACKAGE) {
resolve(`__ccWasmAssetSubpkg__/${basename(binaryUrl)}`);
} else {
resolve(`cocos-js/${binaryUrl}`);
}
});
}
checkPalIntegrity<typeof import('pal/wasm')>(withImpl<typeof import('./wasm-minigame')>());