[v3.8.6] Mark some properties as @dontmangle.

[dumganhar]

Re: #

Changelog

---

Continuous Integration

This pull request:

• needs automatic test cases check.

  Manual trigger with @cocos-robot run test cases afterward.

• does not change any runtime related code or build configuration

  If any reviewer thinks the CI checks are needed, please uncheck this option, then close and reopen the issue.

---

Compatibility Check

This pull request:

• changes public API, and have ensured backward compatibility with deprecated features.
• affects platform compatibility, e.g. system version, browser version, platform sdk version, platform toolchain, language version, hardware compatibility etc.
• affects file structure of the build package or build configuration which requires user project upgrade.
• introduces breaking changes, please list all changes, affected features and the scope of violation.

[github-actions]

⚠️ Package size ⤴ 76 bytes, old: 5241181, new: 5241257

Interface Check Report

! WARNING this pull request has changed these public interfaces:

@@ -21283,8 +21283,13 @@
         /**
          * @internal
          */
         _objFlags: number;
+        /**
+         * @dontmangle
+         * NOTE: _name is a serializable property set by `CCClass.fastDefine`,
+         * so it should not be mangled while `mangleProtected` is true in `<<ProjectRoot>>/engine-mangle-config.json`.
+         */
         protected _name: string;
         constructor(name?: string);
         /**
          * @en The name of the object.
@@ -24602,8 +24607,16 @@
         /**
          * @deprecated since v3.5.0, this is an engine private interface that will be removed in the future.
          */
         _updateSiblingIndex(): void;
+        /**
+         * @dontmangle
+         * NOTE: the protected method `_instantiate` is invoked by dynamically without type information.
+         * See `instantiate` in cocos/serialization/instantiate.ts.
+         * ```ts
+         * clone = original._instantiate(null, true); // original is any, so _instantiate should not be mangled.
+         * ```
+         */
         protected _instantiate(cloned?: Node | null, isSyncedNode?: boolean): Node;
         protected _onHierarchyChangedBase(oldParent: this | null): void;
         protected _onPreDestroyBase(): boolean;
         protected _onSiblingIndexChanged?(siblingIndex: number): void;
@@ -25815,8 +25828,16 @@
          * 此方法将在第一次实例化预制件之前自动调用，<br/>
          * 但是您可以在脚本中修改原始预制数据后重新调用以刷新创建功能。
          */
         compileCreateFunction(): void;
+        /**
+         * @dontmangle
+         * NOTE: the protected method `_instantiate` is invoked by dynamically without type information.
+         * See `instantiate` in cocos/serialization/instantiate.ts.
+         * ```ts
+         * clone = original._instantiate(null, true); // original is any, so _instantiate should not be mangled.
+         * ```
+         */
         protected _instantiate(): Node;
         initDefault(uuid?: string): void;
         validate(): boolean;
         onLoaded(): void;
@@ -64038,9 +64059,20 @@
              */
             clear(): void;
             protected searchKeyframe(time: number): number;
             protected setKeyframes(times: number[], values: TKeyframeValue[]): void;
+            /**
+             * Times are always sorted and 1-1 correspond to values.
+             * @dontmangle
+             * NOTE: _times is a serializable property set by `CCClass.fastDefine`,
+             * so it should not be mangled while `mangleProtected` is true in `<<ProjectRoot>>/engine-mangle-config.json`.
+             */
             protected _times: number[];
+            /**
+             * @dontmangle
+             * NOTE: _values is a serializable property set by `CCClass.fastDefine`,
+             * so it should not be mangled while `mangleProtected` is true in `<<ProjectRoot>>/engine-mangle-config.json`.
+             */
             protected _values: TKeyframeValue[];
         }
         /**
          * @engineInternal

[minggo]

protected member variable will be mangled?

[dumganhar]

The file engine-mangle-config.json supports to control whether to mangle protected properties globally, its default value is false which means protected properties will not be mangled. But if developers set it to true, then all protected properties will be mangled too. The file format is :

{
	"common": {
	    "mangleProtected": false, // <------- here
	    "mangleList": [
	    	"MyClass2",
	    	"MyClass.foo",
	    	"MyClass.getBar"
	    ],
	    "dontMangleList": [
	        "BaseFactory",
	        "Slot",
	        "MyClass.hello"
	    ]
	},
	"web-mobile": {
		"extends": "common",
		"mangleList": [
			"MyClass3",
			"MyClass4.haha",
			"MyClass4.w111uwu"
		],
		"dontMangleList": [
			"MyClass5.skldjfl"
		]
	}
}

So if developer set mangleProtected to true, some properties are set by cc.fastDefine to mark them as serializable, so they should not be mangled. In this case, we should make sure some properties in engine should not be mangled by jsdoc tag @dontmangle.

[dumganhar]

For example:

CCClass.fastDefine('cc.AnimationCurve', AnimationCurve, {
    _curve: null, // <---- the protected property _curve should not be mangled.
});

[minggo]

Got it. If so, then how to determine if a protected variable can be mangled or not? What i mean is how to know if need to add @@dontmangle for protected variables?

[dumganhar]

Need to review the code to decide. So the mangleProtected is disabled (false) by default.

[minggo]

Need to review the code to decide.

Is there a simple rule to determine it? If not, then it will be hard to maintain the codes. And how to make sure it work or not, is there a CI to check it?

[dumganhar]

Currently, we haven't enable CI to run the feature of mangleProperties. I will discuss with QA team after editor is updated.

[dumganhar]

Package size ⤴ 76 bytes

Because the private property AnimationCurve._curve should not be mangled since it's a serializable property used by cc.fastDefine.

[dumganhar]

@minggo I added some comment for the API being marked as @dontmangle and reverted changes in component.ts