Rxjs: Increase dtslint test coverage

[cartant]

Chore

https://github.com/ReactiveX/rxjs/pull/3944 added dtslint to the Travis $FULL_VALIDATE configuration. However, the coverage of the codebase is far from complete.

PRs that contribute to increasing the coverage are welcome.

The purpose of the dtslint tests is to ensure that the types are inferred as expected and to ensure that type errors are effected for invalid types. At the moment, there are some type tests in the codebase. These are able to do the former, but not the latter - as type errors would break the build.

For an example of the type tests, see these for the zip observable and these for the zip operator. The type tests are not executed when the tests run. Rather, they're tested when the tests are built. And if the tests build, the type tests have passed. Not all operators and operators have type tests. In fact, many don't.

The dtslint tests reside in the spec-dtslint directory. They are written as Mocha-style it tests, but they are not run. Instead, TSLint runs rules that test the inferred types against expectations that are expression in comments. For example:

it('should support observables', () => {
  const a = of(1); // $ExpectType Observable<number>
  const b = of('foo'); // $ExpectType Observable<string>
  const c = of(true); // $ExpectType Observable<boolean>
  const o1 = zip(a, b, c); // $ExpectType Observable<[number, string, boolean]>
});

You can find the type tests that have been converted to dtslint tests for the zip observable here and for the zip operator here.

Apart from converting the type tests, we want to ensure that there are dtslint tests for each overload signature for each observable and operator.

Submitting separate PRs - each with one or only a few observables or operators - would be the best way to approach this, as PRs with a limited number of observables or operators should be straightforward to review.

Running the tests

The tests will run on the Travis CI build, but you can run them locally using the dtslint script:

npm run dtslint

However, doing so will see dtslint run via npx, which means it will be downloaded each time the script runs. This is very slow, as it also downloads several versions of TypeScript.

If you are going to run dtslint locally, you might want to install it globally and then run the tests using:

dtslint spec-dtslint/

Additional context

• Microsoft/dtslint
• Testing Types: An Introduction to dtslint

[timdeschryver]

We're past half-way through!
✋ @dkosasih

[timdeschryver]

And of course you too @cartant, thanks for the reviews.

[timdeschryver]

These are the operators that need coverage. As you can see, we're almost there 😄

• [x] https://github.com/ReactiveX/rxjs/blob/master/src/internal/operators/combineLatest.ts
• [x] https://github.com/ReactiveX/rxjs/blob/master/src/internal/operators/merge.ts
• [x] https://github.com/ReactiveX/rxjs/blob/master/src/internal/operators/multicast.ts
• [x] https://github.com/ReactiveX/rxjs/blob/master/src/internal/operators/onErrorResumeNext.ts
• [ ] https://github.com/ReactiveX/rxjs/blob/master/src/internal/operators/onErrorResumeNext.ts - static. Wait till #4356 is merged.
• [x] https://github.com/ReactiveX/rxjs/blob/master/src/internal/operators/partition.ts
• [x] https://github.com/ReactiveX/rxjs/blob/master/src/internal/operators/share.ts
• [x] https://github.com/ReactiveX/rxjs/blob/master/src/internal/operators/shareReplay.ts
• [x] https://github.com/ReactiveX/rxjs/blob/master/src/internal/operators/single.ts
• [x] https://github.com/ReactiveX/rxjs/blob/master/src/internal/operators/subscribeOn.ts
• [x] https://github.com/ReactiveX/rxjs/blob/master/src/internal/operators/throwIfEmpty.ts
• [x] https://github.com/ReactiveX/rxjs/blob/master/src/internal/operators/timeInterval.ts
• [x] https://github.com/ReactiveX/rxjs/blob/master/src/internal/operators/timestamp.ts
• [x] https://github.com/ReactiveX/rxjs/blob/master/src/internal/operators/toArray.ts
• [x] https://github.com/ReactiveX/rxjs/blob/master/src/internal/operators/window.ts
• [x] https://github.com/ReactiveX/rxjs/blob/master/src/internal/operators/windowCount.ts
• [ ] https://github.com/ReactiveX/rxjs/blob/master/src/internal/operators/windowTime.ts
• [ ] https://github.com/ReactiveX/rxjs/blob/master/src/internal/operators/windowToggle.ts
• [ ] https://github.com/ReactiveX/rxjs/blob/master/src/internal/operators/windowWhen.ts
• [ ] https://github.com/ReactiveX/rxjs/blob/master/src/internal/operators/withLatestFrom.ts
• [ ] https://github.com/ReactiveX/rxjs/blob/master/src/internal/operators/zipAll.ts

