Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(fromEvent): Support React Native and node-compatible event sources. #3821

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 77 additions & 2 deletions spec/observables/fromEvent-spec.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
import { expect } from 'chai';
import { expectObservable } from '../helpers/marble-testing';
import { fromEvent, NEVER, timer, pipe } from 'rxjs';
import { Observable, fromEvent, NEVER, timer, pipe } from 'rxjs';
import { NodeStyleEventEmitter, NodeCompatibleEventEmitter, NodeEventHandler } from 'rxjs/internal/observable/fromEvent';
import { mapTo, take, concat } from 'rxjs/operators';
import { TestScheduler } from 'rxjs/testing';

declare const type: Function;

declare function asDiagram(arg: string): Function;
declare const rxTestScheduler: TestScheduler;

Expand Down Expand Up @@ -89,7 +92,7 @@ describe('fromEvent', () => {
expect(offHandler).to.equal(onHandler);
});

it('should setup an event observable on objects with "addListener" and "removeListener" ', () => {
it('should setup an event observable on objects with "addListener" and "removeListener" returning event emitter', () => {
let onEventName;
let onHandler;
let offEventName;
Expand Down Expand Up @@ -121,6 +124,37 @@ describe('fromEvent', () => {
expect(offHandler).to.equal(onHandler);
});

it('should setup an event observable on objects with "addListener" and "removeListener" returning nothing', () => {
let onEventName;
let onHandler;
let offEventName;
let offHandler;

const obj = {
addListener(a: string, b: (...args: any[]) => any, context?: any): { context: any } {
onEventName = a;
onHandler = b;
return { context: '' };
},
removeListener(a: string, b: (...args: any[]) => void) {
offEventName = a;
offHandler = b;
}
};

const subscription = fromEvent(obj, 'click')
.subscribe(() => {
//noop
});

subscription.unsubscribe();

expect(onEventName).to.equal('click');
expect(typeof onHandler).to.equal('function');
expect(offEventName).to.equal(onEventName);
expect(offHandler).to.equal(onHandler);
});

it('should setup an event observable on objects with "addListener" and "removeListener" and "length" ', () => {
let onEventName;
let onHandler;
Expand Down Expand Up @@ -363,4 +397,45 @@ describe('fromEvent', () => {
}).to.not.throw(TypeError);
});

type('should support node style event emitters interfaces', () => {
/* tslint:disable:no-unused-variable */
let a: NodeStyleEventEmitter;
let b: Observable<any> = fromEvent(a, 'mock');
/* tslint:enable:no-unused-variable */
});

type('should support node compatible event emitters interfaces', () => {
/* tslint:disable:no-unused-variable */
let a: NodeCompatibleEventEmitter;
let b: Observable<any> = fromEvent(a, 'mock');
/* tslint:enable:no-unused-variable */
});

type('should support node style event emitters objects', () => {
/* tslint:disable:no-unused-variable */
interface NodeEventEmitter {
addListener(eventType: string | symbol, handler: NodeEventHandler): this;
removeListener(eventType: string | symbol, handler: NodeEventHandler): this;
}
let a: NodeEventEmitter;
let b: Observable<any> = fromEvent(a, 'mock');
/* tslint:enable:no-unused-variable */
});

type('should support React Native event emitters', () => {
/* tslint:disable:no-unused-variable */
interface EmitterSubscription {
context: any;
}
interface ReactNativeEventEmitterListener {
addListener(eventType: string, listener: (...args: any[]) => any, context?: any): EmitterSubscription;
}
interface ReactNativeEventEmitter extends ReactNativeEventEmitterListener {
removeListener(eventType: string, listener: (...args: any[]) => any): void;
}
let a: ReactNativeEventEmitter;
let b: Observable<any> = fromEvent(a, 'mock');
/* tslint:enable:no-unused-variable */
});

});
10 changes: 9 additions & 1 deletion src/internal/observable/fromEvent.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,14 @@ export interface NodeStyleEventEmitter {

export type NodeEventHandler = (...args: any[]) => void;

// For APIs that implement `addListener` and `removeListener` methods that may
// not use the same arguments or return EventEmitter values
// such as React Native
export interface NodeCompatibleEventEmitter {
addListener: (eventName: string, handler: NodeEventHandler) => void | {};
removeListener: (eventName: string, handler: NodeEventHandler) => void | {};
}

export interface JQueryStyleEventEmitter {
on: (eventName: string, handler: Function) => void;
off: (eventName: string, handler: Function) => void;
Expand All @@ -23,7 +31,7 @@ export interface HasEventTargetAddRemove<E> {
removeEventListener(type: string, listener?: ((evt: E) => void) | null, options?: EventListenerOptions | boolean): void;
}

export type EventTargetLike<T> = HasEventTargetAddRemove<T> | NodeStyleEventEmitter | JQueryStyleEventEmitter;
export type EventTargetLike<T> = HasEventTargetAddRemove<T> | NodeStyleEventEmitter | NodeCompatibleEventEmitter | JQueryStyleEventEmitter;

export type FromEventTarget<T> = EventTargetLike<T> | ArrayLike<EventTargetLike<T>>;

Expand Down