Merge pull request #658 from openkraken/refactor/add-method-channel-h…

…andler ♻️ refactor: rename set to add
openkraken · Sep 13, 2021 · eb817b0 · eb817b0
2 parents 701ab9f + d7a7d57
commit eb817b0
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 8 deletions.
diff --git a/bridge/polyfill/src/method-channel.ts b/bridge/polyfill/src/method-channel.ts
@@ -7,8 +7,18 @@ let methodCallHandlers: MethodCallHandler[] = [];
 // Like flutter platform channels
 export const methodChannel = {
   setMethodCallHandler(handler: MethodCallHandler) {
+    console.warn('Deprecated API, use addMethodCallHandler instead.');
+    methodChannel.addMethodCallHandler(handler);
+  },
+  addMethodCallHandler(handler: MethodCallHandler) {
     methodCallHandlers.push(handler);
   },
+  removeMethodCallHandler(handler: MethodCallHandler) {
+    let index = methodCallHandlers.indexOf(handler);
+    if (index != -1) {
+      methodCallHandlers.splice(index, 1); 
+    }
+  },
   clearMethodCallHandler() {
     methodCallHandlers.length = 0;
   },

diff --git a/integration_tests/runtime/kraken.d.ts b/integration_tests/runtime/kraken.d.ts
@@ -1,6 +1,7 @@
 type MethodHandler = (method: string, args: any[]) => void;
 interface MethodChannel {
-    setMethodCallHandler(handler: MethodHandler): void;
+    addMethodCallHandler(handler: MethodHandler): void;
+    removeMethodCallHandler(handler: MethodHandler): void;
     invokeMethod(method: string, ...args: any[]): Promise<string>
 }
 

diff --git a/integration_tests/specs/method-channel/method-channel.ts b/integration_tests/specs/method-channel/method-channel.ts
@@ -1,6 +1,6 @@
 describe('MethodChannel', () => {
-  it('setMethodCallHandler multi params', async (done) => {
-    kraken.methodChannel.setMethodCallHandler((method: string, args: any[]) => {
+  it('addMethodCallHandler multi params', async (done) => {
+    kraken.methodChannel.addMethodCallHandler((method: string, args: any[]) => {
       expect(method).toBe('helloworld');
       expect(args).toEqual(['abc', 1234, null, /* undefined will be converted to */ null, [], true, false, {name: 1}]);
       done();
@@ -15,8 +15,8 @@ describe('MethodChannel', () => {
     expect(result).toBe('method: helloworld');
   });
 
-  it('setMethodHandler', async (done) => {
-    kraken.methodChannel.setMethodCallHandler((method: string, args: any[]) => {
+  it('addMethodCallHandler', async (done) => {
+    kraken.methodChannel.addMethodCallHandler((method: string, args: any[]) => {
       expect(method).toBe('helloworld');
       expect(args).toEqual(['abc']);
       done();
@@ -25,17 +25,29 @@ describe('MethodChannel', () => {
     expect(result).toBe('method: helloworld');
   });
 
-  it('setMethodCallHandler multi params with multi handler', async (done) => {
+
+  it('removeMethodCallHandler', async (done: DoneFn) => {
+    var handler = (method: string, args: any[]) => {
+      done.fail('should not execute here.');
+    };
+    kraken.methodChannel.addMethodCallHandler(handler);
+    kraken.methodChannel.removeMethodCallHandler(handler);
+    let result = await kraken.methodChannel.invokeMethod('helloworld', 'abc');
+    expect(result).toBe('method: helloworld');
+    done();
+  });
+
+  it('addMethodCallHandler multi params with multi handler', async (done) => {
     let handlerCount = 0;
-    kraken.methodChannel.setMethodCallHandler((method: string, args: any[]) => {
+    kraken.methodChannel.addMethodCallHandler((method: string, args: any[]) => {
       handlerCount++;
       expect(method).toBe('helloworld');
       expect(args).toEqual(['abc', 1234, null, /* undefined will be converted to */ null, [], true, false, {name: 1}]);
       if(handlerCount == 2) {
         done();
       }
     });
-    kraken.methodChannel.setMethodCallHandler((method: string, args: any[]) => {
+    kraken.methodChannel.addMethodCallHandler((method: string, args: any[]) => {
       handlerCount++;
       expect(method).toBe('helloworld');
       expect(args).toEqual(['abc', 1234, null, /* undefined will be converted to */ null, [], true, false, {name: 1}]);