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

feat(Subscription): Subscription now implements Symbol.dispose #7305

Merged
merged 2 commits into from
Aug 18, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
20 changes: 20 additions & 0 deletions spec/Subscription-spec.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { expect } from 'chai';
import { Observable, UnsubscriptionError, Subscription, merge } from 'rxjs';
import sinon = require('sinon');

/** @test {Subscription} */
describe('Subscription', () => {
Expand Down Expand Up @@ -225,3 +226,22 @@ describe('Subscription', () => {
});
});
});

describe('Subscription[Symbol.dispose] implementation', () => {
it('should be the same as unsubscribe', () => {
const subscription = new Subscription();
expect(subscription[Symbol.dispose]).to.equal(subscription.unsubscribe);
});

it('should call a teardown when unsubscribed', () => {
// This is just a sanity check.
const callback = sinon.spy();
const subscription = new Subscription();

subscription.add(callback);
subscription[Symbol.dispose]();
expect(callback).to.have.been.calledOnce;
expect(subscription.closed).to.be.true;
});
});

2 changes: 1 addition & 1 deletion spec/helpers/interop-helper.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { Observable, Operator, Subject, Subscriber, Subscription } from 'rxjs';
jakovljevic-mladen marked this conversation as resolved.
Show resolved Hide resolved
import { Observable, Subject, Subscriber, Subscription } from 'rxjs';

/**
* Returns an observable that will be deemed by this package's implementation
Expand Down
6 changes: 6 additions & 0 deletions spec/helpers/setup.ts
Original file line number Diff line number Diff line change
Expand Up @@ -53,5 +53,11 @@ if (!(Symbol as any).observable) {
}
}(global));

// Polyfill Symbol.dispose for testing
if (typeof Symbol.dispose !== 'symbol') {
(Symbol as any).dispose = Symbol('dispose polyfill');
}


//setup sinon-chai
chai.use(sinonChai);
18 changes: 18 additions & 0 deletions src/internal/Subscription.ts
Original file line number Diff line number Diff line change
Expand Up @@ -144,10 +144,28 @@ export class Subscription implements SubscriptionLike {
}
}

// Even though Subscriptoin only conditionally implements `Symbol.dispose`
benlesh marked this conversation as resolved.
Show resolved Hide resolved
// if it's available, we still need to declare it here so that TypeScript
// knows that it exists on the prototype when it is available.
export interface Subscription {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should probably move this interface to types.ts file (either being merged with the existing Subscription interface or added as a new one like here) so it's in one place altogether. Also, maybe documentation could be added as well.

Copy link
Member Author

@benlesh benlesh Jul 12, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have reasons I put it here actually:

  1. Because I'm literally doing this to extend the Subscription interface.
  2. I'm planning on a PR to move everything required in Observable to a single file (until I can split packages up)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought we already had Subscription interface, but we have SubscriptionLike which is not this one.

[Symbol.dispose](): void;
}

if (typeof Symbol.dispose === 'symbol') {
Subscription.prototype[Symbol.dispose] = Subscription.prototype.unsubscribe;
}

function execFinalizer(finalizer: Unsubscribable | (() => void)) {
if (isFunction(finalizer)) {
finalizer();
} else {
finalizer.unsubscribe();
}
}

// Ensure that `Symbol.dispose` is defined in TypeScript
declare global {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about this one being moved to types.ts file as well? Having it all in one place is better for maintaining.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above. Also I suspect this will be removed in soon-released versions of TypeScript

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I'm not wrong, it will be added in 5.2 (next release), as they are also adding support for using. Merged a few weeks ago microsoft/TypeScript#54505

Source code of disposable interfaces: https://github.com/microsoft/TypeScript/blob/main/src/lib/esnext.disposable.d.ts#L7

interface SymbolConstructor {
readonly dispose: unique symbol;
}
}