give more comprehensive error message on duplicated class id

EngineErrorMap.md

@@ -3639,7 +3639,7 @@ This device does not support WebGL.
 
 ### 16334
 
-A Class already exists with the same %s : %s. %s
+Could not register class ID '%s' for '%s' since the ID has been registered for '%s'.
 
 ### 16335
 

cocos/core/utils/js-typed.ts

@@ -85,7 +85,7 @@
  * @zh 如果不是空对象或者不是一个对象，返回 `true`；否则返回 `false`。
  */
 export function isEmptyObject (obj: any): boolean {
     for (const key in obj) {
         return false;
     }
     return true;
@@ -102,7 +102,7 @@
  * @param writable @en If the property is writable. @zh 属性是否可写。
  * @param enumerable @en If the property is enumerable. @zh 属性是否可枚举。
  */
 export const value = ((): (object: Record<string | number, any>, propertyName: string, value_: any, writable?: boolean, enumerable?: boolean) => void => {
     const descriptor: PropertyDescriptor = {
         value: undefined,
         enumerable: false,
@@ -128,13 +128,13 @@
  * @param enumerable @en If the property is enumerable. @zh 属性是否可列举。
  * @param configurable @en If the property is configurable. @zh 属性是否可配置。
  */
 export const getset = ((): (object: Record<string | number, any>, propertyName: string, getter: Getter, setter?: Setter | boolean, enumerable?: boolean, configurable?: boolean) => void => {
     const descriptor: PropertyDescriptor = {
         get: undefined,
         set: undefined,
         enumerable: false,
     };
     return (object: Record<string | number, any>, propertyName: string, getter: Getter, setter?: Setter | boolean, enumerable = false, configurable = false): void => {
         if (typeof setter === 'boolean') {
             logID(1031);
             enumerable = setter;
@@ -160,7 +160,7 @@
  * @param enumerable @en If the property is enumerable. @zh 属性是否可列举。
  * @param configurable @en If the property is configurable. @zh 属性是否可配置。
  */
 export const get = ((): (object: Record<string | number, any>, propertyName: string, getter: Getter, enumerable?: boolean, configurable?: boolean) => void => {
     const descriptor: PropertyDescriptor = {
         get: undefined,
         enumerable: false,
@@ -184,7 +184,7 @@
  * @param enumerable @en If the property is enumerable. @zh 属性是否可列举。
  * @param configurable @en If the property is configurable. @zh 属性是否可配置。
  */
 export const set = ((): (object: Record<string | number, any>, propertyName: string, setter: Setter, enumerable?: boolean, configurable?: boolean) => void => {
     const descriptor: PropertyDescriptor = {
         set: undefined,
         enumerable: false,
@@ -256,11 +256,11 @@
             if (str.charAt(0) === '[') {
                 // str is "[object objectClass]"
                 // eslint-disable-next-line @typescript-eslint/prefer-regexp-exec
                 arr = /\[\w+\s*(\w+)\]/.exec(str);
             } else {
                 // str is function objectClass () {} for IE Firefox
                 // eslint-disable-next-line @typescript-eslint/prefer-regexp-exec
                 arr = /^function\s*(\w+)/.exec(str);
             }
             if (arr && arr.length === 2) {
                 ret = arr[1];
@@ -303,9 +303,9 @@
     }
 
     if (writable) {
         getset(object, oldProp, getter, setter);
     } else {
         get(object, oldProp, getter);
     }
 }
 
@@ -323,7 +323,7 @@
 export function obsoletes (obj, objName, props, writable): void {
     for (const obsoleted in props) {
         const newName = props[obsoleted];
         obsolete(obj, `${objName}.${obsoleted}`, newName, writable);
     }
 }
 
@@ -366,7 +366,7 @@
         return '';
     }
     if (subst.length === 0) {
         return `${msg}`;
     }
 
     const hasSubstitution = typeof msg === 'string' && REGEXP_NUM_OR_STR.test(msg);
@@ -374,15 +374,15 @@
         for (const arg of subst) {
             const regExpToTest = typeof arg === 'number' ? REGEXP_NUM_OR_STR : REGEXP_STR;
             if (regExpToTest.test(msg as string)) {
                 const notReplaceFunction = `${arg}`;
                 msg = (msg as string).replace(regExpToTest, notReplaceFunction);
             } else {
                 msg += ` ${arg}`;
             }
         }
     } else {
         for (const arg of subst) {
             msg += ` ${arg}`;
         }
     }
     return msg as string;
@@ -522,7 +522,7 @@
             errorID(5405);
             return;
         }
         if (Object.keys(cls.prototype).length > 0) {
             errorID(5406);
         }
     }
@@ -620,7 +620,7 @@
 export const _nameToClass: Record<string, Constructor> = createMap(true);
 
 function setup (tag: string, table: Record<string | number, any>, allowExist: boolean): (id: string, constructor: Constructor) => void {
     return function (id: string, constructor: Constructor): void {
         // deregister old
         // eslint-disable-next-line no-prototype-builtins
         if (constructor.prototype.hasOwnProperty(tag)) {
@@ -631,14 +631,8 @@
         if (id) {
             const registered = table[id];
             if (!allowExist && registered && registered !== constructor) {
-                let detail = '';
-                if (TEST) {
-                    // eslint-disable-next-line no-multi-str
-                    detail += ' (This may be caused by error of unit test.) \
-If you dont need serialization, you can set class id to "". You can also call \
-js.unregisterClass to remove the id of unused class';
-                }
-                errorID(16334, tag, id, detail);
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+                errorID(16334, id, constructor.name, registered.name);
             } else {
                 table[id] = constructor;
             }

native/cocos/core/builtin/DebugInfos.cpp

@@ -537,7 +537,7 @@ ccstd::unordered_map<uint32_t, ccstd::string> debugInfos = {
 { 16331, "InputAssemblerInfo.vertexBuffers is null." },
 { 16332, "Illegal index buffer stride." },
 { 16333, "This device does not support WebGL." },
-{ 16334, "A Class already exists with the same %s : %s. %s" },
+{ 16334, "Could not register class ID '%s' for '%s' since the ID has been registered for '%s'." },
 { 16335, "'%s' has already been set as name or alias of another class." },
 { 16336, "'%s' has already been set as id or alias of another class." },
 { 16337, "can not support canvas rendering in 3D" },

tests/core/ccclass.test.ts

@@ -1,5 +1,5 @@
 import { ccclass } from 'cc.decorator';
-import { warnID } from '../../cocos/core';
+import { warnID, errorID } from '../../cocos/core';
 import { float, property } from '../../cocos/core/data/class-decorator';
 import * as requiringFrame from '../../cocos/core/data/utils/requiring-frame';
 import { getClassName, unregisterClass, getClassId } from '../../cocos/core/utils/js-typed';
@@ -62,6 +62,19 @@ describe('ccclass warnings', () => {
     });
 });
 
+test('Error on duplicated class id', () => {
+    // @ts-expect-error
+    errorID.mockClear();
+
+    const id = 'test-duplicated-class-id';
+
+    {@ccclass(id) class A {}}
+    {@ccclass(id) class B {}}
+
+    expect(errorID).toHaveBeenCalledTimes(1);
+    expect(errorID).toHaveBeenCalledWith(16334, id, 'B', 'A');
+});
+
 describe('Class id & class name', () => {
     type ExpectedNameComeFrom = 'self-name' | 'explicit-name' | 'frame-name';
     type ExpectedIdComeFrom = 'self-name' | 'explicit-name' | 'frame-uuid' | 'temp-id';
@@ -136,4 +149,4 @@ describe('Class id & class name', () => {
             unregisterClass(Cls_);
         }
     });
-});
+});