CHANGELOG.md

8.0.2 (2022-01-01)

Fixes

• Add exports to package.json. (0ccd456)

8.0.1 (2021-05-20)

Fixes

• Use SafeSubscriber constructor in toSubscriber. (ae1fddc)

8.0.0 (2021-05-19)

Breaking changes

• Upgrade to RxJS version 7. (8ceece8)

7.5.3 (2020-08-16)

Changes

• Distribute ESM bundles.

7.5.2 (2020-06-22)

Changes

• Added rxjs-report-usage.

7.5.1 (2019-03-10)

Fixes

• Export CyclePlugin. (3066820)

7.5.0 (2018-12-13)

Features

• Add a maxLogged method to the spy. (284fdbc)

7.4.0 (2018-12-13)

Features

• Add a query method to the spy. (d8431f5)

7.3.1 (2018-12-04)

Fixes

• Make the rxSpy-is-deprecated message comprehensible. (b6f2a10)

7.3.0 (2018-10-06)

Features

• Add notification matching to log. This can be used to log only certain notification types. For example, to log subscriptions and unsubscriptions for all observables, type this into the console spy.log(() => true, /(subscribe|unsubscribe)/). (dcec5db)

7.2.1 (2018-09-20)

Non-breaking changes:

• Don't warn if non-Error values are passed to error notifications. Use linting to avoid this. See the rxjs-throw-error rule in rxjs-tslint-rules and the throw-error rule in tslint-etc. (16c1779)

7.2.0 (2018-09-03)

Features:

• Added a global option to create so that a name other than spy can be specified for the global that's used in the console. (9b8b74c)

7.1.1 (2018-09-03)

Non-breaking changes:

• Renamed the rxSpy global (as used in the console) to spy. Using rxSpy is still supported, but it's deprecated. (8dab99b)

7.1.0 (2018-08-26)

Features:

• Added a CyclePlugin to detect cyclic next notifications. (ff62d8d)

7.0.4 (2018-08-25)

Fixes:

• Teardown the internal subscription in spy implementation of subscribe. (27fc0aa)

7.0.3 (2018-08-25)

Fixes:

• Fixed a problem with the chaining of subscriptions/subscribers in the spy implementation of subscribe. See #37. (5a18222)

7.0.2 (2018-05-16)

Fixes:

• Log config-related warnings only once. (891c861)

7.0.1 (2018-04-27)

Fixes:

• Fix RxJS peer dependency. (164068c)

7.0.0 (2018-04-25)

Breaking changes:

• Upgrade to RxJS version 6.
• Rename the UMD global to rxjsSpy.

6.1.0 (2017-12-18)

Fixes:

• When sourceMaps are enabled, memory usage has been hugely reduced. The resolution of the stack traces using source maps is now deferred and is wrapped in an observable.

Features:

• Subscription snapshots now include a mappedStackTrace observable that resolves a stack trace (if sourceMaps is enabled).
• The show command now limits the maximum number of observables that can be logged to the console.

6.0.0 (2017-12-07)

Breaking changes:

• The module API has been replaced with a factory and a class/interface. Instead of calling a spy method, call create which will return a instance that implements the Spy interface.
• The plugins option has been removed and defaultPlugins: boolean has been added.
• The plugin and plugins methods have changed. When using defaultPlugins: false, call plug on the spy instance to add one or more plugins.
• The name parameter has been removed from the plugin/plug method.
• A read-only name property has been added to the Plugin interface.
• The subscribers map has been removed from the observable snapshot and replaced with a subscriptions map.
• In the snapshots, merges has been renamed to flattenings.
• It's no longer possible to undo the entire spy via the console.
• The console global - spy - won't exist until create has been called.
• undefined is favoured for return values, etc. rather than null.

Fixes:

• When calling show, console.error is no longer used for the unsubscribed indicator.
• For memory reasons, raw snapshots, etc. are no longer logged to the console when calling show or log.
• For performance reasons, grouping has been removed from log messages.
• Patching of Observable.prototype has been removed.
• The GraphPlugin now uses a single setInterval when cleaning up unsubscribed subscription refs.

Non-breaking changes:

• Switched to Webpack.

Features:

