[3.8.3] Refactor wasm/asmjs, add nativeCodeBundleMode

.api/public.d.ts

@@ -1,4 +1,4 @@
 declare module "@cocos/ccbuild" {
     /**
      * @group Merged Types
      */
@@ -71,20 +71,12 @@
              */
             split?: boolean;
             /**
-             * 使用的 ammo.js 版本，也即 `@cocos/ammo` 映射到的版本。
-             * - 为 `true` 时使用 WebAssembly 版本的 ammo.js；
-             * - 为 `false` 时使用 asm.js 版本的 ammo.js；
-             * - 为 `'fallback` 时同时在结果中包含两个版本的 ammo.js，并自动根据环境 fallback 选择。
-             *
-             * 注意，`'fallback'` 只有在 SystemJS 和 Async functions 同时支持时才有效。
-             * @default true
-             *
-             * @deprecated 从 1.1.5 版本开始，该选项只会影响 FORCE_BANNING_BULLET_WASM 宏的值
-             * - 为 `true` 时，FORCE_BANNING_BULLET_WASM 为 false
-             * - 为 `false` 时，FORCE_BANNING_BULLET_WASM 为 true
-             * - 为 `'fallback'` 时, FORCE_BANNING_BULLET_WASM 为 false
+             * 原生代码的打包模式
+             * - 为 `wasm` 时使用 wasm 版本原生库
+             * - 为 `asmjs` 时使用 asmjs 版本的原生库
+             * - 为 `both` 时同时在结果中包含 wasm 与 asmjs 两个版本的原生库
              */
-            ammoJsWasm?: boolean | "fallback";
+            nativeCodeBundleMode?: "wasm" | "asmjs" | "both";
             /**
              * If true, all deprecated features/API are excluded.
              * You can also specify a version range(in semver range) to exclude deprecations in specified version(s).
@@ -247,28 +239,12 @@
                 NOT_PACK_PHYSX_LIBS: boolean;
                 WEBGPU: boolean;
                 WASM_SUPPORT_MODE: number;
-                FORCE_BANNING_BULLET_WASM: boolean;
-                /**
-                 * Whether cull the asm.js module.
-                 * If this is true, the external modules ending with '.asm.js' or 'js.mem' will be culled.
-                 *
-                 * @default false
-                 */
-                CULL_ASM_JS_MODULE: boolean;
                 /**
                  * An internal constant to indicate whether we cull the meshopt wasm module and asm.js module.
                  *
                  * @default false
                  */
                 CULL_MESHOPT: boolean;
-                /**
-                 * An internal constant to indicate whether need a fallback of wasm.
-                 * If true, we build a wasm fallback module for the compatibility of wasm files compiled by different version of emscripten.
-                 * This is useful when we use wasm on different version of Safari browsers.
-                 *
-                 * @default false
-                 */
-                WASM_FALLBACK: boolean;
                 /**
                  * An internal constant to indicate whether we use wasm assets as minigame subpackage.
                  * This is useful when we need to reduce code size.

.github/workflows/test.yaml

@@ -1,6 +1,6 @@
 name: test
 run-name: ${{ github.actor }} - test
-on: [pull_request]
+on: [pull_request, push]
 jobs:
   test:
     strategy:
@@ -14,6 +14,15 @@ jobs:
         with:
           node-version: '18.17.0'
 
+      - run: node --version
+      - run: npm --version
+
       - run: npm ci
 
-      - run: npm test
+      - run: npm test
+
+      # - name: Upload Artifact
+      #   uses: actions/upload-artifact@v3
+      #   with: 
+      #     name: ${{ matrix.os }}
+      #     path: test/build-engine

.vscode/settings.json

@@ -1,6 +1,6 @@
 {
     "editor.codeActionsOnSave": {
-        "source.fixAll": true
+        "source.fixAll": "explicit"
     },
     "cSpell.enabled": true,
     "cSpell.words": [

modules/build-engine/src/engine-js/index.ts

@@ -87,11 +87,16 @@
     }
 
 
-    let { ammoJsWasm } = options;
-    ammoJsWasm ??= true;  // default is true
-    const forceBanningBulletWasm = !ammoJsWasm;
+    let { nativeCodeBundleMode } = options;
+    nativeCodeBundleMode ??= 'both';  // default is true
+
     const flags = options.flags ?? {};
-    flags.FORCE_BANNING_BULLET_WASM = forceBanningBulletWasm;
+
+    // meshopt is only used in 3d module, so cull it if 3d module is disabled.
+    if (flags.CULL_MESHOPT === undefined) {
+        flags.CULL_MESHOPT = !features.includes('3d');
+    }
+
     const intrinsicFlags = statsQuery.getIntrinsicFlagsOfFeatures(features);
     let buildTimeConstants = statsQuery.constantManager.genBuildTimeConstants({
         mode: options.mode,
@@ -171,7 +176,7 @@
         presetEnvOptions.targets = options.targets;
     }
 
     const babelPlugins: any[] = [];
     if (!options.targets) {
         babelPlugins.push([babelPluginTransformForOf, {
             loose: true,
@@ -241,18 +246,15 @@
     rollupPlugins.push(
         externalWasmLoader({
             externalRoot: ps.join(engineRoot, 'native/external'),
-            wasmSupportMode: buildTimeConstants.WASM_SUPPORT_MODE,
-            forceBanningBulletWasm,
-            cullAsmJsModule: buildTimeConstants.CULL_ASM_JS_MODULE,
+            nativeCodeBundleMode,
             cullMeshopt: buildTimeConstants.CULL_MESHOPT,
             format: 'relative-from-chunk',
-            wasmFallback: buildTimeConstants.WASM_FALLBACK,
             wasmSubpackage: buildTimeConstants.WASM_SUBPACKAGE,
         }),
 
         {
             name: '@cocos/ccbuild|module-overrides',
             resolveId(source, importer): string | null {
                 if (moduleOverrides[source]) {
                     return source;
                 } else {
@@ -301,6 +303,7 @@
             skipPreflightCheck: true,
             ...babelOptions,
         }),
+
     );
 
     // if (options.progress) {
@@ -457,6 +460,5 @@
     }
 
     result.hasCriticalWarns = hasCriticalWarns;
-
     return result;
-}
+}

modules/build-engine/src/engine-js/rollup-plugins/external-wasm-loader.ts

@@ -22,7 +22,6 @@
 
 const suffixReplaceConfig: ISuffixReplaceConfig = {
     '.mem': '.mem.bin',
-    '.wasm.fallback': '.wasm.fallback.bin',
 };
 
 /**
@@ -68,22 +67,14 @@
     }
 }
 
-function shouldCullBulletWasmModule (options: externalWasmLoader.Options, id: string): boolean {
-    return options.forceBanningBulletWasm && id.includes('bullet');
-}
-
-function shouldCullAsmJsModule (options: externalWasmLoader.Options, id: string): boolean {
-    return options.wasmSupportMode !== 0 && options.cullAsmJsModule;
-}
-
 function shouldCullMeshoptModule (options: externalWasmLoader.Options, id: string): boolean {
     return options.cullMeshopt && id.includes('meshopt');
 }
 
 const loadConfig: ILoadConfig = {
     '.wasm': {
         shouldCullModule (options: externalWasmLoader.Options, id: string): boolean {
-            return options.wasmSupportMode === 0 || shouldCullBulletWasmModule(options, id) || shouldCullMeshoptModule(options, id);
+            return options.nativeCodeBundleMode === 'asmjs' || shouldCullMeshoptModule(options, id);
         },
         shouldEmitAsset (options: externalWasmLoader.Options, id: string): boolean {
             return !this.shouldCullModule(options, id);
@@ -92,7 +83,7 @@
     },
     '.js.mem': {
         shouldCullModule (options: externalWasmLoader.Options, id: string): boolean {
-            return (options.wasmSupportMode === 1 && !shouldCullBulletWasmModule(options, id)) || shouldCullAsmJsModule(options, id) || shouldCullMeshoptModule(options, id);
+            return options.nativeCodeBundleMode === 'wasm' || shouldCullMeshoptModule(options, id);
         },
         shouldEmitAsset (options: externalWasmLoader.Options, id: string): boolean {
             return !this.shouldCullModule(options, id);
@@ -101,36 +92,18 @@
     },
     '.wasm.js': {
         shouldCullModule (options: externalWasmLoader.Options, id: string): boolean {
-            return options.wasmSupportMode === 0 || shouldCullBulletWasmModule(options, id) || shouldCullMeshoptModule(options, id);
+            return options.nativeCodeBundleMode === 'asmjs' || shouldCullMeshoptModule(options, id);
         },
         shouldEmitAsset (options: externalWasmLoader.Options, id: string): boolean {
             return false;
         },
         cullingContent: `export default function () {}`,
     },
     '.asm.js': {
         shouldCullModule (options: externalWasmLoader.Options, id: string): boolean {
-            return (options.wasmSupportMode === 1 && !shouldCullBulletWasmModule(options, id)) || shouldCullAsmJsModule(options, id) || shouldCullMeshoptModule(options, id);
-        },
-        shouldEmitAsset (options: externalWasmLoader.Options, id: string): boolean {
-            return false;
-        },
-        cullingContent: `export default function () {}`,
-    },
-    '.wasm.fallback': {
-        shouldCullModule (options: externalWasmLoader.Options, id: string): boolean {
-            return loadConfig['.wasm'].shouldCullModule(options, id) || !options.wasmFallback;
-        },
-        shouldEmitAsset (options: externalWasmLoader.Options, id: string): boolean {
-            return !this.shouldCullModule(options, id);
-        },
-        cullingContent: `export default '';`,
-    },
-    '.wasm.fallback.js': {
-        shouldCullModule (options: externalWasmLoader.Options, id: string): boolean {
-            return loadConfig['.wasm.js'].shouldCullModule(options, id) || !options.wasmFallback;
+            return options.nativeCodeBundleMode === 'wasm' || shouldCullMeshoptModule(options, id);
         },
         shouldEmitAsset (options: externalWasmLoader.Options, id: string): boolean {
             return false;
         },
         cullingContent: `export default function () {}`,
@@ -257,7 +230,7 @@
     return {
         name: '@cocos/ccbuild|external-loader',
 
         async resolveId (this, source, importer): Promise<string | { id: string; external: true; } | null> {
             if (source.startsWith(externalOrigin)) {
                 if (options.wasmSubpackage) {
                     externalWasmModules.push(source);
@@ -271,7 +244,7 @@
             return null;
         },
 
         async load (id): Promise<any> {
             if (id.startsWith(externalOrigin)) {
                 const filePath = normalizePath(ps.join(options.externalRoot, id.substring(externalOrigin.length)));
                 for (const suffix in loadConfig) {
@@ -282,12 +255,12 @@
                         } else if (config.shouldEmitAsset(options, id)) {
                             return emitAsset(this, filePath);
                         } else {
-                            return await fs.readFile(filePath, 'utf8');
+                            return (await fs.readFile(filePath, 'utf8')).replace(/\r\n/g, '\n');
                         }
                     }
                 }
                 // some external module that doesn't obey the suffix specification, we return its content by default.
-                return await fs.readFile(filePath, 'utf8');
+                return (await fs.readFile(filePath, 'utf8')).replace(/\r\n/g, '\n');
             }
             return null;
         },
@@ -311,7 +284,7 @@
             }
         },
 
         async generateBundle (opts, bundles): Promise<void> {
             if (externalWasmModules.length !== 0) {
                 const bundler = new ExternalWasmModuleBundler({
                     ...options,
@@ -331,26 +304,11 @@
          * The root path of external repository
          */
         externalRoot: string,
+
         /**
-         * The wasm support mode:
-         * 0. not support
-         * 1. support
-         * 2. maybe support
-         */
-        wasmSupportMode: number;
-        /**
-         * Whether need a fallback of wasm.
-         * If true, we need to build a wasm fallback module for the compatibility of wasm files compiled by different version of emscripten.
-         */
-        wasmFallback: boolean;
-        /**
-         * Whether force banning to emit bullet wasm.
-         */
-        forceBanningBulletWasm: boolean;
-        /**
-         * Whether cull asm js module.
+         * The bundle mode of native code while building scripts.
          */
-        cullAsmJsModule: boolean;
+        nativeCodeBundleMode: 'wasm' | 'asmjs' | 'both';
         /**
          * Whether cull meshopt module, including wasm and asm.js.
          */

modules/build-engine/src/engine-ts/plugins/external-wasm-loader.ts

@@ -85,24 +85,6 @@ const loadConfig: ILoadConfig = {
         },
         cullingContent: `let $: any;export default $;`,
     },
