feat(sandbox): support 7.x

- BREAKING CHANGE: supports rxjs >= 7

Author: kwonoj

spec/marbles/parseObservableMarble-spec.ts

@@ -1,9 +1,16 @@
 import { expect } from 'chai';
-import { ColdObservable } from 'rxjs/internal/testing/ColdObservable';
 import { parseObservableMarble } from '../../src/marbles/parseObservableMarble';
 import { complete, error, next } from '../../src/message/TestMessage';
 import { TestScheduler } from '../../src/scheduler/TestScheduler';
 
+//tslint:disable no-var-requires no-require-imports
+const {
+  ColdObservable,
+}: {
+  ColdObservable: typeof import('rxjs/dist/types/internal/testing/ColdObservable').ColdObservable;
+} = require('rxjs/dist/cjs/internal/testing/ColdObservable');
+//tslint:enable no-var-requires no-require-imports
+
 describe('parseObservableMarble', () => {
   it('should not allow unsubscription token', () => {
     const marble = '----!';
@@ -52,7 +59,7 @@ describe('parseObservableMarble', () => {
 
     const customValue = {
       a: new ColdObservable(aMessages, null as any),
-      b: new ColdObservable(bMessages, null as any)
+      b: new ColdObservable(bMessages, null as any),
     };
 
     const messages = parseObservableMarble(marble, customValue, null, true);
@@ -68,7 +75,7 @@ describe('parseObservableMarble', () => {
 
     const customValue = {
       a: new ColdObservable<string>(aMessages, null as any),
-      b: new ColdObservable<string>(bMessages, null as any)
+      b: new ColdObservable<string>(bMessages, null as any),
     };
 
     const messages = parseObservableMarble(marble, customValue, null, false);
@@ -107,7 +114,7 @@ describe('parseObservableMarble', () => {
   it('should parse value literal with custom value', () => {
     const marble = '----a----';
     const customValue = {
-      a: 'qwerty'
+      a: 'qwerty',
     };
 
     const messages = parseObservableMarble(marble, customValue);

spec/scheduler/TestScheduler-spec.ts

@@ -1,12 +1,27 @@
 import { expect } from 'chai';
-import { AsyncAction } from 'rxjs/internal/scheduler/AsyncAction';
-import { ColdObservable } from 'rxjs/internal/testing/ColdObservable';
-import { HotObservable } from 'rxjs/internal/testing/HotObservable';
 import { mapTo, windowCount } from 'rxjs/operators';
 import { parseObservableMarble } from '../../src/marbles/parseObservableMarble';
 import { complete, error, next, subscribe, TestMessage } from '../../src/message/TestMessage';
 import { TestScheduler } from '../../src/scheduler/TestScheduler';
 
+//tslint:disable no-var-requires no-require-imports
+const {
+  AsyncAction,
+}: {
+  AsyncAction: typeof import('rxjs/dist/types/internal/scheduler/AsyncAction').AsyncAction;
+} = require('rxjs/dist/cjs/internal/scheduler/AsyncAction');
+const {
+  ColdObservable,
+}: {
+  ColdObservable: typeof import('rxjs/dist/types/internal/testing/ColdObservable').ColdObservable;
+} = require('rxjs/dist/cjs/internal/testing/ColdObservable');
+const {
+  HotObservable,
+}: {
+  HotObservable: typeof import('rxjs/dist/types/internal/testing/HotObservable').HotObservable;
+} = require('rxjs/dist/cjs/internal/testing/HotObservable');
+//tslint:enable no-var-requires no-require-imports
+
 describe('TestScheduler', () => {
   describe('hotObservable', () => {
     it('should create hot observable via TestMessage', () => {

src/RxSandbox.ts

@@ -1,4 +1,4 @@
-import { SubscriptionLog } from 'rxjs/internal/testing/SubscriptionLog';
+import { SubscriptionLog } from 'rxjs/dist/types/internal/testing/SubscriptionLog';
 import { TestMessage } from './message/TestMessage';
 import { RxSandboxInstance } from './RxSandboxInstance';
 

src/RxSandboxInstance.ts

@@ -1,4 +1,4 @@
-import { SubscriptionLog } from 'rxjs/internal/testing/SubscriptionLog';
+import { SubscriptionLog } from 'rxjs/dist/types/internal/testing/SubscriptionLog';
 import { TestMessage } from './message/TestMessage';
 import { TestScheduler } from './scheduler/TestScheduler';
 
@@ -59,5 +59,5 @@ export {
   getObservableMessage,
   expectedObservable,
   expectedSubscription,
-  RxSandboxInstance
+  RxSandboxInstance,
 };

src/assert/constructSubscriptionMarble.ts

@@ -1,4 +1,4 @@
-import { SubscriptionLog } from 'rxjs/internal/testing/SubscriptionLog';
+import { SubscriptionLog } from 'rxjs/dist/types/internal/testing/SubscriptionLog';
 import { ObservableMarbleToken } from '../marbles/ObservableMarbleToken';
 import { SubscriptionMarbleToken } from '../marbles/SubscriptionMarbleToken';
 
@@ -9,7 +9,7 @@ const MAX_FRAME_LENGTH = 30;
  */
 const constructSubscriptionMarble = ({
   subscribedFrame,
-  unsubscribedFrame
+  unsubscribedFrame,
 }: SubscriptionLog): { marbleString: string; frameString: string } => {
   const marble: Array<ObservableMarbleToken | SubscriptionMarbleToken> = Array.from(Array(MAX_FRAME_LENGTH + 1)).map(
     () => ObservableMarbleToken.TIMEFRAME

src/assert/marbleAssert.ts

@@ -1,13 +1,18 @@
 import { toEqual } from 'jest-matchers/build/matchers';
-import { SubscriptionLog } from 'rxjs/internal/testing/SubscriptionLog';
 import { TestMessage } from '../message/TestMessage';
 import { constructObservableMarble } from './constructObservableMarble';
 import { constructSubscriptionMarble } from './constructSubscriptionMarble';
-const { matcherHint, printExpected, printReceived } = require('jest-matcher-utils'); //tslint:disable-line:no-require-imports no-var-requires
+
+//tslint:disable:no-require-imports no-var-requires
+const { matcherHint, printExpected, printReceived } = require('jest-matcher-utils');
+const { SubscriptionLog } = require('rxjs/dist/cjs/internal/testing/SubscriptionLog');
+//tslint:enbale:no-require-imports no-var-requires
 
 const toEqualAssert = toEqual.bind({ expand: false });
 
-const subscriptionMarbleAssert = (source: Array<SubscriptionLog>) => (expected: Array<SubscriptionLog>) => {
+const subscriptionMarbleAssert = (
+  source: Array<import('rxjs/dist/types/internal/testing/SubscriptionLog').SubscriptionLog>
+) => (expected: Array<import('rxjs/dist/types/internal/testing/SubscriptionLog').SubscriptionLog>) => {
   const asserted = toEqualAssert(source, expected);
 
   if (!asserted.pass) {
@@ -52,6 +57,7 @@ const observableMarbleAssert = <T = string>(source: Array<TestMessage<T>> | Read
 
   //polymorphic picks up observablemarbleassert first when empty array, manually falls back
   //if expected is subscriptionlog
+  //tslint:disable-next-line no-var-requires no-require-imports
   if ((expected as any).every((x: any) => x instanceof SubscriptionLog)) {
     subscriptionMarbleAssert(source as any)(expected as any);
     return;
@@ -83,11 +89,11 @@ function marbleAssert<T = string>(
   };
 };
 function marbleAssert<T = void>(
-  source: Array<SubscriptionLog>
-): { to: { equal(expected: Array<SubscriptionLog>): void } };
+  source: Array<import('rxjs/dist/types/internal/testing/SubscriptionLog').SubscriptionLog>
+): { to: { equal(expected: Array<import('rxjs/dist/types/internal/testing/SubscriptionLog').SubscriptionLog>): void } };
 function marbleAssert<T = string>(
   source:
-    | Array<SubscriptionLog>
+    | Array<import('rxjs/dist/types/internal/testing/SubscriptionLog').SubscriptionLog>
     | Array<TestMessage<T | Array<TestMessage<T>>>>
     | Readonly<Array<TestMessage<T | Array<TestMessage<T>>>>>
 ): { to: { equal(expected: object): void } } {
@@ -96,12 +102,12 @@ function marbleAssert<T = string>(
     throw new Error('Cannot assert non array');
   }
 
-  const isSourceSubscription = source.length > 0 && (source as Array<any>).every(v => v instanceof SubscriptionLog);
+  const isSourceSubscription = source.length > 0 && (source as Array<any>).every((v) => v instanceof SubscriptionLog);
 
   return {
     to: {
-      equal: isSourceSubscription ? subscriptionMarbleAssert(source as any) : observableMarbleAssert(source as any)
-    }
+      equal: isSourceSubscription ? subscriptionMarbleAssert(source as any) : observableMarbleAssert(source as any),
+    },
   };
 }
 

src/index.ts

@@ -1,6 +1,3 @@
-import { Observable } from 'rxjs';
-import { ColdObservable } from 'rxjs/internal/testing/ColdObservable';
-import { HotObservable } from 'rxjs/internal/testing/HotObservable';
 import { marbleAssert } from './assert/marbleAssert';
 import { parseObservableMarble } from './marbles/parseObservableMarble';
 import { parseSubscriptionMarble } from './marbles/parseSubscriptionMarble';
@@ -16,14 +13,9 @@ export {
   getObservableMessage,
   expectedObservable,
   expectedSubscription,
-  RxSandboxInstance
+  RxSandboxInstance,
 } from './RxSandboxInstance';
 
-//workaround TS4029 by explicitly import types and avoid unused import error
-(() => Observable.toString())();
-(() => ColdObservable.toString())();
-(() => HotObservable.toString())();
-
 type marbleAssertion = typeof marbleAssert;
 
 const rxSandbox: RxSandbox = {
@@ -39,10 +31,10 @@ const rxSandbox: RxSandbox = {
       getMessages: scheduler.getMessages.bind(scheduler) as typeof scheduler.getMessages,
       e: <T = string>(marble: string, value?: { [key: string]: T } | null, error?: any) =>
         parseObservableMarble(marble, value, error, true, frameTimeFactor, frameTimeFactor * maxFrameValue),
-      s: (marble: string) => parseSubscriptionMarble(marble, frameTimeFactor, frameTimeFactor * maxFrameValue)
+      s: (marble: string) => parseSubscriptionMarble(marble, frameTimeFactor, frameTimeFactor * maxFrameValue),
     };
   },
-  marbleAssert: marbleAssert
+  marbleAssert: marbleAssert,
 };
 
 export { rxSandbox, TestMessage, marbleAssertion, next, error, complete, subscribe };

src/marbles/parseSubscriptionMarble.ts

@@ -1,20 +1,27 @@
-import { SubscriptionLog } from 'rxjs/internal/testing/SubscriptionLog';
 import { ObservableMarbleToken } from './ObservableMarbleToken';
 import { subscriptionTokenParseReducer } from './tokenParseReducer';
 
+//tslint:disable no-var-requires no-require-imports
+const {
+  SubscriptionLog,
+}: {
+  SubscriptionLog: typeof import('rxjs/dist/types/internal/testing/SubscriptionLog').SubscriptionLog;
+} = require('rxjs/dist/cjs/internal/testing/SubscriptionLog');
+//tslint:enable no-var-requires no-require-imports
+
 const parseSubscriptionMarble = (marble: string | null, frameTimeFactor: number = 1, maxFrame = 1000) => {
   if (!marble) {
     return new SubscriptionLog(Number.POSITIVE_INFINITY);
   }
 
-  const marbleTokenArray = Array.from(marble).filter(token => token !== ObservableMarbleToken.NOOP);
+  const marbleTokenArray = Array.from(marble).filter((token) => token !== ObservableMarbleToken.NOOP);
   const value = marbleTokenArray.reduce(subscriptionTokenParseReducer(frameTimeFactor, maxFrame), {
     currentTimeFrame: 0,
     subscriptionFrame: Number.POSITIVE_INFINITY,
     unsubscriptionFrame: Number.POSITIVE_INFINITY,
     simultaneousGrouped: false,
     expandingTokenCount: 0,
-    expandingValue: []
+    expandingValue: [],
   });
 
   return value.unsubscriptionFrame === Number.POSITIVE_INFINITY

src/marbles/tokenParseReducer.ts

@@ -1,8 +1,15 @@
-import { ColdObservable } from 'rxjs/internal/testing/ColdObservable';
 import { complete, error as e, next, TestMessage } from '../message/TestMessage';
 import { ObservableMarbleToken } from './ObservableMarbleToken';
 import { SubscriptionMarbleToken } from './SubscriptionMarbleToken';
 
+//tslint:disable no-var-requires no-require-imports
+const {
+  ColdObservable,
+}: {
+  ColdObservable: typeof import('rxjs/dist/types/internal/testing/ColdObservable').ColdObservable;
+} = require('rxjs/dist/cjs/internal/testing/ColdObservable');
+//tslint:enable no-var-requires no-require-imports
+
 /**
  * @internal
  * Base accumulator interface for parsing marble diagram.
@@ -219,5 +226,5 @@ export {
   ObservableTokenParseAccumulator,
   SubscriptionTokenParseAccumulator,
   subscriptionTokenParseReducer,
-  observableTokenParseReducer
+  observableTokenParseReducer,
 };

src/message/TestMessage.ts

@@ -1,5 +1,12 @@
 import { Notification } from 'rxjs';
-import { SubscriptionLog } from 'rxjs/internal/testing/SubscriptionLog';
+
+//tslint:disable no-var-requires no-require-imports
+const {
+  SubscriptionLog,
+}: {
+  SubscriptionLog: typeof import('rxjs/dist/types/internal/testing/SubscriptionLog').SubscriptionLog;
+} = require('rxjs/dist/cjs/internal/testing/SubscriptionLog');
+//tslint:enable no-var-requires no-require-imports
 
 /**
  * Represents interface for single metadata value emitted by HotObservable<T> or ColdObservable<T>

src/scheduler/TestScheduler.ts

@@ -1,23 +1,34 @@
 import { Notification, Observable, Subscription } from 'rxjs';
-import { AsyncAction } from 'rxjs/internal/scheduler/AsyncAction';
-import {
-  VirtualAction,
-  VirtualTimeScheduler
-} from 'rxjs/internal/scheduler/VirtualTimeScheduler';
-import { ColdObservable } from 'rxjs/internal/testing/ColdObservable';
-import { HotObservable } from 'rxjs/internal/testing/HotObservable';
+import { AsyncAction } from 'rxjs/dist/types/internal/scheduler/AsyncAction';
 import { parseObservableMarble } from '../marbles/parseObservableMarble';
 import { SubscriptionMarbleToken } from '../marbles/SubscriptionMarbleToken';
 import { TestMessage } from '../message/TestMessage';
 import { TestMessageValue } from '../message/TestMessage';
 import { calculateSubscriptionFrame } from './calculateSubscriptionFrame';
 
+//tslint:disable no-var-requires no-require-imports
+const {
+  VirtualAction,
+  VirtualTimeScheduler,
+}: {
+  VirtualAction: typeof import('rxjs/dist/types/internal/scheduler/VirtualTimeScheduler').VirtualAction;
+  VirtualTimeScheduler: typeof import('rxjs/dist/types/internal/scheduler/VirtualTimeScheduler').VirtualTimeScheduler;
+} = require('rxjs/dist/cjs/internal/scheduler/VirtualTimeScheduler');
+
+const hotObservableCtor = require('rxjs/dist/cjs/internal/testing/HotObservable').HotObservable;
+const coldObservableCtor = require('rxjs/dist/cjs/internal/testing/ColdObservable').ColdObservable;
+//tslint:enable no-var-requires no-require-imports
+
 /**
  * @internal
  */
 class TestScheduler extends VirtualTimeScheduler {
-  private readonly coldObservables: Array<ColdObservable<any>> = [];
-  private readonly hotObservables: Array<HotObservable<any>> = [];
+  private readonly coldObservables: Array<
+    import('rxjs/dist/types/internal/testing/ColdObservable').ColdObservable<any>
+  > = [];
+  private readonly hotObservables: Array<
+    import('rxjs/dist/types/internal/testing/HotObservable').HotObservable<any>
+  > = [];
   private flushed: boolean = false;
   private flushing: boolean = false;
 
@@ -75,9 +86,17 @@ class TestScheduler extends VirtualTimeScheduler {
     return observableMetadata;
   }
 
-  public createColdObservable<T = string>(marble: string, value?: { [key: string]: T } | null, error?: any): ColdObservable<T>;
-  public createColdObservable<T = string>(message: Array<TestMessage<T>>): ColdObservable<T>;
-  public createColdObservable<T = string>(...args: Array<any>): ColdObservable<T> {
+  public createColdObservable<T = string>(
+    marble: string,
+    value?: { [key: string]: T } | null,
+    error?: any
+  ): import('rxjs/dist/types/internal/testing/ColdObservable').ColdObservable<T>;
+  public createColdObservable<T = string>(
+    message: Array<TestMessage<T>>
+  ): import('rxjs/dist/types/internal/testing/ColdObservable').ColdObservable<T>;
+  public createColdObservable<T = string>(
+    ...args: Array<any>
+  ): import('rxjs/dist/types/internal/testing/ColdObservable').ColdObservable<T> {
     const [marbleValue, value, error] = args;
 
     if (typeof marbleValue === 'string' && marbleValue.indexOf(SubscriptionMarbleToken.SUBSCRIBE) !== -1) {
@@ -86,21 +105,29 @@ class TestScheduler extends VirtualTimeScheduler {
 
     const messages = Array.isArray(marbleValue)
       ? marbleValue
-      : parseObservableMarble(marbleValue, value, error, false, this.frameTimeFactor, this._maxFrame) as any;
-    const observable = new ColdObservable<T>(messages as Array<TestMessage<T | Array<TestMessage<T>>>>, this);
+      : (parseObservableMarble(marbleValue, value, error, false, this.frameTimeFactor, this._maxFrame) as any);
+    const observable = new coldObservableCtor(messages as Array<TestMessage<T | Array<TestMessage<T>>>>, this);
     this.coldObservables.push(observable);
     return observable;
   }
 
-  public createHotObservable<T = string>(marble: string, value?: { [key: string]: T } | null, error?: any): HotObservable<T>;
-  public createHotObservable<T = string>(message: Array<TestMessage<T>>): HotObservable<T>;
-  public createHotObservable<T = string>(...args: Array<any>): HotObservable<T> {
+  public createHotObservable<T = string>(
+    marble: string,
+    value?: { [key: string]: T } | null,
+    error?: any
+  ): import('rxjs/dist/types/internal/testing/HotObservable').HotObservable<T>;
+  public createHotObservable<T = string>(
+    message: Array<TestMessage<T>>
+  ): import('rxjs/dist/types/internal/testing/HotObservable').HotObservable<T>;
+  public createHotObservable<T = string>(
+    ...args: Array<any>
+  ): import('rxjs/dist/types/internal/testing/HotObservable').HotObservable<T> {
     const [marbleValue, value, error] = args;
 
     const messages = Array.isArray(marbleValue)
       ? marbleValue
-      : parseObservableMarble(marbleValue, value, error, false, this.frameTimeFactor, this._maxFrame) as any;
-    const subject = new HotObservable<T>(messages as Array<TestMessage<T | Array<TestMessage<T>>>>, this);
+      : (parseObservableMarble(marbleValue, value, error, false, this.frameTimeFactor, this._maxFrame) as any);
+    const subject = new hotObservableCtor(messages as Array<TestMessage<T | Array<TestMessage<T>>>>, this);
     this.hotObservables.push(subject);
     return subject;
   }
@@ -124,8 +151,8 @@ class TestScheduler extends VirtualTimeScheduler {
       innerObservableMetadata.push(new TestMessageValue<T>(this.frame - outerFrame, notification));
 
     observable.subscribe(
-      value => pushMetaData(Notification.createNext(value)),
-      err => pushMetaData(Notification.createError(err)),
+      (value) => pushMetaData(Notification.createNext(value)),
+      (err) => pushMetaData(Notification.createError(err)),
       () => pushMetaData(Notification.createComplete())
     );
 
@@ -177,4 +204,4 @@ class TestScheduler extends VirtualTimeScheduler {
   }
 }
 
-export { TestScheduler };
+export { TestScheduler, VirtualTimeScheduler };