• When logging, if the observable does not have a tag, its type is logged instead.
• Options have been added to the LetPlugin so that completions from the selected observable can be ignored - so it's possible to return something like Observable.of(42) without having the spied-upon observable complete.
• The DevTools plugin has been added (for integration with an almost-ready-for-RC Chrome DevTools extension).
• It's now possible to match IDs as well as tags (it's used by the DevTools extension).
• The output from show now includes the observable's 'path' - a string representation of the composed source and operators.
• A hide operator has been added and can be used to ensure a composed observable is hidden from the spy.
• An audit option has been added to the spy and can be used to audit logged notifications within the specified number of milliseconds - so that logging high-frequency observables will not overwhelm the console.

5.2.3 (2017-11-24)

Fixes

• Fix a bug that occurred when logging if the GraphPlugin was enabled without the SnapshotPlugin. (970e184)

5.2.2 (2017-11-23)

Fixes

• Remove raw snapshots and observables from console logs to avoid leaking memory. (756b32d)

5.2.1 (2017-11-08)

Fixes

• Fix publishing from next fiasco.

5.2.0 (2017-11-08)

Features

• Stats: Add graph-related stats (included only if the GraphPlugin is configured). (c377506)

5.1.1 (2017-11-07)

Changes

• The sourceMaps option now defaults to false.

5.1.0 (2017-11-07)

Features

• Stats: Add a plugin to collect basic stats. (a49344c)

5.0.0 (2017-11-02)

Features

• If non-Error instance values are passed in an error notification, a warning is logged to the console.

Breaking Changes

No breaking changes to the module or console APIs, but the SnapshotPlugin and the snapshots have changed. In particular:

• flush has been removed from SnapshotPlugin. The flushing mechanism has been simplified and delegated entirely to the GraphPlugin. Flushing is now fully automatic and is controlled by the keptDuration option that can be passed to spy.
• destination and rootDestination have been renamed to sink and rootSink.

Also, the DevToolsPlugin has been removed and moved to the next branch, as it is a work in progress.

4.1.2 (2017-11-01)

Fixes

• Upgrade to TypeScript 2.6. (570b915)

4.1.1 (2017-10-31)

Fixes

• Add support for the keptDuration option to the GraphPlugin. (b048d38)

  Now, when source or merged subscriptions complete or error, they should be removed from the destination subscription's graph and counters should be incremented to indicate that flushing has occurred. In short, rxjs-spy should no longer contintually consume memory (unless keptDuration is set to -1).

4.1.0 (2017-10-31)

Features

• Allow plugin options to be passed to spy.
• Add the sourceMaps option for the StackTracePlugin. (3bd322e)
• Add the keptDuration option for the SnapshotPlugin. (723de5b)

4.0.0 (2017-10-23)

Features

• A lettable/pipeable tag operator has been added (under the operators directory);
• find, findAll and detect methods have been added; and
• source maps are now used when obtaining stack traces.

Breaking Changes

No breaking changes to the module or console APIs, but the Plugin interface and the snapshots have changed. In particular:

• complete and error have been moved from the observable snapshot to the subscription snapshot;
• snapshots no longer include the ref; and
• finalDestination has been renamed to rootDestination.

3.1.4 (2017-08-08)

Minor Changes

• Logging: Only show subscribers can have multiple relevant subscriptions; log subscribers will have only one relevant subscription. (38d792c)

3.1.3 (2017-08-02)

Bug Fixes

• Logging: Don't call toString on null, etc. and don't include the value in the group name. (6000e24)

3.1.2 (2017-08-01)

Features

• Stack traces: Default to no source maps. (20dbeaa)

3.1.1 (2017-08-01)

Bug Fixes

• Dependencies: @types/stacktrace-js is a non-dev dependency. (2597fb0)

3.1.0 (2017-08-01)

Features

• Stack traces: Resolve source maps. (78f2b56)

Bug Fixes

• Dependencies: stacktrace-js is a non-dev dependency. (28988ef)

3.0.0 (2017-07-27)

Breaking Changes

No breaking changes to the module or console APIs, but the plugin interface and the snapshots have changed - the changes account for subscribers being able to have multiple subscriptions.

• Snapshots: Include subscription on stack. (6a270e4)
• Snapshots: Rename snapshots. (f3d1992)
• Plugin: Add SubscriptionRef. (953260d)
• Snapshots: Separate records/snapshots. (fd04a76)

2.1.0 (2017-07-24)

Features

• Stack traces: Include subscribe stack traces in log and show output. (d7abd57 and ec926ad)

2.0.0 (2017-07-19)

Breaking Changes

• Snapshots: Remove values from observable snapshots; only store values against subscriptions. (48f7483)
• Plugin events: Rename plugin events to notifications. (6018d38)