-    '.wasm.fallback': {
-        shouldCullModule (options: externalWasmLoaderFactory.Options, id: string): boolean {
-            return true;  // we don't need wasm.fallback module for OH platform
-        },
-        shouldEmitAsset (options: externalWasmLoaderFactory.Options, id: string): boolean {
-            return !this.shouldCullModule(options, id);
-        },
-        cullingContent: `export default '';`,
-    },
-    '.wasm.fallback.js': {
-        shouldCullModule (options: externalWasmLoaderFactory.Options, id: string): boolean {
-            return true;  // we don't need wasm.fallback module for OH platform
-        },
-        shouldEmitAsset (options: externalWasmLoaderFactory.Options, id: string): boolean {
-            return false;
-        },
-        cullingContent: `export default function () {}`,
-    },
 };
 
 // NOTE: we use rollup to transform CommonJS to ES Module.

modules/build-engine/src/index.ts

@@ -111,20 +111,12 @@ export namespace buildEngine {
         split?: boolean;
 
         /**
-         * 使用的 ammo.js 版本，也即 `@cocos/ammo` 映射到的版本。
-         * - 为 `true` 时使用 WebAssembly 版本的 ammo.js；
-         * - 为 `false` 时使用 asm.js 版本的 ammo.js；
-         * - 为 `'fallback` 时同时在结果中包含两个版本的 ammo.js，并自动根据环境 fallback 选择。
-         *
-         * 注意，`'fallback'` 只有在 SystemJS 和 Async functions 同时支持时才有效。
-         * @default true
-         * 
-         * @deprecated 从 1.1.5 版本开始，该选项只会影响 FORCE_BANNING_BULLET_WASM 宏的值
-         * - 为 `true` 时，FORCE_BANNING_BULLET_WASM 为 false
-         * - 为 `false` 时，FORCE_BANNING_BULLET_WASM 为 true
-         * - 为 `'fallback'` 时, FORCE_BANNING_BULLET_WASM 为 false
+         * 原生代码的打包模式
+         * - 为 `wasm` 时使用 wasm 版本原生库
+         * - 为 `asmjs` 时使用 asmjs 版本的原生库
+         * - 为 `both` 时同时在结果中包含 wasm 与 asmjs 两个版本的原生库
          */
-        ammoJsWasm?: boolean | 'fallback';
+        nativeCodeBundleMode?: 'wasm' | 'asmjs' | 'both';
 
         /**
          * If true, all deprecated features/API are excluded.

modules/stats-query/src/index.ts

@@ -293,28 +293,13 @@ export namespace StatsQuery {
             NOT_PACK_PHYSX_LIBS: boolean; 
             WEBGPU: boolean;
             WASM_SUPPORT_MODE: number;
-            FORCE_BANNING_BULLET_WASM: boolean;
-            /**
-             * Whether cull the asm.js module.
-             * If this is true, the external modules ending with '.asm.js' or 'js.mem' will be culled.
-             * 
-             * @default false
-             */
-            CULL_ASM_JS_MODULE: boolean;
+
             /**
              * An internal constant to indicate whether we cull the meshopt wasm module and asm.js module.
              * 
              * @default false
              */
             CULL_MESHOPT: boolean;
-            /**
-             * An internal constant to indicate whether need a fallback of wasm.
-             * If true, we build a wasm fallback module for the compatibility of wasm files compiled by different version of emscripten.
-             * This is useful when we use wasm on different version of Safari browsers.
-             * 
-             * @default false
-             */
-            WASM_FALLBACK: boolean;
             /**
              * An internal constant to indicate whether we use wasm assets as minigame subpackage.
              * This is useful when we need to reduce code size.
@@ -373,10 +358,10 @@ export namespace StatsQuery {
             // init helper
             let result = '';
             if (this._hasCCGlobal(config)) {
-                result += fs.readFileSync(ps.join(__dirname, '../../../static/helper-global-exporter.txt'), 'utf8') + '\n';
+                result += fs.readFileSync(ps.join(__dirname, '../../../static/helper-global-exporter.txt'), 'utf8').replace(/\r\n/g, '\n') + '\n';
             }
             if (this._hasDynamic(config)) {
-                result += fs.readFileSync(ps.join(__dirname, '../../../static/helper-dynamic-constants.txt'), 'utf8') + '\n';
+                result += fs.readFileSync(ps.join(__dirname, '../../../static/helper-dynamic-constants.txt'), 'utf8').replace(/\r\n/g, '\n') + '\n';
             }
 
             // update value
@@ -463,7 +448,7 @@ export namespace StatsQuery {
             // init helper
             let result = '';
             if (this._hasCCGlobal(config)) {
-                result += fs.readFileSync(ps.join(__dirname, '../../../static/helper-global-exporter.txt'), 'utf8') + '\n';
+                result += fs.readFileSync(ps.join(__dirname, '../../../static/helper-global-exporter.txt'), 'utf8').replace(/\r\n/g, '\n') + '\n';
             }
 
             // update value

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cocos/ccbuild",
-  "version": "2.0.3",
+  "version": "2.1.0",
   "description": "The next generation of build tool for Cocos engine.",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -66,9 +66,9 @@
     "typedoc": "^0.24.8"
   },
   "dependencies": {
-    "@ccbuild/dts-bundler": "*",
     "@ccbuild/build-engine": "*",
     "@ccbuild/bundler": "*",
+    "@ccbuild/dts-bundler": "*",
     "@ccbuild/modularize": "*",
     "@ccbuild/stats-query": "*",
     "@ccbuild/transformer": "*",