fix(event): fix#1110, nodejs EventEmitter should support Symbol eventName (#1113)

Author: JiaLiPassion

file-size-limit.json

@@ -3,7 +3,7 @@
  {
 "path": "dist/zone.min.js",
 "checkTarget": true,
-"limit": 42500
+"limit": 43000
  }
  ]
 }

lib/common/events.ts

@@ -69,6 +69,8 @@ export interface PatchEventTargetOptions {
 diff?: (task: any,delegate: any)=>boolean;
 // support passive or not
 supportPassive?: boolean;
+// get string from eventName (in nodejs, eventName maybe Symbol)
+eventNameToString?: (eventName: any)=>string;
 }
 
 exportfunctionpatchEventTarget(
@@ -212,6 +214,8 @@ export function patchEventTarget(
 returnfalse;
 }
 
+consteventNameToString=patchOptions&&patchOptions.eventNameToString;
+
 // a shared global taskData to pass data for scheduleEventTask
 // so we do not need to create a new object just for pass some data
 consttaskData: any={};
@@ -384,8 +388,10 @@ export function patchEventTarget(
 letsymbolEventName;
 if(!symbolEventNames){
 // the code is duplicate, but I just want to get some better performance
-constfalseEventName=eventName+FALSE_STR;
-consttrueEventName=eventName+TRUE_STR;
+constfalseEventName=
+(eventNameToString ? eventNameToString(eventName) : eventName)+FALSE_STR;
+consttrueEventName=
+(eventNameToString ? eventNameToString(eventName) : eventName)+TRUE_STR;
 constsymbol=ZONE_SYMBOL_PREFIX+falseEventName;
 constsymbolCapture=ZONE_SYMBOL_PREFIX+trueEventName;
 zoneSymbolEventNames[eventName]={};
@@ -418,7 +424,8 @@ export function patchEventTarget(
 source=targetSource[eventName];
 }
 if(!source){
-source=constructorName+addSource+eventName;
+source=constructorName+addSource+
+(eventNameToString ? eventNameToString(eventName) : eventName);
 }
 // do not create a new object as task.data to pass those things
 // just use the global shared one
@@ -556,7 +563,8 @@ export function patchEventTarget(
 consteventName=arguments[0];
 
 constlisteners: any[]=[];
-consttasks=findEventTasks(target,eventName);
+consttasks=
+findEventTasks(target,eventNameToString ? eventNameToString(eventName) : eventName);
 
 for(leti=0;i<tasks.length;i++){
 consttask: any=tasks[i];

lib/node/events.ts

@@ -22,6 +22,16 @@ Zone.__load_patch('EventEmitter', (global: any) => {
 returntask.callback===delegate||task.callback.listener===delegate;
 };
 
+consteventNameToString=function(eventName: string|Symbol){
+if(typeofeventName==='string'){
+returneventNameasstring;
+}
+if(!eventName){
+return'';
+}
+returneventName.toString().replace('(','_').replace(')','_');
+};
+
 functionpatchEventEmitterMethods(obj: any){
 constresult=patchEventTarget(global,[obj],{
 useG: false,
@@ -32,7 +42,8 @@ Zone.__load_patch('EventEmitter', (global: any) => {
 listeners: EE_LISTENERS,
 chkDup: false,
 rt: true,
-diff: compareTaskCallbackVsDelegate
+diff: compareTaskCallbackVsDelegate,
+eventNameToString: eventNameToString
 });
 if(result&&result[0]){
 obj[EE_ON]=obj[EE_ADD_LISTENER];

test/node/events.spec.ts

@@ -189,4 +189,16 @@ describe('nodejs EventEmitter', () => {
 process.on('uncaughtException',function(){});
 });
 });
+it('should be able to addEventListener with symbol eventName',()=>{
+zoneA.run(()=>{
+consttestSymbol=Symbol('test');
+consttest1Symbol=Symbol('test1');
+emitter.on(testSymbol,expectZoneA);
+emitter.on(test1Symbol,shouldNotRun);
+emitter.removeListener(test1Symbol,shouldNotRun);
+expect(emitter.listeners(testSymbol).length).toBe(1);
+expect(emitter.listeners(test1Symbol).length).toBe(0);
+emitter.emit(testSymbol,'test value');
+});
+});
 });

tsconfig-esm-node.json

@@ -18,7 +18,8 @@
 "lib": [
 "es5",
 "dom",
-"es2015.promise"
+"es2015.promise",
+"es2015.symbol"
  ]
  },
 "exclude": [

tsconfig-esm.json

@@ -26,6 +26,13 @@
 "build",
 "build-esm",
 "dist",
-"lib/closure"
+"lib/closure",
+"lib/node/**",
+"lib/mix/**",
+"test/node/**",
+"test/node_bluebird_entry_point.ts",
+"test/node_entry_point.ts",
+"test/node_error_entry_point.ts",
+"test/node_tests.ts"
  ]
 }

tsconfig-node.json

@@ -16,7 +16,8 @@
 "lib": [
 "es5",
 "dom",
-"es2015.promise"
+"es2015.promise",
+"es2015.symbol"
  ]
  },
 "exclude": [

tsconfig.json

@@ -23,6 +23,13 @@
 "build",
 "build-esm",
 "dist",
-"lib/closure"
+"lib/closure",
+"lib/node/**",
+"lib/mix/**",
+"test/node/**",
+"test/node_bluebird_entry_point.ts",
+"test/node_entry_point.ts",
+"test/node_error_entry_point.ts",
+"test/node_tests.ts"
  ]
 }