[timdeschryver]

A copy, since the previous message was hidden.

These are the operators that need coverage. As you can see, we're almost there 😄

• [x] https://github.com/ReactiveX/rxjs/blob/master/src/internal/operators/combineLatest.ts
• [x] https://github.com/ReactiveX/rxjs/blob/master/src/internal/operators/merge.ts
• [x] https://github.com/ReactiveX/rxjs/blob/master/src/internal/operators/multicast.ts
• [x] https://github.com/ReactiveX/rxjs/blob/master/src/internal/operators/onErrorResumeNext.ts
• [ ] https://github.com/ReactiveX/rxjs/blob/master/src/internal/operators/onErrorResumeNext.ts - static. Wait till #4356 is merged.
• [x] https://github.com/ReactiveX/rxjs/blob/master/src/internal/operators/partition.ts
• [x] https://github.com/ReactiveX/rxjs/blob/master/src/internal/operators/share.ts
• [x] https://github.com/ReactiveX/rxjs/blob/master/src/internal/operators/shareReplay.ts
• [x] https://github.com/ReactiveX/rxjs/blob/master/src/internal/operators/single.ts
• [x] https://github.com/ReactiveX/rxjs/blob/master/src/internal/operators/subscribeOn.ts
• [x] https://github.com/ReactiveX/rxjs/blob/master/src/internal/operators/throwIfEmpty.ts
• [x] https://github.com/ReactiveX/rxjs/blob/master/src/internal/operators/timeInterval.ts
• [x] https://github.com/ReactiveX/rxjs/blob/master/src/internal/operators/timestamp.ts
• [x] https://github.com/ReactiveX/rxjs/blob/master/src/internal/operators/toArray.ts
• [x] https://github.com/ReactiveX/rxjs/blob/master/src/internal/operators/window.ts
• [x] https://github.com/ReactiveX/rxjs/blob/master/src/internal/operators/windowCount.ts
• [x] https://github.com/ReactiveX/rxjs/blob/master/src/internal/operators/windowTime.ts
• [x] https://github.com/ReactiveX/rxjs/blob/master/src/internal/operators/windowToggle.ts
• [x] https://github.com/ReactiveX/rxjs/blob/master/src/internal/operators/windowWhen.ts
• [x] https://github.com/ReactiveX/rxjs/blob/master/src/internal/operators/withLatestFrom.ts
• [x] https://github.com/ReactiveX/rxjs/blob/master/src/internal/operators/zipAll.ts

[dkosasih]

Merry Christmas everyone.
I just want to list down the observable creator function from the source so we can all refer to the list and not cross path while working on it.

• [ ] bindCallback
• [ ] bindNodeCallback
• [x] combineLatest
• [x] concat
• [x] defer
• [x] empty
• [x] forkJoin
• [x] from
• [ ] fromEvent
• [ ] fromEventPattern
• [x] iif
• [x] interval
• [x] merge
• [x] never
• [x] of
• [ ] onErrorResumeNext
• [ ] pairs
• [x] race
• [x] range
• [ ] scalar
• [ ] SubscribeOnObservable
• [x] throwError
• [x] timer
• [ ] using
• [x] zip